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