1 /* drivers/char/s3c2410_rtc.c
3 * Copyright (c) 2004 Simtec Electronics <linux@simtec.co.uk>
4 * http://www.simtec.co.uk/products/SWLINUX/
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * S3C2410 Internal RTC Driver
13 * 08-Nov-2004 BJD Initial creation
14 * 12-Nov-2004 BJD Added periodic IRQ and PM code
15 * 22-Nov-2004 BJD Sign-test on alarm code to check for <0
18 #include <linux/module.h>
20 #include <linux/string.h>
21 #include <linux/init.h>
22 #include <linux/device.h>
23 #include <linux/interrupt.h>
24 #include <linux/rtc.h>
25 #include <linux/bcd.h>
27 #include <asm/hardware.h>
28 #include <asm/uaccess.h>
33 #include <asm/mach/time.h>
35 #include <asm/hardware/clock.h>
36 #include <asm/arch/regs-rtc.h>
38 /* need this for the RTC_AF definitions */
39 #include <linux/mc146818rtc.h>
42 #define S3C2410_VA_RTC s3c2410_rtc_base
44 static struct resource *s3c2410_rtc_mem;
46 static void __iomem *s3c2410_rtc_base;
47 static int s3c2410_rtc_alarmno = NO_IRQ;
48 static int s3c2410_rtc_tickno = NO_IRQ;
49 static int s3c2410_rtc_freq = 1;
51 static spinlock_t s3c2410_rtc_pie_lock = SPIN_LOCK_UNLOCKED;
55 static irqreturn_t s3c2410_rtc_alarmirq(int irq, void *id, struct pt_regs *r)
57 rtc_update(1, RTC_AF | RTC_IRQF);
61 static irqreturn_t s3c2410_rtc_tickirq(int irq, void *id, struct pt_regs *r)
63 rtc_update(1, RTC_PF | RTC_IRQF);
67 /* Update control registers */
68 static void s3c2410_rtc_setaie(int to)
72 pr_debug("%s: aie=%d\n", __FUNCTION__, to);
74 tmp = readb(S3C2410_RTCALM);
77 tmp |= S3C2410_RTCALM_ALMEN;
79 tmp &= ~S3C2410_RTCALM_ALMEN;
82 writeb(tmp, S3C2410_RTCALM);
85 static void s3c2410_rtc_setpie(int to)
89 pr_debug("%s: pie=%d\n", __FUNCTION__, to);
91 spin_lock_irq(&s3c2410_rtc_pie_lock);
92 tmp = readb(S3C2410_TICNT) & ~S3C2410_TICNT_ENABLE;
95 tmp |= S3C2410_TICNT_ENABLE;
97 writeb(tmp, S3C2410_TICNT);
98 spin_unlock_irq(&s3c2410_rtc_pie_lock);
101 static void s3c2410_rtc_setfreq(int freq)
105 spin_lock_irq(&s3c2410_rtc_pie_lock);
106 tmp = readb(S3C2410_TICNT) & S3C2410_TICNT_ENABLE;
108 s3c2410_rtc_freq = freq;
110 tmp |= (128 / freq)-1;
112 writeb(tmp, S3C2410_TICNT);
113 spin_unlock_irq(&s3c2410_rtc_pie_lock);
116 /* Time read/write */
118 static void s3c2410_rtc_gettime(struct rtc_time *rtc_tm)
120 unsigned int have_retried = 0;
123 rtc_tm->tm_min = readb(S3C2410_RTCMIN);
124 rtc_tm->tm_hour = readb(S3C2410_RTCHOUR);
125 rtc_tm->tm_mday = readb(S3C2410_RTCDATE);
126 rtc_tm->tm_mon = readb(S3C2410_RTCMON);
127 rtc_tm->tm_year = readb(S3C2410_RTCYEAR);
128 rtc_tm->tm_sec = readb(S3C2410_RTCSEC);
130 /* the only way to work out wether the system was mid-update
131 * when we read it is to check the second counter, and if it
132 * is zero, then we re-try the entire read
135 if (rtc_tm->tm_sec == 0 && !have_retried) {
140 pr_debug("read time %02x.%02x.%02x %02x/%02x/%02x\n",
141 rtc_tm->tm_year, rtc_tm->tm_mon, rtc_tm->tm_mday,
142 rtc_tm->tm_hour, rtc_tm->tm_min, rtc_tm->tm_sec);
144 BCD_TO_BIN(rtc_tm->tm_sec);
145 BCD_TO_BIN(rtc_tm->tm_min);
146 BCD_TO_BIN(rtc_tm->tm_hour);
147 BCD_TO_BIN(rtc_tm->tm_mday);
148 BCD_TO_BIN(rtc_tm->tm_mon);
149 BCD_TO_BIN(rtc_tm->tm_year);
151 rtc_tm->tm_year += 100;
156 static int s3c2410_rtc_settime(struct rtc_time *tm)
158 /* the rtc gets round the y2k problem by just not supporting it */
160 if (tm->tm_year < 100)
163 writeb(BIN2BCD(tm->tm_sec), S3C2410_RTCSEC);
164 writeb(BIN2BCD(tm->tm_min), S3C2410_RTCMIN);
165 writeb(BIN2BCD(tm->tm_hour), S3C2410_RTCHOUR);
166 writeb(BIN2BCD(tm->tm_mday), S3C2410_RTCDATE);
167 writeb(BIN2BCD(tm->tm_mon + 1), S3C2410_RTCMON);
168 writeb(BIN2BCD(tm->tm_year - 100), S3C2410_RTCYEAR);
173 static void s3c2410_rtc_getalarm(struct rtc_wkalrm *alrm)
175 struct rtc_time *alm_tm = &alrm->time;
178 alm_tm->tm_sec = readb(S3C2410_ALMSEC);
179 alm_tm->tm_min = readb(S3C2410_ALMMIN);
180 alm_tm->tm_hour = readb(S3C2410_ALMHOUR);
181 alm_tm->tm_mon = readb(S3C2410_ALMMON);
182 alm_tm->tm_mday = readb(S3C2410_ALMDATE);
183 alm_tm->tm_year = readb(S3C2410_ALMYEAR);
185 alm_en = readb(S3C2410_RTCALM);
187 pr_debug("read alarm %02x %02x.%02x.%02x %02x/%02x/%02x\n",
189 alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
190 alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);
193 /* decode the alarm enable field */
195 if (alm_en & S3C2410_RTCALM_SECEN) {
196 BCD_TO_BIN(alm_tm->tm_sec);
198 alm_tm->tm_sec = 0xff;
201 if (alm_en & S3C2410_RTCALM_MINEN) {
202 BCD_TO_BIN(alm_tm->tm_min);
204 alm_tm->tm_min = 0xff;
207 if (alm_en & S3C2410_RTCALM_HOUREN) {
208 BCD_TO_BIN(alm_tm->tm_hour);
210 alm_tm->tm_hour = 0xff;
213 if (alm_en & S3C2410_RTCALM_DAYEN) {
214 BCD_TO_BIN(alm_tm->tm_mday);
216 alm_tm->tm_mday = 0xff;
219 if (alm_en & S3C2410_RTCALM_MONEN) {
220 BCD_TO_BIN(alm_tm->tm_mon);
223 alm_tm->tm_mon = 0xff;
226 if (alm_en & S3C2410_RTCALM_YEAREN) {
227 BCD_TO_BIN(alm_tm->tm_year);
229 alm_tm->tm_year = 0xffff;
232 /* todo - set alrm->enabled ? */
235 static int s3c2410_rtc_setalarm(struct rtc_wkalrm *alrm)
237 struct rtc_time *tm = &alrm->time;
238 unsigned int alrm_en;
240 pr_debug("s3c2410_rtc_setalarm: %d, %02x/%02x/%02x %02x.%02x.%02x\n",
242 tm->tm_mday & 0xff, tm->tm_mon & 0xff, tm->tm_year & 0xff,
243 tm->tm_hour & 0xff, tm->tm_min & 0xff, tm->tm_sec);
245 if (alrm->enabled || 1) {
246 alrm_en = readb(S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
247 writeb(0x00, S3C2410_RTCALM);
249 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
250 alrm_en |= S3C2410_RTCALM_SECEN;
251 writeb(BIN2BCD(tm->tm_sec), S3C2410_ALMSEC);
254 if (tm->tm_min < 60 && tm->tm_min >= 0) {
255 alrm_en |= S3C2410_RTCALM_MINEN;
256 writeb(BIN2BCD(tm->tm_min), S3C2410_ALMMIN);
259 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
260 alrm_en |= S3C2410_RTCALM_HOUREN;
261 writeb(BIN2BCD(tm->tm_hour), S3C2410_ALMHOUR);
264 pr_debug("setting S3C2410_RTCALM to %08x\n", alrm_en);
266 writeb(alrm_en, S3C2410_RTCALM);
267 enable_irq_wake(s3c2410_rtc_alarmno);
269 alrm_en = readb(S3C2410_RTCALM);
270 alrm_en &= ~S3C2410_RTCALM_ALMEN;
271 writeb(alrm_en, S3C2410_RTCALM);
272 disable_irq_wake(s3c2410_rtc_alarmno);
278 static int s3c2410_rtc_ioctl(unsigned int cmd, unsigned long arg)
283 s3c2410_rtc_setaie((cmd == RTC_AIE_ON) ? 1 : 0);
288 s3c2410_rtc_setpie((cmd == RTC_PIE_ON) ? 1 : 0);
292 return put_user(s3c2410_rtc_freq, (unsigned long __user *)arg);
295 if (arg < 1 || arg > 64)
298 if (!capable(CAP_SYS_RESOURCE))
301 /* check for power of 2 */
303 if ((arg & (arg-1)) != 0)
306 pr_debug("s3c2410_rtc: setting frequency %ld\n", arg);
308 s3c2410_rtc_setfreq(arg);
319 static int s3c2410_rtc_proc(char *buf)
321 unsigned int rtcalm = readb(S3C2410_RTCALM);
322 unsigned int ticnt = readb (S3C2410_TICNT);
325 p += sprintf(p, "alarm_IRQ\t: %s\n",
326 (rtcalm & S3C2410_RTCALM_ALMEN) ? "yes" : "no" );
327 p += sprintf(p, "periodic_IRQ\t: %s\n",
328 (ticnt & S3C2410_TICNT_ENABLE) ? "yes" : "no" );
329 p += sprintf(p, "periodic_freq\t: %d\n", s3c2410_rtc_freq);
334 static int s3c2410_rtc_open(void)
338 ret = request_irq(s3c2410_rtc_alarmno, s3c2410_rtc_alarmirq,
339 SA_INTERRUPT, "s3c2410-rtc alarm", NULL);
342 printk(KERN_ERR "IRQ%d already in use\n", s3c2410_rtc_alarmno);
344 ret = request_irq(s3c2410_rtc_tickno, s3c2410_rtc_tickirq,
345 SA_INTERRUPT, "s3c2410-rtc tick", NULL);
348 printk(KERN_ERR "IRQ%d already in use\n", s3c2410_rtc_tickno);
355 free_irq(s3c2410_rtc_alarmno, NULL);
359 static void s3c2410_rtc_release(void)
361 /* do not clear AIE here, it may be needed for wake */
363 s3c2410_rtc_setpie(0);
364 free_irq(s3c2410_rtc_alarmno, NULL);
365 free_irq(s3c2410_rtc_tickno, NULL);
368 static struct rtc_ops s3c2410_rtcops = {
369 .owner = THIS_MODULE,
370 .open = s3c2410_rtc_open,
371 .release = s3c2410_rtc_release,
372 .ioctl = s3c2410_rtc_ioctl,
373 .read_time = s3c2410_rtc_gettime,
374 .set_time = s3c2410_rtc_settime,
375 .read_alarm = s3c2410_rtc_getalarm,
376 .set_alarm = s3c2410_rtc_setalarm,
377 .proc = s3c2410_rtc_proc,
380 static void s3c2410_rtc_enable(struct device *dev, int en)
384 if (s3c2410_rtc_base == NULL)
388 tmp = readb(S3C2410_RTCCON);
389 writeb(tmp & ~S3C2410_RTCCON_RTCEN, S3C2410_RTCCON);
391 tmp = readb(S3C2410_TICNT);
392 writeb(tmp & ~S3C2410_TICNT_ENABLE, S3C2410_TICNT);
394 /* re-enable the device, and check it is ok */
396 if ((readb(S3C2410_RTCCON) & S3C2410_RTCCON_RTCEN) == 0){
397 dev_info(dev, "rtc disabled, re-enabling\n");
399 tmp = readb(S3C2410_RTCCON);
400 writeb(tmp | S3C2410_RTCCON_RTCEN , S3C2410_RTCCON);
403 if ((readb(S3C2410_RTCCON) & S3C2410_RTCCON_CNTSEL)){
404 dev_info(dev, "removing S3C2410_RTCCON_CNTSEL\n");
406 tmp = readb(S3C2410_RTCCON);
407 writeb(tmp& ~S3C2410_RTCCON_CNTSEL , S3C2410_RTCCON);
410 if ((readb(S3C2410_RTCCON) & S3C2410_RTCCON_CLKRST)){
411 dev_info(dev, "removing S3C2410_RTCCON_CLKRST\n");
413 tmp = readb(S3C2410_RTCCON);
414 writeb(tmp & ~S3C2410_RTCCON_CLKRST, S3C2410_RTCCON);
419 static int s3c2410_rtc_remove(struct device *dev)
421 unregister_rtc(&s3c2410_rtcops);
423 s3c2410_rtc_setpie(0);
424 s3c2410_rtc_setaie(0);
426 if (s3c2410_rtc_mem != NULL) {
427 pr_debug("s3c2410_rtc: releasing s3c2410_rtc_mem\n");
428 iounmap(s3c2410_rtc_base);
429 release_resource(s3c2410_rtc_mem);
430 kfree(s3c2410_rtc_mem);
436 static int s3c2410_rtc_probe(struct device *dev)
438 struct platform_device *pdev = to_platform_device(dev);
439 struct resource *res;
442 pr_debug("%s: probe=%p, device=%p\n", __FUNCTION__, pdev, dev);
446 s3c2410_rtc_tickno = platform_get_irq(pdev, 1);
447 if (s3c2410_rtc_tickno <= 0) {
448 dev_err(dev, "no irq for rtc tick\n");
452 s3c2410_rtc_alarmno = platform_get_irq(pdev, 0);
453 if (s3c2410_rtc_alarmno <= 0) {
454 dev_err(dev, "no irq for alarm\n");
458 pr_debug("s3c2410_rtc: tick irq %d, alarm irq %d\n",
459 s3c2410_rtc_tickno, s3c2410_rtc_alarmno);
461 /* get the memory region */
463 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
465 dev_err(dev, "failed to get memory region resource\n");
469 s3c2410_rtc_mem = request_mem_region(res->start, res->end-res->start+1,
472 if (s3c2410_rtc_mem == NULL) {
473 dev_err(dev, "failed to reserve memory region\n");
478 s3c2410_rtc_base = ioremap(res->start, res->end - res->start + 1);
479 if (s3c2410_rtc_base == NULL) {
480 dev_err(dev, "failed ioremap()\n");
485 s3c2410_rtc_mem = res;
486 pr_debug("s3c2410_rtc_base=%p\n", s3c2410_rtc_base);
488 pr_debug("s3c2410_rtc: RTCCON=%02x\n", readb(S3C2410_RTCCON));
490 /* check to see if everything is setup correctly */
492 s3c2410_rtc_enable(dev, 1);
494 pr_debug("s3c2410_rtc: RTCCON=%02x\n", readb(S3C2410_RTCCON));
496 s3c2410_rtc_setfreq(s3c2410_rtc_freq);
498 /* register RTC and exit */
500 register_rtc(&s3c2410_rtcops);
504 dev_err(dev, "error %d during initialisation\n", ret);
511 /* S3C2410 RTC Power management control */
513 static struct timespec s3c2410_rtc_delta;
515 static int ticnt_save;
517 static int s3c2410_rtc_suspend(struct device *dev, u32 state, u32 level)
520 struct timespec time;
524 if (level == SUSPEND_POWER_DOWN) {
525 /* save TICNT for anyone using periodic interrupts */
527 ticnt_save = readb(S3C2410_TICNT);
529 /* calculate time delta for suspend */
531 s3c2410_rtc_gettime(&tm);
532 rtc_tm_to_time(&tm, &time.tv_sec);
533 save_time_delta(&s3c2410_rtc_delta, &time);
534 s3c2410_rtc_enable(dev, 0);
540 static int s3c2410_rtc_resume(struct device *dev, u32 level)
543 struct timespec time;
547 s3c2410_rtc_enable(dev, 1);
548 s3c2410_rtc_gettime(&tm);
549 rtc_tm_to_time(&tm, &time.tv_sec);
550 restore_time_delta(&s3c2410_rtc_delta, &time);
552 writeb(ticnt_save, S3C2410_TICNT);
556 #define s3c2410_rtc_suspend NULL
557 #define s3c2410_rtc_resume NULL
560 static struct device_driver s3c2410_rtcdrv = {
561 .name = "s3c2410-rtc",
562 .bus = &platform_bus_type,
563 .probe = s3c2410_rtc_probe,
564 .remove = s3c2410_rtc_remove,
565 .suspend = s3c2410_rtc_suspend,
566 .resume = s3c2410_rtc_resume,
569 static char __initdata banner[] = "S3C2410 RTC, (c) 2004 Simtec Electronics\n";
571 static int __init s3c2410_rtc_init(void)
574 return driver_register(&s3c2410_rtcdrv);
577 static void __exit s3c2410_rtc_exit(void)
579 driver_unregister(&s3c2410_rtcdrv);
582 module_init(s3c2410_rtc_init);
583 module_exit(s3c2410_rtc_exit);
585 MODULE_DESCRIPTION("S3C24XX RTC Driver");
586 MODULE_AUTHOR("Ben Dooks, <ben@simtec.co.uk>");
587 MODULE_LICENSE("GPL");