Pileus Git - ~andy/linux/blob - 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_alarm_irq_enable(struct device *dev, unsigned int enabled)
 379 {
 380         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 381         unsigned long   flags;
 382
 383         if (!is_valid_irq(cmos->irq))
 384                 return -EINVAL;
 385
 386         spin_lock_irqsave(&rtc_lock, flags);
 387
 388         if (enabled)
 389                 cmos_irq_enable(cmos, RTC_AIE);
 390         else
 391                 cmos_irq_disable(cmos, RTC_AIE);
 392
 393         spin_unlock_irqrestore(&rtc_lock, flags);
 394         return 0;
 395 }
 396
 397 static int cmos_update_irq_enable(struct device *dev, unsigned int enabled)
 398 {
 399         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 400         unsigned long   flags;
 401
 402         if (!is_valid_irq(cmos->irq))
 403                 return -EINVAL;
 404
 405         spin_lock_irqsave(&rtc_lock, flags);
 406
 407         if (enabled)
 408                 cmos_irq_enable(cmos, RTC_UIE);
 409         else
 410                 cmos_irq_disable(cmos, RTC_UIE);
 411
 412         spin_unlock_irqrestore(&rtc_lock, flags);
 413         return 0;
 414 }
 415
 416 #if defined(CONFIG_RTC_INTF_PROC) || defined(CONFIG_RTC_INTF_PROC_MODULE)
 417
 418 static int cmos_procfs(struct device *dev, struct seq_file *seq)
 419 {
 420         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 421         unsigned char   rtc_control, valid;
 422
 423         spin_lock_irq(&rtc_lock);
 424         rtc_control = CMOS_READ(RTC_CONTROL);
 425         valid = CMOS_READ(RTC_VALID);
 426         spin_unlock_irq(&rtc_lock);
 427
 428         /* NOTE:  at least ICH6 reports battery status using a different
 429          * (non-RTC) bit; and SQWE is ignored on many current systems.
 430          */
 431         return seq_printf(seq,
 432                         "periodic_IRQ\t: %s\n"
 433                         "update_IRQ\t: %s\n"
 434                         "HPET_emulated\t: %s\n"
 435                         // "square_wave\t: %s\n"
 436                         "BCD\t\t: %s\n"
 437                         "DST_enable\t: %s\n"
 438                         "periodic_freq\t: %d\n"
 439                         "batt_status\t: %s\n",
 440                         (rtc_control & RTC_PIE) ? "yes" : "no",
 441                         (rtc_control & RTC_UIE) ? "yes" : "no",
 442                         is_hpet_enabled() ? "yes" : "no",
 443                         // (rtc_control & RTC_SQWE) ? "yes" : "no",
 444                         (rtc_control & RTC_DM_BINARY) ? "no" : "yes",
 445                         (rtc_control & RTC_DST_EN) ? "yes" : "no",
 446                         cmos->rtc->irq_freq,
 447                         (valid & RTC_VRT) ? "okay" : "dead");
 448 }
 449
 450 #else
 451 #define cmos_procfs     NULL
 452 #endif
 453
 454 static const struct rtc_class_ops cmos_rtc_ops = {
 455         .read_time              = cmos_read_time,
 456         .set_time               = cmos_set_time,
 457         .read_alarm             = cmos_read_alarm,
 458         .set_alarm              = cmos_set_alarm,
 459         .proc                   = cmos_procfs,
 460         .alarm_irq_enable       = cmos_alarm_irq_enable,
 461         .update_irq_enable      = cmos_update_irq_enable,
 462 };
 463
 464 /*----------------------------------------------------------------*/
 465
 466 /*
 467  * All these chips have at least 64 bytes of address space, shared by
 468  * RTC registers and NVRAM.  Most of those bytes of NVRAM are used
 469  * by boot firmware.  Modern chips have 128 or 256 bytes.
 470  */
 471
 472 #define NVRAM_OFFSET    (RTC_REG_D + 1)
 473
 474 static ssize_t
 475 cmos_nvram_read(struct file *filp, struct kobject *kobj,
 476                 struct bin_attribute *attr,
 477                 char *buf, loff_t off, size_t count)
 478 {
 479         int     retval;
 480
 481         if (unlikely(off >= attr->size))
 482                 return 0;
 483         if (unlikely(off < 0))
 484                 return -EINVAL;
 485         if ((off + count) > attr->size)
 486                 count = attr->size - off;
 487
 488         off += NVRAM_OFFSET;
 489         spin_lock_irq(&rtc_lock);
 490         for (retval = 0; count; count--, off++, retval++) {
 491                 if (off < 128)
 492                         *buf++ = CMOS_READ(off);
 493                 else if (can_bank2)
 494                         *buf++ = cmos_read_bank2(off);
 495                 else
 496                         break;
 497         }
 498         spin_unlock_irq(&rtc_lock);
 499
 500         return retval;
 501 }
 502
 503 static ssize_t
 504 cmos_nvram_write(struct file *filp, struct kobject *kobj,
 505                 struct bin_attribute *attr,
 506                 char *buf, loff_t off, size_t count)
 507 {
 508         struct cmos_rtc *cmos;
 509         int             retval;
 510
 511         cmos = dev_get_drvdata(container_of(kobj, struct device, kobj));
 512         if (unlikely(off >= attr->size))
 513                 return -EFBIG;
 514         if (unlikely(off < 0))
 515                 return -EINVAL;
 516         if ((off + count) > attr->size)
 517                 count = attr->size - off;
 518
 519         /* NOTE:  on at least PCs and Ataris, the boot firmware uses a
 520          * checksum on part of the NVRAM data.  That's currently ignored
 521          * here.  If userspace is smart enough to know what fields of
 522          * NVRAM to update, updating checksums is also part of its job.
 523          */
 524         off += NVRAM_OFFSET;
 525         spin_lock_irq(&rtc_lock);
 526         for (retval = 0; count; count--, off++, retval++) {
 527                 /* don't trash RTC registers */
 528                 if (off == cmos->day_alrm
 529                                 || off == cmos->mon_alrm
 530                                 || off == cmos->century)
 531                         buf++;
 532                 else if (off < 128)
 533                         CMOS_WRITE(*buf++, off);
 534                 else if (can_bank2)
 535                         cmos_write_bank2(*buf++, off);
 536                 else
 537                         break;
 538         }
 539         spin_unlock_irq(&rtc_lock);
 540
 541         return retval;
 542 }
 543
 544 static struct bin_attribute nvram = {
 545         .attr = {
 546                 .name   = "nvram",
 547                 .mode   = S_IRUGO | S_IWUSR,
 548         },
 549
 550         .read   = cmos_nvram_read,
 551         .write  = cmos_nvram_write,
 552         /* size gets set up later */
 553 };
 554
 555 /*----------------------------------------------------------------*/
 556
 557 static struct cmos_rtc  cmos_rtc;
 558
 559 static irqreturn_t cmos_interrupt(int irq, void *p)
 560 {
 561         u8              irqstat;
 562         u8              rtc_control;
 563
 564         spin_lock(&rtc_lock);
 565
 566         /* When the HPET interrupt handler calls us, the interrupt
 567          * status is passed as arg1 instead of the irq number.  But
 568          * always clear irq status, even when HPET is in the way.
 569          *
 570          * Note that HPET and RTC are almost certainly out of phase,
 571          * giving different IRQ status ...
 572          */
 573         irqstat = CMOS_READ(RTC_INTR_FLAGS);
 574         rtc_control = CMOS_READ(RTC_CONTROL);
 575         if (is_hpet_enabled())
 576                 irqstat = (unsigned long)irq & 0xF0;
 577         irqstat &= (rtc_control & RTC_IRQMASK) | RTC_IRQF;
 578
 579         /* All Linux RTC alarms should be treated as if they were oneshot.
 580          * Similar code may be needed in system wakeup paths, in case the
 581          * alarm woke the system.
 582          */
 583         if (irqstat & RTC_AIE) {
 584                 rtc_control &= ~RTC_AIE;
 585                 CMOS_WRITE(rtc_control, RTC_CONTROL);
 586                 hpet_mask_rtc_irq_bit(RTC_AIE);
 587
 588                 CMOS_READ(RTC_INTR_FLAGS);
 589         }
 590         spin_unlock(&rtc_lock);
 591
 592         if (is_intr(irqstat)) {
 593                 rtc_update_irq(p, 1, irqstat);
 594                 return IRQ_HANDLED;
 595         } else
 596                 return IRQ_NONE;
 597 }
 598
 599 #ifdef  CONFIG_PNP
 600 #define INITSECTION
 601
 602 #else
 603 #define INITSECTION     __init
 604 #endif
 605
 606 static int INITSECTION
 607 cmos_do_probe(struct device *dev, struct resource *ports, int rtc_irq)
 608 {
 609         struct cmos_rtc_board_info      *info = dev->platform_data;
 610         int                             retval = 0;
 611         unsigned char                   rtc_control;
 612         unsigned                        address_space;
 613
 614         /* there can be only one ... */
 615         if (cmos_rtc.dev)
 616                 return -EBUSY;
 617
 618         if (!ports)
 619                 return -ENODEV;
 620
 621         /* Claim I/O ports ASAP, minimizing conflict with legacy driver.
 622          *
 623          * REVISIT non-x86 systems may instead use memory space resources
 624          * (needing ioremap etc), not i/o space resources like this ...
 625          */
 626         ports = request_region(ports->start,
 627                         ports->end + 1 - ports->start,
 628                         driver_name);
 629         if (!ports) {
 630                 dev_dbg(dev, "i/o registers already in use\n");
 631                 return -EBUSY;
 632         }
 633
 634         cmos_rtc.irq = rtc_irq;
 635         cmos_rtc.iomem = ports;
 636
 637         /* Heuristic to deduce NVRAM size ... do what the legacy NVRAM
 638          * driver did, but don't reject unknown configs.   Old hardware
 639          * won't address 128 bytes.  Newer chips have multiple banks,
 640          * though they may not be listed in one I/O resource.
 641          */
 642 #if     defined(CONFIG_ATARI)
 643         address_space = 64;
 644 #elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) \
 645                         || defined(__sparc__) || defined(__mips__) \
 646                         || defined(__powerpc__)
 647         address_space = 128;
 648 #else
 649 #warning Assuming 128 bytes of RTC+NVRAM address space, not 64 bytes.
 650         address_space = 128;
 651 #endif
 652         if (can_bank2 && ports->end > (ports->start + 1))
 653                 address_space = 256;
 654
 655         /* For ACPI systems extension info comes from the FADT.  On others,
 656          * board specific setup provides it as appropriate.  Systems where
 657          * the alarm IRQ isn't automatically a wakeup IRQ (like ACPI, and
 658          * some almost-clones) can provide hooks to make that behave.
 659          *
 660          * Note that ACPI doesn't preclude putting these registers into
 661          * "extended" areas of the chip, including some that we won't yet
 662          * expect CMOS_READ and friends to handle.
 663          */
 664         if (info) {
 665                 if (info->rtc_day_alarm && info->rtc_day_alarm < 128)
 666                         cmos_rtc.day_alrm = info->rtc_day_alarm;
 667                 if (info->rtc_mon_alarm && info->rtc_mon_alarm < 128)
 668                         cmos_rtc.mon_alrm = info->rtc_mon_alarm;
 669                 if (info->rtc_century && info->rtc_century < 128)
 670                         cmos_rtc.century = info->rtc_century;
 671
 672                 if (info->wake_on && info->wake_off) {
 673                         cmos_rtc.wake_on = info->wake_on;
 674                         cmos_rtc.wake_off = info->wake_off;
 675                 }
 676         }
 677
 678         cmos_rtc.dev = dev;
 679         dev_set_drvdata(dev, &cmos_rtc);
 680
 681         cmos_rtc.rtc = rtc_device_register(driver_name, dev,
 682                                 &cmos_rtc_ops, THIS_MODULE);
 683         if (IS_ERR(cmos_rtc.rtc)) {
 684                 retval = PTR_ERR(cmos_rtc.rtc);
 685                 goto cleanup0;
 686         }
 687
 688         rename_region(ports, dev_name(&cmos_rtc.rtc->dev));
 689
 690         spin_lock_irq(&rtc_lock);
 691
 692         /* force periodic irq to CMOS reset default of 1024Hz;
 693          *
 694          * REVISIT it's been reported that at least one x86_64 ALI mobo
 695          * doesn't use 32KHz here ... for portability we might need to
 696          * do something about other clock frequencies.
 697          */
 698         cmos_rtc.rtc->irq_freq = 1024;
 699         hpet_set_periodic_freq(cmos_rtc.rtc->irq_freq);
 700         CMOS_WRITE(RTC_REF_CLCK_32KHZ | 0x06, RTC_FREQ_SELECT);
 701
 702         /* disable irqs */
 703         cmos_irq_disable(&cmos_rtc, RTC_PIE | RTC_AIE | RTC_UIE);
 704
 705         rtc_control = CMOS_READ(RTC_CONTROL);
 706
 707         spin_unlock_irq(&rtc_lock);
 708
 709         /* FIXME:
 710          * <asm-generic/rtc.h> doesn't know 12-hour mode either.
 711          */
 712        if (is_valid_irq(rtc_irq) && !(rtc_control & RTC_24H)) {
 713                 dev_warn(dev, "only 24-hr supported\n");
 714                 retval = -ENXIO;
 715                 goto cleanup1;
 716         }
 717
 718         if (is_valid_irq(rtc_irq)) {
 719                 irq_handler_t rtc_cmos_int_handler;
 720
 721                 if (is_hpet_enabled()) {
 722                         int err;
 723
 724                         rtc_cmos_int_handler = hpet_rtc_interrupt;
 725                         err = hpet_register_irq_handler(cmos_interrupt);
 726                         if (err != 0) {
 727                                 printk(KERN_WARNING "hpet_register_irq_handler "
 728                                                 " failed in rtc_init().");
 729                                 goto cleanup1;
 730                         }
 731                 } else
 732                         rtc_cmos_int_handler = cmos_interrupt;
 733
 734                 retval = request_irq(rtc_irq, rtc_cmos_int_handler,
 735                                 IRQF_DISABLED, dev_name(&cmos_rtc.rtc->dev),
 736                                 cmos_rtc.rtc);
 737                 if (retval < 0) {
 738                         dev_dbg(dev, "IRQ %d is already in use\n", rtc_irq);
 739                         goto cleanup1;
 740                 }
 741         }
 742         hpet_rtc_timer_init();
 743
 744         /* export at least the first block of NVRAM */
 745         nvram.size = address_space - NVRAM_OFFSET;
 746         retval = sysfs_create_bin_file(&dev->kobj, &nvram);
 747         if (retval < 0) {
 748                 dev_dbg(dev, "can't create nvram file? %d\n", retval);
 749                 goto cleanup2;
 750         }
 751
 752         pr_info("%s: %s%s, %zd bytes nvram%s\n",
 753                 dev_name(&cmos_rtc.rtc->dev),
 754                 !is_valid_irq(rtc_irq) ? "no alarms" :
 755                         cmos_rtc.mon_alrm ? "alarms up to one year" :
 756                         cmos_rtc.day_alrm ? "alarms up to one month" :
 757                         "alarms up to one day",
 758                 cmos_rtc.century ? ", y3k" : "",
 759                 nvram.size,
 760                 is_hpet_enabled() ? ", hpet irqs" : "");
 761
 762         return 0;
 763
 764 cleanup2:
 765         if (is_valid_irq(rtc_irq))
 766                 free_irq(rtc_irq, cmos_rtc.rtc);
 767 cleanup1:
 768         cmos_rtc.dev = NULL;
 769         rtc_device_unregister(cmos_rtc.rtc);
 770 cleanup0:
 771         release_region(ports->start, ports->end + 1 - ports->start);
 772         return retval;
 773 }
 774
 775 static void cmos_do_shutdown(void)
 776 {
 777         spin_lock_irq(&rtc_lock);
 778         cmos_irq_disable(&cmos_rtc, RTC_IRQMASK);
 779         spin_unlock_irq(&rtc_lock);
 780 }
 781
 782 static void __exit cmos_do_remove(struct device *dev)
 783 {
 784         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 785         struct resource *ports;
 786
 787         cmos_do_shutdown();
 788
 789         sysfs_remove_bin_file(&dev->kobj, &nvram);
 790
 791         if (is_valid_irq(cmos->irq)) {
 792                 free_irq(cmos->irq, cmos->rtc);
 793                 hpet_unregister_irq_handler(cmos_interrupt);
 794         }
 795
 796         rtc_device_unregister(cmos->rtc);
 797         cmos->rtc = NULL;
 798
 799         ports = cmos->iomem;
 800         release_region(ports->start, ports->end + 1 - ports->start);
 801         cmos->iomem = NULL;
 802
 803         cmos->dev = NULL;
 804         dev_set_drvdata(dev, NULL);
 805 }
 806
 807 #ifdef  CONFIG_PM
 808
 809 static int cmos_suspend(struct device *dev)
 810 {
 811         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 812         unsigned char   tmp;
 813
 814         /* only the alarm might be a wakeup event source */
 815         spin_lock_irq(&rtc_lock);
 816         cmos->suspend_ctrl = tmp = CMOS_READ(RTC_CONTROL);
 817         if (tmp & (RTC_PIE|RTC_AIE|RTC_UIE)) {
 818                 unsigned char   mask;
 819
 820                 if (device_may_wakeup(dev))
 821                         mask = RTC_IRQMASK & ~RTC_AIE;
 822                 else
 823                         mask = RTC_IRQMASK;
 824                 tmp &= ~mask;
 825                 CMOS_WRITE(tmp, RTC_CONTROL);
 826
 827                 /* shut down hpet emulation - we don't need it for alarm */
 828                 hpet_mask_rtc_irq_bit(RTC_PIE|RTC_AIE|RTC_UIE);
 829                 cmos_checkintr(cmos, tmp);
 830         }
 831         spin_unlock_irq(&rtc_lock);
 832
 833         if (tmp & RTC_AIE) {
 834                 cmos->enabled_wake = 1;
 835                 if (cmos->wake_on)
 836                         cmos->wake_on(dev);
 837                 else
 838                         enable_irq_wake(cmos->irq);
 839         }
 840
 841         pr_debug("%s: suspend%s, ctrl %02x\n",
 842                         dev_name(&cmos_rtc.rtc->dev),
 843                         (tmp & RTC_AIE) ? ", alarm may wake" : "",
 844                         tmp);
 845
 846         return 0;
 847 }
 848
 849 /* We want RTC alarms to wake us from e.g. ACPI G2/S5 "soft off", even
 850  * after a detour through G3 "mechanical off", although the ACPI spec
 851  * says wakeup should only work from G1/S4 "hibernate".  To most users,
 852  * distinctions between S4 and S5 are pointless.  So when the hardware
 853  * allows, don't draw that distinction.
 854  */
 855 static inline int cmos_poweroff(struct device *dev)
 856 {
 857         return cmos_suspend(dev);
 858 }
 859
 860 static int cmos_resume(struct device *dev)
 861 {
 862         struct cmos_rtc *cmos = dev_get_drvdata(dev);
 863         unsigned char   tmp = cmos->suspend_ctrl;
 864
 865         /* re-enable any irqs previously active */
 866         if (tmp & RTC_IRQMASK) {
 867                 unsigned char   mask;
 868
 869                 if (cmos->enabled_wake) {
 870                         if (cmos->wake_off)
 871                                 cmos->wake_off(dev);
 872                         else
 873                                 disable_irq_wake(cmos->irq);
 874                         cmos->enabled_wake = 0;
 875                 }
 876
 877                 spin_lock_irq(&rtc_lock);
 878                 do {
 879                         CMOS_WRITE(tmp, RTC_CONTROL);
 880                         hpet_set_rtc_irq_bit(tmp & RTC_IRQMASK);
 881
 882                         mask = CMOS_READ(RTC_INTR_FLAGS);
 883                         mask &= (tmp & RTC_IRQMASK) | RTC_IRQF;
 884                         if (!is_hpet_enabled() || !is_intr(mask))
 885                                 break;
 886
 887                         /* force one-shot behavior if HPET blocked
 888                          * the wake alarm's irq
 889                          */
 890                         rtc_update_irq(cmos->rtc, 1, mask);
 891                         tmp &= ~RTC_AIE;
 892                         hpet_mask_rtc_irq_bit(RTC_AIE);
 893                 } while (mask & RTC_AIE);
 894                 spin_unlock_irq(&rtc_lock);
 895         }
 896
 897         pr_debug("%s: resume, ctrl %02x\n",
 898                         dev_name(&cmos_rtc.rtc->dev),
 899                         tmp);
 900
 901         return 0;
 902 }
 903
 904 static SIMPLE_DEV_PM_OPS(cmos_pm_ops, cmos_suspend, cmos_resume);
 905
 906 #else
 907
 908 static inline int cmos_poweroff(struct device *dev)
 909 {
 910         return -ENOSYS;
 911 }
 912
 913 #endif
 914
 915 /*----------------------------------------------------------------*/
 916
 917 /* On non-x86 systems, a "CMOS" RTC lives most naturally on platform_bus.
 918  * ACPI systems always list these as PNPACPI devices, and pre-ACPI PCs
 919  * probably list them in similar PNPBIOS tables; so PNP is more common.
 920  *
 921  * We don't use legacy "poke at the hardware" probing.  Ancient PCs that
 922  * predate even PNPBIOS should set up platform_bus devices.
 923  */
 924
 925 #ifdef  CONFIG_ACPI
 926
 927 #include <linux/acpi.h>
 928
 929 static u32 rtc_handler(void *context)
 930 {
 931         acpi_clear_event(ACPI_EVENT_RTC);
 932         acpi_disable_event(ACPI_EVENT_RTC, 0);
 933         return ACPI_INTERRUPT_HANDLED;
 934 }
 935
 936 static inline void rtc_wake_setup(void)
 937 {
 938         acpi_install_fixed_event_handler(ACPI_EVENT_RTC, rtc_handler, NULL);
 939         /*
 940          * After the RTC handler is installed, the Fixed_RTC event should
 941          * be disabled. Only when the RTC alarm is set will it be enabled.
 942          */
 943         acpi_clear_event(ACPI_EVENT_RTC);
 944         acpi_disable_event(ACPI_EVENT_RTC, 0);
 945 }
 946
 947 static void rtc_wake_on(struct device *dev)
 948 {
 949         acpi_clear_event(ACPI_EVENT_RTC);
 950         acpi_enable_event(ACPI_EVENT_RTC, 0);
 951 }
 952
 953 static void rtc_wake_off(struct device *dev)
 954 {
 955         acpi_disable_event(ACPI_EVENT_RTC, 0);
 956 }
 957
 958 /* Every ACPI platform has a mc146818 compatible "cmos rtc".  Here we find
 959  * its device node and pass extra config data.  This helps its driver use
 960  * capabilities that the now-obsolete mc146818 didn't have, and informs it
 961  * that this board's RTC is wakeup-capable (per ACPI spec).
 962  */
 963 static struct cmos_rtc_board_info acpi_rtc_info;
 964
 965 static void __devinit
 966 cmos_wake_setup(struct device *dev)
 967 {
 968         if (acpi_disabled)
 969                 return;
 970
 971         rtc_wake_setup();
 972         acpi_rtc_info.wake_on = rtc_wake_on;
 973         acpi_rtc_info.wake_off = rtc_wake_off;
 974
 975         /* workaround bug in some ACPI tables */
 976         if (acpi_gbl_FADT.month_alarm && !acpi_gbl_FADT.day_alarm) {
 977                 dev_dbg(dev, "bogus FADT month_alarm (%d)\n",
 978                         acpi_gbl_FADT.month_alarm);
 979                 acpi_gbl_FADT.month_alarm = 0;
 980         }
 981
 982         acpi_rtc_info.rtc_day_alarm = acpi_gbl_FADT.day_alarm;
 983         acpi_rtc_info.rtc_mon_alarm = acpi_gbl_FADT.month_alarm;
 984         acpi_rtc_info.rtc_century = acpi_gbl_FADT.century;
 985
 986         /* NOTE:  S4_RTC_WAKE is NOT currently useful to Linux */
 987         if (acpi_gbl_FADT.flags & ACPI_FADT_S4_RTC_WAKE)
 988                 dev_info(dev, "RTC can wake from S4\n");
 989
 990         dev->platform_data = &acpi_rtc_info;
 991
 992         /* RTC always wakes from S1/S2/S3, and often S4/STD */
 993         device_init_wakeup(dev, 1);
 994 }
 995
 996 #else
 997
 998 static void __devinit
 999 cmos_wake_setup(struct device *dev)
1000 {
1001 }
1002
1003 #endif
1004
1005 #ifdef  CONFIG_PNP
1006
1007 #include <linux/pnp.h>
1008
1009 static int __devinit
1010 cmos_pnp_probe(struct pnp_dev *pnp, const struct pnp_device_id *id)
1011 {
1012         cmos_wake_setup(&pnp->dev);
1013
1014         if (pnp_port_start(pnp,0) == 0x70 && !pnp_irq_valid(pnp,0))
1015                 /* Some machines contain a PNP entry for the RTC, but
1016                  * don't define the IRQ. It should always be safe to
1017                  * hardcode it in these cases
1018                  */
1019                 return cmos_do_probe(&pnp->dev,
1020                                 pnp_get_resource(pnp, IORESOURCE_IO, 0), 8);
1021         else
1022                 return cmos_do_probe(&pnp->dev,
1023                                 pnp_get_resource(pnp, IORESOURCE_IO, 0),
1024                                 pnp_irq(pnp, 0));
1025 }
1026
1027 static void __exit cmos_pnp_remove(struct pnp_dev *pnp)
1028 {
1029         cmos_do_remove(&pnp->dev);
1030 }
1031
1032 #ifdef  CONFIG_PM
1033
1034 static int cmos_pnp_suspend(struct pnp_dev *pnp, pm_message_t mesg)
1035 {
1036         return cmos_suspend(&pnp->dev);
1037 }
1038
1039 static int cmos_pnp_resume(struct pnp_dev *pnp)
1040 {
1041         return cmos_resume(&pnp->dev);
1042 }
1043
1044 #else
1045 #define cmos_pnp_suspend        NULL
1046 #define cmos_pnp_resume         NULL
1047 #endif
1048
1049 static void cmos_pnp_shutdown(struct pnp_dev *pnp)
1050 {
1051         if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(&pnp->dev))
1052                 return;
1053
1054         cmos_do_shutdown();
1055 }
1056
1057 static const struct pnp_device_id rtc_ids[] = {
1058         { .id = "PNP0b00", },
1059         { .id = "PNP0b01", },
1060         { .id = "PNP0b02", },
1061         { },
1062 };
1063 MODULE_DEVICE_TABLE(pnp, rtc_ids);
1064
1065 static struct pnp_driver cmos_pnp_driver = {
1066         .name           = (char *) driver_name,
1067         .id_table       = rtc_ids,
1068         .probe          = cmos_pnp_probe,
1069         .remove         = __exit_p(cmos_pnp_remove),
1070         .shutdown       = cmos_pnp_shutdown,
1071
1072         /* flag ensures resume() gets called, and stops syslog spam */
1073         .flags          = PNP_DRIVER_RES_DO_NOT_CHANGE,
1074         .suspend        = cmos_pnp_suspend,
1075         .resume         = cmos_pnp_resume,
1076 };
1077
1078 #endif  /* CONFIG_PNP */
1079
1080 /*----------------------------------------------------------------*/
1081
1082 /* Platform setup should have set up an RTC device, when PNP is
1083  * unavailable ... this could happen even on (older) PCs.
1084  */
1085
1086 static int __init cmos_platform_probe(struct platform_device *pdev)
1087 {
1088         cmos_wake_setup(&pdev->dev);
1089         return cmos_do_probe(&pdev->dev,
1090                         platform_get_resource(pdev, IORESOURCE_IO, 0),
1091                         platform_get_irq(pdev, 0));
1092 }
1093
1094 static int __exit cmos_platform_remove(struct platform_device *pdev)
1095 {
1096         cmos_do_remove(&pdev->dev);
1097         return 0;
1098 }
1099
1100 static void cmos_platform_shutdown(struct platform_device *pdev)
1101 {
1102         if (system_state == SYSTEM_POWER_OFF && !cmos_poweroff(&pdev->dev))
1103                 return;
1104
1105         cmos_do_shutdown();
1106 }
1107
1108 /* work with hotplug and coldplug */
1109 MODULE_ALIAS("platform:rtc_cmos");
1110
1111 static struct platform_driver cmos_platform_driver = {
1112         .remove         = __exit_p(cmos_platform_remove),
1113         .shutdown       = cmos_platform_shutdown,
1114         .driver = {
1115                 .name           = (char *) driver_name,
1116 #ifdef CONFIG_PM
1117                 .pm             = &cmos_pm_ops,
1118 #endif
1119         }
1120 };
1121
1122 #ifdef CONFIG_PNP
1123 static bool pnp_driver_registered;
1124 #endif
1125 static bool platform_driver_registered;
1126
1127 static int __init cmos_init(void)
1128 {
1129         int retval = 0;
1130
1131 #ifdef  CONFIG_PNP
1132         retval = pnp_register_driver(&cmos_pnp_driver);
1133         if (retval == 0)
1134                 pnp_driver_registered = true;
1135 #endif
1136
1137         if (!cmos_rtc.dev) {
1138                 retval = platform_driver_probe(&cmos_platform_driver,
1139                                                cmos_platform_probe);
1140                 if (retval == 0)
1141                         platform_driver_registered = true;
1142         }
1143
1144         if (retval == 0)
1145                 return 0;
1146
1147 #ifdef  CONFIG_PNP
1148         if (pnp_driver_registered)
1149                 pnp_unregister_driver(&cmos_pnp_driver);
1150 #endif
1151         return retval;
1152 }
1153 module_init(cmos_init);
1154
1155 static void __exit cmos_exit(void)
1156 {
1157 #ifdef  CONFIG_PNP
1158         if (pnp_driver_registered)
1159                 pnp_unregister_driver(&cmos_pnp_driver);
1160 #endif
1161         if (platform_driver_registered)
1162                 platform_driver_unregister(&cmos_platform_driver);
1163 }
1164 module_exit(cmos_exit);
1165
1166
1167 MODULE_AUTHOR("David Brownell");
1168 MODULE_DESCRIPTION("Driver for PC-style 'CMOS' RTCs");
1169 MODULE_LICENSE("GPL");