RTC: Cleanup rtc_class_ops->irq_set_state
[linux-2.6.git] / drivers / rtc / rtc-cmos.c
1 /*
2  * RTC class driver for "CMOS RTC":  PCs, ACPI, etc
3  *
4  * Copyright (C) 1996 Paul Gortmaker (drivers/char/rtc.c)
5  * Copyright (C) 2006 David Brownell (convert to new framework)
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version
10  * 2 of the License, or (at your option) any later version.
11  */
12
13 /*
14  * The original "cmos clock" chip was an MC146818 chip, now obsolete.
15  * That defined the register interface now provided by all PCs, some
16  * non-PC systems, and incorporated into ACPI.  Modern PC chipsets
17  * integrate an MC146818 clone in their southbridge, and boards use
18  * that instead of discrete clones like the DS12887 or M48T86.  There
19  * are also clones that connect using the LPC bus.
20  *
21  * That register API is also used directly by various other drivers
22  * (notably for integrated NVRAM), infrastructure (x86 has code to
23  * bypass the RTC framework, directly reading the RTC during boot
24  * and updating minutes/seconds for systems using NTP synch) and
25  * utilities (like userspace 'hwclock', if no /dev node exists).
26  *
27  * So **ALL** calls to CMOS_READ and CMOS_WRITE must be done with
28  * interrupts disabled, holding the global rtc_lock, to exclude those
29  * other drivers and utilities on correctly configured systems.
30  */
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/init.h>
34 #include <linux/interrupt.h>
35 #include <linux/spinlock.h>
36 #include <linux/platform_device.h>
37 #include <linux/mod_devicetable.h>
38 #include <linux/log2.h>
39 #include <linux/pm.h>
40
41 /* this is for "generic access to PC-style RTC" using CMOS_READ/CMOS_WRITE */
42 #include <asm-generic/rtc.h>
43
44 struct cmos_rtc {
45         struct rtc_device       *rtc;
46         struct device           *dev;
47         int                     irq;
48         struct resource         *iomem;
49
50         void                    (*wake_on)(struct device *);
51         void                    (*wake_off)(struct device *);
52
53         u8                      enabled_wake;
54         u8                      suspend_ctrl;
55
56         /* newer hardware extends the original register set */
57         u8                      day_alrm;
58         u8                      mon_alrm;
59         u8                      century;
60 };
61
62 /* both platform and pnp busses use negative numbers for invalid irqs */
63 #define is_valid_irq(n)         ((n) > 0)
64
65 static const char driver_name[] = "rtc_cmos";
66
67 /* The RTC_INTR register may have e.g. RTC_PF set even if RTC_PIE is clear;
68  * always mask it against the irq enable bits in RTC_CONTROL.  Bit values
69  * are the same: PF==PIE, AF=AIE, UF=UIE; so RTC_IRQMASK works with both.
70  */
71 #define RTC_IRQMASK     (RTC_PF | RTC_AF | RTC_UF)
72
73 static inline int is_intr(u8 rtc_intr)
74 {
75         if (!(rtc_intr & RTC_IRQF))
76                 return 0;
77         return rtc_intr & RTC_IRQMASK;
78 }
79
80 /*----------------------------------------------------------------*/
81
82 /* Much modern x86 hardware has HPETs (10+ MHz timers) which, because
83  * many BIOS programmers don't set up "sane mode" IRQ routing, are mostly
84  * used in a broken "legacy replacement" mode.  The breakage includes
85  * HPET #1 hijacking the IRQ for this RTC, and being unavailable for
86  * other (better) use.
87  *
88  * When that broken mode is in use, platform glue provides a partial
89  * emulation of hardware RTC IRQ facilities using HPET #1.  We don't
90  * want to use HPET for anything except those IRQs though...
91  */
92 #ifdef CONFIG_HPET_EMULATE_RTC
93 #include <asm/hpet.h>
94 #else
95
96 static inline int is_hpet_enabled(void)
97 {
98         return 0;
99 }
100
101 static inline int hpet_mask_rtc_irq_bit(unsigned long mask)
102 {
103         return 0;
104 }
105
106 static inline int hpet_set_rtc_irq_bit(unsigned long mask)
107 {
108         return 0;
109 }
110
111 static inline int
112 hpet_set_alarm_time(unsigned char hrs, unsigned char min, unsigned char sec)
113 {
114         return 0;
115 }
116
117 static inline int hpet_set_periodic_freq(unsigned long freq)
118 {
119         return 0;
120 }
121
122 static inline int hpet_rtc_dropped_irq(void)
123 {
124         return 0;
125 }
126
127 static inline int hpet_rtc_timer_init(void)
128 {
129         return 0;
130 }
131
132 extern irq_handler_t hpet_rtc_interrupt;
133
134 static inline int hpet_register_irq_handler(irq_handler_t handler)
135 {
136         return 0;
137 }
138
139 static inline int hpet_unregister_irq_handler(irq_handler_t handler)
140 {
141         return 0;
142 }
143
144 #endif
145
146 /*----------------------------------------------------------------*/
147
148 #ifdef RTC_PORT
149
150 /* Most newer x86 systems have two register banks, the first used
151  * for RTC and NVRAM and the second only for NVRAM.  Caller must
152  * own rtc_lock ... and we won't worry about access during NMI.
153  */
154 #define can_bank2       true
155
156 static inline unsigned char cmos_read_bank2(unsigned char addr)
157 {
158         outb(addr, RTC_PORT(2));
159         return inb(RTC_PORT(3));
160 }
161
162 static inline void cmos_write_bank2(unsigned char val, unsigned char addr)
163 {
164         outb(addr, RTC_PORT(2));
165         outb(val, RTC_PORT(2));
166 }
167
168 #else
169
170 #define can_bank2       false
171
172 static inline unsigned char cmos_read_bank2(unsigned char addr)
173 {
174         return 0;
175 }
176
177 static inline void cmos_write_bank2(unsigned char val, unsigned char addr)
178 {
179 }
180
181 #endif
182
183 /*----------------------------------------------------------------*/
184
185 static int cmos_read_time(struct device *dev, struct rtc_time *t)
186 {
187         /* REVISIT:  if the clock has a "century" register, use
188          * that instead of the heuristic in get_rtc_time().
189          * That'll make Y3K compatility (year > 2070) easy!
190          */
191         get_rtc_time(t);
192         return 0;
193 }
194
195 static int cmos_set_time(struct device *dev, struct rtc_time *t)
196 {
197         /* REVISIT:  set the "century" register if available
198          *
199          * NOTE: this ignores the issue whereby updating the seconds
200          * takes effect exactly 500ms after we write the register.
201          * (Also queueing and other delays before we get this far.)
202          */
203         return set_rtc_time(t);
204 }
205
206 static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t)
207 {
208         struct cmos_rtc *cmos = dev_get_drvdata(dev);
209         unsigned char   rtc_control;
210
211         if (!is_valid_irq(cmos->irq))
212                 return -EIO;
213
214         /* Basic alarms only support hour, minute, and seconds fields.
215          * Some also support day and month, for alarms up to a year in
216          * the future.
217          */
218         t->time.tm_mday = -1;
219         t->time.tm_mon = -1;
220
221         spin_lock_irq(&rtc_lock);
222         t->time.tm_sec = CMOS_READ(RTC_SECONDS_ALARM);
223         t->time.tm_min = CMOS_READ(RTC_MINUTES_ALARM);
224         t->time.tm_hour = CMOS_READ(RTC_HOURS_ALARM);
225
226         if (cmos->day_alrm) {
227                 /* ignore upper bits on readback per ACPI spec */
228                 t->time.tm_mday = CMOS_READ(cmos->day_alrm) & 0x3f;
229                 if (!t->time.tm_mday)
230                         t->time.tm_mday = -1;
231
232                 if (cmos->mon_alrm) {
233                         t->time.tm_mon = CMOS_READ(cmos->mon_alrm);
234                         if (!t->time.tm_mon)
235                                 t->time.tm_mon = -1;
236                 }
237         }
238
239         rtc_control = CMOS_READ(RTC_CONTROL);
240         spin_unlock_irq(&rtc_lock);
241
242         if (!(rtc_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
243                 if (((unsigned)t->time.tm_sec) < 0x60)
244                         t->time.tm_sec = bcd2bin(t->time.tm_sec);
245                 else
246                         t->time.tm_sec = -1;
247                 if (((unsigned)t->time.tm_min) < 0x60)
248                         t->time.tm_min = bcd2bin(t->time.tm_min);
249                 else
250                         t->time.tm_min = -1;
251                 if (((unsigned)t->time.tm_hour) < 0x24)
252                         t->time.tm_hour = bcd2bin(t->time.tm_hour);
253                 else
254                         t->time.tm_hour = -1;
255
256                 if (cmos->day_alrm) {
257                         if (((unsigned)t->time.tm_mday) <= 0x31)
258                                 t->time.tm_mday = bcd2bin(t->time.tm_mday);
259                         else
260                                 t->time.tm_mday = -1;
261
262                         if (cmos->mon_alrm) {
263                                 if (((unsigned)t->time.tm_mon) <= 0x12)
264                                         t->time.tm_mon = bcd2bin(t->time.tm_mon)-1;
265                                 else
266                                         t->time.tm_mon = -1;
267                         }
268                 }
269         }
270         t->time.tm_year = -1;
271
272         t->enabled = !!(rtc_control & RTC_AIE);
273         t->pending = 0;
274
275         return 0;
276 }
277
278 static void cmos_checkintr(struct cmos_rtc *cmos, unsigned char rtc_control)
279 {
280         unsigned char   rtc_intr;
281
282         /* NOTE after changing RTC_xIE bits we always read INTR_FLAGS;
283          * allegedly some older rtcs need that to handle irqs properly
284          */
285         rtc_intr = CMOS_READ(RTC_INTR_FLAGS);
286
287         if (is_hpet_enabled())
288                 return;
289
290         rtc_intr &= (rtc_control & RTC_IRQMASK) | RTC_IRQF;
291         if (is_intr(rtc_intr))
292                 rtc_update_irq(cmos->rtc, 1, rtc_intr);
293 }
294
295 static void cmos_irq_enable(struct cmos_rtc *cmos, unsigned char mask)
296 {
297         unsigned char   rtc_control;
298
299         /* flush any pending IRQ status, notably for update irqs,
300          * before we enable new IRQs
301          */
302         rtc_control = CMOS_READ(RTC_CONTROL);
303         cmos_checkintr(cmos, rtc_control);
304
305         rtc_control |= mask;
306         CMOS_WRITE(rtc_control, RTC_CONTROL);
307         hpet_set_rtc_irq_bit(mask);
308
309         cmos_checkintr(cmos, rtc_control);
310 }
311
312 static void cmos_irq_disable(struct cmos_rtc *cmos, unsigned char mask)
313 {
314         unsigned char   rtc_control;
315
316         rtc_control = CMOS_READ(RTC_CONTROL);
317         rtc_control &= ~mask;
318         CMOS_WRITE(rtc_control, RTC_CONTROL);
319         hpet_mask_rtc_irq_bit(mask);
320
321         cmos_checkintr(cmos, rtc_control);
322 }
323
324 static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t)
325 {
326         struct cmos_rtc *cmos = dev_get_drvdata(dev);
327        unsigned char   mon, mday, hrs, min, sec, rtc_control;
328
329         if (!is_valid_irq(cmos->irq))
330                 return -EIO;
331
332         mon = t->time.tm_mon + 1;
333         mday = t->time.tm_mday;
334         hrs = t->time.tm_hour;
335         min = t->time.tm_min;
336         sec = t->time.tm_sec;
337
338         rtc_control = CMOS_READ(RTC_CONTROL);
339         if (!(rtc_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
340                 /* Writing 0xff means "don't care" or "match all".  */
341                 mon = (mon <= 12) ? bin2bcd(mon) : 0xff;
342                 mday = (mday >= 1 && mday <= 31) ? bin2bcd(mday) : 0xff;
343                 hrs = (hrs < 24) ? bin2bcd(hrs) : 0xff;
344                 min = (min < 60) ? bin2bcd(min) : 0xff;
345                 sec = (sec < 60) ? bin2bcd(sec) : 0xff;
346         }
347
348         spin_lock_irq(&rtc_lock);
349
350         /* next rtc irq must not be from previous alarm setting */
351         cmos_irq_disable(cmos, RTC_AIE);
352
353         /* update alarm */
354         CMOS_WRITE(hrs, RTC_HOURS_ALARM);
355         CMOS_WRITE(min, RTC_MINUTES_ALARM);
356         CMOS_WRITE(sec, RTC_SECONDS_ALARM);
357
358         /* the system may support an "enhanced" alarm */
359         if (cmos->day_alrm) {
360                 CMOS_WRITE(mday, cmos->day_alrm);
361                 if (cmos->mon_alrm)
362                         CMOS_WRITE(mon, cmos->mon_alrm);
363         }
364
365         /* FIXME the HPET alarm glue currently ignores day_alrm
366          * and mon_alrm ...
367          */
368         hpet_set_alarm_time(t->time.tm_hour, t->time.tm_min, t->time.tm_sec);
369
370         if (t->enabled)
371                 cmos_irq_enable(cmos, RTC_AIE);
372
373         spin_unlock_irq(&rtc_lock);
374
375         return 0;
376 }
377
378 static int cmos_irq_set_freq(struct device *dev, int freq)
379 {
380         struct cmos_rtc *cmos = dev_get_drvdata(dev);
381         int             f;
382         unsigned long   flags;
383
384         if (!is_valid_irq(cmos->irq))
385                 return -ENXIO;
386
387         if (!is_power_of_2(freq))
388                 return -EINVAL;
389         /* 0 = no irqs; 1 = 2^15 Hz ... 15 = 2^0 Hz */
390         f = ffs(freq);
391         if (f-- > 16)
392                 return -EINVAL;
393         f = 16 - f;
394
395         spin_lock_irqsave(&rtc_lock, flags);
396         hpet_set_periodic_freq(freq);
397         CMOS_WRITE(RTC_REF_CLCK_32KHZ | f, RTC_FREQ_SELECT);
398         spin_unlock_irqrestore(&rtc_lock, flags);
399
400         return 0;
401 }
402
403 static int cmos_alarm_irq_enable(struct device *dev, unsigned int enabled)
404 {
405         struct cmos_rtc *cmos = dev_get_drvdata(dev);
406         unsigned long   flags;
407
408         if (!is_valid_irq(cmos->irq))
409                 return -EINVAL;
410
411         spin_lock_irqsave(&rtc_lock, flags);
412
413         if (enabled)
414                 cmos_irq_enable(cmos, RTC_AIE);
415         else
416                 cmos_irq_disable(cmos, RTC_AIE);
417
418         spin_unlock_irqrestore(&rtc_lock, flags);
419         return 0;
420 }
421
422 static int cmos_update_irq_enable(struct device *dev, unsigned int enabled)
423 {
424         struct cmos_rtc *cmos = dev_get_drvdata(dev);
425         unsigned long   flags;
426
427         if (!is_valid_irq(cmos->irq))
428                 return -EINVAL;
429
430         spin_lock_irqsave(&rtc_lock, flags);
431
432         if (enabled)
433                 cmos_irq_enable(cmos, RTC_UIE);
434         else
435                 cmos_irq_disable(cmos, RTC_UIE);
436
437         spin_unlock_irqrestore(&rtc_lock, flags);
438         return 0;
439 }
440
441 #if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
442
443 static int cmos_procfs(struct device *dev, struct seq_file *seq)
444 {
445         struct cmos_rtc *cmos = dev_get_drvdata(dev);
446         unsigned char   rtc_control, valid;
447
448         spin_lock_irq(&rtc_lock);
449         rtc_control = CMOS_READ(RTC_CONTROL);
450         valid = CMOS_READ(RTC_VALID);
451         spin_unlock_irq(&rtc_lock);
452
453         /* NOTE:  at least ICH6 reports battery status using a different
454          * (non-RTC) bit; and SQWE is ignored on many current systems.
455          */
456         return seq_printf(seq,
457                         "periodic_IRQ\t: %s\n"
458                         "update_IRQ\t: %s\n"
459                         "HPET_emulated\t: %s\n"
460                         // "square_wave\t: %s\n"
461                         "BCD\t\t: %s\n"
462                         "DST_enable\t: %s\n"
463                         "periodic_freq\t: %d\n"
464                         "batt_status\t: %s\n",
465                         (rtc_control & RTC_PIE) ? "yes" : "no",
466                         (rtc_control & RTC_UIE) ? "yes" : "no",
467                         is_hpet_enabled() ? "yes" : "no",
468                         // (rtc_control & RTC_SQWE) ? "yes" : "no",
469                         (rtc_control & RTC_DM_BINARY) ? "no" : "yes",
470                         (rtc_control & RTC_DST_EN) ? "yes" : "no",
471                         cmos->rtc->irq_freq,
472                         (valid & RTC_VRT) ? "okay" : "dead");
473 }
474
475 #else
476 #define cmos_procfs     NULL
477 #endif
478
479 static const struct rtc_class_ops cmos_rtc_ops = {
480         .read_time              = cmos_read_time,
481         .set_time               = cmos_set_time,
482         .read_alarm             = cmos_read_alarm,
483         .set_alarm              = cmos_set_alarm,
484         .proc                   = cmos_procfs,
485         .irq_set_freq           = cmos_irq_set_freq,
486         .alarm_irq_enable       = cmos_alarm_irq_enable,
487         .update_irq_enable      = cmos_update_irq_enable,
488 };
489
490 /*----------------------------------------------------------------*/
491
492 /*
493  * All these chips have at least 64 bytes of address space, shared by
494  * RTC registers and NVRAM.  Most of those bytes of NVRAM are used
495  * by boot firmware.  Modern chips have 128 or 256 bytes.
496  */
497
498 #define NVRAM_OFFSET    (RTC_REG_D + 1)
499
500 static ssize_t
501 cmos_nvram_read(struct file *filp, struct kobject *kobj,
502                 struct bin_attribute *attr,
503                 char *buf, loff_t off, size_t count)
504 {
505         int     retval;
506
507         if (unlikely(off >= attr->size))
508                 return 0;
509         if (unlikely(off < 0))
510                 return -EINVAL;
511         if ((off + count) > attr->size)
512                 count = attr->size - off;
513
514         off += NVRAM_OFFSET;
515         spin_lock_irq(&rtc_lock);
516         for (retval = 0; count; count--, off++, retval++) {
517                 if (off < 128)
518                         *buf++ = CMOS_READ(off);
519                 else if (can_bank2)
520                         *buf++ = cmos_read_bank2(off);
521                 else
522                         break;
523         }
524         spin_unlock_irq(&rtc_lock);
525
526         return retval;
527 }
528
529 static ssize_t
530 cmos_nvram_write(struct file *filp, struct kobject *kobj,
531                 struct bin_attribute *attr,
532                 char *buf, loff_t off, size_t count)
533 {
534         struct cmos_rtc *cmos;
535         int             retval;
536
537         cmos = dev_get_drvdata(container_of(kobj, struct device, kobj));
538         if (unlikely(off >= attr->size))
539                 return -EFBIG;
540         if (unlikely(off < 0))
541                 return -EINVAL;
542         if ((off + count) > attr->size)
543                 count = attr->size - off;
544
545         /* NOTE:  on at least PCs and Ataris, the boot firmware uses a
546          * checksum on part of the NVRAM data.  That's currently ignored
547          * here.  If userspace is smart enough to know what fields of
548          * NVRAM to update, updating checksums is also part of its job.
549          */
550         off += NVRAM_OFFSET;
551         spin_lock_irq(&rtc_lock);
552         for (retval = 0; count; count--, off++, retval++) {
553                 /* don't trash RTC registers */
554                 if (off == cmos->day_alrm
555                                 || off == cmos->mon_alrm
556                                 || off == cmos->century)
557                         buf++;
558                 else if (off < 128)
559                         CMOS_WRITE(*buf++, off);
560                 else if (can_bank2)
561                         cmos_write_bank2(*buf++, off);
562                 else
563                         break;
564         }
565         spin_unlock_irq(&rtc_lock);
566
567         return retval;
568 }
569
570 static struct bin_attribute nvram = {
571         .attr = {
572                 .name   = "nvram",
573                 .mode   = S_IRUGO | S_IWUSR,
574         },
575
576         .read   = cmos_nvram_read,
577         .write  = cmos_nvram_write,
578         /* size gets set up later */
579 };
580
581 /*----------------------------------------------------------------*/
582
583 static struct cmos_rtc  cmos_rtc;
584
585 static irqreturn_t cmos_interrupt(int irq, void *p)
586 {
587         u8              irqstat;
588         u8              rtc_control;
589
590         spin_lock(&rtc_lock);
591
592         /* When the HPET interrupt handler calls us, the interrupt
593          * status is passed as arg1 instead of the irq number.  But
594          * always clear irq status, even when HPET is in the way.
595          *
596          * Note that HPET and RTC are almost certainly out of phase,
597          * giving different IRQ status ...
598          */
599         irqstat = CMOS_READ(RTC_INTR_FLAGS);
600         rtc_control = CMOS_READ(RTC_CONTROL);
601         if (is_hpet_enabled())
602                 irqstat = (unsigned long)irq & 0xF0;
603         irqstat &= (rtc_control & RTC_IRQMASK) | RTC_IRQF;
604
605         /* All Linux RTC alarms should be treated as if they were oneshot.
606          * Similar code may be needed in system wakeup paths, in case the
607          * alarm woke the system.
608          */
609         if (irqstat & RTC_AIE) {
610                 rtc_control &= ~RTC_AIE;
611                 CMOS_WRITE(rtc_control, RTC_CONTROL);
612                 hpet_mask_rtc_irq_bit(RTC_AIE);
613
614                 CMOS_READ(RTC_INTR_FLAGS);
615         }
616         spin_unlock(&rtc_lock);
617
618         if (is_intr(irqstat)) {
619                 rtc_update_irq(p, 1, irqstat);
620                 return IRQ_HANDLED;
621         } else
622                 return IRQ_NONE;
623 }
624
625 #ifdef  CONFIG_PNP
626 #define INITSECTION
627
628 #else
629 #define INITSECTION     __init
630 #endif
631
632 static int INITSECTION
633 cmos_do_probe(struct device *dev, struct resource *ports, int rtc_irq)
634 {
635         struct cmos_rtc_board_info      *info = dev->platform_data;
636         int                             retval = 0;
637         unsigned char                   rtc_control;
638         unsigned                        address_space;
639
640         /* there can be only one ... */
641         if (cmos_rtc.dev)
642                 return -EBUSY;
643
644         if (!ports)
645                 return -ENODEV;
646
647         /* Claim I/O ports ASAP, minimizing conflict with legacy driver.
648          *
649          * REVISIT non-x86 systems may instead use memory space resources
650          * (needing ioremap etc), not i/o space resources like this ...
651          */
652         ports = request_region(ports->start,
653                         ports->end + 1 - ports->start,
654                         driver_name);
655         if (!ports) {
656                 dev_dbg(dev, "i/o registers already in use\n");
657                 return -EBUSY;
658         }
659
660         cmos_rtc.irq = rtc_irq;
661         cmos_rtc.iomem = ports;
662
663         /* Heuristic to deduce NVRAM size ... do what the legacy NVRAM
664          * driver did, but don't reject unknown configs.   Old hardware
665          * won't address 128 bytes.  Newer chips have multiple banks,
666          * though they may not be listed in one I/O resource.
667          */
668 #if     defined(CONFIG_ATARI)
669         address_space = 64;
670 #elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) \
671                         || defined(__sparc__) || defined(__mips__) \
672                         || defined(__powerpc__)
673         address_space = 128;
674 #else
675 #warning Assuming 128 bytes of RTC+NVRAM address space, not 64 bytes.
676         address_space = 128;
677 #endif
678         if (can_bank2 && ports->end > (ports->start + 1))
679                 address_space = 256;
680
681         /* For ACPI systems extension info comes from the FADT.  On others,
682          * board specific setup provides it as appropriate.  Systems where
683          * the alarm IRQ isn't automatically a wakeup IRQ (like ACPI, and
684          * some almost-clones) can provide hooks to make that behave.
685          *
686          * Note that ACPI doesn't preclude putting these registers into
687          * "extended" areas of the chip, including some that we won't yet
688          * expect CMOS_READ and friends to handle.
689          */
690         if (info) {
691                 if (info->rtc_day_alarm && info->rtc_day_alarm < 128)
692                         cmos_rtc.day_alrm = info->rtc_day_alarm;
693                 if (info->rtc_mon_alarm && info->rtc_mon_alarm < 128)
694                         cmos_rtc.mon_alrm = info->rtc_mon_alarm;
695                 if (info->rtc_century && info->rtc_century < 128)
696                         cmos_rtc.century = info->rtc_century;
697
698                 if (info->wake_on && info->wake_off) {
699                         cmos_rtc.wake_on = info->wake_on;
700                         cmos_rtc.wake_off = info->wake_off;
701                 }
702         }
703
704         cmos_rtc.dev = dev;
705         dev_set_drvdata(dev, &cmos_rtc);
706
707         cmos_rtc.rtc = rtc_device_register(driver_name, dev,
708                                 &cmos_rtc_ops, THIS_MODULE);
709         if (IS_ERR(cmos_rtc.rtc)) {
710                 retval = PTR_ERR(cmos_rtc.rtc);
711                 goto cleanup0;
712         }
713
714         rename_region(ports, dev_name(&cmos_rtc.rtc->dev));
715
716         spin_lock_irq(&rtc_lock);
717
718         /* force periodic irq to CMOS reset default of 1024Hz;
719          *
720          * REVISIT it's been reported that at least one x86_64 ALI mobo
721          * doesn't use 32KHz here ... for portability we might need to
722          * do something about other clock frequencies.
723          */
724         cmos_rtc.rtc->irq_freq = 1024;
725         hpet_set_periodic_freq(cmos_rtc.rtc->irq_freq);
726         CMOS_WRITE(RTC_REF_CLCK_32KHZ | 0x06, RTC_FREQ_SELECT);
727
728         /* disable irqs */
729         cmos_irq_disable(&cmos_rtc, RTC_PIE | RTC_AIE | RTC_UIE);
730
731         rtc_control = CMOS_READ(RTC_CONTROL);
732
733         spin_unlock_irq(&rtc_lock);
734
735         /* FIXME:
736          * <asm-generic/rtc.h> doesn't know 12-hour mode either.
737          */
738        if (is_valid_irq(rtc_irq) && !(rtc_control & RTC_24H)) {
739                 dev_warn(dev, "only 24-hr supported\n");
740                 retval = -ENXIO;
741                 goto cleanup1;
742         }
743
744         if (is_valid_irq(rtc_irq)) {
745                 irq_handler_t rtc_cmos_int_handler;
746
747                 if (is_hpet_enabled()) {
748                         int err;
749
750                         rtc_cmos_int_handler = hpet_rtc_interrupt;
751                         err = hpet_register_irq_handler(cmos_interrupt);
752                         if (err != 0) {
753                                 printk(KERN_WARNING "hpet_register_irq_handler "
754                                                 " failed in rtc_init().");
755                                 goto cleanup1;
756                         }
757                 } else
758                         rtc_cmos_int_handler = cmos_interrupt;
759
760                 retval = request_irq(rtc_irq, rtc_cmos_int_handler,
761                                 IRQF_DISABLED, dev_name(&cmos_rtc.rtc->dev),
762                                 cmos_rtc.rtc);
763                 if (retval < 0) {
764                         dev_dbg(dev, "IRQ %d is already in use\n", rtc_irq);
765                         goto cleanup1;
766                 }
767         }
768         hpet_rtc_timer_init();
769
770         /* export at least the first block of NVRAM */
771         nvram.size = address_space - NVRAM_OFFSET;
772         retval = sysfs_create_bin_file(&dev->kobj, &nvram);
773         if (retval < 0) {
774                 dev_dbg(dev, "can't create nvram file? %d\n", retval);
775                 goto cleanup2;
776         }
777
778         pr_info("%s: %s%s, %zd bytes nvram%s\n",
779                 dev_name(&cmos_rtc.rtc->dev),
780                 !is_valid_irq(rtc_irq) ? "no alarms" :
781                         cmos_rtc.mon_alrm ? "alarms up to one year" :
782                         cmos_rtc.day_alrm ? "alarms up to one month" :
783                         "alarms up to one day",
784                 cmos_rtc.century ? ", y3k" : "",
785                 nvram.size,
786                 is_hpet_enabled() ? ", hpet irqs" : "");
787
788         return 0;
789
790 cleanup2:
791         if (is_valid_irq(rtc_irq))
792                 free_irq(rtc_irq, cmos_rtc.rtc);
793 cleanup1:
794         cmos_rtc.dev = NULL;
795         rtc_device_unregister(cmos_rtc.rtc);
796 cleanup0:
797         release_region(ports->start, ports->end + 1 - ports->start);
798         return retval;
799 }
800
801 static void cmos_do_shutdown(void)
802 {
803         spin_lock_irq(&rtc_lock);
804         cmos_irq_disable(&cmos_rtc, RTC_IRQMASK);
805         spin_unlock_irq(&rtc_lock);
806 }
807
808 static void __exit cmos_do_remove(struct device *dev)
809 {
810         struct cmos_rtc *cmos = dev_get_drvdata(dev);
811         struct resource *ports;
812
813         cmos_do_shutdown();
814
815         sysfs_remove_bin_file(&dev->kobj, &nvram);
816
817         if (is_valid_irq(cmos->irq)) {
818                 free_irq(cmos->irq, cmos->rtc);
819                 hpet_unregister_irq_handler(cmos_interrupt);
820         }
821
822         rtc_device_unregister(cmos->rtc);
823         cmos->rtc = NULL;
824
825         ports = cmos->iomem;
826         release_region(ports->start, ports->end + 1 - ports->start);
827         cmos->iomem = NULL;
828
829         cmos->dev = NULL;
830         dev_set_drvdata(dev, NULL);
831 }
832
833 #ifdef  CONFIG_PM
834
835 static int cmos_suspend(struct device *dev)
836 {
837         struct cmos_rtc *cmos = dev_get_drvdata(dev);
838         unsigned char   tmp;
839
840         /* only the alarm might be a wakeup event source */
841         spin_lock_irq(&rtc_lock);
842         cmos->suspend_ctrl = tmp = CMOS_READ(RTC_CONTROL);
843         if (tmp & (RTC_PIE|RTC_AIE|RTC_UIE)) {
844                 unsigned char   mask;
845
846                 if (device_may_wakeup(dev))
847                         mask = RTC_IRQMASK & ~RTC_AIE;
848                 else
849                         mask = RTC_IRQMASK;
850                 tmp &= ~mask;
851                 CMOS_WRITE(tmp, RTC_CONTROL);
852
853                 /* shut down hpet emulation - we don't need it for alarm */
854                 hpet_mask_rtc_irq_bit(RTC_PIE|RTC_AIE|RTC_UIE);
855                 cmos_checkintr(cmos, tmp);
856         }
857         spin_unlock_irq(&rtc_lock);
858
859         if (tmp & RTC_AIE) {
860                 cmos->enabled_wake = 1;
861                 if (cmos->wake_on)
862                         cmos->wake_on(dev);
863                 else
864                         enable_irq_wake(cmos->irq);
865         }
866
867         pr_debug("%s: suspend%s, ctrl %02x\n",
868                         dev_name(&cmos_rtc.rtc->dev),
869                         (tmp & RTC_AIE) ? ", alarm may wake" : "",
870                         tmp);
871
872         return 0;
873 }
874
875 /* We want RTC alarms to wake us from e.g. ACPI G2/S5 "soft off", even
876  * after a detour through G3 "mechanical off", although the ACPI spec
877  * says wakeup should only work from G1/S4 "hibernate".  To most users,
878  * distinctions between S4 and S5 are pointless.  So when the hardware
879  * allows, don't draw that distinction.
880  */
881 static inline int cmos_poweroff(struct device *dev)
882 {
883         return cmos_suspend(dev);
884 }
885
886 static int cmos_resume(struct device *dev)
887 {
888         struct cmos_rtc *cmos = dev_get_drvdata(dev);
889         unsigned char   tmp = cmos->suspend_ctrl;
890
891         /* re-enable any irqs previously active */
892         if (tmp & RTC_IRQMASK) {
893                 unsigned char   mask;
894
895                 if (cmos->enabled_wake) {
896                         if (cmos->wake_off)
897                                 cmos->wake_off(dev);
898                         else
899                                 disable_irq_wake(cmos->irq);
900                         cmos->enabled_wake = 0;
901                 }
902
903                 spin_lock_irq(&rtc_lock);
904                 do {
905                         CMOS_WRITE(tmp, RTC_CONTROL);
906                         hpet_set_rtc_irq_bit(tmp & RTC_IRQMASK);
907
908                         mask = CMOS_READ(RTC_INTR_FLAGS);
909                         mask &= (tmp & RTC_IRQMASK) | RTC_IRQF;
910                         if (!is_hpet_enabled() || !is_intr(mask))
911                                 break;
912
913                         /* force one-shot behavior if HPET blocked
914                          * the wake alarm's irq
915                          */
916                         rtc_update_irq(cmos->rtc, 1, mask);
917                         tmp &= ~RTC_AIE;
918                         hpet_mask_rtc_irq_bit(RTC_AIE);
919                 } while (mask & RTC_AIE);
920                 spin_unlock_irq(&rtc_lock);
921         }
922
923         pr_debug("%s: resume, ctrl %02x\n",
924                         dev_name(&cmos_rtc.rtc->dev),
925                         tmp);
926
927         return 0;
928 }
929
930 static SIMPLE_DEV_PM_OPS(cmos_pm_ops, cmos_suspend, cmos_resume);
931
932 #else
933
934 static inline int cmos_poweroff(struct device *dev)
935 {
936         return -ENOSYS;
937 }
938
939 #endif
940
941 /*----------------------------------------------------------------*/
942
943 /* On non-x86 systems, a "CMOS" RTC lives most naturally on platform_bus.
944  * ACPI systems always list these as PNPACPI devices, and pre-ACPI PCs
945  * probably list them in similar PNPBIOS tables; so PNP is more common.
946  *
947  * We don't use legacy "poke at the hardware" probing.  Ancient PCs that
948  * predate even PNPBIOS should set up platform_bus devices.
949  */
950
951 #ifdef  CONFIG_ACPI
952
953 #include <linux/acpi.h>
954
955 static u32 rtc_handler(void *context)
956 {
957         acpi_clear_event(ACPI_EVENT_RTC);
958         acpi_disable_event(ACPI_EVENT_RTC, 0);
959         return ACPI_INTERRUPT_HANDLED;
960 }
961
962 static inline void rtc_wake_setup(void)
963 {
964         acpi_install_fixed_event_handler(ACPI_EVENT_RTC, rtc_handler, NULL);
965         /*
966          * After the RTC handler is installed, the Fixed_RTC event should
967          * be disabled. Only when the RTC alarm is set will it be enabled.
968          */
969         acpi_clear_event(ACPI_EVENT_RTC);
970         acpi_disable_event(ACPI_EVENT_RTC, 0);
971 }
972
973 static void rtc_wake_on(struct device *dev)
974 {
975         acpi_clear_event(ACPI_EVENT_RTC);
976         acpi_enable_event(ACPI_EVENT_RTC, 0);
977 }
978
979 static void rtc_wake_off(struct device *dev)
980 {
981         acpi_disable_event(ACPI_EVENT_RTC, 0);
982 }
983
984 /* Every ACPI platform has a mc146818 compatible "cmos rtc".  Here we find
985  * its device node and pass extra config data.  This helps its driver use
986  * capabilities that the now-obsolete mc146818 didn't have, and informs it
987  * that this board's RTC is wakeup-capable (per ACPI spec).
988  */
989 static struct cmos_rtc_board_info acpi_rtc_info;
990
991 static void __devinit
992 cmos_wake_setup(struct device *dev)
993 {
994         if (acpi_disabled)
995                 return;
996
997         rtc_wake_setup();
998         acpi_rtc_info.wake_on = rtc_wake_on;
999         acpi_rtc_info.wake_off = rtc_wake_off;
1000
1001         /* workaround bug in some ACPI tables */
1002         if (acpi_gbl_FADT.month_alarm && !acpi_gbl_FADT.day_alarm) {
1003                 dev_dbg(dev, "bogus FADT month_alarm (%d)\n",
1004                         acpi_gbl_FADT.month_alarm);
1005                 acpi_gbl_FADT.month_alarm = 0;
1006         }
1007
1008         acpi_rtc_info.rtc_day_alarm = acpi_gbl_FADT.day_alarm;
1009         acpi_rtc_info.rtc_mon_alarm = acpi_gbl_FADT.month_alarm;
1010         acpi_rtc_info.rtc_century = acpi_gbl_FADT.century;
1011
1012         /* NOTE:  S4_RTC_WAKE is NOT currently useful to Linux */
1013         if (acpi_gbl_FADT.flags & ACPI_FADT_S4_RTC_WAKE)
1014                 dev_info(dev, "RTC can wake from S4\n");
1015
1016         dev->platform_data = &acpi_rtc_info;
1017
1018         /* RTC always wakes from S1/S2/S3, and often S4/STD */
1019         device_init_wakeup(dev, 1);
1020 }
1021
1022 #else
1023
1024 static void __devinit
1025 cmos_wake_setup(struct device *dev)
1026 {
1027 }
1028
1029 #endif
1030
1031 #ifdef  CONFIG_PNP
1032
1033 #include <linux/pnp.h>
1034
1035 static int __devinit
1036 cmos_pnp_probe(struct pnp_dev *pnp, const struct pnp_device_id *id)
1037 {
1038         cmos_wake_setup(&pnp->dev);
1039
1040         if (pnp_port_start(pnp,0) == 0x70 && !pnp_irq_valid(pnp,0))
1041                 /* Some machines contain a PNP entry for the RTC, but
1042                  * don't define the IRQ. It should always be safe to
1043                  * hardcode it in these cases
1044                  */
1045                 return cmos_do_probe(&pnp->dev,
1046                                 pnp_get_resource(pnp, IORESOURCE_IO, 0), 8);
1047         else
1048                 return cmos_do_probe(&pnp->dev,
1049                                 pnp_get_resource(pnp, IORESOURCE_IO, 0),
1050                                 pnp_irq(pnp, 0));
1051 }
1052
1053 static void __exit cmos_pnp_remove(struct pnp_dev *pnp)
1054 {
1055         cmos_do_remove(&pnp->dev);
1056 }
1057
1058 #ifdef  CONFIG_PM
1059
1060 static int cmos_pnp_suspend(struct pnp_dev *pnp, pm_message_t mesg)
1061 {
1062         return cmos_suspend(&pnp->dev);
1063 }
1064
1065 static int cmos_pnp_resume(struct pnp_dev *pnp)
1066 {
1067         return cmos_resume(&pnp->dev);
1068 }
1069
1070 #else
1071 #define cmos_pnp_suspend        NULL
1072 #define cmos_pnp_resume         NULL
1073 #endif
1074
1075 static void cmos_pnp_shutdown(struct pnp_dev *pnp)
1076 {
1077         if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(&pnp->dev))
1078                 return;
1079
1080         cmos_do_shutdown();
1081 }
1082
1083 static const struct pnp_device_id rtc_ids[] = {
1084         { .id = "PNP0b00", },
1085         { .id = "PNP0b01", },
1086         { .id = "PNP0b02", },
1087         { },
1088 };
1089 MODULE_DEVICE_TABLE(pnp, rtc_ids);
1090
1091 static struct pnp_driver cmos_pnp_driver = {
1092         .name           = (char *) driver_name,
1093         .id_table       = rtc_ids,
1094         .probe          = cmos_pnp_probe,
1095         .remove         = __exit_p(cmos_pnp_remove),
1096         .shutdown       = cmos_pnp_shutdown,
1097
1098         /* flag ensures resume() gets called, and stops syslog spam */
1099         .flags          = PNP_DRIVER_RES_DO_NOT_CHANGE,
1100         .suspend        = cmos_pnp_suspend,
1101         .resume         = cmos_pnp_resume,
1102 };
1103
1104 #endif  /* CONFIG_PNP */
1105
1106 /*----------------------------------------------------------------*/
1107
1108 /* Platform setup should have set up an RTC device, when PNP is
1109  * unavailable ... this could happen even on (older) PCs.
1110  */
1111
1112 static int __init cmos_platform_probe(struct platform_device *pdev)
1113 {
1114         cmos_wake_setup(&pdev->dev);
1115         return cmos_do_probe(&pdev->dev,
1116                         platform_get_resource(pdev, IORESOURCE_IO, 0),
1117                         platform_get_irq(pdev, 0));
1118 }
1119
1120 static int __exit cmos_platform_remove(struct platform_device *pdev)
1121 {
1122         cmos_do_remove(&pdev->dev);
1123         return 0;
1124 }
1125
1126 static void cmos_platform_shutdown(struct platform_device *pdev)
1127 {
1128         if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(&pdev->dev))
1129                 return;
1130
1131         cmos_do_shutdown();
1132 }
1133
1134 /* work with hotplug and coldplug */
1135 MODULE_ALIAS("platform:rtc_cmos");
1136
1137 static struct platform_driver cmos_platform_driver = {
1138         .remove         = __exit_p(cmos_platform_remove),
1139         .shutdown       = cmos_platform_shutdown,
1140         .driver = {
1141                 .name           = (char *) driver_name,
1142 #ifdef CONFIG_PM
1143                 .pm             = &cmos_pm_ops,
1144 #endif
1145         }
1146 };
1147
1148 #ifdef CONFIG_PNP
1149 static bool pnp_driver_registered;
1150 #endif
1151 static bool platform_driver_registered;
1152
1153 static int __init cmos_init(void)
1154 {
1155         int retval = 0;
1156
1157 #ifdef  CONFIG_PNP
1158         retval = pnp_register_driver(&cmos_pnp_driver);
1159         if (retval == 0)
1160                 pnp_driver_registered = true;
1161 #endif
1162
1163         if (!cmos_rtc.dev) {
1164                 retval = platform_driver_probe(&cmos_platform_driver,
1165                                                cmos_platform_probe);
1166                 if (retval == 0)
1167                         platform_driver_registered = true;
1168         }
1169
1170         if (retval == 0)
1171                 return 0;
1172
1173 #ifdef  CONFIG_PNP
1174         if (pnp_driver_registered)
1175                 pnp_unregister_driver(&cmos_pnp_driver);
1176 #endif
1177         return retval;
1178 }
1179 module_init(cmos_init);
1180
1181 static void __exit cmos_exit(void)
1182 {
1183 #ifdef  CONFIG_PNP
1184         if (pnp_driver_registered)
1185                 pnp_unregister_driver(&cmos_pnp_driver);
1186 #endif
1187         if (platform_driver_registered)
1188                 platform_driver_unregister(&cmos_platform_driver);
1189 }
1190 module_exit(cmos_exit);
1191
1192
1193 MODULE_AUTHOR("David Brownell");
1194 MODULE_DESCRIPTION("Driver for PC-style 'CMOS' RTCs");
1195 MODULE_LICENSE("GPL");