[PATCH] rtc framewok: rtc_wkalrm.enabled reporting updates
[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/mach/time.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", __FUNCTION__,
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", __FUNCTION__,
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", __FUNCTION__,
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_TIMALR,
166                   BIN2BCD(tm.tm_sec) << 0
167                 | BIN2BCD(tm.tm_min) << 8
168                 | BIN2BCD(tm.tm_hour) << 16
169                 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
170         at91_sys_write(AT91_RTC_CALALR,
171                   BIN2BCD(tm.tm_mon + 1) << 16          /* tm_mon starts at zero */
172                 | BIN2BCD(tm.tm_mday) << 24
173                 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
174
175         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__,
176                 at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
177                 tm.tm_min, tm.tm_sec);
178
179         return 0;
180 }
181
182 /*
183  * Handle commands from user-space
184  */
185 static int at91_rtc_ioctl(struct device *dev, unsigned int cmd,
186                         unsigned long arg)
187 {
188         int ret = 0;
189
190         pr_debug("%s(): cmd=%08x, arg=%08lx.\n", __FUNCTION__, cmd, arg);
191
192         switch (cmd) {
193         case RTC_AIE_OFF:       /* alarm off */
194                 at91_sys_write(AT91_RTC_IDR, AT91_RTC_ALARM);
195                 break;
196         case RTC_AIE_ON:        /* alarm on */
197                 at91_sys_write(AT91_RTC_IER, AT91_RTC_ALARM);
198                 break;
199         case RTC_UIE_OFF:       /* update off */
200         case RTC_PIE_OFF:       /* periodic off */
201                 at91_sys_write(AT91_RTC_IDR, AT91_RTC_SECEV);
202                 break;
203         case RTC_UIE_ON:        /* update on */
204         case RTC_PIE_ON:        /* periodic on */
205                 at91_sys_write(AT91_RTC_IER, AT91_RTC_SECEV);
206                 break;
207         case RTC_IRQP_READ:     /* read periodic alarm frequency */
208                 ret = put_user(AT91_RTC_FREQ, (unsigned long *) arg);
209                 break;
210         case RTC_IRQP_SET:      /* set periodic alarm frequency */
211                 if (arg != AT91_RTC_FREQ)
212                         ret = -EINVAL;
213                 break;
214         default:
215                 ret = -ENOIOCTLCMD;
216                 break;
217         }
218
219         return ret;
220 }
221
222 /*
223  * Provide additional RTC information in /proc/driver/rtc
224  */
225 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
226 {
227         unsigned long imr = at91_sys_read(AT91_RTC_IMR);
228
229         seq_printf(seq, "update_IRQ\t: %s\n",
230                         (imr & AT91_RTC_ACKUPD) ? "yes" : "no");
231         seq_printf(seq, "periodic_IRQ\t: %s\n",
232                         (imr & AT91_RTC_SECEV) ? "yes" : "no");
233         seq_printf(seq, "periodic_freq\t: %ld\n",
234                         (unsigned long) AT91_RTC_FREQ);
235
236         return 0;
237 }
238
239 /*
240  * IRQ handler for the RTC
241  */
242 static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
243 {
244         struct platform_device *pdev = dev_id;
245         struct rtc_device *rtc = platform_get_drvdata(pdev);
246         unsigned int rtsr;
247         unsigned long events = 0;
248
249         rtsr = at91_sys_read(AT91_RTC_SR) & at91_sys_read(AT91_RTC_IMR);
250         if (rtsr) {             /* this interrupt is shared!  Is it ours? */
251                 if (rtsr & AT91_RTC_ALARM)
252                         events |= (RTC_AF | RTC_IRQF);
253                 if (rtsr & AT91_RTC_SECEV)
254                         events |= (RTC_UF | RTC_IRQF);
255                 if (rtsr & AT91_RTC_ACKUPD)
256                         complete(&at91_rtc_updated);
257
258                 at91_sys_write(AT91_RTC_SCCR, rtsr);    /* clear status reg */
259
260                 rtc_update_irq(&rtc->class_dev, 1, events);
261
262                 pr_debug("%s(): num=%ld, events=0x%02lx\n", __FUNCTION__,
263                         events >> 8, events & 0x000000FF);
264
265                 return IRQ_HANDLED;
266         }
267         return IRQ_NONE;                /* not handled */
268 }
269
270 static const struct rtc_class_ops at91_rtc_ops = {
271         .ioctl          = at91_rtc_ioctl,
272         .read_time      = at91_rtc_readtime,
273         .set_time       = at91_rtc_settime,
274         .read_alarm     = at91_rtc_readalarm,
275         .set_alarm      = at91_rtc_setalarm,
276         .proc           = at91_rtc_proc,
277 };
278
279 /*
280  * Initialize and install RTC driver
281  */
282 static int __init at91_rtc_probe(struct platform_device *pdev)
283 {
284         struct rtc_device *rtc;
285         int ret;
286
287         at91_sys_write(AT91_RTC_CR, 0);
288         at91_sys_write(AT91_RTC_MR, 0);         /* 24 hour mode */
289
290         /* Disable all interrupts */
291         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
292                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
293                                         AT91_RTC_CALEV);
294
295         ret = request_irq(AT91_ID_SYS, at91_rtc_interrupt,
296                                 IRQF_DISABLED | IRQF_SHARED,
297                                 "at91_rtc", pdev);
298         if (ret) {
299                 printk(KERN_ERR "at91_rtc: IRQ %d already in use.\n",
300                                 AT91_ID_SYS);
301                 return ret;
302         }
303
304         rtc = rtc_device_register(pdev->name, &pdev->dev,
305                                 &at91_rtc_ops, THIS_MODULE);
306         if (IS_ERR(rtc)) {
307                 free_irq(AT91_ID_SYS, pdev);
308                 return PTR_ERR(rtc);
309         }
310         platform_set_drvdata(pdev, rtc);
311         device_init_wakeup(&pdev->dev, 1);
312
313         printk(KERN_INFO "AT91 Real Time Clock driver.\n");
314         return 0;
315 }
316
317 /*
318  * Disable and remove the RTC driver
319  */
320 static int __devexit at91_rtc_remove(struct platform_device *pdev)
321 {
322         struct rtc_device *rtc = platform_get_drvdata(pdev);
323
324         /* Disable all interrupts */
325         at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
326                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
327                                         AT91_RTC_CALEV);
328         free_irq(AT91_ID_SYS, pdev);
329
330         rtc_device_unregister(rtc);
331         platform_set_drvdata(pdev, NULL);
332         device_init_wakeup(&pdev->dev, 0);
333
334         return 0;
335 }
336
337 #ifdef CONFIG_PM
338
339 /* AT91RM9200 RTC Power management control */
340
341 static struct timespec at91_rtc_delta;
342 static u32 at91_rtc_imr;
343
344 static int at91_rtc_suspend(struct platform_device *pdev, pm_message_t state)
345 {
346         struct rtc_time tm;
347         struct timespec time;
348
349         time.tv_nsec = 0;
350
351         /* calculate time delta for suspend */
352         at91_rtc_readtime(&pdev->dev, &tm);
353         rtc_tm_to_time(&tm, &time.tv_sec);
354         save_time_delta(&at91_rtc_delta, &time);
355
356         /* this IRQ is shared with DBGU and other hardware which isn't
357          * necessarily doing PM like we are...
358          */
359         at91_rtc_imr = at91_sys_read(AT91_RTC_IMR)
360                         & (AT91_RTC_ALARM|AT91_RTC_SECEV);
361         if (at91_rtc_imr) {
362                 if (device_may_wakeup(&pdev->dev))
363                         enable_irq_wake(AT91_ID_SYS);
364                 else
365                         at91_sys_write(AT91_RTC_IDR, at91_rtc_imr);
366         }
367
368         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__,
369                 1900 + tm.tm_year, tm.tm_mon, tm.tm_mday,
370                 tm.tm_hour, tm.tm_min, tm.tm_sec);
371
372         return 0;
373 }
374
375 static int at91_rtc_resume(struct platform_device *pdev)
376 {
377         struct rtc_time tm;
378         struct timespec time;
379
380         time.tv_nsec = 0;
381
382         at91_rtc_readtime(&pdev->dev, &tm);
383         rtc_tm_to_time(&tm, &time.tv_sec);
384         restore_time_delta(&at91_rtc_delta, &time);
385
386         if (at91_rtc_imr) {
387                 if (device_may_wakeup(&pdev->dev))
388                         disable_irq_wake(AT91_ID_SYS);
389                 else
390                         at91_sys_write(AT91_RTC_IER, at91_rtc_imr);
391         }
392
393         pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__,
394                 1900 + tm.tm_year, tm.tm_mon, tm.tm_mday,
395                 tm.tm_hour, tm.tm_min, tm.tm_sec);
396
397         return 0;
398 }
399 #else
400 #define at91_rtc_suspend NULL
401 #define at91_rtc_resume  NULL
402 #endif
403
404 static struct platform_driver at91_rtc_driver = {
405         .probe          = at91_rtc_probe,
406         .remove         = at91_rtc_remove,
407         .suspend        = at91_rtc_suspend,
408         .resume         = at91_rtc_resume,
409         .driver         = {
410                 .name   = "at91_rtc",
411                 .owner  = THIS_MODULE,
412         },
413 };
414
415 static int __init at91_rtc_init(void)
416 {
417         return platform_driver_register(&at91_rtc_driver);
418 }
419
420 static void __exit at91_rtc_exit(void)
421 {
422         platform_driver_unregister(&at91_rtc_driver);
423 }
424
425 module_init(at91_rtc_init);
426 module_exit(at91_rtc_exit);
427
428 MODULE_AUTHOR("Rick Bronson");
429 MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
430 MODULE_LICENSE("GPL");