thinkpad-acpi: constrain IBM-era support to IBM boxes
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / rtc / rtc-vr41xx.c
blobc3244244e8cfd7a508963cdcc9e4d16fba57a78c
1 /*
2 * Driver for NEC VR4100 series Real Time Clock unit.
4 * Copyright (C) 2003-2008 Yoichi Yuasa <yuasa@linux-mips.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/err.h>
21 #include <linux/fs.h>
22 #include <linux/init.h>
23 #include <linux/ioport.h>
24 #include <linux/interrupt.h>
25 #include <linux/module.h>
26 #include <linux/platform_device.h>
27 #include <linux/rtc.h>
28 #include <linux/spinlock.h>
29 #include <linux/types.h>
30 #include <linux/log2.h>
32 #include <asm/div64.h>
33 #include <asm/io.h>
34 #include <asm/uaccess.h>
36 MODULE_AUTHOR("Yoichi Yuasa <yuasa@linux-mips.org>");
37 MODULE_DESCRIPTION("NEC VR4100 series RTC driver");
38 MODULE_LICENSE("GPL v2");
40 /* RTC 1 registers */
41 #define ETIMELREG 0x00
42 #define ETIMEMREG 0x02
43 #define ETIMEHREG 0x04
44 /* RFU */
45 #define ECMPLREG 0x08
46 #define ECMPMREG 0x0a
47 #define ECMPHREG 0x0c
48 /* RFU */
49 #define RTCL1LREG 0x10
50 #define RTCL1HREG 0x12
51 #define RTCL1CNTLREG 0x14
52 #define RTCL1CNTHREG 0x16
53 #define RTCL2LREG 0x18
54 #define RTCL2HREG 0x1a
55 #define RTCL2CNTLREG 0x1c
56 #define RTCL2CNTHREG 0x1e
58 /* RTC 2 registers */
59 #define TCLKLREG 0x00
60 #define TCLKHREG 0x02
61 #define TCLKCNTLREG 0x04
62 #define TCLKCNTHREG 0x06
63 /* RFU */
64 #define RTCINTREG 0x1e
65 #define TCLOCK_INT 0x08
66 #define RTCLONG2_INT 0x04
67 #define RTCLONG1_INT 0x02
68 #define ELAPSEDTIME_INT 0x01
70 #define RTC_FREQUENCY 32768
71 #define MAX_PERIODIC_RATE 6553
73 static void __iomem *rtc1_base;
74 static void __iomem *rtc2_base;
76 #define rtc1_read(offset) readw(rtc1_base + (offset))
77 #define rtc1_write(offset, value) writew((value), rtc1_base + (offset))
79 #define rtc2_read(offset) readw(rtc2_base + (offset))
80 #define rtc2_write(offset, value) writew((value), rtc2_base + (offset))
82 static unsigned long epoch = 1970; /* Jan 1 1970 00:00:00 */
84 static DEFINE_SPINLOCK(rtc_lock);
85 static char rtc_name[] = "RTC";
86 static unsigned long periodic_count;
87 static unsigned int alarm_enabled;
88 static int aie_irq;
89 static int pie_irq;
91 static inline unsigned long read_elapsed_second(void)
94 unsigned long first_low, first_mid, first_high;
96 unsigned long second_low, second_mid, second_high;
98 do {
99 first_low = rtc1_read(ETIMELREG);
100 first_mid = rtc1_read(ETIMEMREG);
101 first_high = rtc1_read(ETIMEHREG);
102 second_low = rtc1_read(ETIMELREG);
103 second_mid = rtc1_read(ETIMEMREG);
104 second_high = rtc1_read(ETIMEHREG);
105 } while (first_low != second_low || first_mid != second_mid ||
106 first_high != second_high);
108 return (first_high << 17) | (first_mid << 1) | (first_low >> 15);
111 static inline void write_elapsed_second(unsigned long sec)
113 spin_lock_irq(&rtc_lock);
115 rtc1_write(ETIMELREG, (uint16_t)(sec << 15));
116 rtc1_write(ETIMEMREG, (uint16_t)(sec >> 1));
117 rtc1_write(ETIMEHREG, (uint16_t)(sec >> 17));
119 spin_unlock_irq(&rtc_lock);
122 static void vr41xx_rtc_release(struct device *dev)
125 spin_lock_irq(&rtc_lock);
127 rtc1_write(ECMPLREG, 0);
128 rtc1_write(ECMPMREG, 0);
129 rtc1_write(ECMPHREG, 0);
130 rtc1_write(RTCL1LREG, 0);
131 rtc1_write(RTCL1HREG, 0);
133 spin_unlock_irq(&rtc_lock);
135 disable_irq(aie_irq);
136 disable_irq(pie_irq);
139 static int vr41xx_rtc_read_time(struct device *dev, struct rtc_time *time)
141 unsigned long epoch_sec, elapsed_sec;
143 epoch_sec = mktime(epoch, 1, 1, 0, 0, 0);
144 elapsed_sec = read_elapsed_second();
146 rtc_time_to_tm(epoch_sec + elapsed_sec, time);
148 return 0;
151 static int vr41xx_rtc_set_time(struct device *dev, struct rtc_time *time)
153 unsigned long epoch_sec, current_sec;
155 epoch_sec = mktime(epoch, 1, 1, 0, 0, 0);
156 current_sec = mktime(time->tm_year + 1900, time->tm_mon + 1, time->tm_mday,
157 time->tm_hour, time->tm_min, time->tm_sec);
159 write_elapsed_second(current_sec - epoch_sec);
161 return 0;
164 static int vr41xx_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
166 unsigned long low, mid, high;
167 struct rtc_time *time = &wkalrm->time;
169 spin_lock_irq(&rtc_lock);
171 low = rtc1_read(ECMPLREG);
172 mid = rtc1_read(ECMPMREG);
173 high = rtc1_read(ECMPHREG);
174 wkalrm->enabled = alarm_enabled;
176 spin_unlock_irq(&rtc_lock);
178 rtc_time_to_tm((high << 17) | (mid << 1) | (low >> 15), time);
180 return 0;
183 static int vr41xx_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
185 unsigned long alarm_sec;
186 struct rtc_time *time = &wkalrm->time;
188 alarm_sec = mktime(time->tm_year + 1900, time->tm_mon + 1, time->tm_mday,
189 time->tm_hour, time->tm_min, time->tm_sec);
191 spin_lock_irq(&rtc_lock);
193 if (alarm_enabled)
194 disable_irq(aie_irq);
196 rtc1_write(ECMPLREG, (uint16_t)(alarm_sec << 15));
197 rtc1_write(ECMPMREG, (uint16_t)(alarm_sec >> 1));
198 rtc1_write(ECMPHREG, (uint16_t)(alarm_sec >> 17));
200 if (wkalrm->enabled)
201 enable_irq(aie_irq);
203 alarm_enabled = wkalrm->enabled;
205 spin_unlock_irq(&rtc_lock);
207 return 0;
210 static int vr41xx_rtc_irq_set_freq(struct device *dev, int freq)
212 u64 count;
214 if (!is_power_of_2(freq))
215 return -EINVAL;
216 count = RTC_FREQUENCY;
217 do_div(count, freq);
219 spin_lock_irq(&rtc_lock);
221 periodic_count = count;
222 rtc1_write(RTCL1LREG, periodic_count);
223 rtc1_write(RTCL1HREG, periodic_count >> 16);
225 spin_unlock_irq(&rtc_lock);
227 return 0;
230 static int vr41xx_rtc_irq_set_state(struct device *dev, int enabled)
232 if (enabled)
233 enable_irq(pie_irq);
234 else
235 disable_irq(pie_irq);
237 return 0;
240 static int vr41xx_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
242 switch (cmd) {
243 case RTC_AIE_ON:
244 spin_lock_irq(&rtc_lock);
246 if (!alarm_enabled) {
247 enable_irq(aie_irq);
248 alarm_enabled = 1;
251 spin_unlock_irq(&rtc_lock);
252 break;
253 case RTC_AIE_OFF:
254 spin_lock_irq(&rtc_lock);
256 if (alarm_enabled) {
257 disable_irq(aie_irq);
258 alarm_enabled = 0;
261 spin_unlock_irq(&rtc_lock);
262 break;
263 case RTC_EPOCH_READ:
264 return put_user(epoch, (unsigned long __user *)arg);
265 case RTC_EPOCH_SET:
266 /* Doesn't support before 1900 */
267 if (arg < 1900)
268 return -EINVAL;
269 epoch = arg;
270 break;
271 default:
272 return -ENOIOCTLCMD;
275 return 0;
278 static irqreturn_t elapsedtime_interrupt(int irq, void *dev_id)
280 struct platform_device *pdev = (struct platform_device *)dev_id;
281 struct rtc_device *rtc = platform_get_drvdata(pdev);
283 rtc2_write(RTCINTREG, ELAPSEDTIME_INT);
285 rtc_update_irq(rtc, 1, RTC_AF);
287 return IRQ_HANDLED;
290 static irqreturn_t rtclong1_interrupt(int irq, void *dev_id)
292 struct platform_device *pdev = (struct platform_device *)dev_id;
293 struct rtc_device *rtc = platform_get_drvdata(pdev);
294 unsigned long count = periodic_count;
296 rtc2_write(RTCINTREG, RTCLONG1_INT);
298 rtc1_write(RTCL1LREG, count);
299 rtc1_write(RTCL1HREG, count >> 16);
301 rtc_update_irq(rtc, 1, RTC_PF);
303 return IRQ_HANDLED;
306 static const struct rtc_class_ops vr41xx_rtc_ops = {
307 .release = vr41xx_rtc_release,
308 .ioctl = vr41xx_rtc_ioctl,
309 .read_time = vr41xx_rtc_read_time,
310 .set_time = vr41xx_rtc_set_time,
311 .read_alarm = vr41xx_rtc_read_alarm,
312 .set_alarm = vr41xx_rtc_set_alarm,
313 .irq_set_freq = vr41xx_rtc_irq_set_freq,
314 .irq_set_state = vr41xx_rtc_irq_set_state,
317 static int __devinit rtc_probe(struct platform_device *pdev)
319 struct resource *res;
320 struct rtc_device *rtc;
321 int retval;
323 if (pdev->num_resources != 4)
324 return -EBUSY;
326 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
327 if (!res)
328 return -EBUSY;
330 rtc1_base = ioremap(res->start, resource_size(res));
331 if (!rtc1_base)
332 return -EBUSY;
334 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
335 if (!res) {
336 retval = -EBUSY;
337 goto err_rtc1_iounmap;
340 rtc2_base = ioremap(res->start, resource_size(res));
341 if (!rtc2_base) {
342 retval = -EBUSY;
343 goto err_rtc1_iounmap;
346 rtc = rtc_device_register(rtc_name, &pdev->dev, &vr41xx_rtc_ops, THIS_MODULE);
347 if (IS_ERR(rtc)) {
348 retval = PTR_ERR(rtc);
349 goto err_iounmap_all;
352 rtc->max_user_freq = MAX_PERIODIC_RATE;
354 spin_lock_irq(&rtc_lock);
356 rtc1_write(ECMPLREG, 0);
357 rtc1_write(ECMPMREG, 0);
358 rtc1_write(ECMPHREG, 0);
359 rtc1_write(RTCL1LREG, 0);
360 rtc1_write(RTCL1HREG, 0);
362 spin_unlock_irq(&rtc_lock);
364 aie_irq = platform_get_irq(pdev, 0);
365 if (aie_irq <= 0) {
366 retval = -EBUSY;
367 goto err_device_unregister;
370 retval = request_irq(aie_irq, elapsedtime_interrupt, IRQF_DISABLED,
371 "elapsed_time", pdev);
372 if (retval < 0)
373 goto err_device_unregister;
375 pie_irq = platform_get_irq(pdev, 1);
376 if (pie_irq <= 0)
377 goto err_free_irq;
379 retval = request_irq(pie_irq, rtclong1_interrupt, IRQF_DISABLED,
380 "rtclong1", pdev);
381 if (retval < 0)
382 goto err_free_irq;
384 platform_set_drvdata(pdev, rtc);
386 disable_irq(aie_irq);
387 disable_irq(pie_irq);
389 printk(KERN_INFO "rtc: Real Time Clock of NEC VR4100 series\n");
391 return 0;
393 err_free_irq:
394 free_irq(aie_irq, pdev);
396 err_device_unregister:
397 rtc_device_unregister(rtc);
399 err_iounmap_all:
400 iounmap(rtc2_base);
401 rtc2_base = NULL;
403 err_rtc1_iounmap:
404 iounmap(rtc1_base);
405 rtc1_base = NULL;
407 return retval;
410 static int __devexit rtc_remove(struct platform_device *pdev)
412 struct rtc_device *rtc;
414 rtc = platform_get_drvdata(pdev);
415 if (rtc)
416 rtc_device_unregister(rtc);
418 platform_set_drvdata(pdev, NULL);
420 free_irq(aie_irq, pdev);
421 free_irq(pie_irq, pdev);
422 if (rtc1_base)
423 iounmap(rtc1_base);
424 if (rtc2_base)
425 iounmap(rtc2_base);
427 return 0;
430 /* work with hotplug and coldplug */
431 MODULE_ALIAS("platform:RTC");
433 static struct platform_driver rtc_platform_driver = {
434 .probe = rtc_probe,
435 .remove = __devexit_p(rtc_remove),
436 .driver = {
437 .name = rtc_name,
438 .owner = THIS_MODULE,
442 static int __init vr41xx_rtc_init(void)
444 return platform_driver_register(&rtc_platform_driver);
447 static void __exit vr41xx_rtc_exit(void)
449 platform_driver_unregister(&rtc_platform_driver);
452 module_init(vr41xx_rtc_init);
453 module_exit(vr41xx_rtc_exit);