1 /* drivers/rtc/rtc-s3c.c
3 * Copyright (c) 2010 Samsung Electronics Co., Ltd.
4 * http://www.samsung.com/
6 * Copyright (c) 2004,2006 Simtec Electronics
7 * Ben Dooks, <ben@simtec.co.uk>
8 * http://armlinux.simtec.co.uk/
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * S3C2410/S3C2440/S3C24XX Internal RTC Driver
17 #include <linux/module.h>
19 #include <linux/string.h>
20 #include <linux/init.h>
21 #include <linux/platform_device.h>
22 #include <linux/interrupt.h>
23 #include <linux/rtc.h>
24 #include <linux/bcd.h>
25 #include <linux/clk.h>
26 #include <linux/log2.h>
27 #include <linux/slab.h>
29 #include <linux/uaccess.h>
42 struct s3c_rtc_drv_data {
48 struct rtc_device *rtc;
54 enum s3c_cpu_type cpu_type;
60 spinlock_t alarm_clk_lock;
62 int ticnt_save, ticnt_en_save;
66 static void s3c_rtc_alarm_clk_enable(struct s3c_rtc *info, bool enable)
68 unsigned long irq_flags;
70 spin_lock_irqsave(&info->alarm_clk_lock, irq_flags);
73 clk_enable(info->rtc_clk);
78 clk_disable(info->rtc_clk);
79 info->enabled = false;
82 spin_unlock_irqrestore(&info->alarm_clk_lock, irq_flags);
86 static irqreturn_t s3c_rtc_alarmirq(int irq, void *id)
88 struct s3c_rtc *info = (struct s3c_rtc *)id;
90 clk_enable(info->rtc_clk);
91 rtc_update_irq(info->rtc, 1, RTC_AF | RTC_IRQF);
93 if (info->cpu_type == TYPE_S3C64XX)
94 writeb(S3C2410_INTP_ALM, info->base + S3C2410_INTP);
96 clk_disable(info->rtc_clk);
98 s3c_rtc_alarm_clk_enable(info, false);
103 static irqreturn_t s3c_rtc_tickirq(int irq, void *id)
105 struct s3c_rtc *info = (struct s3c_rtc *)id;
107 clk_enable(info->rtc_clk);
108 rtc_update_irq(info->rtc, 1, RTC_PF | RTC_IRQF);
110 if (info->cpu_type == TYPE_S3C64XX)
111 writeb(S3C2410_INTP_TIC, info->base + S3C2410_INTP);
113 clk_disable(info->rtc_clk);
118 /* Update control registers */
119 static int s3c_rtc_setaie(struct device *dev, unsigned int enabled)
121 struct s3c_rtc *info = dev_get_drvdata(dev);
124 dev_dbg(info->dev, "%s: aie=%d\n", __func__, enabled);
126 clk_enable(info->rtc_clk);
127 tmp = readb(info->base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;
130 tmp |= S3C2410_RTCALM_ALMEN;
132 writeb(tmp, info->base + S3C2410_RTCALM);
133 clk_disable(info->rtc_clk);
135 s3c_rtc_alarm_clk_enable(info, enabled);
140 static int s3c_rtc_setfreq(struct s3c_rtc *info, int freq)
142 unsigned int tmp = 0;
145 if (!is_power_of_2(freq))
148 clk_enable(info->rtc_clk);
149 spin_lock_irq(&info->pie_lock);
151 if (info->cpu_type != TYPE_S3C64XX) {
152 tmp = readb(info->base + S3C2410_TICNT);
153 tmp &= S3C2410_TICNT_ENABLE;
156 val = (info->rtc->max_user_freq / freq) - 1;
158 if (info->cpu_type == TYPE_S3C2416 || info->cpu_type == TYPE_S3C2443) {
159 tmp |= S3C2443_TICNT_PART(val);
160 writel(S3C2443_TICNT1_PART(val), info->base + S3C2443_TICNT1);
162 if (info->cpu_type == TYPE_S3C2416)
163 writel(S3C2416_TICNT2_PART(val),
164 info->base + S3C2416_TICNT2);
169 writel(tmp, info->base + S3C2410_TICNT);
170 spin_unlock_irq(&info->pie_lock);
171 clk_disable(info->rtc_clk);
176 /* Time read/write */
178 static int s3c_rtc_gettime(struct device *dev, struct rtc_time *rtc_tm)
180 struct s3c_rtc *info = dev_get_drvdata(dev);
181 unsigned int have_retried = 0;
183 clk_enable(info->rtc_clk);
185 rtc_tm->tm_min = readb(info->base + S3C2410_RTCMIN);
186 rtc_tm->tm_hour = readb(info->base + S3C2410_RTCHOUR);
187 rtc_tm->tm_mday = readb(info->base + S3C2410_RTCDATE);
188 rtc_tm->tm_mon = readb(info->base + S3C2410_RTCMON);
189 rtc_tm->tm_year = readb(info->base + S3C2410_RTCYEAR);
190 rtc_tm->tm_sec = readb(info->base + S3C2410_RTCSEC);
192 /* the only way to work out whether the system was mid-update
193 * when we read it is to check the second counter, and if it
194 * is zero, then we re-try the entire read
197 if (rtc_tm->tm_sec == 0 && !have_retried) {
202 rtc_tm->tm_sec = bcd2bin(rtc_tm->tm_sec);
203 rtc_tm->tm_min = bcd2bin(rtc_tm->tm_min);
204 rtc_tm->tm_hour = bcd2bin(rtc_tm->tm_hour);
205 rtc_tm->tm_mday = bcd2bin(rtc_tm->tm_mday);
206 rtc_tm->tm_mon = bcd2bin(rtc_tm->tm_mon);
207 rtc_tm->tm_year = bcd2bin(rtc_tm->tm_year);
209 rtc_tm->tm_year += 100;
211 dev_dbg(dev, "read time %04d.%02d.%02d %02d:%02d:%02d\n",
212 1900 + rtc_tm->tm_year, rtc_tm->tm_mon, rtc_tm->tm_mday,
213 rtc_tm->tm_hour, rtc_tm->tm_min, rtc_tm->tm_sec);
217 clk_disable(info->rtc_clk);
219 return rtc_valid_tm(rtc_tm);
222 static int s3c_rtc_settime(struct device *dev, struct rtc_time *tm)
224 struct s3c_rtc *info = dev_get_drvdata(dev);
225 int year = tm->tm_year - 100;
227 dev_dbg(dev, "set time %04d.%02d.%02d %02d:%02d:%02d\n",
228 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
229 tm->tm_hour, tm->tm_min, tm->tm_sec);
231 /* we get around y2k by simply not supporting it */
233 if (year < 0 || year >= 100) {
234 dev_err(dev, "rtc only supports 100 years\n");
238 clk_enable(info->rtc_clk);
240 writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_RTCSEC);
241 writeb(bin2bcd(tm->tm_min), info->base + S3C2410_RTCMIN);
242 writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_RTCHOUR);
243 writeb(bin2bcd(tm->tm_mday), info->base + S3C2410_RTCDATE);
244 writeb(bin2bcd(tm->tm_mon + 1), info->base + S3C2410_RTCMON);
245 writeb(bin2bcd(year), info->base + S3C2410_RTCYEAR);
247 clk_disable(info->rtc_clk);
252 static int s3c_rtc_getalarm(struct device *dev, struct rtc_wkalrm *alrm)
254 struct s3c_rtc *info = dev_get_drvdata(dev);
255 struct rtc_time *alm_tm = &alrm->time;
258 clk_enable(info->rtc_clk);
259 alm_tm->tm_sec = readb(info->base + S3C2410_ALMSEC);
260 alm_tm->tm_min = readb(info->base + S3C2410_ALMMIN);
261 alm_tm->tm_hour = readb(info->base + S3C2410_ALMHOUR);
262 alm_tm->tm_mon = readb(info->base + S3C2410_ALMMON);
263 alm_tm->tm_mday = readb(info->base + S3C2410_ALMDATE);
264 alm_tm->tm_year = readb(info->base + S3C2410_ALMYEAR);
266 alm_en = readb(info->base + S3C2410_RTCALM);
268 alrm->enabled = (alm_en & S3C2410_RTCALM_ALMEN) ? 1 : 0;
270 dev_dbg(dev, "read alarm %d, %04d.%02d.%02d %02d:%02d:%02d\n",
272 1900 + alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
273 alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);
276 /* decode the alarm enable field */
278 if (alm_en & S3C2410_RTCALM_SECEN)
279 alm_tm->tm_sec = bcd2bin(alm_tm->tm_sec);
283 if (alm_en & S3C2410_RTCALM_MINEN)
284 alm_tm->tm_min = bcd2bin(alm_tm->tm_min);
288 if (alm_en & S3C2410_RTCALM_HOUREN)
289 alm_tm->tm_hour = bcd2bin(alm_tm->tm_hour);
291 alm_tm->tm_hour = -1;
293 if (alm_en & S3C2410_RTCALM_DAYEN)
294 alm_tm->tm_mday = bcd2bin(alm_tm->tm_mday);
296 alm_tm->tm_mday = -1;
298 if (alm_en & S3C2410_RTCALM_MONEN) {
299 alm_tm->tm_mon = bcd2bin(alm_tm->tm_mon);
305 if (alm_en & S3C2410_RTCALM_YEAREN)
306 alm_tm->tm_year = bcd2bin(alm_tm->tm_year);
308 alm_tm->tm_year = -1;
310 clk_disable(info->rtc_clk);
314 static int s3c_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
316 struct s3c_rtc *info = dev_get_drvdata(dev);
317 struct rtc_time *tm = &alrm->time;
318 unsigned int alrm_en;
320 clk_enable(info->rtc_clk);
321 dev_dbg(dev, "s3c_rtc_setalarm: %d, %04d.%02d.%02d %02d:%02d:%02d\n",
323 1900 + tm->tm_year, tm->tm_mon + 1, tm->tm_mday,
324 tm->tm_hour, tm->tm_min, tm->tm_sec);
326 alrm_en = readb(info->base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
327 writeb(0x00, info->base + S3C2410_RTCALM);
329 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
330 alrm_en |= S3C2410_RTCALM_SECEN;
331 writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_ALMSEC);
334 if (tm->tm_min < 60 && tm->tm_min >= 0) {
335 alrm_en |= S3C2410_RTCALM_MINEN;
336 writeb(bin2bcd(tm->tm_min), info->base + S3C2410_ALMMIN);
339 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
340 alrm_en |= S3C2410_RTCALM_HOUREN;
341 writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_ALMHOUR);
344 dev_dbg(dev, "setting S3C2410_RTCALM to %08x\n", alrm_en);
346 writeb(alrm_en, info->base + S3C2410_RTCALM);
348 s3c_rtc_setaie(dev, alrm->enabled);
350 clk_disable(info->rtc_clk);
355 static int s3c_rtc_proc(struct device *dev, struct seq_file *seq)
357 struct s3c_rtc *info = dev_get_drvdata(dev);
360 clk_enable(info->rtc_clk);
361 if (info->cpu_type == TYPE_S3C64XX) {
362 ticnt = readw(info->base + S3C2410_RTCCON);
363 ticnt &= S3C64XX_RTCCON_TICEN;
365 ticnt = readb(info->base + S3C2410_TICNT);
366 ticnt &= S3C2410_TICNT_ENABLE;
369 seq_printf(seq, "periodic_IRQ\t: %s\n", ticnt ? "yes" : "no");
370 clk_disable(info->rtc_clk);
374 static const struct rtc_class_ops s3c_rtcops = {
375 .read_time = s3c_rtc_gettime,
376 .set_time = s3c_rtc_settime,
377 .read_alarm = s3c_rtc_getalarm,
378 .set_alarm = s3c_rtc_setalarm,
379 .proc = s3c_rtc_proc,
380 .alarm_irq_enable = s3c_rtc_setaie,
383 static void s3c_rtc_enable(struct s3c_rtc *info, int en)
385 unsigned int con, tmp;
387 clk_enable(info->rtc_clk);
389 con = readw(info->base + S3C2410_RTCCON);
391 if (info->cpu_type == TYPE_S3C64XX)
392 con &= ~S3C64XX_RTCCON_TICEN;
393 con &= ~S3C2410_RTCCON_RTCEN;
394 writew(con, info->base + S3C2410_RTCCON);
396 if (info->cpu_type != TYPE_S3C64XX) {
397 con = readb(info->base + S3C2410_TICNT);
398 con &= ~S3C2410_TICNT_ENABLE;
399 writeb(con, info->base + S3C2410_TICNT);
402 /* re-enable the device, and check it is ok */
403 if ((con & S3C2410_RTCCON_RTCEN) == 0) {
404 dev_info(info->dev, "rtc disabled, re-enabling\n");
406 tmp = readw(info->base + S3C2410_RTCCON);
407 writew(tmp | S3C2410_RTCCON_RTCEN,
408 info->base + S3C2410_RTCCON);
411 if (con & S3C2410_RTCCON_CNTSEL) {
412 dev_info(info->dev, "removing RTCCON_CNTSEL\n");
414 tmp = readw(info->base + S3C2410_RTCCON);
415 writew(tmp & ~S3C2410_RTCCON_CNTSEL,
416 info->base + S3C2410_RTCCON);
419 if (con & S3C2410_RTCCON_CLKRST) {
420 dev_info(info->dev, "removing RTCCON_CLKRST\n");
422 tmp = readw(info->base + S3C2410_RTCCON);
423 writew(tmp & ~S3C2410_RTCCON_CLKRST,
424 info->base + S3C2410_RTCCON);
427 clk_disable(info->rtc_clk);
430 static int s3c_rtc_remove(struct platform_device *pdev)
432 struct s3c_rtc *info = platform_get_drvdata(pdev);
434 s3c_rtc_setaie(info->dev, 0);
436 clk_unprepare(info->rtc_clk);
437 info->rtc_clk = NULL;
442 static const struct of_device_id s3c_rtc_dt_match[];
444 static inline int s3c_rtc_get_driver_data(struct platform_device *pdev)
447 struct s3c_rtc_drv_data *data;
449 if (pdev->dev.of_node) {
450 const struct of_device_id *match;
452 match = of_match_node(s3c_rtc_dt_match, pdev->dev.of_node);
453 data = (struct s3c_rtc_drv_data *) match->data;
454 return data->cpu_type;
457 return platform_get_device_id(pdev)->driver_data;
460 static int s3c_rtc_probe(struct platform_device *pdev)
462 struct s3c_rtc *info = NULL;
463 struct rtc_time rtc_tm;
464 struct resource *res;
468 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
473 info->irq_tick = platform_get_irq(pdev, 1);
474 if (info->irq_tick < 0) {
475 dev_err(&pdev->dev, "no irq for rtc tick\n");
476 return info->irq_tick;
479 info->dev = &pdev->dev;
480 info->cpu_type = s3c_rtc_get_driver_data(pdev);
481 spin_lock_init(&info->pie_lock);
482 spin_lock_init(&info->alarm_clk_lock);
484 platform_set_drvdata(pdev, info);
486 info->irq_alarm = platform_get_irq(pdev, 0);
487 if (info->irq_alarm < 0) {
488 dev_err(&pdev->dev, "no irq for alarm\n");
489 return info->irq_alarm;
492 dev_dbg(&pdev->dev, "s3c2410_rtc: tick irq %d, alarm irq %d\n",
493 info->irq_tick, info->irq_alarm);
495 /* get the memory region */
496 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
497 info->base = devm_ioremap_resource(&pdev->dev, res);
498 if (IS_ERR(info->base))
499 return PTR_ERR(info->base);
501 info->rtc_clk = devm_clk_get(&pdev->dev, "rtc");
502 if (IS_ERR(info->rtc_clk)) {
503 dev_err(&pdev->dev, "failed to find rtc clock source\n");
504 return PTR_ERR(info->rtc_clk);
506 clk_prepare_enable(info->rtc_clk);
508 /* check to see if everything is setup correctly */
509 s3c_rtc_enable(info, 1);
511 dev_dbg(&pdev->dev, "s3c2410_rtc: RTCCON=%02x\n",
512 readw(info->base + S3C2410_RTCCON));
514 device_init_wakeup(&pdev->dev, 1);
516 /* register RTC and exit */
517 info->rtc = devm_rtc_device_register(&pdev->dev, "s3c", &s3c_rtcops,
519 if (IS_ERR(info->rtc)) {
520 dev_err(&pdev->dev, "cannot attach rtc\n");
521 ret = PTR_ERR(info->rtc);
525 ret = devm_request_irq(&pdev->dev, info->irq_alarm, s3c_rtc_alarmirq,
526 0, "s3c2410-rtc alarm", info);
528 dev_err(&pdev->dev, "IRQ%d error %d\n", info->irq_alarm, ret);
532 ret = devm_request_irq(&pdev->dev, info->irq_tick, s3c_rtc_tickirq,
533 0, "s3c2410-rtc tick", info);
535 dev_err(&pdev->dev, "IRQ%d error %d\n", info->irq_tick, ret);
540 s3c_rtc_gettime(&pdev->dev, &rtc_tm);
542 if (rtc_valid_tm(&rtc_tm)) {
543 rtc_tm.tm_year = 100;
550 s3c_rtc_settime(&pdev->dev, &rtc_tm);
552 dev_warn(&pdev->dev, "warning: invalid RTC value so initializing it\n");
555 if (info->cpu_type != TYPE_S3C2410)
556 info->rtc->max_user_freq = 32768;
558 info->rtc->max_user_freq = 128;
560 if (info->cpu_type == TYPE_S3C2416 || info->cpu_type == TYPE_S3C2443) {
561 tmp = readw(info->base + S3C2410_RTCCON);
562 tmp |= S3C2443_RTCCON_TICSEL;
563 writew(tmp, info->base + S3C2410_RTCCON);
566 s3c_rtc_setfreq(info, 1);
568 clk_disable(info->rtc_clk);
573 s3c_rtc_enable(info, 0);
574 clk_disable_unprepare(info->rtc_clk);
579 #ifdef CONFIG_PM_SLEEP
581 static int s3c_rtc_suspend(struct device *dev)
583 struct s3c_rtc *info = dev_get_drvdata(dev);
585 clk_enable(info->rtc_clk);
586 /* save TICNT for anyone using periodic interrupts */
587 if (info->cpu_type == TYPE_S3C64XX) {
588 info->ticnt_en_save = readw(info->base + S3C2410_RTCCON);
589 info->ticnt_en_save &= S3C64XX_RTCCON_TICEN;
590 info->ticnt_save = readl(info->base + S3C2410_TICNT);
592 info->ticnt_save = readb(info->base + S3C2410_TICNT);
594 s3c_rtc_enable(info, 0);
596 if (device_may_wakeup(dev) && !info->wake_en) {
597 if (enable_irq_wake(info->irq_alarm) == 0)
598 info->wake_en = true;
600 dev_err(dev, "enable_irq_wake failed\n");
602 clk_disable(info->rtc_clk);
607 static int s3c_rtc_resume(struct device *dev)
609 struct s3c_rtc *info = dev_get_drvdata(dev);
612 clk_enable(info->rtc_clk);
613 s3c_rtc_enable(info, 1);
614 if (info->cpu_type == TYPE_S3C64XX) {
615 writel(info->ticnt_save, info->base + S3C2410_TICNT);
616 if (info->ticnt_en_save) {
617 tmp = readw(info->base + S3C2410_RTCCON);
618 writew(tmp | info->ticnt_en_save,
619 info->base + S3C2410_RTCCON);
622 writeb(info->ticnt_save, info->base + S3C2410_TICNT);
625 if (device_may_wakeup(dev) && info->wake_en) {
626 disable_irq_wake(info->irq_alarm);
627 info->wake_en = false;
629 clk_disable(info->rtc_clk);
634 static SIMPLE_DEV_PM_OPS(s3c_rtc_pm_ops, s3c_rtc_suspend, s3c_rtc_resume);
637 static struct s3c_rtc_drv_data s3c_rtc_drv_data_array[] = {
638 [TYPE_S3C2410] = { TYPE_S3C2410 },
639 [TYPE_S3C2416] = { TYPE_S3C2416 },
640 [TYPE_S3C2443] = { TYPE_S3C2443 },
641 [TYPE_S3C64XX] = { TYPE_S3C64XX },
644 static const struct of_device_id s3c_rtc_dt_match[] = {
646 .compatible = "samsung,s3c2410-rtc",
647 .data = &s3c_rtc_drv_data_array[TYPE_S3C2410],
649 .compatible = "samsung,s3c2416-rtc",
650 .data = &s3c_rtc_drv_data_array[TYPE_S3C2416],
652 .compatible = "samsung,s3c2443-rtc",
653 .data = &s3c_rtc_drv_data_array[TYPE_S3C2443],
655 .compatible = "samsung,s3c6410-rtc",
656 .data = &s3c_rtc_drv_data_array[TYPE_S3C64XX],
660 MODULE_DEVICE_TABLE(of, s3c_rtc_dt_match);
663 static struct platform_device_id s3c_rtc_driver_ids[] = {
665 .name = "s3c2410-rtc",
666 .driver_data = TYPE_S3C2410,
668 .name = "s3c2416-rtc",
669 .driver_data = TYPE_S3C2416,
671 .name = "s3c2443-rtc",
672 .driver_data = TYPE_S3C2443,
674 .name = "s3c64xx-rtc",
675 .driver_data = TYPE_S3C64XX,
680 MODULE_DEVICE_TABLE(platform, s3c_rtc_driver_ids);
682 static struct platform_driver s3c_rtc_driver = {
683 .probe = s3c_rtc_probe,
684 .remove = s3c_rtc_remove,
685 .id_table = s3c_rtc_driver_ids,
688 .owner = THIS_MODULE,
689 .pm = &s3c_rtc_pm_ops,
690 .of_match_table = of_match_ptr(s3c_rtc_dt_match),
694 module_platform_driver(s3c_rtc_driver);
696 MODULE_DESCRIPTION("Samsung S3C RTC Driver");
697 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
698 MODULE_LICENSE("GPL");
699 MODULE_ALIAS("platform:s3c2410-rtc");