]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/rtc/rtc-mxc.c
Merge branch 's390-qeth-fixes'
[mirror_ubuntu-jammy-kernel.git] / drivers / rtc / rtc-mxc.c
CommitLineData
75d01b75
FE
1// SPDX-License-Identifier: GPL-2.0+
2//
3// Copyright 2004-2008 Freescale Semiconductor, Inc. All Rights Reserved.
d00ed3cf
DM
4
5#include <linux/io.h>
6#include <linux/rtc.h>
7#include <linux/module.h>
5a0e3ad6 8#include <linux/slab.h>
d00ed3cf
DM
9#include <linux/interrupt.h>
10#include <linux/platform_device.h>
bc0e731f 11#include <linux/pm_wakeirq.h>
d00ed3cf 12#include <linux/clk.h>
cec13c26
PR
13#include <linux/of.h>
14#include <linux/of_device.h>
d00ed3cf 15
d00ed3cf
DM
16#define RTC_INPUT_CLK_32768HZ (0x00 << 5)
17#define RTC_INPUT_CLK_32000HZ (0x01 << 5)
18#define RTC_INPUT_CLK_38400HZ (0x02 << 5)
19
20#define RTC_SW_BIT (1 << 0)
21#define RTC_ALM_BIT (1 << 2)
22#define RTC_1HZ_BIT (1 << 4)
23#define RTC_2HZ_BIT (1 << 7)
24#define RTC_SAM0_BIT (1 << 8)
25#define RTC_SAM1_BIT (1 << 9)
26#define RTC_SAM2_BIT (1 << 10)
27#define RTC_SAM3_BIT (1 << 11)
28#define RTC_SAM4_BIT (1 << 12)
29#define RTC_SAM5_BIT (1 << 13)
30#define RTC_SAM6_BIT (1 << 14)
31#define RTC_SAM7_BIT (1 << 15)
32#define PIT_ALL_ON (RTC_2HZ_BIT | RTC_SAM0_BIT | RTC_SAM1_BIT | \
33 RTC_SAM2_BIT | RTC_SAM3_BIT | RTC_SAM4_BIT | \
34 RTC_SAM5_BIT | RTC_SAM6_BIT | RTC_SAM7_BIT)
35
36#define RTC_ENABLE_BIT (1 << 7)
37
38#define MAX_PIE_NUM 9
39#define MAX_PIE_FREQ 512
d00ed3cf 40
d00ed3cf
DM
41#define MXC_RTC_TIME 0
42#define MXC_RTC_ALARM 1
43
44#define RTC_HOURMIN 0x00 /* 32bit rtc hour/min counter reg */
45#define RTC_SECOND 0x04 /* 32bit rtc seconds counter reg */
46#define RTC_ALRM_HM 0x08 /* 32bit rtc alarm hour/min reg */
47#define RTC_ALRM_SEC 0x0C /* 32bit rtc alarm seconds reg */
48#define RTC_RTCCTL 0x10 /* 32bit rtc control reg */
49#define RTC_RTCISR 0x14 /* 32bit rtc interrupt status reg */
50#define RTC_RTCIENR 0x18 /* 32bit rtc interrupt enable reg */
51#define RTC_STPWCH 0x1C /* 32bit rtc stopwatch min reg */
52#define RTC_DAYR 0x20 /* 32bit rtc days counter reg */
53#define RTC_DAYALARM 0x24 /* 32bit rtc day alarm reg */
54#define RTC_TEST1 0x28 /* 32bit rtc test reg 1 */
55#define RTC_TEST2 0x2C /* 32bit rtc test reg 2 */
56#define RTC_TEST3 0x30 /* 32bit rtc test reg 3 */
57
bb1d34a2
SG
58enum imx_rtc_type {
59 IMX1_RTC,
60 IMX21_RTC,
61};
62
d00ed3cf
DM
63struct rtc_plat_data {
64 struct rtc_device *rtc;
65 void __iomem *ioaddr;
66 int irq;
8f5fe778
PR
67 struct clk *clk_ref;
68 struct clk *clk_ipg;
d00ed3cf 69 struct rtc_time g_rtc_alarm;
bb1d34a2 70 enum imx_rtc_type devtype;
d00ed3cf
DM
71};
72
cd6ba00a 73static const struct platform_device_id imx_rtc_devtype[] = {
bb1d34a2
SG
74 {
75 .name = "imx1-rtc",
76 .driver_data = IMX1_RTC,
77 }, {
78 .name = "imx21-rtc",
79 .driver_data = IMX21_RTC,
80 }, {
81 /* sentinel */
82 }
83};
84MODULE_DEVICE_TABLE(platform, imx_rtc_devtype);
85
cec13c26
PR
86#ifdef CONFIG_OF
87static const struct of_device_id imx_rtc_dt_ids[] = {
88 { .compatible = "fsl,imx1-rtc", .data = (const void *)IMX1_RTC },
89 { .compatible = "fsl,imx21-rtc", .data = (const void *)IMX21_RTC },
90 {}
91};
92MODULE_DEVICE_TABLE(of, imx_rtc_dt_ids);
93#endif
94
bb1d34a2
SG
95static inline int is_imx1_rtc(struct rtc_plat_data *data)
96{
97 return data->devtype == IMX1_RTC;
98}
99
d00ed3cf
DM
100/*
101 * This function is used to obtain the RTC time or the alarm value in
102 * second.
103 */
a015b8aa 104static time64_t get_alarm_or_time(struct device *dev, int time_alarm)
d00ed3cf 105{
85368bb9 106 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
d00ed3cf
DM
107 void __iomem *ioaddr = pdata->ioaddr;
108 u32 day = 0, hr = 0, min = 0, sec = 0, hr_min = 0;
109
110 switch (time_alarm) {
111 case MXC_RTC_TIME:
112 day = readw(ioaddr + RTC_DAYR);
113 hr_min = readw(ioaddr + RTC_HOURMIN);
114 sec = readw(ioaddr + RTC_SECOND);
115 break;
116 case MXC_RTC_ALARM:
117 day = readw(ioaddr + RTC_DAYALARM);
118 hr_min = readw(ioaddr + RTC_ALRM_HM) & 0xffff;
119 sec = readw(ioaddr + RTC_ALRM_SEC);
120 break;
121 }
122
123 hr = hr_min >> 8;
124 min = hr_min & 0xff;
125
a015b8aa 126 return ((((time64_t)day * 24 + hr) * 60) + min) * 60 + sec;
d00ed3cf
DM
127}
128
129/*
130 * This function sets the RTC alarm value or the time value.
131 */
a015b8aa 132static void set_alarm_or_time(struct device *dev, int time_alarm, time64_t time)
d00ed3cf 133{
a015b8aa 134 u32 tod, day, hr, min, sec, temp;
85368bb9 135 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
d00ed3cf
DM
136 void __iomem *ioaddr = pdata->ioaddr;
137
a015b8aa 138 day = div_s64_rem(time, 86400, &tod);
d00ed3cf
DM
139
140 /* time is within a day now */
a015b8aa
XP
141 hr = tod / 3600;
142 tod -= hr * 3600;
d00ed3cf
DM
143
144 /* time is within an hour now */
a015b8aa
XP
145 min = tod / 60;
146 sec = tod - min * 60;
d00ed3cf
DM
147
148 temp = (hr << 8) + min;
149
150 switch (time_alarm) {
151 case MXC_RTC_TIME:
152 writew(day, ioaddr + RTC_DAYR);
153 writew(sec, ioaddr + RTC_SECOND);
154 writew(temp, ioaddr + RTC_HOURMIN);
155 break;
156 case MXC_RTC_ALARM:
157 writew(day, ioaddr + RTC_DAYALARM);
158 writew(sec, ioaddr + RTC_ALRM_SEC);
159 writew(temp, ioaddr + RTC_ALRM_HM);
160 break;
161 }
162}
163
164/*
165 * This function updates the RTC alarm registers and then clears all the
166 * interrupt status bits.
167 */
482494a8 168static void rtc_update_alarm(struct device *dev, struct rtc_time *alrm)
d00ed3cf 169{
a015b8aa 170 time64_t time;
85368bb9 171 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
d00ed3cf
DM
172 void __iomem *ioaddr = pdata->ioaddr;
173
a015b8aa 174 time = rtc_tm_to_time64(alrm);
d00ed3cf 175
d00ed3cf
DM
176 /* clear all the interrupt status bits */
177 writew(readw(ioaddr + RTC_RTCISR), ioaddr + RTC_RTCISR);
178 set_alarm_or_time(dev, MXC_RTC_ALARM, time);
c92182ee
YK
179}
180
181static void mxc_rtc_irq_enable(struct device *dev, unsigned int bit,
182 unsigned int enabled)
183{
85368bb9 184 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
c92182ee
YK
185 void __iomem *ioaddr = pdata->ioaddr;
186 u32 reg;
b0a3fa44 187 unsigned long flags;
c92182ee 188
b0a3fa44 189 spin_lock_irqsave(&pdata->rtc->irq_lock, flags);
c92182ee
YK
190 reg = readw(ioaddr + RTC_RTCIENR);
191
192 if (enabled)
193 reg |= bit;
194 else
195 reg &= ~bit;
196
197 writew(reg, ioaddr + RTC_RTCIENR);
b0a3fa44 198 spin_unlock_irqrestore(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
199}
200
201/* This function is the RTC interrupt service routine. */
202static irqreturn_t mxc_rtc_interrupt(int irq, void *dev_id)
203{
204 struct platform_device *pdev = dev_id;
205 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
206 void __iomem *ioaddr = pdata->ioaddr;
b59f6d1f 207 unsigned long flags;
d00ed3cf
DM
208 u32 status;
209 u32 events = 0;
210
b59f6d1f 211 spin_lock_irqsave(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
212 status = readw(ioaddr + RTC_RTCISR) & readw(ioaddr + RTC_RTCIENR);
213 /* clear interrupt sources */
214 writew(status, ioaddr + RTC_RTCISR);
215
d00ed3cf 216 /* update irq data & counter */
c92182ee 217 if (status & RTC_ALM_BIT) {
d00ed3cf 218 events |= (RTC_AF | RTC_IRQF);
c92182ee
YK
219 /* RTC alarm should be one-shot */
220 mxc_rtc_irq_enable(&pdev->dev, RTC_ALM_BIT, 0);
221 }
d00ed3cf 222
d00ed3cf
DM
223 if (status & PIT_ALL_ON)
224 events |= (RTC_PF | RTC_IRQF);
225
d00ed3cf 226 rtc_update_irq(pdata->rtc, 1, events);
b59f6d1f 227 spin_unlock_irqrestore(&pdata->rtc->irq_lock, flags);
d00ed3cf
DM
228
229 return IRQ_HANDLED;
230}
231
d00ed3cf
DM
232static int mxc_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
233{
234 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, enabled);
235 return 0;
236}
237
d00ed3cf
DM
238/*
239 * This function reads the current RTC time into tm in Gregorian date.
240 */
241static int mxc_rtc_read_time(struct device *dev, struct rtc_time *tm)
242{
a015b8aa 243 time64_t val;
d00ed3cf
DM
244
245 /* Avoid roll-over from reading the different registers */
246 do {
247 val = get_alarm_or_time(dev, MXC_RTC_TIME);
248 } while (val != get_alarm_or_time(dev, MXC_RTC_TIME));
249
a015b8aa 250 rtc_time64_to_tm(val, tm);
d00ed3cf
DM
251
252 return 0;
253}
254
255/*
256 * This function sets the internal RTC time based on tm in Gregorian date.
257 */
02bc7235 258static int mxc_rtc_set_time(struct device *dev, struct rtc_time *tm)
d00ed3cf 259{
02bc7235
AB
260 time64_t time = rtc_tm_to_time64(tm);
261
d00ed3cf
DM
262 /* Avoid roll-over from reading the different registers */
263 do {
264 set_alarm_or_time(dev, MXC_RTC_TIME, time);
265 } while (time != get_alarm_or_time(dev, MXC_RTC_TIME));
266
267 return 0;
268}
269
270/*
271 * This function reads the current alarm value into the passed in 'alrm'
272 * argument. It updates the alrm's pending field value based on the whether
273 * an alarm interrupt occurs or not.
274 */
275static int mxc_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
276{
85368bb9 277 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
d00ed3cf
DM
278 void __iomem *ioaddr = pdata->ioaddr;
279
a015b8aa 280 rtc_time64_to_tm(get_alarm_or_time(dev, MXC_RTC_ALARM), &alrm->time);
d00ed3cf
DM
281 alrm->pending = ((readw(ioaddr + RTC_RTCISR) & RTC_ALM_BIT)) ? 1 : 0;
282
283 return 0;
284}
285
286/*
287 * This function sets the RTC alarm based on passed in alrm.
288 */
289static int mxc_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
290{
85368bb9 291 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
d00ed3cf 292
482494a8 293 rtc_update_alarm(dev, &alrm->time);
d00ed3cf
DM
294
295 memcpy(&pdata->g_rtc_alarm, &alrm->time, sizeof(struct rtc_time));
296 mxc_rtc_irq_enable(dev, RTC_ALM_BIT, alrm->enabled);
297
298 return 0;
299}
300
301/* RTC layer */
8bc57e7f 302static const struct rtc_class_ops mxc_rtc_ops = {
d00ed3cf 303 .read_time = mxc_rtc_read_time,
02bc7235 304 .set_time = mxc_rtc_set_time,
d00ed3cf
DM
305 .read_alarm = mxc_rtc_read_alarm,
306 .set_alarm = mxc_rtc_set_alarm,
307 .alarm_irq_enable = mxc_rtc_alarm_irq_enable,
d00ed3cf
DM
308};
309
fdc9f0ea
AH
310static void mxc_rtc_action(void *p)
311{
312 struct rtc_plat_data *pdata = p;
313
314 clk_disable_unprepare(pdata->clk_ref);
315 clk_disable_unprepare(pdata->clk_ipg);
316}
317
5a167f45 318static int mxc_rtc_probe(struct platform_device *pdev)
d00ed3cf 319{
d00ed3cf
DM
320 struct rtc_device *rtc;
321 struct rtc_plat_data *pdata = NULL;
322 u32 reg;
c783a29e
VZ
323 unsigned long rate;
324 int ret;
cec13c26 325 const struct of_device_id *of_id;
d00ed3cf 326
c783a29e 327 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
d00ed3cf
DM
328 if (!pdata)
329 return -ENOMEM;
330
cec13c26
PR
331 of_id = of_match_device(imx_rtc_dt_ids, &pdev->dev);
332 if (of_id)
333 pdata->devtype = (enum imx_rtc_type)of_id->data;
334 else
335 pdata->devtype = pdev->id_entry->driver_data;
bb1d34a2 336
cf37fa79 337 pdata->ioaddr = devm_platform_ioremap_resource(pdev, 0);
7c1d69ee
JL
338 if (IS_ERR(pdata->ioaddr))
339 return PTR_ERR(pdata->ioaddr);
d00ed3cf 340
ebc2ec4e
AB
341 rtc = devm_rtc_allocate_device(&pdev->dev);
342 if (IS_ERR(rtc))
343 return PTR_ERR(rtc);
344
345 pdata->rtc = rtc;
346 rtc->ops = &mxc_rtc_ops;
83888df4
AB
347 if (is_imx1_rtc(pdata)) {
348 struct rtc_time tm;
349
350 /* 9bit days + hours minutes seconds */
351 rtc->range_max = (1 << 9) * 86400 - 1;
352
353 /*
354 * Set the start date as beginning of the current year. This can
355 * be overridden using device tree.
356 */
357 rtc_time64_to_tm(ktime_get_real_seconds(), &tm);
358 rtc->start_secs = mktime64(tm.tm_year, 1, 1, 0, 0, 0);
359 rtc->set_start_time = true;
360 } else {
361 /* 16bit days + hours minutes seconds */
362 rtc->range_max = (1 << 16) * 86400ULL - 1;
363 }
ebc2ec4e 364
8f5fe778
PR
365 pdata->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
366 if (IS_ERR(pdata->clk_ipg)) {
367 dev_err(&pdev->dev, "unable to get ipg clock!\n");
368 return PTR_ERR(pdata->clk_ipg);
49908e73 369 }
d00ed3cf 370
8f5fe778 371 ret = clk_prepare_enable(pdata->clk_ipg);
1b3d2243
FE
372 if (ret)
373 return ret;
374
8f5fe778
PR
375 pdata->clk_ref = devm_clk_get(&pdev->dev, "ref");
376 if (IS_ERR(pdata->clk_ref)) {
fdc9f0ea 377 clk_disable_unprepare(pdata->clk_ipg);
8f5fe778 378 dev_err(&pdev->dev, "unable to get ref clock!\n");
fdc9f0ea 379 return PTR_ERR(pdata->clk_ref);
8f5fe778
PR
380 }
381
382 ret = clk_prepare_enable(pdata->clk_ref);
fdc9f0ea
AH
383 if (ret) {
384 clk_disable_unprepare(pdata->clk_ipg);
385 return ret;
386 }
387
388 ret = devm_add_action_or_reset(&pdev->dev, mxc_rtc_action, pdata);
8f5fe778 389 if (ret)
fdc9f0ea 390 return ret;
8f5fe778
PR
391
392 rate = clk_get_rate(pdata->clk_ref);
d00ed3cf
DM
393
394 if (rate == 32768)
395 reg = RTC_INPUT_CLK_32768HZ;
396 else if (rate == 32000)
397 reg = RTC_INPUT_CLK_32000HZ;
398 else if (rate == 38400)
399 reg = RTC_INPUT_CLK_38400HZ;
400 else {
c783a29e 401 dev_err(&pdev->dev, "rtc clock is not valid (%lu)\n", rate);
fdc9f0ea 402 return -EINVAL;
d00ed3cf
DM
403 }
404
405 reg |= RTC_ENABLE_BIT;
406 writew(reg, (pdata->ioaddr + RTC_RTCCTL));
407 if (((readw(pdata->ioaddr + RTC_RTCCTL)) & RTC_ENABLE_BIT) == 0) {
408 dev_err(&pdev->dev, "hardware module can't be enabled!\n");
fdc9f0ea 409 return -EIO;
d00ed3cf
DM
410 }
411
d00ed3cf
DM
412 platform_set_drvdata(pdev, pdata);
413
414 /* Configure and enable the RTC */
415 pdata->irq = platform_get_irq(pdev, 0);
416
417 if (pdata->irq >= 0 &&
c783a29e
VZ
418 devm_request_irq(&pdev->dev, pdata->irq, mxc_rtc_interrupt,
419 IRQF_SHARED, pdev->name, pdev) < 0) {
d00ed3cf
DM
420 dev_warn(&pdev->dev, "interrupt not available.\n");
421 pdata->irq = -1;
422 }
423
bc0e731f 424 if (pdata->irq >= 0) {
c92182ee 425 device_init_wakeup(&pdev->dev, 1);
bc0e731f
AH
426 ret = dev_pm_set_wake_irq(&pdev->dev, pdata->irq);
427 if (ret)
428 dev_err(&pdev->dev, "failed to enable irq wake\n");
429 }
c92182ee 430
ebc2ec4e 431 ret = rtc_register_device(rtc);
d00ed3cf 432
d00ed3cf
DM
433 return ret;
434}
435
d00ed3cf
DM
436static struct platform_driver mxc_rtc_driver = {
437 .driver = {
438 .name = "mxc_rtc",
cec13c26 439 .of_match_table = of_match_ptr(imx_rtc_dt_ids),
d00ed3cf 440 },
bb1d34a2 441 .id_table = imx_rtc_devtype,
be8b6d51 442 .probe = mxc_rtc_probe,
d00ed3cf
DM
443};
444
be8b6d51 445module_platform_driver(mxc_rtc_driver)
d00ed3cf
DM
446
447MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
448MODULE_DESCRIPTION("RTC driver for Freescale MXC");
449MODULE_LICENSE("GPL");
450