Linux 4.1.16
[linux/fpc-iii.git] / drivers / rtc / rtc-pxa.c
blob4561f375327dbefd5f532a961dfa478934e856e6
1 /*
2 * Real Time Clock interface for XScale PXA27x and PXA3xx
4 * Copyright (C) 2008 Robert Jarzmik
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.
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.
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
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>
33 #include <mach/hardware.h>
35 #define RTC_DEF_DIVIDER (32768 - 1)
36 #define RTC_DEF_TRIM 0
37 #define MAXFREQ_PERIODIC 1000
40 * PXA Registers and bits definitions
42 #define RTSR_PICE (1 << 15) /* Periodic interrupt count enable */
43 #define RTSR_PIALE (1 << 14) /* Periodic interrupt Alarm enable */
44 #define RTSR_PIAL (1 << 13) /* Periodic interrupt detected */
45 #define RTSR_SWALE2 (1 << 11) /* RTC stopwatch alarm2 enable */
46 #define RTSR_SWAL2 (1 << 10) /* RTC stopwatch alarm2 detected */
47 #define RTSR_SWALE1 (1 << 9) /* RTC stopwatch alarm1 enable */
48 #define RTSR_SWAL1 (1 << 8) /* RTC stopwatch alarm1 detected */
49 #define RTSR_RDALE2 (1 << 7) /* RTC alarm2 enable */
50 #define RTSR_RDAL2 (1 << 6) /* RTC alarm2 detected */
51 #define RTSR_RDALE1 (1 << 5) /* RTC alarm1 enable */
52 #define RTSR_RDAL1 (1 << 4) /* RTC alarm1 detected */
53 #define RTSR_HZE (1 << 3) /* HZ interrupt enable */
54 #define RTSR_ALE (1 << 2) /* RTC alarm interrupt enable */
55 #define RTSR_HZ (1 << 1) /* HZ rising-edge detected */
56 #define RTSR_AL (1 << 0) /* RTC alarm detected */
57 #define RTSR_TRIG_MASK (RTSR_AL | RTSR_HZ | RTSR_RDAL1 | RTSR_RDAL2\
58 | RTSR_SWAL1 | RTSR_SWAL2)
59 #define RYxR_YEAR_S 9
60 #define RYxR_YEAR_MASK (0xfff << RYxR_YEAR_S)
61 #define RYxR_MONTH_S 5
62 #define RYxR_MONTH_MASK (0xf << RYxR_MONTH_S)
63 #define RYxR_DAY_MASK 0x1f
64 #define RDxR_WOM_S 20
65 #define RDxR_WOM_MASK (0x7 << RDxR_WOM_S)
66 #define RDxR_DOW_S 17
67 #define RDxR_DOW_MASK (0x7 << RDxR_DOW_S)
68 #define RDxR_HOUR_S 12
69 #define RDxR_HOUR_MASK (0x1f << RDxR_HOUR_S)
70 #define RDxR_MIN_S 6
71 #define RDxR_MIN_MASK (0x3f << RDxR_MIN_S)
72 #define RDxR_SEC_MASK 0x3f
74 #define RTSR 0x08
75 #define RTTR 0x0c
76 #define RDCR 0x10
77 #define RYCR 0x14
78 #define RDAR1 0x18
79 #define RYAR1 0x1c
80 #define RTCPICR 0x34
81 #define PIAR 0x38
83 #define rtc_readl(pxa_rtc, reg) \
84 __raw_readl((pxa_rtc)->base + (reg))
85 #define rtc_writel(pxa_rtc, reg, value) \
86 __raw_writel((value), (pxa_rtc)->base + (reg))
88 struct pxa_rtc {
89 struct resource *ress;
90 void __iomem *base;
91 int irq_1Hz;
92 int irq_Alrm;
93 struct rtc_device *rtc;
94 spinlock_t lock; /* Protects this structure */
98 static u32 ryxr_calc(struct rtc_time *tm)
100 return ((tm->tm_year + 1900) << RYxR_YEAR_S)
101 | ((tm->tm_mon + 1) << RYxR_MONTH_S)
102 | tm->tm_mday;
105 static u32 rdxr_calc(struct rtc_time *tm)
107 return ((((tm->tm_mday + 6) / 7) << RDxR_WOM_S) & RDxR_WOM_MASK)
108 | (((tm->tm_wday + 1) << RDxR_DOW_S) & RDxR_DOW_MASK)
109 | (tm->tm_hour << RDxR_HOUR_S)
110 | (tm->tm_min << RDxR_MIN_S)
111 | tm->tm_sec;
114 static void tm_calc(u32 rycr, u32 rdcr, struct rtc_time *tm)
116 tm->tm_year = ((rycr & RYxR_YEAR_MASK) >> RYxR_YEAR_S) - 1900;
117 tm->tm_mon = (((rycr & RYxR_MONTH_MASK) >> RYxR_MONTH_S)) - 1;
118 tm->tm_mday = (rycr & RYxR_DAY_MASK);
119 tm->tm_wday = ((rycr & RDxR_DOW_MASK) >> RDxR_DOW_S) - 1;
120 tm->tm_hour = (rdcr & RDxR_HOUR_MASK) >> RDxR_HOUR_S;
121 tm->tm_min = (rdcr & RDxR_MIN_MASK) >> RDxR_MIN_S;
122 tm->tm_sec = rdcr & RDxR_SEC_MASK;
125 static void rtsr_clear_bits(struct pxa_rtc *pxa_rtc, u32 mask)
127 u32 rtsr;
129 rtsr = rtc_readl(pxa_rtc, RTSR);
130 rtsr &= ~RTSR_TRIG_MASK;
131 rtsr &= ~mask;
132 rtc_writel(pxa_rtc, RTSR, rtsr);
135 static void rtsr_set_bits(struct pxa_rtc *pxa_rtc, u32 mask)
137 u32 rtsr;
139 rtsr = rtc_readl(pxa_rtc, RTSR);
140 rtsr &= ~RTSR_TRIG_MASK;
141 rtsr |= mask;
142 rtc_writel(pxa_rtc, RTSR, rtsr);
145 static irqreturn_t pxa_rtc_irq(int irq, void *dev_id)
147 struct platform_device *pdev = to_platform_device(dev_id);
148 struct pxa_rtc *pxa_rtc = platform_get_drvdata(pdev);
149 u32 rtsr;
150 unsigned long events = 0;
152 spin_lock(&pxa_rtc->lock);
154 /* clear interrupt sources */
155 rtsr = rtc_readl(pxa_rtc, RTSR);
156 rtc_writel(pxa_rtc, RTSR, rtsr);
158 /* temporary disable rtc interrupts */
159 rtsr_clear_bits(pxa_rtc, RTSR_RDALE1 | RTSR_PIALE | RTSR_HZE);
161 /* clear alarm interrupt if it has occurred */
162 if (rtsr & RTSR_RDAL1)
163 rtsr &= ~RTSR_RDALE1;
165 /* update irq data & counter */
166 if (rtsr & RTSR_RDAL1)
167 events |= RTC_AF | RTC_IRQF;
168 if (rtsr & RTSR_HZ)
169 events |= RTC_UF | RTC_IRQF;
170 if (rtsr & RTSR_PIAL)
171 events |= RTC_PF | RTC_IRQF;
173 rtc_update_irq(pxa_rtc->rtc, 1, events);
175 /* enable back rtc interrupts */
176 rtc_writel(pxa_rtc, RTSR, rtsr & ~RTSR_TRIG_MASK);
178 spin_unlock(&pxa_rtc->lock);
179 return IRQ_HANDLED;
182 static int pxa_rtc_open(struct device *dev)
184 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
185 int ret;
187 ret = request_irq(pxa_rtc->irq_1Hz, pxa_rtc_irq, 0,
188 "rtc 1Hz", dev);
189 if (ret < 0) {
190 dev_err(dev, "can't get irq %i, err %d\n", pxa_rtc->irq_1Hz,
191 ret);
192 goto err_irq_1Hz;
194 ret = request_irq(pxa_rtc->irq_Alrm, pxa_rtc_irq, 0,
195 "rtc Alrm", dev);
196 if (ret < 0) {
197 dev_err(dev, "can't get irq %i, err %d\n", pxa_rtc->irq_Alrm,
198 ret);
199 goto err_irq_Alrm;
202 return 0;
204 err_irq_Alrm:
205 free_irq(pxa_rtc->irq_1Hz, dev);
206 err_irq_1Hz:
207 return ret;
210 static void pxa_rtc_release(struct device *dev)
212 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
214 spin_lock_irq(&pxa_rtc->lock);
215 rtsr_clear_bits(pxa_rtc, RTSR_PIALE | RTSR_RDALE1 | RTSR_HZE);
216 spin_unlock_irq(&pxa_rtc->lock);
218 free_irq(pxa_rtc->irq_Alrm, dev);
219 free_irq(pxa_rtc->irq_1Hz, dev);
222 static int pxa_alarm_irq_enable(struct device *dev, unsigned int enabled)
224 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
226 spin_lock_irq(&pxa_rtc->lock);
228 if (enabled)
229 rtsr_set_bits(pxa_rtc, RTSR_RDALE1);
230 else
231 rtsr_clear_bits(pxa_rtc, RTSR_RDALE1);
233 spin_unlock_irq(&pxa_rtc->lock);
234 return 0;
237 static int pxa_rtc_read_time(struct device *dev, struct rtc_time *tm)
239 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
240 u32 rycr, rdcr;
242 rycr = rtc_readl(pxa_rtc, RYCR);
243 rdcr = rtc_readl(pxa_rtc, RDCR);
245 tm_calc(rycr, rdcr, tm);
246 return 0;
249 static int pxa_rtc_set_time(struct device *dev, struct rtc_time *tm)
251 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
253 rtc_writel(pxa_rtc, RYCR, ryxr_calc(tm));
254 rtc_writel(pxa_rtc, RDCR, rdxr_calc(tm));
256 return 0;
259 static int pxa_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
261 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
262 u32 rtsr, ryar, rdar;
264 ryar = rtc_readl(pxa_rtc, RYAR1);
265 rdar = rtc_readl(pxa_rtc, RDAR1);
266 tm_calc(ryar, rdar, &alrm->time);
268 rtsr = rtc_readl(pxa_rtc, RTSR);
269 alrm->enabled = (rtsr & RTSR_RDALE1) ? 1 : 0;
270 alrm->pending = (rtsr & RTSR_RDAL1) ? 1 : 0;
271 return 0;
274 static int pxa_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
276 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
277 u32 rtsr;
279 spin_lock_irq(&pxa_rtc->lock);
281 rtc_writel(pxa_rtc, RYAR1, ryxr_calc(&alrm->time));
282 rtc_writel(pxa_rtc, RDAR1, rdxr_calc(&alrm->time));
284 rtsr = rtc_readl(pxa_rtc, RTSR);
285 if (alrm->enabled)
286 rtsr |= RTSR_RDALE1;
287 else
288 rtsr &= ~RTSR_RDALE1;
289 rtc_writel(pxa_rtc, RTSR, rtsr);
291 spin_unlock_irq(&pxa_rtc->lock);
293 return 0;
296 static int pxa_rtc_proc(struct device *dev, struct seq_file *seq)
298 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
300 seq_printf(seq, "trim/divider\t: 0x%08x\n", rtc_readl(pxa_rtc, RTTR));
301 seq_printf(seq, "update_IRQ\t: %s\n",
302 (rtc_readl(pxa_rtc, RTSR) & RTSR_HZE) ? "yes" : "no");
303 seq_printf(seq, "periodic_IRQ\t: %s\n",
304 (rtc_readl(pxa_rtc, RTSR) & RTSR_PIALE) ? "yes" : "no");
305 seq_printf(seq, "periodic_freq\t: %u\n", rtc_readl(pxa_rtc, PIAR));
307 return 0;
310 static const struct rtc_class_ops pxa_rtc_ops = {
311 .read_time = pxa_rtc_read_time,
312 .set_time = pxa_rtc_set_time,
313 .read_alarm = pxa_rtc_read_alarm,
314 .set_alarm = pxa_rtc_set_alarm,
315 .alarm_irq_enable = pxa_alarm_irq_enable,
316 .proc = pxa_rtc_proc,
319 static int __init pxa_rtc_probe(struct platform_device *pdev)
321 struct device *dev = &pdev->dev;
322 struct pxa_rtc *pxa_rtc;
323 int ret;
324 u32 rttr;
326 pxa_rtc = devm_kzalloc(dev, sizeof(*pxa_rtc), GFP_KERNEL);
327 if (!pxa_rtc)
328 return -ENOMEM;
330 spin_lock_init(&pxa_rtc->lock);
331 platform_set_drvdata(pdev, pxa_rtc);
333 pxa_rtc->ress = platform_get_resource(pdev, IORESOURCE_MEM, 0);
334 if (!pxa_rtc->ress) {
335 dev_err(dev, "No I/O memory resource defined\n");
336 return -ENXIO;
339 pxa_rtc->irq_1Hz = platform_get_irq(pdev, 0);
340 if (pxa_rtc->irq_1Hz < 0) {
341 dev_err(dev, "No 1Hz IRQ resource defined\n");
342 return -ENXIO;
344 pxa_rtc->irq_Alrm = platform_get_irq(pdev, 1);
345 if (pxa_rtc->irq_Alrm < 0) {
346 dev_err(dev, "No alarm IRQ resource defined\n");
347 return -ENXIO;
349 pxa_rtc_open(dev);
350 pxa_rtc->base = devm_ioremap(dev, pxa_rtc->ress->start,
351 resource_size(pxa_rtc->ress));
352 if (!pxa_rtc->base) {
353 dev_err(dev, "Unable to map pxa RTC I/O memory\n");
354 return -ENOMEM;
358 * If the clock divider is uninitialized then reset it to the
359 * default value to get the 1Hz clock.
361 if (rtc_readl(pxa_rtc, RTTR) == 0) {
362 rttr = RTC_DEF_DIVIDER + (RTC_DEF_TRIM << 16);
363 rtc_writel(pxa_rtc, RTTR, rttr);
364 dev_warn(dev, "warning: initializing default clock"
365 " divider/trim value\n");
368 rtsr_clear_bits(pxa_rtc, RTSR_PIALE | RTSR_RDALE1 | RTSR_HZE);
370 pxa_rtc->rtc = devm_rtc_device_register(&pdev->dev, "pxa-rtc",
371 &pxa_rtc_ops, THIS_MODULE);
372 if (IS_ERR(pxa_rtc->rtc)) {
373 ret = PTR_ERR(pxa_rtc->rtc);
374 dev_err(dev, "Failed to register RTC device -> %d\n", ret);
375 return ret;
378 device_init_wakeup(dev, 1);
380 return 0;
383 static int __exit pxa_rtc_remove(struct platform_device *pdev)
385 struct device *dev = &pdev->dev;
387 pxa_rtc_release(dev);
388 return 0;
391 #ifdef CONFIG_OF
392 static const struct of_device_id pxa_rtc_dt_ids[] = {
393 { .compatible = "marvell,pxa-rtc" },
396 MODULE_DEVICE_TABLE(of, pxa_rtc_dt_ids);
397 #endif
399 #ifdef CONFIG_PM_SLEEP
400 static int pxa_rtc_suspend(struct device *dev)
402 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
404 if (device_may_wakeup(dev))
405 enable_irq_wake(pxa_rtc->irq_Alrm);
406 return 0;
409 static int pxa_rtc_resume(struct device *dev)
411 struct pxa_rtc *pxa_rtc = dev_get_drvdata(dev);
413 if (device_may_wakeup(dev))
414 disable_irq_wake(pxa_rtc->irq_Alrm);
415 return 0;
417 #endif
419 static SIMPLE_DEV_PM_OPS(pxa_rtc_pm_ops, pxa_rtc_suspend, pxa_rtc_resume);
421 static struct platform_driver pxa_rtc_driver = {
422 .remove = __exit_p(pxa_rtc_remove),
423 .driver = {
424 .name = "pxa-rtc",
425 .of_match_table = of_match_ptr(pxa_rtc_dt_ids),
426 .pm = &pxa_rtc_pm_ops,
430 module_platform_driver_probe(pxa_rtc_driver, pxa_rtc_probe);
432 MODULE_AUTHOR("Robert Jarzmik <robert.jarzmik@free.fr>");
433 MODULE_DESCRIPTION("PXA27x/PXA3xx Realtime Clock Driver (RTC)");
434 MODULE_LICENSE("GPL");
435 MODULE_ALIAS("platform:pxa-rtc");