[RTC] remove references to asm/mach/time.h
[linux-2.6.git] / drivers / rtc / rtc-at91rm9200.c
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>
30
31 #include <asm/uaccess.h>
32 #include <asm/rtc.h>
33
34 #include <asm/arch/at91_rtc.h>
35
36
37 #define AT91_RTC_FREQ           1
38 #define AT91_RTC_EPOCH          1900UL  /* just like arch/arm/common/rtctime.c */
39
40 static DECLARE_COMPLETION(at91_rtc_updated);
41 static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
42
43 /*
44  * Decode time/date into rtc_time structure
45  */
46 static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
47                                 struct rtc_time *tm)
48 {
49         unsigned int time, date;
50
51         /* must read twice in case it changes */
52         do {
53                 time = at91_sys_read(timereg);
54                 date = at91_sys_read(calreg);
55         } while ((time != at91_sys_read(timereg)) ||
56                         (date != at91_sys_read(calreg)));
57
58         tm->tm_sec  = BCD2BIN((time & AT91_RTC_SEC) >> 0);
59         tm->tm_min  = BCD2BIN((time & AT91_RTC_MIN) >> 8);
60         tm->tm_hour = BCD2BIN((time & AT91_RTC_HOUR) >> 16);
61
62         /*
63          * The Calendar Alarm register does not have a field for
64          * the year - so these will return an invalid value.  When an
65          * alarm is set, at91_alarm_year wille store the current year.
66          */
67         tm->tm_year  = BCD2BIN(date & AT91_RTC_CENT) * 100;     /* century */
68         tm->tm_year += BCD2BIN((date & AT91_RTC_YEAR) >> 8);    /* year */
69
70         tm->tm_wday = BCD2BIN((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */
71         tm->tm_mon  = BCD2BIN((date & AT91_RTC_MONTH) >> 16) - 1;
72         tm->tm_mday = BCD2BIN((date & AT91_RTC_DATE) >> 24);
73 }
74
75 /*
76  * Read current time and date in RTC
77  */
78 static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
79 {
80         at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
81         tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
82         tm->tm_year = tm->tm_year - 1900;
83
84         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
85                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
86                 tm->tm_hour, tm->tm_min, tm->tm_sec);
87
88         return 0;
89 }
90
91 /*
92  * Set current time and date in RTC
93  */
94 static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
95 {
96         unsigned long cr;
97
98         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
99                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
100                 tm->tm_hour, tm->tm_min, tm->tm_sec);
101
102         /* Stop Time/Calendar from counting */
103         cr = at91_sys_read(AT91_RTC_CR);
104         at91_sys_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);
105
106         at91_sys_write(AT91_RTC_IER, AT91_RTC_ACKUPD);
107         wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
108         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD);
109
110         at91_sys_write(AT91_RTC_TIMR,
111                           BIN2BCD(tm->tm_sec) << 0
112                         | BIN2BCD(tm->tm_min) << 8
113                         | BIN2BCD(tm->tm_hour) << 16);
114
115         at91_sys_write(AT91_RTC_CALR,
116                           BIN2BCD((tm->tm_year + 1900) / 100)   /* century */
117                         | BIN2BCD(tm->tm_year % 100) << 8       /* year */
118                         | BIN2BCD(tm->tm_mon + 1) << 16         /* tm_mon starts at zero */
119                         | BIN2BCD(tm->tm_wday + 1) << 21        /* day of the week [0-6], Sunday=0 */
120                         | BIN2BCD(tm->tm_mday) << 24);
121
122         /* Restart Time/Calendar */
123         cr = at91_sys_read(AT91_RTC_CR);
124         at91_sys_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
125
126         return 0;
127 }
128
129 /*
130  * Read alarm time and date in RTC
131  */
132 static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
133 {
134         struct rtc_time *tm = &alrm->time;
135
136         at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
137         tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
138         tm->tm_year = at91_alarm_year - 1900;
139
140         alrm->enabled = (at91_sys_read(AT91_RTC_IMR) & AT91_RTC_ALARM)
141                         ? 1 : 0;
142
143         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
144                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
145                 tm->tm_hour, tm->tm_min, tm->tm_sec);
146
147         return 0;
148 }
149
150 /*
151  * Set alarm time and date in RTC
152  */
153 static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
154 {
155         struct rtc_time tm;
156
157         at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);
158
159         at91_alarm_year = tm.tm_year;
160
161         tm.tm_hour = alrm->time.tm_hour;
162         tm.tm_min = alrm->time.tm_min;
163         tm.tm_sec = alrm->time.tm_sec;
164
165         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ALARM);
166         at91_sys_write(AT91_RTC_TIMALR,
167                   BIN2BCD(tm.tm_sec) << 0
168                 | BIN2BCD(tm.tm_min) << 8
169                 | BIN2BCD(tm.tm_hour) << 16
170                 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
171         at91_sys_write(AT91_RTC_CALALR,
172                   BIN2BCD(tm.tm_mon + 1) << 16          /* tm_mon starts at zero */
173                 | BIN2BCD(tm.tm_mday) << 24
174                 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
175
176         if (alrm->enabled)
177                 at91_sys_write(AT91_RTC_IER, AT91_RTC_ALARM);
178
179         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
180                 at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
181                 tm.tm_min, tm.tm_sec);
182
183         return 0;
184 }
185
186 /*
187  * Handle commands from user-space
188  */
189 static int at91_rtc_ioctl(struct device *dev, unsigned int cmd,
190                         unsigned long arg)
191 {
192         int ret = 0;
193
194         pr_debug("%s(): cmd=%08x, arg=%08lx.\n", __func__, cmd, arg);
195
196         switch (cmd) {
197         case RTC_AIE_OFF:       /* alarm off */
198                 at91_sys_write(AT91_RTC_IDR, AT91_RTC_ALARM);
199                 break;
200         case RTC_AIE_ON:        /* alarm on */
201                 at91_sys_write(AT91_RTC_IER, AT91_RTC_ALARM);
202                 break;
203         case RTC_UIE_OFF:       /* update off */
204         case RTC_PIE_OFF:       /* periodic off */
205                 at91_sys_write(AT91_RTC_IDR, AT91_RTC_SECEV);
206                 break;
207         case RTC_UIE_ON:        /* update on */
208         case RTC_PIE_ON:        /* periodic on */
209                 at91_sys_write(AT91_RTC_IER, AT91_RTC_SECEV);
210                 break;
211         case RTC_IRQP_READ:     /* read periodic alarm frequency */
212                 ret = put_user(AT91_RTC_FREQ, (unsigned long *) arg);
213                 break;
214         case RTC_IRQP_SET:      /* set periodic alarm frequency */
215                 if (arg != AT91_RTC_FREQ)
216                         ret = -EINVAL;
217                 break;
218         default:
219                 ret = -ENOIOCTLCMD;
220                 break;
221         }
222
223         return ret;
224 }
225
226 /*
227  * Provide additional RTC information in /proc/driver/rtc
228  */
229 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
230 {
231         unsigned long imr = at91_sys_read(AT91_RTC_IMR);
232
233         seq_printf(seq, "update_IRQ\t: %s\n",
234                         (imr & AT91_RTC_ACKUPD) ? "yes" : "no");
235         seq_printf(seq, "periodic_IRQ\t: %s\n",
236                         (imr & AT91_RTC_SECEV) ? "yes" : "no");
237         seq_printf(seq, "periodic_freq\t: %ld\n",
238                         (unsigned long) AT91_RTC_FREQ);
239
240         return 0;
241 }
242
243 /*
244  * IRQ handler for the RTC
245  */
246 static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
247 {
248         struct platform_device *pdev = dev_id;
249         struct rtc_device *rtc = platform_get_drvdata(pdev);
250         unsigned int rtsr;
251         unsigned long events = 0;
252
253         rtsr = at91_sys_read(AT91_RTC_SR) & at91_sys_read(AT91_RTC_IMR);
254         if (rtsr) {             /* this interrupt is shared!  Is it ours? */
255                 if (rtsr & AT91_RTC_ALARM)
256                         events |= (RTC_AF | RTC_IRQF);
257                 if (rtsr & AT91_RTC_SECEV)
258                         events |= (RTC_UF | RTC_IRQF);
259                 if (rtsr & AT91_RTC_ACKUPD)
260                         complete(&at91_rtc_updated);
261
262                 at91_sys_write(AT91_RTC_SCCR, rtsr);    /* clear status reg */
263
264                 rtc_update_irq(rtc, 1, events);
265
266                 pr_debug("%s(): num=%ld, events=0x%02lx\n", __func__,
267                         events >> 8, events & 0x000000FF);
268
269                 return IRQ_HANDLED;
270         }
271         return IRQ_NONE;                /* not handled */
272 }
273
274 static const struct rtc_class_ops at91_rtc_ops = {
275         .ioctl          = at91_rtc_ioctl,
276         .read_time      = at91_rtc_readtime,
277         .set_time       = at91_rtc_settime,
278         .read_alarm     = at91_rtc_readalarm,
279         .set_alarm      = at91_rtc_setalarm,
280         .proc           = at91_rtc_proc,
281 };
282
283 /*
284  * Initialize and install RTC driver
285  */
286 static int __init at91_rtc_probe(struct platform_device *pdev)
287 {
288         struct rtc_device *rtc;
289         int ret;
290
291         at91_sys_write(AT91_RTC_CR, 0);
292         at91_sys_write(AT91_RTC_MR, 0);         /* 24 hour mode */
293
294         /* Disable all interrupts */
295         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
296                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
297                                         AT91_RTC_CALEV);
298
299         ret = request_irq(AT91_ID_SYS, at91_rtc_interrupt,
300                                 IRQF_DISABLED | IRQF_SHARED,
301                                 "at91_rtc", pdev);
302         if (ret) {
303                 printk(KERN_ERR "at91_rtc: IRQ %d already in use.\n",
304                                 AT91_ID_SYS);
305                 return ret;
306         }
307
308         /* cpu init code should really have flagged this device as
309          * being wake-capable; if it didn't, do that here.
310          */
311         if (!device_can_wakeup(&pdev->dev))
312                 device_init_wakeup(&pdev->dev, 1);
313
314         rtc = rtc_device_register(pdev->name, &pdev->dev,
315                                 &at91_rtc_ops, THIS_MODULE);
316         if (IS_ERR(rtc)) {
317                 free_irq(AT91_ID_SYS, pdev);
318                 return PTR_ERR(rtc);
319         }
320         platform_set_drvdata(pdev, rtc);
321
322         printk(KERN_INFO "AT91 Real Time Clock driver.\n");
323         return 0;
324 }
325
326 /*
327  * Disable and remove the RTC driver
328  */
329 static int __exit at91_rtc_remove(struct platform_device *pdev)
330 {
331         struct rtc_device *rtc = platform_get_drvdata(pdev);
332
333         /* Disable all interrupts */
334         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
335                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
336                                         AT91_RTC_CALEV);
337         free_irq(AT91_ID_SYS, pdev);
338
339         rtc_device_unregister(rtc);
340         platform_set_drvdata(pdev, NULL);
341
342         return 0;
343 }
344
345 #ifdef CONFIG_PM
346
347 /* AT91RM9200 RTC Power management control */
348
349 static u32 at91_rtc_imr;
350
351 static int at91_rtc_suspend(struct platform_device *pdev, pm_message_t state)
352 {
353         /* this IRQ is shared with DBGU and other hardware which isn't
354          * necessarily doing PM like we are...
355          */
356         at91_rtc_imr = at91_sys_read(AT91_RTC_IMR)
357                         & (AT91_RTC_ALARM|AT91_RTC_SECEV);
358         if (at91_rtc_imr) {
359                 if (device_may_wakeup(&pdev->dev))
360                         enable_irq_wake(AT91_ID_SYS);
361                 else
362                         at91_sys_write(AT91_RTC_IDR, at91_rtc_imr);
363         }
364         return 0;
365 }
366
367 static int at91_rtc_resume(struct platform_device *pdev)
368 {
369         if (at91_rtc_imr) {
370                 if (device_may_wakeup(&pdev->dev))
371                         disable_irq_wake(AT91_ID_SYS);
372                 else
373                         at91_sys_write(AT91_RTC_IER, at91_rtc_imr);
374         }
375         return 0;
376 }
377 #else
378 #define at91_rtc_suspend NULL
379 #define at91_rtc_resume  NULL
380 #endif
381
382 static struct platform_driver at91_rtc_driver = {
383         .remove         = __exit_p(at91_rtc_remove),
384         .suspend        = at91_rtc_suspend,
385         .resume         = at91_rtc_resume,
386         .driver         = {
387                 .name   = "at91_rtc",
388                 .owner  = THIS_MODULE,
389         },
390 };
391
392 static int __init at91_rtc_init(void)
393 {
394         return platform_driver_probe(&at91_rtc_driver, at91_rtc_probe);
395 }
396
397 static void __exit at91_rtc_exit(void)
398 {
399         platform_driver_unregister(&at91_rtc_driver);
400 }
401
402 module_init(at91_rtc_init);
403 module_exit(at91_rtc_exit);
404
405 MODULE_AUTHOR("Rick Bronson");
406 MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
407 MODULE_LICENSE("GPL");
408 MODULE_ALIAS("platform:at91_rtc");