]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/rtc/rtc-mxc.c
rtc: 88pm80x: fix unintended sign extension
[mirror_ubuntu-bionic-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>
cec13c26
PR
19#include <linux/of.h>
20#include <linux/of_device.h>
d00ed3cf 21
d00ed3cf
DM
22#define RTC_INPUT_CLK_32768HZ (0x00 << 5)
23#define RTC_INPUT_CLK_32000HZ (0x01 << 5)
24#define RTC_INPUT_CLK_38400HZ (0x02 << 5)
25
26#define RTC_SW_BIT (1 << 0)
27#define RTC_ALM_BIT (1 << 2)
28#define RTC_1HZ_BIT (1 << 4)
29#define RTC_2HZ_BIT (1 << 7)
30#define RTC_SAM0_BIT (1 << 8)
31#define RTC_SAM1_BIT (1 << 9)
32#define RTC_SAM2_BIT (1 << 10)
33#define RTC_SAM3_BIT (1 << 11)
34#define RTC_SAM4_BIT (1 << 12)
35#define RTC_SAM5_BIT (1 << 13)
36#define RTC_SAM6_BIT (1 << 14)
37#define RTC_SAM7_BIT (1 << 15)
38#define PIT_ALL_ON (RTC_2HZ_BIT | RTC_SAM0_BIT | RTC_SAM1_BIT | \
39 RTC_SAM2_BIT | RTC_SAM3_BIT | RTC_SAM4_BIT | \
40 RTC_SAM5_BIT | RTC_SAM6_BIT | RTC_SAM7_BIT)
41
42#define RTC_ENABLE_BIT (1 << 7)
43
44#define MAX_PIE_NUM 9
45#define MAX_PIE_FREQ 512
d00ed3cf 46
d00ed3cf
DM
47#define MXC_RTC_TIME 0
48#define MXC_RTC_ALARM 1
49
50#define RTC_HOURMIN 0x00 /* 32bit rtc hour/min counter reg */
51#define RTC_SECOND 0x04 /* 32bit rtc seconds counter reg */
52#define RTC_ALRM_HM 0x08 /* 32bit rtc alarm hour/min reg */
53#define RTC_ALRM_SEC 0x0C /* 32bit rtc alarm seconds reg */
54#define RTC_RTCCTL 0x10 /* 32bit rtc control reg */
55#define RTC_RTCISR 0x14 /* 32bit rtc interrupt status reg */
56#define RTC_RTCIENR 0x18 /* 32bit rtc interrupt enable reg */
57#define RTC_STPWCH 0x1C /* 32bit rtc stopwatch min reg */
58#define RTC_DAYR 0x20 /* 32bit rtc days counter reg */
59#define RTC_DAYALARM 0x24 /* 32bit rtc day alarm reg */
60#define RTC_TEST1 0x28 /* 32bit rtc test reg 1 */
61#define RTC_TEST2 0x2C /* 32bit rtc test reg 2 */
62#define RTC_TEST3 0x30 /* 32bit rtc test reg 3 */
63
bb1d34a2
SG
64enum imx_rtc_type {
65 IMX1_RTC,
66 IMX21_RTC,
67};
68
d00ed3cf
DM
69struct rtc_plat_data {
70 struct rtc_device *rtc;
71 void __iomem *ioaddr;
72 int irq;
8f5fe778
PR
73 struct clk *clk_ref;
74 struct clk *clk_ipg;
d00ed3cf 75 struct rtc_time g_rtc_alarm;
bb1d34a2 76 enum imx_rtc_type devtype;
d00ed3cf
DM
77};
78
cd6ba00a 79static const struct platform_device_id imx_rtc_devtype[] = {
bb1d34a2
SG
80 {
81 .name = "imx1-rtc",
82 .driver_data = IMX1_RTC,
83 }, {
84 .name = "imx21-rtc",
85 .driver_data = IMX21_RTC,
86 }, {
87 /* sentinel */
88 }
89};
90MODULE_DEVICE_TABLE(platform, imx_rtc_devtype);
91
cec13c26
PR
92#ifdef CONFIG_OF
93static const struct of_device_id imx_rtc_dt_ids[] = {
94 { .compatible = "fsl,imx1-rtc", .data = (const void *)IMX1_RTC },
95 { .compatible = "fsl,imx21-rtc", .data = (const void *)IMX21_RTC },
96 {}
97};
98MODULE_DEVICE_TABLE(of, imx_rtc_dt_ids);
99#endif
100
bb1d34a2
SG
101static inline int is_imx1_rtc(struct rtc_plat_data *data)
102{
103 return data->devtype == IMX1_RTC;
104}
105
d00ed3cf
DM
106/*
107 * This function is used to obtain the RTC time or the alarm value in
108 * second.
109 */
a015b8aa 110static time64_t get_alarm_or_time(struct device *dev, int time_alarm)
d00ed3cf
DM
111{
112 struct platform_device *pdev = to_platform_device(dev);
113 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
114 void __iomem *ioaddr = pdata->ioaddr;
115 u32 day = 0, hr = 0, min = 0, sec = 0, hr_min = 0;
116
117 switch (time_alarm) {
118 case MXC_RTC_TIME:
119 day = readw(ioaddr + RTC_DAYR);
120 hr_min = readw(ioaddr + RTC_HOURMIN);
121 sec = readw(ioaddr + RTC_SECOND);
122 break;
123 case MXC_RTC_ALARM:
124 day = readw(ioaddr + RTC_DAYALARM);
125 hr_min = readw(ioaddr + RTC_ALRM_HM) & 0xffff;
126 sec = readw(ioaddr + RTC_ALRM_SEC);
127 break;
128 }
129
130 hr = hr_min >> 8;
131 min = hr_min & 0xff;
132
a015b8aa 133 return ((((time64_t)day * 24 + hr) * 60) + min) * 60 + sec;
d00ed3cf
DM
134}
135
136/*
137 * This function sets the RTC alarm value or the time value.
138 */
a015b8aa 139static void set_alarm_or_time(struct device *dev, int time_alarm, time64_t time)
d00ed3cf 140{
a015b8aa 141 u32 tod, day, hr, min, sec, temp;
d00ed3cf
DM
142 struct platform_device *pdev = to_platform_device(dev);
143 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
144 void __iomem *ioaddr = pdata->ioaddr;
145
a015b8aa 146 day = div_s64_rem(time, 86400, &tod);
d00ed3cf
DM
147
148 /* time is within a day now */
a015b8aa
XP
149 hr = tod / 3600;
150 tod -= hr * 3600;
d00ed3cf
DM
151
152 /* time is within an hour now */
a015b8aa
XP
153 min = tod / 60;
154 sec = tod - min * 60;
d00ed3cf
DM
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{
a015b8aa 178 time64_t 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
a015b8aa 183 time = rtc_tm_to_time64(alrm);
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 231
d00ed3cf
DM
232 if (status & PIT_ALL_ON)
233 events |= (RTC_PF | RTC_IRQF);
234
d00ed3cf 235 rtc_update_irq(pdata->rtc, 1, events);
b59f6d1f 236 spin_unlock_irqrestore(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
237
238 return IRQ_HANDLED;
239}
240
d00ed3cf
DM
241static int mxc_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
242{
243 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, enabled);
244 return 0;
245}
246
d00ed3cf
DM
247/*
248 * This function reads the current RTC time into tm in Gregorian date.
249 */
250static int mxc_rtc_read_time(struct device *dev, struct rtc_time *tm)
251{
a015b8aa 252 time64_t val;
d00ed3cf
DM
253
254 /* Avoid roll-over from reading the different registers */
255 do {
256 val = get_alarm_or_time(dev, MXC_RTC_TIME);
257 } while (val != get_alarm_or_time(dev, MXC_RTC_TIME));
258
a015b8aa 259 rtc_time64_to_tm(val, tm);
d00ed3cf
DM
260
261 return 0;
262}
263
264/*
265 * This function sets the internal RTC time based on tm in Gregorian date.
266 */
933623c3 267static int mxc_rtc_set_mmss(struct device *dev, time64_t time)
d00ed3cf 268{
bb1d34a2
SG
269 struct platform_device *pdev = to_platform_device(dev);
270 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
271
7287be1d
YK
272 /*
273 * TTC_DAYR register is 9-bit in MX1 SoC, save time and day of year only
274 */
bb1d34a2 275 if (is_imx1_rtc(pdata)) {
7287be1d
YK
276 struct rtc_time tm;
277
933623c3 278 rtc_time64_to_tm(time, &tm);
7287be1d 279 tm.tm_year = 70;
933623c3 280 time = rtc_tm_to_time64(&tm);
7287be1d
YK
281 }
282
d00ed3cf
DM
283 /* Avoid roll-over from reading the different registers */
284 do {
285 set_alarm_or_time(dev, MXC_RTC_TIME, time);
286 } while (time != get_alarm_or_time(dev, MXC_RTC_TIME));
287
288 return 0;
289}
290
291/*
292 * This function reads the current alarm value into the passed in 'alrm'
293 * argument. It updates the alrm's pending field value based on the whether
294 * an alarm interrupt occurs or not.
295 */
296static int mxc_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
297{
298 struct platform_device *pdev = to_platform_device(dev);
299 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
300 void __iomem *ioaddr = pdata->ioaddr;
301
a015b8aa 302 rtc_time64_to_tm(get_alarm_or_time(dev, MXC_RTC_ALARM), &alrm->time);
d00ed3cf
DM
303 alrm->pending = ((readw(ioaddr + RTC_RTCISR) & RTC_ALM_BIT)) ? 1 : 0;
304
305 return 0;
306}
307
308/*
309 * This function sets the RTC alarm based on passed in alrm.
310 */
311static int mxc_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
312{
313 struct platform_device *pdev = to_platform_device(dev);
314 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
d00ed3cf 315
482494a8 316 rtc_update_alarm(dev, &alrm->time);
d00ed3cf
DM
317
318 memcpy(&pdata->g_rtc_alarm, &alrm->time, sizeof(struct rtc_time));
319 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, alrm->enabled);
320
321 return 0;
322}
323
324/* RTC layer */
8bc57e7f 325static const struct rtc_class_ops mxc_rtc_ops = {
d00ed3cf 326 .read_time = mxc_rtc_read_time,
933623c3 327 .set_mmss64 = mxc_rtc_set_mmss,
d00ed3cf
DM
328 .read_alarm = mxc_rtc_read_alarm,
329 .set_alarm = mxc_rtc_set_alarm,
330 .alarm_irq_enable = mxc_rtc_alarm_irq_enable,
d00ed3cf
DM
331};
332
5a167f45 333static int mxc_rtc_probe(struct platform_device *pdev)
d00ed3cf 334{
d00ed3cf
DM
335 struct resource *res;
336 struct rtc_device *rtc;
337 struct rtc_plat_data *pdata = NULL;
338 u32 reg;
c783a29e
VZ
339 unsigned long rate;
340 int ret;
cec13c26 341 const struct of_device_id *of_id;
d00ed3cf 342
c783a29e 343 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
d00ed3cf
DM
344 if (!pdata)
345 return -ENOMEM;
346
cec13c26
PR
347 of_id = of_match_device(imx_rtc_dt_ids, &pdev->dev);
348 if (of_id)
349 pdata->devtype = (enum imx_rtc_type)of_id->data;
350 else
351 pdata->devtype = pdev->id_entry->driver_data;
bb1d34a2 352
7c1d69ee
JL
353 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
354 pdata->ioaddr = devm_ioremap_resource(&pdev->dev, res);
355 if (IS_ERR(pdata->ioaddr))
356 return PTR_ERR(pdata->ioaddr);
d00ed3cf 357
8f5fe778
PR
358 pdata->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
359 if (IS_ERR(pdata->clk_ipg)) {
360 dev_err(&pdev->dev, "unable to get ipg clock!\n");
361 return PTR_ERR(pdata->clk_ipg);
49908e73 362 }
d00ed3cf 363
8f5fe778 364 ret = clk_prepare_enable(pdata->clk_ipg);
1b3d2243
FE
365 if (ret)
366 return ret;
367
8f5fe778
PR
368 pdata->clk_ref = devm_clk_get(&pdev->dev, "ref");
369 if (IS_ERR(pdata->clk_ref)) {
370 dev_err(&pdev->dev, "unable to get ref clock!\n");
371 ret = PTR_ERR(pdata->clk_ref);
372 goto exit_put_clk_ipg;
373 }
374
375 ret = clk_prepare_enable(pdata->clk_ref);
376 if (ret)
377 goto exit_put_clk_ipg;
378
379 rate = clk_get_rate(pdata->clk_ref);
d00ed3cf
DM
380
381 if (rate == 32768)
382 reg = RTC_INPUT_CLK_32768HZ;
383 else if (rate == 32000)
384 reg = RTC_INPUT_CLK_32000HZ;
385 else if (rate == 38400)
386 reg = RTC_INPUT_CLK_38400HZ;
387 else {
c783a29e 388 dev_err(&pdev->dev, "rtc clock is not valid (%lu)\n", rate);
d00ed3cf 389 ret = -EINVAL;
8f5fe778 390 goto exit_put_clk_ref;
d00ed3cf
DM
391 }
392
393 reg |= RTC_ENABLE_BIT;
394 writew(reg, (pdata->ioaddr + RTC_RTCCTL));
395 if (((readw(pdata->ioaddr + RTC_RTCCTL)) & RTC_ENABLE_BIT) == 0) {
396 dev_err(&pdev->dev, "hardware module can't be enabled!\n");
397 ret = -EIO;
8f5fe778 398 goto exit_put_clk_ref;
d00ed3cf
DM
399 }
400
d00ed3cf
DM
401 platform_set_drvdata(pdev, pdata);
402
403 /* Configure and enable the RTC */
404 pdata->irq = platform_get_irq(pdev, 0);
405
406 if (pdata->irq >= 0 &&
c783a29e
VZ
407 devm_request_irq(&pdev->dev, pdata->irq, mxc_rtc_interrupt,
408 IRQF_SHARED, pdev->name, pdev) < 0) {
d00ed3cf
DM
409 dev_warn(&pdev->dev, "interrupt not available.\n");
410 pdata->irq = -1;
411 }
412
4a8282d0 413 if (pdata->irq >= 0)
c92182ee
YK
414 device_init_wakeup(&pdev->dev, 1);
415
033ca3ad 416 rtc = devm_rtc_device_register(&pdev->dev, pdev->name, &mxc_rtc_ops,
5f54c8a0
WS
417 THIS_MODULE);
418 if (IS_ERR(rtc)) {
419 ret = PTR_ERR(rtc);
8f5fe778 420 goto exit_put_clk_ref;
5f54c8a0
WS
421 }
422
423 pdata->rtc = rtc;
424
d00ed3cf
DM
425 return 0;
426
8f5fe778
PR
427exit_put_clk_ref:
428 clk_disable_unprepare(pdata->clk_ref);
429exit_put_clk_ipg:
430 clk_disable_unprepare(pdata->clk_ipg);
d00ed3cf 431
d00ed3cf
DM
432 return ret;
433}
434
5a167f45 435static int mxc_rtc_remove(struct platform_device *pdev)
d00ed3cf
DM
436{
437 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
438
8f5fe778
PR
439 clk_disable_unprepare(pdata->clk_ref);
440 clk_disable_unprepare(pdata->clk_ipg);
d00ed3cf
DM
441
442 return 0;
443}
444
75634cc4 445#ifdef CONFIG_PM_SLEEP
c92182ee
YK
446static int mxc_rtc_suspend(struct device *dev)
447{
448 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
449
450 if (device_may_wakeup(dev))
451 enable_irq_wake(pdata->irq);
452
453 return 0;
454}
455
456static int mxc_rtc_resume(struct device *dev)
457{
458 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
459
460 if (device_may_wakeup(dev))
461 disable_irq_wake(pdata->irq);
462
463 return 0;
464}
c92182ee
YK
465#endif
466
75634cc4
JH
467static SIMPLE_DEV_PM_OPS(mxc_rtc_pm_ops, mxc_rtc_suspend, mxc_rtc_resume);
468
d00ed3cf
DM
469static struct platform_driver mxc_rtc_driver = {
470 .driver = {
471 .name = "mxc_rtc",
cec13c26 472 .of_match_table = of_match_ptr(imx_rtc_dt_ids),
c92182ee 473 .pm = &mxc_rtc_pm_ops,
d00ed3cf 474 },
bb1d34a2 475 .id_table = imx_rtc_devtype,
be8b6d51 476 .probe = mxc_rtc_probe,
5a167f45 477 .remove = mxc_rtc_remove,
d00ed3cf
DM
478};
479
be8b6d51 480module_platform_driver(mxc_rtc_driver)
d00ed3cf
DM
481
482MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
483MODULE_DESCRIPTION("RTC driver for Freescale MXC");
484MODULE_LICENSE("GPL");
485