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                 rtc_freq = arg;
 683
 684                 spin_lock_irqsave(&rtc_lock, flags);
 685                 if (hpet_set_periodic_freq(arg)) {
 686                         spin_unlock_irqrestore(&rtc_lock, flags);
 687                         return 0;
 688                 }
 689
 690                 val = CMOS_READ(RTC_FREQ_SELECT) & 0xf0;
 691                 val |= (16 - tmp);
 692                 CMOS_WRITE(val, RTC_FREQ_SELECT);
 693                 spin_unlock_irqrestore(&rtc_lock, flags);
 694                 return 0;
 695         }
 696 #endif
 697         case RTC_EPOCH_READ:    /* Read the epoch.      */
 698         {
 699                 return put_user(epoch, (unsigned long __user *)arg);
 700         }
 701         case RTC_EPOCH_SET:     /* Set the epoch.       */
 702         {
 703                 /*
 704                  * There were no RTC clocks before 1900.
 705                  */
 706                 if (arg < 1900)
 707                         return -EINVAL;
 708
 709                 if (!capable(CAP_SYS_TIME))
 710                         return -EACCES;
 711
 712                 epoch = arg;
 713                 return 0;
 714         }
 715         default:
 716                 return -ENOTTY;
 717         }
 718         return copy_to_user((void __user *)arg,
 719                             &wtime, sizeof wtime) ? -EFAULT : 0;
 720 }
 721
 722 static int rtc_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
 723                      unsigned long arg)
 724 {
 725         return rtc_do_ioctl(cmd, arg, 0);
 726 }
 727
 728 /*
 729  *      We enforce only one user at a time here with the open/close.
 730  *      Also clear the previous interrupt data on an open, and clean
 731  *      up things on a close.
 732  */
 733
 734 /* We use rtc_lock to protect against concurrent opens. So the BKL is not
 735  * needed here. Or anywhere else in this driver. */
 736 static int rtc_open(struct inode *inode, struct file *file)
 737 {
 738         lock_kernel();
 739         spin_lock_irq(&rtc_lock);
 740
 741         if (rtc_status & RTC_IS_OPEN)
 742                 goto out_busy;
 743
 744         rtc_status |= RTC_IS_OPEN;
 745
 746         rtc_irq_data = 0;
 747         spin_unlock_irq(&rtc_lock);
 748         unlock_kernel();
 749         return 0;
 750
 751 out_busy:
 752         spin_unlock_irq(&rtc_lock);
 753         unlock_kernel();
 754         return -EBUSY;
 755 }
 756
 757 static int rtc_fasync(int fd, struct file *filp, int on)
 758 {
 759         return fasync_helper(fd, filp, on, &rtc_async_queue);
 760 }
 761
 762 static int rtc_release(struct inode *inode, struct file *file)
 763 {
 764 #ifdef RTC_IRQ
 765         unsigned char tmp;
 766
 767         if (rtc_has_irq == 0)
 768                 goto no_irq;
 769
 770         /*
 771          * Turn off all interrupts once the device is no longer
 772          * in use, and clear the data.
 773          */
 774
 775         spin_lock_irq(&rtc_lock);
 776         if (!hpet_mask_rtc_irq_bit(RTC_PIE | RTC_AIE | RTC_UIE)) {
 777                 tmp = CMOS_READ(RTC_CONTROL);
 778                 tmp &=  ~RTC_PIE;
 779                 tmp &=  ~RTC_AIE;
 780                 tmp &=  ~RTC_UIE;
 781                 CMOS_WRITE(tmp, RTC_CONTROL);
 782                 CMOS_READ(RTC_INTR_FLAGS);
 783         }
 784         if (rtc_status & RTC_TIMER_ON) {
 785                 rtc_status &= ~RTC_TIMER_ON;
 786                 del_timer(&rtc_irq_timer);
 787         }
 788         spin_unlock_irq(&rtc_lock);
 789
 790         if (file->f_flags & FASYNC)
 791                 rtc_fasync(-1, file, 0);
 792 no_irq:
 793 #endif
 794
 795         spin_lock_irq(&rtc_lock);
 796         rtc_irq_data = 0;
 797         rtc_status &= ~RTC_IS_OPEN;
 798         spin_unlock_irq(&rtc_lock);
 799
 800         return 0;
 801 }
 802
 803 #ifdef RTC_IRQ
 804 /* Called without the kernel lock - fine */
 805 static unsigned int rtc_poll(struct file *file, poll_table *wait)
 806 {
 807         unsigned long l;
 808
 809         if (rtc_has_irq == 0)
 810                 return 0;
 811
 812         poll_wait(file, &rtc_wait, wait);
 813
 814         spin_lock_irq(&rtc_lock);
 815         l = rtc_irq_data;
 816         spin_unlock_irq(&rtc_lock);
 817
 818         if (l != 0)
 819                 return POLLIN | POLLRDNORM;
 820         return 0;
 821 }
 822 #endif
 823
 824 int rtc_register(rtc_task_t *task)
 825 {
 826 #ifndef RTC_IRQ
 827         return -EIO;
 828 #else
 829         if (task == NULL || task->func == NULL)
 830                 return -EINVAL;
 831         spin_lock_irq(&rtc_lock);
 832         if (rtc_status & RTC_IS_OPEN) {
 833                 spin_unlock_irq(&rtc_lock);
 834                 return -EBUSY;
 835         }
 836         spin_lock(&rtc_task_lock);
 837         if (rtc_callback) {
 838                 spin_unlock(&rtc_task_lock);
 839                 spin_unlock_irq(&rtc_lock);
 840                 return -EBUSY;
 841         }
 842         rtc_status |= RTC_IS_OPEN;
 843         rtc_callback = task;
 844         spin_unlock(&rtc_task_lock);
 845         spin_unlock_irq(&rtc_lock);
 846         return 0;
 847 #endif
 848 }
 849 EXPORT_SYMBOL(rtc_register);
 850
 851 int rtc_unregister(rtc_task_t *task)
 852 {
 853 #ifndef RTC_IRQ
 854         return -EIO;
 855 #else
 856         unsigned char tmp;
 857
 858         spin_lock_irq(&rtc_lock);
 859         spin_lock(&rtc_task_lock);
 860         if (rtc_callback != task) {
 861                 spin_unlock(&rtc_task_lock);
 862                 spin_unlock_irq(&rtc_lock);
 863                 return -ENXIO;
 864         }
 865         rtc_callback = NULL;
 866
 867         /* disable controls */
 868         if (!hpet_mask_rtc_irq_bit(RTC_PIE | RTC_AIE | RTC_UIE)) {
 869                 tmp = CMOS_READ(RTC_CONTROL);
 870                 tmp &= ~RTC_PIE;
 871                 tmp &= ~RTC_AIE;
 872                 tmp &= ~RTC_UIE;
 873                 CMOS_WRITE(tmp, RTC_CONTROL);
 874                 CMOS_READ(RTC_INTR_FLAGS);
 875         }
 876         if (rtc_status & RTC_TIMER_ON) {
 877                 rtc_status &= ~RTC_TIMER_ON;
 878                 del_timer(&rtc_irq_timer);
 879         }
 880         rtc_status &= ~RTC_IS_OPEN;
 881         spin_unlock(&rtc_task_lock);
 882         spin_unlock_irq(&rtc_lock);
 883         return 0;
 884 #endif
 885 }
 886 EXPORT_SYMBOL(rtc_unregister);
 887
 888 int rtc_control(rtc_task_t *task, unsigned int cmd, unsigned long arg)
 889 {
 890 #ifndef RTC_IRQ
 891         return -EIO;
 892 #else
 893         unsigned long flags;
 894         if (cmd != RTC_PIE_ON && cmd != RTC_PIE_OFF && cmd != RTC_IRQP_SET)
 895                 return -EINVAL;
 896         spin_lock_irqsave(&rtc_task_lock, flags);
 897         if (rtc_callback != task) {
 898                 spin_unlock_irqrestore(&rtc_task_lock, flags);
 899                 return -ENXIO;
 900         }
 901         spin_unlock_irqrestore(&rtc_task_lock, flags);
 902         return rtc_do_ioctl(cmd, arg, 1);
 903 #endif
 904 }
 905 EXPORT_SYMBOL(rtc_control);
 906
 907 /*
 908  *      The various file operations we support.
 909  */
 910
 911 static const struct file_operations rtc_fops = {
 912         .owner          = THIS_MODULE,
 913         .llseek         = no_llseek,
 914         .read           = rtc_read,
 915 #ifdef RTC_IRQ
 916         .poll           = rtc_poll,
 917 #endif
 918         .ioctl          = rtc_ioctl,
 919         .open           = rtc_open,
 920         .release        = rtc_release,
 921         .fasync         = rtc_fasync,
 922 };
 923
 924 static struct miscdevice rtc_dev = {
 925         .minor          = RTC_MINOR,
 926         .name           = "rtc",
 927         .fops           = &rtc_fops,
 928 };
 929
 930 #ifdef CONFIG_PROC_FS
 931 static const struct file_operations rtc_proc_fops = {
 932         .owner          = THIS_MODULE,
 933         .open           = rtc_proc_open,
 934         .read           = seq_read,
 935         .llseek         = seq_lseek,
 936         .release        = single_release,
 937 };
 938 #endif
 939
 940 static resource_size_t rtc_size;
 941
 942 static struct resource * __init rtc_request_region(resource_size_t size)
 943 {
 944         struct resource *r;
 945
 946         if (RTC_IOMAPPED)
 947                 r = request_region(RTC_PORT(0), size, "rtc");
 948         else
 949                 r = request_mem_region(RTC_PORT(0), size, "rtc");
 950
 951         if (r)
 952                 rtc_size = size;
 953
 954         return r;
 955 }
 956
 957 static void rtc_release_region(void)
 958 {
 959         if (RTC_IOMAPPED)
 960                 release_region(RTC_PORT(0), rtc_size);
 961         else
 962                 release_mem_region(RTC_PORT(0), rtc_size);
 963 }
 964
 965 static int __init rtc_init(void)
 966 {
 967 #ifdef CONFIG_PROC_FS
 968         struct proc_dir_entry *ent;
 969 #endif
 970 #if defined(__alpha__) || defined(__mips__)
 971         unsigned int year, ctrl;
 972         char *guess = NULL;
 973 #endif
 974 #ifdef CONFIG_SPARC32
 975         struct linux_ebus *ebus;
 976         struct linux_ebus_device *edev;
 977 #else
 978         void *r;
 979 #ifdef RTC_IRQ
 980         irq_handler_t rtc_int_handler_ptr;
 981 #endif
 982 #endif
 983
 984 #ifdef CONFIG_SPARC32
 985         for_each_ebus(ebus) {
 986                 for_each_ebusdev(edev, ebus) {
 987                         if (strcmp(edev->prom_node->name, "rtc") == 0) {
 988                                 rtc_port = edev->resource[0].start;
 989                                 rtc_irq = edev->irqs[0];
 990                                 goto found;
 991                         }
 992                 }
 993         }
 994         rtc_has_irq = 0;
 995         printk(KERN_ERR "rtc_init: no PC rtc found\n");
 996         return -EIO;
 997
 998 found:
 999         if (rtc_irq == PCI_IRQ_NONE) {
1000                 rtc_has_irq = 0;
1001                 goto no_irq;
1002         }
1003
1004         /*
1005          * XXX Interrupt pin #7 in Espresso is shared between RTC and
1006          * PCI Slot 2 INTA# (and some INTx# in Slot 1).
1007          */
1008         if (request_irq(rtc_irq, rtc_interrupt, IRQF_SHARED, "rtc",
1009                         (void *)&rtc_port)) {
1010                 rtc_has_irq = 0;
1011                 printk(KERN_ERR "rtc: cannot register IRQ %d\n", rtc_irq);
1012                 return -EIO;
1013         }
1014 no_irq:
1015 #else
1016         r = rtc_request_region(RTC_IO_EXTENT);
1017
1018         /*
1019          * If we've already requested a smaller range (for example, because
1020          * PNPBIOS or ACPI told us how the device is configured), the request
1021          * above might fail because it's too big.
1022          *
1023          * If so, request just the range we actually use.
1024          */
1025         if (!r)
1026                 r = rtc_request_region(RTC_IO_EXTENT_USED);
1027         if (!r) {
1028 #ifdef RTC_IRQ
1029                 rtc_has_irq = 0;
1030 #endif
1031                 printk(KERN_ERR "rtc: I/O resource %lx is not free.\n",
1032                        (long)(RTC_PORT(0)));
1033                 return -EIO;
1034         }
1035
1036 #ifdef RTC_IRQ
1037         if (is_hpet_enabled()) {
1038                 int err;
1039
1040                 rtc_int_handler_ptr = hpet_rtc_interrupt;
1041                 err = hpet_register_irq_handler(rtc_interrupt);
1042                 if (err != 0) {
1043                         printk(KERN_WARNING "hpet_register_irq_handler failed "
1044                                         "in rtc_init().");
1045                         return err;
1046                 }
1047         } else {
1048                 rtc_int_handler_ptr = rtc_interrupt;
1049         }
1050
1051         if (request_irq(RTC_IRQ, rtc_int_handler_ptr, IRQF_DISABLED,
1052                         "rtc", NULL)) {
1053                 /* Yeah right, seeing as irq 8 doesn't even hit the bus. */
1054                 rtc_has_irq = 0;
1055                 printk(KERN_ERR "rtc: IRQ %d is not free.\n", RTC_IRQ);
1056                 rtc_release_region();
1057
1058                 return -EIO;
1059         }
1060         hpet_rtc_timer_init();
1061
1062 #endif
1063
1064 #endif /* CONFIG_SPARC32 vs. others */
1065
1066         if (misc_register(&rtc_dev)) {
1067 #ifdef RTC_IRQ
1068                 free_irq(RTC_IRQ, NULL);
1069                 hpet_unregister_irq_handler(rtc_interrupt);
1070                 rtc_has_irq = 0;
1071 #endif
1072                 rtc_release_region();
1073                 return -ENODEV;
1074         }
1075
1076 #ifdef CONFIG_PROC_FS
1077         ent = proc_create("driver/rtc", 0, NULL, &rtc_proc_fops);
1078         if (!ent)
1079                 printk(KERN_WARNING "rtc: Failed to register with procfs.\n");
1080 #endif
1081
1082 #if defined(__alpha__) || defined(__mips__)
1083         rtc_freq = HZ;
1084
1085         /* Each operating system on an Alpha uses its own epoch.
1086            Let's try to guess which one we are using now. */
1087
1088         if (rtc_is_updating() != 0)
1089                 msleep(20);
1090
1091         spin_lock_irq(&rtc_lock);
1092         year = CMOS_READ(RTC_YEAR);
1093         ctrl = CMOS_READ(RTC_CONTROL);
1094         spin_unlock_irq(&rtc_lock);
1095
1096         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
1097                 BCD_TO_BIN(year);       /* This should never happen... */
1098
1099         if (year < 20) {
1100                 epoch = 2000;
1101                 guess = "SRM (post-2000)";
1102         } else if (year >= 20 && year < 48) {
1103                 epoch = 1980;
1104                 guess = "ARC console";
1105         } else if (year >= 48 && year < 72) {
1106                 epoch = 1952;
1107                 guess = "Digital UNIX";
1108 #if defined(__mips__)
1109         } else if (year >= 72 && year < 74) {
1110                 epoch = 2000;
1111                 guess = "Digital DECstation";
1112 #else
1113         } else if (year >= 70) {
1114                 epoch = 1900;
1115                 guess = "Standard PC (1900)";
1116 #endif
1117         }
1118         if (guess)
1119                 printk(KERN_INFO "rtc: %s epoch (%lu) detected\n",
1120                         guess, epoch);
1121 #endif
1122 #ifdef RTC_IRQ
1123         if (rtc_has_irq == 0)
1124                 goto no_irq2;
1125
1126         spin_lock_irq(&rtc_lock);
1127         rtc_freq = 1024;
1128         if (!hpet_set_periodic_freq(rtc_freq)) {
1129                 /*
1130                  * Initialize periodic frequency to CMOS reset default,
1131                  * which is 1024Hz
1132                  */
1133                 CMOS_WRITE(((CMOS_READ(RTC_FREQ_SELECT) & 0xF0) | 0x06),
1134                            RTC_FREQ_SELECT);
1135         }
1136         spin_unlock_irq(&rtc_lock);
1137 no_irq2:
1138 #endif
1139
1140         (void) init_sysctl();
1141
1142         printk(KERN_INFO "Real Time Clock Driver v" RTC_VERSION "\n");
1143
1144         return 0;
1145 }
1146
1147 static void __exit rtc_exit(void)
1148 {
1149         cleanup_sysctl();
1150         remove_proc_entry("driver/rtc", NULL);
1151         misc_deregister(&rtc_dev);
1152
1153 #ifdef CONFIG_SPARC32
1154         if (rtc_has_irq)
1155                 free_irq(rtc_irq, &rtc_port);
1156 #else
1157         rtc_release_region();
1158 #ifdef RTC_IRQ
1159         if (rtc_has_irq) {
1160                 free_irq(RTC_IRQ, NULL);
1161                 hpet_unregister_irq_handler(hpet_rtc_interrupt);
1162         }
1163 #endif
1164 #endif /* CONFIG_SPARC32 */
1165 }
1166
1167 module_init(rtc_init);
1168 module_exit(rtc_exit);
1169
1170 #ifdef RTC_IRQ
1171 /*
1172  *      At IRQ rates >= 4096Hz, an interrupt may get lost altogether.
1173  *      (usually during an IDE disk interrupt, with IRQ unmasking off)
1174  *      Since the interrupt handler doesn't get called, the IRQ status
1175  *      byte doesn't get read, and the RTC stops generating interrupts.
1176  *      A timer is set, and will call this function if/when that happens.
1177  *      To get it out of this stalled state, we just read the status.
1178  *      At least a jiffy of interrupts (rtc_freq/HZ) will have been lost.
1179  *      (You *really* shouldn't be trying to use a non-realtime system
1180  *      for something that requires a steady > 1KHz signal anyways.)
1181  */
1182
1183 static void rtc_dropped_irq(unsigned long data)
1184 {
1185         unsigned long freq;
1186
1187         spin_lock_irq(&rtc_lock);
1188
1189         if (hpet_rtc_dropped_irq()) {
1190                 spin_unlock_irq(&rtc_lock);
1191                 return;
1192         }
1193
1194         /* Just in case someone disabled the timer from behind our back... */
1195         if (rtc_status & RTC_TIMER_ON)
1196                 mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq + 2*HZ/100);
1197
1198         rtc_irq_data += ((rtc_freq/HZ)<<8);
1199         rtc_irq_data &= ~0xff;
1200         rtc_irq_data |= (CMOS_READ(RTC_INTR_FLAGS) & 0xF0);     /* restart */
1201
1202         freq = rtc_freq;
1203
1204         spin_unlock_irq(&rtc_lock);
1205
1206         if (printk_ratelimit()) {
1207                 printk(KERN_WARNING "rtc: lost some interrupts at %ldHz.\n",
1208                         freq);
1209         }
1210
1211         /* Now we have new data */
1212         wake_up_interruptible(&rtc_wait);
1213
1214         kill_fasync(&rtc_async_queue, SIGIO, POLL_IN);
1215 }
1216 #endif
1217
1218 #ifdef CONFIG_PROC_FS
1219 /*
1220  *      Info exported via "/proc/driver/rtc".
1221  */
1222
1223 static int rtc_proc_show(struct seq_file *seq, void *v)
1224 {
1225 #define YN(bit) ((ctrl & bit) ? "yes" : "no")
1226 #define NY(bit) ((ctrl & bit) ? "no" : "yes")
1227         struct rtc_time tm;
1228         unsigned char batt, ctrl;
1229         unsigned long freq;
1230
1231         spin_lock_irq(&rtc_lock);
1232         batt = CMOS_READ(RTC_VALID) & RTC_VRT;
1233         ctrl = CMOS_READ(RTC_CONTROL);
1234         freq = rtc_freq;
1235         spin_unlock_irq(&rtc_lock);
1236
1237
1238         rtc_get_rtc_time(&tm);
1239
1240         /*
1241          * There is no way to tell if the luser has the RTC set for local
1242          * time or for Universal Standard Time (GMT). Probably local though.
1243          */
1244         seq_printf(seq,
1245                    "rtc_time\t: %02d:%02d:%02d\n"
1246                    "rtc_date\t: %04d-%02d-%02d\n"
1247                    "rtc_epoch\t: %04lu\n",
1248                    tm.tm_hour, tm.tm_min, tm.tm_sec,
1249                    tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, epoch);
1250
1251         get_rtc_alm_time(&tm);
1252
1253         /*
1254          * We implicitly assume 24hr mode here. Alarm values >= 0xc0 will
1255          * match any value for that particular field. Values that are
1256          * greater than a valid time, but less than 0xc0 shouldn't appear.
1257          */
1258         seq_puts(seq, "alarm\t\t: ");
1259         if (tm.tm_hour <= 24)
1260                 seq_printf(seq, "%02d:", tm.tm_hour);
1261         else
1262                 seq_puts(seq, "**:");
1263
1264         if (tm.tm_min <= 59)
1265                 seq_printf(seq, "%02d:", tm.tm_min);
1266         else
1267                 seq_puts(seq, "**:");
1268
1269         if (tm.tm_sec <= 59)
1270                 seq_printf(seq, "%02d\n", tm.tm_sec);
1271         else
1272                 seq_puts(seq, "**\n");
1273
1274         seq_printf(seq,
1275                    "DST_enable\t: %s\n"
1276                    "BCD\t\t: %s\n"
1277                    "24hr\t\t: %s\n"
1278                    "square_wave\t: %s\n"
1279                    "alarm_IRQ\t: %s\n"
1280                    "update_IRQ\t: %s\n"
1281                    "periodic_IRQ\t: %s\n"
1282                    "periodic_freq\t: %ld\n"
1283                    "batt_status\t: %s\n",
1284                    YN(RTC_DST_EN),
1285                    NY(RTC_DM_BINARY),
1286                    YN(RTC_24H),
1287                    YN(RTC_SQWE),
1288                    YN(RTC_AIE),
1289                    YN(RTC_UIE),
1290                    YN(RTC_PIE),
1291                    freq,
1292                    batt ? "okay" : "dead");
1293
1294         return  0;
1295 #undef YN
1296 #undef NY
1297 }
1298
1299 static int rtc_proc_open(struct inode *inode, struct file *file)
1300 {
1301         return single_open(file, rtc_proc_show, NULL);
1302 }
1303 #endif
1304
1305 void rtc_get_rtc_time(struct rtc_time *rtc_tm)
1306 {
1307         unsigned long uip_watchdog = jiffies, flags;
1308         unsigned char ctrl;
1309 #ifdef CONFIG_MACH_DECSTATION
1310         unsigned int real_year;
1311 #endif
1312
1313         /*
1314          * read RTC once any update in progress is done. The update
1315          * can take just over 2ms. We wait 20ms. There is no need to
1316          * to poll-wait (up to 1s - eeccch) for the falling edge of RTC_UIP.
1317          * If you need to know *exactly* when a second has started, enable
1318          * periodic update complete interrupts, (via ioctl) and then
1319          * immediately read /dev/rtc which will block until you get the IRQ.
1320          * Once the read clears, read the RTC time (again via ioctl). Easy.
1321          */
1322
1323         while (rtc_is_updating() != 0 &&
1324                time_before(jiffies, uip_watchdog + 2*HZ/100))
1325                 cpu_relax();
1326
1327         /*
1328          * Only the values that we read from the RTC are set. We leave
1329          * tm_wday, tm_yday and tm_isdst untouched. Note that while the
1330          * RTC has RTC_DAY_OF_WEEK, we should usually ignore it, as it is
1331          * only updated by the RTC when initially set to a non-zero value.
1332          */
1333         spin_lock_irqsave(&rtc_lock, flags);
1334         rtc_tm->tm_sec = CMOS_READ(RTC_SECONDS);
1335         rtc_tm->tm_min = CMOS_READ(RTC_MINUTES);
1336         rtc_tm->tm_hour = CMOS_READ(RTC_HOURS);
1337         rtc_tm->tm_mday = CMOS_READ(RTC_DAY_OF_MONTH);
1338         rtc_tm->tm_mon = CMOS_READ(RTC_MONTH);
1339         rtc_tm->tm_year = CMOS_READ(RTC_YEAR);
1340         /* Only set from 2.6.16 onwards */
1341         rtc_tm->tm_wday = CMOS_READ(RTC_DAY_OF_WEEK);
1342
1343 #ifdef CONFIG_MACH_DECSTATION
1344         real_year = CMOS_READ(RTC_DEC_YEAR);
1345 #endif
1346         ctrl = CMOS_READ(RTC_CONTROL);
1347         spin_unlock_irqrestore(&rtc_lock, flags);
1348
1349         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
1350                 BCD_TO_BIN(rtc_tm->tm_sec);
1351                 BCD_TO_BIN(rtc_tm->tm_min);
1352                 BCD_TO_BIN(rtc_tm->tm_hour);
1353                 BCD_TO_BIN(rtc_tm->tm_mday);
1354                 BCD_TO_BIN(rtc_tm->tm_mon);
1355                 BCD_TO_BIN(rtc_tm->tm_year);
1356                 BCD_TO_BIN(rtc_tm->tm_wday);
1357         }
1358
1359 #ifdef CONFIG_MACH_DECSTATION
1360         rtc_tm->tm_year += real_year - 72;
1361 #endif
1362
1363         /*
1364          * Account for differences between how the RTC uses the values
1365          * and how they are defined in a struct rtc_time;
1366          */
1367         rtc_tm->tm_year += epoch - 1900;
1368         if (rtc_tm->tm_year <= 69)
1369                 rtc_tm->tm_year += 100;
1370
1371         rtc_tm->tm_mon--;
1372 }
1373
1374 static void get_rtc_alm_time(struct rtc_time *alm_tm)
1375 {
1376         unsigned char ctrl;
1377
1378         /*
1379          * Only the values that we read from the RTC are set. That
1380          * means only tm_hour, tm_min, and tm_sec.
1381          */
1382         spin_lock_irq(&rtc_lock);
1383         alm_tm->tm_sec = CMOS_READ(RTC_SECONDS_ALARM);
1384         alm_tm->tm_min = CMOS_READ(RTC_MINUTES_ALARM);
1385         alm_tm->tm_hour = CMOS_READ(RTC_HOURS_ALARM);
1386         ctrl = CMOS_READ(RTC_CONTROL);
1387         spin_unlock_irq(&rtc_lock);
1388
1389         if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
1390                 BCD_TO_BIN(alm_tm->tm_sec);
1391                 BCD_TO_BIN(alm_tm->tm_min);
1392                 BCD_TO_BIN(alm_tm->tm_hour);
1393         }
1394 }
1395
1396 #ifdef RTC_IRQ
1397 /*
1398  * Used to disable/enable interrupts for any one of UIE, AIE, PIE.
1399  * Rumour has it that if you frob the interrupt enable/disable
1400  * bits in RTC_CONTROL, you should read RTC_INTR_FLAGS, to
1401  * ensure you actually start getting interrupts. Probably for
1402  * compatibility with older/broken chipset RTC implementations.
1403  * We also clear out any old irq data after an ioctl() that
1404  * meddles with the interrupt enable/disable bits.
1405  */
1406
1407 static void mask_rtc_irq_bit_locked(unsigned char bit)
1408 {
1409         unsigned char val;
1410
1411         if (hpet_mask_rtc_irq_bit(bit))
1412                 return;
1413         val = CMOS_READ(RTC_CONTROL);
1414         val &=  ~bit;
1415         CMOS_WRITE(val, RTC_CONTROL);
1416         CMOS_READ(RTC_INTR_FLAGS);
1417
1418         rtc_irq_data = 0;
1419 }
1420
1421 static void set_rtc_irq_bit_locked(unsigned char bit)
1422 {
1423         unsigned char val;
1424
1425         if (hpet_set_rtc_irq_bit(bit))
1426                 return;
1427         val = CMOS_READ(RTC_CONTROL);
1428         val |= bit;
1429         CMOS_WRITE(val, RTC_CONTROL);
1430         CMOS_READ(RTC_INTR_FLAGS);
1431
1432         rtc_irq_data = 0;
1433 }
1434 #endif
1435
1436 MODULE_AUTHOR("Paul Gortmaker");
1437 MODULE_LICENSE("GPL");
1438 MODULE_ALIAS_MISCDEV(RTC_MINOR);