]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/rtc/rtc-mxc.c
drivers/rtc/mxc: Modify rtc_update_alarm() not to touch the alarm time
[mirror_ubuntu-zesty-kernel.git] / drivers / rtc / rtc-mxc.c
CommitLineData
d00ed3cf
DM
1/*
2 * Copyright 2004-2008 Freescale Semiconductor, Inc. All Rights Reserved.
3 *
4 * The code contained herein is licensed under the GNU General Public
5 * License. You may obtain a copy of the GNU General Public License
6 * Version 2 or later at the following locations:
7 *
8 * http://www.opensource.org/licenses/gpl-license.html
9 * http://www.gnu.org/copyleft/gpl.html
10 */
11
12#include <linux/io.h>
13#include <linux/rtc.h>
14#include <linux/module.h>
5a0e3ad6 15#include <linux/slab.h>
d00ed3cf
DM
16#include <linux/interrupt.h>
17#include <linux/platform_device.h>
18#include <linux/clk.h>
19
d00ed3cf
DM
20#define RTC_INPUT_CLK_32768HZ (0x00 << 5)
21#define RTC_INPUT_CLK_32000HZ (0x01 << 5)
22#define RTC_INPUT_CLK_38400HZ (0x02 << 5)
23
24#define RTC_SW_BIT (1 << 0)
25#define RTC_ALM_BIT (1 << 2)
26#define RTC_1HZ_BIT (1 << 4)
27#define RTC_2HZ_BIT (1 << 7)
28#define RTC_SAM0_BIT (1 << 8)
29#define RTC_SAM1_BIT (1 << 9)
30#define RTC_SAM2_BIT (1 << 10)
31#define RTC_SAM3_BIT (1 << 11)
32#define RTC_SAM4_BIT (1 << 12)
33#define RTC_SAM5_BIT (1 << 13)
34#define RTC_SAM6_BIT (1 << 14)
35#define RTC_SAM7_BIT (1 << 15)
36#define PIT_ALL_ON (RTC_2HZ_BIT | RTC_SAM0_BIT | RTC_SAM1_BIT | \
37 RTC_SAM2_BIT | RTC_SAM3_BIT | RTC_SAM4_BIT | \
38 RTC_SAM5_BIT | RTC_SAM6_BIT | RTC_SAM7_BIT)
39
40#define RTC_ENABLE_BIT (1 << 7)
41
42#define MAX_PIE_NUM 9
43#define MAX_PIE_FREQ 512
44static const u32 PIE_BIT_DEF[MAX_PIE_NUM][2] = {
45 { 2, RTC_2HZ_BIT },
46 { 4, RTC_SAM0_BIT },
47 { 8, RTC_SAM1_BIT },
48 { 16, RTC_SAM2_BIT },
49 { 32, RTC_SAM3_BIT },
50 { 64, RTC_SAM4_BIT },
51 { 128, RTC_SAM5_BIT },
52 { 256, RTC_SAM6_BIT },
53 { MAX_PIE_FREQ, RTC_SAM7_BIT },
54};
55
d00ed3cf
DM
56#define MXC_RTC_TIME 0
57#define MXC_RTC_ALARM 1
58
59#define RTC_HOURMIN 0x00 /* 32bit rtc hour/min counter reg */
60#define RTC_SECOND 0x04 /* 32bit rtc seconds counter reg */
61#define RTC_ALRM_HM 0x08 /* 32bit rtc alarm hour/min reg */
62#define RTC_ALRM_SEC 0x0C /* 32bit rtc alarm seconds reg */
63#define RTC_RTCCTL 0x10 /* 32bit rtc control reg */
64#define RTC_RTCISR 0x14 /* 32bit rtc interrupt status reg */
65#define RTC_RTCIENR 0x18 /* 32bit rtc interrupt enable reg */
66#define RTC_STPWCH 0x1C /* 32bit rtc stopwatch min reg */
67#define RTC_DAYR 0x20 /* 32bit rtc days counter reg */
68#define RTC_DAYALARM 0x24 /* 32bit rtc day alarm reg */
69#define RTC_TEST1 0x28 /* 32bit rtc test reg 1 */
70#define RTC_TEST2 0x2C /* 32bit rtc test reg 2 */
71#define RTC_TEST3 0x30 /* 32bit rtc test reg 3 */
72
bb1d34a2
SG
73enum imx_rtc_type {
74 IMX1_RTC,
75 IMX21_RTC,
76};
77
d00ed3cf
DM
78struct rtc_plat_data {
79 struct rtc_device *rtc;
80 void __iomem *ioaddr;
81 int irq;
82 struct clk *clk;
d00ed3cf 83 struct rtc_time g_rtc_alarm;
bb1d34a2 84 enum imx_rtc_type devtype;
d00ed3cf
DM
85};
86
bb1d34a2
SG
87static struct platform_device_id imx_rtc_devtype[] = {
88 {
89 .name = "imx1-rtc",
90 .driver_data = IMX1_RTC,
91 }, {
92 .name = "imx21-rtc",
93 .driver_data = IMX21_RTC,
94 }, {
95 /* sentinel */
96 }
97};
98MODULE_DEVICE_TABLE(platform, imx_rtc_devtype);
99
100static inline int is_imx1_rtc(struct rtc_plat_data *data)
101{
102 return data->devtype == IMX1_RTC;
103}
104
d00ed3cf
DM
105/*
106 * This function is used to obtain the RTC time or the alarm value in
107 * second.
108 */
109static u32 get_alarm_or_time(struct device *dev, int time_alarm)
110{
111 struct platform_device *pdev = to_platform_device(dev);
112 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
113 void __iomem *ioaddr = pdata->ioaddr;
114 u32 day = 0, hr = 0, min = 0, sec = 0, hr_min = 0;
115
116 switch (time_alarm) {
117 case MXC_RTC_TIME:
118 day = readw(ioaddr + RTC_DAYR);
119 hr_min = readw(ioaddr + RTC_HOURMIN);
120 sec = readw(ioaddr + RTC_SECOND);
121 break;
122 case MXC_RTC_ALARM:
123 day = readw(ioaddr + RTC_DAYALARM);
124 hr_min = readw(ioaddr + RTC_ALRM_HM) & 0xffff;
125 sec = readw(ioaddr + RTC_ALRM_SEC);
126 break;
127 }
128
129 hr = hr_min >> 8;
130 min = hr_min & 0xff;
131
132 return (((day * 24 + hr) * 60) + min) * 60 + sec;
133}
134
135/*
136 * This function sets the RTC alarm value or the time value.
137 */
138static void set_alarm_or_time(struct device *dev, int time_alarm, u32 time)
139{
140 u32 day, hr, min, sec, temp;
141 struct platform_device *pdev = to_platform_device(dev);
142 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
143 void __iomem *ioaddr = pdata->ioaddr;
144
145 day = time / 86400;
146 time -= day * 86400;
147
148 /* time is within a day now */
149 hr = time / 3600;
150 time -= hr * 3600;
151
152 /* time is within an hour now */
153 min = time / 60;
154 sec = time - min * 60;
155
156 temp = (hr << 8) + min;
157
158 switch (time_alarm) {
159 case MXC_RTC_TIME:
160 writew(day, ioaddr + RTC_DAYR);
161 writew(sec, ioaddr + RTC_SECOND);
162 writew(temp, ioaddr + RTC_HOURMIN);
163 break;
164 case MXC_RTC_ALARM:
165 writew(day, ioaddr + RTC_DAYALARM);
166 writew(sec, ioaddr + RTC_ALRM_SEC);
167 writew(temp, ioaddr + RTC_ALRM_HM);
168 break;
169 }
170}
171
172/*
173 * This function updates the RTC alarm registers and then clears all the
174 * interrupt status bits.
175 */
482494a8 176static void rtc_update_alarm(struct device *dev, struct rtc_time *alrm)
d00ed3cf 177{
482494a8 178 unsigned long time;
d00ed3cf
DM
179 struct platform_device *pdev = to_platform_device(dev);
180 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
181 void __iomem *ioaddr = pdata->ioaddr;
182
482494a8 183 rtc_tm_to_time(alrm, &time);
d00ed3cf 184
d00ed3cf
DM
185 /* clear all the interrupt status bits */
186 writew(readw(ioaddr + RTC_RTCISR), ioaddr + RTC_RTCISR);
187 set_alarm_or_time(dev, MXC_RTC_ALARM, time);
c92182ee
YK
188}
189
190static void mxc_rtc_irq_enable(struct device *dev, unsigned int bit,
191 unsigned int enabled)
192{
193 struct platform_device *pdev = to_platform_device(dev);
194 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
195 void __iomem *ioaddr = pdata->ioaddr;
196 u32 reg;
197
198 spin_lock_irq(&pdata->rtc->irq_lock);
199 reg = readw(ioaddr + RTC_RTCIENR);
200
201 if (enabled)
202 reg |= bit;
203 else
204 reg &= ~bit;
205
206 writew(reg, ioaddr + RTC_RTCIENR);
207 spin_unlock_irq(&pdata->rtc->irq_lock);
d00ed3cf
DM
208}
209
210/* This function is the RTC interrupt service routine. */
211static irqreturn_t mxc_rtc_interrupt(int irq, void *dev_id)
212{
213 struct platform_device *pdev = dev_id;
214 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
215 void __iomem *ioaddr = pdata->ioaddr;
b59f6d1f 216 unsigned long flags;
d00ed3cf
DM
217 u32 status;
218 u32 events = 0;
219
b59f6d1f 220 spin_lock_irqsave(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
221 status = readw(ioaddr + RTC_RTCISR) & readw(ioaddr + RTC_RTCIENR);
222 /* clear interrupt sources */
223 writew(status, ioaddr + RTC_RTCISR);
224
d00ed3cf 225 /* update irq data & counter */
c92182ee 226 if (status & RTC_ALM_BIT) {
d00ed3cf 227 events |= (RTC_AF | RTC_IRQF);
c92182ee
YK
228 /* RTC alarm should be one-shot */
229 mxc_rtc_irq_enable(&pdev->dev, RTC_ALM_BIT, 0);
230 }
d00ed3cf
DM
231
232 if (status & RTC_1HZ_BIT)
233 events |= (RTC_UF | RTC_IRQF);
234
235 if (status & PIT_ALL_ON)
236 events |= (RTC_PF | RTC_IRQF);
237
d00ed3cf 238 rtc_update_irq(pdata->rtc, 1, events);
b59f6d1f 239 spin_unlock_irqrestore(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
240
241 return IRQ_HANDLED;
242}
243
244/*
245 * Clear all interrupts and release the IRQ
246 */
247static void mxc_rtc_release(struct device *dev)
248{
249 struct platform_device *pdev = to_platform_device(dev);
250 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
251 void __iomem *ioaddr = pdata->ioaddr;
252
253 spin_lock_irq(&pdata->rtc->irq_lock);
254
255 /* Disable all rtc interrupts */
256 writew(0, ioaddr + RTC_RTCIENR);
257
258 /* Clear all interrupt status */
259 writew(0xffffffff, ioaddr + RTC_RTCISR);
260
261 spin_unlock_irq(&pdata->rtc->irq_lock);
262}
263
d00ed3cf
DM
264static int mxc_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
265{
266 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, enabled);
267 return 0;
268}
269
d00ed3cf
DM
270/*
271 * This function reads the current RTC time into tm in Gregorian date.
272 */
273static int mxc_rtc_read_time(struct device *dev, struct rtc_time *tm)
274{
275 u32 val;
276
277 /* Avoid roll-over from reading the different registers */
278 do {
279 val = get_alarm_or_time(dev, MXC_RTC_TIME);
280 } while (val != get_alarm_or_time(dev, MXC_RTC_TIME));
281
282 rtc_time_to_tm(val, tm);
283
284 return 0;
285}
286
287/*
288 * This function sets the internal RTC time based on tm in Gregorian date.
289 */
290static int mxc_rtc_set_mmss(struct device *dev, unsigned long time)
291{
bb1d34a2
SG
292 struct platform_device *pdev = to_platform_device(dev);
293 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
294
7287be1d
YK
295 /*
296 * TTC_DAYR register is 9-bit in MX1 SoC, save time and day of year only
297 */
bb1d34a2 298 if (is_imx1_rtc(pdata)) {
7287be1d
YK
299 struct rtc_time tm;
300
301 rtc_time_to_tm(time, &tm);
302 tm.tm_year = 70;
303 rtc_tm_to_time(&tm, &time);
304 }
305
d00ed3cf
DM
306 /* Avoid roll-over from reading the different registers */
307 do {
308 set_alarm_or_time(dev, MXC_RTC_TIME, time);
309 } while (time != get_alarm_or_time(dev, MXC_RTC_TIME));
310
311 return 0;
312}
313
314/*
315 * This function reads the current alarm value into the passed in 'alrm'
316 * argument. It updates the alrm's pending field value based on the whether
317 * an alarm interrupt occurs or not.
318 */
319static int mxc_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
320{
321 struct platform_device *pdev = to_platform_device(dev);
322 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
323 void __iomem *ioaddr = pdata->ioaddr;
324
325 rtc_time_to_tm(get_alarm_or_time(dev, MXC_RTC_ALARM), &alrm->time);
326 alrm->pending = ((readw(ioaddr + RTC_RTCISR) & RTC_ALM_BIT)) ? 1 : 0;
327
328 return 0;
329}
330
331/*
332 * This function sets the RTC alarm based on passed in alrm.
333 */
334static int mxc_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
335{
336 struct platform_device *pdev = to_platform_device(dev);
337 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
d00ed3cf 338
482494a8 339 rtc_update_alarm(dev, &alrm->time);
d00ed3cf
DM
340
341 memcpy(&pdata->g_rtc_alarm, &alrm->time, sizeof(struct rtc_time));
342 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, alrm->enabled);
343
344 return 0;
345}
346
347/* RTC layer */
348static struct rtc_class_ops mxc_rtc_ops = {
349 .release = mxc_rtc_release,
350 .read_time = mxc_rtc_read_time,
351 .set_mmss = mxc_rtc_set_mmss,
352 .read_alarm = mxc_rtc_read_alarm,
353 .set_alarm = mxc_rtc_set_alarm,
354 .alarm_irq_enable = mxc_rtc_alarm_irq_enable,
d00ed3cf
DM
355};
356
5a167f45 357static int mxc_rtc_probe(struct platform_device *pdev)
d00ed3cf 358{
d00ed3cf
DM
359 struct resource *res;
360 struct rtc_device *rtc;
361 struct rtc_plat_data *pdata = NULL;
362 u32 reg;
c783a29e
VZ
363 unsigned long rate;
364 int ret;
d00ed3cf 365
c783a29e 366 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
d00ed3cf
DM
367 if (!pdata)
368 return -ENOMEM;
369
bb1d34a2
SG
370 pdata->devtype = pdev->id_entry->driver_data;
371
7c1d69ee
JL
372 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
373 pdata->ioaddr = devm_ioremap_resource(&pdev->dev, res);
374 if (IS_ERR(pdata->ioaddr))
375 return PTR_ERR(pdata->ioaddr);
d00ed3cf 376
0f3cde53 377 pdata->clk = devm_clk_get(&pdev->dev, NULL);
5cf8f57d
VZ
378 if (IS_ERR(pdata->clk)) {
379 dev_err(&pdev->dev, "unable to get clock!\n");
fbd5e754 380 return PTR_ERR(pdata->clk);
49908e73 381 }
d00ed3cf 382
1b3d2243
FE
383 ret = clk_prepare_enable(pdata->clk);
384 if (ret)
385 return ret;
386
5cf8f57d 387 rate = clk_get_rate(pdata->clk);
d00ed3cf
DM
388
389 if (rate == 32768)
390 reg = RTC_INPUT_CLK_32768HZ;
391 else if (rate == 32000)
392 reg = RTC_INPUT_CLK_32000HZ;
393 else if (rate == 38400)
394 reg = RTC_INPUT_CLK_38400HZ;
395 else {
c783a29e 396 dev_err(&pdev->dev, "rtc clock is not valid (%lu)\n", rate);
d00ed3cf 397 ret = -EINVAL;
5cf8f57d 398 goto exit_put_clk;
d00ed3cf
DM
399 }
400
401 reg |= RTC_ENABLE_BIT;
402 writew(reg, (pdata->ioaddr + RTC_RTCCTL));
403 if (((readw(pdata->ioaddr + RTC_RTCCTL)) & RTC_ENABLE_BIT) == 0) {
404 dev_err(&pdev->dev, "hardware module can't be enabled!\n");
405 ret = -EIO;
5cf8f57d 406 goto exit_put_clk;
d00ed3cf
DM
407 }
408
d00ed3cf
DM
409 platform_set_drvdata(pdev, pdata);
410
411 /* Configure and enable the RTC */
412 pdata->irq = platform_get_irq(pdev, 0);
413
414 if (pdata->irq >= 0 &&
c783a29e
VZ
415 devm_request_irq(&pdev->dev, pdata->irq, mxc_rtc_interrupt,
416 IRQF_SHARED, pdev->name, pdev) < 0) {
d00ed3cf
DM
417 dev_warn(&pdev->dev, "interrupt not available.\n");
418 pdata->irq = -1;
419 }
420
4a8282d0 421 if (pdata->irq >= 0)
c92182ee
YK
422 device_init_wakeup(&pdev->dev, 1);
423
033ca3ad 424 rtc = devm_rtc_device_register(&pdev->dev, pdev->name, &mxc_rtc_ops,
5f54c8a0
WS
425 THIS_MODULE);
426 if (IS_ERR(rtc)) {
427 ret = PTR_ERR(rtc);
d2f3a398 428 goto exit_put_clk;
5f54c8a0
WS
429 }
430
431 pdata->rtc = rtc;
432
d00ed3cf
DM
433 return 0;
434
435exit_put_clk:
0f3cde53 436 clk_disable_unprepare(pdata->clk);
d00ed3cf 437
d00ed3cf
DM
438 return ret;
439}
440
5a167f45 441static int mxc_rtc_remove(struct platform_device *pdev)
d00ed3cf
DM
442{
443 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
444
0f3cde53 445 clk_disable_unprepare(pdata->clk);
d00ed3cf
DM
446
447 return 0;
448}
449
75634cc4 450#ifdef CONFIG_PM_SLEEP
c92182ee
YK
451static int mxc_rtc_suspend(struct device *dev)
452{
453 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
454
455 if (device_may_wakeup(dev))
456 enable_irq_wake(pdata->irq);
457
458 return 0;
459}
460
461static int mxc_rtc_resume(struct device *dev)
462{
463 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
464
465 if (device_may_wakeup(dev))
466 disable_irq_wake(pdata->irq);
467
468 return 0;
469}
c92182ee
YK
470#endif
471
75634cc4
JH
472static SIMPLE_DEV_PM_OPS(mxc_rtc_pm_ops, mxc_rtc_suspend, mxc_rtc_resume);
473
d00ed3cf
DM
474static struct platform_driver mxc_rtc_driver = {
475 .driver = {
476 .name = "mxc_rtc",
c92182ee 477 .pm = &mxc_rtc_pm_ops,
d00ed3cf 478 },
bb1d34a2 479 .id_table = imx_rtc_devtype,
be8b6d51 480 .probe = mxc_rtc_probe,
5a167f45 481 .remove = mxc_rtc_remove,
d00ed3cf
DM
482};
483
be8b6d51 484module_platform_driver(mxc_rtc_driver)
d00ed3cf
DM
485
486MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
487MODULE_DESCRIPTION("RTC driver for Freescale MXC");
488MODULE_LICENSE("GPL");
489