2 * Real Time Clock interface for Linux on Atmel AT91RM9200
4 * Copyright (C) 2002 Rick Bronson
6 * Converted to RTC class model by Andrew Victor
8 * Ported to Linux 2.6 by Steven Scholz
9 * Based on s3c2410-rtc.c Simtec Electronics
11 * Based on sa1100-rtc.c by Nils Faerber
12 * Based on rtc.c by Paul Gortmaker
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.
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>
32 #include <asm/uaccess.h>
34 #include "rtc-at91rm9200.h"
36 #define at91_rtc_read(field) \
37 __raw_readl(at91_rtc_regs + field)
38 #define at91_rtc_write(field, val) \
39 __raw_writel((val), at91_rtc_regs + field)
41 #define AT91_RTC_EPOCH 1900UL /* just like arch/arm/common/rtctime.c */
43 static DECLARE_COMPLETION(at91_rtc_updated);
44 static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
45 static void __iomem *at91_rtc_regs;
49 * Decode time/date into rtc_time structure
51 static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
54 unsigned int time, date;
56 /* must read twice in case it changes */
58 time = at91_rtc_read(timereg);
59 date = at91_rtc_read(calreg);
60 } while ((time != at91_rtc_read(timereg)) ||
61 (date != at91_rtc_read(calreg)));
63 tm->tm_sec = bcd2bin((time & AT91_RTC_SEC) >> 0);
64 tm->tm_min = bcd2bin((time & AT91_RTC_MIN) >> 8);
65 tm->tm_hour = bcd2bin((time & AT91_RTC_HOUR) >> 16);
68 * The Calendar Alarm register does not have a field for
69 * the year - so these will return an invalid value. When an
70 * alarm is set, at91_alarm_year will store the current year.
72 tm->tm_year = bcd2bin(date & AT91_RTC_CENT) * 100; /* century */
73 tm->tm_year += bcd2bin((date & AT91_RTC_YEAR) >> 8); /* year */
75 tm->tm_wday = bcd2bin((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */
76 tm->tm_mon = bcd2bin((date & AT91_RTC_MONTH) >> 16) - 1;
77 tm->tm_mday = bcd2bin((date & AT91_RTC_DATE) >> 24);
81 * Read current time and date in RTC
83 static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
85 at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
86 tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
87 tm->tm_year = tm->tm_year - 1900;
89 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
90 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
91 tm->tm_hour, tm->tm_min, tm->tm_sec);
97 * Set current time and date in RTC
99 static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
103 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
104 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
105 tm->tm_hour, tm->tm_min, tm->tm_sec);
107 /* Stop Time/Calendar from counting */
108 cr = at91_rtc_read(AT91_RTC_CR);
109 at91_rtc_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);
111 at91_rtc_write(AT91_RTC_IER, AT91_RTC_ACKUPD);
112 wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
113 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD);
115 at91_rtc_write(AT91_RTC_TIMR,
116 bin2bcd(tm->tm_sec) << 0
117 | bin2bcd(tm->tm_min) << 8
118 | bin2bcd(tm->tm_hour) << 16);
120 at91_rtc_write(AT91_RTC_CALR,
121 bin2bcd((tm->tm_year + 1900) / 100) /* century */
122 | bin2bcd(tm->tm_year % 100) << 8 /* year */
123 | bin2bcd(tm->tm_mon + 1) << 16 /* tm_mon starts at zero */
124 | bin2bcd(tm->tm_wday + 1) << 21 /* day of the week [0-6], Sunday=0 */
125 | bin2bcd(tm->tm_mday) << 24);
127 /* Restart Time/Calendar */
128 cr = at91_rtc_read(AT91_RTC_CR);
129 at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
135 * Read alarm time and date in RTC
137 static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
139 struct rtc_time *tm = &alrm->time;
141 at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
142 tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
143 tm->tm_year = at91_alarm_year - 1900;
145 alrm->enabled = (at91_rtc_read(AT91_RTC_IMR) & AT91_RTC_ALARM)
148 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
149 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
150 tm->tm_hour, tm->tm_min, tm->tm_sec);
156 * Set alarm time and date in RTC
158 static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
162 at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);
164 at91_alarm_year = tm.tm_year;
166 tm.tm_hour = alrm->time.tm_hour;
167 tm.tm_min = alrm->time.tm_min;
168 tm.tm_sec = alrm->time.tm_sec;
170 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ALARM);
171 at91_rtc_write(AT91_RTC_TIMALR,
172 bin2bcd(tm.tm_sec) << 0
173 | bin2bcd(tm.tm_min) << 8
174 | bin2bcd(tm.tm_hour) << 16
175 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
176 at91_rtc_write(AT91_RTC_CALALR,
177 bin2bcd(tm.tm_mon + 1) << 16 /* tm_mon starts at zero */
178 | bin2bcd(tm.tm_mday) << 24
179 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
182 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
183 at91_rtc_write(AT91_RTC_IER, AT91_RTC_ALARM);
186 dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
187 at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
188 tm.tm_min, tm.tm_sec);
193 static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
195 dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);
198 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
199 at91_rtc_write(AT91_RTC_IER, AT91_RTC_ALARM);
201 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ALARM);
206 * Provide additional RTC information in /proc/driver/rtc
208 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
210 unsigned long imr = at91_rtc_read(AT91_RTC_IMR);
212 seq_printf(seq, "update_IRQ\t: %s\n",
213 (imr & AT91_RTC_ACKUPD) ? "yes" : "no");
214 seq_printf(seq, "periodic_IRQ\t: %s\n",
215 (imr & AT91_RTC_SECEV) ? "yes" : "no");
221 * IRQ handler for the RTC
223 static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
225 struct platform_device *pdev = dev_id;
226 struct rtc_device *rtc = platform_get_drvdata(pdev);
228 unsigned long events = 0;
230 rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read(AT91_RTC_IMR);
231 if (rtsr) { /* this interrupt is shared! Is it ours? */
232 if (rtsr & AT91_RTC_ALARM)
233 events |= (RTC_AF | RTC_IRQF);
234 if (rtsr & AT91_RTC_SECEV)
235 events |= (RTC_UF | RTC_IRQF);
236 if (rtsr & AT91_RTC_ACKUPD)
237 complete(&at91_rtc_updated);
239 at91_rtc_write(AT91_RTC_SCCR, rtsr); /* clear status reg */
241 rtc_update_irq(rtc, 1, events);
243 dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n", __func__,
244 events >> 8, events & 0x000000FF);
248 return IRQ_NONE; /* not handled */
251 static const struct rtc_class_ops at91_rtc_ops = {
252 .read_time = at91_rtc_readtime,
253 .set_time = at91_rtc_settime,
254 .read_alarm = at91_rtc_readalarm,
255 .set_alarm = at91_rtc_setalarm,
256 .proc = at91_rtc_proc,
257 .alarm_irq_enable = at91_rtc_alarm_irq_enable,
261 * Initialize and install RTC driver
263 static int __init at91_rtc_probe(struct platform_device *pdev)
265 struct rtc_device *rtc;
266 struct resource *regs;
269 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
271 dev_err(&pdev->dev, "no mmio resource defined\n");
275 irq = platform_get_irq(pdev, 0);
277 dev_err(&pdev->dev, "no irq resource defined\n");
281 at91_rtc_regs = ioremap(regs->start, resource_size(regs));
282 if (!at91_rtc_regs) {
283 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
287 at91_rtc_write(AT91_RTC_CR, 0);
288 at91_rtc_write(AT91_RTC_MR, 0); /* 24 hour mode */
290 /* Disable all interrupts */
291 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
292 AT91_RTC_SECEV | AT91_RTC_TIMEV |
295 ret = request_irq(irq, at91_rtc_interrupt,
299 dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
303 /* cpu init code should really have flagged this device as
304 * being wake-capable; if it didn't, do that here.
306 if (!device_can_wakeup(&pdev->dev))
307 device_init_wakeup(&pdev->dev, 1);
309 rtc = rtc_device_register(pdev->name, &pdev->dev,
310 &at91_rtc_ops, THIS_MODULE);
315 platform_set_drvdata(pdev, rtc);
317 dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
322 * Disable and remove the RTC driver
324 static int __exit at91_rtc_remove(struct platform_device *pdev)
326 struct rtc_device *rtc = platform_get_drvdata(pdev);
328 /* Disable all interrupts */
329 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
330 AT91_RTC_SECEV | AT91_RTC_TIMEV |
334 rtc_device_unregister(rtc);
335 platform_set_drvdata(pdev, NULL);
340 #ifdef CONFIG_PM_SLEEP
342 /* AT91RM9200 RTC Power management control */
344 static u32 at91_rtc_imr;
346 static int at91_rtc_suspend(struct device *dev)
348 /* this IRQ is shared with DBGU and other hardware which isn't
349 * necessarily doing PM like we are...
351 at91_rtc_imr = at91_rtc_read(AT91_RTC_IMR)
352 & (AT91_RTC_ALARM|AT91_RTC_SECEV);
354 if (device_may_wakeup(dev))
355 enable_irq_wake(irq);
357 at91_rtc_write(AT91_RTC_IDR, at91_rtc_imr);
362 static int at91_rtc_resume(struct device *dev)
365 if (device_may_wakeup(dev))
366 disable_irq_wake(irq);
368 at91_rtc_write(AT91_RTC_IER, at91_rtc_imr);
374 static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
376 static struct platform_driver at91_rtc_driver = {
377 .remove = __exit_p(at91_rtc_remove),
380 .owner = THIS_MODULE,
381 .pm = &at91_rtc_pm_ops,
385 module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);
387 MODULE_AUTHOR("Rick Bronson");
388 MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
389 MODULE_LICENSE("GPL");
390 MODULE_ALIAS("platform:at91_rtc");