Loading...
1/* drivers/rtc/rtc-s3c.c
2 *
3 * Copyright (c) 2010 Samsung Electronics Co., Ltd.
4 * http://www.samsung.com/
5 *
6 * Copyright (c) 2004,2006 Simtec Electronics
7 * Ben Dooks, <ben@simtec.co.uk>
8 * http://armlinux.simtec.co.uk/
9 *
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.
13 *
14 * S3C2410/S3C2440/S3C24XX Internal RTC Driver
15*/
16
17#include <linux/module.h>
18#include <linux/fs.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>
28
29#include <mach/hardware.h>
30#include <asm/uaccess.h>
31#include <asm/io.h>
32#include <asm/irq.h>
33#include <plat/regs-rtc.h>
34
35enum s3c_cpu_type {
36 TYPE_S3C2410,
37 TYPE_S3C64XX,
38};
39
40/* I have yet to find an S3C implementation with more than one
41 * of these rtc blocks in */
42
43static struct resource *s3c_rtc_mem;
44
45static struct clk *rtc_clk;
46static void __iomem *s3c_rtc_base;
47static int s3c_rtc_alarmno = NO_IRQ;
48static int s3c_rtc_tickno = NO_IRQ;
49static bool wake_en;
50static enum s3c_cpu_type s3c_rtc_cpu_type;
51
52static DEFINE_SPINLOCK(s3c_rtc_pie_lock);
53
54static void s3c_rtc_alarm_clk_enable(bool enable)
55{
56 static DEFINE_SPINLOCK(s3c_rtc_alarm_clk_lock);
57 static bool alarm_clk_enabled;
58 unsigned long irq_flags;
59
60 spin_lock_irqsave(&s3c_rtc_alarm_clk_lock, irq_flags);
61 if (enable) {
62 if (!alarm_clk_enabled) {
63 clk_enable(rtc_clk);
64 alarm_clk_enabled = true;
65 }
66 } else {
67 if (alarm_clk_enabled) {
68 clk_disable(rtc_clk);
69 alarm_clk_enabled = false;
70 }
71 }
72 spin_unlock_irqrestore(&s3c_rtc_alarm_clk_lock, irq_flags);
73}
74
75/* IRQ Handlers */
76
77static irqreturn_t s3c_rtc_alarmirq(int irq, void *id)
78{
79 struct rtc_device *rdev = id;
80
81 clk_enable(rtc_clk);
82 rtc_update_irq(rdev, 1, RTC_AF | RTC_IRQF);
83
84 if (s3c_rtc_cpu_type == TYPE_S3C64XX)
85 writeb(S3C2410_INTP_ALM, s3c_rtc_base + S3C2410_INTP);
86
87 clk_disable(rtc_clk);
88
89 s3c_rtc_alarm_clk_enable(false);
90
91 return IRQ_HANDLED;
92}
93
94static irqreturn_t s3c_rtc_tickirq(int irq, void *id)
95{
96 struct rtc_device *rdev = id;
97
98 clk_enable(rtc_clk);
99 rtc_update_irq(rdev, 1, RTC_PF | RTC_IRQF);
100
101 if (s3c_rtc_cpu_type == TYPE_S3C64XX)
102 writeb(S3C2410_INTP_TIC, s3c_rtc_base + S3C2410_INTP);
103
104 clk_disable(rtc_clk);
105 return IRQ_HANDLED;
106}
107
108/* Update control registers */
109static int s3c_rtc_setaie(struct device *dev, unsigned int enabled)
110{
111 unsigned int tmp;
112
113 pr_debug("%s: aie=%d\n", __func__, enabled);
114
115 clk_enable(rtc_clk);
116 tmp = readb(s3c_rtc_base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;
117
118 if (enabled)
119 tmp |= S3C2410_RTCALM_ALMEN;
120
121 writeb(tmp, s3c_rtc_base + S3C2410_RTCALM);
122 clk_disable(rtc_clk);
123
124 s3c_rtc_alarm_clk_enable(enabled);
125
126 return 0;
127}
128
129static int s3c_rtc_setfreq(struct device *dev, int freq)
130{
131 struct platform_device *pdev = to_platform_device(dev);
132 struct rtc_device *rtc_dev = platform_get_drvdata(pdev);
133 unsigned int tmp = 0;
134
135 if (!is_power_of_2(freq))
136 return -EINVAL;
137
138 clk_enable(rtc_clk);
139 spin_lock_irq(&s3c_rtc_pie_lock);
140
141 if (s3c_rtc_cpu_type == TYPE_S3C2410) {
142 tmp = readb(s3c_rtc_base + S3C2410_TICNT);
143 tmp &= S3C2410_TICNT_ENABLE;
144 }
145
146 tmp |= (rtc_dev->max_user_freq / freq)-1;
147
148 writel(tmp, s3c_rtc_base + S3C2410_TICNT);
149 spin_unlock_irq(&s3c_rtc_pie_lock);
150 clk_disable(rtc_clk);
151
152 return 0;
153}
154
155/* Time read/write */
156
157static int s3c_rtc_gettime(struct device *dev, struct rtc_time *rtc_tm)
158{
159 unsigned int have_retried = 0;
160 void __iomem *base = s3c_rtc_base;
161
162 clk_enable(rtc_clk);
163 retry_get_time:
164 rtc_tm->tm_min = readb(base + S3C2410_RTCMIN);
165 rtc_tm->tm_hour = readb(base + S3C2410_RTCHOUR);
166 rtc_tm->tm_mday = readb(base + S3C2410_RTCDATE);
167 rtc_tm->tm_mon = readb(base + S3C2410_RTCMON);
168 rtc_tm->tm_year = readb(base + S3C2410_RTCYEAR);
169 rtc_tm->tm_sec = readb(base + S3C2410_RTCSEC);
170
171 /* the only way to work out wether the system was mid-update
172 * when we read it is to check the second counter, and if it
173 * is zero, then we re-try the entire read
174 */
175
176 if (rtc_tm->tm_sec == 0 && !have_retried) {
177 have_retried = 1;
178 goto retry_get_time;
179 }
180
181 rtc_tm->tm_sec = bcd2bin(rtc_tm->tm_sec);
182 rtc_tm->tm_min = bcd2bin(rtc_tm->tm_min);
183 rtc_tm->tm_hour = bcd2bin(rtc_tm->tm_hour);
184 rtc_tm->tm_mday = bcd2bin(rtc_tm->tm_mday);
185 rtc_tm->tm_mon = bcd2bin(rtc_tm->tm_mon);
186 rtc_tm->tm_year = bcd2bin(rtc_tm->tm_year);
187
188 rtc_tm->tm_year += 100;
189
190 pr_debug("read time %04d.%02d.%02d %02d:%02d:%02d\n",
191 1900 + rtc_tm->tm_year, rtc_tm->tm_mon, rtc_tm->tm_mday,
192 rtc_tm->tm_hour, rtc_tm->tm_min, rtc_tm->tm_sec);
193
194 rtc_tm->tm_mon -= 1;
195
196 clk_disable(rtc_clk);
197 return rtc_valid_tm(rtc_tm);
198}
199
200static int s3c_rtc_settime(struct device *dev, struct rtc_time *tm)
201{
202 void __iomem *base = s3c_rtc_base;
203 int year = tm->tm_year - 100;
204
205 clk_enable(rtc_clk);
206 pr_debug("set time %04d.%02d.%02d %02d:%02d:%02d\n",
207 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
208 tm->tm_hour, tm->tm_min, tm->tm_sec);
209
210 /* we get around y2k by simply not supporting it */
211
212 if (year < 0 || year >= 100) {
213 dev_err(dev, "rtc only supports 100 years\n");
214 return -EINVAL;
215 }
216
217 writeb(bin2bcd(tm->tm_sec), base + S3C2410_RTCSEC);
218 writeb(bin2bcd(tm->tm_min), base + S3C2410_RTCMIN);
219 writeb(bin2bcd(tm->tm_hour), base + S3C2410_RTCHOUR);
220 writeb(bin2bcd(tm->tm_mday), base + S3C2410_RTCDATE);
221 writeb(bin2bcd(tm->tm_mon + 1), base + S3C2410_RTCMON);
222 writeb(bin2bcd(year), base + S3C2410_RTCYEAR);
223 clk_disable(rtc_clk);
224
225 return 0;
226}
227
228static int s3c_rtc_getalarm(struct device *dev, struct rtc_wkalrm *alrm)
229{
230 struct rtc_time *alm_tm = &alrm->time;
231 void __iomem *base = s3c_rtc_base;
232 unsigned int alm_en;
233
234 clk_enable(rtc_clk);
235 alm_tm->tm_sec = readb(base + S3C2410_ALMSEC);
236 alm_tm->tm_min = readb(base + S3C2410_ALMMIN);
237 alm_tm->tm_hour = readb(base + S3C2410_ALMHOUR);
238 alm_tm->tm_mon = readb(base + S3C2410_ALMMON);
239 alm_tm->tm_mday = readb(base + S3C2410_ALMDATE);
240 alm_tm->tm_year = readb(base + S3C2410_ALMYEAR);
241
242 alm_en = readb(base + S3C2410_RTCALM);
243
244 alrm->enabled = (alm_en & S3C2410_RTCALM_ALMEN) ? 1 : 0;
245
246 pr_debug("read alarm %d, %04d.%02d.%02d %02d:%02d:%02d\n",
247 alm_en,
248 1900 + alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
249 alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);
250
251
252 /* decode the alarm enable field */
253
254 if (alm_en & S3C2410_RTCALM_SECEN)
255 alm_tm->tm_sec = bcd2bin(alm_tm->tm_sec);
256 else
257 alm_tm->tm_sec = -1;
258
259 if (alm_en & S3C2410_RTCALM_MINEN)
260 alm_tm->tm_min = bcd2bin(alm_tm->tm_min);
261 else
262 alm_tm->tm_min = -1;
263
264 if (alm_en & S3C2410_RTCALM_HOUREN)
265 alm_tm->tm_hour = bcd2bin(alm_tm->tm_hour);
266 else
267 alm_tm->tm_hour = -1;
268
269 if (alm_en & S3C2410_RTCALM_DAYEN)
270 alm_tm->tm_mday = bcd2bin(alm_tm->tm_mday);
271 else
272 alm_tm->tm_mday = -1;
273
274 if (alm_en & S3C2410_RTCALM_MONEN) {
275 alm_tm->tm_mon = bcd2bin(alm_tm->tm_mon);
276 alm_tm->tm_mon -= 1;
277 } else {
278 alm_tm->tm_mon = -1;
279 }
280
281 if (alm_en & S3C2410_RTCALM_YEAREN)
282 alm_tm->tm_year = bcd2bin(alm_tm->tm_year);
283 else
284 alm_tm->tm_year = -1;
285
286 clk_disable(rtc_clk);
287 return 0;
288}
289
290static int s3c_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
291{
292 struct rtc_time *tm = &alrm->time;
293 void __iomem *base = s3c_rtc_base;
294 unsigned int alrm_en;
295
296 clk_enable(rtc_clk);
297 pr_debug("s3c_rtc_setalarm: %d, %04d.%02d.%02d %02d:%02d:%02d\n",
298 alrm->enabled,
299 1900 + tm->tm_year, tm->tm_mon + 1, tm->tm_mday,
300 tm->tm_hour, tm->tm_min, tm->tm_sec);
301
302 alrm_en = readb(base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
303 writeb(0x00, base + S3C2410_RTCALM);
304
305 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
306 alrm_en |= S3C2410_RTCALM_SECEN;
307 writeb(bin2bcd(tm->tm_sec), base + S3C2410_ALMSEC);
308 }
309
310 if (tm->tm_min < 60 && tm->tm_min >= 0) {
311 alrm_en |= S3C2410_RTCALM_MINEN;
312 writeb(bin2bcd(tm->tm_min), base + S3C2410_ALMMIN);
313 }
314
315 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
316 alrm_en |= S3C2410_RTCALM_HOUREN;
317 writeb(bin2bcd(tm->tm_hour), base + S3C2410_ALMHOUR);
318 }
319
320 pr_debug("setting S3C2410_RTCALM to %08x\n", alrm_en);
321
322 writeb(alrm_en, base + S3C2410_RTCALM);
323
324 s3c_rtc_setaie(dev, alrm->enabled);
325
326 clk_disable(rtc_clk);
327 return 0;
328}
329
330static int s3c_rtc_proc(struct device *dev, struct seq_file *seq)
331{
332 unsigned int ticnt;
333
334 clk_enable(rtc_clk);
335 if (s3c_rtc_cpu_type == TYPE_S3C64XX) {
336 ticnt = readw(s3c_rtc_base + S3C2410_RTCCON);
337 ticnt &= S3C64XX_RTCCON_TICEN;
338 } else {
339 ticnt = readb(s3c_rtc_base + S3C2410_TICNT);
340 ticnt &= S3C2410_TICNT_ENABLE;
341 }
342
343 seq_printf(seq, "periodic_IRQ\t: %s\n", ticnt ? "yes" : "no");
344 clk_disable(rtc_clk);
345 return 0;
346}
347
348static const struct rtc_class_ops s3c_rtcops = {
349 .read_time = s3c_rtc_gettime,
350 .set_time = s3c_rtc_settime,
351 .read_alarm = s3c_rtc_getalarm,
352 .set_alarm = s3c_rtc_setalarm,
353 .proc = s3c_rtc_proc,
354 .alarm_irq_enable = s3c_rtc_setaie,
355};
356
357static void s3c_rtc_enable(struct platform_device *pdev, int en)
358{
359 void __iomem *base = s3c_rtc_base;
360 unsigned int tmp;
361
362 if (s3c_rtc_base == NULL)
363 return;
364
365 clk_enable(rtc_clk);
366 if (!en) {
367 tmp = readw(base + S3C2410_RTCCON);
368 if (s3c_rtc_cpu_type == TYPE_S3C64XX)
369 tmp &= ~S3C64XX_RTCCON_TICEN;
370 tmp &= ~S3C2410_RTCCON_RTCEN;
371 writew(tmp, base + S3C2410_RTCCON);
372
373 if (s3c_rtc_cpu_type == TYPE_S3C2410) {
374 tmp = readb(base + S3C2410_TICNT);
375 tmp &= ~S3C2410_TICNT_ENABLE;
376 writeb(tmp, base + S3C2410_TICNT);
377 }
378 } else {
379 /* re-enable the device, and check it is ok */
380
381 if ((readw(base+S3C2410_RTCCON) & S3C2410_RTCCON_RTCEN) == 0) {
382 dev_info(&pdev->dev, "rtc disabled, re-enabling\n");
383
384 tmp = readw(base + S3C2410_RTCCON);
385 writew(tmp | S3C2410_RTCCON_RTCEN,
386 base + S3C2410_RTCCON);
387 }
388
389 if ((readw(base + S3C2410_RTCCON) & S3C2410_RTCCON_CNTSEL)) {
390 dev_info(&pdev->dev, "removing RTCCON_CNTSEL\n");
391
392 tmp = readw(base + S3C2410_RTCCON);
393 writew(tmp & ~S3C2410_RTCCON_CNTSEL,
394 base + S3C2410_RTCCON);
395 }
396
397 if ((readw(base + S3C2410_RTCCON) & S3C2410_RTCCON_CLKRST)) {
398 dev_info(&pdev->dev, "removing RTCCON_CLKRST\n");
399
400 tmp = readw(base + S3C2410_RTCCON);
401 writew(tmp & ~S3C2410_RTCCON_CLKRST,
402 base + S3C2410_RTCCON);
403 }
404 }
405 clk_disable(rtc_clk);
406}
407
408static int __devexit s3c_rtc_remove(struct platform_device *dev)
409{
410 struct rtc_device *rtc = platform_get_drvdata(dev);
411
412 free_irq(s3c_rtc_alarmno, rtc);
413 free_irq(s3c_rtc_tickno, rtc);
414
415 platform_set_drvdata(dev, NULL);
416 rtc_device_unregister(rtc);
417
418 s3c_rtc_setaie(&dev->dev, 0);
419
420 clk_put(rtc_clk);
421 rtc_clk = NULL;
422
423 iounmap(s3c_rtc_base);
424 release_resource(s3c_rtc_mem);
425 kfree(s3c_rtc_mem);
426
427 return 0;
428}
429
430static int __devinit s3c_rtc_probe(struct platform_device *pdev)
431{
432 struct rtc_device *rtc;
433 struct rtc_time rtc_tm;
434 struct resource *res;
435 int ret;
436
437 pr_debug("%s: probe=%p\n", __func__, pdev);
438
439 /* find the IRQs */
440
441 s3c_rtc_tickno = platform_get_irq(pdev, 1);
442 if (s3c_rtc_tickno < 0) {
443 dev_err(&pdev->dev, "no irq for rtc tick\n");
444 return -ENOENT;
445 }
446
447 s3c_rtc_alarmno = platform_get_irq(pdev, 0);
448 if (s3c_rtc_alarmno < 0) {
449 dev_err(&pdev->dev, "no irq for alarm\n");
450 return -ENOENT;
451 }
452
453 pr_debug("s3c2410_rtc: tick irq %d, alarm irq %d\n",
454 s3c_rtc_tickno, s3c_rtc_alarmno);
455
456 /* get the memory region */
457
458 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
459 if (res == NULL) {
460 dev_err(&pdev->dev, "failed to get memory region resource\n");
461 return -ENOENT;
462 }
463
464 s3c_rtc_mem = request_mem_region(res->start, resource_size(res),
465 pdev->name);
466
467 if (s3c_rtc_mem == NULL) {
468 dev_err(&pdev->dev, "failed to reserve memory region\n");
469 ret = -ENOENT;
470 goto err_nores;
471 }
472
473 s3c_rtc_base = ioremap(res->start, resource_size(res));
474 if (s3c_rtc_base == NULL) {
475 dev_err(&pdev->dev, "failed ioremap()\n");
476 ret = -EINVAL;
477 goto err_nomap;
478 }
479
480 rtc_clk = clk_get(&pdev->dev, "rtc");
481 if (IS_ERR(rtc_clk)) {
482 dev_err(&pdev->dev, "failed to find rtc clock source\n");
483 ret = PTR_ERR(rtc_clk);
484 rtc_clk = NULL;
485 goto err_clk;
486 }
487
488 clk_enable(rtc_clk);
489
490 /* check to see if everything is setup correctly */
491
492 s3c_rtc_enable(pdev, 1);
493
494 pr_debug("s3c2410_rtc: RTCCON=%02x\n",
495 readw(s3c_rtc_base + S3C2410_RTCCON));
496
497 device_init_wakeup(&pdev->dev, 1);
498
499 /* register RTC and exit */
500
501 rtc = rtc_device_register("s3c", &pdev->dev, &s3c_rtcops,
502 THIS_MODULE);
503
504 if (IS_ERR(rtc)) {
505 dev_err(&pdev->dev, "cannot attach rtc\n");
506 ret = PTR_ERR(rtc);
507 goto err_nortc;
508 }
509
510 s3c_rtc_cpu_type = platform_get_device_id(pdev)->driver_data;
511
512 /* Check RTC Time */
513
514 s3c_rtc_gettime(NULL, &rtc_tm);
515
516 if (rtc_valid_tm(&rtc_tm)) {
517 rtc_tm.tm_year = 100;
518 rtc_tm.tm_mon = 0;
519 rtc_tm.tm_mday = 1;
520 rtc_tm.tm_hour = 0;
521 rtc_tm.tm_min = 0;
522 rtc_tm.tm_sec = 0;
523
524 s3c_rtc_settime(NULL, &rtc_tm);
525
526 dev_warn(&pdev->dev, "warning: invalid RTC value so initializing it\n");
527 }
528
529 if (s3c_rtc_cpu_type == TYPE_S3C64XX)
530 rtc->max_user_freq = 32768;
531 else
532 rtc->max_user_freq = 128;
533
534 platform_set_drvdata(pdev, rtc);
535
536 s3c_rtc_setfreq(&pdev->dev, 1);
537
538 ret = request_irq(s3c_rtc_alarmno, s3c_rtc_alarmirq,
539 IRQF_DISABLED, "s3c2410-rtc alarm", rtc);
540 if (ret) {
541 dev_err(&pdev->dev, "IRQ%d error %d\n", s3c_rtc_alarmno, ret);
542 goto err_alarm_irq;
543 }
544
545 ret = request_irq(s3c_rtc_tickno, s3c_rtc_tickirq,
546 IRQF_DISABLED, "s3c2410-rtc tick", rtc);
547 if (ret) {
548 dev_err(&pdev->dev, "IRQ%d error %d\n", s3c_rtc_tickno, ret);
549 free_irq(s3c_rtc_alarmno, rtc);
550 goto err_tick_irq;
551 }
552
553 clk_disable(rtc_clk);
554
555 return 0;
556
557 err_tick_irq:
558 free_irq(s3c_rtc_alarmno, rtc);
559
560 err_alarm_irq:
561 platform_set_drvdata(pdev, NULL);
562 rtc_device_unregister(rtc);
563
564 err_nortc:
565 s3c_rtc_enable(pdev, 0);
566 clk_disable(rtc_clk);
567 clk_put(rtc_clk);
568
569 err_clk:
570 iounmap(s3c_rtc_base);
571
572 err_nomap:
573 release_resource(s3c_rtc_mem);
574
575 err_nores:
576 return ret;
577}
578
579#ifdef CONFIG_PM
580
581/* RTC Power management control */
582
583static int ticnt_save, ticnt_en_save;
584
585static int s3c_rtc_suspend(struct platform_device *pdev, pm_message_t state)
586{
587 clk_enable(rtc_clk);
588 /* save TICNT for anyone using periodic interrupts */
589 ticnt_save = readb(s3c_rtc_base + S3C2410_TICNT);
590 if (s3c_rtc_cpu_type == TYPE_S3C64XX) {
591 ticnt_en_save = readw(s3c_rtc_base + S3C2410_RTCCON);
592 ticnt_en_save &= S3C64XX_RTCCON_TICEN;
593 }
594 s3c_rtc_enable(pdev, 0);
595
596 if (device_may_wakeup(&pdev->dev) && !wake_en) {
597 if (enable_irq_wake(s3c_rtc_alarmno) == 0)
598 wake_en = true;
599 else
600 dev_err(&pdev->dev, "enable_irq_wake failed\n");
601 }
602 clk_disable(rtc_clk);
603
604 return 0;
605}
606
607static int s3c_rtc_resume(struct platform_device *pdev)
608{
609 unsigned int tmp;
610
611 clk_enable(rtc_clk);
612 s3c_rtc_enable(pdev, 1);
613 writeb(ticnt_save, s3c_rtc_base + S3C2410_TICNT);
614 if (s3c_rtc_cpu_type == TYPE_S3C64XX && ticnt_en_save) {
615 tmp = readw(s3c_rtc_base + S3C2410_RTCCON);
616 writew(tmp | ticnt_en_save, s3c_rtc_base + S3C2410_RTCCON);
617 }
618
619 if (device_may_wakeup(&pdev->dev) && wake_en) {
620 disable_irq_wake(s3c_rtc_alarmno);
621 wake_en = false;
622 }
623 clk_disable(rtc_clk);
624
625 return 0;
626}
627#else
628#define s3c_rtc_suspend NULL
629#define s3c_rtc_resume NULL
630#endif
631
632static struct platform_device_id s3c_rtc_driver_ids[] = {
633 {
634 .name = "s3c2410-rtc",
635 .driver_data = TYPE_S3C2410,
636 }, {
637 .name = "s3c64xx-rtc",
638 .driver_data = TYPE_S3C64XX,
639 },
640 { }
641};
642
643MODULE_DEVICE_TABLE(platform, s3c_rtc_driver_ids);
644
645static struct platform_driver s3c_rtc_driver = {
646 .probe = s3c_rtc_probe,
647 .remove = __devexit_p(s3c_rtc_remove),
648 .suspend = s3c_rtc_suspend,
649 .resume = s3c_rtc_resume,
650 .id_table = s3c_rtc_driver_ids,
651 .driver = {
652 .name = "s3c-rtc",
653 .owner = THIS_MODULE,
654 },
655};
656
657static char __initdata banner[] = "S3C24XX RTC, (c) 2004,2006 Simtec Electronics\n";
658
659static int __init s3c_rtc_init(void)
660{
661 printk(banner);
662 return platform_driver_register(&s3c_rtc_driver);
663}
664
665static void __exit s3c_rtc_exit(void)
666{
667 platform_driver_unregister(&s3c_rtc_driver);
668}
669
670module_init(s3c_rtc_init);
671module_exit(s3c_rtc_exit);
672
673MODULE_DESCRIPTION("Samsung S3C RTC Driver");
674MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
675MODULE_LICENSE("GPL");
676MODULE_ALIAS("platform:s3c2410-rtc");
1// SPDX-License-Identifier: GPL-2.0-only
2/* drivers/rtc/rtc-s3c.c
3 *
4 * Copyright (c) 2010 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
6 *
7 * Copyright (c) 2004,2006 Simtec Electronics
8 * Ben Dooks, <ben@simtec.co.uk>
9 * http://armlinux.simtec.co.uk/
10 *
11 * S3C2410/S3C2440/S3C24XX Internal RTC Driver
12*/
13
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>
23#include <linux/log2.h>
24#include <linux/slab.h>
25#include <linux/of.h>
26#include <linux/of_device.h>
27#include <linux/uaccess.h>
28#include <linux/io.h>
29
30#include <asm/irq.h>
31#include "rtc-s3c.h"
32
33struct s3c_rtc {
34 struct device *dev;
35 struct rtc_device *rtc;
36
37 void __iomem *base;
38 struct clk *rtc_clk;
39 struct clk *rtc_src_clk;
40 bool alarm_enabled;
41
42 const struct s3c_rtc_data *data;
43
44 int irq_alarm;
45 spinlock_t alarm_lock;
46
47 bool wake_en;
48};
49
50struct s3c_rtc_data {
51 bool needs_src_clk;
52
53 void (*irq_handler) (struct s3c_rtc *info, int mask);
54 void (*enable) (struct s3c_rtc *info);
55 void (*disable) (struct s3c_rtc *info);
56};
57
58static int s3c_rtc_enable_clk(struct s3c_rtc *info)
59{
60 int ret;
61
62 ret = clk_enable(info->rtc_clk);
63 if (ret)
64 return ret;
65
66 if (info->data->needs_src_clk) {
67 ret = clk_enable(info->rtc_src_clk);
68 if (ret) {
69 clk_disable(info->rtc_clk);
70 return ret;
71 }
72 }
73 return 0;
74}
75
76static void s3c_rtc_disable_clk(struct s3c_rtc *info)
77{
78 if (info->data->needs_src_clk)
79 clk_disable(info->rtc_src_clk);
80 clk_disable(info->rtc_clk);
81}
82
83/* IRQ Handler */
84static irqreturn_t s3c_rtc_alarmirq(int irq, void *id)
85{
86 struct s3c_rtc *info = (struct s3c_rtc *)id;
87
88 if (info->data->irq_handler)
89 info->data->irq_handler(info, S3C2410_INTP_ALM);
90
91 return IRQ_HANDLED;
92}
93
94/* Update control registers */
95static int s3c_rtc_setaie(struct device *dev, unsigned int enabled)
96{
97 struct s3c_rtc *info = dev_get_drvdata(dev);
98 unsigned long flags;
99 unsigned int tmp;
100 int ret;
101
102 dev_dbg(info->dev, "%s: aie=%d\n", __func__, enabled);
103
104 ret = s3c_rtc_enable_clk(info);
105 if (ret)
106 return ret;
107
108 tmp = readb(info->base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;
109
110 if (enabled)
111 tmp |= S3C2410_RTCALM_ALMEN;
112
113 writeb(tmp, info->base + S3C2410_RTCALM);
114
115 spin_lock_irqsave(&info->alarm_lock, flags);
116
117 if (info->alarm_enabled && !enabled)
118 s3c_rtc_disable_clk(info);
119 else if (!info->alarm_enabled && enabled)
120 ret = s3c_rtc_enable_clk(info);
121
122 info->alarm_enabled = enabled;
123 spin_unlock_irqrestore(&info->alarm_lock, flags);
124
125 s3c_rtc_disable_clk(info);
126
127 return ret;
128}
129
130/* Read time from RTC and convert it from BCD */
131static int s3c_rtc_read_time(struct s3c_rtc *info, struct rtc_time *tm)
132{
133 unsigned int have_retried = 0;
134 int ret;
135
136 ret = s3c_rtc_enable_clk(info);
137 if (ret)
138 return ret;
139
140retry_get_time:
141 tm->tm_min = readb(info->base + S3C2410_RTCMIN);
142 tm->tm_hour = readb(info->base + S3C2410_RTCHOUR);
143 tm->tm_mday = readb(info->base + S3C2410_RTCDATE);
144 tm->tm_mon = readb(info->base + S3C2410_RTCMON);
145 tm->tm_year = readb(info->base + S3C2410_RTCYEAR);
146 tm->tm_sec = readb(info->base + S3C2410_RTCSEC);
147
148 /*
149 * The only way to work out whether the system was mid-update
150 * when we read it is to check the second counter, and if it
151 * is zero, then we re-try the entire read
152 */
153 if (tm->tm_sec == 0 && !have_retried) {
154 have_retried = 1;
155 goto retry_get_time;
156 }
157
158 s3c_rtc_disable_clk(info);
159
160 tm->tm_sec = bcd2bin(tm->tm_sec);
161 tm->tm_min = bcd2bin(tm->tm_min);
162 tm->tm_hour = bcd2bin(tm->tm_hour);
163 tm->tm_mday = bcd2bin(tm->tm_mday);
164 tm->tm_mon = bcd2bin(tm->tm_mon);
165 tm->tm_year = bcd2bin(tm->tm_year);
166
167 return 0;
168}
169
170/* Convert time to BCD and write it to RTC */
171static int s3c_rtc_write_time(struct s3c_rtc *info, const struct rtc_time *tm)
172{
173 int ret;
174
175 ret = s3c_rtc_enable_clk(info);
176 if (ret)
177 return ret;
178
179 writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_RTCSEC);
180 writeb(bin2bcd(tm->tm_min), info->base + S3C2410_RTCMIN);
181 writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_RTCHOUR);
182 writeb(bin2bcd(tm->tm_mday), info->base + S3C2410_RTCDATE);
183 writeb(bin2bcd(tm->tm_mon), info->base + S3C2410_RTCMON);
184 writeb(bin2bcd(tm->tm_year), info->base + S3C2410_RTCYEAR);
185
186 s3c_rtc_disable_clk(info);
187
188 return 0;
189}
190
191static int s3c_rtc_gettime(struct device *dev, struct rtc_time *tm)
192{
193 struct s3c_rtc *info = dev_get_drvdata(dev);
194 int ret;
195
196 ret = s3c_rtc_read_time(info, tm);
197 if (ret)
198 return ret;
199
200 /* Convert internal representation to actual date/time */
201 tm->tm_year += 100;
202 tm->tm_mon -= 1;
203
204 dev_dbg(dev, "read time %ptR\n", tm);
205 return 0;
206}
207
208static int s3c_rtc_settime(struct device *dev, struct rtc_time *tm)
209{
210 struct s3c_rtc *info = dev_get_drvdata(dev);
211 struct rtc_time rtc_tm = *tm;
212
213 dev_dbg(dev, "set time %ptR\n", tm);
214
215 /*
216 * Convert actual date/time to internal representation.
217 * We get around Y2K by simply not supporting it.
218 */
219 rtc_tm.tm_year -= 100;
220 rtc_tm.tm_mon += 1;
221
222 return s3c_rtc_write_time(info, &rtc_tm);
223}
224
225static int s3c_rtc_getalarm(struct device *dev, struct rtc_wkalrm *alrm)
226{
227 struct s3c_rtc *info = dev_get_drvdata(dev);
228 struct rtc_time *alm_tm = &alrm->time;
229 unsigned int alm_en;
230 int ret;
231
232 ret = s3c_rtc_enable_clk(info);
233 if (ret)
234 return ret;
235
236 alm_tm->tm_sec = readb(info->base + S3C2410_ALMSEC);
237 alm_tm->tm_min = readb(info->base + S3C2410_ALMMIN);
238 alm_tm->tm_hour = readb(info->base + S3C2410_ALMHOUR);
239 alm_tm->tm_mon = readb(info->base + S3C2410_ALMMON);
240 alm_tm->tm_mday = readb(info->base + S3C2410_ALMDATE);
241 alm_tm->tm_year = readb(info->base + S3C2410_ALMYEAR);
242
243 alm_en = readb(info->base + S3C2410_RTCALM);
244
245 s3c_rtc_disable_clk(info);
246
247 alrm->enabled = (alm_en & S3C2410_RTCALM_ALMEN) ? 1 : 0;
248
249 dev_dbg(dev, "read alarm %d, %ptR\n", alm_en, alm_tm);
250
251 /* decode the alarm enable field */
252 if (alm_en & S3C2410_RTCALM_SECEN)
253 alm_tm->tm_sec = bcd2bin(alm_tm->tm_sec);
254
255 if (alm_en & S3C2410_RTCALM_MINEN)
256 alm_tm->tm_min = bcd2bin(alm_tm->tm_min);
257
258 if (alm_en & S3C2410_RTCALM_HOUREN)
259 alm_tm->tm_hour = bcd2bin(alm_tm->tm_hour);
260
261 if (alm_en & S3C2410_RTCALM_DAYEN)
262 alm_tm->tm_mday = bcd2bin(alm_tm->tm_mday);
263
264 if (alm_en & S3C2410_RTCALM_MONEN) {
265 alm_tm->tm_mon = bcd2bin(alm_tm->tm_mon);
266 alm_tm->tm_mon -= 1;
267 }
268
269 if (alm_en & S3C2410_RTCALM_YEAREN)
270 alm_tm->tm_year = bcd2bin(alm_tm->tm_year);
271
272 return 0;
273}
274
275static int s3c_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
276{
277 struct s3c_rtc *info = dev_get_drvdata(dev);
278 struct rtc_time *tm = &alrm->time;
279 unsigned int alrm_en;
280 int ret;
281
282 dev_dbg(dev, "s3c_rtc_setalarm: %d, %ptR\n", alrm->enabled, tm);
283
284 ret = s3c_rtc_enable_clk(info);
285 if (ret)
286 return ret;
287
288 alrm_en = readb(info->base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;
289 writeb(0x00, info->base + S3C2410_RTCALM);
290
291 if (tm->tm_sec < 60 && tm->tm_sec >= 0) {
292 alrm_en |= S3C2410_RTCALM_SECEN;
293 writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_ALMSEC);
294 }
295
296 if (tm->tm_min < 60 && tm->tm_min >= 0) {
297 alrm_en |= S3C2410_RTCALM_MINEN;
298 writeb(bin2bcd(tm->tm_min), info->base + S3C2410_ALMMIN);
299 }
300
301 if (tm->tm_hour < 24 && tm->tm_hour >= 0) {
302 alrm_en |= S3C2410_RTCALM_HOUREN;
303 writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_ALMHOUR);
304 }
305
306 if (tm->tm_mon < 12 && tm->tm_mon >= 0) {
307 alrm_en |= S3C2410_RTCALM_MONEN;
308 writeb(bin2bcd(tm->tm_mon + 1), info->base + S3C2410_ALMMON);
309 }
310
311 if (tm->tm_mday <= 31 && tm->tm_mday >= 1) {
312 alrm_en |= S3C2410_RTCALM_DAYEN;
313 writeb(bin2bcd(tm->tm_mday), info->base + S3C2410_ALMDATE);
314 }
315
316 dev_dbg(dev, "setting S3C2410_RTCALM to %08x\n", alrm_en);
317
318 writeb(alrm_en, info->base + S3C2410_RTCALM);
319
320 s3c_rtc_setaie(dev, alrm->enabled);
321
322 s3c_rtc_disable_clk(info);
323
324 return 0;
325}
326
327static const struct rtc_class_ops s3c_rtcops = {
328 .read_time = s3c_rtc_gettime,
329 .set_time = s3c_rtc_settime,
330 .read_alarm = s3c_rtc_getalarm,
331 .set_alarm = s3c_rtc_setalarm,
332 .alarm_irq_enable = s3c_rtc_setaie,
333};
334
335static void s3c24xx_rtc_enable(struct s3c_rtc *info)
336{
337 unsigned int con, tmp;
338
339 con = readw(info->base + S3C2410_RTCCON);
340 /* re-enable the device, and check it is ok */
341 if ((con & S3C2410_RTCCON_RTCEN) == 0) {
342 dev_info(info->dev, "rtc disabled, re-enabling\n");
343
344 tmp = readw(info->base + S3C2410_RTCCON);
345 writew(tmp | S3C2410_RTCCON_RTCEN, info->base + S3C2410_RTCCON);
346 }
347
348 if (con & S3C2410_RTCCON_CNTSEL) {
349 dev_info(info->dev, "removing RTCCON_CNTSEL\n");
350
351 tmp = readw(info->base + S3C2410_RTCCON);
352 writew(tmp & ~S3C2410_RTCCON_CNTSEL,
353 info->base + S3C2410_RTCCON);
354 }
355
356 if (con & S3C2410_RTCCON_CLKRST) {
357 dev_info(info->dev, "removing RTCCON_CLKRST\n");
358
359 tmp = readw(info->base + S3C2410_RTCCON);
360 writew(tmp & ~S3C2410_RTCCON_CLKRST,
361 info->base + S3C2410_RTCCON);
362 }
363}
364
365static void s3c24xx_rtc_disable(struct s3c_rtc *info)
366{
367 unsigned int con;
368
369 con = readw(info->base + S3C2410_RTCCON);
370 con &= ~S3C2410_RTCCON_RTCEN;
371 writew(con, info->base + S3C2410_RTCCON);
372
373 con = readb(info->base + S3C2410_TICNT);
374 con &= ~S3C2410_TICNT_ENABLE;
375 writeb(con, info->base + S3C2410_TICNT);
376}
377
378static void s3c6410_rtc_disable(struct s3c_rtc *info)
379{
380 unsigned int con;
381
382 con = readw(info->base + S3C2410_RTCCON);
383 con &= ~S3C64XX_RTCCON_TICEN;
384 con &= ~S3C2410_RTCCON_RTCEN;
385 writew(con, info->base + S3C2410_RTCCON);
386}
387
388static int s3c_rtc_remove(struct platform_device *pdev)
389{
390 struct s3c_rtc *info = platform_get_drvdata(pdev);
391
392 s3c_rtc_setaie(info->dev, 0);
393
394 if (info->data->needs_src_clk)
395 clk_unprepare(info->rtc_src_clk);
396 clk_unprepare(info->rtc_clk);
397
398 return 0;
399}
400
401static int s3c_rtc_probe(struct platform_device *pdev)
402{
403 struct s3c_rtc *info = NULL;
404 int ret;
405
406 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
407 if (!info)
408 return -ENOMEM;
409
410 info->dev = &pdev->dev;
411 info->data = of_device_get_match_data(&pdev->dev);
412 if (!info->data) {
413 dev_err(&pdev->dev, "failed getting s3c_rtc_data\n");
414 return -EINVAL;
415 }
416 spin_lock_init(&info->alarm_lock);
417
418 platform_set_drvdata(pdev, info);
419
420 info->irq_alarm = platform_get_irq(pdev, 0);
421 if (info->irq_alarm < 0)
422 return info->irq_alarm;
423
424 dev_dbg(&pdev->dev, "s3c2410_rtc: alarm irq %d\n", info->irq_alarm);
425
426 /* get the memory region */
427 info->base = devm_platform_ioremap_resource(pdev, 0);
428 if (IS_ERR(info->base))
429 return PTR_ERR(info->base);
430
431 info->rtc_clk = devm_clk_get(&pdev->dev, "rtc");
432 if (IS_ERR(info->rtc_clk))
433 return dev_err_probe(&pdev->dev, PTR_ERR(info->rtc_clk),
434 "failed to find rtc clock\n");
435 ret = clk_prepare_enable(info->rtc_clk);
436 if (ret)
437 return ret;
438
439 if (info->data->needs_src_clk) {
440 info->rtc_src_clk = devm_clk_get(&pdev->dev, "rtc_src");
441 if (IS_ERR(info->rtc_src_clk)) {
442 ret = dev_err_probe(&pdev->dev, PTR_ERR(info->rtc_src_clk),
443 "failed to find rtc source clock\n");
444 goto err_src_clk;
445 }
446 ret = clk_prepare_enable(info->rtc_src_clk);
447 if (ret)
448 goto err_src_clk;
449 }
450
451 /* disable RTC enable bits potentially set by the bootloader */
452 if (info->data->disable)
453 info->data->disable(info);
454
455 /* check to see if everything is setup correctly */
456 if (info->data->enable)
457 info->data->enable(info);
458
459 dev_dbg(&pdev->dev, "s3c2410_rtc: RTCCON=%02x\n",
460 readw(info->base + S3C2410_RTCCON));
461
462 device_init_wakeup(&pdev->dev, 1);
463
464 info->rtc = devm_rtc_allocate_device(&pdev->dev);
465 if (IS_ERR(info->rtc)) {
466 ret = PTR_ERR(info->rtc);
467 goto err_nortc;
468 }
469
470 info->rtc->ops = &s3c_rtcops;
471 info->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
472 info->rtc->range_max = RTC_TIMESTAMP_END_2099;
473
474 ret = devm_rtc_register_device(info->rtc);
475 if (ret)
476 goto err_nortc;
477
478 ret = devm_request_irq(&pdev->dev, info->irq_alarm, s3c_rtc_alarmirq,
479 0, "s3c2410-rtc alarm", info);
480 if (ret) {
481 dev_err(&pdev->dev, "IRQ%d error %d\n", info->irq_alarm, ret);
482 goto err_nortc;
483 }
484
485 s3c_rtc_disable_clk(info);
486
487 return 0;
488
489err_nortc:
490 if (info->data->disable)
491 info->data->disable(info);
492
493 if (info->data->needs_src_clk)
494 clk_disable_unprepare(info->rtc_src_clk);
495err_src_clk:
496 clk_disable_unprepare(info->rtc_clk);
497
498 return ret;
499}
500
501#ifdef CONFIG_PM_SLEEP
502
503static int s3c_rtc_suspend(struct device *dev)
504{
505 struct s3c_rtc *info = dev_get_drvdata(dev);
506 int ret;
507
508 ret = s3c_rtc_enable_clk(info);
509 if (ret)
510 return ret;
511
512 if (info->data->disable)
513 info->data->disable(info);
514
515 if (device_may_wakeup(dev) && !info->wake_en) {
516 if (enable_irq_wake(info->irq_alarm) == 0)
517 info->wake_en = true;
518 else
519 dev_err(dev, "enable_irq_wake failed\n");
520 }
521
522 return 0;
523}
524
525static int s3c_rtc_resume(struct device *dev)
526{
527 struct s3c_rtc *info = dev_get_drvdata(dev);
528
529 if (info->data->enable)
530 info->data->enable(info);
531
532 s3c_rtc_disable_clk(info);
533
534 if (device_may_wakeup(dev) && info->wake_en) {
535 disable_irq_wake(info->irq_alarm);
536 info->wake_en = false;
537 }
538
539 return 0;
540}
541#endif
542static SIMPLE_DEV_PM_OPS(s3c_rtc_pm_ops, s3c_rtc_suspend, s3c_rtc_resume);
543
544static void s3c24xx_rtc_irq(struct s3c_rtc *info, int mask)
545{
546 rtc_update_irq(info->rtc, 1, RTC_AF | RTC_IRQF);
547}
548
549static void s3c6410_rtc_irq(struct s3c_rtc *info, int mask)
550{
551 rtc_update_irq(info->rtc, 1, RTC_AF | RTC_IRQF);
552 writeb(mask, info->base + S3C2410_INTP);
553}
554
555static struct s3c_rtc_data const s3c2410_rtc_data = {
556 .irq_handler = s3c24xx_rtc_irq,
557 .enable = s3c24xx_rtc_enable,
558 .disable = s3c24xx_rtc_disable,
559};
560
561static struct s3c_rtc_data const s3c2416_rtc_data = {
562 .irq_handler = s3c24xx_rtc_irq,
563 .enable = s3c24xx_rtc_enable,
564 .disable = s3c24xx_rtc_disable,
565};
566
567static struct s3c_rtc_data const s3c2443_rtc_data = {
568 .irq_handler = s3c24xx_rtc_irq,
569 .enable = s3c24xx_rtc_enable,
570 .disable = s3c24xx_rtc_disable,
571};
572
573static struct s3c_rtc_data const s3c6410_rtc_data = {
574 .needs_src_clk = true,
575 .irq_handler = s3c6410_rtc_irq,
576 .enable = s3c24xx_rtc_enable,
577 .disable = s3c6410_rtc_disable,
578};
579
580static const __maybe_unused struct of_device_id s3c_rtc_dt_match[] = {
581 {
582 .compatible = "samsung,s3c2410-rtc",
583 .data = &s3c2410_rtc_data,
584 }, {
585 .compatible = "samsung,s3c2416-rtc",
586 .data = &s3c2416_rtc_data,
587 }, {
588 .compatible = "samsung,s3c2443-rtc",
589 .data = &s3c2443_rtc_data,
590 }, {
591 .compatible = "samsung,s3c6410-rtc",
592 .data = &s3c6410_rtc_data,
593 }, {
594 .compatible = "samsung,exynos3250-rtc",
595 .data = &s3c6410_rtc_data,
596 },
597 { /* sentinel */ },
598};
599MODULE_DEVICE_TABLE(of, s3c_rtc_dt_match);
600
601static struct platform_driver s3c_rtc_driver = {
602 .probe = s3c_rtc_probe,
603 .remove = s3c_rtc_remove,
604 .driver = {
605 .name = "s3c-rtc",
606 .pm = &s3c_rtc_pm_ops,
607 .of_match_table = of_match_ptr(s3c_rtc_dt_match),
608 },
609};
610module_platform_driver(s3c_rtc_driver);
611
612MODULE_DESCRIPTION("Samsung S3C RTC Driver");
613MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
614MODULE_LICENSE("GPL");
615MODULE_ALIAS("platform:s3c2410-rtc");