Linux 2.6.22-rc3
[linux-2.6/next.git] / drivers / rtc / rtc-s3c.c
blob54b6130534686586aa817c449c5c02ca418b6e08
1 /* drivers/rtc/rtc-s3c.c
3 * Copyright (c) 2004,2006 Simtec Electronics
4 * Ben Dooks, <ben@simtec.co.uk>
5 * http://armlinux.simtec.co.uk/
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * S3C2410/S3C2440/S3C24XX Internal RTC Driver
14 #include <linux/module.h>
15 #include <linux/fs.h>
16 #include <linux/string.h>
17 #include <linux/init.h>
18 #include <linux/platform_device.h>
19 #include <linux/interrupt.h>
20 #include <linux/rtc.h>
21 #include <linux/bcd.h>
22 #include <linux/clk.h>
24 #include <asm/hardware.h>
25 #include <asm/uaccess.h>
26 #include <asm/io.h>
27 #include <asm/irq.h>
28 #include <asm/rtc.h>
30 #include <asm/mach/time.h>
32 #include <asm/arch/regs-rtc.h>
34 /* I have yet to find an S3C implementation with more than one
35 * of these rtc blocks in */
37 static struct resource *s3c_rtc_mem;
39 static void __iomem *s3c_rtc_base;
40 static int s3c_rtc_alarmno = NO_IRQ;
41 static int s3c_rtc_tickno = NO_IRQ;
42 static int s3c_rtc_freq = 1;
44 static DEFINE_SPINLOCK(s3c_rtc_pie_lock);
45 static unsigned int tick_count;
47 /* IRQ Handlers */
49 static irqreturn_t s3c_rtc_alarmirq(int irq, void *id)
51 struct rtc_device *rdev = id;
53 rtc_update_irq(rdev, 1, RTC_AF | RTC_IRQF);
54 return IRQ_HANDLED;
57 static irqreturn_t s3c_rtc_tickirq(int irq, void *id)
59 struct rtc_device *rdev = id;
61 rtc_update_irq(rdev, tick_count++, RTC_PF | RTC_IRQF);
62 return IRQ_HANDLED;
65 /* Update control registers */
66 static void s3c_rtc_setaie(int to)
68 unsigned int tmp;
70 pr_debug("%s: aie=%d\n", __FUNCTION__, to);
72 tmp = readb(s3c_rtc_base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;
74 if (to)
75 tmp |= S3C2410_RTCALM_ALMEN;
77 writeb(tmp, s3c_rtc_base + S3C2410_RTCALM);
80 static void s3c_rtc_setpie(int to)
82 unsigned int tmp;
84 pr_debug("%s: pie=%d\n", __FUNCTION__, to);
86 spin_lock_irq(&s3c_rtc_pie_lock);
87 tmp = readb(s3c_rtc_base + S3C2410_TICNT) & ~S3C2410_TICNT_ENABLE;
89 if (to)
90 tmp |= S3C2410_TICNT_ENABLE;
92 writeb(tmp, s3c_rtc_base + S3C2410_TICNT);
93 spin_unlock_irq(&s3c_rtc_pie_lock);
96 static void s3c_rtc_setfreq(int freq)
98 unsigned int tmp;
100 spin_lock_irq(&s3c_rtc_pie_lock);
101 tmp = readb(s3c_rtc_base + S3C2410_TICNT) & S3C2410_TICNT_ENABLE;
103 s3c_rtc_freq = freq;
105 tmp |= (128 / freq)-1;
107 writeb(tmp, s3c_rtc_base + S3C2410_TICNT);
108 spin_unlock_irq(&s3c_rtc_pie_lock);
111 /* Time read/write */
113 static int s3c_rtc_gettime(struct device *dev, struct rtc_time *rtc_tm)
115 unsigned int have_retried = 0;
116 void __iomem *base = s3c_rtc_base;
118 retry_get_time:
119 rtc_tm->tm_min = readb(base + S3C2410_RTCMIN);
120 rtc_tm->tm_hour = readb(base + S3C2410_RTCHOUR);
121 rtc_tm->tm_mday = readb(base + S3C2410_RTCDATE);
122 rtc_tm->tm_mon = readb(base + S3C2410_RTCMON);
123 rtc_tm->tm_year = readb(base + S3C2410_RTCYEAR);
124 rtc_tm->tm_sec = readb(base + S3C2410_RTCSEC);
126 /* the only way to work out wether the system was mid-update
127 * when we read it is to check the second counter, and if it
128 * is zero, then we re-try the entire read
131 if (rtc_tm->tm_sec == 0 && !have_retried) {
132 have_retried = 1;
133 goto retry_get_time;
136 pr_debug("read time %02x.%02x.%02x %02x/%02x/%02x\n",
137 rtc_tm->tm_year, rtc_tm->tm_mon, rtc_tm->tm_mday,
138 rtc_tm->tm_hour, rtc_tm->tm_min, rtc_tm->tm_sec);
140 BCD_TO_BIN(rtc_tm->tm_sec);
141 BCD_TO_BIN(rtc_tm->tm_min);
142 BCD_TO_BIN(rtc_tm->tm_hour);
143 BCD_TO_BIN(rtc_tm->tm_mday);
144 BCD_TO_BIN(rtc_tm->tm_mon);
145 BCD_TO_BIN(rtc_tm->tm_year);
147 rtc_tm->tm_year += 100;
148 rtc_tm->tm_mon -= 1;
150 return 0;
153 static int s3c_rtc_settime(struct device *dev, struct rtc_time *tm)
155 void __iomem *base = s3c_rtc_base;
156 int year = tm->tm_year - 100;
158 pr_debug("set time %02d.%02d.%02d %02d/%02d/%02d\n",
159 tm->tm_year, tm->tm_mon, tm->tm_mday,
160 tm->tm_hour, tm->tm_min, tm->tm_sec);
162 /* we get around y2k by simply not supporting it */
164 if (year < 0 || year >= 100) {
165 dev_err(dev, "rtc only supports 100 years\n");
166 return -EINVAL;
169 writeb(BIN2BCD(tm->tm_sec), base + S3C2410_RTCSEC);
170 writeb(BIN2BCD(tm->tm_min), base + S3C2410_RTCMIN);
171 writeb(BIN2BCD(tm->tm_hour), base + S3C2410_RTCHOUR);
172 writeb(BIN2BCD(tm->tm_mday), base + S3C2410_RTCDATE);
173 writeb(BIN2BCD(tm->tm_mon + 1), base + S3C2410_RTCMON);
174 writeb(BIN2BCD(year), base + S3C2410_RTCYEAR);
176 return 0;
179 static int s3c_rtc_getalarm(struct device *dev, struct rtc_wkalrm *alrm)
181 struct rtc_time *alm_tm = &alrm->time;
182 void __iomem *base = s3c_rtc_base;
183 unsigned int alm_en;
185 alm_tm->tm_sec = readb(base + S3C2410_ALMSEC);
186 alm_tm->tm_min = readb(base + S3C2410_ALMMIN);
187 alm_tm->tm_hour = readb(base + S3C2410_ALMHOUR);
188 alm_tm->tm_mon = readb(base + S3C2410_ALMMON);
189 alm_tm->tm_mday = readb(base + S3C2410_ALMDATE);
190 alm_tm->tm_year = readb(base + S3C2410_ALMYEAR);
192 alm_en = readb(base + S3C2410_RTCALM);
194 alrm->enabled = (alm_en & S3C2410_RTCALM_ALMEN) ? 1 : 0;
196 pr_debug("read alarm %02x %02x.%02x.%02x %02x/%02x/%02x\n",
197 alm_en,
198 alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
199 alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);
202 /* decode the alarm enable field */
204 if (alm_en & S3C2410_RTCALM_SECEN)
205 BCD_TO_BIN(alm_tm->tm_sec);
206 else
207 alm_tm->tm_sec = 0xff;
209 if (alm_en & S3C2410_RTCALM_MINEN)
210 BCD_TO_BIN(alm_tm->tm_min);
211 else
212 alm_tm->tm_min = 0xff;
214 if (alm_en & S3C2410_RTCALM_HOUREN)
215 BCD_TO_BIN(alm_tm->tm_hour);
216 else
217 alm_tm->tm_hour = 0xff;
219 if (alm_en & S3C2410_RTCALM_DAYEN)
220 BCD_TO_BIN(alm_tm->tm_mday);
221 else
222 alm_tm->tm_mday = 0xff;
224 if (alm_en & S3C2410_RTCALM_MONEN) {
225 BCD_TO_BIN(alm_tm->tm_mon);
226 alm_tm->tm_mon -= 1;
227 } else {
228 alm_tm->tm_mon = 0xff;
231 if (alm_en & S3C2410_RTCALM_YEAREN)
232 BCD_TO_BIN(alm_tm->tm_year);
233 else
234 alm_tm->tm_year = 0xffff;
236 return 0;
239 static int s3c_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
241 struct rtc_time *tm = &alrm->time;
242 void __iomem *base = s3c_rtc_base;
243 unsigned int alrm_en;
245 pr_debug("s3c_rtc_setalarm: %d, %02x/%02x/%02x %02x.%02x.%02x\n",
246 alrm->enabled,
247 tm->tm_mday & 0xff, tm->tm_mon & 0xff, tm->tm_year & 0xff,
248 tm->tm_hour & 0xff, tm->tm_min & 0xff, tm->tm_sec);
251 alrm_en = readb(base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
252 writeb(0x00, base + S3C2410_RTCALM);
254 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
255 alrm_en |= S3C2410_RTCALM_SECEN;
256 writeb(BIN2BCD(tm->tm_sec), base + S3C2410_ALMSEC);
259 if (tm->tm_min < 60 && tm->tm_min >= 0) {
260 alrm_en |= S3C2410_RTCALM_MINEN;
261 writeb(BIN2BCD(tm->tm_min), base + S3C2410_ALMMIN);
264 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
265 alrm_en |= S3C2410_RTCALM_HOUREN;
266 writeb(BIN2BCD(tm->tm_hour), base + S3C2410_ALMHOUR);
269 pr_debug("setting S3C2410_RTCALM to %08x\n", alrm_en);
271 writeb(alrm_en, base + S3C2410_RTCALM);
273 if (0) {
274 alrm_en = readb(base + S3C2410_RTCALM);
275 alrm_en &= ~S3C2410_RTCALM_ALMEN;
276 writeb(alrm_en, base + S3C2410_RTCALM);
277 disable_irq_wake(s3c_rtc_alarmno);
280 if (alrm->enabled)
281 enable_irq_wake(s3c_rtc_alarmno);
282 else
283 disable_irq_wake(s3c_rtc_alarmno);
285 return 0;
288 static int s3c_rtc_ioctl(struct device *dev,
289 unsigned int cmd, unsigned long arg)
291 unsigned int ret = -ENOIOCTLCMD;
293 switch (cmd) {
294 case RTC_AIE_OFF:
295 case RTC_AIE_ON:
296 s3c_rtc_setaie((cmd == RTC_AIE_ON) ? 1 : 0);
297 ret = 0;
298 break;
300 case RTC_PIE_OFF:
301 case RTC_PIE_ON:
302 tick_count = 0;
303 s3c_rtc_setpie((cmd == RTC_PIE_ON) ? 1 : 0);
304 ret = 0;
305 break;
307 case RTC_IRQP_READ:
308 ret = put_user(s3c_rtc_freq, (unsigned long __user *)arg);
309 break;
311 case RTC_IRQP_SET:
312 /* check for power of 2 */
314 if ((arg & (arg-1)) != 0 || arg < 1) {
315 ret = -EINVAL;
316 goto exit;
319 pr_debug("s3c2410_rtc: setting frequency %ld\n", arg);
321 s3c_rtc_setfreq(arg);
322 ret = 0;
323 break;
325 case RTC_UIE_ON:
326 case RTC_UIE_OFF:
327 ret = -EINVAL;
330 exit:
331 return ret;
334 static int s3c_rtc_proc(struct device *dev, struct seq_file *seq)
336 unsigned int ticnt = readb(s3c_rtc_base + S3C2410_TICNT);
338 seq_printf(seq, "periodic_IRQ\t: %s\n",
339 (ticnt & S3C2410_TICNT_ENABLE) ? "yes" : "no" );
341 seq_printf(seq, "periodic_freq\t: %d\n", s3c_rtc_freq);
343 return 0;
346 static int s3c_rtc_open(struct device *dev)
348 struct platform_device *pdev = to_platform_device(dev);
349 struct rtc_device *rtc_dev = platform_get_drvdata(pdev);
350 int ret;
352 ret = request_irq(s3c_rtc_alarmno, s3c_rtc_alarmirq,
353 IRQF_DISABLED, "s3c2410-rtc alarm", rtc_dev);
355 if (ret) {
356 dev_err(dev, "IRQ%d error %d\n", s3c_rtc_alarmno, ret);
357 return ret;
360 ret = request_irq(s3c_rtc_tickno, s3c_rtc_tickirq,
361 IRQF_DISABLED, "s3c2410-rtc tick", rtc_dev);
363 if (ret) {
364 dev_err(dev, "IRQ%d error %d\n", s3c_rtc_tickno, ret);
365 goto tick_err;
368 return ret;
370 tick_err:
371 free_irq(s3c_rtc_alarmno, rtc_dev);
372 return ret;
375 static void s3c_rtc_release(struct device *dev)
377 struct platform_device *pdev = to_platform_device(dev);
378 struct rtc_device *rtc_dev = platform_get_drvdata(pdev);
380 /* do not clear AIE here, it may be needed for wake */
382 s3c_rtc_setpie(0);
383 free_irq(s3c_rtc_alarmno, rtc_dev);
384 free_irq(s3c_rtc_tickno, rtc_dev);
387 static const struct rtc_class_ops s3c_rtcops = {
388 .open = s3c_rtc_open,
389 .release = s3c_rtc_release,
390 .ioctl = s3c_rtc_ioctl,
391 .read_time = s3c_rtc_gettime,
392 .set_time = s3c_rtc_settime,
393 .read_alarm = s3c_rtc_getalarm,
394 .set_alarm = s3c_rtc_setalarm,
395 .proc = s3c_rtc_proc,
398 static void s3c_rtc_enable(struct platform_device *pdev, int en)
400 void __iomem *base = s3c_rtc_base;
401 unsigned int tmp;
403 if (s3c_rtc_base == NULL)
404 return;
406 if (!en) {
407 tmp = readb(base + S3C2410_RTCCON);
408 writeb(tmp & ~S3C2410_RTCCON_RTCEN, base + S3C2410_RTCCON);
410 tmp = readb(base + S3C2410_TICNT);
411 writeb(tmp & ~S3C2410_TICNT_ENABLE, base + S3C2410_TICNT);
412 } else {
413 /* re-enable the device, and check it is ok */
415 if ((readb(base+S3C2410_RTCCON) & S3C2410_RTCCON_RTCEN) == 0){
416 dev_info(&pdev->dev, "rtc disabled, re-enabling\n");
418 tmp = readb(base + S3C2410_RTCCON);
419 writeb(tmp|S3C2410_RTCCON_RTCEN, base+S3C2410_RTCCON);
422 if ((readb(base + S3C2410_RTCCON) & S3C2410_RTCCON_CNTSEL)){
423 dev_info(&pdev->dev, "removing RTCCON_CNTSEL\n");
425 tmp = readb(base + S3C2410_RTCCON);
426 writeb(tmp& ~S3C2410_RTCCON_CNTSEL, base+S3C2410_RTCCON);
429 if ((readb(base + S3C2410_RTCCON) & S3C2410_RTCCON_CLKRST)){
430 dev_info(&pdev->dev, "removing RTCCON_CLKRST\n");
432 tmp = readb(base + S3C2410_RTCCON);
433 writeb(tmp & ~S3C2410_RTCCON_CLKRST, base+S3C2410_RTCCON);
438 static int s3c_rtc_remove(struct platform_device *dev)
440 struct rtc_device *rtc = platform_get_drvdata(dev);
442 platform_set_drvdata(dev, NULL);
443 rtc_device_unregister(rtc);
445 s3c_rtc_setpie(0);
446 s3c_rtc_setaie(0);
448 iounmap(s3c_rtc_base);
449 release_resource(s3c_rtc_mem);
450 kfree(s3c_rtc_mem);
452 return 0;
455 static int s3c_rtc_probe(struct platform_device *pdev)
457 struct rtc_device *rtc;
458 struct resource *res;
459 int ret;
461 pr_debug("%s: probe=%p\n", __FUNCTION__, pdev);
463 /* find the IRQs */
465 s3c_rtc_tickno = platform_get_irq(pdev, 1);
466 if (s3c_rtc_tickno < 0) {
467 dev_err(&pdev->dev, "no irq for rtc tick\n");
468 return -ENOENT;
471 s3c_rtc_alarmno = platform_get_irq(pdev, 0);
472 if (s3c_rtc_alarmno < 0) {
473 dev_err(&pdev->dev, "no irq for alarm\n");
474 return -ENOENT;
477 pr_debug("s3c2410_rtc: tick irq %d, alarm irq %d\n",
478 s3c_rtc_tickno, s3c_rtc_alarmno);
480 /* get the memory region */
482 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
483 if (res == NULL) {
484 dev_err(&pdev->dev, "failed to get memory region resource\n");
485 return -ENOENT;
488 s3c_rtc_mem = request_mem_region(res->start,
489 res->end-res->start+1,
490 pdev->name);
492 if (s3c_rtc_mem == NULL) {
493 dev_err(&pdev->dev, "failed to reserve memory region\n");
494 ret = -ENOENT;
495 goto err_nores;
498 s3c_rtc_base = ioremap(res->start, res->end - res->start + 1);
499 if (s3c_rtc_base == NULL) {
500 dev_err(&pdev->dev, "failed ioremap()\n");
501 ret = -EINVAL;
502 goto err_nomap;
505 /* check to see if everything is setup correctly */
507 s3c_rtc_enable(pdev, 1);
509 pr_debug("s3c2410_rtc: RTCCON=%02x\n",
510 readb(s3c_rtc_base + S3C2410_RTCCON));
512 s3c_rtc_setfreq(s3c_rtc_freq);
514 /* register RTC and exit */
516 rtc = rtc_device_register("s3c", &pdev->dev, &s3c_rtcops,
517 THIS_MODULE);
519 if (IS_ERR(rtc)) {
520 dev_err(&pdev->dev, "cannot attach rtc\n");
521 ret = PTR_ERR(rtc);
522 goto err_nortc;
525 rtc->max_user_freq = 128;
527 platform_set_drvdata(pdev, rtc);
528 return 0;
530 err_nortc:
531 s3c_rtc_enable(pdev, 0);
532 iounmap(s3c_rtc_base);
534 err_nomap:
535 release_resource(s3c_rtc_mem);
537 err_nores:
538 return ret;
541 #ifdef CONFIG_PM
543 /* RTC Power management control */
545 static struct timespec s3c_rtc_delta;
547 static int ticnt_save;
549 static int s3c_rtc_suspend(struct platform_device *pdev, pm_message_t state)
551 /* save TICNT for anyone using periodic interrupts */
552 ticnt_save = readb(s3c_rtc_base + S3C2410_TICNT);
553 s3c_rtc_enable(pdev, 0);
554 return 0;
557 static int s3c_rtc_resume(struct platform_device *pdev)
559 s3c_rtc_enable(pdev, 1);
560 writeb(ticnt_save, s3c_rtc_base + S3C2410_TICNT);
561 return 0;
563 #else
564 #define s3c_rtc_suspend NULL
565 #define s3c_rtc_resume NULL
566 #endif
568 static struct platform_driver s3c2410_rtcdrv = {
569 .probe = s3c_rtc_probe,
570 .remove = s3c_rtc_remove,
571 .suspend = s3c_rtc_suspend,
572 .resume = s3c_rtc_resume,
573 .driver = {
574 .name = "s3c2410-rtc",
575 .owner = THIS_MODULE,
579 static char __initdata banner[] = "S3C24XX RTC, (c) 2004,2006 Simtec Electronics\n";
581 static int __init s3c_rtc_init(void)
583 printk(banner);
584 return platform_driver_register(&s3c2410_rtcdrv);
587 static void __exit s3c_rtc_exit(void)
589 platform_driver_unregister(&s3c2410_rtcdrv);
592 module_init(s3c_rtc_init);
593 module_exit(s3c_rtc_exit);
595 MODULE_DESCRIPTION("Samsung S3C RTC Driver");
596 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
597 MODULE_LICENSE("GPL");