2 * SuperH On-Chip RTC Support
4 * Copyright (C) 2006, 2007, 2008 Paul Mundt
5 * Copyright (C) 2006 Jamie Lenehan
6 * Copyright (C) 2008 Angelo Castello
8 * Based on the old arch/sh/kernel/cpu/rtc.c by:
10 * Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
11 * Copyright (C) 1999 Tetsuya Okada & Niibe Yutaka
13 * This file is subject to the terms and conditions of the GNU General Public
14 * License. See the file "COPYING" in the main directory of this archive
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/bcd.h>
20 #include <linux/rtc.h>
21 #include <linux/init.h>
22 #include <linux/platform_device.h>
23 #include <linux/seq_file.h>
24 #include <linux/interrupt.h>
25 #include <linux/spinlock.h>
29 #define DRV_NAME "sh-rtc"
30 #define DRV_VERSION "0.2.0"
32 #define RTC_REG(r) ((r) * rtc_reg_size)
34 #define R64CNT RTC_REG(0)
36 #define RSECCNT RTC_REG(1) /* RTC sec */
37 #define RMINCNT RTC_REG(2) /* RTC min */
38 #define RHRCNT RTC_REG(3) /* RTC hour */
39 #define RWKCNT RTC_REG(4) /* RTC week */
40 #define RDAYCNT RTC_REG(5) /* RTC day */
41 #define RMONCNT RTC_REG(6) /* RTC month */
42 #define RYRCNT RTC_REG(7) /* RTC year */
43 #define RSECAR RTC_REG(8) /* ALARM sec */
44 #define RMINAR RTC_REG(9) /* ALARM min */
45 #define RHRAR RTC_REG(10) /* ALARM hour */
46 #define RWKAR RTC_REG(11) /* ALARM week */
47 #define RDAYAR RTC_REG(12) /* ALARM day */
48 #define RMONAR RTC_REG(13) /* ALARM month */
49 #define RCR1 RTC_REG(14) /* Control */
50 #define RCR2 RTC_REG(15) /* Control */
53 * Note on RYRAR and RCR3: Up until this point most of the register
54 * definitions are consistent across all of the available parts. However,
55 * the placement of the optional RYRAR and RCR3 (the RYRAR control
56 * register used to control RYRCNT/RYRAR compare) varies considerably
57 * across various parts, occasionally being mapped in to a completely
58 * unrelated address space. For proper RYRAR support a separate resource
59 * would have to be handed off, but as this is purely optional in
60 * practice, we simply opt not to support it, thereby keeping the code
61 * quite a bit more simplified.
64 /* ALARM Bits - or with BCD encoded value */
65 #define AR_ENB 0x80 /* Enable for alarm cmp */
68 #define PF_HP 0x100 /* Enable Half Period to support 8,32,128Hz */
69 #define PF_COUNT 0x200 /* Half periodic counter */
70 #define PF_OXS 0x400 /* Periodic One x Second */
71 #define PF_KOU 0x800 /* Kernel or User periodic request 1=kernel */
75 #define RCR1_CF 0x80 /* Carry Flag */
76 #define RCR1_CIE 0x10 /* Carry Interrupt Enable */
77 #define RCR1_AIE 0x08 /* Alarm Interrupt Enable */
78 #define RCR1_AF 0x01 /* Alarm Flag */
81 #define RCR2_PEF 0x80 /* PEriodic interrupt Flag */
82 #define RCR2_PESMASK 0x70 /* Periodic interrupt Set */
83 #define RCR2_RTCEN 0x08 /* ENable RTC */
84 #define RCR2_ADJ 0x04 /* ADJustment (30-second) */
85 #define RCR2_RESET 0x02 /* Reset bit */
86 #define RCR2_START 0x01 /* Start bit */
89 void __iomem *regbase;
90 unsigned long regsize;
95 struct rtc_device *rtc_dev;
97 unsigned long capabilities; /* See asm-sh/rtc.h for cap bits */
98 unsigned short periodic_freq;
101 static irqreturn_t sh_rtc_interrupt(int irq, void *dev_id)
103 struct sh_rtc *rtc = dev_id;
106 spin_lock(&rtc->lock);
108 tmp = readb(rtc->regbase + RCR1);
110 writeb(tmp, rtc->regbase + RCR1);
112 /* Users have requested One x Second IRQ */
113 if (rtc->periodic_freq & PF_OXS)
114 rtc_update_irq(rtc->rtc_dev, 1, RTC_UF | RTC_IRQF);
116 spin_unlock(&rtc->lock);
121 static irqreturn_t sh_rtc_alarm(int irq, void *dev_id)
123 struct sh_rtc *rtc = dev_id;
126 spin_lock(&rtc->lock);
128 tmp = readb(rtc->regbase + RCR1);
129 tmp &= ~(RCR1_AF | RCR1_AIE);
130 writeb(tmp, rtc->regbase + RCR1);
132 rtc_update_irq(rtc->rtc_dev, 1, RTC_AF | RTC_IRQF);
134 spin_unlock(&rtc->lock);
139 static irqreturn_t sh_rtc_periodic(int irq, void *dev_id)
141 struct sh_rtc *rtc = dev_id;
142 struct rtc_device *rtc_dev = rtc->rtc_dev;
145 spin_lock(&rtc->lock);
147 tmp = readb(rtc->regbase + RCR2);
149 writeb(tmp, rtc->regbase + RCR2);
151 /* Half period enabled than one skipped and the next notified */
152 if ((rtc->periodic_freq & PF_HP) && (rtc->periodic_freq & PF_COUNT))
153 rtc->periodic_freq &= ~PF_COUNT;
155 if (rtc->periodic_freq & PF_HP)
156 rtc->periodic_freq |= PF_COUNT;
157 if (rtc->periodic_freq & PF_KOU) {
158 spin_lock(&rtc_dev->irq_task_lock);
159 if (rtc_dev->irq_task)
160 rtc_dev->irq_task->func(rtc_dev->irq_task->private_data);
161 spin_unlock(&rtc_dev->irq_task_lock);
163 rtc_update_irq(rtc->rtc_dev, 1, RTC_PF | RTC_IRQF);
166 spin_unlock(&rtc->lock);
171 static inline void sh_rtc_setpie(struct device *dev, unsigned int enable)
173 struct sh_rtc *rtc = dev_get_drvdata(dev);
176 spin_lock_irq(&rtc->lock);
178 tmp = readb(rtc->regbase + RCR2);
181 tmp &= ~RCR2_PEF; /* Clear PES bit */
182 tmp |= (rtc->periodic_freq & ~PF_HP); /* Set PES2-0 */
184 tmp &= ~(RCR2_PESMASK | RCR2_PEF);
186 writeb(tmp, rtc->regbase + RCR2);
188 spin_unlock_irq(&rtc->lock);
191 static inline int sh_rtc_setfreq(struct device *dev, unsigned int freq)
193 struct sh_rtc *rtc = dev_get_drvdata(dev);
196 spin_lock_irq(&rtc->lock);
197 tmp = rtc->periodic_freq & PF_MASK;
201 rtc->periodic_freq = 0x00;
204 rtc->periodic_freq = 0x60;
207 rtc->periodic_freq = 0x50;
210 rtc->periodic_freq = 0x40;
213 rtc->periodic_freq = 0x30 | PF_HP;
216 rtc->periodic_freq = 0x30;
219 rtc->periodic_freq = 0x20 | PF_HP;
222 rtc->periodic_freq = 0x20;
225 rtc->periodic_freq = 0x10 | PF_HP;
228 rtc->periodic_freq = 0x10;
235 rtc->periodic_freq |= tmp;
236 rtc->rtc_dev->irq_freq = freq;
239 spin_unlock_irq(&rtc->lock);
243 static inline void sh_rtc_setaie(struct device *dev, unsigned int enable)
245 struct sh_rtc *rtc = dev_get_drvdata(dev);
248 spin_lock_irq(&rtc->lock);
250 tmp = readb(rtc->regbase + RCR1);
257 writeb(tmp, rtc->regbase + RCR1);
259 spin_unlock_irq(&rtc->lock);
262 static int sh_rtc_proc(struct device *dev, struct seq_file *seq)
264 struct sh_rtc *rtc = dev_get_drvdata(dev);
267 tmp = readb(rtc->regbase + RCR1);
268 seq_printf(seq, "carry_IRQ\t: %s\n", (tmp & RCR1_CIE) ? "yes" : "no");
270 tmp = readb(rtc->regbase + RCR2);
271 seq_printf(seq, "periodic_IRQ\t: %s\n",
272 (tmp & RCR2_PESMASK) ? "yes" : "no");
277 static int sh_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
279 struct sh_rtc *rtc = dev_get_drvdata(dev);
280 unsigned int ret = 0;
285 sh_rtc_setpie(dev, cmd == RTC_PIE_ON);
289 sh_rtc_setaie(dev, cmd == RTC_AIE_ON);
292 rtc->periodic_freq &= ~PF_OXS;
295 rtc->periodic_freq |= PF_OXS;
298 ret = put_user(rtc->rtc_dev->irq_freq,
299 (unsigned long __user *)arg);
302 ret = sh_rtc_setfreq(dev, arg);
311 static int sh_rtc_read_time(struct device *dev, struct rtc_time *tm)
313 struct platform_device *pdev = to_platform_device(dev);
314 struct sh_rtc *rtc = platform_get_drvdata(pdev);
315 unsigned int sec128, sec2, yr, yr100, cf_bit;
320 spin_lock_irq(&rtc->lock);
322 tmp = readb(rtc->regbase + RCR1);
323 tmp &= ~RCR1_CF; /* Clear CF-bit */
325 writeb(tmp, rtc->regbase + RCR1);
327 sec128 = readb(rtc->regbase + R64CNT);
329 tm->tm_sec = bcd2bin(readb(rtc->regbase + RSECCNT));
330 tm->tm_min = bcd2bin(readb(rtc->regbase + RMINCNT));
331 tm->tm_hour = bcd2bin(readb(rtc->regbase + RHRCNT));
332 tm->tm_wday = bcd2bin(readb(rtc->regbase + RWKCNT));
333 tm->tm_mday = bcd2bin(readb(rtc->regbase + RDAYCNT));
334 tm->tm_mon = bcd2bin(readb(rtc->regbase + RMONCNT)) - 1;
336 if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
337 yr = readw(rtc->regbase + RYRCNT);
338 yr100 = bcd2bin(yr >> 8);
341 yr = readb(rtc->regbase + RYRCNT);
342 yr100 = bcd2bin((yr == 0x99) ? 0x19 : 0x20);
345 tm->tm_year = (yr100 * 100 + bcd2bin(yr)) - 1900;
347 sec2 = readb(rtc->regbase + R64CNT);
348 cf_bit = readb(rtc->regbase + RCR1) & RCR1_CF;
350 spin_unlock_irq(&rtc->lock);
351 } while (cf_bit != 0 || ((sec128 ^ sec2) & RTC_BIT_INVERTED) != 0);
353 #if RTC_BIT_INVERTED != 0
354 if ((sec128 & RTC_BIT_INVERTED))
358 dev_dbg(dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
359 "mday=%d, mon=%d, year=%d, wday=%d\n",
361 tm->tm_sec, tm->tm_min, tm->tm_hour,
362 tm->tm_mday, tm->tm_mon + 1, tm->tm_year, tm->tm_wday);
364 if (rtc_valid_tm(tm) < 0) {
365 dev_err(dev, "invalid date\n");
366 rtc_time_to_tm(0, tm);
372 static int sh_rtc_set_time(struct device *dev, struct rtc_time *tm)
374 struct platform_device *pdev = to_platform_device(dev);
375 struct sh_rtc *rtc = platform_get_drvdata(pdev);
379 spin_lock_irq(&rtc->lock);
381 /* Reset pre-scaler & stop RTC */
382 tmp = readb(rtc->regbase + RCR2);
385 writeb(tmp, rtc->regbase + RCR2);
387 writeb(bin2bcd(tm->tm_sec), rtc->regbase + RSECCNT);
388 writeb(bin2bcd(tm->tm_min), rtc->regbase + RMINCNT);
389 writeb(bin2bcd(tm->tm_hour), rtc->regbase + RHRCNT);
390 writeb(bin2bcd(tm->tm_wday), rtc->regbase + RWKCNT);
391 writeb(bin2bcd(tm->tm_mday), rtc->regbase + RDAYCNT);
392 writeb(bin2bcd(tm->tm_mon + 1), rtc->regbase + RMONCNT);
394 if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
395 year = (bin2bcd((tm->tm_year + 1900) / 100) << 8) |
396 bin2bcd(tm->tm_year % 100);
397 writew(year, rtc->regbase + RYRCNT);
399 year = tm->tm_year % 100;
400 writeb(bin2bcd(year), rtc->regbase + RYRCNT);
404 tmp = readb(rtc->regbase + RCR2);
406 tmp |= RCR2_RTCEN | RCR2_START;
407 writeb(tmp, rtc->regbase + RCR2);
409 spin_unlock_irq(&rtc->lock);
414 static inline int sh_rtc_read_alarm_value(struct sh_rtc *rtc, int reg_off)
417 int value = 0xff; /* return 0xff for ignored values */
419 byte = readb(rtc->regbase + reg_off);
421 byte &= ~AR_ENB; /* strip the enable bit */
422 value = bcd2bin(byte);
428 static int sh_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
430 struct platform_device *pdev = to_platform_device(dev);
431 struct sh_rtc *rtc = platform_get_drvdata(pdev);
432 struct rtc_time *tm = &wkalrm->time;
434 spin_lock_irq(&rtc->lock);
436 tm->tm_sec = sh_rtc_read_alarm_value(rtc, RSECAR);
437 tm->tm_min = sh_rtc_read_alarm_value(rtc, RMINAR);
438 tm->tm_hour = sh_rtc_read_alarm_value(rtc, RHRAR);
439 tm->tm_wday = sh_rtc_read_alarm_value(rtc, RWKAR);
440 tm->tm_mday = sh_rtc_read_alarm_value(rtc, RDAYAR);
441 tm->tm_mon = sh_rtc_read_alarm_value(rtc, RMONAR);
443 tm->tm_mon -= 1; /* RTC is 1-12, tm_mon is 0-11 */
444 tm->tm_year = 0xffff;
446 wkalrm->enabled = (readb(rtc->regbase + RCR1) & RCR1_AIE) ? 1 : 0;
448 spin_unlock_irq(&rtc->lock);
453 static inline void sh_rtc_write_alarm_value(struct sh_rtc *rtc,
454 int value, int reg_off)
456 /* < 0 for a value that is ignored */
458 writeb(0, rtc->regbase + reg_off);
460 writeb(bin2bcd(value) | AR_ENB, rtc->regbase + reg_off);
463 static int sh_rtc_check_alarm(struct rtc_time *tm)
466 * The original rtc says anything > 0xc0 is "don't care" or "match
467 * all" - most users use 0xff but rtc-dev uses -1 for the same thing.
468 * The original rtc doesn't support years - some things use -1 and
469 * some 0xffff. We use -1 to make out tests easier.
471 if (tm->tm_year == 0xffff)
473 if (tm->tm_mon >= 0xff)
475 if (tm->tm_mday >= 0xff)
477 if (tm->tm_wday >= 0xff)
479 if (tm->tm_hour >= 0xff)
481 if (tm->tm_min >= 0xff)
483 if (tm->tm_sec >= 0xff)
486 if (tm->tm_year > 9999 ||
488 tm->tm_mday == 0 || tm->tm_mday >= 32 ||
498 static int sh_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
500 struct platform_device *pdev = to_platform_device(dev);
501 struct sh_rtc *rtc = platform_get_drvdata(pdev);
503 struct rtc_time *tm = &wkalrm->time;
506 err = sh_rtc_check_alarm(tm);
507 if (unlikely(err < 0))
510 spin_lock_irq(&rtc->lock);
512 /* disable alarm interrupt and clear the alarm flag */
513 rcr1 = readb(rtc->regbase + RCR1);
514 rcr1 &= ~(RCR1_AF | RCR1_AIE);
515 writeb(rcr1, rtc->regbase + RCR1);
518 sh_rtc_write_alarm_value(rtc, tm->tm_sec, RSECAR);
519 sh_rtc_write_alarm_value(rtc, tm->tm_min, RMINAR);
520 sh_rtc_write_alarm_value(rtc, tm->tm_hour, RHRAR);
521 sh_rtc_write_alarm_value(rtc, tm->tm_wday, RWKAR);
522 sh_rtc_write_alarm_value(rtc, tm->tm_mday, RDAYAR);
526 sh_rtc_write_alarm_value(rtc, mon, RMONAR);
528 if (wkalrm->enabled) {
530 writeb(rcr1, rtc->regbase + RCR1);
533 spin_unlock_irq(&rtc->lock);
538 static int sh_rtc_irq_set_state(struct device *dev, int enabled)
540 struct platform_device *pdev = to_platform_device(dev);
541 struct sh_rtc *rtc = platform_get_drvdata(pdev);
544 rtc->periodic_freq |= PF_KOU;
545 return sh_rtc_ioctl(dev, RTC_PIE_ON, 0);
547 rtc->periodic_freq &= ~PF_KOU;
548 return sh_rtc_ioctl(dev, RTC_PIE_OFF, 0);
552 static int sh_rtc_irq_set_freq(struct device *dev, int freq)
554 return sh_rtc_ioctl(dev, RTC_IRQP_SET, freq);
557 static struct rtc_class_ops sh_rtc_ops = {
558 .ioctl = sh_rtc_ioctl,
559 .read_time = sh_rtc_read_time,
560 .set_time = sh_rtc_set_time,
561 .read_alarm = sh_rtc_read_alarm,
562 .set_alarm = sh_rtc_set_alarm,
563 .irq_set_state = sh_rtc_irq_set_state,
564 .irq_set_freq = sh_rtc_irq_set_freq,
568 static int __devinit sh_rtc_probe(struct platform_device *pdev)
571 struct resource *res;
575 rtc = kzalloc(sizeof(struct sh_rtc), GFP_KERNEL);
579 spin_lock_init(&rtc->lock);
581 /* get periodic/carry/alarm irqs */
582 ret = platform_get_irq(pdev, 0);
583 if (unlikely(ret <= 0)) {
585 dev_err(&pdev->dev, "No IRQ for period\n");
588 rtc->periodic_irq = ret;
590 ret = platform_get_irq(pdev, 1);
591 if (unlikely(ret <= 0)) {
593 dev_err(&pdev->dev, "No IRQ for carry\n");
596 rtc->carry_irq = ret;
598 ret = platform_get_irq(pdev, 2);
599 if (unlikely(ret <= 0)) {
601 dev_err(&pdev->dev, "No IRQ for alarm\n");
604 rtc->alarm_irq = ret;
606 res = platform_get_resource(pdev, IORESOURCE_IO, 0);
607 if (unlikely(res == NULL)) {
609 dev_err(&pdev->dev, "No IO resource\n");
613 rtc->regsize = res->end - res->start + 1;
615 rtc->res = request_mem_region(res->start, rtc->regsize, pdev->name);
616 if (unlikely(!rtc->res)) {
621 rtc->regbase = ioremap_nocache(rtc->res->start, rtc->regsize);
622 if (unlikely(!rtc->regbase)) {
627 rtc->rtc_dev = rtc_device_register("sh", &pdev->dev,
628 &sh_rtc_ops, THIS_MODULE);
629 if (IS_ERR(rtc->rtc_dev)) {
630 ret = PTR_ERR(rtc->rtc_dev);
634 rtc->capabilities = RTC_DEF_CAPABILITIES;
635 if (pdev->dev.platform_data) {
636 struct sh_rtc_platform_info *pinfo = pdev->dev.platform_data;
639 * Some CPUs have special capabilities in addition to the
640 * default set. Add those in here.
642 rtc->capabilities |= pinfo->capabilities;
645 rtc->rtc_dev->max_user_freq = 256;
646 rtc->rtc_dev->irq_freq = 1;
647 rtc->periodic_freq = 0x60;
649 platform_set_drvdata(pdev, rtc);
651 /* register periodic/carry/alarm irqs */
652 ret = request_irq(rtc->periodic_irq, sh_rtc_periodic, IRQF_DISABLED,
653 "sh-rtc period", rtc);
656 "request period IRQ failed with %d, IRQ %d\n", ret,
661 ret = request_irq(rtc->carry_irq, sh_rtc_interrupt, IRQF_DISABLED,
662 "sh-rtc carry", rtc);
665 "request carry IRQ failed with %d, IRQ %d\n", ret,
667 free_irq(rtc->periodic_irq, rtc);
671 ret = request_irq(rtc->alarm_irq, sh_rtc_alarm, IRQF_DISABLED,
672 "sh-rtc alarm", rtc);
675 "request alarm IRQ failed with %d, IRQ %d\n", ret,
677 free_irq(rtc->carry_irq, rtc);
678 free_irq(rtc->periodic_irq, rtc);
682 tmp = readb(rtc->regbase + RCR1);
685 writeb(tmp, rtc->regbase + RCR1);
690 iounmap(rtc->regbase);
692 release_resource(rtc->res);
699 static int __devexit sh_rtc_remove(struct platform_device *pdev)
701 struct sh_rtc *rtc = platform_get_drvdata(pdev);
703 if (likely(rtc->rtc_dev))
704 rtc_device_unregister(rtc->rtc_dev);
706 sh_rtc_setpie(&pdev->dev, 0);
707 sh_rtc_setaie(&pdev->dev, 0);
709 free_irq(rtc->carry_irq, rtc);
710 free_irq(rtc->periodic_irq, rtc);
711 free_irq(rtc->alarm_irq, rtc);
713 release_resource(rtc->res);
715 iounmap(rtc->regbase);
717 platform_set_drvdata(pdev, NULL);
723 static struct platform_driver sh_rtc_platform_driver = {
726 .owner = THIS_MODULE,
728 .probe = sh_rtc_probe,
729 .remove = __devexit_p(sh_rtc_remove),
732 static int __init sh_rtc_init(void)
734 return platform_driver_register(&sh_rtc_platform_driver);
737 static void __exit sh_rtc_exit(void)
739 platform_driver_unregister(&sh_rtc_platform_driver);
742 module_init(sh_rtc_init);
743 module_exit(sh_rtc_exit);
745 MODULE_DESCRIPTION("SuperH on-chip RTC driver");
746 MODULE_VERSION(DRV_VERSION);
747 MODULE_AUTHOR("Paul Mundt <lethal@linux-sh.org>, "
748 "Jamie Lenehan <lenehan@twibble.org>, "
749 "Angelo Castello <angelo.castello@st.com>");
750 MODULE_LICENSE("GPL");
751 MODULE_ALIAS("platform:" DRV_NAME);