drivers/char/rtc.c

   1 /*
   2  *      Real Time Clock interface for Linux
   3  *
   4  *      Copyright (C) 1996 Paul Gortmaker
   5  *
   6  *      This driver allows use of the real time clock (built into
   7  *      nearly all computers) from user space. It exports the /dev/rtc
   8  *      interface supporting various ioctl() and also the
   9  *      /proc/driver/rtc pseudo-file for status information.
  10  *
  11  *      The ioctls can be used to set the interrupt behaviour and
  12  *      generation rate from the RTC via IRQ 8. Then the /dev/rtc
  13  *      interface can be used to make use of these timer interrupts,
  14  *      be they interval or alarm based.
  15  *
  16  *      The /dev/rtc interface will block on reads until an interrupt
  17  *      has been received. If a RTC interrupt has already happened,
  18  *      it will output an unsigned long and then block. The output value
  19  *      contains the interrupt status in the low byte and the number of
  20  *      interrupts since the last read in the remaining high bytes. The
  21  *      /dev/rtc interface can also be used with the select(2) call.
  22  *
  23  *      This program is free software; you can redistribute it and/or
  24  *      modify it under the terms of the GNU General Public License
  25  *      as published by the Free Software Foundation; either version
  26  *      2 of the License, or (at your option) any later version.
  27  *
  28  *      Based on other minimal char device drivers, like Alan's
  29  *      watchdog, Ted's random, etc. etc.
  30  *
  31  *      1.07    Paul Gortmaker.
  32  *      1.08    Miquel van Smoorenburg: disallow certain things on the
  33  *              DEC Alpha as the CMOS clock is also used for other things.
  34  *      1.09    Nikita Schmidt: epoch support and some Alpha cleanup.
  35  *      1.09a   Pete Zaitcev: Sun SPARC
  36  *      1.09b   Jeff Garzik: Modularize, init cleanup
  37  *      1.09c   Jeff Garzik: SMP cleanup
  38  *      1.10    Paul Barton-Davis: add support for async I/O
  39  *      1.10a   Andrea Arcangeli: Alpha updates
  40  *      1.10b   Andrew Morton: SMP lock fix
  41  *      1.10c   Cesar Barros: SMP locking fixes and cleanup
  42  *      1.10d   Paul Gortmaker: delete paranoia check in rtc_exit
  43  *      1.10e   Maciej W. Rozycki: Handle DECstation's year weirdness.
  44  *      1.11    Takashi Iwai: Kernel access functions
  45  *                            rtc_register/rtc_unregister/rtc_control
  46  *      1.11a   Daniele Bellucci: Audit create_proc_read_entry in rtc_init
  47  *      1.12    Venkatesh Pallipadi: Hooks for emulating rtc on HPET base-timer
  48  *              CONFIG_HPET_EMULATE_RTC
  49  *      1.12a   Maciej W. Rozycki: Handle memory-mapped chips properly.
  50  *      1.12ac  Alan Cox: Allow read access to the day of week register
  51  */
  52
  53 #define RTC_VERSION             "1.12ac"
  54
  55 /*
  56  *      Note that *all* calls to CMOS_READ and CMOS_WRITE are done with
  57  *      interrupts disabled. Due to the index-port/data-port (0x70/0x71)
  58  *      design of the RTC, we don't want two different things trying to
  59  *      get to it at once. (e.g. the periodic 11 min sync from time.c vs.
  60  *      this driver.)
  61  */
  62
  63 #include <linux/interrupt.h>
  64 #include <linux/module.h>
  65 #include <linux/kernel.h>
  66 #include <linux/types.h>
  67 #include <linux/miscdevice.h>
  68 #include <linux/ioport.h>
  69 #include <linux/fcntl.h>
  70 #include <linux/mc146818rtc.h>
  71 #include <linux/init.h>
  72 #include <linux/poll.h>
  73 #include <linux/proc_fs.h>
  74 #include <linux/seq_file.h>
  75 #include <linux/spinlock.h>
  76 #include <linux/smp_lock.h>
  77 #include <linux/sysctl.h>
  78 #include <linux/wait.h>
  79 #include <linux/bcd.h>
  80 #include <linux/delay.h>
  81
  82 #include <asm/current.h>
  83 #include <asm/uaccess.h>
  84 #include <asm/system.h>
  85
  86 #ifdef CONFIG_X86
  87 #include <asm/hpet.h>
  88 #endif
  89
  90 #ifdef CONFIG_SPARC32
  91 #include <linux/pci.h>
  92 #include <linux/jiffies.h>
  93 #include <asm/ebus.h>
  94
  95 static unsigned long rtc_port;
  96 static int rtc_irq = PCI_IRQ_NONE;
  97 #endif
  98
  99 #ifdef  CONFIG_HPET_RTC_IRQ
 100 #undef  RTC_IRQ
 101 #endif
 102
 103 #ifdef RTC_IRQ
 104 static int rtc_has_irq = 1;
 105 #endif
 106
 107 #ifndef CONFIG_HPET_EMULATE_RTC
 108 #define is_hpet_enabled()                       0
 109 #define hpet_set_alarm_time(hrs, min, sec)      0
 110 #define hpet_set_periodic_freq(arg)             0
 111 #define hpet_mask_rtc_irq_bit(arg)              0
 112 #define hpet_set_rtc_irq_bit(arg)               0
 113 #define hpet_rtc_timer_init()                   do { } while (0)
 114 #define hpet_rtc_dropped_irq()                  0
 115 #define hpet_register_irq_handler(h)            ({ 0; })
 116 #define hpet_unregister_irq_handler(h)          ({ 0; })
 117 #ifdef RTC_IRQ
 118 static irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id)
 119 {
 120         return 0;
 121 }
 122 #endif
 123 #else
 124 extern irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id);
 125 #endif
 126
 127 /*
 128  *      We sponge a minor off of the misc major. No need slurping
 129  *      up another valuable major dev number for this. If you add
 130  *      an ioctl, make sure you don't conflict with SPARC's RTC
 131  *      ioctls.
 132  */
 133
 134 static struct fasync_struct *rtc_async_queue;
 135
 136 static DECLARE_WAIT_QUEUE_HEAD(rtc_wait);
 137
 138 #ifdef RTC_IRQ
 139 static void rtc_dropped_irq(unsigned long data);
 140
 141 static DEFINE_TIMER(rtc_irq_timer, rtc_dropped_irq, 0, 0);
 142 #endif
 143
 144 static ssize_t rtc_read(struct file *file, char __user *buf,
 145                         size_t count, loff_t *ppos);
 146
 147 static int rtc_ioctl(struct inode *inode, struct file *file,
 148                      unsigned int cmd, unsigned long arg);
 149
 150 #ifdef RTC_IRQ
 151 static unsigned int rtc_poll(struct file *file, poll_table *wait);
 152 #endif
 153
 154 static void get_rtc_alm_time(struct rtc_time *alm_tm);
 155 #ifdef RTC_IRQ
 156 static void set_rtc_irq_bit_locked(unsigned char bit);
 157 static void mask_rtc_irq_bit_locked(unsigned char bit);
 158
 159 static inline void set_rtc_irq_bit(unsigned char bit)
 160 {
 161         spin_lock_irq(&rtc_lock);
 162         set_rtc_irq_bit_locked(bit);
 163         spin_unlock_irq(&rtc_lock);
 164 }
 165
 166 static void mask_rtc_irq_bit(unsigned char bit)
 167 {
 168         spin_lock_irq(&rtc_lock);
 169         mask_rtc_irq_bit_locked(bit);
 170         spin_unlock_irq(&rtc_lock);
 171 }
 172 #endif
 173
 174 #ifdef CONFIG_PROC_FS
 175 static int rtc_proc_open(struct inode *inode, struct file *file);
 176 #endif
 177
 178 /*
 179  *      Bits in rtc_status. (6 bits of room for future expansion)
 180  */
 181
 182 #define RTC_IS_OPEN             0x01    /* means /dev/rtc is in use     */
 183 #define RTC_TIMER_ON            0x02    /* missed irq timer active      */
 184
 185 /*
 186  * rtc_status is never changed by rtc_interrupt, and ioctl/open/close is
 187  * protected by the big kernel lock. However, ioctl can still disable the timer
 188  * in rtc_status and then with del_timer after the interrupt has read
 189  * rtc_status but before mod_timer is called, which would then reenable the
 190  * timer (but you would need to have an awful timing before you'd trip on it)
 191  */
 192 static unsigned long rtc_status;        /* bitmapped status byte.       */
 193 static unsigned long rtc_freq;          /* Current periodic IRQ rate    */
 194 static unsigned long rtc_irq_data;      /* our output to the world      */
 195 static unsigned long rtc_max_user_freq = 64; /* > this, need CAP_SYS_RESOURCE */
 196
 197 #ifdef RTC_IRQ
 198 /*
 199  * rtc_task_lock nests inside rtc_lock.
 200  */
 201 static DEFINE_SPINLOCK(rtc_task_lock);
 202 static rtc_task_t *rtc_callback;
 203 #endif
 204
 205 /*
 206  *      If this driver ever becomes modularised, it will be really nice
 207  *      to make the epoch retain its value across module reload...
 208  */
 209
 210 static unsigned long epoch = 1900;      /* year corresponding to 0x00   */
 211
 212 static const unsigned char days_in_mo[] =
 213 {0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
 214
 215 /*
 216  * Returns true if a clock update is in progress
 217  */
 218 static inline unsigned char rtc_is_updating(void)
 219 {
 220         unsigned long flags;
 221         unsigned char uip;
 222
 223         spin_lock_irqsave(&rtc_lock, flags);
 224         uip = (CMOS_READ(RTC_FREQ_SELECT) & RTC_UIP);
 225         spin_unlock_irqrestore(&rtc_lock, flags);
 226         return uip;
 227 }
 228
 229 #ifdef RTC_IRQ
 230 /*
 231  *      A very tiny interrupt handler. It runs with IRQF_DISABLED set,
 232  *      but there is possibility of conflicting with the set_rtc_mmss()
 233  *      call (the rtc irq and the timer irq can easily run at the same
 234  *      time in two different CPUs). So we need to serialize
 235  *      accesses to the chip with the rtc_lock spinlock that each
 236  *      architecture should implement in the timer code.
 237  *      (See ./arch/XXXX/kernel/time.c for the set_rtc_mmss() function.)
 238  */
 239
 240 irqreturn_t rtc_interrupt(int irq, void *dev_id)
 241 {
 242         /*
 243          *      Can be an alarm interrupt, update complete interrupt,
 244          *      or a periodic interrupt. We store the status in the
 245          *      low byte and the number of interrupts received since
 246          *      the last read in the remainder of rtc_irq_data.
 247          */
 248
 249         spin_lock(&rtc_lock);
 250         rtc_irq_data += 0x100;
 251         rtc_irq_data &= ~0xff;
 252         if (is_hpet_enabled()) {
 253                 /*
 254                  * In this case it is HPET RTC interrupt handler
 255                  * calling us, with the interrupt information
 256                  * passed as arg1, instead of irq.
 257                  */
 258                 rtc_irq_data |= (unsigned long)irq & 0xF0;
 259         } else {
 260                 rtc_irq_data |= (CMOS_READ(RTC_INTR_FLAGS) & 0xF0);
 261         }
 262
 263         if (rtc_status & RTC_TIMER_ON)
 264                 mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq + 2*HZ/100);
 265
 266         spin_unlock(&rtc_lock);
 267
 268         /* Now do the rest of the actions */
 269         spin_lock(&rtc_task_lock);
 270         if (rtc_callback)
 271                 rtc_callback->func(rtc_callback->private_data);
 272         spin_unlock(&rtc_task_lock);
 273         wake_up_interruptible(&rtc_wait);
 274
 275         kill_fasync(&rtc_async_queue, SIGIO, POLL_IN);
 276
 277         return IRQ_HANDLED;
 278 }
 279 #endif
 280
 281 /*
 282  * sysctl-tuning infrastructure.
 283  */
 284 static ctl_table rtc_table[] = {
 285         {
 286                 .ctl_name       = CTL_UNNUMBERED,
 287                 .procname       = "max-user-freq",
 288                 .data           = &rtc_max_user_freq,
 289                 .maxlen         = sizeof(int),
 290                 .mode           = 0644,
 291                 .proc_handler   = &proc_dointvec,
 292         },
 293         { .ctl_name = 0 }
 294 };
 295
 296 static ctl_table rtc_root[] = {
 297         {
 298                 .ctl_name       = CTL_UNNUMBERED,
 299                 .procname       = "rtc",
 300                 .mode           = 0555,
 301                 .child          = rtc_table,
 302         },
 303         { .ctl_name = 0 }
 304 };
 305
 306 static ctl_table dev_root[] = {
 307         {
 308                 .ctl_name       = CTL_DEV,
 309                 .procname       = "dev",
 310                 .mode           = 0555,
 311                 .child          = rtc_root,
 312         },
 313         { .ctl_name = 0 }
 314 };
 315
 316 static struct ctl_table_header *sysctl_header;
 317
 318 static int __init init_sysctl(void)
 319 {
 320     sysctl_header = register_sysctl_table(dev_root);
 321     return 0;
 322 }
 323
 324 static void __exit cleanup_sysctl(void)
 325 {
 326     unregister_sysctl_table(sysctl_header);
 327 }
 328
 329 /*
 330  *      Now all the various file operations that we export.
 331  */
 332
 333 static ssize_t rtc_read(struct file *file, char __user *buf,
 334                         size_t count, loff_t *ppos)
 335 {
 336 #ifndef RTC_IRQ
 337         return -EIO;
 338 #else
 339         DECLARE_WAITQUEUE(wait, current);
 340         unsigned long data;
 341         ssize_t retval;
 342
 343         if (rtc_has_irq == 0)
 344                 return -EIO;
 345
 346         /*
 347          * Historically this function used to assume that sizeof(unsigned long)
 348          * is the same in userspace and kernelspace.  This lead to problems
 349          * for configurations with multiple ABIs such a the MIPS o32 and 64
 350          * ABIs supported on the same kernel.  So now we support read of both
 351          * 4 and 8 bytes and assume that's the sizeof(unsigned long) in the
 352          * userspace ABI.
 353          */
 354         if (count != sizeof(unsigned int) && count !=  sizeof(unsigned long))
 355                 return -EINVAL;
 356
 357         add_wait_queue(&rtc_wait, &wait);
 358
 359         do {
 360                 /* First make it right. Then make it fast. Putting this whole
 361                  * block within the parentheses of a while would be too
 362                  * confusing. And no, xchg() is not the answer. */
 363
 364                 __set_current_state(TASK_INTERRUPTIBLE);
 365
 366                 spin_lock_irq(&rtc_lock);
 367                 data = rtc_irq_data;
 368                 rtc_irq_data = 0;
 369                 spin_unlock_irq(&rtc_lock);
 370
 371                 if (data != 0)
 372                         break;
 373
 374                 if (file->f_flags & O_NONBLOCK) {
 375                         retval = -EAGAIN;
 376                         goto out;
 377                 }
 378                 if (signal_pending(current)) {
 379                         retval = -ERESTARTSYS;
 380                         goto out;
 381                 }
 382                 schedule();
 383         } while (1);
 384
 385         if (count == sizeof(unsigned int)) {
 386                 retval = put_user(data,
 387                                   (unsigned int __user *)buf) ?: sizeof(int);
 388         } else {
 389                 retval = put_user(data,
 390                                   (unsigned long __user *)buf) ?: sizeof(long);
 391         }
 392         if (!retval)
 393                 retval = count;
 394  out:
 395         __set_current_state(TASK_RUNNING);
 396         remove_wait_queue(&rtc_wait, &wait);
 397
 398         return retval;
 399 #endif
 400 }
 401
 402 static int rtc_do_ioctl(unsigned int cmd, unsigned long arg, int kernel)
 403 {
 404         struct rtc_time wtime;
 405
 406 #ifdef RTC_IRQ
 407         if (rtc_has_irq == 0) {
 408                 switch (cmd) {
 409                 case RTC_AIE_OFF:
 410                 case RTC_AIE_ON:
 411                 case RTC_PIE_OFF:
 412                 case RTC_PIE_ON:
 413                 case RTC_UIE_OFF:
 414                 case RTC_UIE_ON:
 415                 case RTC_IRQP_READ:
 416                 case RTC_IRQP_SET:
 417                         return -EINVAL;
 418                 };
 419         }
 420 #endif
 421
 422         switch (cmd) {
 423 #ifdef RTC_IRQ
 424         case RTC_AIE_OFF:       /* Mask alarm int. enab. bit    */
 425         {
 426                 mask_rtc_irq_bit(RTC_AIE);
 427                 return 0;
 428         }
 429         case RTC_AIE_ON:        /* Allow alarm interrupts.      */
 430         {
 431                 set_rtc_irq_bit(RTC_AIE);
 432                 return 0;
 433         }
 434         case RTC_PIE_OFF:       /* Mask periodic int. enab. bit */
 435         {
 436                 /* can be called from isr via rtc_control() */
 437                 unsigned long flags;
 438
 439                 spin_lock_irqsave(&rtc_lock, flags);
 440                 mask_rtc_irq_bit_locked(RTC_PIE);
 441                 if (rtc_status & RTC_TIMER_ON) {
 442                         rtc_status &= ~RTC_TIMER_ON;
 443                         del_timer(&rtc_irq_timer);
 444                 }
 445                 spin_unlock_irqrestore(&rtc_lock, flags);
 446
 447                 return 0;
 448         }
 449         case RTC_PIE_ON:        /* Allow periodic ints          */
 450         {
 451                 /* can be called from isr via rtc_control() */
 452                 unsigned long flags;
 453
 454                 /*
 455                  * We don't really want Joe User enabling more
 456                  * than 64Hz of interrupts on a multi-user machine.
 457                  */
 458                 if (!kernel && (rtc_freq > rtc_max_user_freq) &&
 459                                                 (!capable(CAP_SYS_RESOURCE)))
 460                         return -EACCES;
 461
 462                 spin_lock_irqsave(&rtc_lock, flags);
 463                 if (!(rtc_status & RTC_TIMER_ON)) {
 464                         mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq +
 465                                         2*HZ/100);
 466                         rtc_status |= RTC_TIMER_ON;
 467                 }
 468                 set_rtc_irq_bit_locked(RTC_PIE);
 469                 spin_unlock_irqrestore(&rtc_lock, flags);
 470
 471                 return 0;
 472         }
 473         case RTC_UIE_OFF:       /* Mask ints from RTC updates.  */
 474         {
 475                 mask_rtc_irq_bit(RTC_UIE);
 476                 return 0;
 477         }
 478         case RTC_UIE_ON:        /* Allow ints for RTC updates.  */
 479         {
 480                 set_rtc_irq_bit(RTC_UIE);
 481                 return 0;
 482         }
 483 #endif
 484         case RTC_ALM_READ:      /* Read the present alarm time */
 485         {
 486                 /*
 487                  * This returns a struct rtc_time. Reading >= 0xc0
 488                  * means "don't care" or "match all". Only the tm_hour,
 489                  * tm_min, and tm_sec values are filled in.
 490                  */
 491                 memset(&wtime, 0, sizeof(struct rtc_time));
 492                 get_rtc_alm_time(&wtime);
 493                 break;
 494         }
 495         case RTC_ALM_SET:       /* Store a time into the alarm */
 496         {
 497                 /*
 498                  * This expects a struct rtc_time. Writing 0xff means
 499                  * "don't care" or "match all". Only the tm_hour,
 500                  * tm_min and tm_sec are used.
 501                  */
 502                 unsigned char hrs, min, sec;
 503                 struct rtc_time alm_tm;
 504
 505                 if (copy_from_user(&alm_tm, (struct rtc_time __user *)arg,
 506                                    sizeof(struct rtc_time)))
 507                         return -EFAULT;
 508
 509                 hrs = alm_tm.tm_hour;
 510                 min = alm_tm.tm_min;
 511                 sec = alm_tm.tm_sec;
 512
 513                 spin_lock_irq(&rtc_lock);
 514                 if (hpet_set_alarm_time(hrs, min, sec)) {
 515                         /*
 516                          * Fallthru and set alarm time in CMOS too,
 517                          * so that we will get proper value in RTC_ALM_READ
 518                          */
 519                 }
 520                 if (!(CMOS_READ(RTC_CONTROL) & RTC_DM_BINARY) ||
 521                                                         RTC_ALWAYS_BCD) {
 522                         if (sec < 60)
 523                                 BIN_TO_BCD(sec);
 524                         else
 525                                 sec = 0xff;
 526
 527                         if (min < 60)
 528                                 BIN_TO_BCD(min);
 529                         else
 530                                 min = 0xff;
 531
 532                         if (hrs < 24)
 533                                 BIN_TO_BCD(hrs);
 534                         else
 535                                 hrs = 0xff;
 536                 }
 537                 CMOS_WRITE(hrs, RTC_HOURS_ALARM);
 538                 CMOS_WRITE(min, RTC_MINUTES_ALARM);
 539                 CMOS_WRITE(sec, RTC_SECONDS_ALARM);
 540                 spin_unlock_irq(&rtc_lock);
 541
 542                 return 0;
 543         }
 544         case RTC_RD_TIME:       /* Read the time/date from RTC  */
 545         {
 546                 memset(&wtime, 0, sizeof(struct rtc_time));
 547                 rtc_get_rtc_time(&wtime);
 548                 break;
 549         }
 550         case RTC_SET_TIME:      /* Set the RTC */
 551         {
 552                 struct rtc_time rtc_tm;
 553                 unsigned char mon, day, hrs, min, sec, leap_yr;
 554                 unsigned char save_control, save_freq_select;
 555                 unsigned int yrs;
 556 #ifdef CONFIG_MACH_DECSTATION
 557                 unsigned int real_yrs;
 558 #endif
 559
 560                 if (!capable(CAP_SYS_TIME))
 561                         return -EACCES;
 562
 563                 if (copy_from_user(&rtc_tm, (struct rtc_time __user *)arg,
 564                                    sizeof(struct rtc_time)))
 565                         return -EFAULT;
 566
 567                 yrs = rtc_tm.tm_year + 1900;
 568                 mon = rtc_tm.tm_mon + 1;   /* tm_mon starts at zero */
 569                 day = rtc_tm.tm_mday;
 570                 hrs = rtc_tm.tm_hour;
 571                 min = rtc_tm.tm_min;
 572                 sec = rtc_tm.tm_sec;
 573
 574                 if (yrs < 1970)
 575                         return -EINVAL;
 576
 577                 leap_yr = ((!(yrs % 4) && (yrs % 100)) || !(yrs % 400));
 578
 579                 if ((mon > 12) || (day == 0))
 580                         return -EINVAL;
 581
 582                 if (day > (days_in_mo[mon] + ((mon == 2) && leap_yr)))
 583                         return -EINVAL;
 584
 585                 if ((hrs >= 24) || (min >= 60) || (sec >= 60))
 586                         return -EINVAL;
 587
 588                 yrs -= epoch;
 589                 if (yrs > 255)          /* They are unsigned */
 590                         return -EINVAL;
 591
 592                 spin_lock_irq(&rtc_lock);
 593 #ifdef CONFIG_MACH_DECSTATION
 594                 real_yrs = yrs;
 595                 yrs = 72;
 596
 597                 /*
 598                  * We want to keep the year set to 73 until March
 599                  * for non-leap years, so that Feb, 29th is handled
 600                  * correctly.
 601                  */
 602                 if (!leap_yr && mon < 3) {
 603                         real_yrs--;
 604                         yrs = 73;
 605                 }
 606 #endif
 607                 /* These limits and adjustments are independent of
 608                  * whether the chip is in binary mode or not.
 609                  */
 610                 if (yrs > 169) {
 611                         spin_unlock_irq(&rtc_lock);
 612                         return -EINVAL;
 613                 }
 614                 if (yrs >= 100)
 615                         yrs -= 100;
 616
 617                 if (!(CMOS_READ(RTC_CONTROL) & RTC_DM_BINARY)
 618                     || RTC_ALWAYS_BCD) {
 619                         BIN_TO_BCD(sec);
 620                         BIN_TO_BCD(min);
 621                         BIN_TO_BCD(hrs);
 622                         BIN_TO_BCD(day);
 623                         BIN_TO_BCD(mon);
 624                         BIN_TO_BCD(yrs);
 625                 }
 626
 627                 save_control = CMOS_READ(RTC_CONTROL);
 628                 CMOS_WRITE((save_control|RTC_SET), RTC_CONTROL);
 629                 save_freq_select = CMOS_READ(RTC_FREQ_SELECT);
 630                 CMOS_WRITE((save_freq_select|RTC_DIV_RESET2), RTC_FREQ_SELECT);
 631
 632 #ifdef CONFIG_MACH_DECSTATION
 633                 CMOS_WRITE(real_yrs, RTC_DEC_YEAR);
 634 #endif
 635                 CMOS_WRITE(yrs, RTC_YEAR);
 636                 CMOS_WRITE(mon, RTC_MONTH);
 637                 CMOS_WRITE(day, RTC_DAY_OF_MONTH);
 638                 CMOS_WRITE(hrs, RTC_HOURS);
 639                 CMOS_WRITE(min, RTC_MINUTES);
 640                 CMOS_WRITE(sec, RTC_SECONDS);
 641
 642                 CMOS_WRITE(save_control, RTC_CONTROL);
 643                 CMOS_WRITE(save_freq_select, RTC_FREQ_SELECT);
 644
 645                 spin_unlock_irq(&rtc_lock);
 646                 return 0;
 647         }
 648 #ifdef RTC_IRQ
 649         case RTC_IRQP_READ:     /* Read the periodic IRQ rate.  */
 650         {
 651                 return put_user(rtc_freq, (unsigned long __user *)arg);
 652         }
 653         case RTC_IRQP_SET:      /* Set periodic IRQ rate.       */
 654         {
 655                 int tmp = 0;
 656                 unsigned char val;
 657                 /* can be called from isr via rtc_control() */
 658                 unsigned long flags;
 659
 660                 /*
 661                  * The max we can do is 8192Hz.
 662                  */
 663                 if ((arg < 2) || (arg > 8192))
 664                         return -EINVAL;
 665                 /*
 666                  * We don't really want Joe User generating more
 667                  * than 64Hz of interrupts on a multi-user machine.
 668                  */
 669                 if (!kernel && (arg > rtc_max_user_freq) &&
 670                                         !capable(CAP_SYS_RESOURCE))
 671                         return -EACCES;
 672
 673                 while (arg > (1<<tmp))
 674                         tmp++;
 675
 676                 /*
 677                  * Check that the input was really a power of 2.
 678                  */
 679                 if (arg != (1<<tmp))
 680                         return -EINVAL;
 681
 682                 spin_lock_irqsave(&rtc_lock, flags);
 683                 if (hpet_set_periodic_freq(arg)) {
 684                         spin_unlock_irqrestore(&rtc_lock, flags);
 685                         return 0;
 686                 }
 687                 rtc_freq = arg;
 688
 689                 val = CMOS_READ(RTC_FREQ_SELECT) & 0xf0;
 690                 val |= (16 - tmp);
 691                 CMOS_WRITE(val, RTC_FREQ_SELECT);
 692                 spin_unlock_irqrestore(&rtc_lock, flags);
 693                 return 0;
 694         }
 695 #endif
 696         case RTC_EPOCH_READ:    /* Read the epoch.      */
 697         {
 698                 return put_user(epoch, (unsigned long __user *)arg);
 699         }
 700         case RTC_EPOCH_SET:     /* Set the epoch.       */
 701         {
 702                 /*
 703                  * There were no RTC clocks before 1900.
 704                  */
 705                 if (arg < 1900)
 706                         return -EINVAL;
 707
 708                 if (!capable(CAP_SYS_TIME))
 709                         return -EACCES;
 710
 711                 epoch = arg;
 712                 return 0;
 713         }
 714         default:
 715                 return -ENOTTY;
 716         }
 717         return copy_to_user((void __user *)arg,
 718                             &wtime, sizeof wtime) ? -EFAULT : 0;
 719 }
 720
 721 static int rtc_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 722                      unsigned long arg)
 723 {
 724         return rtc_do_ioctl(cmd, arg, 0);
 725 }
 726
 727 /*
 728  *      We enforce only one user at a time here with the open/close.
 729  *      Also clear the previous interrupt data on an open, and clean
 730  *      up things on a close.
 731  */
 732
 733 /* We use rtc_lock to protect against concurrent opens. So the BKL is not
 734  * needed here. Or anywhere else in this driver. */
 735 static int rtc_open(struct inode *inode, struct file *file)
 736 {
 737         lock_kernel();
 738         spin_lock_irq(&rtc_lock);
 739
 740         if (rtc_status & RTC_IS_OPEN)
 741                 goto out_busy;
 742
 743         rtc_status |= RTC_IS_OPEN;
 744
 745         rtc_irq_data = 0;
 746         spin_unlock_irq(&rtc_lock);
 747         unlock_kernel();
 748         return 0;
 749
 750 out_busy:
 751         spin_unlock_irq(&rtc_lock);
 752         unlock_kernel();
 753         return -EBUSY;
 754 }
 755
 756 static int rtc_fasync(int fd, struct file *filp, int on)
 757 {
 758         return fasync_helper(fd, filp, on, &rtc_async_queue);
 759 }
 760
 761 static int rtc_release(struct inode *inode, struct file *file)
 762 {
 763 #ifdef RTC_IRQ
 764         unsigned char tmp;
 765
 766         if (rtc_has_irq == 0)
 767                 goto no_irq;
 768
 769         /*
 770          * Turn off all interrupts once the device is no longer
 771          * in use, and clear the data.
 772          */
 773
 774         spin_lock_irq(&rtc_lock);
 775         if (!hpet_mask_rtc_irq_bit(RTC_PIE | RTC_AIE | RTC_UIE)) {
 776                 tmp = CMOS_READ(RTC_CONTROL);
 777                 tmp &=  ~RTC_PIE;
 778                 tmp &=  ~RTC_AIE;
 779                 tmp &=  ~RTC_UIE;
 780                 CMOS_WRITE(tmp, RTC_CONTROL);
 781                 CMOS_READ(RTC_INTR_FLAGS);
 782         }
 783         if (rtc_status & RTC_TIMER_ON) {
 784                 rtc_status &= ~RTC_TIMER_ON;
 785                 del_timer(&rtc_irq_timer);
 786         }
 787         spin_unlock_irq(&rtc_lock);
 788
 789         if (file->f_flags & FASYNC)
 790                 rtc_fasync(-1, file, 0);
 791 no_irq:
 792 #endif
 793
 794         spin_lock_irq(&rtc_lock);
 795         rtc_irq_data = 0;
 796         rtc_status &= ~RTC_IS_OPEN;
 797         spin_unlock_irq(&rtc_lock);
 798
 799         return 0;
 800 }
 801
 802 #ifdef RTC_IRQ
 803 /* Called without the kernel lock - fine */
 804 static unsigned int rtc_poll(struct file *file, poll_table *wait)
 805 {
 806         unsigned long l;
 807
 808         if (rtc_has_irq == 0)
 809                 return 0;
 810
 811         poll_wait(file, &rtc_wait, wait);
 812
 813         spin_lock_irq(&rtc_lock);
 814         l = rtc_irq_data;
 815         spin_unlock_irq(&rtc_lock);
 816
 817         if (l != 0)
 818                 return POLLIN | POLLRDNORM;
 819         return 0;
 820 }
 821 #endif
 822
 823 int rtc_register(rtc_task_t *task)
 824 {
 825 #ifndef RTC_IRQ
 826         return -EIO;
 827 #else
 828         if (task == NULL || task->func == NULL)
 829                 return -EINVAL;
 830         spin_lock_irq(&rtc_lock);
 831         if (rtc_status & RTC_IS_OPEN) {
 832                 spin_unlock_irq(&rtc_lock);
 833                 return -EBUSY;
 834         }
 835         spin_lock(&rtc_task_lock);
 836         if (rtc_callback) {
 837                 spin_unlock(&rtc_task_lock);
 838                 spin_unlock_irq(&rtc_lock);
 839                 return -EBUSY;
 840         }
 841         rtc_status |= RTC_IS_OPEN;
 842         rtc_callback = task;
 843         spin_unlock(&rtc_task_lock);
 844         spin_unlock_irq(&rtc_lock);
 845         return 0;
 846 #endif
 847 }
 848 EXPORT_SYMBOL(rtc_register);
 849
 850 int rtc_unregister(rtc_task_t *task)
 851 {
 852 #ifndef RTC_IRQ
 853         return -EIO;
 854 #else
 855         unsigned char tmp;
 856
 857         spin_lock_irq(&rtc_lock);
 858         spin_lock(&rtc_task_lock);
 859         if (rtc_callback != task) {
 860                 spin_unlock(&rtc_task_lock);
 861                 spin_unlock_irq(&rtc_lock);
 862                 return -ENXIO;
 863         }
 864         rtc_callback = NULL;
 865
 866         /* disable controls */
 867         if (!hpet_mask_rtc_irq_bit(RTC_PIE | RTC_AIE | RTC_UIE)) {
 868                 tmp = CMOS_READ(RTC_CONTROL);
 869                 tmp &= ~RTC_PIE;
 870                 tmp &= ~RTC_AIE;
 871                 tmp &= ~RTC_UIE;
 872                 CMOS_WRITE(tmp, RTC_CONTROL);
 873                 CMOS_READ(RTC_INTR_FLAGS);
 874         }
 875         if (rtc_status & RTC_TIMER_ON) {
 876                 rtc_status &= ~RTC_TIMER_ON;
 877                 del_timer(&rtc_irq_timer);
 878         }
 879         rtc_status &= ~RTC_IS_OPEN;
 880         spin_unlock(&rtc_task_lock);
 881         spin_unlock_irq(&rtc_lock);
 882         return 0;
 883 #endif
 884 }
 885 EXPORT_SYMBOL(rtc_unregister);
 886
 887 int rtc_control(rtc_task_t *task, unsigned int cmd, unsigned long arg)
 888 {
 889 #ifndef RTC_IRQ
 890         return -EIO;
 891 #else
 892         unsigned long flags;
 893         if (cmd != RTC_PIE_ON && cmd != RTC_PIE_OFF && cmd != RTC_IRQP_SET)
 894                 return -EINVAL;
 895         spin_lock_irqsave(&rtc_task_lock, flags);
 896         if (rtc_callback != task) {
 897                 spin_unlock_irqrestore(&rtc_task_lock, flags);
 898                 return -ENXIO;
 899         }
 900         spin_unlock_irqrestore(&rtc_task_lock, flags);
 901         return rtc_do_ioctl(cmd, arg, 1);
 902 #endif
 903 }
 904 EXPORT_SYMBOL(rtc_control);
 905
 906 /*
 907  *      The various file operations we support.
 908  */
 909
 910 static const struct file_operations rtc_fops = {
 911         .owner          = THIS_MODULE,
 912         .llseek         = no_llseek,
 913         .read           = rtc_read,
 914 #ifdef RTC_IRQ
 915         .poll           = rtc_poll,
 916 #endif
 917         .ioctl          = rtc_ioctl,
 918         .open           = rtc_open,
 919         .release        = rtc_release,
 920         .fasync         = rtc_fasync,
 921 };
 922
 923 static struct miscdevice rtc_dev = {
 924         .minor          = RTC_MINOR,
 925         .name           = "rtc",
 926         .fops           = &rtc_fops,
 927 };
 928
 929 #ifdef CONFIG_PROC_FS
 930 static const struct file_operations rtc_proc_fops = {
 931         .owner          = THIS_MODULE,
 932         .open           = rtc_proc_open,
 933         .read           = seq_read,
 934         .llseek         = seq_lseek,
 935         .release        = single_release,
 936 };
 937 #endif
 938
 939 static resource_size_t rtc_size;
 940
 941 static struct resource * __init rtc_request_region(resource_size_t size)
 942 {
 943         struct resource *r;
 944
 945         if (RTC_IOMAPPED)
 946                 r = request_region(RTC_PORT(0), size, "rtc");
 947         else
 948                 r = request_mem_region(RTC_PORT(0), size, "rtc");
 949
 950         if (r)
 951                 rtc_size = size;
 952
 953         return r;
 954 }
 955
 956 static void rtc_release_region(void)
 957 {
 958         if (RTC_IOMAPPED)
 959                 release_region(RTC_PORT(0), rtc_size);
 960         else
 961                 release_mem_region(RTC_PORT(0), rtc_size);
 962 }
 963
 964 static int __init rtc_init(void)
 965 {
 966 #ifdef CONFIG_PROC_FS
 967         struct proc_dir_entry *ent;
 968 #endif
 969 #if defined(__alpha__) || defined(__mips__)
 970         unsigned int year, ctrl;
 971         char *guess = NULL;
 972 #endif
 973 #ifdef CONFIG_SPARC32
 974         struct linux_ebus *ebus;
 975         struct linux_ebus_device *edev;
 976 #else
 977         void *r;
 978 #ifdef RTC_IRQ
 979         irq_handler_t rtc_int_handler_ptr;
 980 #endif
 981 #endif
 982
 983 #ifdef CONFIG_SPARC32
 984         for_each_ebus(ebus) {
 985                 for_each_ebusdev(edev, ebus) {
 986                         if (strcmp(edev->prom_node->name, "rtc") == 0) {
 987                                 rtc_port = edev->resource[0].start;
 988                                 rtc_irq = edev->irqs[0];
 989                                 goto found;
 990                         }
 991                 }
 992         }
 993         rtc_has_irq = 0;
 994         printk(KERN_ERR "rtc_init: no PC rtc found\n");
 995         return -EIO;
 996
 997 found:
 998         if (rtc_irq == PCI_IRQ_NONE) {
 999                 rtc_has_irq = 0;
1000                 goto no_irq;
1001         }
1002
1003         /*
1004          * XXX Interrupt pin #7 in Espresso is shared between RTC and
1005          * PCI Slot 2 INTA# (and some INTx# in Slot 1).
1006          */
1007         if (request_irq(rtc_irq, rtc_interrupt, IRQF_SHARED, "rtc",
1008                         (void *)&rtc_port)) {
1009                 rtc_has_irq = 0;
1010                 printk(KERN_ERR "rtc: cannot register IRQ %d\n", rtc_irq);
1011                 return -EIO;
1012         }
1013 no_irq:
1014 #else
1015         r = rtc_request_region(RTC_IO_EXTENT);
1016
1017         /*
1018          * If we've already requested a smaller range (for example, because
1019          * PNPBIOS or ACPI told us how the device is configured), the request
1020          * above might fail because it's too big.
1021          *
1022          * If so, request just the range we actually use.
1023          */
1024         if (!r)
1025                 r = rtc_request_region(RTC_IO_EXTENT_USED);
1026         if (!r) {
1027 #ifdef RTC_IRQ
1028                 rtc_has_irq = 0;
1029 #endif
1030                 printk(KERN_ERR "rtc: I/O resource %lx is not free.\n",
1031                        (long)(RTC_PORT(0)));
1032                 return -EIO;
1033         }
1034
1035 #ifdef RTC_IRQ
1036         if (is_hpet_enabled()) {
1037                 int err;
1038
1039                 rtc_int_handler_ptr = hpet_rtc_interrupt;
1040                 err = hpet_register_irq_handler(rtc_interrupt);
1041                 if (err != 0) {
1042                         printk(KERN_WARNING "hpet_register_irq_handler failed "
1043                                         "in rtc_init().");
1044                         return err;
1045                 }
1046         } else {
1047                 rtc_int_handler_ptr = rtc_interrupt;
1048         }
1049
1050         if (request_irq(RTC_IRQ, rtc_int_handler_ptr, IRQF_DISABLED,
1051                         "rtc", NULL)) {
1052                 /* Yeah right, seeing as irq 8 doesn't even hit the bus. */
1053                 rtc_has_irq = 0;
1054                 printk(KERN_ERR "rtc: IRQ %d is not free.\n", RTC_IRQ);
1055                 rtc_release_region();
1056
1057                 return -EIO;
1058         }
1059         hpet_rtc_timer_init();
1060
1061 #endif
1062
1063 #endif /* CONFIG_SPARC32 vs. others */
1064
1065         if (misc_register(&rtc_dev)) {
1066 #ifdef RTC_IRQ
1067                 free_irq(RTC_IRQ, NULL);
1068                 hpet_unregister_irq_handler(rtc_interrupt);
1069                 rtc_has_irq = 0;
1070 #endif
1071                 rtc_release_region();
1072                 return -ENODEV;
1073         }
1074
1075 #ifdef CONFIG_PROC_FS
1076         ent = proc_create("driver/rtc", 0, NULL, &rtc_proc_fops);
1077         if (!ent)
1078                 printk(KERN_WARNING "rtc: Failed to register with procfs.\n");
1079 #endif
1080
1081 #if defined(__alpha__) || defined(__mips__)
1082         rtc_freq = HZ;
1083
1084         /* Each operating system on an Alpha uses its own epoch.
1085            Let's try to guess which one we are using now. */
1086
1087         if (rtc_is_updating() != 0)
1088                 msleep(20);
1089
1090         spin_lock_irq(&rtc_lock);
1091         year = CMOS_READ(RTC_YEAR);
1092         ctrl = CMOS_READ(RTC_CONTROL);
1093         spin_unlock_irq(&rtc_lock);
1094
1095         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
1096                 BCD_TO_BIN(year);       /* This should never happen... */
1097
1098         if (year < 20) {
1099                 epoch = 2000;
1100                 guess = "SRM (post-2000)";
1101         } else if (year >= 20 && year < 48) {
1102                 epoch = 1980;
1103                 guess = "ARC console";
1104         } else if (year >= 48 && year < 72) {
1105                 epoch = 1952;
1106                 guess = "Digital UNIX";
1107 #if defined(__mips__)
1108         } else if (year >= 72 && year < 74) {
1109                 epoch = 2000;
1110                 guess = "Digital DECstation";
1111 #else
1112         } else if (year >= 70) {
1113                 epoch = 1900;
1114                 guess = "Standard PC (1900)";
1115 #endif
1116         }
1117         if (guess)
1118                 printk(KERN_INFO "rtc: %s epoch (%lu) detected\n",
1119                         guess, epoch);
1120 #endif
1121 #ifdef RTC_IRQ
1122         if (rtc_has_irq == 0)
1123                 goto no_irq2;
1124
1125         spin_lock_irq(&rtc_lock);
1126         rtc_freq = 1024;
1127         if (!hpet_set_periodic_freq(rtc_freq)) {
1128                 /*
1129                  * Initialize periodic frequency to CMOS reset default,
1130                  * which is 1024Hz
1131                  */
1132                 CMOS_WRITE(((CMOS_READ(RTC_FREQ_SELECT) & 0xF0) | 0x06),
1133                            RTC_FREQ_SELECT);
1134         }
1135         spin_unlock_irq(&rtc_lock);
1136 no_irq2:
1137 #endif
1138
1139         (void) init_sysctl();
1140
1141         printk(KERN_INFO "Real Time Clock Driver v" RTC_VERSION "\n");
1142
1143         return 0;
1144 }
1145
1146 static void __exit rtc_exit(void)
1147 {
1148         cleanup_sysctl();
1149         remove_proc_entry("driver/rtc", NULL);
1150         misc_deregister(&rtc_dev);
1151
1152 #ifdef CONFIG_SPARC32
1153         if (rtc_has_irq)
1154                 free_irq(rtc_irq, &rtc_port);
1155 #else
1156         rtc_release_region();
1157 #ifdef RTC_IRQ
1158         if (rtc_has_irq) {
1159                 free_irq(RTC_IRQ, NULL);
1160                 hpet_unregister_irq_handler(hpet_rtc_interrupt);
1161         }
1162 #endif
1163 #endif /* CONFIG_SPARC32 */
1164 }
1165
1166 module_init(rtc_init);
1167 module_exit(rtc_exit);
1168
1169 #ifdef RTC_IRQ
1170 /*
1171  *      At IRQ rates >= 4096Hz, an interrupt may get lost altogether.
1172  *      (usually during an IDE disk interrupt, with IRQ unmasking off)
1173  *      Since the interrupt handler doesn't get called, the IRQ status
1174  *      byte doesn't get read, and the RTC stops generating interrupts.
1175  *      A timer is set, and will call this function if/when that happens.
1176  *      To get it out of this stalled state, we just read the status.
1177  *      At least a jiffy of interrupts (rtc_freq/HZ) will have been lost.
1178  *      (You *really* shouldn't be trying to use a non-realtime system
1179  *      for something that requires a steady > 1KHz signal anyways.)
1180  */
1181
1182 static void rtc_dropped_irq(unsigned long data)
1183 {
1184         unsigned long freq;
1185
1186         spin_lock_irq(&rtc_lock);
1187
1188         if (hpet_rtc_dropped_irq()) {
1189                 spin_unlock_irq(&rtc_lock);
1190                 return;
1191         }
1192
1193         /* Just in case someone disabled the timer from behind our back... */
1194         if (rtc_status & RTC_TIMER_ON)
1195                 mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq + 2*HZ/100);
1196
1197         rtc_irq_data += ((rtc_freq/HZ)<<8);
1198         rtc_irq_data &= ~0xff;
1199         rtc_irq_data |= (CMOS_READ(RTC_INTR_FLAGS) & 0xF0);     /* restart */
1200
1201         freq = rtc_freq;
1202
1203         spin_unlock_irq(&rtc_lock);
1204
1205         if (printk_ratelimit()) {
1206                 printk(KERN_WARNING "rtc: lost some interrupts at %ldHz.\n",
1207                         freq);
1208         }
1209
1210         /* Now we have new data */
1211         wake_up_interruptible(&rtc_wait);
1212
1213         kill_fasync(&rtc_async_queue, SIGIO, POLL_IN);
1214 }
1215 #endif
1216
1217 #ifdef CONFIG_PROC_FS
1218 /*
1219  *      Info exported via "/proc/driver/rtc".
1220  */
1221
1222 static int rtc_proc_show(struct seq_file *seq, void *v)
1223 {
1224 #define YN(bit) ((ctrl & bit) ? "yes" : "no")
1225 #define NY(bit) ((ctrl & bit) ? "no" : "yes")
1226         struct rtc_time tm;
1227         unsigned char batt, ctrl;
1228         unsigned long freq;
1229
1230         spin_lock_irq(&rtc_lock);
1231         batt = CMOS_READ(RTC_VALID) & RTC_VRT;
1232         ctrl = CMOS_READ(RTC_CONTROL);
1233         freq = rtc_freq;
1234         spin_unlock_irq(&rtc_lock);
1235
1236
1237         rtc_get_rtc_time(&tm);
1238
1239         /*
1240          * There is no way to tell if the luser has the RTC set for local
1241          * time or for Universal Standard Time (GMT). Probably local though.
1242          */
1243         seq_printf(seq,
1244                    "rtc_time\t: %02d:%02d:%02d\n"
1245                    "rtc_date\t: %04d-%02d-%02d\n"
1246                    "rtc_epoch\t: %04lu\n",
1247                    tm.tm_hour, tm.tm_min, tm.tm_sec,
1248                    tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, epoch);
1249
1250         get_rtc_alm_time(&tm);
1251
1252         /*
1253          * We implicitly assume 24hr mode here. Alarm values >= 0xc0 will
1254          * match any value for that particular field. Values that are
1255          * greater than a valid time, but less than 0xc0 shouldn't appear.
1256          */
1257         seq_puts(seq, "alarm\t\t: ");
1258         if (tm.tm_hour <= 24)
1259                 seq_printf(seq, "%02d:", tm.tm_hour);
1260         else
1261                 seq_puts(seq, "**:");
1262
1263         if (tm.tm_min <= 59)
1264                 seq_printf(seq, "%02d:", tm.tm_min);
1265         else
1266                 seq_puts(seq, "**:");
1267
1268         if (tm.tm_sec <= 59)
1269                 seq_printf(seq, "%02d\n", tm.tm_sec);
1270         else
1271                 seq_puts(seq, "**\n");
1272
1273         seq_printf(seq,
1274                    "DST_enable\t: %s\n"
1275                    "BCD\t\t: %s\n"
1276                    "24hr\t\t: %s\n"
1277                    "square_wave\t: %s\n"
1278                    "alarm_IRQ\t: %s\n"
1279                    "update_IRQ\t: %s\n"
1280                    "periodic_IRQ\t: %s\n"
1281                    "periodic_freq\t: %ld\n"
1282                    "batt_status\t: %s\n",
1283                    YN(RTC_DST_EN),
1284                    NY(RTC_DM_BINARY),
1285                    YN(RTC_24H),
1286                    YN(RTC_SQWE),
1287                    YN(RTC_AIE),
1288                    YN(RTC_UIE),
1289                    YN(RTC_PIE),
1290                    freq,
1291                    batt ? "okay" : "dead");
1292
1293         return  0;
1294 #undef YN
1295 #undef NY
1296 }
1297
1298 static int rtc_proc_open(struct inode *inode, struct file *file)
1299 {
1300         return single_open(file, rtc_proc_show, NULL);
1301 }
1302 #endif
1303
1304 void rtc_get_rtc_time(struct rtc_time *rtc_tm)
1305 {
1306         unsigned long uip_watchdog = jiffies, flags;
1307         unsigned char ctrl;
1308 #ifdef CONFIG_MACH_DECSTATION
1309         unsigned int real_year;
1310 #endif
1311
1312         /*
1313          * read RTC once any update in progress is done. The update
1314          * can take just over 2ms. We wait 20ms. There is no need to
1315          * to poll-wait (up to 1s - eeccch) for the falling edge of RTC_UIP.
1316          * If you need to know *exactly* when a second has started, enable
1317          * periodic update complete interrupts, (via ioctl) and then
1318          * immediately read /dev/rtc which will block until you get the IRQ.
1319          * Once the read clears, read the RTC time (again via ioctl). Easy.
1320          */
1321
1322         while (rtc_is_updating() != 0 &&
1323                time_before(jiffies, uip_watchdog + 2*HZ/100))
1324                 cpu_relax();
1325
1326         /*
1327          * Only the values that we read from the RTC are set. We leave
1328          * tm_wday, tm_yday and tm_isdst untouched. Note that while the
1329          * RTC has RTC_DAY_OF_WEEK, we should usually ignore it, as it is
1330          * only updated by the RTC when initially set to a non-zero value.
1331          */
1332         spin_lock_irqsave(&rtc_lock, flags);
1333         rtc_tm->tm_sec = CMOS_READ(RTC_SECONDS);
1334         rtc_tm->tm_min = CMOS_READ(RTC_MINUTES);
1335         rtc_tm->tm_hour = CMOS_READ(RTC_HOURS);
1336         rtc_tm->tm_mday = CMOS_READ(RTC_DAY_OF_MONTH);
1337         rtc_tm->tm_mon = CMOS_READ(RTC_MONTH);
1338         rtc_tm->tm_year = CMOS_READ(RTC_YEAR);
1339         /* Only set from 2.6.16 onwards */
1340         rtc_tm->tm_wday = CMOS_READ(RTC_DAY_OF_WEEK);
1341
1342 #ifdef CONFIG_MACH_DECSTATION
1343         real_year = CMOS_READ(RTC_DEC_YEAR);
1344 #endif
1345         ctrl = CMOS_READ(RTC_CONTROL);
1346         spin_unlock_irqrestore(&rtc_lock, flags);
1347
1348         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
1349                 BCD_TO_BIN(rtc_tm->tm_sec);
1350                 BCD_TO_BIN(rtc_tm->tm_min);
1351                 BCD_TO_BIN(rtc_tm->tm_hour);
1352                 BCD_TO_BIN(rtc_tm->tm_mday);
1353                 BCD_TO_BIN(rtc_tm->tm_mon);
1354                 BCD_TO_BIN(rtc_tm->tm_year);
1355                 BCD_TO_BIN(rtc_tm->tm_wday);
1356         }
1357
1358 #ifdef CONFIG_MACH_DECSTATION
1359         rtc_tm->tm_year += real_year - 72;
1360 #endif
1361
1362         /*
1363          * Account for differences between how the RTC uses the values
1364          * and how they are defined in a struct rtc_time;
1365          */
1366         rtc_tm->tm_year += epoch - 1900;
1367         if (rtc_tm->tm_year <= 69)
1368                 rtc_tm->tm_year += 100;
1369
1370         rtc_tm->tm_mon--;
1371 }
1372
1373 static void get_rtc_alm_time(struct rtc_time *alm_tm)
1374 {
1375         unsigned char ctrl;
1376
1377         /*
1378          * Only the values that we read from the RTC are set. That
1379          * means only tm_hour, tm_min, and tm_sec.
1380          */
1381         spin_lock_irq(&rtc_lock);
1382         alm_tm->tm_sec = CMOS_READ(RTC_SECONDS_ALARM);
1383         alm_tm->tm_min = CMOS_READ(RTC_MINUTES_ALARM);
1384         alm_tm->tm_hour = CMOS_READ(RTC_HOURS_ALARM);
1385         ctrl = CMOS_READ(RTC_CONTROL);
1386         spin_unlock_irq(&rtc_lock);
1387
1388         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
1389                 BCD_TO_BIN(alm_tm->tm_sec);
1390                 BCD_TO_BIN(alm_tm->tm_min);
1391                 BCD_TO_BIN(alm_tm->tm_hour);
1392         }
1393 }
1394
1395 #ifdef RTC_IRQ
1396 /*
1397  * Used to disable/enable interrupts for any one of UIE, AIE, PIE.
1398  * Rumour has it that if you frob the interrupt enable/disable
1399  * bits in RTC_CONTROL, you should read RTC_INTR_FLAGS, to
1400  * ensure you actually start getting interrupts. Probably for
1401  * compatibility with older/broken chipset RTC implementations.
1402  * We also clear out any old irq data after an ioctl() that
1403  * meddles with the interrupt enable/disable bits.
1404  */
1405
1406 static void mask_rtc_irq_bit_locked(unsigned char bit)
1407 {
1408         unsigned char val;
1409
1410         if (hpet_mask_rtc_irq_bit(bit))
1411                 return;
1412         val = CMOS_READ(RTC_CONTROL);
1413         val &=  ~bit;
1414         CMOS_WRITE(val, RTC_CONTROL);
1415         CMOS_READ(RTC_INTR_FLAGS);
1416
1417         rtc_irq_data = 0;
1418 }
1419
1420 static void set_rtc_irq_bit_locked(unsigned char bit)
1421 {
1422         unsigned char val;
1423
1424         if (hpet_set_rtc_irq_bit(bit))
1425                 return;
1426         val = CMOS_READ(RTC_CONTROL);
1427         val |= bit;
1428         CMOS_WRITE(val, RTC_CONTROL);
1429         CMOS_READ(RTC_INTR_FLAGS);
1430
1431         rtc_irq_data = 0;
1432 }
1433 #endif
1434
1435 MODULE_AUTHOR("Paul Gortmaker");
1436 MODULE_LICENSE("GPL");
1437 MODULE_ALIAS_MISCDEV(RTC_MINOR);