]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/rtc/rtc-twl4030.c
Merge current mainline tree into linux-omap tree
[linux-2.6-omap-h63xx.git] / drivers / rtc / rtc-twl4030.c
1 /*
2  * drivers/rtc/rtc-twl4030.c
3  * 
4  * TWL4030 Real Time Clock interface
5  * 
6  * Copyright (C) 2007 MontaVista Software, Inc
7  * Author: Alexandre Rusev <source@mvista.com>
8  *
9  * Based on original TI driver twl4030-rtc.c
10  *   Copyright (C) 2006 Texas Instruments, Inc.
11  * 
12  * Based on rtc-omap.c
13  *   Copyright (C) 2003 MontaVista Software, Inc.
14  *   Author: George G. Davis <gdavis@mvista.com> or <source@mvista.com>
15  *
16  *   Copyright (C) 2006 David Brownell
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License
20  * as published by the Free Software Foundation; either version
21  * 2 of the License, or (at your option) any later version.
22  * 
23  */
24
25 #include <linux/kernel.h>
26 #include <linux/init.h>
27 #include <linux/module.h>
28 #include <linux/ioport.h>
29 #include <linux/delay.h>
30 #include <linux/types.h>
31 #include <linux/rtc.h>
32 #include <linux/bcd.h>
33 #include <linux/platform_device.h>
34 #include <linux/spinlock.h>
35 #include <linux/interrupt.h>
36 #include <linux/device.h>
37
38 #include <asm/io.h>
39 #include <asm/mach/time.h>
40 #include <asm/system.h>
41 #include <asm/hardware.h>
42 #include <asm/irq.h>
43 #include <asm/arch/twl4030.h>
44 #include <asm/arch/twl4030-rtc.h>
45
46 #define ALL_TIME_REGS           6
47
48 /*
49  * If this driver ever becomes modularised, it will be really nice
50  * to make the epoch retain its value across module reload...
51  */
52 static int epoch = 1900;        /* year corresponding to 0x00   */
53
54 /* 
55  * Supports 1 byte read from TWL4030 RTC register. 
56  */
57 static int twl4030_rtc_read_u8(u8 * data, u8 reg)
58 {
59         int ret;
60
61         ret = twl4030_i2c_read_u8(TWL4030_MODULE_RTC, data, reg);
62         if (ret < 0) {
63                 printk(KERN_WARNING "twl4030_rtc: Could not read TWL4030"
64                        "register %X - returned %d[%x]\n", reg, ret, ret);
65         }
66         return ret;
67 }
68
69 /* 
70  * Supports 1 byte write to TWL4030 RTC registers.
71  */
72 static int twl4030_rtc_write_u8(u8 data, u8 reg)
73 {
74         int ret;
75
76         ret = twl4030_i2c_write_u8(TWL4030_MODULE_RTC, data, reg);
77         if (ret < 0) {
78                 printk(KERN_WARNING "twl4030_rtc: Could not write TWL4030" 
79                        "register %X - returned %d[%x]\n", reg, ret, ret);
80         }
81         return ret;
82 }
83
84 /* 
85  * Enables timer or alarm interrupts.
86  */
87 static int set_rtc_irq_bit(unsigned char bit)
88 {
89         unsigned char val;
90         int ret;
91
92         ret = twl4030_rtc_read_u8(&val, REG_RTC_INTERRUPTS_REG);
93         if (ret < 0)
94                 goto set_irq_out;
95
96         val |= bit;
97         ret = twl4030_rtc_write_u8(val, REG_RTC_INTERRUPTS_REG);
98
99 set_irq_out:
100         return ret;
101 }
102
103 #ifdef CONFIG_PM
104 /* 
105  * Read timer or alarm interrupts register.
106  */
107 static int get_rtc_irq_bit(unsigned char *val)
108 {
109         int ret;
110
111         ret = twl4030_rtc_read_u8(val, REG_RTC_INTERRUPTS_REG);
112         return ret;
113 }
114 #endif
115 /* 
116  * Disables timer or alarm interrupts.
117  */
118 static int mask_rtc_irq_bit(unsigned char bit)
119 {
120         unsigned char val;
121         int ret;
122
123         ret = twl4030_rtc_read_u8(&val, REG_RTC_INTERRUPTS_REG);
124         if (ret < 0)
125                 goto mask_irq_out;
126         
127         val &= ~bit;
128         ret = twl4030_rtc_write_u8(val, REG_RTC_INTERRUPTS_REG);
129
130 mask_irq_out:
131         return ret;
132 }
133
134 static int twl4030_rtc_alarm_irq_set_state(struct device *dev, int enabled)
135 {
136         int ret;
137
138         /* Allow ints for RTC ALARM updates.  */
139         if (enabled) 
140                 ret = set_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
141         else 
142                 ret = mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
143
144         return ret;
145 }
146
147 /* 
148  * Gets current TWL4030 RTC time and date parameters.
149  */
150 static int get_rtc_time(struct rtc_time *rtc_tm)
151 {
152         unsigned char rtc_data[ALL_TIME_REGS + 1];
153         int ret;
154         u8 save_control;
155
156         ret = twl4030_rtc_read_u8(&save_control, REG_RTC_CTRL_REG);
157         if (ret < 0)
158                 return ret;
159
160         save_control |= BIT_RTC_CTRL_REG_GET_TIME_M;
161
162         ret = twl4030_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
163         if (ret < 0)
164                 return ret;
165
166         ret = twl4030_i2c_read(TWL4030_MODULE_RTC, rtc_data,
167                                REG_SECONDS_REG, ALL_TIME_REGS);
168
169         if (ret < 0) {
170                 printk(KERN_ERR "twl4030_rtc: twl4030_i2c_read error.\n");
171                 return ret;
172         }
173
174         rtc_tm->tm_sec = BCD2BIN(rtc_data[0]);
175         rtc_tm->tm_min = BCD2BIN(rtc_data[1]);
176         rtc_tm->tm_hour = BCD2BIN(rtc_data[2]);
177         rtc_tm->tm_mday = BCD2BIN(rtc_data[3]);
178         rtc_tm->tm_mon = BCD2BIN(rtc_data[4]);
179         rtc_tm->tm_year = BCD2BIN(rtc_data[5]);
180
181         /*
182          * Account for differences between how the RTC uses the values
183          * and how they are defined in a struct rtc_time;
184          */
185         if ((rtc_tm->tm_year += (epoch - 1900)) <= 69)
186                 rtc_tm->tm_year += 100;
187
188         rtc_tm->tm_mon--;
189
190         return ret;
191 }
192
193 static int twl4030_rtc_set_time(struct device *dev, struct rtc_time *tm)
194 {
195         unsigned char save_control;
196         unsigned char rtc_data[ALL_TIME_REGS + 1];
197         int ret;
198
199         /* Month range is 01..12 */
200         tm->tm_mon++;
201
202         rtc_data[1] = BIN2BCD(tm->tm_sec);
203         rtc_data[2] = BIN2BCD(tm->tm_min);
204         rtc_data[3] = BIN2BCD(tm->tm_hour);
205         rtc_data[4] = BIN2BCD(tm->tm_mday);
206         rtc_data[5] = BIN2BCD(tm->tm_mon);
207         rtc_data[6] = BIN2BCD(tm->tm_year);
208
209         /* Stop RTC while updating the TC registers */
210         ret = twl4030_rtc_read_u8(&save_control, REG_RTC_CTRL_REG);
211         if (ret < 0)
212                 goto out;
213
214         save_control &= ~BIT_RTC_CTRL_REG_STOP_RTC_M;
215         twl4030_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
216         if (ret < 0)
217                 goto out;
218
219         /* update all the alarm registers in one shot */
220         ret = twl4030_i2c_write(TWL4030_MODULE_RTC, rtc_data,
221                                 REG_SECONDS_REG, ALL_TIME_REGS);
222         if (ret < 0) {
223                 printk(KERN_ERR "twl4030: twl4030_i2c_write error.\n");
224                 goto out;
225         }
226
227         /* Start back RTC */
228         save_control |= BIT_RTC_CTRL_REG_STOP_RTC_M;
229         ret = twl4030_rtc_write_u8(save_control, REG_RTC_CTRL_REG);
230
231 out:
232         return ret;
233 }
234
235 /* 
236  * Gets current TWL4030 RTC alarm time.
237  */
238 static int get_rtc_alm_time(struct rtc_time *alm_tm)
239 {
240         unsigned char rtc_data[ALL_TIME_REGS + 1];
241         int ret;
242
243         ret = twl4030_i2c_read(TWL4030_MODULE_RTC, rtc_data,
244                                REG_ALARM_SECONDS_REG, ALL_TIME_REGS);
245         if (ret < 0) {
246                 printk(KERN_ERR "twl4030_rtc: twl4030_i2c_read error.\n");
247                 return ret;
248         }
249
250         alm_tm->tm_sec = BCD2BIN(rtc_data[0]);
251         alm_tm->tm_min = BCD2BIN(rtc_data[1]);
252         alm_tm->tm_hour = BCD2BIN(rtc_data[2]);
253         alm_tm->tm_mday = BCD2BIN(rtc_data[3]);
254         alm_tm->tm_mon = BCD2BIN(rtc_data[4]);
255         alm_tm->tm_year = BCD2BIN(rtc_data[5]);
256
257         /*
258          * Account for differences between how the RTC uses the values
259          * and how they are defined in a struct rtc_time;
260          */
261         if ((alm_tm->tm_year += (epoch - 1900)) <= 69)
262                 alm_tm->tm_year += 100;
263
264         alm_tm->tm_mon--;
265
266         return ret;
267 }
268
269 static int twl4030_rtc_read_time(struct device *dev, struct rtc_time *tm)
270 {
271         int ret;
272
273         memset(tm, 0, sizeof(struct rtc_time));
274         ret = get_rtc_time(tm);
275
276         return ret;
277 }
278
279 /* 
280  * Gets current TWL4030 RTC alarm time.
281  */
282 static int twl4030_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
283 {
284         int ret;
285         u8 rtc_interrupts_reg = 0;
286
287         /*
288          * This returns a struct rtc_time. Reading >= 0xc0
289          * means "don't care" or "match all". Only the tm_hour,
290          * tm_min, and tm_sec values are filled in.
291          */
292         memset(&alm->time, 0, sizeof(struct rtc_time));
293         ret = get_rtc_alm_time(&alm->time);
294
295         if (ret)
296                 goto out;
297
298         /* Check alarm enabled flag state */
299         ret =
300             ret | twl4030_i2c_read_u8(TWL4030_MODULE_RTC, &rtc_interrupts_reg,
301                                       REG_RTC_INTERRUPTS_REG);
302
303         if (ret)
304                 goto out;
305
306         if ((rtc_interrupts_reg & BIT_RTC_INTERRUPTS_REG_IT_ALARM_M) != 0)
307                 alm->enabled = 1;
308         else
309                 alm->enabled = 0;
310
311 out:
312         return ret;
313 }
314
315 static int twl4030_rtc_irq_set_state(struct device *dev, int enabled)
316 {
317         int ret;
318
319         /* Allow ints for RTC updates.  */
320         if (enabled) 
321                 ret = set_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
322         else 
323                 ret = mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
324         
325         return ret;
326 }
327
328 static int twl4030_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
329 {
330         unsigned char alarm_data[ALL_TIME_REGS + 1];
331         int ret;
332
333         /* Month range is 01..12 */
334         alm->time.tm_mon++;
335
336         alarm_data[1] = BIN2BCD(alm->time.tm_sec);
337         alarm_data[2] = BIN2BCD(alm->time.tm_min);
338         alarm_data[3] = BIN2BCD(alm->time.tm_hour);
339         alarm_data[4] = BIN2BCD(alm->time.tm_mday);
340         alarm_data[5] = BIN2BCD(alm->time.tm_mon);
341         alarm_data[6] = BIN2BCD(alm->time.tm_year);
342
343         /* update all the alarm registers in one shot */
344         ret = twl4030_i2c_write(TWL4030_MODULE_RTC, alarm_data,
345                                 REG_ALARM_SECONDS_REG, ALL_TIME_REGS);
346         if (ret) {
347                 printk(KERN_ERR "twl4030: twl4030_i2c_write error.\n");
348                 goto out;
349         }
350
351         ret = twl4030_rtc_alarm_irq_set_state(dev, alm->enabled);
352 out:
353         return ret;
354 }
355
356 #ifdef  CONFIG_RTC_INTF_DEV
357
358 static int twl4030_rtc_ioctl(struct device *dev, unsigned int cmd,
359                              unsigned long arg)
360 {
361
362         switch (cmd) {
363         case RTC_AIE_OFF:
364                 return twl4030_rtc_alarm_irq_set_state(dev, 0);
365         case RTC_AIE_ON:
366                 return twl4030_rtc_alarm_irq_set_state(dev, 1);
367         case RTC_UIE_OFF:
368                 /* Mask ints from RTC updates.  */
369                 return twl4030_rtc_irq_set_state(dev, 0);
370         case RTC_UIE_ON:
371                 /* Allow ints for RTC updates.  */
372                 return twl4030_rtc_irq_set_state(dev, 1);
373         case RTC_EPOCH_READ:
374                 return put_user(epoch, (unsigned long *)arg);
375         case RTC_EPOCH_SET:     
376                 /*
377                  * There were no RTC clocks before 1900.
378                  */
379                 if (arg < 1900)
380                         return -EINVAL;
381
382                 if (!capable(CAP_SYS_TIME))
383                         return -EACCES;
384
385                 epoch = arg;
386                 return 0;
387         default:
388                 return -ENOIOCTLCMD;
389         }
390 }
391
392 #else
393 #define omap_rtc_ioctl  NULL
394 #endif
395
396 static irqreturn_t twl4030_rtc_interrupt(int irq, void *rtc)
397 {
398         unsigned long events = 0;
399         int ret = IRQ_NONE;
400         int res;
401         u8 rd_reg;
402         
403         /* clear the RTC interrupt in TWL4030 power module */
404         res = twl4030_i2c_read_u8(TWL4030_MODULE_INT, &rd_reg, REG_PWR_ISR1);
405         if (res)
406                 goto out;
407
408         /* Check if interrupt is sourced by RTC */
409         if (!(rd_reg & PWR_RTC_INT_CLR))
410                 goto out;
411
412         rd_reg |= PWR_RTC_INT_CLR;
413         res = twl4030_i2c_write_u8(TWL4030_MODULE_INT, rd_reg, REG_PWR_ISR1);
414         if (res)
415                 goto out;
416
417         res = twl4030_rtc_read_u8(&rd_reg, REG_RTC_STATUS_REG);
418         if (res)
419                 goto out;
420         /*
421          * Figure out source of interrupt: ALARM or TIMER in RTC_STATUS_REG.
422          * only one (ALARM or RTC) interrupt source may be enabled
423          * at time, we also could check our results
424          * by reading RTS_INTERRUPTS_REGISTER[IT_TIMER,IT_ALARM]
425          */
426         if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
427                 events |= RTC_IRQF | RTC_AF;
428         else
429                 events |= RTC_IRQF | RTC_UF;
430
431         res = twl4030_rtc_write_u8(rd_reg | BIT_RTC_STATUS_REG_ALARM_M,
432                                    REG_RTC_STATUS_REG);
433         if (res)
434                 goto out;
435         /*
436          * Workaround for strange behaviour with T2. Need to write into ISR 
437          * register one more time to clear the interrupt. Otherwise, the same
438          * RTC event generates 2 interrupts in a row.
439          * (no errata document available)
440          */
441         res = twl4030_i2c_read_u8(TWL4030_MODULE_INT, &rd_reg, REG_PWR_ISR1);
442         if (res)
443                 goto out;
444
445         rd_reg |= PWR_RTC_INT_CLR;
446         res = twl4030_i2c_write_u8(TWL4030_MODULE_INT, rd_reg, REG_PWR_ISR1);
447         if (res)
448                 goto out;
449
450         /* Notify RTC core on event */
451         rtc_update_irq(rtc, 1, events);
452
453         ret = IRQ_HANDLED;
454 out:
455         return ret;
456 }
457
458 static struct rtc_class_ops twl4030_rtc_ops = {
459         .ioctl = twl4030_rtc_ioctl,
460         .read_time = twl4030_rtc_read_time,
461         .set_time = twl4030_rtc_set_time,
462         .read_alarm = twl4030_rtc_read_alarm,
463         .set_alarm = twl4030_rtc_set_alarm,
464 };
465
466 static int __devinit twl4030_rtc_probe(struct platform_device *pdev)
467 {
468         struct twl4030rtc_platform_data *pdata = pdev->dev.platform_data;
469         struct rtc_device *rtc;
470         int ret = 0;
471         u8 rd_reg;
472         
473         if (pdata != NULL && pdata->init != NULL) {
474                 ret = pdata->init();
475                 if (ret < 0)
476                         goto out;
477         }
478
479         rtc = rtc_device_register(pdev->name,
480                                   &pdev->dev, &twl4030_rtc_ops, THIS_MODULE);
481         if (IS_ERR(rtc)) {
482                 ret = -EINVAL;
483                 dev_err(&pdev->dev, "can't register RTC device, err %ld\n",
484                         PTR_ERR(rtc));
485                 goto out0;
486
487         }
488
489         platform_set_drvdata(pdev, rtc);
490
491         ret = twl4030_rtc_read_u8(&rd_reg, REG_RTC_STATUS_REG);
492
493         if (ret < 0)
494                 goto out1;
495
496         if (rd_reg & BIT_RTC_STATUS_REG_POWER_UP_M)
497                 dev_warn(&pdev->dev, "Power up reset detected.\n");
498
499         if (rd_reg & BIT_RTC_STATUS_REG_ALARM_M)
500                 dev_warn(&pdev->dev, "Pending Alarm interrupt detected.\n");
501
502         /* Clear RTC Power up reset and pending alarm interrupts */
503         ret = twl4030_rtc_write_u8(rd_reg, REG_RTC_STATUS_REG);
504         if (ret < 0)
505                 goto out1;
506
507         ret = request_irq(TWL4030_MODIRQ_PWR, twl4030_rtc_interrupt,
508                           IRQF_DISABLED | IRQF_SHARED, rtc->dev.bus_id, rtc);
509         if (ret < 0) {
510                 dev_err(&pdev->dev, "IRQ is not free.\n");
511                 goto out1;
512         } 
513
514         /* Check RTC module status, Enable if it is off */
515         ret = twl4030_rtc_read_u8(&rd_reg, REG_RTC_CTRL_REG);
516         if (ret < 0)
517                 goto out2;
518
519         if (!(rd_reg & BIT_RTC_CTRL_REG_STOP_RTC_M)) {
520                 dev_info(&pdev->dev, "Enabling TWL4030-RTC.\n");
521                 rd_reg = BIT_RTC_CTRL_REG_STOP_RTC_M;
522                 ret = twl4030_rtc_write_u8(rd_reg, REG_RTC_CTRL_REG);
523                 if (ret < 0)
524                         goto out2;
525         }
526
527         ret = twl4030_i2c_read_u8(TWL4030_MODULE_INT, &rd_reg, REG_PWR_IMR1);
528         if (ret < 0)
529                 goto out2;
530
531         rd_reg &= PWR_RTC_IT_UNMASK;
532         /* MASK PWR - we will need this */
533         ret = twl4030_i2c_write_u8(TWL4030_MODULE_INT, rd_reg, REG_PWR_IMR1);
534         if (ret < 0)
535                 goto out2;
536
537         ret = twl4030_i2c_read_u8(TWL4030_MODULE_INT, &rd_reg, REG_PWR_EDR1);
538         if (ret < 0)
539                 goto out2;
540
541         /* Rising edge detection enabled, needed for RTC alarm */
542         rd_reg |= 0x80;         
543         ret = twl4030_i2c_write_u8(TWL4030_MODULE_INT, rd_reg, REG_PWR_EDR1);
544         if (ret < 0)
545                 goto out2;
546
547         return ret;
548
549
550 out2:
551         free_irq(TWL4030_MODIRQ_PWR, rtc);
552 out1:
553         rtc_device_unregister(rtc);
554 out0:
555         if (pdata != NULL && pdata->exit != NULL)
556                 pdata->exit();
557 out:
558         return ret;
559 }
560
561 /*
562  * Disable all TWL4030 RTC module interrupts.
563  * Sets status flag to free.
564  */
565 static int __devexit twl4030_rtc_remove(struct platform_device *pdev)
566 {
567         /* leave rtc running, but disable irqs */
568         struct twl4030rtc_platform_data *pdata = pdev->dev.platform_data;
569         struct rtc_device *rtc = platform_get_drvdata(pdev);
570
571         mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
572         mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M);
573
574         free_irq(TWL4030_MODIRQ_PWR, rtc);
575
576         if (pdata != NULL && pdata->exit != NULL) 
577                 pdata->exit();
578
579         rtc_device_unregister(rtc);
580         return 0;
581 }
582
583 static void twl4030_rtc_shutdown(struct platform_device *pdev)
584 {
585         twl4030_rtc_alarm_irq_set_state(&pdev->dev, 0);
586         twl4030_rtc_irq_set_state(&pdev->dev, 0);
587 }
588
589 #ifdef CONFIG_PM
590
591 static unsigned char irqstat = 0;
592
593 static int twl4030_rtc_suspend(struct platform_device *pdev, pm_message_t state)
594 {
595         get_rtc_irq_bit(&irqstat);
596
597         mask_rtc_irq_bit(BIT_RTC_INTERRUPTS_REG_IT_TIMER_M |
598                          BIT_RTC_INTERRUPTS_REG_IT_ALARM_M);
599         return 0;
600 }
601
602 static int twl4030_rtc_resume(struct platform_device *pdev)
603 {
604         set_rtc_irq_bit(irqstat);
605         return 0;
606 }
607 #else
608 #define twl4030_rtc_suspend NULL
609 #define twl4030_rtc_resume  NULL
610 #endif
611
612 MODULE_ALIAS("twl4030_rtc");
613 static struct platform_driver twl4030rtc_driver = {
614         .probe          = twl4030_rtc_probe,
615         .remove         = __devexit_p(twl4030_rtc_remove),
616         .shutdown       = twl4030_rtc_shutdown,
617         .suspend        = twl4030_rtc_suspend,
618         .resume         = twl4030_rtc_resume,
619         .driver         = {
620                 .owner  = THIS_MODULE,
621                 .name   = "twl4030_rtc",
622         },
623 };
624
625 static int __init twl4030_rtc_init(void)
626 {
627         return platform_driver_register(&twl4030rtc_driver);
628 }
629
630 static void __exit twl4030_rtc_exit(void)
631 {
632         platform_driver_unregister(&twl4030rtc_driver);
633 }
634
635 MODULE_AUTHOR("Texas Instruments, MontaVista Software");
636 MODULE_LICENSE("GPL");;
637
638 module_init(twl4030_rtc_init);
639 module_exit(twl4030_rtc_exit);