Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * rtc-twl.c -- TWL Real Time Clock interface
4 *
5 * Copyright (C) 2007 MontaVista Software, Inc
6 * Author: Alexandre Rusev <source@mvista.com>
7 *
8 * Based on original TI driver twl4030-rtc.c
9 * Copyright (C) 2006 Texas Instruments, Inc.
10 *
11 * Based on rtc-omap.c
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
15 */
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
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>
28#include <linux/of.h>
29
30#include <linux/mfd/twl.h>
31
32enum twl_class {
33 TWL_4030 = 0,
34 TWL_6030,
35};
36
37/*
38 * RTC block register offsets (use TWL_MODULE_RTC)
39 */
40enum {
41 REG_SECONDS_REG = 0,
42 REG_MINUTES_REG,
43 REG_HOURS_REG,
44 REG_DAYS_REG,
45 REG_MONTHS_REG,
46 REG_YEARS_REG,
47 REG_WEEKS_REG,
48
49 REG_ALARM_SECONDS_REG,
50 REG_ALARM_MINUTES_REG,
51 REG_ALARM_HOURS_REG,
52 REG_ALARM_DAYS_REG,
53 REG_ALARM_MONTHS_REG,
54 REG_ALARM_YEARS_REG,
55
56 REG_RTC_CTRL_REG,
57 REG_RTC_STATUS_REG,
58 REG_RTC_INTERRUPTS_REG,
59
60 REG_RTC_COMP_LSB_REG,
61 REG_RTC_COMP_MSB_REG,
62};
63static 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,
71
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,
78
79 [REG_RTC_CTRL_REG] = 0x0D,
80 [REG_RTC_STATUS_REG] = 0x0E,
81 [REG_RTC_INTERRUPTS_REG] = 0x0F,
82
83 [REG_RTC_COMP_LSB_REG] = 0x10,
84 [REG_RTC_COMP_MSB_REG] = 0x11,
85};
86static 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,
94
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,
101
102 [REG_RTC_CTRL_REG] = 0x10,
103 [REG_RTC_STATUS_REG] = 0x11,
104 [REG_RTC_INTERRUPTS_REG] = 0x12,
105
106 [REG_RTC_COMP_LSB_REG] = 0x13,
107 [REG_RTC_COMP_MSB_REG] = 0x14,
108};
109
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
119
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
128
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
133
134
135/* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
136#define ALL_TIME_REGS 6
137
138/*----------------------------------------------------------------------*/
139struct twl_rtc {
140 struct device *dev;
141 struct rtc_device *rtc;
142 u8 *reg_map;
143 /*
144 * Cache the value for timer/alarm interrupts register; this is
145 * only changed by callers holding rtc ops lock (or resume).
146 */
147 unsigned char rtc_irq_bits;
148 bool wake_enabled;
149#ifdef CONFIG_PM_SLEEP
150 unsigned char irqstat;
151#endif
152 enum twl_class class;
153};
154
155/*
156 * Supports 1 byte read from TWL RTC register.
157 */
158static int twl_rtc_read_u8(struct twl_rtc *twl_rtc, u8 *data, u8 reg)
159{
160 int ret;
161
162 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
163 if (ret < 0)
164 pr_err("Could not read TWL register %X - error %d\n", reg, ret);
165 return ret;
166}
167
168/*
169 * Supports 1 byte write to TWL RTC registers.
170 */
171static int twl_rtc_write_u8(struct twl_rtc *twl_rtc, u8 data, u8 reg)
172{
173 int ret;
174
175 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
176 if (ret < 0)
177 pr_err("Could not write TWL register %X - error %d\n",
178 reg, ret);
179 return ret;
180}
181
182/*
183 * Enable 1/second update and/or alarm interrupts.
184 */
185static int set_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
186{
187 unsigned char val;
188 int ret;
189
190 /* if the bit is set, return from here */
191 if (twl_rtc->rtc_irq_bits & bit)
192 return 0;
193
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);
197 if (ret == 0)
198 twl_rtc->rtc_irq_bits = val;
199
200 return ret;
201}
202
203/*
204 * Disable update and/or alarm interrupts.
205 */
206static int mask_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
207{
208 unsigned char val;
209 int ret;
210
211 /* if the bit is clear, return from here */
212 if (!(twl_rtc->rtc_irq_bits & bit))
213 return 0;
214
215 val = twl_rtc->rtc_irq_bits & ~bit;
216 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
217 if (ret == 0)
218 twl_rtc->rtc_irq_bits = val;
219
220 return ret;
221}
222
223static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
224{
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);
228 int ret;
229
230 if (enabled) {
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;
236 }
237 } else {
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;
243 }
244 }
245
246 return ret;
247}
248
249/*
250 * Gets current TWL RTC time and date parameters.
251 *
252 * The RTC's time/alarm representation is not what gmtime(3) requires
253 * Linux to use:
254 *
255 * - Months are 1..12 vs Linux 0-11
256 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
257 */
258static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
259{
260 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
261 unsigned char rtc_data[ALL_TIME_REGS];
262 int ret;
263 u8 save_control;
264 u8 rtc_control;
265
266 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
267 if (ret < 0) {
268 dev_err(dev, "%s: reading CTRL_REG, error %d\n", __func__, ret);
269 return ret;
270 }
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,
276 REG_RTC_CTRL_REG);
277 if (ret < 0) {
278 dev_err(dev, "%s clr GET_TIME, error %d\n",
279 __func__, ret);
280 return ret;
281 }
282 }
283 }
284
285 /* Copy RTC counting registers to static registers or latches */
286 rtc_control = save_control | BIT_RTC_CTRL_REG_GET_TIME_M;
287
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;
291
292 ret = twl_rtc_write_u8(twl_rtc, rtc_control, REG_RTC_CTRL_REG);
293 if (ret < 0) {
294 dev_err(dev, "%s: writing CTRL_REG, error %d\n", __func__, ret);
295 return ret;
296 }
297
298 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
299 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
300
301 if (ret < 0) {
302 dev_err(dev, "%s: reading data, error %d\n", __func__, ret);
303 return ret;
304 }
305
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);
309 if (ret < 0) {
310 dev_err(dev, "%s: restore CTRL_REG, error %d\n",
311 __func__, ret);
312 return ret;
313 }
314 }
315
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;
322
323 return ret;
324}
325
326static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
327{
328 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
329 unsigned char save_control;
330 unsigned char rtc_data[ALL_TIME_REGS];
331 int ret;
332
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);
339
340 /* Stop RTC while updating the TC registers */
341 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
342 if (ret < 0)
343 goto out;
344
345 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
346 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
347 if (ret < 0)
348 goto out;
349
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);
353 if (ret < 0) {
354 dev_err(dev, "rtc_set_time error %d\n", ret);
355 goto out;
356 }
357
358 /* Start back RTC */
359 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
360 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
361
362out:
363 return ret;
364}
365
366/*
367 * Gets current TWL RTC alarm time.
368 */
369static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
370{
371 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
372 unsigned char rtc_data[ALL_TIME_REGS];
373 int ret;
374
375 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
376 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
377 if (ret < 0) {
378 dev_err(dev, "rtc_read_alarm error %d\n", ret);
379 return ret;
380 }
381
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;
389
390 /* report cached alarm enable state */
391 if (twl_rtc->rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
392 alm->enabled = 1;
393
394 return ret;
395}
396
397static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
398{
399 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
400
401 unsigned char alarm_data[ALL_TIME_REGS];
402 int ret;
403
404 ret = twl_rtc_alarm_irq_enable(dev, 0);
405 if (ret)
406 goto out;
407
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);
414
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);
418 if (ret) {
419 dev_err(dev, "rtc_set_alarm error %d\n", ret);
420 goto out;
421 }
422
423 if (alm->enabled)
424 ret = twl_rtc_alarm_irq_enable(dev, 1);
425out:
426 return ret;
427}
428
429static irqreturn_t twl_rtc_interrupt(int irq, void *data)
430{
431 struct twl_rtc *twl_rtc = data;
432 unsigned long events;
433 int ret = IRQ_NONE;
434 int res;
435 u8 rd_reg;
436
437 res = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
438 if (res)
439 goto out;
440 /*
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]
445 */
446 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
447 events = RTC_IRQF | RTC_AF;
448 else
449 events = RTC_IRQF | RTC_PF;
450
451 res = twl_rtc_write_u8(twl_rtc, BIT_RTC_STATUS_REG_ALARM_M,
452 REG_RTC_STATUS_REG);
453 if (res)
454 goto out;
455
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
460 * the bit.
461 *
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 ...
467 */
468 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
469 &rd_reg, TWL4030_INT_PWR_ISR1);
470 if (res)
471 goto out;
472 }
473
474 /* Notify RTC core on event */
475 rtc_update_irq(twl_rtc->rtc, 1, events);
476
477 ret = IRQ_HANDLED;
478out:
479 return ret;
480}
481
482static 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,
488};
489
490static int twl_nvram_read(void *priv, unsigned int offset, void *val,
491 size_t bytes)
492{
493 return twl_i2c_read((long)priv, val, offset, bytes);
494}
495
496static int twl_nvram_write(void *priv, unsigned int offset, void *val,
497 size_t bytes)
498{
499 return twl_i2c_write((long)priv, val, offset, bytes);
500}
501
502/*----------------------------------------------------------------------*/
503
504static int twl_rtc_probe(struct platform_device *pdev)
505{
506 struct twl_rtc *twl_rtc;
507 struct nvmem_config nvmem_cfg;
508 struct device_node *np = pdev->dev.of_node;
509 int ret = -EINVAL;
510 int irq = platform_get_irq(pdev, 0);
511 u8 rd_reg;
512
513 if (!np) {
514 dev_err(&pdev->dev, "no DT info\n");
515 return -EINVAL;
516 }
517
518 if (irq <= 0)
519 return ret;
520
521 twl_rtc = devm_kzalloc(&pdev->dev, sizeof(*twl_rtc), GFP_KERNEL);
522 if (!twl_rtc)
523 return -ENOMEM;
524
525 if (twl_class_is_4030()) {
526 twl_rtc->class = TWL_4030;
527 twl_rtc->reg_map = (u8 *)twl4030_rtc_reg_map;
528 } else if (twl_class_is_6030()) {
529 twl_rtc->class = TWL_6030;
530 twl_rtc->reg_map = (u8 *)twl6030_rtc_reg_map;
531 } else {
532 dev_err(&pdev->dev, "TWL Class not supported.\n");
533 return -EINVAL;
534 }
535
536 ret = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
537 if (ret < 0)
538 return ret;
539
540 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
541 dev_warn(&pdev->dev, "Power up reset detected.\n");
542
543 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
544 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
545
546 /* Clear RTC Power up reset and pending alarm interrupts */
547 ret = twl_rtc_write_u8(twl_rtc, rd_reg, REG_RTC_STATUS_REG);
548 if (ret < 0)
549 return ret;
550
551 if (twl_rtc->class == TWL_6030) {
552 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
553 REG_INT_MSK_LINE_A);
554 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
555 REG_INT_MSK_STS_A);
556 }
557
558 ret = twl_rtc_write_u8(twl_rtc, BIT_RTC_CTRL_REG_STOP_RTC_M,
559 REG_RTC_CTRL_REG);
560 if (ret < 0)
561 return ret;
562
563 /* ensure interrupts are disabled, bootloaders can be strange */
564 ret = twl_rtc_write_u8(twl_rtc, 0, REG_RTC_INTERRUPTS_REG);
565 if (ret < 0)
566 dev_warn(&pdev->dev, "unable to disable interrupt\n");
567
568 /* init cached IRQ enable bits */
569 ret = twl_rtc_read_u8(twl_rtc, &twl_rtc->rtc_irq_bits,
570 REG_RTC_INTERRUPTS_REG);
571 if (ret < 0)
572 return ret;
573
574 platform_set_drvdata(pdev, twl_rtc);
575 device_init_wakeup(&pdev->dev, 1);
576
577 twl_rtc->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
578 &twl_rtc_ops, THIS_MODULE);
579 if (IS_ERR(twl_rtc->rtc))
580 return PTR_ERR(twl_rtc->rtc);
581
582 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
583 twl_rtc_interrupt,
584 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
585 dev_name(&twl_rtc->rtc->dev), twl_rtc);
586 if (ret < 0) {
587 dev_err(&pdev->dev, "IRQ is not free.\n");
588 return ret;
589 }
590
591 memset(&nvmem_cfg, 0, sizeof(nvmem_cfg));
592 nvmem_cfg.name = "twl-secured-";
593 nvmem_cfg.type = NVMEM_TYPE_BATTERY_BACKED;
594 nvmem_cfg.reg_read = twl_nvram_read;
595 nvmem_cfg.reg_write = twl_nvram_write;
596 nvmem_cfg.word_size = 1;
597 nvmem_cfg.stride = 1;
598 if (twl_class_is_4030()) {
599 /* 20 bytes SECURED_REG area */
600 nvmem_cfg.size = 20;
601 nvmem_cfg.priv = (void *)TWL_MODULE_SECURED_REG;
602 devm_rtc_nvmem_register(twl_rtc->rtc, &nvmem_cfg);
603 /* 8 bytes BACKUP area */
604 nvmem_cfg.name = "twl-backup-";
605 nvmem_cfg.size = 8;
606 nvmem_cfg.priv = (void *)TWL4030_MODULE_BACKUP;
607 devm_rtc_nvmem_register(twl_rtc->rtc, &nvmem_cfg);
608 } else {
609 /* 8 bytes SECURED_REG area */
610 nvmem_cfg.size = 8;
611 nvmem_cfg.priv = (void *)TWL_MODULE_SECURED_REG;
612 devm_rtc_nvmem_register(twl_rtc->rtc, &nvmem_cfg);
613 }
614
615 return 0;
616}
617
618/*
619 * Disable all TWL RTC module interrupts.
620 * Sets status flag to free.
621 */
622static void twl_rtc_remove(struct platform_device *pdev)
623{
624 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
625
626 /* leave rtc running, but disable irqs */
627 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
628 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
629 if (twl_rtc->class == TWL_6030) {
630 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
631 REG_INT_MSK_LINE_A);
632 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
633 REG_INT_MSK_STS_A);
634 }
635}
636
637static void twl_rtc_shutdown(struct platform_device *pdev)
638{
639 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
640
641 /* mask timer interrupts, but leave alarm interrupts on to enable
642 power-on when alarm is triggered */
643 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
644}
645
646#ifdef CONFIG_PM_SLEEP
647static int twl_rtc_suspend(struct device *dev)
648{
649 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
650
651 twl_rtc->irqstat = twl_rtc->rtc_irq_bits;
652
653 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
654 return 0;
655}
656
657static int twl_rtc_resume(struct device *dev)
658{
659 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
660
661 set_rtc_irq_bit(twl_rtc, twl_rtc->irqstat);
662 return 0;
663}
664#endif
665
666static SIMPLE_DEV_PM_OPS(twl_rtc_pm_ops, twl_rtc_suspend, twl_rtc_resume);
667
668static const struct of_device_id twl_rtc_of_match[] = {
669 {.compatible = "ti,twl4030-rtc", },
670 { },
671};
672MODULE_DEVICE_TABLE(of, twl_rtc_of_match);
673
674static struct platform_driver twl4030rtc_driver = {
675 .probe = twl_rtc_probe,
676 .remove = twl_rtc_remove,
677 .shutdown = twl_rtc_shutdown,
678 .driver = {
679 .name = "twl_rtc",
680 .pm = &twl_rtc_pm_ops,
681 .of_match_table = twl_rtc_of_match,
682 },
683};
684
685module_platform_driver(twl4030rtc_driver);
686
687MODULE_AUTHOR("Texas Instruments, MontaVista Software");
688MODULE_DESCRIPTION("TI TWL4030/TWL5030/TWL6030/TPS659x0 RTC driver");
689MODULE_LICENSE("GPL");
1/*
2 * rtc-twl.c -- TWL Real Time Clock interface
3 *
4 * Copyright (C) 2007 MontaVista Software, Inc
5 * Author: Alexandre Rusev <source@mvista.com>
6 *
7 * Based on original TI driver twl4030-rtc.c
8 * Copyright (C) 2006 Texas Instruments, Inc.
9 *
10 * Based on rtc-omap.c
11 * Copyright (C) 2003 MontaVista Software, Inc.
12 * Author: George G. Davis <gdavis@mvista.com> or <source@mvista.com>
13 * Copyright (C) 2006 David Brownell
14 *
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
19 */
20
21#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
23#include <linux/kernel.h>
24#include <linux/errno.h>
25#include <linux/init.h>
26#include <linux/module.h>
27#include <linux/types.h>
28#include <linux/rtc.h>
29#include <linux/bcd.h>
30#include <linux/platform_device.h>
31#include <linux/interrupt.h>
32#include <linux/of.h>
33
34#include <linux/i2c/twl.h>
35
36enum twl_class {
37 TWL_4030 = 0,
38 TWL_6030,
39};
40
41/*
42 * RTC block register offsets (use TWL_MODULE_RTC)
43 */
44enum {
45 REG_SECONDS_REG = 0,
46 REG_MINUTES_REG,
47 REG_HOURS_REG,
48 REG_DAYS_REG,
49 REG_MONTHS_REG,
50 REG_YEARS_REG,
51 REG_WEEKS_REG,
52
53 REG_ALARM_SECONDS_REG,
54 REG_ALARM_MINUTES_REG,
55 REG_ALARM_HOURS_REG,
56 REG_ALARM_DAYS_REG,
57 REG_ALARM_MONTHS_REG,
58 REG_ALARM_YEARS_REG,
59
60 REG_RTC_CTRL_REG,
61 REG_RTC_STATUS_REG,
62 REG_RTC_INTERRUPTS_REG,
63
64 REG_RTC_COMP_LSB_REG,
65 REG_RTC_COMP_MSB_REG,
66};
67static const u8 twl4030_rtc_reg_map[] = {
68 [REG_SECONDS_REG] = 0x00,
69 [REG_MINUTES_REG] = 0x01,
70 [REG_HOURS_REG] = 0x02,
71 [REG_DAYS_REG] = 0x03,
72 [REG_MONTHS_REG] = 0x04,
73 [REG_YEARS_REG] = 0x05,
74 [REG_WEEKS_REG] = 0x06,
75
76 [REG_ALARM_SECONDS_REG] = 0x07,
77 [REG_ALARM_MINUTES_REG] = 0x08,
78 [REG_ALARM_HOURS_REG] = 0x09,
79 [REG_ALARM_DAYS_REG] = 0x0A,
80 [REG_ALARM_MONTHS_REG] = 0x0B,
81 [REG_ALARM_YEARS_REG] = 0x0C,
82
83 [REG_RTC_CTRL_REG] = 0x0D,
84 [REG_RTC_STATUS_REG] = 0x0E,
85 [REG_RTC_INTERRUPTS_REG] = 0x0F,
86
87 [REG_RTC_COMP_LSB_REG] = 0x10,
88 [REG_RTC_COMP_MSB_REG] = 0x11,
89};
90static const u8 twl6030_rtc_reg_map[] = {
91 [REG_SECONDS_REG] = 0x00,
92 [REG_MINUTES_REG] = 0x01,
93 [REG_HOURS_REG] = 0x02,
94 [REG_DAYS_REG] = 0x03,
95 [REG_MONTHS_REG] = 0x04,
96 [REG_YEARS_REG] = 0x05,
97 [REG_WEEKS_REG] = 0x06,
98
99 [REG_ALARM_SECONDS_REG] = 0x08,
100 [REG_ALARM_MINUTES_REG] = 0x09,
101 [REG_ALARM_HOURS_REG] = 0x0A,
102 [REG_ALARM_DAYS_REG] = 0x0B,
103 [REG_ALARM_MONTHS_REG] = 0x0C,
104 [REG_ALARM_YEARS_REG] = 0x0D,
105
106 [REG_RTC_CTRL_REG] = 0x10,
107 [REG_RTC_STATUS_REG] = 0x11,
108 [REG_RTC_INTERRUPTS_REG] = 0x12,
109
110 [REG_RTC_COMP_LSB_REG] = 0x13,
111 [REG_RTC_COMP_MSB_REG] = 0x14,
112};
113
114/* RTC_CTRL_REG bitfields */
115#define BIT_RTC_CTRL_REG_STOP_RTC_M 0x01
116#define BIT_RTC_CTRL_REG_ROUND_30S_M 0x02
117#define BIT_RTC_CTRL_REG_AUTO_COMP_M 0x04
118#define BIT_RTC_CTRL_REG_MODE_12_24_M 0x08
119#define BIT_RTC_CTRL_REG_TEST_MODE_M 0x10
120#define BIT_RTC_CTRL_REG_SET_32_COUNTER_M 0x20
121#define BIT_RTC_CTRL_REG_GET_TIME_M 0x40
122#define BIT_RTC_CTRL_REG_RTC_V_OPT 0x80
123
124/* RTC_STATUS_REG bitfields */
125#define BIT_RTC_STATUS_REG_RUN_M 0x02
126#define BIT_RTC_STATUS_REG_1S_EVENT_M 0x04
127#define BIT_RTC_STATUS_REG_1M_EVENT_M 0x08
128#define BIT_RTC_STATUS_REG_1H_EVENT_M 0x10
129#define BIT_RTC_STATUS_REG_1D_EVENT_M 0x20
130#define BIT_RTC_STATUS_REG_ALARM_M 0x40
131#define BIT_RTC_STATUS_REG_POWER_UP_M 0x80
132
133/* RTC_INTERRUPTS_REG bitfields */
134#define BIT_RTC_INTERRUPTS_REG_EVERY_M 0x03
135#define BIT_RTC_INTERRUPTS_REG_IT_TIMER_M 0x04
136#define BIT_RTC_INTERRUPTS_REG_IT_ALARM_M 0x08
137
138
139/* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
140#define ALL_TIME_REGS 6
141
142/*----------------------------------------------------------------------*/
143struct twl_rtc {
144 struct device *dev;
145 struct rtc_device *rtc;
146 u8 *reg_map;
147 /*
148 * Cache the value for timer/alarm interrupts register; this is
149 * only changed by callers holding rtc ops lock (or resume).
150 */
151 unsigned char rtc_irq_bits;
152 bool wake_enabled;
153#ifdef CONFIG_PM_SLEEP
154 unsigned char irqstat;
155#endif
156 enum twl_class class;
157};
158
159/*
160 * Supports 1 byte read from TWL RTC register.
161 */
162static int twl_rtc_read_u8(struct twl_rtc *twl_rtc, u8 *data, u8 reg)
163{
164 int ret;
165
166 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
167 if (ret < 0)
168 pr_err("Could not read TWL register %X - error %d\n", reg, ret);
169 return ret;
170}
171
172/*
173 * Supports 1 byte write to TWL RTC registers.
174 */
175static int twl_rtc_write_u8(struct twl_rtc *twl_rtc, u8 data, u8 reg)
176{
177 int ret;
178
179 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (twl_rtc->reg_map[reg]));
180 if (ret < 0)
181 pr_err("Could not write TWL register %X - error %d\n",
182 reg, ret);
183 return ret;
184}
185
186/*
187 * Enable 1/second update and/or alarm interrupts.
188 */
189static int set_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
190{
191 unsigned char val;
192 int ret;
193
194 /* if the bit is set, return from here */
195 if (twl_rtc->rtc_irq_bits & bit)
196 return 0;
197
198 val = twl_rtc->rtc_irq_bits | bit;
199 val &= ~BIT_RTC_INTERRUPTS_REG_EVERY_M;
200 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
201 if (ret == 0)
202 twl_rtc->rtc_irq_bits = val;
203
204 return ret;
205}
206
207/*
208 * Disable update and/or alarm interrupts.
209 */
210static int mask_rtc_irq_bit(struct twl_rtc *twl_rtc, unsigned char bit)
211{
212 unsigned char val;
213 int ret;
214
215 /* if the bit is clear, return from here */
216 if (!(twl_rtc->rtc_irq_bits & bit))
217 return 0;
218
219 val = twl_rtc->rtc_irq_bits & ~bit;
220 ret = twl_rtc_write_u8(twl_rtc, val, REG_RTC_INTERRUPTS_REG);
221 if (ret == 0)
222 twl_rtc->rtc_irq_bits = val;
223
224 return ret;
225}
226
227static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
228{
229 struct platform_device *pdev = to_platform_device(dev);
230 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
231 int irq = platform_get_irq(pdev, 0);
232 int ret;
233
234 if (enabled) {
235 ret = set_rtc_irq_bit(twl_rtc,
236 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
237 if (device_can_wakeup(dev) && !twl_rtc->wake_enabled) {
238 enable_irq_wake(irq);
239 twl_rtc->wake_enabled = true;
240 }
241 } else {
242 ret = mask_rtc_irq_bit(twl_rtc,
243 BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
244 if (twl_rtc->wake_enabled) {
245 disable_irq_wake(irq);
246 twl_rtc->wake_enabled = false;
247 }
248 }
249
250 return ret;
251}
252
253/*
254 * Gets current TWL RTC time and date parameters.
255 *
256 * The RTC's time/alarm representation is not what gmtime(3) requires
257 * Linux to use:
258 *
259 * - Months are 1..12 vs Linux 0-11
260 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
261 */
262static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
263{
264 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
265 unsigned char rtc_data[ALL_TIME_REGS];
266 int ret;
267 u8 save_control;
268 u8 rtc_control;
269
270 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
271 if (ret < 0) {
272 dev_err(dev, "%s: reading CTRL_REG, error %d\n", __func__, ret);
273 return ret;
274 }
275 /* for twl6030/32 make sure BIT_RTC_CTRL_REG_GET_TIME_M is clear */
276 if (twl_rtc->class == TWL_6030) {
277 if (save_control & BIT_RTC_CTRL_REG_GET_TIME_M) {
278 save_control &= ~BIT_RTC_CTRL_REG_GET_TIME_M;
279 ret = twl_rtc_write_u8(twl_rtc, save_control,
280 REG_RTC_CTRL_REG);
281 if (ret < 0) {
282 dev_err(dev, "%s clr GET_TIME, error %d\n",
283 __func__, ret);
284 return ret;
285 }
286 }
287 }
288
289 /* Copy RTC counting registers to static registers or latches */
290 rtc_control = save_control | BIT_RTC_CTRL_REG_GET_TIME_M;
291
292 /* for twl6030/32 enable read access to static shadowed registers */
293 if (twl_rtc->class == TWL_6030)
294 rtc_control |= BIT_RTC_CTRL_REG_RTC_V_OPT;
295
296 ret = twl_rtc_write_u8(twl_rtc, rtc_control, REG_RTC_CTRL_REG);
297 if (ret < 0) {
298 dev_err(dev, "%s: writing CTRL_REG, error %d\n", __func__, ret);
299 return ret;
300 }
301
302 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
303 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
304
305 if (ret < 0) {
306 dev_err(dev, "%s: reading data, error %d\n", __func__, ret);
307 return ret;
308 }
309
310 /* for twl6030 restore original state of rtc control register */
311 if (twl_rtc->class == TWL_6030) {
312 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
313 if (ret < 0) {
314 dev_err(dev, "%s: restore CTRL_REG, error %d\n",
315 __func__, ret);
316 return ret;
317 }
318 }
319
320 tm->tm_sec = bcd2bin(rtc_data[0]);
321 tm->tm_min = bcd2bin(rtc_data[1]);
322 tm->tm_hour = bcd2bin(rtc_data[2]);
323 tm->tm_mday = bcd2bin(rtc_data[3]);
324 tm->tm_mon = bcd2bin(rtc_data[4]) - 1;
325 tm->tm_year = bcd2bin(rtc_data[5]) + 100;
326
327 return ret;
328}
329
330static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
331{
332 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
333 unsigned char save_control;
334 unsigned char rtc_data[ALL_TIME_REGS];
335 int ret;
336
337 rtc_data[0] = bin2bcd(tm->tm_sec);
338 rtc_data[1] = bin2bcd(tm->tm_min);
339 rtc_data[2] = bin2bcd(tm->tm_hour);
340 rtc_data[3] = bin2bcd(tm->tm_mday);
341 rtc_data[4] = bin2bcd(tm->tm_mon + 1);
342 rtc_data[5] = bin2bcd(tm->tm_year - 100);
343
344 /* Stop RTC while updating the TC registers */
345 ret = twl_rtc_read_u8(twl_rtc, &save_control, REG_RTC_CTRL_REG);
346 if (ret < 0)
347 goto out;
348
349 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
350 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
351 if (ret < 0)
352 goto out;
353
354 /* update all the time registers in one shot */
355 ret = twl_i2c_write(TWL_MODULE_RTC, rtc_data,
356 (twl_rtc->reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
357 if (ret < 0) {
358 dev_err(dev, "rtc_set_time error %d\n", ret);
359 goto out;
360 }
361
362 /* Start back RTC */
363 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
364 ret = twl_rtc_write_u8(twl_rtc, save_control, REG_RTC_CTRL_REG);
365
366out:
367 return ret;
368}
369
370/*
371 * Gets current TWL RTC alarm time.
372 */
373static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
374{
375 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
376 unsigned char rtc_data[ALL_TIME_REGS];
377 int ret;
378
379 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
380 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
381 if (ret < 0) {
382 dev_err(dev, "rtc_read_alarm error %d\n", ret);
383 return ret;
384 }
385
386 /* some of these fields may be wildcard/"match all" */
387 alm->time.tm_sec = bcd2bin(rtc_data[0]);
388 alm->time.tm_min = bcd2bin(rtc_data[1]);
389 alm->time.tm_hour = bcd2bin(rtc_data[2]);
390 alm->time.tm_mday = bcd2bin(rtc_data[3]);
391 alm->time.tm_mon = bcd2bin(rtc_data[4]) - 1;
392 alm->time.tm_year = bcd2bin(rtc_data[5]) + 100;
393
394 /* report cached alarm enable state */
395 if (twl_rtc->rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
396 alm->enabled = 1;
397
398 return ret;
399}
400
401static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
402{
403 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
404
405 unsigned char alarm_data[ALL_TIME_REGS];
406 int ret;
407
408 ret = twl_rtc_alarm_irq_enable(dev, 0);
409 if (ret)
410 goto out;
411
412 alarm_data[0] = bin2bcd(alm->time.tm_sec);
413 alarm_data[1] = bin2bcd(alm->time.tm_min);
414 alarm_data[2] = bin2bcd(alm->time.tm_hour);
415 alarm_data[3] = bin2bcd(alm->time.tm_mday);
416 alarm_data[4] = bin2bcd(alm->time.tm_mon + 1);
417 alarm_data[5] = bin2bcd(alm->time.tm_year - 100);
418
419 /* update all the alarm registers in one shot */
420 ret = twl_i2c_write(TWL_MODULE_RTC, alarm_data,
421 twl_rtc->reg_map[REG_ALARM_SECONDS_REG], ALL_TIME_REGS);
422 if (ret) {
423 dev_err(dev, "rtc_set_alarm error %d\n", ret);
424 goto out;
425 }
426
427 if (alm->enabled)
428 ret = twl_rtc_alarm_irq_enable(dev, 1);
429out:
430 return ret;
431}
432
433static irqreturn_t twl_rtc_interrupt(int irq, void *data)
434{
435 struct twl_rtc *twl_rtc = data;
436 unsigned long events;
437 int ret = IRQ_NONE;
438 int res;
439 u8 rd_reg;
440
441 res = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
442 if (res)
443 goto out;
444 /*
445 * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
446 * only one (ALARM or RTC) interrupt source may be enabled
447 * at time, we also could check our results
448 * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
449 */
450 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
451 events = RTC_IRQF | RTC_AF;
452 else
453 events = RTC_IRQF | RTC_PF;
454
455 res = twl_rtc_write_u8(twl_rtc, BIT_RTC_STATUS_REG_ALARM_M,
456 REG_RTC_STATUS_REG);
457 if (res)
458 goto out;
459
460 if (twl_rtc->class == TWL_4030) {
461 /* Clear on Read enabled. RTC_IT bit of TWL4030_INT_PWR_ISR1
462 * needs 2 reads to clear the interrupt. One read is done in
463 * do_twl_pwrirq(). Doing the second read, to clear
464 * the bit.
465 *
466 * FIXME the reason PWR_ISR1 needs an extra read is that
467 * RTC_IF retriggered until we cleared REG_ALARM_M above.
468 * But re-reading like this is a bad hack; by doing so we
469 * risk wrongly clearing status for some other IRQ (losing
470 * the interrupt). Be smarter about handling RTC_UF ...
471 */
472 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
473 &rd_reg, TWL4030_INT_PWR_ISR1);
474 if (res)
475 goto out;
476 }
477
478 /* Notify RTC core on event */
479 rtc_update_irq(twl_rtc->rtc, 1, events);
480
481 ret = IRQ_HANDLED;
482out:
483 return ret;
484}
485
486static const struct rtc_class_ops twl_rtc_ops = {
487 .read_time = twl_rtc_read_time,
488 .set_time = twl_rtc_set_time,
489 .read_alarm = twl_rtc_read_alarm,
490 .set_alarm = twl_rtc_set_alarm,
491 .alarm_irq_enable = twl_rtc_alarm_irq_enable,
492};
493
494/*----------------------------------------------------------------------*/
495
496static int twl_rtc_probe(struct platform_device *pdev)
497{
498 struct twl_rtc *twl_rtc;
499 struct device_node *np = pdev->dev.of_node;
500 int ret = -EINVAL;
501 int irq = platform_get_irq(pdev, 0);
502 u8 rd_reg;
503
504 if (!np) {
505 dev_err(&pdev->dev, "no DT info\n");
506 return -EINVAL;
507 }
508
509 if (irq <= 0)
510 return ret;
511
512 twl_rtc = devm_kzalloc(&pdev->dev, sizeof(*twl_rtc), GFP_KERNEL);
513 if (!twl_rtc)
514 return -ENOMEM;
515
516 if (twl_class_is_4030()) {
517 twl_rtc->class = TWL_4030;
518 twl_rtc->reg_map = (u8 *)twl4030_rtc_reg_map;
519 } else if (twl_class_is_6030()) {
520 twl_rtc->class = TWL_6030;
521 twl_rtc->reg_map = (u8 *)twl6030_rtc_reg_map;
522 } else {
523 dev_err(&pdev->dev, "TWL Class not supported.\n");
524 return -EINVAL;
525 }
526
527 ret = twl_rtc_read_u8(twl_rtc, &rd_reg, REG_RTC_STATUS_REG);
528 if (ret < 0)
529 return ret;
530
531 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
532 dev_warn(&pdev->dev, "Power up reset detected.\n");
533
534 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
535 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
536
537 /* Clear RTC Power up reset and pending alarm interrupts */
538 ret = twl_rtc_write_u8(twl_rtc, rd_reg, REG_RTC_STATUS_REG);
539 if (ret < 0)
540 return ret;
541
542 if (twl_rtc->class == TWL_6030) {
543 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
544 REG_INT_MSK_LINE_A);
545 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
546 REG_INT_MSK_STS_A);
547 }
548
549 dev_info(&pdev->dev, "Enabling TWL-RTC\n");
550 ret = twl_rtc_write_u8(twl_rtc, BIT_RTC_CTRL_REG_STOP_RTC_M,
551 REG_RTC_CTRL_REG);
552 if (ret < 0)
553 return ret;
554
555 /* ensure interrupts are disabled, bootloaders can be strange */
556 ret = twl_rtc_write_u8(twl_rtc, 0, REG_RTC_INTERRUPTS_REG);
557 if (ret < 0)
558 dev_warn(&pdev->dev, "unable to disable interrupt\n");
559
560 /* init cached IRQ enable bits */
561 ret = twl_rtc_read_u8(twl_rtc, &twl_rtc->rtc_irq_bits,
562 REG_RTC_INTERRUPTS_REG);
563 if (ret < 0)
564 return ret;
565
566 platform_set_drvdata(pdev, twl_rtc);
567 device_init_wakeup(&pdev->dev, 1);
568
569 twl_rtc->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
570 &twl_rtc_ops, THIS_MODULE);
571 if (IS_ERR(twl_rtc->rtc)) {
572 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
573 PTR_ERR(twl_rtc->rtc));
574 return PTR_ERR(twl_rtc->rtc);
575 }
576
577 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
578 twl_rtc_interrupt,
579 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
580 dev_name(&twl_rtc->rtc->dev), twl_rtc);
581 if (ret < 0) {
582 dev_err(&pdev->dev, "IRQ is not free.\n");
583 return ret;
584 }
585
586 return 0;
587}
588
589/*
590 * Disable all TWL RTC module interrupts.
591 * Sets status flag to free.
592 */
593static int twl_rtc_remove(struct platform_device *pdev)
594{
595 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
596
597 /* leave rtc running, but disable irqs */
598 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
599 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
600 if (twl_rtc->class == TWL_6030) {
601 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
602 REG_INT_MSK_LINE_A);
603 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
604 REG_INT_MSK_STS_A);
605 }
606
607 return 0;
608}
609
610static void twl_rtc_shutdown(struct platform_device *pdev)
611{
612 struct twl_rtc *twl_rtc = platform_get_drvdata(pdev);
613
614 /* mask timer interrupts, but leave alarm interrupts on to enable
615 power-on when alarm is triggered */
616 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
617}
618
619#ifdef CONFIG_PM_SLEEP
620static int twl_rtc_suspend(struct device *dev)
621{
622 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
623
624 twl_rtc->irqstat = twl_rtc->rtc_irq_bits;
625
626 mask_rtc_irq_bit(twl_rtc, BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
627 return 0;
628}
629
630static int twl_rtc_resume(struct device *dev)
631{
632 struct twl_rtc *twl_rtc = dev_get_drvdata(dev);
633
634 set_rtc_irq_bit(twl_rtc, twl_rtc->irqstat);
635 return 0;
636}
637#endif
638
639static SIMPLE_DEV_PM_OPS(twl_rtc_pm_ops, twl_rtc_suspend, twl_rtc_resume);
640
641static const struct of_device_id twl_rtc_of_match[] = {
642 {.compatible = "ti,twl4030-rtc", },
643 { },
644};
645MODULE_DEVICE_TABLE(of, twl_rtc_of_match);
646
647static struct platform_driver twl4030rtc_driver = {
648 .probe = twl_rtc_probe,
649 .remove = twl_rtc_remove,
650 .shutdown = twl_rtc_shutdown,
651 .driver = {
652 .name = "twl_rtc",
653 .pm = &twl_rtc_pm_ops,
654 .of_match_table = twl_rtc_of_match,
655 },
656};
657
658module_platform_driver(twl4030rtc_driver);
659
660MODULE_AUTHOR("Texas Instruments, MontaVista Software");
661MODULE_LICENSE("GPL");