GUI: Fix Tomato RAF theme for all builds. Compilation typo.
[tomato.git] / release / src-rt-6.x.4708 / linux / linux-2.6.36 / drivers / rtc / rtc-twl.c
blobce2287fe1c143d70de9e92c9a2ed1054ab9c03e6
1 /*
2 * rtc-twl.c -- TWL Real Time Clock interface
4 * Copyright (C) 2007 MontaVista Software, Inc
5 * Author: Alexandre Rusev <source@mvista.com>
7 * Based on original TI driver twl4030-rtc.c
8 * Copyright (C) 2006 Texas Instruments, Inc.
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
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.
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/types.h>
26 #include <linux/rtc.h>
27 #include <linux/bcd.h>
28 #include <linux/platform_device.h>
29 #include <linux/interrupt.h>
31 #include <linux/i2c/twl.h>
35 * RTC block register offsets (use TWL_MODULE_RTC)
37 enum {
38 REG_SECONDS_REG = 0,
39 REG_MINUTES_REG,
40 REG_HOURS_REG,
41 REG_DAYS_REG,
42 REG_MONTHS_REG,
43 REG_YEARS_REG,
44 REG_WEEKS_REG,
46 REG_ALARM_SECONDS_REG,
47 REG_ALARM_MINUTES_REG,
48 REG_ALARM_HOURS_REG,
49 REG_ALARM_DAYS_REG,
50 REG_ALARM_MONTHS_REG,
51 REG_ALARM_YEARS_REG,
53 REG_RTC_CTRL_REG,
54 REG_RTC_STATUS_REG,
55 REG_RTC_INTERRUPTS_REG,
57 REG_RTC_COMP_LSB_REG,
58 REG_RTC_COMP_MSB_REG,
60 static const u8 twl4030_rtc_reg_map[] = {
61 [REG_SECONDS_REG] = 0x00,
62 [REG_MINUTES_REG] = 0x01,
63 [REG_HOURS_REG] = 0x02,
64 [REG_DAYS_REG] = 0x03,
65 [REG_MONTHS_REG] = 0x04,
66 [REG_YEARS_REG] = 0x05,
67 [REG_WEEKS_REG] = 0x06,
69 [REG_ALARM_SECONDS_REG] = 0x07,
70 [REG_ALARM_MINUTES_REG] = 0x08,
71 [REG_ALARM_HOURS_REG] = 0x09,
72 [REG_ALARM_DAYS_REG] = 0x0A,
73 [REG_ALARM_MONTHS_REG] = 0x0B,
74 [REG_ALARM_YEARS_REG] = 0x0C,
76 [REG_RTC_CTRL_REG] = 0x0D,
77 [REG_RTC_STATUS_REG] = 0x0E,
78 [REG_RTC_INTERRUPTS_REG] = 0x0F,
80 [REG_RTC_COMP_LSB_REG] = 0x10,
81 [REG_RTC_COMP_MSB_REG] = 0x11,
83 static const u8 twl6030_rtc_reg_map[] = {
84 [REG_SECONDS_REG] = 0x00,
85 [REG_MINUTES_REG] = 0x01,
86 [REG_HOURS_REG] = 0x02,
87 [REG_DAYS_REG] = 0x03,
88 [REG_MONTHS_REG] = 0x04,
89 [REG_YEARS_REG] = 0x05,
90 [REG_WEEKS_REG] = 0x06,
92 [REG_ALARM_SECONDS_REG] = 0x08,
93 [REG_ALARM_MINUTES_REG] = 0x09,
94 [REG_ALARM_HOURS_REG] = 0x0A,
95 [REG_ALARM_DAYS_REG] = 0x0B,
96 [REG_ALARM_MONTHS_REG] = 0x0C,
97 [REG_ALARM_YEARS_REG] = 0x0D,
99 [REG_RTC_CTRL_REG] = 0x10,
100 [REG_RTC_STATUS_REG] = 0x11,
101 [REG_RTC_INTERRUPTS_REG] = 0x12,
103 [REG_RTC_COMP_LSB_REG] = 0x13,
104 [REG_RTC_COMP_MSB_REG] = 0x14,
107 /* RTC_CTRL_REG bitfields */
108 #define BIT_RTC_CTRL_REG_STOP_RTC_M 0x01
109 #define BIT_RTC_CTRL_REG_ROUND_30S_M 0x02
110 #define BIT_RTC_CTRL_REG_AUTO_COMP_M 0x04
111 #define BIT_RTC_CTRL_REG_MODE_12_24_M 0x08
112 #define BIT_RTC_CTRL_REG_TEST_MODE_M 0x10
113 #define BIT_RTC_CTRL_REG_SET_32_COUNTER_M 0x20
114 #define BIT_RTC_CTRL_REG_GET_TIME_M 0x40
116 /* RTC_STATUS_REG bitfields */
117 #define BIT_RTC_STATUS_REG_RUN_M 0x02
118 #define BIT_RTC_STATUS_REG_1S_EVENT_M 0x04
119 #define BIT_RTC_STATUS_REG_1M_EVENT_M 0x08
120 #define BIT_RTC_STATUS_REG_1H_EVENT_M 0x10
121 #define BIT_RTC_STATUS_REG_1D_EVENT_M 0x20
122 #define BIT_RTC_STATUS_REG_ALARM_M 0x40
123 #define BIT_RTC_STATUS_REG_POWER_UP_M 0x80
125 /* RTC_INTERRUPTS_REG bitfields */
126 #define BIT_RTC_INTERRUPTS_REG_EVERY_M 0x03
127 #define BIT_RTC_INTERRUPTS_REG_IT_TIMER_M 0x04
128 #define BIT_RTC_INTERRUPTS_REG_IT_ALARM_M 0x08
131 /* REG_SECONDS_REG through REG_YEARS_REG is how many registers? */
132 #define ALL_TIME_REGS 6
134 /*----------------------------------------------------------------------*/
135 static u8 *rtc_reg_map;
138 * Supports 1 byte read from TWL RTC register.
140 static int twl_rtc_read_u8(u8 *data, u8 reg)
142 int ret;
144 ret = twl_i2c_read_u8(TWL_MODULE_RTC, data, (rtc_reg_map[reg]));
145 if (ret < 0)
146 pr_err("twl_rtc: Could not read TWL"
147 "register %X - error %d\n", reg, ret);
148 return ret;
152 * Supports 1 byte write to TWL RTC registers.
154 static int twl_rtc_write_u8(u8 data, u8 reg)
156 int ret;
158 ret = twl_i2c_write_u8(TWL_MODULE_RTC, data, (rtc_reg_map[reg]));
159 if (ret < 0)
160 pr_err("twl_rtc: Could not write TWL"
161 "register %X - error %d\n", reg, ret);
162 return ret;
166 * Cache the value for timer/alarm interrupts register; this is
167 * only changed by callers holding rtc ops lock (or resume).
169 static unsigned char rtc_irq_bits;
172 * Enable 1/second update and/or alarm interrupts.
174 static int set_rtc_irq_bit(unsigned char bit)
176 unsigned char val;
177 int ret;
179 val = rtc_irq_bits | bit;
180 val &= ~BIT_RTC_INTERRUPTS_REG_EVERY_M;
181 ret = twl_rtc_write_u8(val, REG_RTC_INTERRUPTS_REG);
182 if (ret == 0)
183 rtc_irq_bits = val;
185 return ret;
189 * Disable update and/or alarm interrupts.
191 static int mask_rtc_irq_bit(unsigned char bit)
193 unsigned char val;
194 int ret;
196 val = rtc_irq_bits & ~bit;
197 ret = twl_rtc_write_u8(val, REG_RTC_INTERRUPTS_REG);
198 if (ret == 0)
199 rtc_irq_bits = val;
201 return ret;
204 static int twl_rtc_alarm_irq_enable(struct device *dev, unsigned enabled)
206 int ret;
208 if (enabled)
209 ret = set_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
210 else
211 ret = mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
213 return ret;
216 static int twl_rtc_update_irq_enable(struct device *dev, unsigned enabled)
218 int ret;
220 if (enabled)
221 ret = set_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
222 else
223 ret = mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
225 return ret;
229 * Gets current TWL RTC time and date parameters.
231 * The RTC's time/alarm representation is not what gmtime(3) requires
232 * Linux to use:
234 * - Months are 1..12 vs Linux 0-11
235 * - Years are 0..99 vs Linux 1900..N (we assume 21st century)
237 static int twl_rtc_read_time(struct device *dev, struct rtc_time *tm)
239 unsigned char rtc_data[ALL_TIME_REGS + 1];
240 int ret;
241 u8 save_control;
243 ret = twl_rtc_read_u8(&save_control, REG_RTC_CTRL_REG);
244 if (ret < 0)
245 return ret;
247 save_control |= BIT_RTC_CTRL_REG_GET_TIME_M;
249 ret = twl_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
250 if (ret < 0)
251 return ret;
253 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
254 (rtc_reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
256 if (ret < 0) {
257 dev_err(dev, "rtc_read_time error %d\n", ret);
258 return ret;
261 tm->tm_sec = bcd2bin(rtc_data[0]);
262 tm->tm_min = bcd2bin(rtc_data[1]);
263 tm->tm_hour = bcd2bin(rtc_data[2]);
264 tm->tm_mday = bcd2bin(rtc_data[3]);
265 tm->tm_mon = bcd2bin(rtc_data[4]) - 1;
266 tm->tm_year = bcd2bin(rtc_data[5]) + 100;
268 return ret;
271 static int twl_rtc_set_time(struct device *dev, struct rtc_time *tm)
273 unsigned char save_control;
274 unsigned char rtc_data[ALL_TIME_REGS + 1];
275 int ret;
277 rtc_data[1] = bin2bcd(tm->tm_sec);
278 rtc_data[2] = bin2bcd(tm->tm_min);
279 rtc_data[3] = bin2bcd(tm->tm_hour);
280 rtc_data[4] = bin2bcd(tm->tm_mday);
281 rtc_data[5] = bin2bcd(tm->tm_mon + 1);
282 rtc_data[6] = bin2bcd(tm->tm_year - 100);
284 /* Stop RTC while updating the TC registers */
285 ret = twl_rtc_read_u8(&save_control, REG_RTC_CTRL_REG);
286 if (ret < 0)
287 goto out;
289 save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
290 twl_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
291 if (ret < 0)
292 goto out;
294 /* update all the time registers in one shot */
295 ret = twl_i2c_write(TWL_MODULE_RTC, rtc_data,
296 (rtc_reg_map[REG_SECONDS_REG]), ALL_TIME_REGS);
297 if (ret < 0) {
298 dev_err(dev, "rtc_set_time error %d\n", ret);
299 goto out;
302 /* Start back RTC */
303 save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
304 ret = twl_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
306 out:
307 return ret;
311 * Gets current TWL RTC alarm time.
313 static int twl_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
315 unsigned char rtc_data[ALL_TIME_REGS + 1];
316 int ret;
318 ret = twl_i2c_read(TWL_MODULE_RTC, rtc_data,
319 (rtc_reg_map[REG_ALARM_SECONDS_REG]), ALL_TIME_REGS);
320 if (ret < 0) {
321 dev_err(dev, "rtc_read_alarm error %d\n", ret);
322 return ret;
325 /* some of these fields may be wildcard/"match all" */
326 alm->time.tm_sec = bcd2bin(rtc_data[0]);
327 alm->time.tm_min = bcd2bin(rtc_data[1]);
328 alm->time.tm_hour = bcd2bin(rtc_data[2]);
329 alm->time.tm_mday = bcd2bin(rtc_data[3]);
330 alm->time.tm_mon = bcd2bin(rtc_data[4]) - 1;
331 alm->time.tm_year = bcd2bin(rtc_data[5]) + 100;
333 /* report cached alarm enable state */
334 if (rtc_irq_bits & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M)
335 alm->enabled = 1;
337 return ret;
340 static int twl_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
342 unsigned char alarm_data[ALL_TIME_REGS + 1];
343 int ret;
345 ret = twl_rtc_alarm_irq_enable(dev, 0);
346 if (ret)
347 goto out;
349 alarm_data[1] = bin2bcd(alm->time.tm_sec);
350 alarm_data[2] = bin2bcd(alm->time.tm_min);
351 alarm_data[3] = bin2bcd(alm->time.tm_hour);
352 alarm_data[4] = bin2bcd(alm->time.tm_mday);
353 alarm_data[5] = bin2bcd(alm->time.tm_mon + 1);
354 alarm_data[6] = bin2bcd(alm->time.tm_year - 100);
356 /* update all the alarm registers in one shot */
357 ret = twl_i2c_write(TWL_MODULE_RTC, alarm_data,
358 (rtc_reg_map[REG_ALARM_SECONDS_REG]), ALL_TIME_REGS);
359 if (ret) {
360 dev_err(dev, "rtc_set_alarm error %d\n", ret);
361 goto out;
364 if (alm->enabled)
365 ret = twl_rtc_alarm_irq_enable(dev, 1);
366 out:
367 return ret;
370 static irqreturn_t twl_rtc_interrupt(int irq, void *rtc)
372 unsigned long events = 0;
373 int ret = IRQ_NONE;
374 int res;
375 u8 rd_reg;
377 #ifdef CONFIG_LOCKDEP
378 local_irq_enable();
379 #endif
381 res = twl_rtc_read_u8(&rd_reg, REG_RTC_STATUS_REG);
382 if (res)
383 goto out;
385 * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
386 * only one (ALARM or RTC) interrupt source may be enabled
387 * at time, we also could check our results
388 * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
390 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
391 events |= RTC_IRQF | RTC_AF;
392 else
393 events |= RTC_IRQF | RTC_UF;
395 res = twl_rtc_write_u8(rd_reg | BIT_RTC_STATUS_REG_ALARM_M,
396 REG_RTC_STATUS_REG);
397 if (res)
398 goto out;
400 if (twl_class_is_4030()) {
401 res = twl_i2c_read_u8(TWL4030_MODULE_INT,
402 &rd_reg, TWL4030_INT_PWR_ISR1);
403 if (res)
404 goto out;
407 /* Notify RTC core on event */
408 rtc_update_irq(rtc, 1, events);
410 ret = IRQ_HANDLED;
411 out:
412 return ret;
415 static struct rtc_class_ops twl_rtc_ops = {
416 .read_time = twl_rtc_read_time,
417 .set_time = twl_rtc_set_time,
418 .read_alarm = twl_rtc_read_alarm,
419 .set_alarm = twl_rtc_set_alarm,
420 .alarm_irq_enable = twl_rtc_alarm_irq_enable,
421 .update_irq_enable = twl_rtc_update_irq_enable,
424 /*----------------------------------------------------------------------*/
426 static int __devinit twl_rtc_probe(struct platform_device *pdev)
428 struct rtc_device *rtc;
429 int ret = 0;
430 int irq = platform_get_irq(pdev, 0);
431 u8 rd_reg;
433 if (irq <= 0)
434 return -EINVAL;
436 rtc = rtc_device_register(pdev->name,
437 &pdev->dev, &twl_rtc_ops, THIS_MODULE);
438 if (IS_ERR(rtc)) {
439 ret = PTR_ERR(rtc);
440 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
441 PTR_ERR(rtc));
442 goto out0;
446 platform_set_drvdata(pdev, rtc);
448 ret = twl_rtc_read_u8(&rd_reg, REG_RTC_STATUS_REG);
449 if (ret < 0)
450 goto out1;
452 if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
453 dev_warn(&pdev->dev, "Power up reset detected.\n");
455 if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
456 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
458 /* Clear RTC Power up reset and pending alarm interrupts */
459 ret = twl_rtc_write_u8(rd_reg, REG_RTC_STATUS_REG);
460 if (ret < 0)
461 goto out1;
463 ret = request_irq(irq, twl_rtc_interrupt,
464 IRQF_TRIGGER_RISING,
465 dev_name(&rtc->dev), rtc);
466 if (ret < 0) {
467 dev_err(&pdev->dev, "IRQ is not free.\n");
468 goto out1;
471 if (twl_class_is_6030()) {
472 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
473 REG_INT_MSK_LINE_A);
474 twl6030_interrupt_unmask(TWL6030_RTC_INT_MASK,
475 REG_INT_MSK_STS_A);
478 /* Check RTC module status, Enable if it is off */
479 ret = twl_rtc_read_u8(&rd_reg, REG_RTC_CTRL_REG);
480 if (ret < 0)
481 goto out2;
483 if (!(rd_reg & BIT_RTC_CTRL_REG_STOP_RTC_M)) {
484 dev_info(&pdev->dev, "Enabling TWL-RTC.\n");
485 rd_reg = BIT_RTC_CTRL_REG_STOP_RTC_M;
486 ret = twl_rtc_write_u8(rd_reg, REG_RTC_CTRL_REG);
487 if (ret < 0)
488 goto out2;
491 /* init cached IRQ enable bits */
492 ret = twl_rtc_read_u8(&rtc_irq_bits, REG_RTC_INTERRUPTS_REG);
493 if (ret < 0)
494 goto out2;
496 return ret;
498 out2:
499 free_irq(irq, rtc);
500 out1:
501 rtc_device_unregister(rtc);
502 out0:
503 return ret;
507 * Disable all TWL RTC module interrupts.
508 * Sets status flag to free.
510 static int __devexit twl_rtc_remove(struct platform_device *pdev)
512 /* leave rtc running, but disable irqs */
513 struct rtc_device *rtc = platform_get_drvdata(pdev);
514 int irq = platform_get_irq(pdev, 0);
516 mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
517 mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
518 if (twl_class_is_6030()) {
519 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
520 REG_INT_MSK_LINE_A);
521 twl6030_interrupt_mask(TWL6030_RTC_INT_MASK,
522 REG_INT_MSK_STS_A);
526 free_irq(irq, rtc);
528 rtc_device_unregister(rtc);
529 platform_set_drvdata(pdev, NULL);
530 return 0;
533 static void twl_rtc_shutdown(struct platform_device *pdev)
535 /* mask timer interrupts, but leave alarm interrupts on to enable
536 power-on when alarm is triggered */
537 mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
540 #ifdef CONFIG_PM
542 static unsigned char irqstat;
544 static int twl_rtc_suspend(struct platform_device *pdev, pm_message_t state)
546 irqstat = rtc_irq_bits;
548 mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
549 return 0;
552 static int twl_rtc_resume(struct platform_device *pdev)
554 set_rtc_irq_bit(irqstat);
555 return 0;
558 #else
559 #define twl_rtc_suspend NULL
560 #define twl_rtc_resume NULL
561 #endif
563 MODULE_ALIAS("platform:twl_rtc");
565 static struct platform_driver twl4030rtc_driver = {
566 .probe = twl_rtc_probe,
567 .remove = __devexit_p(twl_rtc_remove),
568 .shutdown = twl_rtc_shutdown,
569 .suspend = twl_rtc_suspend,
570 .resume = twl_rtc_resume,
571 .driver = {
572 .owner = THIS_MODULE,
573 .name = "twl_rtc",
577 static int __init twl_rtc_init(void)
579 if (twl_class_is_4030())
580 rtc_reg_map = (u8 *) twl4030_rtc_reg_map;
581 else
582 rtc_reg_map = (u8 *) twl6030_rtc_reg_map;
584 return platform_driver_register(&twl4030rtc_driver);
586 module_init(twl_rtc_init);
588 static void __exit twl_rtc_exit(void)
590 platform_driver_unregister(&twl4030rtc_driver);
592 module_exit(twl_rtc_exit);
594 MODULE_AUTHOR("Texas Instruments, MontaVista Software");
595 MODULE_LICENSE("GPL");