Commit | Line | Data |
---|---|---|
788b1fc6 AV |
1 | /* |
2 | * Real Time Clock interface for Linux on Atmel AT91RM9200 | |
3 | * | |
4 | * Copyright (C) 2002 Rick Bronson | |
5 | * | |
6 | * Converted to RTC class model by Andrew Victor | |
7 | * | |
8 | * Ported to Linux 2.6 by Steven Scholz | |
9 | * Based on s3c2410-rtc.c Simtec Electronics | |
10 | * | |
11 | * Based on sa1100-rtc.c by Nils Faerber | |
12 | * Based on rtc.c by Paul Gortmaker | |
13 | * | |
14 | * This program is free software; you can redistribute it and/or | |
15 | * modify it under the terms of the GNU General Public License | |
16 | * as published by the Free Software Foundation; either version | |
17 | * 2 of the License, or (at your option) any later version. | |
18 | * | |
19 | */ | |
20 | ||
21 | #include <linux/module.h> | |
22 | #include <linux/kernel.h> | |
23 | #include <linux/platform_device.h> | |
24 | #include <linux/time.h> | |
25 | #include <linux/rtc.h> | |
26 | #include <linux/bcd.h> | |
27 | #include <linux/interrupt.h> | |
28 | #include <linux/ioctl.h> | |
29 | #include <linux/completion.h> | |
30 | ||
31 | #include <asm/uaccess.h> | |
32 | #include <asm/rtc.h> | |
33 | ||
34 | #include <asm/mach/time.h> | |
35 | ||
36 | ||
37 | #define AT91_RTC_FREQ 1 | |
38 | #define AT91_RTC_EPOCH 1900UL /* just like arch/arm/common/rtctime.c */ | |
39 | ||
40 | static DECLARE_COMPLETION(at91_rtc_updated); | |
41 | static unsigned int at91_alarm_year = AT91_RTC_EPOCH; | |
42 | ||
788b1fc6 AV |
43 | /* |
44 | * Decode time/date into rtc_time structure | |
45 | */ | |
e7a8bb12 AM |
46 | static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg, |
47 | struct rtc_time *tm) | |
788b1fc6 AV |
48 | { |
49 | unsigned int time, date; | |
50 | ||
51 | /* must read twice in case it changes */ | |
52 | do { | |
53 | time = at91_sys_read(timereg); | |
54 | date = at91_sys_read(calreg); | |
e7a8bb12 AM |
55 | } while ((time != at91_sys_read(timereg)) || |
56 | (date != at91_sys_read(calreg))); | |
788b1fc6 AV |
57 | |
58 | tm->tm_sec = BCD2BIN((time & AT91_RTC_SEC) >> 0); | |
59 | tm->tm_min = BCD2BIN((time & AT91_RTC_MIN) >> 8); | |
60 | tm->tm_hour = BCD2BIN((time & AT91_RTC_HOUR) >> 16); | |
61 | ||
62 | /* | |
63 | * The Calendar Alarm register does not have a field for | |
64 | * the year - so these will return an invalid value. When an | |
65 | * alarm is set, at91_alarm_year wille store the current year. | |
66 | */ | |
e7a8bb12 AM |
67 | tm->tm_year = BCD2BIN(date & AT91_RTC_CENT) * 100; /* century */ |
68 | tm->tm_year += BCD2BIN((date & AT91_RTC_YEAR) >> 8); /* year */ | |
788b1fc6 AV |
69 | |
70 | tm->tm_wday = BCD2BIN((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */ | |
71 | tm->tm_mon = BCD2BIN((date & AT91_RTC_MONTH) >> 16) - 1; | |
72 | tm->tm_mday = BCD2BIN((date & AT91_RTC_DATE) >> 24); | |
73 | } | |
74 | ||
75 | /* | |
76 | * Read current time and date in RTC | |
77 | */ | |
78 | static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm) | |
79 | { | |
80 | at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm); | |
81 | tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year); | |
82 | tm->tm_year = tm->tm_year - 1900; | |
83 | ||
84 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
85 | 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday, |
86 | tm->tm_hour, tm->tm_min, tm->tm_sec); | |
788b1fc6 AV |
87 | |
88 | return 0; | |
89 | } | |
90 | ||
91 | /* | |
92 | * Set current time and date in RTC | |
93 | */ | |
94 | static int at91_rtc_settime(struct device *dev, struct rtc_time *tm) | |
95 | { | |
96 | unsigned long cr; | |
97 | ||
98 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
99 | 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday, |
100 | tm->tm_hour, tm->tm_min, tm->tm_sec); | |
788b1fc6 AV |
101 | |
102 | /* Stop Time/Calendar from counting */ | |
103 | cr = at91_sys_read(AT91_RTC_CR); | |
104 | at91_sys_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM); | |
105 | ||
106 | at91_sys_write(AT91_RTC_IER, AT91_RTC_ACKUPD); | |
e7a8bb12 | 107 | wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */ |
788b1fc6 AV |
108 | at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD); |
109 | ||
110 | at91_sys_write(AT91_RTC_TIMR, | |
111 | BIN2BCD(tm->tm_sec) << 0 | |
112 | | BIN2BCD(tm->tm_min) << 8 | |
113 | | BIN2BCD(tm->tm_hour) << 16); | |
114 | ||
115 | at91_sys_write(AT91_RTC_CALR, | |
e7a8bb12 AM |
116 | BIN2BCD((tm->tm_year + 1900) / 100) /* century */ |
117 | | BIN2BCD(tm->tm_year % 100) << 8 /* year */ | |
118 | | BIN2BCD(tm->tm_mon + 1) << 16 /* tm_mon starts at zero */ | |
119 | | BIN2BCD(tm->tm_wday + 1) << 21 /* day of the week [0-6], Sunday=0 */ | |
788b1fc6 AV |
120 | | BIN2BCD(tm->tm_mday) << 24); |
121 | ||
122 | /* Restart Time/Calendar */ | |
123 | cr = at91_sys_read(AT91_RTC_CR); | |
124 | at91_sys_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM)); | |
125 | ||
126 | return 0; | |
127 | } | |
128 | ||
129 | /* | |
130 | * Read alarm time and date in RTC | |
131 | */ | |
132 | static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm) | |
133 | { | |
134 | struct rtc_time *tm = &alrm->time; | |
135 | ||
136 | at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm); | |
137 | tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year); | |
138 | tm->tm_year = at91_alarm_year - 1900; | |
139 | ||
140 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
141 | 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday, |
142 | tm->tm_hour, tm->tm_min, tm->tm_sec); | |
788b1fc6 AV |
143 | |
144 | return 0; | |
145 | } | |
146 | ||
147 | /* | |
148 | * Set alarm time and date in RTC | |
149 | */ | |
150 | static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm) | |
151 | { | |
152 | struct rtc_time tm; | |
153 | ||
154 | at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm); | |
155 | ||
156 | at91_alarm_year = tm.tm_year; | |
157 | ||
158 | tm.tm_hour = alrm->time.tm_hour; | |
159 | tm.tm_min = alrm->time.tm_min; | |
160 | tm.tm_sec = alrm->time.tm_sec; | |
161 | ||
162 | at91_sys_write(AT91_RTC_TIMALR, | |
163 | BIN2BCD(tm.tm_sec) << 0 | |
164 | | BIN2BCD(tm.tm_min) << 8 | |
165 | | BIN2BCD(tm.tm_hour) << 16 | |
166 | | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN); | |
167 | at91_sys_write(AT91_RTC_CALALR, | |
168 | BIN2BCD(tm.tm_mon + 1) << 16 /* tm_mon starts at zero */ | |
169 | | BIN2BCD(tm.tm_mday) << 24 | |
170 | | AT91_RTC_DATEEN | AT91_RTC_MTHEN); | |
171 | ||
172 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
173 | at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour, |
174 | tm.tm_min, tm.tm_sec); | |
788b1fc6 AV |
175 | |
176 | return 0; | |
177 | } | |
178 | ||
179 | /* | |
180 | * Handle commands from user-space | |
181 | */ | |
e7a8bb12 AM |
182 | static int at91_rtc_ioctl(struct device *dev, unsigned int cmd, |
183 | unsigned long arg) | |
788b1fc6 AV |
184 | { |
185 | int ret = 0; | |
186 | ||
187 | pr_debug("%s(): cmd=%08x, arg=%08lx.\n", __FUNCTION__, cmd, arg); | |
188 | ||
189 | switch (cmd) { | |
190 | case RTC_AIE_OFF: /* alarm off */ | |
191 | at91_sys_write(AT91_RTC_IDR, AT91_RTC_ALARM); | |
192 | break; | |
193 | case RTC_AIE_ON: /* alarm on */ | |
194 | at91_sys_write(AT91_RTC_IER, AT91_RTC_ALARM); | |
195 | break; | |
196 | case RTC_UIE_OFF: /* update off */ | |
197 | case RTC_PIE_OFF: /* periodic off */ | |
198 | at91_sys_write(AT91_RTC_IDR, AT91_RTC_SECEV); | |
199 | break; | |
200 | case RTC_UIE_ON: /* update on */ | |
201 | case RTC_PIE_ON: /* periodic on */ | |
202 | at91_sys_write(AT91_RTC_IER, AT91_RTC_SECEV); | |
203 | break; | |
204 | case RTC_IRQP_READ: /* read periodic alarm frequency */ | |
205 | ret = put_user(AT91_RTC_FREQ, (unsigned long *) arg); | |
206 | break; | |
207 | case RTC_IRQP_SET: /* set periodic alarm frequency */ | |
208 | if (arg != AT91_RTC_FREQ) | |
209 | ret = -EINVAL; | |
210 | break; | |
211 | default: | |
212 | ret = -ENOIOCTLCMD; | |
213 | break; | |
214 | } | |
215 | ||
216 | return ret; | |
217 | } | |
218 | ||
219 | /* | |
220 | * Provide additional RTC information in /proc/driver/rtc | |
221 | */ | |
222 | static int at91_rtc_proc(struct device *dev, struct seq_file *seq) | |
223 | { | |
224 | unsigned long imr = at91_sys_read(AT91_RTC_IMR); | |
225 | ||
e7a8bb12 AM |
226 | seq_printf(seq, "alarm_IRQ\t: %s\n", |
227 | (imr & AT91_RTC_ALARM) ? "yes" : "no"); | |
228 | seq_printf(seq, "update_IRQ\t: %s\n", | |
229 | (imr & AT91_RTC_ACKUPD) ? "yes" : "no"); | |
230 | seq_printf(seq, "periodic_IRQ\t: %s\n", | |
231 | (imr & AT91_RTC_SECEV) ? "yes" : "no"); | |
232 | seq_printf(seq, "periodic_freq\t: %ld\n", | |
233 | (unsigned long) AT91_RTC_FREQ); | |
788b1fc6 AV |
234 | |
235 | return 0; | |
236 | } | |
237 | ||
238 | /* | |
239 | * IRQ handler for the RTC | |
240 | */ | |
e7a8bb12 AM |
241 | static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id, |
242 | struct pt_regs *regs) | |
788b1fc6 | 243 | { |
e7a8bb12 | 244 | struct platform_device *pdev = dev_id; |
788b1fc6 AV |
245 | struct rtc_device *rtc = platform_get_drvdata(pdev); |
246 | unsigned int rtsr; | |
247 | unsigned long events = 0; | |
248 | ||
249 | rtsr = at91_sys_read(AT91_RTC_SR) & at91_sys_read(AT91_RTC_IMR); | |
250 | if (rtsr) { /* this interrupt is shared! Is it ours? */ | |
251 | if (rtsr & AT91_RTC_ALARM) | |
252 | events |= (RTC_AF | RTC_IRQF); | |
253 | if (rtsr & AT91_RTC_SECEV) | |
254 | events |= (RTC_UF | RTC_IRQF); | |
255 | if (rtsr & AT91_RTC_ACKUPD) | |
256 | complete(&at91_rtc_updated); | |
257 | ||
e7a8bb12 | 258 | at91_sys_write(AT91_RTC_SCCR, rtsr); /* clear status reg */ |
788b1fc6 AV |
259 | |
260 | rtc_update_irq(&rtc->class_dev, 1, events); | |
261 | ||
262 | pr_debug("%s(): num=%ld, events=0x%02lx\n", __FUNCTION__, | |
263 | events >> 8, events & 0x000000FF); | |
264 | ||
265 | return IRQ_HANDLED; | |
266 | } | |
267 | return IRQ_NONE; /* not handled */ | |
268 | } | |
269 | ||
270 | static struct rtc_class_ops at91_rtc_ops = { | |
271 | .ioctl = at91_rtc_ioctl, | |
272 | .read_time = at91_rtc_readtime, | |
273 | .set_time = at91_rtc_settime, | |
274 | .read_alarm = at91_rtc_readalarm, | |
275 | .set_alarm = at91_rtc_setalarm, | |
276 | .proc = at91_rtc_proc, | |
277 | }; | |
278 | ||
279 | /* | |
280 | * Initialize and install RTC driver | |
281 | */ | |
282 | static int __init at91_rtc_probe(struct platform_device *pdev) | |
283 | { | |
284 | struct rtc_device *rtc; | |
285 | int ret; | |
286 | ||
287 | at91_sys_write(AT91_RTC_CR, 0); | |
288 | at91_sys_write(AT91_RTC_MR, 0); /* 24 hour mode */ | |
289 | ||
290 | /* Disable all interrupts */ | |
e7a8bb12 AM |
291 | at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM | |
292 | AT91_RTC_SECEV | AT91_RTC_TIMEV | | |
293 | AT91_RTC_CALEV); | |
788b1fc6 | 294 | |
e7a8bb12 AM |
295 | ret = request_irq(AT91_ID_SYS, at91_rtc_interrupt, |
296 | SA_SHIRQ, "at91_rtc", pdev); | |
788b1fc6 | 297 | if (ret) { |
e7a8bb12 AM |
298 | printk(KERN_ERR "at91_rtc: IRQ %d already in use.\n", |
299 | AT91_ID_SYS); | |
788b1fc6 AV |
300 | return ret; |
301 | } | |
302 | ||
e7a8bb12 AM |
303 | rtc = rtc_device_register(pdev->name, &pdev->dev, |
304 | &at91_rtc_ops, THIS_MODULE); | |
788b1fc6 AV |
305 | if (IS_ERR(rtc)) { |
306 | free_irq(AT91_ID_SYS, pdev); | |
307 | return PTR_ERR(rtc); | |
308 | } | |
309 | platform_set_drvdata(pdev, rtc); | |
310 | ||
311 | printk(KERN_INFO "AT91 Real Time Clock driver.\n"); | |
312 | return 0; | |
313 | } | |
314 | ||
315 | /* | |
316 | * Disable and remove the RTC driver | |
317 | */ | |
318 | static int __devexit at91_rtc_remove(struct platform_device *pdev) | |
319 | { | |
320 | struct rtc_device *rtc = platform_get_drvdata(pdev); | |
321 | ||
322 | /* Disable all interrupts */ | |
e7a8bb12 AM |
323 | at91_sys_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM | |
324 | AT91_RTC_SECEV | AT91_RTC_TIMEV | | |
325 | AT91_RTC_CALEV); | |
788b1fc6 AV |
326 | free_irq(AT91_ID_SYS, pdev); |
327 | ||
328 | rtc_device_unregister(rtc); | |
329 | platform_set_drvdata(pdev, NULL); | |
330 | ||
331 | return 0; | |
332 | } | |
333 | ||
334 | #ifdef CONFIG_PM | |
335 | ||
336 | /* AT91RM9200 RTC Power management control */ | |
337 | ||
338 | static struct timespec at91_rtc_delta; | |
339 | ||
340 | static int at91_rtc_suspend(struct platform_device *pdev, pm_message_t state) | |
341 | { | |
342 | struct rtc_time tm; | |
343 | struct timespec time; | |
344 | ||
345 | time.tv_nsec = 0; | |
346 | ||
347 | /* calculate time delta for suspend */ | |
348 | at91_rtc_readtime(&pdev->dev, &tm); | |
349 | rtc_tm_to_time(&tm, &time.tv_sec); | |
350 | save_time_delta(&at91_rtc_delta, &time); | |
351 | ||
352 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
353 | 1900 + tm.tm_year, tm.tm_mon, tm.tm_mday, |
354 | tm.tm_hour, tm.tm_min, tm.tm_sec); | |
788b1fc6 AV |
355 | |
356 | return 0; | |
357 | } | |
358 | ||
359 | static int at91_rtc_resume(struct platform_device *pdev) | |
360 | { | |
361 | struct rtc_time tm; | |
362 | struct timespec time; | |
363 | ||
364 | time.tv_nsec = 0; | |
365 | ||
366 | at91_rtc_readtime(&pdev->dev, &tm); | |
367 | rtc_tm_to_time(&tm, &time.tv_sec); | |
368 | restore_time_delta(&at91_rtc_delta, &time); | |
369 | ||
370 | pr_debug("%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __FUNCTION__, | |
e7a8bb12 AM |
371 | 1900 + tm.tm_year, tm.tm_mon, tm.tm_mday, |
372 | tm.tm_hour, tm.tm_min, tm.tm_sec); | |
788b1fc6 AV |
373 | |
374 | return 0; | |
375 | } | |
376 | #else | |
377 | #define at91_rtc_suspend NULL | |
378 | #define at91_rtc_resume NULL | |
379 | #endif | |
380 | ||
381 | static struct platform_driver at91_rtc_driver = { | |
382 | .probe = at91_rtc_probe, | |
383 | .remove = at91_rtc_remove, | |
384 | .suspend = at91_rtc_suspend, | |
385 | .resume = at91_rtc_resume, | |
386 | .driver = { | |
387 | .name = "at91_rtc", | |
388 | .owner = THIS_MODULE, | |
389 | }, | |
390 | }; | |
391 | ||
392 | static int __init at91_rtc_init(void) | |
393 | { | |
394 | return platform_driver_register(&at91_rtc_driver); | |
395 | } | |
396 | ||
397 | static void __exit at91_rtc_exit(void) | |
398 | { | |
399 | platform_driver_unregister(&at91_rtc_driver); | |
400 | } | |
401 | ||
788b1fc6 AV |
402 | module_init(at91_rtc_init); |
403 | module_exit(at91_rtc_exit); | |
404 | ||
405 | MODULE_AUTHOR("Rick Bronson"); | |
406 | MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200"); | |
407 | MODULE_LICENSE("GPL"); |