drivers/rtc/rtc-cmos.c

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