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