]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - drivers/rtc/rtc-at91rm9200.c
rtc-at91rm9200: refactor interrupt-register handling
[mirror_ubuntu-eoan-kernel.git] / drivers / rtc / rtc-at91rm9200.c
CommitLineData
788b1fc6
AV
1/*
2 * Real Time Clock interface for Linux on Atmel AT91RM9200
3 *
4 * Copyright (C) 2002 Rick Bronson
5 *
6 * Converted to RTC class model by Andrew Victor
7 *
8 * Ported to Linux 2.6 by Steven Scholz
9 * Based on s3c2410-rtc.c Simtec Electronics
10 *
11 * Based on sa1100-rtc.c by Nils Faerber
12 * Based on rtc.c by Paul Gortmaker
13 *
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version
17 * 2 of the License, or (at your option) any later version.
18 *
19 */
20
21#include <linux/module.h>
22#include <linux/kernel.h>
23#include <linux/platform_device.h>
24#include <linux/time.h>
25#include <linux/rtc.h>
26#include <linux/bcd.h>
27#include <linux/interrupt.h>
28#include <linux/ioctl.h>
29#include <linux/completion.h>
14070ade 30#include <linux/io.h>
7c1b68d4
JE
31#include <linux/of.h>
32#include <linux/of_device.h>
788b1fc6
AV
33
34#include <asm/uaccess.h>
fb0d4ec4 35
75984df0 36#include "rtc-at91rm9200.h"
d73e3cd7 37
d28bdfc5
JCPV
38#define at91_rtc_read(field) \
39 __raw_readl(at91_rtc_regs + field)
40#define at91_rtc_write(field, val) \
41 __raw_writel((val), at91_rtc_regs + field)
788b1fc6 42
788b1fc6
AV
43#define AT91_RTC_EPOCH 1900UL /* just like arch/arm/common/rtctime.c */
44
de645475
JH
45struct at91_rtc_config {
46};
47
48static const struct at91_rtc_config *at91_rtc_config;
788b1fc6
AV
49static DECLARE_COMPLETION(at91_rtc_updated);
50static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
d28bdfc5
JCPV
51static void __iomem *at91_rtc_regs;
52static int irq;
788b1fc6 53
e304fcd0
JH
54static void at91_rtc_write_ier(u32 mask)
55{
56 at91_rtc_write(AT91_RTC_IER, mask);
57}
58
59static void at91_rtc_write_idr(u32 mask)
60{
61 at91_rtc_write(AT91_RTC_IDR, mask);
62}
63
64static u32 at91_rtc_read_imr(void)
65{
66 return at91_rtc_read(AT91_RTC_IMR);
67}
68
788b1fc6
AV
69/*
70 * Decode time/date into rtc_time structure
71 */
e7a8bb12
AM
72static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
73 struct rtc_time *tm)
788b1fc6
AV
74{
75 unsigned int time, date;
76
77 /* must read twice in case it changes */
78 do {
d28bdfc5
JCPV
79 time = at91_rtc_read(timereg);
80 date = at91_rtc_read(calreg);
81 } while ((time != at91_rtc_read(timereg)) ||
82 (date != at91_rtc_read(calreg)));
788b1fc6 83
fe20ba70
AB
84 tm->tm_sec = bcd2bin((time & AT91_RTC_SEC) >> 0);
85 tm->tm_min = bcd2bin((time & AT91_RTC_MIN) >> 8);
86 tm->tm_hour = bcd2bin((time & AT91_RTC_HOUR) >> 16);
788b1fc6
AV
87
88 /*
89 * The Calendar Alarm register does not have a field for
90 * the year - so these will return an invalid value. When an
25985edc 91 * alarm is set, at91_alarm_year will store the current year.
788b1fc6 92 */
fe20ba70
AB
93 tm->tm_year = bcd2bin(date & AT91_RTC_CENT) * 100; /* century */
94 tm->tm_year += bcd2bin((date & AT91_RTC_YEAR) >> 8); /* year */
788b1fc6 95
fe20ba70
AB
96 tm->tm_wday = bcd2bin((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */
97 tm->tm_mon = bcd2bin((date & AT91_RTC_MONTH) >> 16) - 1;
98 tm->tm_mday = bcd2bin((date & AT91_RTC_DATE) >> 24);
788b1fc6
AV
99}
100
101/*
102 * Read current time and date in RTC
103 */
104static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
105{
106 at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
107 tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
108 tm->tm_year = tm->tm_year - 1900;
109
6588208c 110 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12
AM
111 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
112 tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6
AV
113
114 return 0;
115}
116
117/*
118 * Set current time and date in RTC
119 */
120static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
121{
122 unsigned long cr;
123
6588208c 124 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12
AM
125 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
126 tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6
AV
127
128 /* Stop Time/Calendar from counting */
d28bdfc5
JCPV
129 cr = at91_rtc_read(AT91_RTC_CR);
130 at91_rtc_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);
788b1fc6 131
e304fcd0 132 at91_rtc_write_ier(AT91_RTC_ACKUPD);
e7a8bb12 133 wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
e304fcd0 134 at91_rtc_write_idr(AT91_RTC_ACKUPD);
788b1fc6 135
d28bdfc5 136 at91_rtc_write(AT91_RTC_TIMR,
fe20ba70
AB
137 bin2bcd(tm->tm_sec) << 0
138 | bin2bcd(tm->tm_min) << 8
139 | bin2bcd(tm->tm_hour) << 16);
788b1fc6 140
d28bdfc5 141 at91_rtc_write(AT91_RTC_CALR,
fe20ba70
AB
142 bin2bcd((tm->tm_year + 1900) / 100) /* century */
143 | bin2bcd(tm->tm_year % 100) << 8 /* year */
144 | bin2bcd(tm->tm_mon + 1) << 16 /* tm_mon starts at zero */
145 | bin2bcd(tm->tm_wday + 1) << 21 /* day of the week [0-6], Sunday=0 */
146 | bin2bcd(tm->tm_mday) << 24);
788b1fc6
AV
147
148 /* Restart Time/Calendar */
d28bdfc5
JCPV
149 cr = at91_rtc_read(AT91_RTC_CR);
150 at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
788b1fc6
AV
151
152 return 0;
153}
154
155/*
156 * Read alarm time and date in RTC
157 */
158static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
159{
160 struct rtc_time *tm = &alrm->time;
161
162 at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
163 tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
164 tm->tm_year = at91_alarm_year - 1900;
165
e304fcd0 166 alrm->enabled = (at91_rtc_read_imr() & AT91_RTC_ALARM)
a2db8dfc
DB
167 ? 1 : 0;
168
6588208c 169 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12
AM
170 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
171 tm->tm_hour, tm->tm_min, tm->tm_sec);
788b1fc6
AV
172
173 return 0;
174}
175
176/*
177 * Set alarm time and date in RTC
178 */
179static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
180{
181 struct rtc_time tm;
182
183 at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);
184
185 at91_alarm_year = tm.tm_year;
186
187 tm.tm_hour = alrm->time.tm_hour;
188 tm.tm_min = alrm->time.tm_min;
189 tm.tm_sec = alrm->time.tm_sec;
190
e304fcd0 191 at91_rtc_write_idr(AT91_RTC_ALARM);
d28bdfc5 192 at91_rtc_write(AT91_RTC_TIMALR,
fe20ba70
AB
193 bin2bcd(tm.tm_sec) << 0
194 | bin2bcd(tm.tm_min) << 8
195 | bin2bcd(tm.tm_hour) << 16
788b1fc6 196 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
d28bdfc5 197 at91_rtc_write(AT91_RTC_CALALR,
fe20ba70
AB
198 bin2bcd(tm.tm_mon + 1) << 16 /* tm_mon starts at zero */
199 | bin2bcd(tm.tm_mday) << 24
788b1fc6
AV
200 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
201
449321b3 202 if (alrm->enabled) {
d28bdfc5 203 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
e304fcd0 204 at91_rtc_write_ier(AT91_RTC_ALARM);
449321b3 205 }
5d4675a8 206
6588208c 207 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
e7a8bb12
AM
208 at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
209 tm.tm_min, tm.tm_sec);
788b1fc6
AV
210
211 return 0;
212}
213
16380c15
JS
214static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
215{
6588208c 216 dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);
16380c15
JS
217
218 if (enabled) {
d28bdfc5 219 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
e304fcd0 220 at91_rtc_write_ier(AT91_RTC_ALARM);
e24b0bfa 221 } else
e304fcd0 222 at91_rtc_write_idr(AT91_RTC_ALARM);
16380c15
JS
223
224 return 0;
225}
788b1fc6
AV
226/*
227 * Provide additional RTC information in /proc/driver/rtc
228 */
229static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
230{
e304fcd0 231 unsigned long imr = at91_rtc_read_imr();
e24b0bfa 232
e7a8bb12 233 seq_printf(seq, "update_IRQ\t: %s\n",
e24b0bfa 234 (imr & AT91_RTC_ACKUPD) ? "yes" : "no");
e7a8bb12 235 seq_printf(seq, "periodic_IRQ\t: %s\n",
e24b0bfa 236 (imr & AT91_RTC_SECEV) ? "yes" : "no");
788b1fc6
AV
237
238 return 0;
239}
240
241/*
242 * IRQ handler for the RTC
243 */
7d12e780 244static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
788b1fc6 245{
e7a8bb12 246 struct platform_device *pdev = dev_id;
788b1fc6
AV
247 struct rtc_device *rtc = platform_get_drvdata(pdev);
248 unsigned int rtsr;
249 unsigned long events = 0;
250
e304fcd0 251 rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read_imr();
788b1fc6
AV
252 if (rtsr) { /* this interrupt is shared! Is it ours? */
253 if (rtsr & AT91_RTC_ALARM)
254 events |= (RTC_AF | RTC_IRQF);
255 if (rtsr & AT91_RTC_SECEV)
256 events |= (RTC_UF | RTC_IRQF);
257 if (rtsr & AT91_RTC_ACKUPD)
258 complete(&at91_rtc_updated);
259
d28bdfc5 260 at91_rtc_write(AT91_RTC_SCCR, rtsr); /* clear status reg */
788b1fc6 261
ab6a2d70 262 rtc_update_irq(rtc, 1, events);
788b1fc6 263
6588208c 264 dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n", __func__,
788b1fc6
AV
265 events >> 8, events & 0x000000FF);
266
267 return IRQ_HANDLED;
268 }
269 return IRQ_NONE; /* not handled */
270}
271
de645475
JH
272static const struct at91_rtc_config at91rm9200_config = {
273};
274
275#ifdef CONFIG_OF
276static const struct of_device_id at91_rtc_dt_ids[] = {
277 {
278 .compatible = "atmel,at91rm9200-rtc",
279 .data = &at91rm9200_config,
280 }, {
281 /* sentinel */
282 }
283};
284MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
285#endif
286
287static const struct at91_rtc_config *
288at91_rtc_get_config(struct platform_device *pdev)
289{
290 const struct of_device_id *match;
291
292 if (pdev->dev.of_node) {
293 match = of_match_node(at91_rtc_dt_ids, pdev->dev.of_node);
294 if (!match)
295 return NULL;
296 return (const struct at91_rtc_config *)match->data;
297 }
298
299 return &at91rm9200_config;
300}
301
ff8371ac 302static const struct rtc_class_ops at91_rtc_ops = {
788b1fc6
AV
303 .read_time = at91_rtc_readtime,
304 .set_time = at91_rtc_settime,
305 .read_alarm = at91_rtc_readalarm,
306 .set_alarm = at91_rtc_setalarm,
307 .proc = at91_rtc_proc,
16380c15 308 .alarm_irq_enable = at91_rtc_alarm_irq_enable,
788b1fc6
AV
309};
310
311/*
312 * Initialize and install RTC driver
313 */
314static int __init at91_rtc_probe(struct platform_device *pdev)
315{
316 struct rtc_device *rtc;
d28bdfc5
JCPV
317 struct resource *regs;
318 int ret = 0;
788b1fc6 319
de645475
JH
320 at91_rtc_config = at91_rtc_get_config(pdev);
321 if (!at91_rtc_config)
322 return -ENODEV;
323
d28bdfc5
JCPV
324 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
325 if (!regs) {
326 dev_err(&pdev->dev, "no mmio resource defined\n");
327 return -ENXIO;
328 }
329
330 irq = platform_get_irq(pdev, 0);
331 if (irq < 0) {
332 dev_err(&pdev->dev, "no irq resource defined\n");
333 return -ENXIO;
334 }
335
336 at91_rtc_regs = ioremap(regs->start, resource_size(regs));
337 if (!at91_rtc_regs) {
338 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
339 return -ENOMEM;
340 }
341
342 at91_rtc_write(AT91_RTC_CR, 0);
343 at91_rtc_write(AT91_RTC_MR, 0); /* 24 hour mode */
788b1fc6
AV
344
345 /* Disable all interrupts */
e304fcd0 346 at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
e7a8bb12
AM
347 AT91_RTC_SECEV | AT91_RTC_TIMEV |
348 AT91_RTC_CALEV);
788b1fc6 349
d28bdfc5 350 ret = request_irq(irq, at91_rtc_interrupt,
dac94d9e 351 IRQF_SHARED,
d728b1e6 352 "at91_rtc", pdev);
788b1fc6 353 if (ret) {
6588208c 354 dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
3427de92 355 goto err_unmap;
788b1fc6
AV
356 }
357
5d4675a8
DB
358 /* cpu init code should really have flagged this device as
359 * being wake-capable; if it didn't, do that here.
360 */
361 if (!device_can_wakeup(&pdev->dev))
362 device_init_wakeup(&pdev->dev, 1);
363
e7a8bb12
AM
364 rtc = rtc_device_register(pdev->name, &pdev->dev,
365 &at91_rtc_ops, THIS_MODULE);
788b1fc6 366 if (IS_ERR(rtc)) {
3427de92
JH
367 ret = PTR_ERR(rtc);
368 goto err_free_irq;
788b1fc6
AV
369 }
370 platform_set_drvdata(pdev, rtc);
371
6588208c 372 dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
788b1fc6 373 return 0;
3427de92
JH
374
375err_free_irq:
376 free_irq(irq, pdev);
377err_unmap:
378 iounmap(at91_rtc_regs);
379
380 return ret;
788b1fc6
AV
381}
382
383/*
384 * Disable and remove the RTC driver
385 */
5d4675a8 386static int __exit at91_rtc_remove(struct platform_device *pdev)
788b1fc6
AV
387{
388 struct rtc_device *rtc = platform_get_drvdata(pdev);
389
390 /* Disable all interrupts */
e304fcd0 391 at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
e7a8bb12
AM
392 AT91_RTC_SECEV | AT91_RTC_TIMEV |
393 AT91_RTC_CALEV);
d28bdfc5 394 free_irq(irq, pdev);
788b1fc6
AV
395
396 rtc_device_unregister(rtc);
3427de92 397 iounmap(at91_rtc_regs);
788b1fc6
AV
398 platform_set_drvdata(pdev, NULL);
399
400 return 0;
401}
402
6975a9c1 403#ifdef CONFIG_PM_SLEEP
788b1fc6
AV
404
405/* AT91RM9200 RTC Power management control */
406
e24b0bfa 407static u32 at91_rtc_imr;
788b1fc6 408
dac94d9e 409static int at91_rtc_suspend(struct device *dev)
788b1fc6 410{
90b4d648
DB
411 /* this IRQ is shared with DBGU and other hardware which isn't
412 * necessarily doing PM like we are...
413 */
e304fcd0 414 at91_rtc_imr = at91_rtc_read_imr()
e24b0bfa
JH
415 & (AT91_RTC_ALARM|AT91_RTC_SECEV);
416 if (at91_rtc_imr) {
417 if (device_may_wakeup(dev))
d28bdfc5 418 enable_irq_wake(irq);
e24b0bfa 419 else
e304fcd0 420 at91_rtc_write_idr(at91_rtc_imr);
e24b0bfa 421 }
788b1fc6
AV
422 return 0;
423}
424
dac94d9e 425static int at91_rtc_resume(struct device *dev)
788b1fc6 426{
e24b0bfa
JH
427 if (at91_rtc_imr) {
428 if (device_may_wakeup(dev))
d28bdfc5 429 disable_irq_wake(irq);
e24b0bfa 430 else
e304fcd0 431 at91_rtc_write_ier(at91_rtc_imr);
90b4d648 432 }
788b1fc6
AV
433 return 0;
434}
788b1fc6
AV
435#endif
436
6975a9c1
JH
437static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
438
788b1fc6 439static struct platform_driver at91_rtc_driver = {
5d4675a8 440 .remove = __exit_p(at91_rtc_remove),
788b1fc6
AV
441 .driver = {
442 .name = "at91_rtc",
443 .owner = THIS_MODULE,
6975a9c1 444 .pm = &at91_rtc_pm_ops,
7c1b68d4 445 .of_match_table = of_match_ptr(at91_rtc_dt_ids),
788b1fc6
AV
446 },
447};
448
ac36960f 449module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);
788b1fc6
AV
450
451MODULE_AUTHOR("Rick Bronson");
452MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
453MODULE_LICENSE("GPL");
ad28a07b 454MODULE_ALIAS("platform:at91_rtc");