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>
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>
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;
49 static irqreturn_t s3c_rtc_alarmirq(int irq, void *id, struct pt_regs *r)
51 struct rtc_device *rdev = id;
53 rtc_update_irq(&rdev->class_dev, 1, RTC_AF | RTC_IRQF);
57 static irqreturn_t s3c_rtc_tickirq(int irq, void *id, struct pt_regs *r)
59 struct rtc_device *rdev = id;
61 rtc_update_irq(&rdev->class_dev, tick_count++, RTC_PF | RTC_IRQF);
65 /* Update control registers */
66 static void s3c_rtc_setaie(int to)
70 pr_debug("%s: aie=%d\n", __FUNCTION__, to);
72 tmp = readb(s3c_rtc_base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;
75 tmp |= S3C2410_RTCALM_ALMEN;
77 writeb(tmp, s3c_rtc_base + S3C2410_RTCALM);
80 static void s3c_rtc_setpie(int to)
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;
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)
100 spin_lock_irq(&s3c_rtc_pie_lock);
101 tmp = readb(s3c_rtc_base + S3C2410_TICNT) & S3C2410_TICNT_ENABLE;
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;
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) {
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;
153 static int s3c_rtc_settime(struct device *dev, struct rtc_time *tm)
155 void __iomem *base = s3c_rtc_base;
157 /* the rtc gets round the y2k problem by just not supporting it */
159 if (tm->tm_year > 100) {
160 dev_err(dev, "rtc only supports 100 years\n");
164 pr_debug("set time %02d.%02d.%02d %02d/%02d/%02d\n",
165 tm->tm_year, tm->tm_mon, tm->tm_mday,
166 tm->tm_hour, tm->tm_min, tm->tm_sec);
168 writeb(BIN2BCD(tm->tm_sec), base + S3C2410_RTCSEC);
169 writeb(BIN2BCD(tm->tm_min), base + S3C2410_RTCMIN);
170 writeb(BIN2BCD(tm->tm_hour), base + S3C2410_RTCHOUR);
171 writeb(BIN2BCD(tm->tm_mday), base + S3C2410_RTCDATE);
172 writeb(BIN2BCD(tm->tm_mon + 1), base + S3C2410_RTCMON);
173 writeb(BIN2BCD(tm->tm_year - 100), base + S3C2410_RTCYEAR);
178 static int s3c_rtc_getalarm(struct device *dev, struct rtc_wkalrm *alrm)
180 struct rtc_time *alm_tm = &alrm->time;
181 void __iomem *base = s3c_rtc_base;
184 alm_tm->tm_sec = readb(base + S3C2410_ALMSEC);
185 alm_tm->tm_min = readb(base + S3C2410_ALMMIN);
186 alm_tm->tm_hour = readb(base + S3C2410_ALMHOUR);
187 alm_tm->tm_mon = readb(base + S3C2410_ALMMON);
188 alm_tm->tm_mday = readb(base + S3C2410_ALMDATE);
189 alm_tm->tm_year = readb(base + S3C2410_ALMYEAR);
191 alm_en = readb(base + S3C2410_RTCALM);
193 pr_debug("read alarm %02x %02x.%02x.%02x %02x/%02x/%02x\n",
195 alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
196 alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);
199 /* decode the alarm enable field */
201 if (alm_en & S3C2410_RTCALM_SECEN)
202 BCD_TO_BIN(alm_tm->tm_sec);
204 alm_tm->tm_sec = 0xff;
206 if (alm_en & S3C2410_RTCALM_MINEN)
207 BCD_TO_BIN(alm_tm->tm_min);
209 alm_tm->tm_min = 0xff;
211 if (alm_en & S3C2410_RTCALM_HOUREN)
212 BCD_TO_BIN(alm_tm->tm_hour);
214 alm_tm->tm_hour = 0xff;
216 if (alm_en & S3C2410_RTCALM_DAYEN)
217 BCD_TO_BIN(alm_tm->tm_mday);
219 alm_tm->tm_mday = 0xff;
221 if (alm_en & S3C2410_RTCALM_MONEN) {
222 BCD_TO_BIN(alm_tm->tm_mon);
225 alm_tm->tm_mon = 0xff;
228 if (alm_en & S3C2410_RTCALM_YEAREN)
229 BCD_TO_BIN(alm_tm->tm_year);
231 alm_tm->tm_year = 0xffff;
236 static int s3c_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
238 struct rtc_time *tm = &alrm->time;
239 void __iomem *base = s3c_rtc_base;
240 unsigned int alrm_en;
242 pr_debug("s3c_rtc_setalarm: %d, %02x/%02x/%02x %02x.%02x.%02x\n",
244 tm->tm_mday & 0xff, tm->tm_mon & 0xff, tm->tm_year & 0xff,
245 tm->tm_hour & 0xff, tm->tm_min & 0xff, tm->tm_sec);
248 alrm_en = readb(base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
249 writeb(0x00, base + S3C2410_RTCALM);
251 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
252 alrm_en |= S3C2410_RTCALM_SECEN;
253 writeb(BIN2BCD(tm->tm_sec), base + S3C2410_ALMSEC);
256 if (tm->tm_min < 60 && tm->tm_min >= 0) {
257 alrm_en |= S3C2410_RTCALM_MINEN;
258 writeb(BIN2BCD(tm->tm_min), base + S3C2410_ALMMIN);
261 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
262 alrm_en |= S3C2410_RTCALM_HOUREN;
263 writeb(BIN2BCD(tm->tm_hour), base + S3C2410_ALMHOUR);
266 pr_debug("setting S3C2410_RTCALM to %08x\n", alrm_en);
268 writeb(alrm_en, base + S3C2410_RTCALM);
271 alrm_en = readb(base + S3C2410_RTCALM);
272 alrm_en &= ~S3C2410_RTCALM_ALMEN;
273 writeb(alrm_en, base + S3C2410_RTCALM);
274 disable_irq_wake(s3c_rtc_alarmno);
278 enable_irq_wake(s3c_rtc_alarmno);
280 disable_irq_wake(s3c_rtc_alarmno);
285 static int s3c_rtc_ioctl(struct device *dev,
286 unsigned int cmd, unsigned long arg)
288 unsigned int ret = -ENOIOCTLCMD;
293 s3c_rtc_setaie((cmd == RTC_AIE_ON) ? 1 : 0);
300 s3c_rtc_setpie((cmd == RTC_PIE_ON) ? 1 : 0);
305 ret = put_user(s3c_rtc_freq, (unsigned long __user *)arg);
309 /* check for power of 2 */
311 if ((arg & (arg-1)) != 0 || arg < 1) {
316 pr_debug("s3c2410_rtc: setting frequency %ld\n", arg);
318 s3c_rtc_setfreq(arg);
331 static int s3c_rtc_proc(struct device *dev, struct seq_file *seq)
333 unsigned int rtcalm = readb(s3c_rtc_base + S3C2410_RTCALM);
334 unsigned int ticnt = readb(s3c_rtc_base + S3C2410_TICNT);
336 seq_printf(seq, "alarm_IRQ\t: %s\n",
337 (rtcalm & S3C2410_RTCALM_ALMEN) ? "yes" : "no" );
339 seq_printf(seq, "periodic_IRQ\t: %s\n",
340 (ticnt & S3C2410_TICNT_ENABLE) ? "yes" : "no" );
342 seq_printf(seq, "periodic_freq\t: %d\n", s3c_rtc_freq);
347 static int s3c_rtc_open(struct device *dev)
349 struct platform_device *pdev = to_platform_device(dev);
350 struct rtc_device *rtc_dev = platform_get_drvdata(pdev);
353 ret = request_irq(s3c_rtc_alarmno, s3c_rtc_alarmirq,
354 SA_INTERRUPT, "s3c2410-rtc alarm", rtc_dev);
357 dev_err(dev, "IRQ%d error %d\n", s3c_rtc_alarmno, ret);
361 ret = request_irq(s3c_rtc_tickno, s3c_rtc_tickirq,
362 SA_INTERRUPT, "s3c2410-rtc tick", rtc_dev);
365 dev_err(dev, "IRQ%d error %d\n", s3c_rtc_tickno, ret);
372 free_irq(s3c_rtc_alarmno, rtc_dev);
376 static void s3c_rtc_release(struct device *dev)
378 struct platform_device *pdev = to_platform_device(dev);
379 struct rtc_device *rtc_dev = platform_get_drvdata(pdev);
381 /* do not clear AIE here, it may be needed for wake */
384 free_irq(s3c_rtc_alarmno, rtc_dev);
385 free_irq(s3c_rtc_tickno, rtc_dev);
388 static struct rtc_class_ops s3c_rtcops = {
389 .open = s3c_rtc_open,
390 .release = s3c_rtc_release,
391 .ioctl = s3c_rtc_ioctl,
392 .read_time = s3c_rtc_gettime,
393 .set_time = s3c_rtc_settime,
394 .read_alarm = s3c_rtc_getalarm,
395 .set_alarm = s3c_rtc_setalarm,
396 .proc = s3c_rtc_proc,
399 static void s3c_rtc_enable(struct platform_device *pdev, int en)
401 void __iomem *base = s3c_rtc_base;
404 if (s3c_rtc_base == NULL)
408 tmp = readb(base + S3C2410_RTCCON);
409 writeb(tmp & ~S3C2410_RTCCON_RTCEN, base + S3C2410_RTCCON);
411 tmp = readb(base + S3C2410_TICNT);
412 writeb(tmp & ~S3C2410_TICNT_ENABLE, base + S3C2410_TICNT);
414 /* re-enable the device, and check it is ok */
416 if ((readb(base+S3C2410_RTCCON) & S3C2410_RTCCON_RTCEN) == 0){
417 dev_info(&pdev->dev, "rtc disabled, re-enabling\n");
419 tmp = readb(base + S3C2410_RTCCON);
420 writeb(tmp|S3C2410_RTCCON_RTCEN, base+S3C2410_RTCCON);
423 if ((readb(base + S3C2410_RTCCON) & S3C2410_RTCCON_CNTSEL)){
424 dev_info(&pdev->dev, "removing RTCCON_CNTSEL\n");
426 tmp = readb(base + S3C2410_RTCCON);
427 writeb(tmp& ~S3C2410_RTCCON_CNTSEL, base+S3C2410_RTCCON);
430 if ((readb(base + S3C2410_RTCCON) & S3C2410_RTCCON_CLKRST)){
431 dev_info(&pdev->dev, "removing RTCCON_CLKRST\n");
433 tmp = readb(base + S3C2410_RTCCON);
434 writeb(tmp & ~S3C2410_RTCCON_CLKRST, base+S3C2410_RTCCON);
439 static int s3c_rtc_remove(struct platform_device *dev)
441 struct rtc_device *rtc = platform_get_drvdata(dev);
443 platform_set_drvdata(dev, NULL);
444 rtc_device_unregister(rtc);
449 iounmap(s3c_rtc_base);
450 release_resource(s3c_rtc_mem);
456 static int s3c_rtc_probe(struct platform_device *pdev)
458 struct rtc_device *rtc;
459 struct resource *res;
462 pr_debug("%s: probe=%p\n", __FUNCTION__, pdev);
466 s3c_rtc_tickno = platform_get_irq(pdev, 1);
467 if (s3c_rtc_tickno < 0) {
468 dev_err(&pdev->dev, "no irq for rtc tick\n");
472 s3c_rtc_alarmno = platform_get_irq(pdev, 0);
473 if (s3c_rtc_alarmno < 0) {
474 dev_err(&pdev->dev, "no irq for alarm\n");
478 pr_debug("s3c2410_rtc: tick irq %d, alarm irq %d\n",
479 s3c_rtc_tickno, s3c_rtc_alarmno);
481 /* get the memory region */
483 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
485 dev_err(&pdev->dev, "failed to get memory region resource\n");
489 s3c_rtc_mem = request_mem_region(res->start,
490 res->end-res->start+1,
493 if (s3c_rtc_mem == NULL) {
494 dev_err(&pdev->dev, "failed to reserve memory region\n");
499 s3c_rtc_base = ioremap(res->start, res->end - res->start + 1);
500 if (s3c_rtc_base == NULL) {
501 dev_err(&pdev->dev, "failed ioremap()\n");
506 /* check to see if everything is setup correctly */
508 s3c_rtc_enable(pdev, 1);
510 pr_debug("s3c2410_rtc: RTCCON=%02x\n",
511 readb(s3c_rtc_base + S3C2410_RTCCON));
513 s3c_rtc_setfreq(s3c_rtc_freq);
515 /* register RTC and exit */
517 rtc = rtc_device_register("s3c", &pdev->dev, &s3c_rtcops,
521 dev_err(&pdev->dev, "cannot attach rtc\n");
526 rtc->max_user_freq = 128;
528 platform_set_drvdata(pdev, rtc);
532 s3c_rtc_enable(pdev, 0);
533 iounmap(s3c_rtc_base);
536 release_resource(s3c_rtc_mem);
544 /* RTC Power management control */
546 static struct timespec s3c_rtc_delta;
548 static int ticnt_save;
550 static int s3c_rtc_suspend(struct platform_device *pdev, pm_message_t state)
553 struct timespec time;
557 /* save TICNT for anyone using periodic interrupts */
559 ticnt_save = readb(s3c_rtc_base + S3C2410_TICNT);
561 /* calculate time delta for suspend */
563 s3c_rtc_gettime(&pdev->dev, &tm);
564 rtc_tm_to_time(&tm, &time.tv_sec);
565 save_time_delta(&s3c_rtc_delta, &time);
566 s3c_rtc_enable(pdev, 0);
571 static int s3c_rtc_resume(struct platform_device *pdev)
574 struct timespec time;
578 s3c_rtc_enable(pdev, 1);
579 s3c_rtc_gettime(&pdev->dev, &tm);
580 rtc_tm_to_time(&tm, &time.tv_sec);
581 restore_time_delta(&s3c_rtc_delta, &time);
583 writeb(ticnt_save, s3c_rtc_base + S3C2410_TICNT);
587 #define s3c_rtc_suspend NULL
588 #define s3c_rtc_resume NULL
591 static struct platform_driver s3c2410_rtcdrv = {
592 .probe = s3c_rtc_probe,
593 .remove = s3c_rtc_remove,
594 .suspend = s3c_rtc_suspend,
595 .resume = s3c_rtc_resume,
597 .name = "s3c2410-rtc",
598 .owner = THIS_MODULE,
602 static char __initdata banner[] = "S3C24XX RTC, (c) 2004,2006 Simtec Electronics\n";
604 static int __init s3c_rtc_init(void)
607 return platform_driver_register(&s3c2410_rtcdrv);
610 static void __exit s3c_rtc_exit(void)
612 platform_driver_unregister(&s3c2410_rtcdrv);
615 module_init(s3c_rtc_init);
616 module_exit(s3c_rtc_exit);
618 MODULE_DESCRIPTION("Samsung S3C RTC Driver");
619 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
620 MODULE_LICENSE("GPL");