1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * rtc-twl.c -- TWL Real Time Clock interface
5 * Copyright (C) 2007 MontaVista Software, Inc
6 * Author: Alexandre Rusev <source@mvista.com>
8 * Based on original TI driver twl4030-rtc.c
9 * Copyright (C) 2006 Texas Instruments, Inc.
12 * Copyright (C) 2003 MontaVista Software, Inc.
13 * Author: George G. Davis <gdavis@mvista.com> or <source@mvista.com>
14 * Copyright (C) 2006 David Brownell
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/kernel.h>
20 #include <linux/errno.h>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/rtc.h>
25 #include <linux/bcd.h>
26 #include <linux/platform_device.h>
27 #include <linux/interrupt.h>
30 #include <linux/mfd/twl.h>
38 * RTC block register offsets (use TWL_MODULE_RTC)
49 REG_ALARM_SECONDS_REG,
50 REG_ALARM_MINUTES_REG,
58 REG_RTC_INTERRUPTS_REG,
63 static const u8 twl4030_rtc_reg_map[] = {
64 [REG_SECONDS_REG] = 0x00,
65 [REG_MINUTES_REG] = 0x01,
66 [REG_HOURS_REG] = 0x02,
67 [REG_DAYS_REG] = 0x03,
68 [REG_MONTHS_REG] = 0x04,
69 [REG_YEARS_REG] = 0x05,
70 [REG_WEEKS_REG] = 0x06,
72 [REG_ALARM_SECONDS_REG] = 0x07,
73 [REG_ALARM_MINUTES_REG] = 0x08,
74 [REG_ALARM_HOURS_REG] = 0x09,
75 [REG_ALARM_DAYS_REG] = 0x0A,
76 [REG_ALARM_MONTHS_REG] = 0x0B,
77 [REG_ALARM_YEARS_REG] = 0x0C,
79 [REG_RTC_CTRL_REG] = 0x0D,
80 [REG_RTC_STATUS_REG] = 0x0E,
81 [REG_RTC_INTERRUPTS_REG] = 0x0F,
83 [REG_RTC_COMP_LSB_REG] = 0x10,
84 [REG_RTC_COMP_MSB_REG] = 0x11,
86 static const u8 twl6030_rtc_reg_map[] = {
87 [REG_SECONDS_REG] = 0x00,
88 [REG_MINUTES_REG] = 0x01,
89 [REG_HOURS_REG] = 0x02,
90 [REG_DAYS_REG] = 0x03,
91 [REG_MONTHS_REG] = 0x04,
92 [REG_YEARS_REG] = 0x05,
93 [REG_WEEKS_REG] = 0x06,
95 [REG_ALARM_SECONDS_REG] = 0x08,
96 [REG_ALARM_MINUTES_REG] = 0x09,
97 [REG_ALARM_HOURS_REG] = 0x0A,
98 [REG_ALARM_DAYS_REG] = 0x0B,
99 [REG_ALARM_MONTHS_REG] = 0x0C,
100 [REG_ALARM_YEARS_REG] = 0x0D,
102 [REG_RTC_CTRL_REG] = 0x10,
103 [REG_RTC_STATUS_REG] = 0x11,
104 [REG_RTC_INTERRUPTS_REG] = 0x12,
106 [REG_RTC_COMP_LSB_REG] = 0x13,
107 [REG_RTC_COMP_MSB_REG] = 0x14,
110 /* RTC_CTRL_REG bitfields */
111 #define BIT_RTC_CTRL_REG_STOP_RTC_M 0x01
112 #define BIT_RTC_CTRL_REG_ROUND_30S_M 0x02
113 #define BIT_RTC_CTRL_REG_AUTO_COMP_M 0x04
114 #define BIT_RTC_CTRL_REG_MODE_12_24_M 0x08
115 #define BIT_RTC_CTRL_REG_TEST_MODE_M 0x10
116 #define BIT_RTC_CTRL_REG_SET_32_COUNTER_M 0x20
117 #define BIT_RTC_CTRL_REG_GET_TIME_M 0x40
118 #define BIT_RTC_CTRL_REG_RTC_V_OPT 0x80
120 /* RTC_STATUS_REG bitfields */
121 #define BIT_RTC_STATUS_REG_RUN_M 0x02
122 #define BIT_RTC_STATUS_REG_1S_EVENT_M 0x04
123 #define BIT_RTC_STATUS_REG_1M_EVENT_M 0x08
124 #define BIT_RTC_STATUS_REG_1H_EVENT_M 0x10
125 #define BIT_RTC_STATUS_REG_1D_EVENT_M 0x20
126 #define BIT_RTC_STATUS_REG_ALARM_M 0x40
127 #define BIT_RTC_STATUS_REG_POWER_UP_M 0x80
129 /* RTC_INTERRUPTS_REG bitfields */
130 #define BIT_RTC_INTERRUPTS_REG_EVERY_M 0x03
131 #define BIT_RTC_INTERRUPTS_REG_IT_TIMER_M 0x04
132 #define BIT_RTC_INTERRUPTS_REG_IT_ALARM_M 0x08
135 /* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
136 #define ALL_TIME_REGS 6
138 /*----------------------------------------------------------------------*/
141 struct rtc_device *rtc;
144 * Cache the value for timer/alarm interrupts register; this is
145 * only changed by callers holding rtc ops lock (or resume).
147 unsigned char rtc_irq_bits;
149 #ifdef CONFIG_PM_SLEEP
150 unsigned char irqstat;
152 enum twl_class class;
156 * Supports 1 byte read from TWL RTC register.
158 static int twl_rtc_read_u8(struct twl_rtc *twl_rtc, u8 *data, u8 reg)
162 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
164 pr_err("Could not read TWL register %X - error %d\n", reg, ret);
169 * Supports 1 byte write to TWL RTC registers.
171 static int twl_rtc_write_u8(struct twl_rtc *twl_rtc, u8 data, u8 reg)
175 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
177 pr_err("Could not write TWL register %X - error %d\n",
183 * Enable 1/second update and/or alarm interrupts.
185 static int set_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
190 /* if the bit is set, return from here */
191 if (twl_rtc->rtc_irq_bits & bit)
194 val = twl_rtc->rtc_irq_bits | bit;
195 val &= ~BIT_RTC_INTERRUPTS_REG_EVERY_M;
196 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
198 twl_rtc->rtc_irq_bits = val;
204 * Disable update and/or alarm interrupts.
206 static int mask_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
211 /* if the bit is clear, return from here */
212 if (!(twl_rtc->rtc_irq_bits & bit))
215 val = twl_rtc->rtc_irq_bits & ~bit;
216 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
218 twl_rtc->rtc_irq_bits = val;
223 static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
225 struct platform_device *pdev = to_platform_device(dev);
226 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
227 int irq = platform_get_irq(pdev, 0);
231 ret = set_rtc_irq_bit(twl_rtc,
232 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
233 if (device_can_wakeup(dev) && !twl_rtc->wake_enabled) {
234 enable_irq_wake(irq);
235 twl_rtc->wake_enabled = true;
238 ret = mask_rtc_irq_bit(twl_rtc,
239 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
240 if (twl_rtc->wake_enabled) {
241 disable_irq_wake(irq);
242 twl_rtc->wake_enabled = false;
250 * Gets current TWL RTC time and date parameters.
252 * The RTC's time/alarm representation is not what gmtime(3) requires
255 * - Months are 1..12 vs Linux 0-11
256 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
258 static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
260 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
261 unsigned char rtc_data[ALL_TIME_REGS];
266 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
268 dev_err(dev, "%s: reading CTRL_REG, error %d\n", __func__, ret);
271 /* for twl6030/32 make sure BIT_RTC_CTRL_REG_GET_TIME_M is clear */
272 if (twl_rtc->class == TWL_6030) {
273 if (save_control & BIT_RTC_CTRL_REG_GET_TIME_M) {
274 save_control &= ~BIT_RTC_CTRL_REG_GET_TIME_M;
275 ret = twl_rtc_write_u8(twl_rtc, save_control,
278 dev_err(dev, "%s clr GET_TIME, error %d\n",
285 /* Copy RTC counting registers to static registers or latches */
286 rtc_control = save_control | BIT_RTC_CTRL_REG_GET_TIME_M;
288 /* for twl6030/32 enable read access to static shadowed registers */
289 if (twl_rtc->class == TWL_6030)
290 rtc_control |= BIT_RTC_CTRL_REG_RTC_V_OPT;
292 ret = twl_rtc_write_u8(twl_rtc, rtc_control, REG_RTC_CTRL_REG);
294 dev_err(dev, "%s: writing CTRL_REG, error %d\n", __func__, ret);
298 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
299 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
302 dev_err(dev, "%s: reading data, error %d\n", __func__, ret);
306 /* for twl6030 restore original state of rtc control register */
307 if (twl_rtc->class == TWL_6030) {
308 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
310 dev_err(dev, "%s: restore CTRL_REG, error %d\n",
316 tm->tm_sec = bcd2bin(rtc_data[0]);
317 tm->tm_min = bcd2bin(rtc_data[1]);
318 tm->tm_hour = bcd2bin(rtc_data[2]);
319 tm->tm_mday = bcd2bin(rtc_data[3]);
320 tm->tm_mon = bcd2bin(rtc_data[4]) - 1;
321 tm->tm_year = bcd2bin(rtc_data[5]) + 100;
326 static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
328 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
329 unsigned char save_control;
330 unsigned char rtc_data[ALL_TIME_REGS];
333 rtc_data[0] = bin2bcd(tm->tm_sec);
334 rtc_data[1] = bin2bcd(tm->tm_min);
335 rtc_data[2] = bin2bcd(tm->tm_hour);
336 rtc_data[3] = bin2bcd(tm->tm_mday);
337 rtc_data[4] = bin2bcd(tm->tm_mon + 1);
338 rtc_data[5] = bin2bcd(tm->tm_year - 100);
340 /* Stop RTC while updating the TC registers */
341 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
345 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
346 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
350 /* update all the time registers in one shot */
351 ret = twl_i2c_write(TWL_MODULE_RTC, rtc_data,
352 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
354 dev_err(dev, "rtc_set_time error %d\n", ret);
359 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
360 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
367 * Gets current TWL RTC alarm time.
369 static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
371 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
372 unsigned char rtc_data[ALL_TIME_REGS];
375 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
376 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
378 dev_err(dev, "rtc_read_alarm error %d\n", ret);
382 /* some of these fields may be wildcard/"match all" */
383 alm->time.tm_sec = bcd2bin(rtc_data[0]);
384 alm->time.tm_min = bcd2bin(rtc_data[1]);
385 alm->time.tm_hour = bcd2bin(rtc_data[2]);
386 alm->time.tm_mday = bcd2bin(rtc_data[3]);
387 alm->time.tm_mon = bcd2bin(rtc_data[4]) - 1;
388 alm->time.tm_year = bcd2bin(rtc_data[5]) + 100;
390 /* report cached alarm enable state */
391 if (twl_rtc->rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
397 static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
399 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
401 unsigned char alarm_data[ALL_TIME_REGS];
404 ret = twl_rtc_alarm_irq_enable(dev, 0);
408 alarm_data[0] = bin2bcd(alm->time.tm_sec);
409 alarm_data[1] = bin2bcd(alm->time.tm_min);
410 alarm_data[2] = bin2bcd(alm->time.tm_hour);
411 alarm_data[3] = bin2bcd(alm->time.tm_mday);
412 alarm_data[4] = bin2bcd(alm->time.tm_mon + 1);
413 alarm_data[5] = bin2bcd(alm->time.tm_year - 100);
415 /* update all the alarm registers in one shot */
416 ret = twl_i2c_write(TWL_MODULE_RTC, alarm_data,
417 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
419 dev_err(dev, "rtc_set_alarm error %d\n", ret);
424 ret = twl_rtc_alarm_irq_enable(dev, 1);
429 static irqreturn_t twl_rtc_interrupt(int irq, void *data)
431 struct twl_rtc *twl_rtc = data;
432 unsigned long events;
437 res = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
441 * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
442 * only one (ALARM or RTC) interrupt source may be enabled
443 * at time, we also could check our results
444 * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
446 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
447 events = RTC_IRQF | RTC_AF;
449 events = RTC_IRQF | RTC_PF;
451 res = twl_rtc_write_u8(twl_rtc, BIT_RTC_STATUS_REG_ALARM_M,
456 if (twl_rtc->class == TWL_4030) {
457 /* Clear on Read enabled. RTC_IT bit of TWL4030_INT_PWR_ISR1
458 * needs 2 reads to clear the interrupt. One read is done in
459 * do_twl_pwrirq(). Doing the second read, to clear
462 * FIXME the reason PWR_ISR1 needs an extra read is that
463 * RTC_IF retriggered until we cleared REG_ALARM_M above.
464 * But re-reading like this is a bad hack; by doing so we
465 * risk wrongly clearing status for some other IRQ (losing
466 * the interrupt). Be smarter about handling RTC_UF ...
468 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
469 &rd_reg, TWL4030_INT_PWR_ISR1);
474 /* Notify RTC core on event */
475 rtc_update_irq(twl_rtc->rtc, 1, events);
482 static const struct rtc_class_ops twl_rtc_ops = {
483 .read_time = twl_rtc_read_time,
484 .set_time = twl_rtc_set_time,
485 .read_alarm = twl_rtc_read_alarm,
486 .set_alarm = twl_rtc_set_alarm,
487 .alarm_irq_enable = twl_rtc_alarm_irq_enable,
490 /*----------------------------------------------------------------------*/
492 static int twl_rtc_probe(struct platform_device *pdev)
494 struct twl_rtc *twl_rtc;
495 struct device_node *np = pdev->dev.of_node;
497 int irq = platform_get_irq(pdev, 0);
501 dev_err(&pdev->dev, "no DT info\n");
508 twl_rtc = devm_kzalloc(&pdev->dev, sizeof(*twl_rtc), GFP_KERNEL);
512 if (twl_class_is_4030()) {
513 twl_rtc->class = TWL_4030;
514 twl_rtc->reg_map = (u8 *)twl4030_rtc_reg_map;
515 } else if (twl_class_is_6030()) {
516 twl_rtc->class = TWL_6030;
517 twl_rtc->reg_map = (u8 *)twl6030_rtc_reg_map;
519 dev_err(&pdev->dev, "TWL Class not supported.\n");
523 ret = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
527 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
528 dev_warn(&pdev->dev, "Power up reset detected.\n");
530 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
531 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
533 /* Clear RTC Power up reset and pending alarm interrupts */
534 ret = twl_rtc_write_u8(twl_rtc, rd_reg, REG_RTC_STATUS_REG);
538 if (twl_rtc->class == TWL_6030) {
539 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
541 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
545 dev_info(&pdev->dev, "Enabling TWL-RTC\n");
546 ret = twl_rtc_write_u8(twl_rtc, BIT_RTC_CTRL_REG_STOP_RTC_M,
551 /* ensure interrupts are disabled, bootloaders can be strange */
552 ret = twl_rtc_write_u8(twl_rtc, 0, REG_RTC_INTERRUPTS_REG);
554 dev_warn(&pdev->dev, "unable to disable interrupt\n");
556 /* init cached IRQ enable bits */
557 ret = twl_rtc_read_u8(twl_rtc, &twl_rtc->rtc_irq_bits,
558 REG_RTC_INTERRUPTS_REG);
562 platform_set_drvdata(pdev, twl_rtc);
563 device_init_wakeup(&pdev->dev, 1);
565 twl_rtc->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
566 &twl_rtc_ops, THIS_MODULE);
567 if (IS_ERR(twl_rtc->rtc)) {
568 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
569 PTR_ERR(twl_rtc->rtc));
570 return PTR_ERR(twl_rtc->rtc);
573 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
575 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
576 dev_name(&twl_rtc->rtc->dev), twl_rtc);
578 dev_err(&pdev->dev, "IRQ is not free.\n");
586 * Disable all TWL RTC module interrupts.
587 * Sets status flag to free.
589 static int twl_rtc_remove(struct platform_device *pdev)
591 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
593 /* leave rtc running, but disable irqs */
594 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
595 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
596 if (twl_rtc->class == TWL_6030) {
597 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
599 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
606 static void twl_rtc_shutdown(struct platform_device *pdev)
608 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
610 /* mask timer interrupts, but leave alarm interrupts on to enable
611 power-on when alarm is triggered */
612 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
615 #ifdef CONFIG_PM_SLEEP
616 static int twl_rtc_suspend(struct device *dev)
618 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
620 twl_rtc->irqstat = twl_rtc->rtc_irq_bits;
622 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
626 static int twl_rtc_resume(struct device *dev)
628 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
630 set_rtc_irq_bit(twl_rtc, twl_rtc->irqstat);
635 static SIMPLE_DEV_PM_OPS(twl_rtc_pm_ops, twl_rtc_suspend, twl_rtc_resume);
637 static const struct of_device_id twl_rtc_of_match[] = {
638 {.compatible = "ti,twl4030-rtc", },
641 MODULE_DEVICE_TABLE(of, twl_rtc_of_match);
643 static struct platform_driver twl4030rtc_driver = {
644 .probe = twl_rtc_probe,
645 .remove = twl_rtc_remove,
646 .shutdown = twl_rtc_shutdown,
649 .pm = &twl_rtc_pm_ops,
650 .of_match_table = twl_rtc_of_match,
654 module_platform_driver(twl4030rtc_driver);
656 MODULE_AUTHOR("Texas Instruments, MontaVista Software");
657 MODULE_LICENSE("GPL");