1 /*
2 * Real Time Clock interface for XScale PXA27x and PXA3xx
3 *
4 * Copyright (C) 2008 Robert Jarzmik
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21
22 #include <linux/init.h>
23 #include <linux/platform_device.h>
24 #include <linux/module.h>
25 #include <linux/rtc.h>
26 #include <linux/seq_file.h>
27 #include <linux/interrupt.h>
28 #include <linux/io.h>
29 #include <linux/slab.h>
30 #include <linux/of.h>
31 #include <linux/of_device.h>
32
33 #include <mach/hardware.h>
34
35 #include "rtc-sa1100.h"
36
37 #define RTC_DEF_DIVIDER (32768 - 1)
38 #define RTC_DEF_TRIM 0
39 #define MAXFREQ_PERIODIC 1000
40
41 /*
42 * PXA Registers and bits definitions
43 */
44 #define RTSR_PICE (1 << 15) /* Periodic interrupt count enable */
45 #define RTSR_PIALE (1 << 14) /* Periodic interrupt Alarm enable */
46 #define RTSR_PIAL (1 << 13) /* Periodic interrupt detected */
47 #define RTSR_SWALE2 (1 << 11) /* RTC stopwatch alarm2 enable */
48 #define RTSR_SWAL2 (1 << 10) /* RTC stopwatch alarm2 detected */
49 #define RTSR_SWALE1 (1 << 9) /* RTC stopwatch alarm1 enable */
50 #define RTSR_SWAL1 (1 << 8) /* RTC stopwatch alarm1 detected */
51 #define RTSR_RDALE2 (1 << 7) /* RTC alarm2 enable */
52 #define RTSR_RDAL2 (1 << 6) /* RTC alarm2 detected */
53 #define RTSR_RDALE1 (1 << 5) /* RTC alarm1 enable */
54 #define RTSR_RDAL1 (1 << 4) /* RTC alarm1 detected */
55 #define RTSR_HZE (1 << 3) /* HZ interrupt enable */
56 #define RTSR_ALE (1 << 2) /* RTC alarm interrupt enable */
57 #define RTSR_HZ (1 << 1) /* HZ rising-edge detected */
58 #define RTSR_AL (1 << 0) /* RTC alarm detected */
59 #define RTSR_TRIG_MASK (RTSR_AL | RTSR_HZ | RTSR_RDAL1 | RTSR_RDAL2\
60 | RTSR_SWAL1 | RTSR_SWAL2)
61 #define RYxR_YEAR_S 9
62 #define RYxR_YEAR_MASK (0xfff << RYxR_YEAR_S)
63 #define RYxR_MONTH_S 5
64 #define RYxR_MONTH_MASK (0xf << RYxR_MONTH_S)
65 #define RYxR_DAY_MASK 0x1f
66 #define RDxR_WOM_S 20
67 #define RDxR_WOM_MASK (0x7 << RDxR_WOM_S)
68 #define RDxR_DOW_S 17
69 #define RDxR_DOW_MASK (0x7 << RDxR_DOW_S)
70 #define RDxR_HOUR_S 12
71 #define RDxR_HOUR_MASK (0x1f << RDxR_HOUR_S)
72 #define RDxR_MIN_S 6
73 #define RDxR_MIN_MASK (0x3f << RDxR_MIN_S)
74 #define RDxR_SEC_MASK 0x3f
75
76 #define RTSR 0x08
77 #define RTTR 0x0c
78 #define RDCR 0x10
79 #define RYCR 0x14
80 #define RDAR1 0x18
81 #define RYAR1 0x1c
82 #define RTCPICR 0x34
83 #define PIAR 0x38
84
85 #define rtc_readl(pxa_rtc, reg) \
86 __raw_readl((pxa_rtc)->base + (reg))
87 #define rtc_writel(pxa_rtc, reg, value) \
88 __raw_writel((value), (pxa_rtc)->base + (reg))
89
90 struct pxa_rtc {
91 struct sa1100_rtc sa1100_rtc;
92 struct resource *ress;
93 void __iomem *base;
94 struct rtc_device *rtc;
95 spinlock_t lock; /* Protects this structure */
96 };
97
98
ryxr_calc(struct rtc_time * tm)99 static u32 ryxr_calc(struct rtc_time *tm)
100 {
101 return ((tm->tm_year + 1900) << RYxR_YEAR_S)
102 | ((tm->tm_mon + 1) << RYxR_MONTH_S)
103 | tm->tm_mday;
104 }
105
rdxr_calc(struct rtc_time * tm)106 static u32 rdxr_calc(struct rtc_time *tm)
107 {
108 return ((((tm->tm_mday + 6) / 7) << RDxR_WOM_S) & RDxR_WOM_MASK)
109 | (((tm->tm_wday + 1) << RDxR_DOW_S) & RDxR_DOW_MASK)
110 | (tm->tm_hour << RDxR_HOUR_S)
111 | (tm->tm_min << RDxR_MIN_S)
112 | tm->tm_sec;
113 }
114
tm_calc(u32 rycr,u32 rdcr,struct rtc_time * tm)115 static void tm_calc(u32 rycr, u32 rdcr, struct rtc_time *tm)
116 {
117 tm->tm_year = ((rycr & RYxR_YEAR_MASK) >> RYxR_YEAR_S) - 1900;
118 tm->tm_mon = (((rycr & RYxR_MONTH_MASK) >> RYxR_MONTH_S)) - 1;
119 tm->tm_mday = (rycr & RYxR_DAY_MASK);
120 tm->tm_wday = ((rycr & RDxR_DOW_MASK) >> RDxR_DOW_S) - 1;
121 tm->tm_hour = (rdcr & RDxR_HOUR_MASK) >> RDxR_HOUR_S;
122 tm->tm_min = (rdcr & RDxR_MIN_MASK) >> RDxR_MIN_S;
123 tm->tm_sec = rdcr & RDxR_SEC_MASK;
124 }
125
rtsr_clear_bits(struct pxa_rtc * pxa_rtc,u32 mask)126 static void rtsr_clear_bits(struct pxa_rtc *pxa_rtc, u32 mask)
127 {
128 u32 rtsr;
129
130 rtsr = rtc_readl(pxa_rtc, RTSR);
131 rtsr &= ~RTSR_TRIG_MASK;
132 rtsr &= ~mask;
133 rtc_writel(pxa_rtc, RTSR, rtsr);
134 }
135
rtsr_set_bits(struct pxa_rtc * pxa_rtc,u32 mask)136 static void rtsr_set_bits(struct pxa_rtc *pxa_rtc, u32 mask)
137 {
138 u32 rtsr;
139
140 rtsr = rtc_readl(pxa_rtc, RTSR);
141 rtsr &= ~RTSR_TRIG_MASK;
142 rtsr |= mask;
143 rtc_writel(pxa_rtc, RTSR, rtsr);
144 }
145
pxa_rtc_irq(int irq,void * dev_id)146 static irqreturn_t pxa_rtc_irq(int irq, void *dev_id)
147 {
148 struct platform_device *pdev = to_platform_device(dev_id);
149 struct pxa_rtc *pxa_rtc = platform_get_drvdata(pdev);
150 u32 rtsr;
151 unsigned long events = 0;
152
153 spin_lock(&pxa_rtc->lock);
154
155 /* clear interrupt sources */
156 rtsr = rtc_readl(pxa_rtc, RTSR);
157 rtc_writel(pxa_rtc, RTSR, rtsr);
158
159 /* temporary disable rtc interrupts */
160 rtsr_clear_bits(pxa_rtc, RTSR_RDALE1 | RTSR_PIALE | RTSR_HZE);
161
162 /* clear alarm interrupt if it has occurred */
163 if (rtsr & RTSR_RDAL1)
164 rtsr &= ~RTSR_RDALE1;
165
166 /* update irq data & counter */
167 if (rtsr & RTSR_RDAL1)
168 events |= RTC_AF | RTC_IRQF;
169 if (rtsr & RTSR_HZ)
170 events |= RTC_UF | RTC_IRQF;
171 if (rtsr & RTSR_PIAL)
172 events |= RTC_PF | RTC_IRQF;
173
174 rtc_update_irq(pxa_rtc->rtc, 1, events);
175
176 /* enable back rtc interrupts */
177 rtc_writel(pxa_rtc, RTSR, rtsr & ~RTSR_TRIG_MASK);
178
179 spin_unlock(&pxa_rtc->lock);
180 return IRQ_HANDLED;
181 }
182
pxa_rtc_open(struct device * dev)183 static int pxa_rtc_open(struct device *dev)
184 {
185 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
186 int ret;
187
188 ret = request_irq(pxa_rtc->sa1100_rtc.irq_1hz, pxa_rtc_irq, 0,
189 "rtc 1Hz", dev);
190 if (ret < 0) {
191 dev_err(dev, "can't get irq %i, err %d\n",
192 pxa_rtc->sa1100_rtc.irq_1hz, ret);
193 goto err_irq_1Hz;
194 }
195 ret = request_irq(pxa_rtc->sa1100_rtc.irq_alarm, pxa_rtc_irq, 0,
196 "rtc Alrm", dev);
197 if (ret < 0) {
198 dev_err(dev, "can't get irq %i, err %d\n",
199 pxa_rtc->sa1100_rtc.irq_alarm, ret);
200 goto err_irq_Alrm;
201 }
202
203 return 0;
204
205 err_irq_Alrm:
206 free_irq(pxa_rtc->sa1100_rtc.irq_1hz, dev);
207 err_irq_1Hz:
208 return ret;
209 }
210
pxa_rtc_release(struct device * dev)211 static void pxa_rtc_release(struct device *dev)
212 {
213 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
214
215 spin_lock_irq(&pxa_rtc->lock);
216 rtsr_clear_bits(pxa_rtc, RTSR_PIALE | RTSR_RDALE1 | RTSR_HZE);
217 spin_unlock_irq(&pxa_rtc->lock);
218
219 free_irq(pxa_rtc->sa1100_rtc.irq_1hz, dev);
220 free_irq(pxa_rtc->sa1100_rtc.irq_alarm, dev);
221 }
222
pxa_alarm_irq_enable(struct device * dev,unsigned int enabled)223 static int pxa_alarm_irq_enable(struct device *dev, unsigned int enabled)
224 {
225 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
226
227 spin_lock_irq(&pxa_rtc->lock);
228
229 if (enabled)
230 rtsr_set_bits(pxa_rtc, RTSR_RDALE1);
231 else
232 rtsr_clear_bits(pxa_rtc, RTSR_RDALE1);
233
234 spin_unlock_irq(&pxa_rtc->lock);
235 return 0;
236 }
237
pxa_rtc_read_time(struct device * dev,struct rtc_time * tm)238 static int pxa_rtc_read_time(struct device *dev, struct rtc_time *tm)
239 {
240 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
241 u32 rycr, rdcr;
242
243 rycr = rtc_readl(pxa_rtc, RYCR);
244 rdcr = rtc_readl(pxa_rtc, RDCR);
245
246 tm_calc(rycr, rdcr, tm);
247 return 0;
248 }
249
pxa_rtc_set_time(struct device * dev,struct rtc_time * tm)250 static int pxa_rtc_set_time(struct device *dev, struct rtc_time *tm)
251 {
252 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
253
254 rtc_writel(pxa_rtc, RYCR, ryxr_calc(tm));
255 rtc_writel(pxa_rtc, RDCR, rdxr_calc(tm));
256
257 return 0;
258 }
259
pxa_rtc_read_alarm(struct device * dev,struct rtc_wkalrm * alrm)260 static int pxa_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
261 {
262 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
263 u32 rtsr, ryar, rdar;
264
265 ryar = rtc_readl(pxa_rtc, RYAR1);
266 rdar = rtc_readl(pxa_rtc, RDAR1);
267 tm_calc(ryar, rdar, &alrm->time);
268
269 rtsr = rtc_readl(pxa_rtc, RTSR);
270 alrm->enabled = (rtsr & RTSR_RDALE1) ? 1 : 0;
271 alrm->pending = (rtsr & RTSR_RDAL1) ? 1 : 0;
272 return 0;
273 }
274
pxa_rtc_set_alarm(struct device * dev,struct rtc_wkalrm * alrm)275 static int pxa_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
276 {
277 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
278 u32 rtsr;
279
280 spin_lock_irq(&pxa_rtc->lock);
281
282 rtc_writel(pxa_rtc, RYAR1, ryxr_calc(&alrm->time));
283 rtc_writel(pxa_rtc, RDAR1, rdxr_calc(&alrm->time));
284
285 rtsr = rtc_readl(pxa_rtc, RTSR);
286 if (alrm->enabled)
287 rtsr |= RTSR_RDALE1;
288 else
289 rtsr &= ~RTSR_RDALE1;
290 rtc_writel(pxa_rtc, RTSR, rtsr);
291
292 spin_unlock_irq(&pxa_rtc->lock);
293
294 return 0;
295 }
296
pxa_rtc_proc(struct device * dev,struct seq_file * seq)297 static int pxa_rtc_proc(struct device *dev, struct seq_file *seq)
298 {
299 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
300
301 seq_printf(seq, "trim/divider\t: 0x%08x\n", rtc_readl(pxa_rtc, RTTR));
302 seq_printf(seq, "update_IRQ\t: %s\n",
303 (rtc_readl(pxa_rtc, RTSR) & RTSR_HZE) ? "yes" : "no");
304 seq_printf(seq, "periodic_IRQ\t: %s\n",
305 (rtc_readl(pxa_rtc, RTSR) & RTSR_PIALE) ? "yes" : "no");
306 seq_printf(seq, "periodic_freq\t: %u\n", rtc_readl(pxa_rtc, PIAR));
307
308 return 0;
309 }
310
311 static const struct rtc_class_ops pxa_rtc_ops = {
312 .read_time = pxa_rtc_read_time,
313 .set_time = pxa_rtc_set_time,
314 .read_alarm = pxa_rtc_read_alarm,
315 .set_alarm = pxa_rtc_set_alarm,
316 .alarm_irq_enable = pxa_alarm_irq_enable,
317 .proc = pxa_rtc_proc,
318 };
319
pxa_rtc_probe(struct platform_device * pdev)320 static int __init pxa_rtc_probe(struct platform_device *pdev)
321 {
322 struct device *dev = &pdev->dev;
323 struct pxa_rtc *pxa_rtc;
324 struct sa1100_rtc *sa1100_rtc;
325 int ret;
326
327 pxa_rtc = devm_kzalloc(dev, sizeof(*pxa_rtc), GFP_KERNEL);
328 if (!pxa_rtc)
329 return -ENOMEM;
330 sa1100_rtc = &pxa_rtc->sa1100_rtc;
331
332 spin_lock_init(&pxa_rtc->lock);
333 platform_set_drvdata(pdev, pxa_rtc);
334
335 pxa_rtc->ress = platform_get_resource(pdev, IORESOURCE_MEM, 0);
336 if (!pxa_rtc->ress) {
337 dev_err(dev, "No I/O memory resource defined\n");
338 return -ENXIO;
339 }
340
341 sa1100_rtc->irq_1hz = platform_get_irq(pdev, 0);
342 if (sa1100_rtc->irq_1hz < 0) {
343 dev_err(dev, "No 1Hz IRQ resource defined\n");
344 return -ENXIO;
345 }
346 sa1100_rtc->irq_alarm = platform_get_irq(pdev, 1);
347 if (sa1100_rtc->irq_alarm < 0) {
348 dev_err(dev, "No alarm IRQ resource defined\n");
349 return -ENXIO;
350 }
351
352 pxa_rtc->base = devm_ioremap(dev, pxa_rtc->ress->start,
353 resource_size(pxa_rtc->ress));
354 if (!pxa_rtc->base) {
355 dev_err(dev, "Unable to map pxa RTC I/O memory\n");
356 return -ENOMEM;
357 }
358
359 pxa_rtc_open(dev);
360
361 sa1100_rtc->rcnr = pxa_rtc->base + 0x0;
362 sa1100_rtc->rtsr = pxa_rtc->base + 0x8;
363 sa1100_rtc->rtar = pxa_rtc->base + 0x4;
364 sa1100_rtc->rttr = pxa_rtc->base + 0xc;
365 ret = sa1100_rtc_init(pdev, sa1100_rtc);
366 if (ret) {
367 dev_err(dev, "Unable to init SA1100 RTC sub-device\n");
368 return ret;
369 }
370
371 rtsr_clear_bits(pxa_rtc, RTSR_PIALE | RTSR_RDALE1 | RTSR_HZE);
372
373 pxa_rtc->rtc = devm_rtc_device_register(&pdev->dev, "pxa-rtc",
374 &pxa_rtc_ops, THIS_MODULE);
375 if (IS_ERR(pxa_rtc->rtc)) {
376 ret = PTR_ERR(pxa_rtc->rtc);
377 dev_err(dev, "Failed to register RTC device -> %d\n", ret);
378 return ret;
379 }
380
381 device_init_wakeup(dev, 1);
382
383 return 0;
384 }
385
pxa_rtc_remove(struct platform_device * pdev)386 static int __exit pxa_rtc_remove(struct platform_device *pdev)
387 {
388 struct device *dev = &pdev->dev;
389
390 pxa_rtc_release(dev);
391 return 0;
392 }
393
394 #ifdef CONFIG_OF
395 static const struct of_device_id pxa_rtc_dt_ids[] = {
396 { .compatible = "marvell,pxa-rtc" },
397 {}
398 };
399 MODULE_DEVICE_TABLE(of, pxa_rtc_dt_ids);
400 #endif
401
402 #ifdef CONFIG_PM_SLEEP
pxa_rtc_suspend(struct device * dev)403 static int pxa_rtc_suspend(struct device *dev)
404 {
405 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
406
407 if (device_may_wakeup(dev))
408 enable_irq_wake(pxa_rtc->sa1100_rtc.irq_alarm);
409 return 0;
410 }
411
pxa_rtc_resume(struct device * dev)412 static int pxa_rtc_resume(struct device *dev)
413 {
414 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
415
416 if (device_may_wakeup(dev))
417 disable_irq_wake(pxa_rtc->sa1100_rtc.irq_alarm);
418 return 0;
419 }
420 #endif
421
422 static SIMPLE_DEV_PM_OPS(pxa_rtc_pm_ops, pxa_rtc_suspend, pxa_rtc_resume);
423
424 static struct platform_driver pxa_rtc_driver = {
425 .remove = __exit_p(pxa_rtc_remove),
426 .driver = {
427 .name = "pxa-rtc",
428 .of_match_table = of_match_ptr(pxa_rtc_dt_ids),
429 .pm = &pxa_rtc_pm_ops,
430 },
431 };
432
433 module_platform_driver_probe(pxa_rtc_driver, pxa_rtc_probe);
434
435 MODULE_AUTHOR("Robert Jarzmik <robert.jarzmik@free.fr>");
436 MODULE_DESCRIPTION("PXA27x/PXA3xx Realtime Clock Driver (RTC)");
437 MODULE_LICENSE("GPL");
438 MODULE_ALIAS("platform:pxa-rtc");
439
