14ff6f024SKuninori Morimoto // SPDX-License-Identifier: GPL-2.0
2317a6104SPaul Mundt /*
3317a6104SPaul Mundt * SuperH On-Chip RTC Support
4317a6104SPaul Mundt *
5063adc75SPaul Mundt * Copyright (C) 2006 - 2009 Paul Mundt
61b73e6aeSJamie Lenehan * Copyright (C) 2006 Jamie Lenehan
7b420b1a7SAngelo Castello * Copyright (C) 2008 Angelo Castello
8317a6104SPaul Mundt *
9317a6104SPaul Mundt * Based on the old arch/sh/kernel/cpu/rtc.c by:
10317a6104SPaul Mundt *
11317a6104SPaul Mundt * Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
12317a6104SPaul Mundt * Copyright (C) 1999 Tetsuya Okada & Niibe Yutaka
13317a6104SPaul Mundt */
14317a6104SPaul Mundt #include <linux/module.h>
15ac316725SRandy Dunlap #include <linux/mod_devicetable.h>
16317a6104SPaul Mundt #include <linux/kernel.h>
17317a6104SPaul Mundt #include <linux/bcd.h>
18317a6104SPaul Mundt #include <linux/rtc.h>
19317a6104SPaul Mundt #include <linux/init.h>
20317a6104SPaul Mundt #include <linux/platform_device.h>
21317a6104SPaul Mundt #include <linux/seq_file.h>
22317a6104SPaul Mundt #include <linux/interrupt.h>
23317a6104SPaul Mundt #include <linux/spinlock.h>
2431ccb081SJamie Lenehan #include <linux/io.h>
255d2a5037SJonathan Cameron #include <linux/log2.h>
26063adc75SPaul Mundt #include <linux/clk.h>
275a0e3ad6STejun Heo #include <linux/slab.h>
28dab5aec6SChris Brandt #ifdef CONFIG_SUPERH
29ad89f87aSPaul Mundt #include <asm/rtc.h>
30dab5aec6SChris Brandt #else
31dab5aec6SChris Brandt /* Default values for RZ/A RTC */
32dab5aec6SChris Brandt #define rtc_reg_size sizeof(u16)
33dab5aec6SChris Brandt #define RTC_BIT_INVERTED 0 /* no chip bugs */
34dab5aec6SChris Brandt #define RTC_CAP_4_DIGIT_YEAR (1 << 0)
35dab5aec6SChris Brandt #define RTC_DEF_CAPABILITIES RTC_CAP_4_DIGIT_YEAR
36dab5aec6SChris Brandt #endif
37317a6104SPaul Mundt
381b73e6aeSJamie Lenehan #define DRV_NAME "sh-rtc"
39317a6104SPaul Mundt
40317a6104SPaul Mundt #define RTC_REG(r) ((r) * rtc_reg_size)
41317a6104SPaul Mundt
42317a6104SPaul Mundt #define R64CNT RTC_REG(0)
431b73e6aeSJamie Lenehan
441b73e6aeSJamie Lenehan #define RSECCNT RTC_REG(1) /* RTC sec */
451b73e6aeSJamie Lenehan #define RMINCNT RTC_REG(2) /* RTC min */
461b73e6aeSJamie Lenehan #define RHRCNT RTC_REG(3) /* RTC hour */
471b73e6aeSJamie Lenehan #define RWKCNT RTC_REG(4) /* RTC week */
481b73e6aeSJamie Lenehan #define RDAYCNT RTC_REG(5) /* RTC day */
491b73e6aeSJamie Lenehan #define RMONCNT RTC_REG(6) /* RTC month */
501b73e6aeSJamie Lenehan #define RYRCNT RTC_REG(7) /* RTC year */
511b73e6aeSJamie Lenehan #define RSECAR RTC_REG(8) /* ALARM sec */
521b73e6aeSJamie Lenehan #define RMINAR RTC_REG(9) /* ALARM min */
531b73e6aeSJamie Lenehan #define RHRAR RTC_REG(10) /* ALARM hour */
541b73e6aeSJamie Lenehan #define RWKAR RTC_REG(11) /* ALARM week */
551b73e6aeSJamie Lenehan #define RDAYAR RTC_REG(12) /* ALARM day */
561b73e6aeSJamie Lenehan #define RMONAR RTC_REG(13) /* ALARM month */
571b73e6aeSJamie Lenehan #define RCR1 RTC_REG(14) /* Control */
581b73e6aeSJamie Lenehan #define RCR2 RTC_REG(15) /* Control */
591b73e6aeSJamie Lenehan
60ff1b7506SPaul Mundt /*
61ff1b7506SPaul Mundt * Note on RYRAR and RCR3: Up until this point most of the register
62ff1b7506SPaul Mundt * definitions are consistent across all of the available parts. However,
63ff1b7506SPaul Mundt * the placement of the optional RYRAR and RCR3 (the RYRAR control
64ff1b7506SPaul Mundt * register used to control RYRCNT/RYRAR compare) varies considerably
65ff1b7506SPaul Mundt * across various parts, occasionally being mapped in to a completely
66ff1b7506SPaul Mundt * unrelated address space. For proper RYRAR support a separate resource
67ff1b7506SPaul Mundt * would have to be handed off, but as this is purely optional in
68ff1b7506SPaul Mundt * practice, we simply opt not to support it, thereby keeping the code
69ff1b7506SPaul Mundt * quite a bit more simplified.
70ff1b7506SPaul Mundt */
71ff1b7506SPaul Mundt
721b73e6aeSJamie Lenehan /* ALARM Bits - or with BCD encoded value */
731b73e6aeSJamie Lenehan #define AR_ENB 0x80 /* Enable for alarm cmp */
74317a6104SPaul Mundt
75b420b1a7SAngelo Castello /* Period Bits */
76b420b1a7SAngelo Castello #define PF_HP 0x100 /* Enable Half Period to support 8,32,128Hz */
77b420b1a7SAngelo Castello #define PF_COUNT 0x200 /* Half periodic counter */
78b420b1a7SAngelo Castello #define PF_OXS 0x400 /* Periodic One x Second */
79b420b1a7SAngelo Castello #define PF_KOU 0x800 /* Kernel or User periodic request 1=kernel */
80b420b1a7SAngelo Castello #define PF_MASK 0xf00
81b420b1a7SAngelo Castello
82317a6104SPaul Mundt /* RCR1 Bits */
83317a6104SPaul Mundt #define RCR1_CF 0x80 /* Carry Flag */
84317a6104SPaul Mundt #define RCR1_CIE 0x10 /* Carry Interrupt Enable */
85317a6104SPaul Mundt #define RCR1_AIE 0x08 /* Alarm Interrupt Enable */
86317a6104SPaul Mundt #define RCR1_AF 0x01 /* Alarm Flag */
87317a6104SPaul Mundt
88317a6104SPaul Mundt /* RCR2 Bits */
89317a6104SPaul Mundt #define RCR2_PEF 0x80 /* PEriodic interrupt Flag */
90317a6104SPaul Mundt #define RCR2_PESMASK 0x70 /* Periodic interrupt Set */
91317a6104SPaul Mundt #define RCR2_RTCEN 0x08 /* ENable RTC */
92317a6104SPaul Mundt #define RCR2_ADJ 0x04 /* ADJustment (30-second) */
93317a6104SPaul Mundt #define RCR2_RESET 0x02 /* Reset bit */
94317a6104SPaul Mundt #define RCR2_START 0x01 /* Start bit */
95317a6104SPaul Mundt
96317a6104SPaul Mundt struct sh_rtc {
97317a6104SPaul Mundt void __iomem *regbase;
98317a6104SPaul Mundt unsigned long regsize;
99317a6104SPaul Mundt struct resource *res;
1002fac6674SAnton Vorontsov int alarm_irq;
1012fac6674SAnton Vorontsov int periodic_irq;
1022fac6674SAnton Vorontsov int carry_irq;
103063adc75SPaul Mundt struct clk *clk;
104317a6104SPaul Mundt struct rtc_device *rtc_dev;
105317a6104SPaul Mundt spinlock_t lock;
106063adc75SPaul Mundt unsigned long capabilities; /* See asm/rtc.h for cap bits */
107b420b1a7SAngelo Castello unsigned short periodic_freq;
108317a6104SPaul Mundt };
109317a6104SPaul Mundt
__sh_rtc_interrupt(struct sh_rtc * rtc)1105e084a15SMagnus Damm static int __sh_rtc_interrupt(struct sh_rtc *rtc)
111317a6104SPaul Mundt {
1125e084a15SMagnus Damm unsigned int tmp, pending;
113317a6104SPaul Mundt
114317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR1);
1155e084a15SMagnus Damm pending = tmp & RCR1_CF;
1161b73e6aeSJamie Lenehan tmp &= ~RCR1_CF;
117317a6104SPaul Mundt writeb(tmp, rtc->regbase + RCR1);
118317a6104SPaul Mundt
119b420b1a7SAngelo Castello /* Users have requested One x Second IRQ */
1205e084a15SMagnus Damm if (pending && rtc->periodic_freq & PF_OXS)
121b420b1a7SAngelo Castello rtc_update_irq(rtc->rtc_dev, 1, RTC_UF | RTC_IRQF);
122317a6104SPaul Mundt
1235e084a15SMagnus Damm return pending;
124317a6104SPaul Mundt }
125317a6104SPaul Mundt
__sh_rtc_alarm(struct sh_rtc * rtc)1265e084a15SMagnus Damm static int __sh_rtc_alarm(struct sh_rtc *rtc)
1271b73e6aeSJamie Lenehan {
1285e084a15SMagnus Damm unsigned int tmp, pending;
1291b73e6aeSJamie Lenehan
1301b73e6aeSJamie Lenehan tmp = readb(rtc->regbase + RCR1);
1315e084a15SMagnus Damm pending = tmp & RCR1_AF;
1321b73e6aeSJamie Lenehan tmp &= ~(RCR1_AF | RCR1_AIE);
1331b73e6aeSJamie Lenehan writeb(tmp, rtc->regbase + RCR1);
1341b73e6aeSJamie Lenehan
1355e084a15SMagnus Damm if (pending)
136b420b1a7SAngelo Castello rtc_update_irq(rtc->rtc_dev, 1, RTC_AF | RTC_IRQF);
1371b73e6aeSJamie Lenehan
1385e084a15SMagnus Damm return pending;
1391b73e6aeSJamie Lenehan }
1401b73e6aeSJamie Lenehan
__sh_rtc_periodic(struct sh_rtc * rtc)1415e084a15SMagnus Damm static int __sh_rtc_periodic(struct sh_rtc *rtc)
142317a6104SPaul Mundt {
1435e084a15SMagnus Damm unsigned int tmp, pending;
144317a6104SPaul Mundt
145b420b1a7SAngelo Castello tmp = readb(rtc->regbase + RCR2);
1465e084a15SMagnus Damm pending = tmp & RCR2_PEF;
147b420b1a7SAngelo Castello tmp &= ~RCR2_PEF;
148b420b1a7SAngelo Castello writeb(tmp, rtc->regbase + RCR2);
149b420b1a7SAngelo Castello
1505e084a15SMagnus Damm if (!pending)
1515e084a15SMagnus Damm return 0;
1525e084a15SMagnus Damm
153b420b1a7SAngelo Castello /* Half period enabled than one skipped and the next notified */
154b420b1a7SAngelo Castello if ((rtc->periodic_freq & PF_HP) && (rtc->periodic_freq & PF_COUNT))
155b420b1a7SAngelo Castello rtc->periodic_freq &= ~PF_COUNT;
156b420b1a7SAngelo Castello else {
157b420b1a7SAngelo Castello if (rtc->periodic_freq & PF_HP)
158b420b1a7SAngelo Castello rtc->periodic_freq |= PF_COUNT;
159a361a68bSPaul Mundt rtc_update_irq(rtc->rtc_dev, 1, RTC_PF | RTC_IRQF);
160b420b1a7SAngelo Castello }
161317a6104SPaul Mundt
1625e084a15SMagnus Damm return pending;
1635e084a15SMagnus Damm }
1645e084a15SMagnus Damm
sh_rtc_interrupt(int irq,void * dev_id)1655e084a15SMagnus Damm static irqreturn_t sh_rtc_interrupt(int irq, void *dev_id)
1665e084a15SMagnus Damm {
1675e084a15SMagnus Damm struct sh_rtc *rtc = dev_id;
1685e084a15SMagnus Damm int ret;
1695e084a15SMagnus Damm
1705e084a15SMagnus Damm spin_lock(&rtc->lock);
1715e084a15SMagnus Damm ret = __sh_rtc_interrupt(rtc);
172317a6104SPaul Mundt spin_unlock(&rtc->lock);
173317a6104SPaul Mundt
1745e084a15SMagnus Damm return IRQ_RETVAL(ret);
1755e084a15SMagnus Damm }
1765e084a15SMagnus Damm
sh_rtc_alarm(int irq,void * dev_id)1775e084a15SMagnus Damm static irqreturn_t sh_rtc_alarm(int irq, void *dev_id)
1785e084a15SMagnus Damm {
1795e084a15SMagnus Damm struct sh_rtc *rtc = dev_id;
1805e084a15SMagnus Damm int ret;
1815e084a15SMagnus Damm
1825e084a15SMagnus Damm spin_lock(&rtc->lock);
1835e084a15SMagnus Damm ret = __sh_rtc_alarm(rtc);
1845e084a15SMagnus Damm spin_unlock(&rtc->lock);
1855e084a15SMagnus Damm
1865e084a15SMagnus Damm return IRQ_RETVAL(ret);
1875e084a15SMagnus Damm }
1885e084a15SMagnus Damm
sh_rtc_periodic(int irq,void * dev_id)1895e084a15SMagnus Damm static irqreturn_t sh_rtc_periodic(int irq, void *dev_id)
1905e084a15SMagnus Damm {
1915e084a15SMagnus Damm struct sh_rtc *rtc = dev_id;
1925e084a15SMagnus Damm int ret;
1935e084a15SMagnus Damm
1945e084a15SMagnus Damm spin_lock(&rtc->lock);
1955e084a15SMagnus Damm ret = __sh_rtc_periodic(rtc);
1965e084a15SMagnus Damm spin_unlock(&rtc->lock);
1975e084a15SMagnus Damm
1985e084a15SMagnus Damm return IRQ_RETVAL(ret);
1995e084a15SMagnus Damm }
2005e084a15SMagnus Damm
sh_rtc_shared(int irq,void * dev_id)2015e084a15SMagnus Damm static irqreturn_t sh_rtc_shared(int irq, void *dev_id)
2025e084a15SMagnus Damm {
2035e084a15SMagnus Damm struct sh_rtc *rtc = dev_id;
2045e084a15SMagnus Damm int ret;
2055e084a15SMagnus Damm
2065e084a15SMagnus Damm spin_lock(&rtc->lock);
2075e084a15SMagnus Damm ret = __sh_rtc_interrupt(rtc);
2085e084a15SMagnus Damm ret |= __sh_rtc_alarm(rtc);
2095e084a15SMagnus Damm ret |= __sh_rtc_periodic(rtc);
2105e084a15SMagnus Damm spin_unlock(&rtc->lock);
2115e084a15SMagnus Damm
2125e084a15SMagnus Damm return IRQ_RETVAL(ret);
213317a6104SPaul Mundt }
214317a6104SPaul Mundt
sh_rtc_setaie(struct device * dev,unsigned int enable)215317a6104SPaul Mundt static inline void sh_rtc_setaie(struct device *dev, unsigned int enable)
216317a6104SPaul Mundt {
217317a6104SPaul Mundt struct sh_rtc *rtc = dev_get_drvdata(dev);
218317a6104SPaul Mundt unsigned int tmp;
219317a6104SPaul Mundt
220317a6104SPaul Mundt spin_lock_irq(&rtc->lock);
221317a6104SPaul Mundt
222317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR1);
223317a6104SPaul Mundt
224063adc75SPaul Mundt if (enable)
2251b73e6aeSJamie Lenehan tmp |= RCR1_AIE;
226063adc75SPaul Mundt else
227063adc75SPaul Mundt tmp &= ~RCR1_AIE;
228317a6104SPaul Mundt
229317a6104SPaul Mundt writeb(tmp, rtc->regbase + RCR1);
230317a6104SPaul Mundt
231317a6104SPaul Mundt spin_unlock_irq(&rtc->lock);
232317a6104SPaul Mundt }
233317a6104SPaul Mundt
sh_rtc_proc(struct device * dev,struct seq_file * seq)234317a6104SPaul Mundt static int sh_rtc_proc(struct device *dev, struct seq_file *seq)
235317a6104SPaul Mundt {
236317a6104SPaul Mundt struct sh_rtc *rtc = dev_get_drvdata(dev);
237317a6104SPaul Mundt unsigned int tmp;
238317a6104SPaul Mundt
239317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR1);
240b420b1a7SAngelo Castello seq_printf(seq, "carry_IRQ\t: %s\n", (tmp & RCR1_CIE) ? "yes" : "no");
241317a6104SPaul Mundt
242317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR2);
243317a6104SPaul Mundt seq_printf(seq, "periodic_IRQ\t: %s\n",
244b420b1a7SAngelo Castello (tmp & RCR2_PESMASK) ? "yes" : "no");
245317a6104SPaul Mundt
246317a6104SPaul Mundt return 0;
247317a6104SPaul Mundt }
248317a6104SPaul Mundt
sh_rtc_setcie(struct device * dev,unsigned int enable)2499cd88b90SMagnus Damm static inline void sh_rtc_setcie(struct device *dev, unsigned int enable)
2509cd88b90SMagnus Damm {
2519cd88b90SMagnus Damm struct sh_rtc *rtc = dev_get_drvdata(dev);
2529cd88b90SMagnus Damm unsigned int tmp;
2539cd88b90SMagnus Damm
2549cd88b90SMagnus Damm spin_lock_irq(&rtc->lock);
2559cd88b90SMagnus Damm
2569cd88b90SMagnus Damm tmp = readb(rtc->regbase + RCR1);
2579cd88b90SMagnus Damm
2589cd88b90SMagnus Damm if (!enable)
2599cd88b90SMagnus Damm tmp &= ~RCR1_CIE;
2609cd88b90SMagnus Damm else
2619cd88b90SMagnus Damm tmp |= RCR1_CIE;
2629cd88b90SMagnus Damm
2639cd88b90SMagnus Damm writeb(tmp, rtc->regbase + RCR1);
2649cd88b90SMagnus Damm
2659cd88b90SMagnus Damm spin_unlock_irq(&rtc->lock);
2669cd88b90SMagnus Damm }
2679cd88b90SMagnus Damm
sh_rtc_alarm_irq_enable(struct device * dev,unsigned int enabled)26816380c15SJohn Stultz static int sh_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
26916380c15SJohn Stultz {
27016380c15SJohn Stultz sh_rtc_setaie(dev, enabled);
27116380c15SJohn Stultz return 0;
27216380c15SJohn Stultz }
27316380c15SJohn Stultz
sh_rtc_read_time(struct device * dev,struct rtc_time * tm)274317a6104SPaul Mundt static int sh_rtc_read_time(struct device *dev, struct rtc_time *tm)
275317a6104SPaul Mundt {
27685368bb9SWolfram Sang struct sh_rtc *rtc = dev_get_drvdata(dev);
277317a6104SPaul Mundt unsigned int sec128, sec2, yr, yr100, cf_bit;
278317a6104SPaul Mundt
2799852023dSAlexandre Belloni if (!(readb(rtc->regbase + RCR2) & RCR2_RTCEN))
2809852023dSAlexandre Belloni return -EINVAL;
2819852023dSAlexandre Belloni
282317a6104SPaul Mundt do {
283317a6104SPaul Mundt unsigned int tmp;
284317a6104SPaul Mundt
285317a6104SPaul Mundt spin_lock_irq(&rtc->lock);
286317a6104SPaul Mundt
287317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR1);
288317a6104SPaul Mundt tmp &= ~RCR1_CF; /* Clear CF-bit */
289317a6104SPaul Mundt tmp |= RCR1_CIE;
290317a6104SPaul Mundt writeb(tmp, rtc->regbase + RCR1);
291317a6104SPaul Mundt
292317a6104SPaul Mundt sec128 = readb(rtc->regbase + R64CNT);
293317a6104SPaul Mundt
294fe20ba70SAdrian Bunk tm->tm_sec = bcd2bin(readb(rtc->regbase + RSECCNT));
295fe20ba70SAdrian Bunk tm->tm_min = bcd2bin(readb(rtc->regbase + RMINCNT));
296fe20ba70SAdrian Bunk tm->tm_hour = bcd2bin(readb(rtc->regbase + RHRCNT));
297fe20ba70SAdrian Bunk tm->tm_wday = bcd2bin(readb(rtc->regbase + RWKCNT));
298fe20ba70SAdrian Bunk tm->tm_mday = bcd2bin(readb(rtc->regbase + RDAYCNT));
299fe20ba70SAdrian Bunk tm->tm_mon = bcd2bin(readb(rtc->regbase + RMONCNT)) - 1;
300317a6104SPaul Mundt
301ad89f87aSPaul Mundt if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
302317a6104SPaul Mundt yr = readw(rtc->regbase + RYRCNT);
303fe20ba70SAdrian Bunk yr100 = bcd2bin(yr >> 8);
304317a6104SPaul Mundt yr &= 0xff;
305ad89f87aSPaul Mundt } else {
306317a6104SPaul Mundt yr = readb(rtc->regbase + RYRCNT);
307fe20ba70SAdrian Bunk yr100 = bcd2bin((yr == 0x99) ? 0x19 : 0x20);
308ad89f87aSPaul Mundt }
309317a6104SPaul Mundt
310fe20ba70SAdrian Bunk tm->tm_year = (yr100 * 100 + bcd2bin(yr)) - 1900;
311317a6104SPaul Mundt
312317a6104SPaul Mundt sec2 = readb(rtc->regbase + R64CNT);
313317a6104SPaul Mundt cf_bit = readb(rtc->regbase + RCR1) & RCR1_CF;
314317a6104SPaul Mundt
315317a6104SPaul Mundt spin_unlock_irq(&rtc->lock);
316317a6104SPaul Mundt } while (cf_bit != 0 || ((sec128 ^ sec2) & RTC_BIT_INVERTED) != 0);
317317a6104SPaul Mundt
318317a6104SPaul Mundt #if RTC_BIT_INVERTED != 0
319317a6104SPaul Mundt if ((sec128 & RTC_BIT_INVERTED))
320317a6104SPaul Mundt tm->tm_sec--;
321317a6104SPaul Mundt #endif
322317a6104SPaul Mundt
3239cd88b90SMagnus Damm /* only keep the carry interrupt enabled if UIE is on */
3249cd88b90SMagnus Damm if (!(rtc->periodic_freq & PF_OXS))
3259cd88b90SMagnus Damm sh_rtc_setcie(dev, 0);
3269cd88b90SMagnus Damm
327435c55d1SPaul Mundt dev_dbg(dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
328317a6104SPaul Mundt "mday=%d, mon=%d, year=%d, wday=%d\n",
3292a4e2b87SHarvey Harrison __func__,
330317a6104SPaul Mundt tm->tm_sec, tm->tm_min, tm->tm_hour,
331a1614796SJamie Lenehan tm->tm_mday, tm->tm_mon + 1, tm->tm_year, tm->tm_wday);
332317a6104SPaul Mundt
33322652ba7SAlexandre Belloni return 0;
334317a6104SPaul Mundt }
335317a6104SPaul Mundt
sh_rtc_set_time(struct device * dev,struct rtc_time * tm)336317a6104SPaul Mundt static int sh_rtc_set_time(struct device *dev, struct rtc_time *tm)
337317a6104SPaul Mundt {
33885368bb9SWolfram Sang struct sh_rtc *rtc = dev_get_drvdata(dev);
339317a6104SPaul Mundt unsigned int tmp;
340317a6104SPaul Mundt int year;
341317a6104SPaul Mundt
342317a6104SPaul Mundt spin_lock_irq(&rtc->lock);
343317a6104SPaul Mundt
344317a6104SPaul Mundt /* Reset pre-scaler & stop RTC */
345317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR2);
346317a6104SPaul Mundt tmp |= RCR2_RESET;
347699bc661SMarkus Brunner tmp &= ~RCR2_START;
348317a6104SPaul Mundt writeb(tmp, rtc->regbase + RCR2);
349317a6104SPaul Mundt
350fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_sec), rtc->regbase + RSECCNT);
351fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_min), rtc->regbase + RMINCNT);
352fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_hour), rtc->regbase + RHRCNT);
353fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_wday), rtc->regbase + RWKCNT);
354fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_mday), rtc->regbase + RDAYCNT);
355fe20ba70SAdrian Bunk writeb(bin2bcd(tm->tm_mon + 1), rtc->regbase + RMONCNT);
356317a6104SPaul Mundt
357ad89f87aSPaul Mundt if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
358fe20ba70SAdrian Bunk year = (bin2bcd((tm->tm_year + 1900) / 100) << 8) |
359fe20ba70SAdrian Bunk bin2bcd(tm->tm_year % 100);
360317a6104SPaul Mundt writew(year, rtc->regbase + RYRCNT);
361ad89f87aSPaul Mundt } else {
362ad89f87aSPaul Mundt year = tm->tm_year % 100;
363fe20ba70SAdrian Bunk writeb(bin2bcd(year), rtc->regbase + RYRCNT);
364ad89f87aSPaul Mundt }
365317a6104SPaul Mundt
366317a6104SPaul Mundt /* Start RTC */
367317a6104SPaul Mundt tmp = readb(rtc->regbase + RCR2);
368317a6104SPaul Mundt tmp &= ~RCR2_RESET;
369317a6104SPaul Mundt tmp |= RCR2_RTCEN | RCR2_START;
370317a6104SPaul Mundt writeb(tmp, rtc->regbase + RCR2);
371317a6104SPaul Mundt
372317a6104SPaul Mundt spin_unlock_irq(&rtc->lock);
373317a6104SPaul Mundt
374317a6104SPaul Mundt return 0;
375317a6104SPaul Mundt }
376317a6104SPaul Mundt
sh_rtc_read_alarm_value(struct sh_rtc * rtc,int reg_off)3771b73e6aeSJamie Lenehan static inline int sh_rtc_read_alarm_value(struct sh_rtc *rtc, int reg_off)
3781b73e6aeSJamie Lenehan {
3791b73e6aeSJamie Lenehan unsigned int byte;
38015d82d22SGeert Uytterhoeven int value = -1; /* return -1 for ignored values */
3811b73e6aeSJamie Lenehan
3821b73e6aeSJamie Lenehan byte = readb(rtc->regbase + reg_off);
3831b73e6aeSJamie Lenehan if (byte & AR_ENB) {
3841b73e6aeSJamie Lenehan byte &= ~AR_ENB; /* strip the enable bit */
385fe20ba70SAdrian Bunk value = bcd2bin(byte);
3861b73e6aeSJamie Lenehan }
3871b73e6aeSJamie Lenehan
3881b73e6aeSJamie Lenehan return value;
3891b73e6aeSJamie Lenehan }
3901b73e6aeSJamie Lenehan
sh_rtc_read_alarm(struct device * dev,struct rtc_wkalrm * wkalrm)3911b73e6aeSJamie Lenehan static int sh_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
3921b73e6aeSJamie Lenehan {
39385368bb9SWolfram Sang struct sh_rtc *rtc = dev_get_drvdata(dev);
3941b73e6aeSJamie Lenehan struct rtc_time *tm = &wkalrm->time;
3951b73e6aeSJamie Lenehan
3961b73e6aeSJamie Lenehan spin_lock_irq(&rtc->lock);
3971b73e6aeSJamie Lenehan
3981b73e6aeSJamie Lenehan tm->tm_sec = sh_rtc_read_alarm_value(rtc, RSECAR);
3991b73e6aeSJamie Lenehan tm->tm_min = sh_rtc_read_alarm_value(rtc, RMINAR);
4001b73e6aeSJamie Lenehan tm->tm_hour = sh_rtc_read_alarm_value(rtc, RHRAR);
4011b73e6aeSJamie Lenehan tm->tm_wday = sh_rtc_read_alarm_value(rtc, RWKAR);
4021b73e6aeSJamie Lenehan tm->tm_mday = sh_rtc_read_alarm_value(rtc, RDAYAR);
4031b73e6aeSJamie Lenehan tm->tm_mon = sh_rtc_read_alarm_value(rtc, RMONAR);
4041b73e6aeSJamie Lenehan if (tm->tm_mon > 0)
4051b73e6aeSJamie Lenehan tm->tm_mon -= 1; /* RTC is 1-12, tm_mon is 0-11 */
4061b73e6aeSJamie Lenehan
4070d103e90SDavid Brownell wkalrm->enabled = (readb(rtc->regbase + RCR1) & RCR1_AIE) ? 1 : 0;
4080d103e90SDavid Brownell
4091b73e6aeSJamie Lenehan spin_unlock_irq(&rtc->lock);
4101b73e6aeSJamie Lenehan
4111b73e6aeSJamie Lenehan return 0;
4121b73e6aeSJamie Lenehan }
4131b73e6aeSJamie Lenehan
sh_rtc_write_alarm_value(struct sh_rtc * rtc,int value,int reg_off)4141b73e6aeSJamie Lenehan static inline void sh_rtc_write_alarm_value(struct sh_rtc *rtc,
4151b73e6aeSJamie Lenehan int value, int reg_off)
4161b73e6aeSJamie Lenehan {
4171b73e6aeSJamie Lenehan /* < 0 for a value that is ignored */
4181b73e6aeSJamie Lenehan if (value < 0)
4191b73e6aeSJamie Lenehan writeb(0, rtc->regbase + reg_off);
4201b73e6aeSJamie Lenehan else
421fe20ba70SAdrian Bunk writeb(bin2bcd(value) | AR_ENB, rtc->regbase + reg_off);
4221b73e6aeSJamie Lenehan }
4231b73e6aeSJamie Lenehan
sh_rtc_set_alarm(struct device * dev,struct rtc_wkalrm * wkalrm)4241b73e6aeSJamie Lenehan static int sh_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
4251b73e6aeSJamie Lenehan {
42685368bb9SWolfram Sang struct sh_rtc *rtc = dev_get_drvdata(dev);
4271b73e6aeSJamie Lenehan unsigned int rcr1;
4281b73e6aeSJamie Lenehan struct rtc_time *tm = &wkalrm->time;
4298441189eSUwe Kleine-König int mon;
4301b73e6aeSJamie Lenehan
4311b73e6aeSJamie Lenehan spin_lock_irq(&rtc->lock);
4321b73e6aeSJamie Lenehan
43315c945c3SJamie Lenehan /* disable alarm interrupt and clear the alarm flag */
4341b73e6aeSJamie Lenehan rcr1 = readb(rtc->regbase + RCR1);
43515c945c3SJamie Lenehan rcr1 &= ~(RCR1_AF | RCR1_AIE);
43615c945c3SJamie Lenehan writeb(rcr1, rtc->regbase + RCR1);
4371b73e6aeSJamie Lenehan
4381b73e6aeSJamie Lenehan /* set alarm time */
4391b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, tm->tm_sec, RSECAR);
4401b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, tm->tm_min, RMINAR);
4411b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, tm->tm_hour, RHRAR);
4421b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, tm->tm_wday, RWKAR);
4431b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, tm->tm_mday, RDAYAR);
4441b73e6aeSJamie Lenehan mon = tm->tm_mon;
4451b73e6aeSJamie Lenehan if (mon >= 0)
4461b73e6aeSJamie Lenehan mon += 1;
4471b73e6aeSJamie Lenehan sh_rtc_write_alarm_value(rtc, mon, RMONAR);
4481b73e6aeSJamie Lenehan
44915c945c3SJamie Lenehan if (wkalrm->enabled) {
45015c945c3SJamie Lenehan rcr1 |= RCR1_AIE;
4511b73e6aeSJamie Lenehan writeb(rcr1, rtc->regbase + RCR1);
45215c945c3SJamie Lenehan }
4531b73e6aeSJamie Lenehan
4541b73e6aeSJamie Lenehan spin_unlock_irq(&rtc->lock);
4551b73e6aeSJamie Lenehan
4561b73e6aeSJamie Lenehan return 0;
4571b73e6aeSJamie Lenehan }
4581b73e6aeSJamie Lenehan
4598bc57e7fSBhumika Goyal static const struct rtc_class_ops sh_rtc_ops = {
460317a6104SPaul Mundt .read_time = sh_rtc_read_time,
461317a6104SPaul Mundt .set_time = sh_rtc_set_time,
4621b73e6aeSJamie Lenehan .read_alarm = sh_rtc_read_alarm,
4631b73e6aeSJamie Lenehan .set_alarm = sh_rtc_set_alarm,
464317a6104SPaul Mundt .proc = sh_rtc_proc,
46516380c15SJohn Stultz .alarm_irq_enable = sh_rtc_alarm_irq_enable,
466317a6104SPaul Mundt };
467317a6104SPaul Mundt
sh_rtc_probe(struct platform_device * pdev)4685c9740a8SAlessandro Zummo static int __init sh_rtc_probe(struct platform_device *pdev)
469317a6104SPaul Mundt {
470317a6104SPaul Mundt struct sh_rtc *rtc;
471317a6104SPaul Mundt struct resource *res;
472063adc75SPaul Mundt char clk_name[6];
473063adc75SPaul Mundt int clk_id, ret;
474317a6104SPaul Mundt
4750209affaSJingoo Han rtc = devm_kzalloc(&pdev->dev, sizeof(*rtc), GFP_KERNEL);
476317a6104SPaul Mundt if (unlikely(!rtc))
477317a6104SPaul Mundt return -ENOMEM;
478317a6104SPaul Mundt
479317a6104SPaul Mundt spin_lock_init(&rtc->lock);
480317a6104SPaul Mundt
481b420b1a7SAngelo Castello /* get periodic/carry/alarm irqs */
4822641dc92Sroel kluin ret = platform_get_irq(pdev, 0);
4832fac6674SAnton Vorontsov if (unlikely(ret <= 0)) {
4845e084a15SMagnus Damm dev_err(&pdev->dev, "No IRQ resource\n");
4850209affaSJingoo Han return -ENOENT;
486317a6104SPaul Mundt }
487063adc75SPaul Mundt
4882641dc92Sroel kluin rtc->periodic_irq = ret;
4895e084a15SMagnus Damm rtc->carry_irq = platform_get_irq(pdev, 1);
4905e084a15SMagnus Damm rtc->alarm_irq = platform_get_irq(pdev, 2);
491317a6104SPaul Mundt
492317a6104SPaul Mundt res = platform_get_resource(pdev, IORESOURCE_IO, 0);
493dab5aec6SChris Brandt if (!res)
494dab5aec6SChris Brandt res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
495317a6104SPaul Mundt if (unlikely(res == NULL)) {
496317a6104SPaul Mundt dev_err(&pdev->dev, "No IO resource\n");
4970209affaSJingoo Han return -ENOENT;
498317a6104SPaul Mundt }
499317a6104SPaul Mundt
500063adc75SPaul Mundt rtc->regsize = resource_size(res);
501317a6104SPaul Mundt
5020209affaSJingoo Han rtc->res = devm_request_mem_region(&pdev->dev, res->start,
5030209affaSJingoo Han rtc->regsize, pdev->name);
5040209affaSJingoo Han if (unlikely(!rtc->res))
5050209affaSJingoo Han return -EBUSY;
506317a6104SPaul Mundt
50738a49742SGeert Uytterhoeven rtc->regbase = devm_ioremap(&pdev->dev, rtc->res->start, rtc->regsize);
5080209affaSJingoo Han if (unlikely(!rtc->regbase))
5090209affaSJingoo Han return -EINVAL;
510317a6104SPaul Mundt
511dab5aec6SChris Brandt if (!pdev->dev.of_node) {
512063adc75SPaul Mundt clk_id = pdev->id;
513063adc75SPaul Mundt /* With a single device, the clock id is still "rtc0" */
514063adc75SPaul Mundt if (clk_id < 0)
515063adc75SPaul Mundt clk_id = 0;
516063adc75SPaul Mundt
517063adc75SPaul Mundt snprintf(clk_name, sizeof(clk_name), "rtc%d", clk_id);
518dab5aec6SChris Brandt } else
519dab5aec6SChris Brandt snprintf(clk_name, sizeof(clk_name), "fck");
520063adc75SPaul Mundt
5210209affaSJingoo Han rtc->clk = devm_clk_get(&pdev->dev, clk_name);
522063adc75SPaul Mundt if (IS_ERR(rtc->clk)) {
523063adc75SPaul Mundt /*
524063adc75SPaul Mundt * No error handling for rtc->clk intentionally, not all
525063adc75SPaul Mundt * platforms will have a unique clock for the RTC, and
526063adc75SPaul Mundt * the clk API can handle the struct clk pointer being
527063adc75SPaul Mundt * NULL.
528063adc75SPaul Mundt */
529063adc75SPaul Mundt rtc->clk = NULL;
530063adc75SPaul Mundt }
531063adc75SPaul Mundt
5321097998dSAlexandre Belloni rtc->rtc_dev = devm_rtc_allocate_device(&pdev->dev);
5331097998dSAlexandre Belloni if (IS_ERR(rtc->rtc_dev))
5341097998dSAlexandre Belloni return PTR_ERR(rtc->rtc_dev);
5351097998dSAlexandre Belloni
536063adc75SPaul Mundt clk_enable(rtc->clk);
537063adc75SPaul Mundt
538ad89f87aSPaul Mundt rtc->capabilities = RTC_DEF_CAPABILITIES;
539dab5aec6SChris Brandt
540dab5aec6SChris Brandt #ifdef CONFIG_SUPERH
541e58c18d4SJingoo Han if (dev_get_platdata(&pdev->dev)) {
542e58c18d4SJingoo Han struct sh_rtc_platform_info *pinfo =
543e58c18d4SJingoo Han dev_get_platdata(&pdev->dev);
544ad89f87aSPaul Mundt
545ad89f87aSPaul Mundt /*
546ad89f87aSPaul Mundt * Some CPUs have special capabilities in addition to the
547ad89f87aSPaul Mundt * default set. Add those in here.
548ad89f87aSPaul Mundt */
549ad89f87aSPaul Mundt rtc->capabilities |= pinfo->capabilities;
550ad89f87aSPaul Mundt }
551dab5aec6SChris Brandt #endif
552ad89f87aSPaul Mundt
5535e084a15SMagnus Damm if (rtc->carry_irq <= 0) {
5545e084a15SMagnus Damm /* register shared periodic/carry/alarm irq */
5550209affaSJingoo Han ret = devm_request_irq(&pdev->dev, rtc->periodic_irq,
5560209affaSJingoo Han sh_rtc_shared, 0, "sh-rtc", rtc);
557b420b1a7SAngelo Castello if (unlikely(ret)) {
558b420b1a7SAngelo Castello dev_err(&pdev->dev,
5595e084a15SMagnus Damm "request IRQ failed with %d, IRQ %d\n", ret,
560b420b1a7SAngelo Castello rtc->periodic_irq);
5610305794cSPaul Mundt goto err_unmap;
562b420b1a7SAngelo Castello }
5635e084a15SMagnus Damm } else {
5645e084a15SMagnus Damm /* register periodic/carry/alarm irqs */
5650209affaSJingoo Han ret = devm_request_irq(&pdev->dev, rtc->periodic_irq,
5660209affaSJingoo Han sh_rtc_periodic, 0, "sh-rtc period", rtc);
567b420b1a7SAngelo Castello if (unlikely(ret)) {
568b420b1a7SAngelo Castello dev_err(&pdev->dev,
5695e084a15SMagnus Damm "request period IRQ failed with %d, IRQ %d\n",
5705e084a15SMagnus Damm ret, rtc->periodic_irq);
5715e084a15SMagnus Damm goto err_unmap;
5725e084a15SMagnus Damm }
5735e084a15SMagnus Damm
5740209affaSJingoo Han ret = devm_request_irq(&pdev->dev, rtc->carry_irq,
5750209affaSJingoo Han sh_rtc_interrupt, 0, "sh-rtc carry", rtc);
5765e084a15SMagnus Damm if (unlikely(ret)) {
5775e084a15SMagnus Damm dev_err(&pdev->dev,
5785e084a15SMagnus Damm "request carry IRQ failed with %d, IRQ %d\n",
5795e084a15SMagnus Damm ret, rtc->carry_irq);
5800305794cSPaul Mundt goto err_unmap;
581b420b1a7SAngelo Castello }
582b420b1a7SAngelo Castello
5830209affaSJingoo Han ret = devm_request_irq(&pdev->dev, rtc->alarm_irq,
5840209affaSJingoo Han sh_rtc_alarm, 0, "sh-rtc alarm", rtc);
585b420b1a7SAngelo Castello if (unlikely(ret)) {
586b420b1a7SAngelo Castello dev_err(&pdev->dev,
5875e084a15SMagnus Damm "request alarm IRQ failed with %d, IRQ %d\n",
5885e084a15SMagnus Damm ret, rtc->alarm_irq);
5890305794cSPaul Mundt goto err_unmap;
590b420b1a7SAngelo Castello }
5915e084a15SMagnus Damm }
592b420b1a7SAngelo Castello
5935c9740a8SAlessandro Zummo platform_set_drvdata(pdev, rtc);
5945c9740a8SAlessandro Zummo
5959cd88b90SMagnus Damm /* everything disabled by default */
5969cd88b90SMagnus Damm sh_rtc_setaie(&pdev->dev, 0);
5979cd88b90SMagnus Damm sh_rtc_setcie(&pdev->dev, 0);
598edf22477SMagnus Damm
5991097998dSAlexandre Belloni rtc->rtc_dev->ops = &sh_rtc_ops;
6005c9740a8SAlessandro Zummo rtc->rtc_dev->max_user_freq = 256;
6015c9740a8SAlessandro Zummo
602beee05dfSAlexandre Belloni if (rtc->capabilities & RTC_CAP_4_DIGIT_YEAR) {
603beee05dfSAlexandre Belloni rtc->rtc_dev->range_min = RTC_TIMESTAMP_BEGIN_1900;
604beee05dfSAlexandre Belloni rtc->rtc_dev->range_max = RTC_TIMESTAMP_END_9999;
605beee05dfSAlexandre Belloni } else {
606beee05dfSAlexandre Belloni rtc->rtc_dev->range_min = mktime64(1999, 1, 1, 0, 0, 0);
607beee05dfSAlexandre Belloni rtc->rtc_dev->range_max = mktime64(2098, 12, 31, 23, 59, 59);
608edf22477SMagnus Damm }
609edf22477SMagnus Damm
610*fdcfd854SBartosz Golaszewski ret = devm_rtc_register_device(rtc->rtc_dev);
6111097998dSAlexandre Belloni if (ret)
6121097998dSAlexandre Belloni goto err_unmap;
6131097998dSAlexandre Belloni
6147a8fe8e3SMagnus Damm device_init_wakeup(&pdev->dev, 1);
615317a6104SPaul Mundt return 0;
616317a6104SPaul Mundt
6170305794cSPaul Mundt err_unmap:
618063adc75SPaul Mundt clk_disable(rtc->clk);
619317a6104SPaul Mundt
620317a6104SPaul Mundt return ret;
621317a6104SPaul Mundt }
622317a6104SPaul Mundt
sh_rtc_remove(struct platform_device * pdev)6235c9740a8SAlessandro Zummo static int __exit sh_rtc_remove(struct platform_device *pdev)
624317a6104SPaul Mundt {
625317a6104SPaul Mundt struct sh_rtc *rtc = platform_get_drvdata(pdev);
626317a6104SPaul Mundt
627317a6104SPaul Mundt sh_rtc_setaie(&pdev->dev, 0);
6289cd88b90SMagnus Damm sh_rtc_setcie(&pdev->dev, 0);
629317a6104SPaul Mundt
630063adc75SPaul Mundt clk_disable(rtc->clk);
631317a6104SPaul Mundt
632317a6104SPaul Mundt return 0;
633317a6104SPaul Mundt }
634faa9fa8eSMagnus Damm
sh_rtc_set_irq_wake(struct device * dev,int enabled)635faa9fa8eSMagnus Damm static void sh_rtc_set_irq_wake(struct device *dev, int enabled)
636faa9fa8eSMagnus Damm {
63785368bb9SWolfram Sang struct sh_rtc *rtc = dev_get_drvdata(dev);
638faa9fa8eSMagnus Damm
639dced35aeSThomas Gleixner irq_set_irq_wake(rtc->periodic_irq, enabled);
640063adc75SPaul Mundt
641faa9fa8eSMagnus Damm if (rtc->carry_irq > 0) {
642dced35aeSThomas Gleixner irq_set_irq_wake(rtc->carry_irq, enabled);
643dced35aeSThomas Gleixner irq_set_irq_wake(rtc->alarm_irq, enabled);
644faa9fa8eSMagnus Damm }
645faa9fa8eSMagnus Damm }
646faa9fa8eSMagnus Damm
sh_rtc_suspend(struct device * dev)6475d05e815SArnd Bergmann static int __maybe_unused sh_rtc_suspend(struct device *dev)
648faa9fa8eSMagnus Damm {
649faa9fa8eSMagnus Damm if (device_may_wakeup(dev))
650faa9fa8eSMagnus Damm sh_rtc_set_irq_wake(dev, 1);
651faa9fa8eSMagnus Damm
652faa9fa8eSMagnus Damm return 0;
653faa9fa8eSMagnus Damm }
654faa9fa8eSMagnus Damm
sh_rtc_resume(struct device * dev)6555d05e815SArnd Bergmann static int __maybe_unused sh_rtc_resume(struct device *dev)
656faa9fa8eSMagnus Damm {
657faa9fa8eSMagnus Damm if (device_may_wakeup(dev))
658faa9fa8eSMagnus Damm sh_rtc_set_irq_wake(dev, 0);
659faa9fa8eSMagnus Damm
660faa9fa8eSMagnus Damm return 0;
661faa9fa8eSMagnus Damm }
662faa9fa8eSMagnus Damm
6630ed50544SJingoo Han static SIMPLE_DEV_PM_OPS(sh_rtc_pm_ops, sh_rtc_suspend, sh_rtc_resume);
664faa9fa8eSMagnus Damm
665dab5aec6SChris Brandt static const struct of_device_id sh_rtc_of_match[] = {
666dab5aec6SChris Brandt { .compatible = "renesas,sh-rtc", },
667dab5aec6SChris Brandt { /* sentinel */ }
668dab5aec6SChris Brandt };
669dab5aec6SChris Brandt MODULE_DEVICE_TABLE(of, sh_rtc_of_match);
670dab5aec6SChris Brandt
671317a6104SPaul Mundt static struct platform_driver sh_rtc_platform_driver = {
672317a6104SPaul Mundt .driver = {
6731b73e6aeSJamie Lenehan .name = DRV_NAME,
6740ed50544SJingoo Han .pm = &sh_rtc_pm_ops,
675dab5aec6SChris Brandt .of_match_table = sh_rtc_of_match,
676317a6104SPaul Mundt },
6775c9740a8SAlessandro Zummo .remove = __exit_p(sh_rtc_remove),
678317a6104SPaul Mundt };
679317a6104SPaul Mundt
680deed5a9dSJingoo Han module_platform_driver_probe(sh_rtc_platform_driver, sh_rtc_probe);
681317a6104SPaul Mundt
682317a6104SPaul Mundt MODULE_DESCRIPTION("SuperH on-chip RTC driver");
683b420b1a7SAngelo Castello MODULE_AUTHOR("Paul Mundt <lethal@linux-sh.org>, "
684b420b1a7SAngelo Castello "Jamie Lenehan <lenehan@twibble.org>, "
685b420b1a7SAngelo Castello "Angelo Castello <angelo.castello@st.com>");
6864ff6f024SKuninori Morimoto MODULE_LICENSE("GPL v2");
687ad28a07bSKay Sievers MODULE_ALIAS("platform:" DRV_NAME);
688