2 * Copyright 2004-2008 Freescale Semiconductor, Inc. All Rights Reserved.
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:
8 * http://www.opensource.org/licenses/gpl-license.html
9 * http://www.gnu.org/copyleft/gpl.html
13 #include <linux/rtc.h>
14 #include <linux/module.h>
15 #include <linux/slab.h>
16 #include <linux/interrupt.h>
17 #include <linux/platform_device.h>
18 #include <linux/clk.h>
20 #include <linux/of_device.h>
22 #define RTC_INPUT_CLK_32768HZ (0x00 << 5)
23 #define RTC_INPUT_CLK_32000HZ (0x01 << 5)
24 #define RTC_INPUT_CLK_38400HZ (0x02 << 5)
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)
42 #define RTC_ENABLE_BIT (1 << 7)
45 #define MAX_PIE_FREQ 512
46 static const u32 PIE_BIT_DEF
[MAX_PIE_NUM
][2] = {
53 { 128, RTC_SAM5_BIT
},
54 { 256, RTC_SAM6_BIT
},
55 { MAX_PIE_FREQ
, RTC_SAM7_BIT
},
58 #define MXC_RTC_TIME 0
59 #define MXC_RTC_ALARM 1
61 #define RTC_HOURMIN 0x00 /* 32bit rtc hour/min counter reg */
62 #define RTC_SECOND 0x04 /* 32bit rtc seconds counter reg */
63 #define RTC_ALRM_HM 0x08 /* 32bit rtc alarm hour/min reg */
64 #define RTC_ALRM_SEC 0x0C /* 32bit rtc alarm seconds reg */
65 #define RTC_RTCCTL 0x10 /* 32bit rtc control reg */
66 #define RTC_RTCISR 0x14 /* 32bit rtc interrupt status reg */
67 #define RTC_RTCIENR 0x18 /* 32bit rtc interrupt enable reg */
68 #define RTC_STPWCH 0x1C /* 32bit rtc stopwatch min reg */
69 #define RTC_DAYR 0x20 /* 32bit rtc days counter reg */
70 #define RTC_DAYALARM 0x24 /* 32bit rtc day alarm reg */
71 #define RTC_TEST1 0x28 /* 32bit rtc test reg 1 */
72 #define RTC_TEST2 0x2C /* 32bit rtc test reg 2 */
73 #define RTC_TEST3 0x30 /* 32bit rtc test reg 3 */
80 struct rtc_plat_data
{
81 struct rtc_device
*rtc
;
86 struct rtc_time g_rtc_alarm
;
87 enum imx_rtc_type devtype
;
90 static const struct platform_device_id imx_rtc_devtype
[] = {
93 .driver_data
= IMX1_RTC
,
96 .driver_data
= IMX21_RTC
,
101 MODULE_DEVICE_TABLE(platform
, imx_rtc_devtype
);
104 static const struct of_device_id imx_rtc_dt_ids
[] = {
105 { .compatible
= "fsl,imx1-rtc", .data
= (const void *)IMX1_RTC
},
106 { .compatible
= "fsl,imx21-rtc", .data
= (const void *)IMX21_RTC
},
109 MODULE_DEVICE_TABLE(of
, imx_rtc_dt_ids
);
112 static inline int is_imx1_rtc(struct rtc_plat_data
*data
)
114 return data
->devtype
== IMX1_RTC
;
118 * This function is used to obtain the RTC time or the alarm value in
121 static time64_t
get_alarm_or_time(struct device
*dev
, int time_alarm
)
123 struct platform_device
*pdev
= to_platform_device(dev
);
124 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
125 void __iomem
*ioaddr
= pdata
->ioaddr
;
126 u32 day
= 0, hr
= 0, min
= 0, sec
= 0, hr_min
= 0;
128 switch (time_alarm
) {
130 day
= readw(ioaddr
+ RTC_DAYR
);
131 hr_min
= readw(ioaddr
+ RTC_HOURMIN
);
132 sec
= readw(ioaddr
+ RTC_SECOND
);
135 day
= readw(ioaddr
+ RTC_DAYALARM
);
136 hr_min
= readw(ioaddr
+ RTC_ALRM_HM
) & 0xffff;
137 sec
= readw(ioaddr
+ RTC_ALRM_SEC
);
144 return ((((time64_t
)day
* 24 + hr
) * 60) + min
) * 60 + sec
;
148 * This function sets the RTC alarm value or the time value.
150 static void set_alarm_or_time(struct device
*dev
, int time_alarm
, time64_t time
)
152 u32 tod
, day
, hr
, min
, sec
, temp
;
153 struct platform_device
*pdev
= to_platform_device(dev
);
154 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
155 void __iomem
*ioaddr
= pdata
->ioaddr
;
157 day
= div_s64_rem(time
, 86400, &tod
);
159 /* time is within a day now */
163 /* time is within an hour now */
165 sec
= tod
- min
* 60;
167 temp
= (hr
<< 8) + min
;
169 switch (time_alarm
) {
171 writew(day
, ioaddr
+ RTC_DAYR
);
172 writew(sec
, ioaddr
+ RTC_SECOND
);
173 writew(temp
, ioaddr
+ RTC_HOURMIN
);
176 writew(day
, ioaddr
+ RTC_DAYALARM
);
177 writew(sec
, ioaddr
+ RTC_ALRM_SEC
);
178 writew(temp
, ioaddr
+ RTC_ALRM_HM
);
184 * This function updates the RTC alarm registers and then clears all the
185 * interrupt status bits.
187 static void rtc_update_alarm(struct device
*dev
, struct rtc_time
*alrm
)
190 struct platform_device
*pdev
= to_platform_device(dev
);
191 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
192 void __iomem
*ioaddr
= pdata
->ioaddr
;
194 time
= rtc_tm_to_time64(alrm
);
196 /* clear all the interrupt status bits */
197 writew(readw(ioaddr
+ RTC_RTCISR
), ioaddr
+ RTC_RTCISR
);
198 set_alarm_or_time(dev
, MXC_RTC_ALARM
, time
);
201 static void mxc_rtc_irq_enable(struct device
*dev
, unsigned int bit
,
202 unsigned int enabled
)
204 struct platform_device
*pdev
= to_platform_device(dev
);
205 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
206 void __iomem
*ioaddr
= pdata
->ioaddr
;
209 spin_lock_irq(&pdata
->rtc
->irq_lock
);
210 reg
= readw(ioaddr
+ RTC_RTCIENR
);
217 writew(reg
, ioaddr
+ RTC_RTCIENR
);
218 spin_unlock_irq(&pdata
->rtc
->irq_lock
);
221 /* This function is the RTC interrupt service routine. */
222 static irqreturn_t
mxc_rtc_interrupt(int irq
, void *dev_id
)
224 struct platform_device
*pdev
= dev_id
;
225 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
226 void __iomem
*ioaddr
= pdata
->ioaddr
;
231 spin_lock_irqsave(&pdata
->rtc
->irq_lock
, flags
);
232 status
= readw(ioaddr
+ RTC_RTCISR
) & readw(ioaddr
+ RTC_RTCIENR
);
233 /* clear interrupt sources */
234 writew(status
, ioaddr
+ RTC_RTCISR
);
236 /* update irq data & counter */
237 if (status
& RTC_ALM_BIT
) {
238 events
|= (RTC_AF
| RTC_IRQF
);
239 /* RTC alarm should be one-shot */
240 mxc_rtc_irq_enable(&pdev
->dev
, RTC_ALM_BIT
, 0);
243 if (status
& RTC_1HZ_BIT
)
244 events
|= (RTC_UF
| RTC_IRQF
);
246 if (status
& PIT_ALL_ON
)
247 events
|= (RTC_PF
| RTC_IRQF
);
249 rtc_update_irq(pdata
->rtc
, 1, events
);
250 spin_unlock_irqrestore(&pdata
->rtc
->irq_lock
, flags
);
256 * Clear all interrupts and release the IRQ
258 static void mxc_rtc_release(struct device
*dev
)
260 struct platform_device
*pdev
= to_platform_device(dev
);
261 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
262 void __iomem
*ioaddr
= pdata
->ioaddr
;
264 spin_lock_irq(&pdata
->rtc
->irq_lock
);
266 /* Disable all rtc interrupts */
267 writew(0, ioaddr
+ RTC_RTCIENR
);
269 /* Clear all interrupt status */
270 writew(0xffffffff, ioaddr
+ RTC_RTCISR
);
272 spin_unlock_irq(&pdata
->rtc
->irq_lock
);
275 static int mxc_rtc_alarm_irq_enable(struct device
*dev
, unsigned int enabled
)
277 mxc_rtc_irq_enable(dev
, RTC_ALM_BIT
, enabled
);
282 * This function reads the current RTC time into tm in Gregorian date.
284 static int mxc_rtc_read_time(struct device
*dev
, struct rtc_time
*tm
)
288 /* Avoid roll-over from reading the different registers */
290 val
= get_alarm_or_time(dev
, MXC_RTC_TIME
);
291 } while (val
!= get_alarm_or_time(dev
, MXC_RTC_TIME
));
293 rtc_time64_to_tm(val
, tm
);
299 * This function sets the internal RTC time based on tm in Gregorian date.
301 static int mxc_rtc_set_mmss(struct device
*dev
, time64_t time
)
303 struct platform_device
*pdev
= to_platform_device(dev
);
304 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
307 * TTC_DAYR register is 9-bit in MX1 SoC, save time and day of year only
309 if (is_imx1_rtc(pdata
)) {
312 rtc_time64_to_tm(time
, &tm
);
314 time
= rtc_tm_to_time64(&tm
);
317 /* Avoid roll-over from reading the different registers */
319 set_alarm_or_time(dev
, MXC_RTC_TIME
, time
);
320 } while (time
!= get_alarm_or_time(dev
, MXC_RTC_TIME
));
326 * This function reads the current alarm value into the passed in 'alrm'
327 * argument. It updates the alrm's pending field value based on the whether
328 * an alarm interrupt occurs or not.
330 static int mxc_rtc_read_alarm(struct device
*dev
, struct rtc_wkalrm
*alrm
)
332 struct platform_device
*pdev
= to_platform_device(dev
);
333 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
334 void __iomem
*ioaddr
= pdata
->ioaddr
;
336 rtc_time64_to_tm(get_alarm_or_time(dev
, MXC_RTC_ALARM
), &alrm
->time
);
337 alrm
->pending
= ((readw(ioaddr
+ RTC_RTCISR
) & RTC_ALM_BIT
)) ? 1 : 0;
343 * This function sets the RTC alarm based on passed in alrm.
345 static int mxc_rtc_set_alarm(struct device
*dev
, struct rtc_wkalrm
*alrm
)
347 struct platform_device
*pdev
= to_platform_device(dev
);
348 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
350 rtc_update_alarm(dev
, &alrm
->time
);
352 memcpy(&pdata
->g_rtc_alarm
, &alrm
->time
, sizeof(struct rtc_time
));
353 mxc_rtc_irq_enable(dev
, RTC_ALM_BIT
, alrm
->enabled
);
359 static struct rtc_class_ops mxc_rtc_ops
= {
360 .release
= mxc_rtc_release
,
361 .read_time
= mxc_rtc_read_time
,
362 .set_mmss64
= mxc_rtc_set_mmss
,
363 .read_alarm
= mxc_rtc_read_alarm
,
364 .set_alarm
= mxc_rtc_set_alarm
,
365 .alarm_irq_enable
= mxc_rtc_alarm_irq_enable
,
368 static int mxc_rtc_probe(struct platform_device
*pdev
)
370 struct resource
*res
;
371 struct rtc_device
*rtc
;
372 struct rtc_plat_data
*pdata
= NULL
;
376 const struct of_device_id
*of_id
;
378 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
382 of_id
= of_match_device(imx_rtc_dt_ids
, &pdev
->dev
);
384 pdata
->devtype
= (enum imx_rtc_type
)of_id
->data
;
386 pdata
->devtype
= pdev
->id_entry
->driver_data
;
388 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
389 pdata
->ioaddr
= devm_ioremap_resource(&pdev
->dev
, res
);
390 if (IS_ERR(pdata
->ioaddr
))
391 return PTR_ERR(pdata
->ioaddr
);
393 pdata
->clk_ipg
= devm_clk_get(&pdev
->dev
, "ipg");
394 if (IS_ERR(pdata
->clk_ipg
)) {
395 dev_err(&pdev
->dev
, "unable to get ipg clock!\n");
396 return PTR_ERR(pdata
->clk_ipg
);
399 ret
= clk_prepare_enable(pdata
->clk_ipg
);
403 pdata
->clk_ref
= devm_clk_get(&pdev
->dev
, "ref");
404 if (IS_ERR(pdata
->clk_ref
)) {
405 dev_err(&pdev
->dev
, "unable to get ref clock!\n");
406 ret
= PTR_ERR(pdata
->clk_ref
);
407 goto exit_put_clk_ipg
;
410 ret
= clk_prepare_enable(pdata
->clk_ref
);
412 goto exit_put_clk_ipg
;
414 rate
= clk_get_rate(pdata
->clk_ref
);
417 reg
= RTC_INPUT_CLK_32768HZ
;
418 else if (rate
== 32000)
419 reg
= RTC_INPUT_CLK_32000HZ
;
420 else if (rate
== 38400)
421 reg
= RTC_INPUT_CLK_38400HZ
;
423 dev_err(&pdev
->dev
, "rtc clock is not valid (%lu)\n", rate
);
425 goto exit_put_clk_ref
;
428 reg
|= RTC_ENABLE_BIT
;
429 writew(reg
, (pdata
->ioaddr
+ RTC_RTCCTL
));
430 if (((readw(pdata
->ioaddr
+ RTC_RTCCTL
)) & RTC_ENABLE_BIT
) == 0) {
431 dev_err(&pdev
->dev
, "hardware module can't be enabled!\n");
433 goto exit_put_clk_ref
;
436 platform_set_drvdata(pdev
, pdata
);
438 /* Configure and enable the RTC */
439 pdata
->irq
= platform_get_irq(pdev
, 0);
441 if (pdata
->irq
>= 0 &&
442 devm_request_irq(&pdev
->dev
, pdata
->irq
, mxc_rtc_interrupt
,
443 IRQF_SHARED
, pdev
->name
, pdev
) < 0) {
444 dev_warn(&pdev
->dev
, "interrupt not available.\n");
449 device_init_wakeup(&pdev
->dev
, 1);
451 rtc
= devm_rtc_device_register(&pdev
->dev
, pdev
->name
, &mxc_rtc_ops
,
455 goto exit_put_clk_ref
;
463 clk_disable_unprepare(pdata
->clk_ref
);
465 clk_disable_unprepare(pdata
->clk_ipg
);
470 static int mxc_rtc_remove(struct platform_device
*pdev
)
472 struct rtc_plat_data
*pdata
= platform_get_drvdata(pdev
);
474 clk_disable_unprepare(pdata
->clk_ref
);
475 clk_disable_unprepare(pdata
->clk_ipg
);
480 #ifdef CONFIG_PM_SLEEP
481 static int mxc_rtc_suspend(struct device
*dev
)
483 struct rtc_plat_data
*pdata
= dev_get_drvdata(dev
);
485 if (device_may_wakeup(dev
))
486 enable_irq_wake(pdata
->irq
);
491 static int mxc_rtc_resume(struct device
*dev
)
493 struct rtc_plat_data
*pdata
= dev_get_drvdata(dev
);
495 if (device_may_wakeup(dev
))
496 disable_irq_wake(pdata
->irq
);
502 static SIMPLE_DEV_PM_OPS(mxc_rtc_pm_ops
, mxc_rtc_suspend
, mxc_rtc_resume
);
504 static struct platform_driver mxc_rtc_driver
= {
507 .of_match_table
= of_match_ptr(imx_rtc_dt_ids
),
508 .pm
= &mxc_rtc_pm_ops
,
510 .id_table
= imx_rtc_devtype
,
511 .probe
= mxc_rtc_probe
,
512 .remove
= mxc_rtc_remove
,
515 module_platform_driver(mxc_rtc_driver
)
517 MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
518 MODULE_DESCRIPTION("RTC driver for Freescale MXC");
519 MODULE_LICENSE("GPL");