blob: 4f98543d1ea5d700d52572add88dc37200c7b4e6 [file] [log] [blame]
Paul Mundt317a6102006-09-27 17:13:19 +09001/*
2 * SuperH On-Chip RTC Support
3 *
Paul Mundt063adc72009-04-16 14:12:22 +09004 * Copyright (C) 2006 - 2009 Paul Mundt
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +09005 * Copyright (C) 2006 Jamie Lenehan
Angelo Castellob420b1a2008-03-06 12:50:53 +09006 * Copyright (C) 2008 Angelo Castello
Paul Mundt317a6102006-09-27 17:13:19 +09007 *
8 * Based on the old arch/sh/kernel/cpu/rtc.c by:
9 *
10 * Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
11 * Copyright (C) 1999 Tetsuya Okada & Niibe Yutaka
12 *
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
15 * for more details.
16 */
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>
Jamie Lenehan31ccb082006-12-07 17:23:50 +090026#include <linux/io.h>
Jonathan Cameron5d2a5032009-01-06 14:42:12 -080027#include <linux/log2.h>
Paul Mundt063adc72009-04-16 14:12:22 +090028#include <linux/clk.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Chris Brandtdab5aec2017-03-29 10:30:29 -070030#ifdef CONFIG_SUPERH
Paul Mundtad89f872007-08-03 14:19:58 +090031#include <asm/rtc.h>
Chris Brandtdab5aec2017-03-29 10:30:29 -070032#else
33/* Default values for RZ/A RTC */
34#define rtc_reg_size sizeof(u16)
35#define RTC_BIT_INVERTED 0 /* no chip bugs */
36#define RTC_CAP_4_DIGIT_YEAR (1 << 0)
37#define RTC_DEF_CAPABILITIES RTC_CAP_4_DIGIT_YEAR
38#endif
Paul Mundt317a6102006-09-27 17:13:19 +090039
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +090040#define DRV_NAME "sh-rtc"
Paul Mundt317a6102006-09-27 17:13:19 +090041
42#define RTC_REG(r) ((r) * rtc_reg_size)
43
Jamie Lenehan31ccb082006-12-07 17:23:50 +090044#define R64CNT RTC_REG(0)
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +090045
46#define RSECCNT RTC_REG(1) /* RTC sec */
47#define RMINCNT RTC_REG(2) /* RTC min */
48#define RHRCNT RTC_REG(3) /* RTC hour */
49#define RWKCNT RTC_REG(4) /* RTC week */
50#define RDAYCNT RTC_REG(5) /* RTC day */
51#define RMONCNT RTC_REG(6) /* RTC month */
52#define RYRCNT RTC_REG(7) /* RTC year */
53#define RSECAR RTC_REG(8) /* ALARM sec */
54#define RMINAR RTC_REG(9) /* ALARM min */
55#define RHRAR RTC_REG(10) /* ALARM hour */
56#define RWKAR RTC_REG(11) /* ALARM week */
57#define RDAYAR RTC_REG(12) /* ALARM day */
58#define RMONAR RTC_REG(13) /* ALARM month */
59#define RCR1 RTC_REG(14) /* Control */
60#define RCR2 RTC_REG(15) /* Control */
61
Paul Mundtff1b7502007-11-26 17:56:31 +090062/*
63 * Note on RYRAR and RCR3: Up until this point most of the register
64 * definitions are consistent across all of the available parts. However,
65 * the placement of the optional RYRAR and RCR3 (the RYRAR control
66 * register used to control RYRCNT/RYRAR compare) varies considerably
67 * across various parts, occasionally being mapped in to a completely
68 * unrelated address space. For proper RYRAR support a separate resource
69 * would have to be handed off, but as this is purely optional in
70 * practice, we simply opt not to support it, thereby keeping the code
71 * quite a bit more simplified.
72 */
73
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +090074/* ALARM Bits - or with BCD encoded value */
75#define AR_ENB 0x80 /* Enable for alarm cmp */
Paul Mundt317a6102006-09-27 17:13:19 +090076
Angelo Castellob420b1a2008-03-06 12:50:53 +090077/* Period Bits */
78#define PF_HP 0x100 /* Enable Half Period to support 8,32,128Hz */
79#define PF_COUNT 0x200 /* Half periodic counter */
80#define PF_OXS 0x400 /* Periodic One x Second */
81#define PF_KOU 0x800 /* Kernel or User periodic request 1=kernel */
82#define PF_MASK 0xf00
83
Paul Mundt317a6102006-09-27 17:13:19 +090084/* RCR1 Bits */
85#define RCR1_CF 0x80 /* Carry Flag */
86#define RCR1_CIE 0x10 /* Carry Interrupt Enable */
87#define RCR1_AIE 0x08 /* Alarm Interrupt Enable */
88#define RCR1_AF 0x01 /* Alarm Flag */
89
90/* RCR2 Bits */
91#define RCR2_PEF 0x80 /* PEriodic interrupt Flag */
92#define RCR2_PESMASK 0x70 /* Periodic interrupt Set */
93#define RCR2_RTCEN 0x08 /* ENable RTC */
94#define RCR2_ADJ 0x04 /* ADJustment (30-second) */
95#define RCR2_RESET 0x02 /* Reset bit */
96#define RCR2_START 0x01 /* Start bit */
97
98struct sh_rtc {
Paul Mundt063adc72009-04-16 14:12:22 +090099 void __iomem *regbase;
100 unsigned long regsize;
101 struct resource *res;
102 int alarm_irq;
103 int periodic_irq;
104 int carry_irq;
105 struct clk *clk;
106 struct rtc_device *rtc_dev;
107 spinlock_t lock;
108 unsigned long capabilities; /* See asm/rtc.h for cap bits */
109 unsigned short periodic_freq;
Paul Mundt317a6102006-09-27 17:13:19 +0900110};
111
Magnus Damm5e084a12009-02-24 22:11:03 +0900112static int __sh_rtc_interrupt(struct sh_rtc *rtc)
Paul Mundt317a6102006-09-27 17:13:19 +0900113{
Magnus Damm5e084a12009-02-24 22:11:03 +0900114 unsigned int tmp, pending;
Paul Mundt317a6102006-09-27 17:13:19 +0900115
116 tmp = readb(rtc->regbase + RCR1);
Magnus Damm5e084a12009-02-24 22:11:03 +0900117 pending = tmp & RCR1_CF;
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900118 tmp &= ~RCR1_CF;
Paul Mundt317a6102006-09-27 17:13:19 +0900119 writeb(tmp, rtc->regbase + RCR1);
120
Angelo Castellob420b1a2008-03-06 12:50:53 +0900121 /* Users have requested One x Second IRQ */
Magnus Damm5e084a12009-02-24 22:11:03 +0900122 if (pending && rtc->periodic_freq & PF_OXS)
Angelo Castellob420b1a2008-03-06 12:50:53 +0900123 rtc_update_irq(rtc->rtc_dev, 1, RTC_UF | RTC_IRQF);
Paul Mundt317a6102006-09-27 17:13:19 +0900124
Magnus Damm5e084a12009-02-24 22:11:03 +0900125 return pending;
Paul Mundt317a6102006-09-27 17:13:19 +0900126}
127
Magnus Damm5e084a12009-02-24 22:11:03 +0900128static int __sh_rtc_alarm(struct sh_rtc *rtc)
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900129{
Magnus Damm5e084a12009-02-24 22:11:03 +0900130 unsigned int tmp, pending;
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900131
132 tmp = readb(rtc->regbase + RCR1);
Magnus Damm5e084a12009-02-24 22:11:03 +0900133 pending = tmp & RCR1_AF;
Angelo Castellob420b1a2008-03-06 12:50:53 +0900134 tmp &= ~(RCR1_AF | RCR1_AIE);
Magnus Damm5e084a12009-02-24 22:11:03 +0900135 writeb(tmp, rtc->regbase + RCR1);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900136
Magnus Damm5e084a12009-02-24 22:11:03 +0900137 if (pending)
138 rtc_update_irq(rtc->rtc_dev, 1, RTC_AF | RTC_IRQF);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900139
Magnus Damm5e084a12009-02-24 22:11:03 +0900140 return pending;
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900141}
142
Magnus Damm5e084a12009-02-24 22:11:03 +0900143static int __sh_rtc_periodic(struct sh_rtc *rtc)
Paul Mundt317a6102006-09-27 17:13:19 +0900144{
Angelo Castellob420b1a2008-03-06 12:50:53 +0900145 struct rtc_device *rtc_dev = rtc->rtc_dev;
Magnus Damm5e084a12009-02-24 22:11:03 +0900146 struct rtc_task *irq_task;
147 unsigned int tmp, pending;
Paul Mundt317a6102006-09-27 17:13:19 +0900148
Angelo Castellob420b1a2008-03-06 12:50:53 +0900149 tmp = readb(rtc->regbase + RCR2);
Magnus Damm5e084a12009-02-24 22:11:03 +0900150 pending = tmp & RCR2_PEF;
Angelo Castellob420b1a2008-03-06 12:50:53 +0900151 tmp &= ~RCR2_PEF;
152 writeb(tmp, rtc->regbase + RCR2);
153
Magnus Damm5e084a12009-02-24 22:11:03 +0900154 if (!pending)
155 return 0;
156
Angelo Castellob420b1a2008-03-06 12:50:53 +0900157 /* Half period enabled than one skipped and the next notified */
158 if ((rtc->periodic_freq & PF_HP) && (rtc->periodic_freq & PF_COUNT))
159 rtc->periodic_freq &= ~PF_COUNT;
160 else {
161 if (rtc->periodic_freq & PF_HP)
162 rtc->periodic_freq |= PF_COUNT;
163 if (rtc->periodic_freq & PF_KOU) {
164 spin_lock(&rtc_dev->irq_task_lock);
Magnus Damm5e084a12009-02-24 22:11:03 +0900165 irq_task = rtc_dev->irq_task;
166 if (irq_task)
167 irq_task->func(irq_task->private_data);
Angelo Castellob420b1a2008-03-06 12:50:53 +0900168 spin_unlock(&rtc_dev->irq_task_lock);
169 } else
170 rtc_update_irq(rtc->rtc_dev, 1, RTC_PF | RTC_IRQF);
171 }
Paul Mundt317a6102006-09-27 17:13:19 +0900172
Magnus Damm5e084a12009-02-24 22:11:03 +0900173 return pending;
174}
175
176static irqreturn_t sh_rtc_interrupt(int irq, void *dev_id)
177{
178 struct sh_rtc *rtc = dev_id;
179 int ret;
180
181 spin_lock(&rtc->lock);
182 ret = __sh_rtc_interrupt(rtc);
Paul Mundt317a6102006-09-27 17:13:19 +0900183 spin_unlock(&rtc->lock);
184
Magnus Damm5e084a12009-02-24 22:11:03 +0900185 return IRQ_RETVAL(ret);
186}
187
188static irqreturn_t sh_rtc_alarm(int irq, void *dev_id)
189{
190 struct sh_rtc *rtc = dev_id;
191 int ret;
192
193 spin_lock(&rtc->lock);
194 ret = __sh_rtc_alarm(rtc);
195 spin_unlock(&rtc->lock);
196
197 return IRQ_RETVAL(ret);
198}
199
200static irqreturn_t sh_rtc_periodic(int irq, void *dev_id)
201{
202 struct sh_rtc *rtc = dev_id;
203 int ret;
204
205 spin_lock(&rtc->lock);
206 ret = __sh_rtc_periodic(rtc);
207 spin_unlock(&rtc->lock);
208
209 return IRQ_RETVAL(ret);
210}
211
212static irqreturn_t sh_rtc_shared(int irq, void *dev_id)
213{
214 struct sh_rtc *rtc = dev_id;
215 int ret;
216
217 spin_lock(&rtc->lock);
218 ret = __sh_rtc_interrupt(rtc);
219 ret |= __sh_rtc_alarm(rtc);
220 ret |= __sh_rtc_periodic(rtc);
221 spin_unlock(&rtc->lock);
222
223 return IRQ_RETVAL(ret);
Paul Mundt317a6102006-09-27 17:13:19 +0900224}
225
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900226static int sh_rtc_irq_set_state(struct device *dev, int enable)
Paul Mundt317a6102006-09-27 17:13:19 +0900227{
228 struct sh_rtc *rtc = dev_get_drvdata(dev);
229 unsigned int tmp;
230
231 spin_lock_irq(&rtc->lock);
232
233 tmp = readb(rtc->regbase + RCR2);
234
235 if (enable) {
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900236 rtc->periodic_freq |= PF_KOU;
Angelo Castellob420b1a2008-03-06 12:50:53 +0900237 tmp &= ~RCR2_PEF; /* Clear PES bit */
238 tmp |= (rtc->periodic_freq & ~PF_HP); /* Set PES2-0 */
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900239 } else {
240 rtc->periodic_freq &= ~PF_KOU;
Paul Mundt317a6102006-09-27 17:13:19 +0900241 tmp &= ~(RCR2_PESMASK | RCR2_PEF);
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900242 }
Paul Mundt317a6102006-09-27 17:13:19 +0900243
244 writeb(tmp, rtc->regbase + RCR2);
245
246 spin_unlock_irq(&rtc->lock);
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900247
248 return 0;
Paul Mundt317a6102006-09-27 17:13:19 +0900249}
250
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900251static int sh_rtc_irq_set_freq(struct device *dev, int freq)
Angelo Castellob420b1a2008-03-06 12:50:53 +0900252{
253 struct sh_rtc *rtc = dev_get_drvdata(dev);
254 int tmp, ret = 0;
255
256 spin_lock_irq(&rtc->lock);
257 tmp = rtc->periodic_freq & PF_MASK;
258
259 switch (freq) {
260 case 0:
261 rtc->periodic_freq = 0x00;
262 break;
263 case 1:
264 rtc->periodic_freq = 0x60;
265 break;
266 case 2:
267 rtc->periodic_freq = 0x50;
268 break;
269 case 4:
270 rtc->periodic_freq = 0x40;
271 break;
272 case 8:
273 rtc->periodic_freq = 0x30 | PF_HP;
274 break;
275 case 16:
276 rtc->periodic_freq = 0x30;
277 break;
278 case 32:
279 rtc->periodic_freq = 0x20 | PF_HP;
280 break;
281 case 64:
282 rtc->periodic_freq = 0x20;
283 break;
284 case 128:
285 rtc->periodic_freq = 0x10 | PF_HP;
286 break;
287 case 256:
288 rtc->periodic_freq = 0x10;
289 break;
290 default:
291 ret = -ENOTSUPP;
292 }
293
Paul Mundt1043bf52009-09-09 12:13:01 +0900294 if (ret == 0)
Angelo Castellob420b1a2008-03-06 12:50:53 +0900295 rtc->periodic_freq |= tmp;
Angelo Castellob420b1a2008-03-06 12:50:53 +0900296
297 spin_unlock_irq(&rtc->lock);
298 return ret;
299}
300
Paul Mundt317a6102006-09-27 17:13:19 +0900301static inline void sh_rtc_setaie(struct device *dev, unsigned int enable)
302{
303 struct sh_rtc *rtc = dev_get_drvdata(dev);
304 unsigned int tmp;
305
306 spin_lock_irq(&rtc->lock);
307
308 tmp = readb(rtc->regbase + RCR1);
309
Paul Mundt063adc72009-04-16 14:12:22 +0900310 if (enable)
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900311 tmp |= RCR1_AIE;
Paul Mundt063adc72009-04-16 14:12:22 +0900312 else
313 tmp &= ~RCR1_AIE;
Paul Mundt317a6102006-09-27 17:13:19 +0900314
315 writeb(tmp, rtc->regbase + RCR1);
316
317 spin_unlock_irq(&rtc->lock);
318}
319
Paul Mundt317a6102006-09-27 17:13:19 +0900320static int sh_rtc_proc(struct device *dev, struct seq_file *seq)
321{
322 struct sh_rtc *rtc = dev_get_drvdata(dev);
323 unsigned int tmp;
324
325 tmp = readb(rtc->regbase + RCR1);
Angelo Castellob420b1a2008-03-06 12:50:53 +0900326 seq_printf(seq, "carry_IRQ\t: %s\n", (tmp & RCR1_CIE) ? "yes" : "no");
Paul Mundt317a6102006-09-27 17:13:19 +0900327
328 tmp = readb(rtc->regbase + RCR2);
329 seq_printf(seq, "periodic_IRQ\t: %s\n",
Angelo Castellob420b1a2008-03-06 12:50:53 +0900330 (tmp & RCR2_PESMASK) ? "yes" : "no");
Paul Mundt317a6102006-09-27 17:13:19 +0900331
332 return 0;
333}
334
Magnus Damm9cd88b92009-03-19 10:05:58 +0000335static inline void sh_rtc_setcie(struct device *dev, unsigned int enable)
336{
337 struct sh_rtc *rtc = dev_get_drvdata(dev);
338 unsigned int tmp;
339
340 spin_lock_irq(&rtc->lock);
341
342 tmp = readb(rtc->regbase + RCR1);
343
344 if (!enable)
345 tmp &= ~RCR1_CIE;
346 else
347 tmp |= RCR1_CIE;
348
349 writeb(tmp, rtc->regbase + RCR1);
350
351 spin_unlock_irq(&rtc->lock);
352}
353
John Stultz16380c12011-02-02 17:02:41 -0800354static int sh_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
355{
356 sh_rtc_setaie(dev, enabled);
357 return 0;
358}
359
Paul Mundt317a6102006-09-27 17:13:19 +0900360static int sh_rtc_read_time(struct device *dev, struct rtc_time *tm)
361{
Wolfram Sang85368bb2018-04-19 16:06:14 +0200362 struct sh_rtc *rtc = dev_get_drvdata(dev);
Paul Mundt317a6102006-09-27 17:13:19 +0900363 unsigned int sec128, sec2, yr, yr100, cf_bit;
364
365 do {
366 unsigned int tmp;
367
368 spin_lock_irq(&rtc->lock);
369
370 tmp = readb(rtc->regbase + RCR1);
371 tmp &= ~RCR1_CF; /* Clear CF-bit */
372 tmp |= RCR1_CIE;
373 writeb(tmp, rtc->regbase + RCR1);
374
375 sec128 = readb(rtc->regbase + R64CNT);
376
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700377 tm->tm_sec = bcd2bin(readb(rtc->regbase + RSECCNT));
378 tm->tm_min = bcd2bin(readb(rtc->regbase + RMINCNT));
379 tm->tm_hour = bcd2bin(readb(rtc->regbase + RHRCNT));
380 tm->tm_wday = bcd2bin(readb(rtc->regbase + RWKCNT));
381 tm->tm_mday = bcd2bin(readb(rtc->regbase + RDAYCNT));
382 tm->tm_mon = bcd2bin(readb(rtc->regbase + RMONCNT)) - 1;
Paul Mundt317a6102006-09-27 17:13:19 +0900383
Paul Mundtad89f872007-08-03 14:19:58 +0900384 if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
385 yr = readw(rtc->regbase + RYRCNT);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700386 yr100 = bcd2bin(yr >> 8);
Paul Mundtad89f872007-08-03 14:19:58 +0900387 yr &= 0xff;
388 } else {
389 yr = readb(rtc->regbase + RYRCNT);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700390 yr100 = bcd2bin((yr == 0x99) ? 0x19 : 0x20);
Paul Mundtad89f872007-08-03 14:19:58 +0900391 }
Paul Mundt317a6102006-09-27 17:13:19 +0900392
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700393 tm->tm_year = (yr100 * 100 + bcd2bin(yr)) - 1900;
Paul Mundt317a6102006-09-27 17:13:19 +0900394
395 sec2 = readb(rtc->regbase + R64CNT);
396 cf_bit = readb(rtc->regbase + RCR1) & RCR1_CF;
397
398 spin_unlock_irq(&rtc->lock);
399 } while (cf_bit != 0 || ((sec128 ^ sec2) & RTC_BIT_INVERTED) != 0);
400
401#if RTC_BIT_INVERTED != 0
402 if ((sec128 & RTC_BIT_INVERTED))
403 tm->tm_sec--;
404#endif
405
Magnus Damm9cd88b92009-03-19 10:05:58 +0000406 /* only keep the carry interrupt enabled if UIE is on */
407 if (!(rtc->periodic_freq & PF_OXS))
408 sh_rtc_setcie(dev, 0);
409
Paul Mundt435c55d2007-05-08 11:56:27 +0900410 dev_dbg(dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
Paul Mundt317a6102006-09-27 17:13:19 +0900411 "mday=%d, mon=%d, year=%d, wday=%d\n",
Harvey Harrison2a4e2b8782008-04-28 02:12:00 -0700412 __func__,
Paul Mundt317a6102006-09-27 17:13:19 +0900413 tm->tm_sec, tm->tm_min, tm->tm_hour,
Jamie Lenehana1614792006-12-08 14:49:30 +0900414 tm->tm_mday, tm->tm_mon + 1, tm->tm_year, tm->tm_wday);
Paul Mundt317a6102006-09-27 17:13:19 +0900415
Alexandre Belloni22652ba2018-02-19 16:23:56 +0100416 return 0;
Paul Mundt317a6102006-09-27 17:13:19 +0900417}
418
419static int sh_rtc_set_time(struct device *dev, struct rtc_time *tm)
420{
Wolfram Sang85368bb2018-04-19 16:06:14 +0200421 struct sh_rtc *rtc = dev_get_drvdata(dev);
Paul Mundt317a6102006-09-27 17:13:19 +0900422 unsigned int tmp;
423 int year;
424
425 spin_lock_irq(&rtc->lock);
426
427 /* Reset pre-scaler & stop RTC */
428 tmp = readb(rtc->regbase + RCR2);
429 tmp |= RCR2_RESET;
Markus Brunner699bc662007-07-26 17:31:28 +0900430 tmp &= ~RCR2_START;
Paul Mundt317a6102006-09-27 17:13:19 +0900431 writeb(tmp, rtc->regbase + RCR2);
432
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700433 writeb(bin2bcd(tm->tm_sec), rtc->regbase + RSECCNT);
434 writeb(bin2bcd(tm->tm_min), rtc->regbase + RMINCNT);
435 writeb(bin2bcd(tm->tm_hour), rtc->regbase + RHRCNT);
436 writeb(bin2bcd(tm->tm_wday), rtc->regbase + RWKCNT);
437 writeb(bin2bcd(tm->tm_mday), rtc->regbase + RDAYCNT);
438 writeb(bin2bcd(tm->tm_mon + 1), rtc->regbase + RMONCNT);
Paul Mundt317a6102006-09-27 17:13:19 +0900439
Paul Mundtad89f872007-08-03 14:19:58 +0900440 if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700441 year = (bin2bcd((tm->tm_year + 1900) / 100) << 8) |
442 bin2bcd(tm->tm_year % 100);
Paul Mundtad89f872007-08-03 14:19:58 +0900443 writew(year, rtc->regbase + RYRCNT);
444 } else {
445 year = tm->tm_year % 100;
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700446 writeb(bin2bcd(year), rtc->regbase + RYRCNT);
Paul Mundtad89f872007-08-03 14:19:58 +0900447 }
Paul Mundt317a6102006-09-27 17:13:19 +0900448
449 /* Start RTC */
450 tmp = readb(rtc->regbase + RCR2);
451 tmp &= ~RCR2_RESET;
452 tmp |= RCR2_RTCEN | RCR2_START;
453 writeb(tmp, rtc->regbase + RCR2);
454
455 spin_unlock_irq(&rtc->lock);
456
457 return 0;
458}
459
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900460static inline int sh_rtc_read_alarm_value(struct sh_rtc *rtc, int reg_off)
461{
462 unsigned int byte;
463 int value = 0xff; /* return 0xff for ignored values */
464
465 byte = readb(rtc->regbase + reg_off);
466 if (byte & AR_ENB) {
467 byte &= ~AR_ENB; /* strip the enable bit */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700468 value = bcd2bin(byte);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900469 }
470
471 return value;
472}
473
474static int sh_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
475{
Wolfram Sang85368bb2018-04-19 16:06:14 +0200476 struct sh_rtc *rtc = dev_get_drvdata(dev);
Angelo Castellob420b1a2008-03-06 12:50:53 +0900477 struct rtc_time *tm = &wkalrm->time;
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900478
479 spin_lock_irq(&rtc->lock);
480
481 tm->tm_sec = sh_rtc_read_alarm_value(rtc, RSECAR);
482 tm->tm_min = sh_rtc_read_alarm_value(rtc, RMINAR);
483 tm->tm_hour = sh_rtc_read_alarm_value(rtc, RHRAR);
484 tm->tm_wday = sh_rtc_read_alarm_value(rtc, RWKAR);
485 tm->tm_mday = sh_rtc_read_alarm_value(rtc, RDAYAR);
486 tm->tm_mon = sh_rtc_read_alarm_value(rtc, RMONAR);
487 if (tm->tm_mon > 0)
488 tm->tm_mon -= 1; /* RTC is 1-12, tm_mon is 0-11 */
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900489
David Brownell0d103e92007-01-10 23:15:32 -0800490 wkalrm->enabled = (readb(rtc->regbase + RCR1) & RCR1_AIE) ? 1 : 0;
491
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900492 spin_unlock_irq(&rtc->lock);
493
494 return 0;
495}
496
497static inline void sh_rtc_write_alarm_value(struct sh_rtc *rtc,
498 int value, int reg_off)
499{
500 /* < 0 for a value that is ignored */
501 if (value < 0)
502 writeb(0, rtc->regbase + reg_off);
503 else
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700504 writeb(bin2bcd(value) | AR_ENB, rtc->regbase + reg_off);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900505}
506
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900507static int sh_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
508{
Wolfram Sang85368bb2018-04-19 16:06:14 +0200509 struct sh_rtc *rtc = dev_get_drvdata(dev);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900510 unsigned int rcr1;
511 struct rtc_time *tm = &wkalrm->time;
Uwe Kleine-König84411892016-06-28 10:43:48 +0200512 int mon;
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900513
514 spin_lock_irq(&rtc->lock);
515
Jamie Lenehan15c945c2007-01-22 20:40:41 -0800516 /* disable alarm interrupt and clear the alarm flag */
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900517 rcr1 = readb(rtc->regbase + RCR1);
Angelo Castellob420b1a2008-03-06 12:50:53 +0900518 rcr1 &= ~(RCR1_AF | RCR1_AIE);
Jamie Lenehan15c945c2007-01-22 20:40:41 -0800519 writeb(rcr1, rtc->regbase + RCR1);
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900520
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900521 /* set alarm time */
522 sh_rtc_write_alarm_value(rtc, tm->tm_sec, RSECAR);
523 sh_rtc_write_alarm_value(rtc, tm->tm_min, RMINAR);
524 sh_rtc_write_alarm_value(rtc, tm->tm_hour, RHRAR);
525 sh_rtc_write_alarm_value(rtc, tm->tm_wday, RWKAR);
526 sh_rtc_write_alarm_value(rtc, tm->tm_mday, RDAYAR);
527 mon = tm->tm_mon;
528 if (mon >= 0)
529 mon += 1;
530 sh_rtc_write_alarm_value(rtc, mon, RMONAR);
531
Jamie Lenehan15c945c2007-01-22 20:40:41 -0800532 if (wkalrm->enabled) {
533 rcr1 |= RCR1_AIE;
534 writeb(rcr1, rtc->regbase + RCR1);
535 }
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900536
537 spin_unlock_irq(&rtc->lock);
538
539 return 0;
540}
541
Bhumika Goyal8bc57e72017-01-05 22:25:05 +0530542static const struct rtc_class_ops sh_rtc_ops = {
Paul Mundt317a6102006-09-27 17:13:19 +0900543 .read_time = sh_rtc_read_time,
544 .set_time = sh_rtc_set_time,
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900545 .read_alarm = sh_rtc_read_alarm,
546 .set_alarm = sh_rtc_set_alarm,
Paul Mundt317a6102006-09-27 17:13:19 +0900547 .proc = sh_rtc_proc,
John Stultz16380c12011-02-02 17:02:41 -0800548 .alarm_irq_enable = sh_rtc_alarm_irq_enable,
Paul Mundt317a6102006-09-27 17:13:19 +0900549};
550
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900551static int __init sh_rtc_probe(struct platform_device *pdev)
Paul Mundt317a6102006-09-27 17:13:19 +0900552{
553 struct sh_rtc *rtc;
554 struct resource *res;
Magnus Dammedf22472009-03-19 10:10:44 +0000555 struct rtc_time r;
Paul Mundt063adc72009-04-16 14:12:22 +0900556 char clk_name[6];
557 int clk_id, ret;
Paul Mundt317a6102006-09-27 17:13:19 +0900558
Jingoo Han0209aff2013-07-03 15:07:11 -0700559 rtc = devm_kzalloc(&pdev->dev, sizeof(*rtc), GFP_KERNEL);
Paul Mundt317a6102006-09-27 17:13:19 +0900560 if (unlikely(!rtc))
561 return -ENOMEM;
562
563 spin_lock_init(&rtc->lock);
564
Angelo Castellob420b1a2008-03-06 12:50:53 +0900565 /* get periodic/carry/alarm irqs */
roel kluin2641dc92008-09-10 19:34:44 +0200566 ret = platform_get_irq(pdev, 0);
Anton Vorontsov2fac6672009-01-06 14:42:11 -0800567 if (unlikely(ret <= 0)) {
Magnus Damm5e084a12009-02-24 22:11:03 +0900568 dev_err(&pdev->dev, "No IRQ resource\n");
Jingoo Han0209aff2013-07-03 15:07:11 -0700569 return -ENOENT;
Paul Mundt317a6102006-09-27 17:13:19 +0900570 }
Paul Mundt063adc72009-04-16 14:12:22 +0900571
roel kluin2641dc92008-09-10 19:34:44 +0200572 rtc->periodic_irq = ret;
Magnus Damm5e084a12009-02-24 22:11:03 +0900573 rtc->carry_irq = platform_get_irq(pdev, 1);
574 rtc->alarm_irq = platform_get_irq(pdev, 2);
Paul Mundt317a6102006-09-27 17:13:19 +0900575
576 res = platform_get_resource(pdev, IORESOURCE_IO, 0);
Chris Brandtdab5aec2017-03-29 10:30:29 -0700577 if (!res)
578 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Paul Mundt317a6102006-09-27 17:13:19 +0900579 if (unlikely(res == NULL)) {
580 dev_err(&pdev->dev, "No IO resource\n");
Jingoo Han0209aff2013-07-03 15:07:11 -0700581 return -ENOENT;
Paul Mundt317a6102006-09-27 17:13:19 +0900582 }
583
Paul Mundt063adc72009-04-16 14:12:22 +0900584 rtc->regsize = resource_size(res);
Paul Mundt317a6102006-09-27 17:13:19 +0900585
Jingoo Han0209aff2013-07-03 15:07:11 -0700586 rtc->res = devm_request_mem_region(&pdev->dev, res->start,
587 rtc->regsize, pdev->name);
588 if (unlikely(!rtc->res))
589 return -EBUSY;
Paul Mundt317a6102006-09-27 17:13:19 +0900590
Jingoo Han0209aff2013-07-03 15:07:11 -0700591 rtc->regbase = devm_ioremap_nocache(&pdev->dev, rtc->res->start,
592 rtc->regsize);
593 if (unlikely(!rtc->regbase))
594 return -EINVAL;
Paul Mundt317a6102006-09-27 17:13:19 +0900595
Chris Brandtdab5aec2017-03-29 10:30:29 -0700596 if (!pdev->dev.of_node) {
597 clk_id = pdev->id;
598 /* With a single device, the clock id is still "rtc0" */
599 if (clk_id < 0)
600 clk_id = 0;
Paul Mundt063adc72009-04-16 14:12:22 +0900601
Chris Brandtdab5aec2017-03-29 10:30:29 -0700602 snprintf(clk_name, sizeof(clk_name), "rtc%d", clk_id);
603 } else
604 snprintf(clk_name, sizeof(clk_name), "fck");
Paul Mundt063adc72009-04-16 14:12:22 +0900605
Jingoo Han0209aff2013-07-03 15:07:11 -0700606 rtc->clk = devm_clk_get(&pdev->dev, clk_name);
Paul Mundt063adc72009-04-16 14:12:22 +0900607 if (IS_ERR(rtc->clk)) {
608 /*
609 * No error handling for rtc->clk intentionally, not all
610 * platforms will have a unique clock for the RTC, and
611 * the clk API can handle the struct clk pointer being
612 * NULL.
613 */
614 rtc->clk = NULL;
615 }
616
617 clk_enable(rtc->clk);
618
Paul Mundtad89f872007-08-03 14:19:58 +0900619 rtc->capabilities = RTC_DEF_CAPABILITIES;
Chris Brandtdab5aec2017-03-29 10:30:29 -0700620
621#ifdef CONFIG_SUPERH
Jingoo Hane58c18d2013-11-12 15:10:52 -0800622 if (dev_get_platdata(&pdev->dev)) {
623 struct sh_rtc_platform_info *pinfo =
624 dev_get_platdata(&pdev->dev);
Paul Mundtad89f872007-08-03 14:19:58 +0900625
626 /*
627 * Some CPUs have special capabilities in addition to the
628 * default set. Add those in here.
629 */
630 rtc->capabilities |= pinfo->capabilities;
631 }
Chris Brandtdab5aec2017-03-29 10:30:29 -0700632#endif
Paul Mundtad89f872007-08-03 14:19:58 +0900633
Magnus Damm5e084a12009-02-24 22:11:03 +0900634 if (rtc->carry_irq <= 0) {
635 /* register shared periodic/carry/alarm irq */
Jingoo Han0209aff2013-07-03 15:07:11 -0700636 ret = devm_request_irq(&pdev->dev, rtc->periodic_irq,
637 sh_rtc_shared, 0, "sh-rtc", rtc);
Magnus Damm5e084a12009-02-24 22:11:03 +0900638 if (unlikely(ret)) {
639 dev_err(&pdev->dev,
640 "request IRQ failed with %d, IRQ %d\n", ret,
641 rtc->periodic_irq);
642 goto err_unmap;
643 }
644 } else {
645 /* register periodic/carry/alarm irqs */
Jingoo Han0209aff2013-07-03 15:07:11 -0700646 ret = devm_request_irq(&pdev->dev, rtc->periodic_irq,
647 sh_rtc_periodic, 0, "sh-rtc period", rtc);
Magnus Damm5e084a12009-02-24 22:11:03 +0900648 if (unlikely(ret)) {
649 dev_err(&pdev->dev,
650 "request period IRQ failed with %d, IRQ %d\n",
651 ret, rtc->periodic_irq);
652 goto err_unmap;
653 }
Angelo Castellob420b1a2008-03-06 12:50:53 +0900654
Jingoo Han0209aff2013-07-03 15:07:11 -0700655 ret = devm_request_irq(&pdev->dev, rtc->carry_irq,
656 sh_rtc_interrupt, 0, "sh-rtc carry", rtc);
Magnus Damm5e084a12009-02-24 22:11:03 +0900657 if (unlikely(ret)) {
658 dev_err(&pdev->dev,
659 "request carry IRQ failed with %d, IRQ %d\n",
660 ret, rtc->carry_irq);
Magnus Damm5e084a12009-02-24 22:11:03 +0900661 goto err_unmap;
662 }
Angelo Castellob420b1a2008-03-06 12:50:53 +0900663
Jingoo Han0209aff2013-07-03 15:07:11 -0700664 ret = devm_request_irq(&pdev->dev, rtc->alarm_irq,
665 sh_rtc_alarm, 0, "sh-rtc alarm", rtc);
Magnus Damm5e084a12009-02-24 22:11:03 +0900666 if (unlikely(ret)) {
667 dev_err(&pdev->dev,
668 "request alarm IRQ failed with %d, IRQ %d\n",
669 ret, rtc->alarm_irq);
Magnus Damm5e084a12009-02-24 22:11:03 +0900670 goto err_unmap;
671 }
Angelo Castellob420b1a2008-03-06 12:50:53 +0900672 }
673
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900674 platform_set_drvdata(pdev, rtc);
675
Magnus Damm9cd88b92009-03-19 10:05:58 +0000676 /* everything disabled by default */
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900677 sh_rtc_irq_set_freq(&pdev->dev, 0);
678 sh_rtc_irq_set_state(&pdev->dev, 0);
Magnus Damm9cd88b92009-03-19 10:05:58 +0000679 sh_rtc_setaie(&pdev->dev, 0);
680 sh_rtc_setcie(&pdev->dev, 0);
Magnus Dammedf22472009-03-19 10:10:44 +0000681
Jingoo Han0209aff2013-07-03 15:07:11 -0700682 rtc->rtc_dev = devm_rtc_device_register(&pdev->dev, "sh",
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900683 &sh_rtc_ops, THIS_MODULE);
684 if (IS_ERR(rtc->rtc_dev)) {
685 ret = PTR_ERR(rtc->rtc_dev);
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900686 goto err_unmap;
687 }
688
689 rtc->rtc_dev->max_user_freq = 256;
690
Magnus Dammedf22472009-03-19 10:10:44 +0000691 /* reset rtc to epoch 0 if time is invalid */
692 if (rtc_read_time(rtc->rtc_dev, &r) < 0) {
693 rtc_time_to_tm(0, &r);
694 rtc_set_time(rtc->rtc_dev, &r);
695 }
696
Magnus Damm7a8fe8e2009-03-19 10:14:41 +0000697 device_init_wakeup(&pdev->dev, 1);
Paul Mundt317a6102006-09-27 17:13:19 +0900698 return 0;
699
Paul Mundt03057942008-04-25 17:58:42 +0900700err_unmap:
Paul Mundt063adc72009-04-16 14:12:22 +0900701 clk_disable(rtc->clk);
Paul Mundt317a6102006-09-27 17:13:19 +0900702
703 return ret;
704}
705
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900706static int __exit sh_rtc_remove(struct platform_device *pdev)
Paul Mundt317a6102006-09-27 17:13:19 +0900707{
708 struct sh_rtc *rtc = platform_get_drvdata(pdev);
709
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900710 sh_rtc_irq_set_state(&pdev->dev, 0);
Paul Mundt317a6102006-09-27 17:13:19 +0900711
Paul Mundt317a6102006-09-27 17:13:19 +0900712 sh_rtc_setaie(&pdev->dev, 0);
Magnus Damm9cd88b92009-03-19 10:05:58 +0000713 sh_rtc_setcie(&pdev->dev, 0);
Paul Mundt317a6102006-09-27 17:13:19 +0900714
Paul Mundt063adc72009-04-16 14:12:22 +0900715 clk_disable(rtc->clk);
Paul Mundt317a6102006-09-27 17:13:19 +0900716
717 return 0;
718}
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000719
720static void sh_rtc_set_irq_wake(struct device *dev, int enabled)
721{
Wolfram Sang85368bb2018-04-19 16:06:14 +0200722 struct sh_rtc *rtc = dev_get_drvdata(dev);
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000723
Thomas Gleixnerdced35a2011-03-28 17:49:12 +0200724 irq_set_irq_wake(rtc->periodic_irq, enabled);
Paul Mundt063adc72009-04-16 14:12:22 +0900725
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000726 if (rtc->carry_irq > 0) {
Thomas Gleixnerdced35a2011-03-28 17:49:12 +0200727 irq_set_irq_wake(rtc->carry_irq, enabled);
728 irq_set_irq_wake(rtc->alarm_irq, enabled);
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000729 }
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000730}
731
Arnd Bergmann5d05e812017-04-19 19:52:43 +0200732static int __maybe_unused sh_rtc_suspend(struct device *dev)
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000733{
734 if (device_may_wakeup(dev))
735 sh_rtc_set_irq_wake(dev, 1);
736
737 return 0;
738}
739
Arnd Bergmann5d05e812017-04-19 19:52:43 +0200740static int __maybe_unused sh_rtc_resume(struct device *dev)
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000741{
742 if (device_may_wakeup(dev))
743 sh_rtc_set_irq_wake(dev, 0);
744
745 return 0;
746}
747
Jingoo Han0ed50542013-04-29 16:20:00 -0700748static SIMPLE_DEV_PM_OPS(sh_rtc_pm_ops, sh_rtc_suspend, sh_rtc_resume);
Magnus Dammfaa9fa82009-04-01 14:45:17 +0000749
Chris Brandtdab5aec2017-03-29 10:30:29 -0700750static const struct of_device_id sh_rtc_of_match[] = {
751 { .compatible = "renesas,sh-rtc", },
752 { /* sentinel */ }
753};
754MODULE_DEVICE_TABLE(of, sh_rtc_of_match);
755
Paul Mundt317a6102006-09-27 17:13:19 +0900756static struct platform_driver sh_rtc_platform_driver = {
757 .driver = {
Jamie Lenehan1b73e6a2006-12-08 15:26:15 +0900758 .name = DRV_NAME,
Jingoo Han0ed50542013-04-29 16:20:00 -0700759 .pm = &sh_rtc_pm_ops,
Chris Brandtdab5aec2017-03-29 10:30:29 -0700760 .of_match_table = sh_rtc_of_match,
Paul Mundt317a6102006-09-27 17:13:19 +0900761 },
Alessandro Zummo5c9740a2009-08-20 13:25:11 +0900762 .remove = __exit_p(sh_rtc_remove),
Paul Mundt317a6102006-09-27 17:13:19 +0900763};
764
Jingoo Handeed5a92013-04-29 16:18:51 -0700765module_platform_driver_probe(sh_rtc_platform_driver, sh_rtc_probe);
Paul Mundt317a6102006-09-27 17:13:19 +0900766
767MODULE_DESCRIPTION("SuperH on-chip RTC driver");
Angelo Castellob420b1a2008-03-06 12:50:53 +0900768MODULE_AUTHOR("Paul Mundt <lethal@linux-sh.org>, "
769 "Jamie Lenehan <lenehan@twibble.org>, "
770 "Angelo Castello <angelo.castello@st.com>");
Paul Mundt317a6102006-09-27 17:13:19 +0900771MODULE_LICENSE("GPL");
Kay Sieversad28a072008-04-10 21:29:25 -0700772MODULE_ALIAS("platform:" DRV_NAME);