rtc.c
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:27k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  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.  */
  45. #define RTC_VERSION "1.10e"
  46. #define RTC_IO_EXTENT 0x10 /* Only really two ports, but... */
  47. /*
  48.  * Note that *all* calls to CMOS_READ and CMOS_WRITE are done with
  49.  * interrupts disabled. Due to the index-port/data-port (0x70/0x71)
  50.  * design of the RTC, we don't want two different things trying to
  51.  * get to it at once. (e.g. the periodic 11 min sync from time.c vs.
  52.  * this driver.)
  53.  */
  54. #include <linux/config.h>
  55. #include <linux/module.h>
  56. #include <linux/kernel.h>
  57. #include <linux/types.h>
  58. #include <linux/miscdevice.h>
  59. #include <linux/ioport.h>
  60. #include <linux/fcntl.h>
  61. #include <linux/mc146818rtc.h>
  62. #include <linux/init.h>
  63. #include <linux/poll.h>
  64. #include <linux/proc_fs.h>
  65. #include <linux/spinlock.h>
  66. #include <linux/sysctl.h>
  67. #include <asm/io.h>
  68. #include <asm/uaccess.h>
  69. #include <asm/system.h>
  70. #ifdef __sparc__
  71. #include <asm/ebus.h>
  72. #ifdef __sparc_v9__
  73. #include <asm/isa.h>
  74. #endif
  75. static unsigned long rtc_port;
  76. static int rtc_irq = PCI_IRQ_NONE;
  77. #endif
  78. static int rtc_has_irq = 1;
  79. /*
  80.  * We sponge a minor off of the misc major. No need slurping
  81.  * up another valuable major dev number for this. If you add
  82.  * an ioctl, make sure you don't conflict with SPARC's RTC
  83.  * ioctls.
  84.  */
  85. static struct fasync_struct *rtc_async_queue;
  86. static DECLARE_WAIT_QUEUE_HEAD(rtc_wait);
  87. static struct timer_list rtc_irq_timer;
  88. static ssize_t rtc_read(struct file *file, char *buf,
  89. size_t count, loff_t *ppos);
  90. static int rtc_ioctl(struct inode *inode, struct file *file,
  91.      unsigned int cmd, unsigned long arg);
  92. #if RTC_IRQ
  93. static unsigned int rtc_poll(struct file *file, poll_table *wait);
  94. #endif
  95. static void get_rtc_time (struct rtc_time *rtc_tm);
  96. static void get_rtc_alm_time (struct rtc_time *alm_tm);
  97. #if RTC_IRQ
  98. static void rtc_dropped_irq(unsigned long data);
  99. static void set_rtc_irq_bit(unsigned char bit);
  100. static void mask_rtc_irq_bit(unsigned char bit);
  101. #endif
  102. static inline unsigned char rtc_is_updating(void);
  103. static int rtc_read_proc(char *page, char **start, off_t off,
  104.                          int count, int *eof, void *data);
  105. /*
  106.  * Bits in rtc_status. (6 bits of room for future expansion)
  107.  */
  108. #define RTC_IS_OPEN 0x01 /* means /dev/rtc is in use */
  109. #define RTC_TIMER_ON 0x02 /* missed irq timer active */
  110. /*
  111.  * rtc_status is never changed by rtc_interrupt, and ioctl/open/close is
  112.  * protected by the big kernel lock. However, ioctl can still disable the timer
  113.  * in rtc_status and then with del_timer after the interrupt has read
  114.  * rtc_status but before mod_timer is called, which would then reenable the
  115.  * timer (but you would need to have an awful timing before you'd trip on it)
  116.  */
  117. static unsigned long rtc_status = 0; /* bitmapped status byte. */
  118. static unsigned long rtc_freq = 0; /* Current periodic IRQ rate */
  119. static unsigned long rtc_irq_data = 0; /* our output to the world */
  120. static unsigned long rtc_max_user_freq = 64; /* > this, need CAP_SYS_RESOURCE */
  121. /*
  122.  * If this driver ever becomes modularised, it will be really nice
  123.  * to make the epoch retain its value across module reload...
  124.  */
  125. static unsigned long epoch = 1900; /* year corresponding to 0x00 */
  126. static const unsigned char days_in_mo[] = 
  127. {0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
  128. #if RTC_IRQ
  129. /*
  130.  * A very tiny interrupt handler. It runs with SA_INTERRUPT set,
  131.  * but there is possibility of conflicting with the set_rtc_mmss()
  132.  * call (the rtc irq and the timer irq can easily run at the same
  133.  * time in two different CPUs). So we need to serializes
  134.  * accesses to the chip with the rtc_lock spinlock that each
  135.  * architecture should implement in the timer code.
  136.  * (See ./arch/XXXX/kernel/time.c for the set_rtc_mmss() function.)
  137.  */
  138. static void rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs)
  139. {
  140. /*
  141.  * Can be an alarm interrupt, update complete interrupt,
  142.  * or a periodic interrupt. We store the status in the
  143.  * low byte and the number of interrupts received since
  144.  * the last read in the remainder of rtc_irq_data.
  145.  */
  146. spin_lock (&rtc_lock);
  147. rtc_irq_data += 0x100;
  148. rtc_irq_data &= ~0xff;
  149. rtc_irq_data |= (CMOS_READ(RTC_INTR_FLAGS) & 0xF0);
  150. if (rtc_status & RTC_TIMER_ON)
  151. mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq + 2*HZ/100);
  152. spin_unlock (&rtc_lock);
  153. /* Now do the rest of the actions */
  154. wake_up_interruptible(&rtc_wait);
  155. kill_fasync (&rtc_async_queue, SIGIO, POLL_IN);
  156. }
  157. #endif
  158. /*
  159.  * sysctl-tuning infrastructure.
  160.  */
  161. static ctl_table rtc_table[] = {
  162.     { 1, "max-user-freq", &rtc_max_user_freq, sizeof(int), 0644, NULL,
  163.       &proc_dointvec, NULL, },
  164.     { 0, }
  165. };
  166. static ctl_table rtc_root[] = {
  167.     { 1, "rtc", NULL, 0, 0555, rtc_table, },
  168.     { 0, }
  169. };
  170. static ctl_table dev_root[] = {
  171.     { CTL_DEV, "dev", NULL, 0, 0555, rtc_root, },
  172.     { 0, }
  173. };
  174. static struct ctl_table_header *sysctl_header;
  175. static int __init init_sysctl(void)
  176. {
  177.     sysctl_header = register_sysctl_table(dev_root, 0);
  178.     return 0;
  179. }
  180. static void __exit cleanup_sysctl(void)
  181. {
  182.     unregister_sysctl_table(sysctl_header);
  183. }
  184. /*
  185.  * Now all the various file operations that we export.
  186.  */
  187. static ssize_t rtc_read(struct file *file, char *buf,
  188. size_t count, loff_t *ppos)
  189. {
  190. #if !RTC_IRQ
  191. return -EIO;
  192. #else
  193. DECLARE_WAITQUEUE(wait, current);
  194. unsigned long data;
  195. ssize_t retval;
  196. if (rtc_has_irq == 0)
  197. return -EIO;
  198. if (count < sizeof(unsigned long))
  199. return -EINVAL;
  200. add_wait_queue(&rtc_wait, &wait);
  201. current->state = TASK_INTERRUPTIBLE;
  202. do {
  203. /* First make it right. Then make it fast. Putting this whole
  204.  * block within the parentheses of a while would be too
  205.  * confusing. And no, xchg() is not the answer. */
  206. spin_lock_irq (&rtc_lock);
  207. data = rtc_irq_data;
  208. rtc_irq_data = 0;
  209. spin_unlock_irq (&rtc_lock);
  210. if (data != 0)
  211. break;
  212. if (file->f_flags & O_NONBLOCK) {
  213. retval = -EAGAIN;
  214. goto out;
  215. }
  216. if (signal_pending(current)) {
  217. retval = -ERESTARTSYS;
  218. goto out;
  219. }
  220. schedule();
  221. } while (1);
  222. retval = put_user(data, (unsigned long *)buf); 
  223. if (!retval)
  224. retval = sizeof(unsigned long); 
  225.  out:
  226. current->state = TASK_RUNNING;
  227. remove_wait_queue(&rtc_wait, &wait);
  228. return retval;
  229. #endif
  230. }
  231. static int rtc_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
  232.      unsigned long arg)
  233. {
  234. struct rtc_time wtime; 
  235. #if RTC_IRQ
  236. if (rtc_has_irq == 0) {
  237. switch (cmd) {
  238. case RTC_AIE_OFF:
  239. case RTC_AIE_ON:
  240. case RTC_PIE_OFF:
  241. case RTC_PIE_ON:
  242. case RTC_UIE_OFF:
  243. case RTC_UIE_ON:
  244. case RTC_IRQP_READ:
  245. case RTC_IRQP_SET:
  246. return -EINVAL;
  247. };
  248. }
  249. #endif
  250. switch (cmd) {
  251. #if RTC_IRQ
  252. case RTC_AIE_OFF: /* Mask alarm int. enab. bit */
  253. {
  254. mask_rtc_irq_bit(RTC_AIE);
  255. return 0;
  256. }
  257. case RTC_AIE_ON: /* Allow alarm interrupts. */
  258. {
  259. set_rtc_irq_bit(RTC_AIE);
  260. return 0;
  261. }
  262. case RTC_PIE_OFF: /* Mask periodic int. enab. bit */
  263. {
  264. mask_rtc_irq_bit(RTC_PIE);
  265. if (rtc_status & RTC_TIMER_ON) {
  266. spin_lock_irq (&rtc_lock);
  267. rtc_status &= ~RTC_TIMER_ON;
  268. del_timer(&rtc_irq_timer);
  269. spin_unlock_irq (&rtc_lock);
  270. }
  271. return 0;
  272. }
  273. case RTC_PIE_ON: /* Allow periodic ints */
  274. {
  275. /*
  276.  * We don't really want Joe User enabling more
  277.  * than 64Hz of interrupts on a multi-user machine.
  278.  */
  279. if ((rtc_freq > rtc_max_user_freq) && 
  280.     (!capable(CAP_SYS_RESOURCE)))
  281. return -EACCES;
  282. if (!(rtc_status & RTC_TIMER_ON)) {
  283. spin_lock_irq (&rtc_lock);
  284. rtc_irq_timer.expires = jiffies + HZ/rtc_freq + 2*HZ/100;
  285. add_timer(&rtc_irq_timer);
  286. rtc_status |= RTC_TIMER_ON;
  287. spin_unlock_irq (&rtc_lock);
  288. }
  289. set_rtc_irq_bit(RTC_PIE);
  290. return 0;
  291. }
  292. case RTC_UIE_OFF: /* Mask ints from RTC updates. */
  293. {
  294. mask_rtc_irq_bit(RTC_UIE);
  295. return 0;
  296. }
  297. case RTC_UIE_ON: /* Allow ints for RTC updates. */
  298. {
  299. set_rtc_irq_bit(RTC_UIE);
  300. return 0;
  301. }
  302. #endif
  303. case RTC_ALM_READ: /* Read the present alarm time */
  304. {
  305. /*
  306.  * This returns a struct rtc_time. Reading >= 0xc0
  307.  * means "don't care" or "match all". Only the tm_hour,
  308.  * tm_min, and tm_sec values are filled in.
  309.  */
  310. get_rtc_alm_time(&wtime);
  311. break; 
  312. }
  313. case RTC_ALM_SET: /* Store a time into the alarm */
  314. {
  315. /*
  316.  * This expects a struct rtc_time. Writing 0xff means
  317.  * "don't care" or "match all". Only the tm_hour,
  318.  * tm_min and tm_sec are used.
  319.  */
  320. unsigned char hrs, min, sec;
  321. struct rtc_time alm_tm;
  322. if (copy_from_user(&alm_tm, (struct rtc_time*)arg,
  323.    sizeof(struct rtc_time)))
  324. return -EFAULT;
  325. hrs = alm_tm.tm_hour;
  326. min = alm_tm.tm_min;
  327. sec = alm_tm.tm_sec;
  328. if (hrs >= 24)
  329. hrs = 0xff;
  330. if (min >= 60)
  331. min = 0xff;
  332. if (sec >= 60)
  333. sec = 0xff;
  334. spin_lock_irq(&rtc_lock);
  335. if (!(CMOS_READ(RTC_CONTROL) & RTC_DM_BINARY) ||
  336.     RTC_ALWAYS_BCD)
  337. {
  338. BIN_TO_BCD(sec);
  339. BIN_TO_BCD(min);
  340. BIN_TO_BCD(hrs);
  341. }
  342. CMOS_WRITE(hrs, RTC_HOURS_ALARM);
  343. CMOS_WRITE(min, RTC_MINUTES_ALARM);
  344. CMOS_WRITE(sec, RTC_SECONDS_ALARM);
  345. spin_unlock_irq(&rtc_lock);
  346. return 0;
  347. }
  348. case RTC_RD_TIME: /* Read the time/date from RTC */
  349. {
  350. get_rtc_time(&wtime);
  351. break;
  352. }
  353. case RTC_SET_TIME: /* Set the RTC */
  354. {
  355. struct rtc_time rtc_tm;
  356. unsigned char mon, day, hrs, min, sec, leap_yr;
  357. unsigned char save_control, save_freq_select;
  358. unsigned int yrs;
  359. #ifdef CONFIG_DECSTATION
  360. unsigned int real_yrs;
  361. #endif
  362. if (!capable(CAP_SYS_TIME))
  363. return -EACCES;
  364. if (copy_from_user(&rtc_tm, (struct rtc_time*)arg,
  365.    sizeof(struct rtc_time)))
  366. return -EFAULT;
  367. yrs = rtc_tm.tm_year + 1900;
  368. mon = rtc_tm.tm_mon + 1;   /* tm_mon starts at zero */
  369. day = rtc_tm.tm_mday;
  370. hrs = rtc_tm.tm_hour;
  371. min = rtc_tm.tm_min;
  372. sec = rtc_tm.tm_sec;
  373. if (yrs < 1970)
  374. return -EINVAL;
  375. leap_yr = ((!(yrs % 4) && (yrs % 100)) || !(yrs % 400));
  376. if ((mon > 12) || (day == 0))
  377. return -EINVAL;
  378. if (day > (days_in_mo[mon] + ((mon == 2) && leap_yr)))
  379. return -EINVAL;
  380. if ((hrs >= 24) || (min >= 60) || (sec >= 60))
  381. return -EINVAL;
  382. if ((yrs -= epoch) > 255)    /* They are unsigned */
  383. return -EINVAL;
  384. spin_lock_irq(&rtc_lock);
  385. #ifdef CONFIG_DECSTATION
  386. real_yrs = yrs;
  387. yrs = 72;
  388. /*
  389.  * We want to keep the year set to 73 until March
  390.  * for non-leap years, so that Feb, 29th is handled
  391.  * correctly.
  392.  */
  393. if (!leap_yr && mon < 3) {
  394. real_yrs--;
  395. yrs = 73;
  396. }
  397. #endif
  398. /* These limits and adjustments are independant of
  399.  * whether the chip is in binary mode or not.
  400.  */
  401. if (yrs > 169) {
  402. spin_unlock_irq(&rtc_lock);
  403. return -EINVAL;
  404. }
  405. if (yrs >= 100)
  406. yrs -= 100;
  407. if (!(CMOS_READ(RTC_CONTROL) & RTC_DM_BINARY)
  408.     || RTC_ALWAYS_BCD) {
  409. BIN_TO_BCD(sec);
  410. BIN_TO_BCD(min);
  411. BIN_TO_BCD(hrs);
  412. BIN_TO_BCD(day);
  413. BIN_TO_BCD(mon);
  414. BIN_TO_BCD(yrs);
  415. }
  416. save_control = CMOS_READ(RTC_CONTROL);
  417. CMOS_WRITE((save_control|RTC_SET), RTC_CONTROL);
  418. save_freq_select = CMOS_READ(RTC_FREQ_SELECT);
  419. CMOS_WRITE((save_freq_select|RTC_DIV_RESET2), RTC_FREQ_SELECT);
  420. #ifdef CONFIG_DECSTATION
  421. CMOS_WRITE(real_yrs, RTC_DEC_YEAR);
  422. #endif
  423. CMOS_WRITE(yrs, RTC_YEAR);
  424. CMOS_WRITE(mon, RTC_MONTH);
  425. CMOS_WRITE(day, RTC_DAY_OF_MONTH);
  426. CMOS_WRITE(hrs, RTC_HOURS);
  427. CMOS_WRITE(min, RTC_MINUTES);
  428. CMOS_WRITE(sec, RTC_SECONDS);
  429. CMOS_WRITE(save_control, RTC_CONTROL);
  430. CMOS_WRITE(save_freq_select, RTC_FREQ_SELECT);
  431. spin_unlock_irq(&rtc_lock);
  432. return 0;
  433. }
  434. #if RTC_IRQ
  435. case RTC_IRQP_READ: /* Read the periodic IRQ rate. */
  436. {
  437. return put_user(rtc_freq, (unsigned long *)arg);
  438. }
  439. case RTC_IRQP_SET: /* Set periodic IRQ rate. */
  440. {
  441. int tmp = 0;
  442. unsigned char val;
  443. /* 
  444.  * The max we can do is 8192Hz.
  445.  */
  446. if ((arg < 2) || (arg > 8192))
  447. return -EINVAL;
  448. /*
  449.  * We don't really want Joe User generating more
  450.  * than 64Hz of interrupts on a multi-user machine.
  451.  */
  452. if ((arg > rtc_max_user_freq) && (!capable(CAP_SYS_RESOURCE)))
  453. return -EACCES;
  454. while (arg > (1<<tmp))
  455. tmp++;
  456. /*
  457.  * Check that the input was really a power of 2.
  458.  */
  459. if (arg != (1<<tmp))
  460. return -EINVAL;
  461. spin_lock_irq(&rtc_lock);
  462. rtc_freq = arg;
  463. val = CMOS_READ(RTC_FREQ_SELECT) & 0xf0;
  464. val |= (16 - tmp);
  465. CMOS_WRITE(val, RTC_FREQ_SELECT);
  466. spin_unlock_irq(&rtc_lock);
  467. return 0;
  468. }
  469. #endif
  470. case RTC_EPOCH_READ: /* Read the epoch. */
  471. {
  472. return put_user (epoch, (unsigned long *)arg);
  473. }
  474. case RTC_EPOCH_SET: /* Set the epoch. */
  475. {
  476. /* 
  477.  * There were no RTC clocks before 1900.
  478.  */
  479. if (arg < 1900)
  480. return -EINVAL;
  481. if (!capable(CAP_SYS_TIME))
  482. return -EACCES;
  483. epoch = arg;
  484. return 0;
  485. }
  486. default:
  487. return -ENOTTY;
  488. }
  489. return copy_to_user((void *)arg, &wtime, sizeof wtime) ? -EFAULT : 0;
  490. }
  491. /*
  492.  * We enforce only one user at a time here with the open/close.
  493.  * Also clear the previous interrupt data on an open, and clean
  494.  * up things on a close.
  495.  */
  496. /* We use rtc_lock to protect against concurrent opens. So the BKL is not
  497.  * needed here. Or anywhere else in this driver. */
  498. static int rtc_open(struct inode *inode, struct file *file)
  499. {
  500. spin_lock_irq (&rtc_lock);
  501. if(rtc_status & RTC_IS_OPEN)
  502. goto out_busy;
  503. rtc_status |= RTC_IS_OPEN;
  504. rtc_irq_data = 0;
  505. spin_unlock_irq (&rtc_lock);
  506. return 0;
  507. out_busy:
  508. spin_unlock_irq (&rtc_lock);
  509. return -EBUSY;
  510. }
  511. static int rtc_fasync (int fd, struct file *filp, int on)
  512. {
  513. return fasync_helper (fd, filp, on, &rtc_async_queue);
  514. }
  515. static int rtc_release(struct inode *inode, struct file *file)
  516. {
  517. #if RTC_IRQ
  518. unsigned char tmp;
  519. if (rtc_has_irq == 0)
  520. goto no_irq;
  521. /*
  522.  * Turn off all interrupts once the device is no longer
  523.  * in use, and clear the data.
  524.  */
  525. spin_lock_irq(&rtc_lock);
  526. tmp = CMOS_READ(RTC_CONTROL);
  527. tmp &=  ~RTC_PIE;
  528. tmp &=  ~RTC_AIE;
  529. tmp &=  ~RTC_UIE;
  530. CMOS_WRITE(tmp, RTC_CONTROL);
  531. CMOS_READ(RTC_INTR_FLAGS);
  532. if (rtc_status & RTC_TIMER_ON) {
  533. rtc_status &= ~RTC_TIMER_ON;
  534. del_timer(&rtc_irq_timer);
  535. }
  536. spin_unlock_irq(&rtc_lock);
  537. if (file->f_flags & FASYNC) {
  538. rtc_fasync (-1, file, 0);
  539. }
  540. no_irq:
  541. #endif
  542. spin_lock_irq (&rtc_lock);
  543. rtc_irq_data = 0;
  544. spin_unlock_irq (&rtc_lock);
  545. /* No need for locking -- nobody else can do anything until this rmw is
  546.  * committed, and no timer is running. */
  547. rtc_status &= ~RTC_IS_OPEN;
  548. return 0;
  549. }
  550. #if RTC_IRQ
  551. /* Called without the kernel lock - fine */
  552. static unsigned int rtc_poll(struct file *file, poll_table *wait)
  553. {
  554. unsigned long l;
  555. if (rtc_has_irq == 0)
  556. return 0;
  557. poll_wait(file, &rtc_wait, wait);
  558. spin_lock_irq (&rtc_lock);
  559. l = rtc_irq_data;
  560. spin_unlock_irq (&rtc_lock);
  561. if (l != 0)
  562. return POLLIN | POLLRDNORM;
  563. return 0;
  564. }
  565. #endif
  566. /*
  567.  * The various file operations we support.
  568.  */
  569. static struct file_operations rtc_fops = {
  570. owner: THIS_MODULE,
  571. llseek: no_llseek,
  572. read: rtc_read,
  573. #if RTC_IRQ
  574. poll: rtc_poll,
  575. #endif
  576. ioctl: rtc_ioctl,
  577. open: rtc_open,
  578. release: rtc_release,
  579. fasync: rtc_fasync,
  580. };
  581. static struct miscdevice rtc_dev=
  582. {
  583. RTC_MINOR,
  584. "rtc",
  585. &rtc_fops
  586. };
  587. static int __init rtc_init(void)
  588. {
  589. #if defined(__alpha__) || defined(__mips__)
  590. unsigned int year, ctrl;
  591. unsigned long uip_watchdog;
  592. char *guess = NULL;
  593. #endif
  594. #ifdef __sparc__
  595. struct linux_ebus *ebus;
  596. struct linux_ebus_device *edev;
  597. #ifdef __sparc_v9__
  598. struct isa_bridge *isa_br;
  599. struct isa_device *isa_dev;
  600. #endif
  601. #endif
  602. #ifdef __sparc__
  603. for_each_ebus(ebus) {
  604. for_each_ebusdev(edev, ebus) {
  605. if(strcmp(edev->prom_name, "rtc") == 0) {
  606. rtc_port = edev->resource[0].start;
  607. rtc_irq = edev->irqs[0];
  608. goto found;
  609. }
  610. }
  611. }
  612. #ifdef __sparc_v9__
  613. for_each_isa(isa_br) {
  614. for_each_isadev(isa_dev, isa_br) {
  615. if (strcmp(isa_dev->prom_name, "rtc") == 0) {
  616. rtc_port = isa_dev->resource.start;
  617. rtc_irq = isa_dev->irq;
  618. goto found;
  619. }
  620. }
  621. }
  622. #endif
  623. printk(KERN_ERR "rtc_init: no PC rtc foundn");
  624. return -EIO;
  625. found:
  626. if (rtc_irq == PCI_IRQ_NONE) {
  627. rtc_has_irq = 0;
  628. goto no_irq;
  629. }
  630. /*
  631.  * XXX Interrupt pin #7 in Espresso is shared between RTC and
  632.  * PCI Slot 2 INTA# (and some INTx# in Slot 1). SA_INTERRUPT here
  633.  * is asking for trouble with add-on boards. Change to SA_SHIRQ.
  634.  */
  635. if (request_irq(rtc_irq, rtc_interrupt, SA_INTERRUPT, "rtc", (void *)&rtc_port)) {
  636. /*
  637.  * Standard way for sparc to print irq's is to use
  638.  * __irq_itoa(). I think for EBus it's ok to use %d.
  639.  */
  640. printk(KERN_ERR "rtc: cannot register IRQ %dn", rtc_irq);
  641. return -EIO;
  642. }
  643. no_irq:
  644. #else
  645. if (!request_region(RTC_PORT(0), RTC_IO_EXTENT, "rtc"))
  646. {
  647. printk(KERN_ERR "rtc: I/O port %d is not free.n", RTC_PORT (0));
  648. return -EIO;
  649. }
  650. #if RTC_IRQ
  651. if(request_irq(RTC_IRQ, rtc_interrupt, SA_INTERRUPT, "rtc", NULL))
  652. {
  653. /* Yeah right, seeing as irq 8 doesn't even hit the bus. */
  654. printk(KERN_ERR "rtc: IRQ %d is not free.n", RTC_IRQ);
  655. release_region(RTC_PORT(0), RTC_IO_EXTENT);
  656. return -EIO;
  657. }
  658. #endif
  659. #endif /* __sparc__ vs. others */
  660. misc_register(&rtc_dev);
  661. create_proc_read_entry ("driver/rtc", 0, 0, rtc_read_proc, NULL);
  662. #if defined(__alpha__) || defined(__mips__)
  663. rtc_freq = HZ;
  664. /* Each operating system on an Alpha uses its own epoch.
  665.    Let's try to guess which one we are using now. */
  666. uip_watchdog = jiffies;
  667. if (rtc_is_updating() != 0)
  668. while (jiffies - uip_watchdog < 2*HZ/100) { 
  669. barrier();
  670. cpu_relax();
  671. }
  672. spin_lock_irq(&rtc_lock);
  673. year = CMOS_READ(RTC_YEAR);
  674. ctrl = CMOS_READ(RTC_CONTROL);
  675. spin_unlock_irq(&rtc_lock);
  676. if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
  677. BCD_TO_BIN(year);       /* This should never happen... */
  678. if (year < 20) {
  679. epoch = 2000;
  680. guess = "SRM (post-2000)";
  681. } else if (year >= 20 && year < 48) {
  682. epoch = 1980;
  683. guess = "ARC console";
  684. } else if (year >= 48 && year < 72) {
  685. epoch = 1952;
  686. guess = "Digital UNIX";
  687. #if defined(__mips__)
  688. } else if (year >= 72 && year < 74) {
  689. epoch = 2000;
  690. guess = "Digital DECstation";
  691. #else
  692. } else if (year >= 70) {
  693. epoch = 1900;
  694. guess = "Standard PC (1900)";
  695. #endif
  696. }
  697. if (guess)
  698. printk(KERN_INFO "rtc: %s epoch (%lu) detectedn", guess, epoch);
  699. #endif
  700. #if RTC_IRQ
  701. if (rtc_has_irq == 0)
  702. goto no_irq2;
  703. init_timer(&rtc_irq_timer);
  704. rtc_irq_timer.function = rtc_dropped_irq;
  705. spin_lock_irq(&rtc_lock);
  706. /* Initialize periodic freq. to CMOS reset default, which is 1024Hz */
  707. CMOS_WRITE(((CMOS_READ(RTC_FREQ_SELECT) & 0xF0) | 0x06), RTC_FREQ_SELECT);
  708. spin_unlock_irq(&rtc_lock);
  709. rtc_freq = 1024;
  710. no_irq2:
  711. #endif
  712. (void) init_sysctl();
  713. printk(KERN_INFO "Real Time Clock Driver v" RTC_VERSION "n");
  714. return 0;
  715. }
  716. static void __exit rtc_exit (void)
  717. {
  718. cleanup_sysctl();
  719. remove_proc_entry ("driver/rtc", NULL);
  720. misc_deregister(&rtc_dev);
  721. #ifdef __sparc__
  722. if (rtc_has_irq)
  723. free_irq (rtc_irq, &rtc_port);
  724. #else
  725. release_region (RTC_PORT (0), RTC_IO_EXTENT);
  726. #if RTC_IRQ
  727. if (rtc_has_irq)
  728. free_irq (RTC_IRQ, NULL);
  729. #endif
  730. #endif /* __sparc__ */
  731. }
  732. module_init(rtc_init);
  733. module_exit(rtc_exit);
  734. EXPORT_NO_SYMBOLS;
  735. #if RTC_IRQ
  736. /*
  737.  *  At IRQ rates >= 4096Hz, an interrupt may get lost altogether.
  738.  * (usually during an IDE disk interrupt, with IRQ unmasking off)
  739.  * Since the interrupt handler doesn't get called, the IRQ status
  740.  * byte doesn't get read, and the RTC stops generating interrupts.
  741.  * A timer is set, and will call this function if/when that happens.
  742.  * To get it out of this stalled state, we just read the status.
  743.  * At least a jiffy of interrupts (rtc_freq/HZ) will have been lost.
  744.  * (You *really* shouldn't be trying to use a non-realtime system 
  745.  * for something that requires a steady > 1KHz signal anyways.)
  746.  */
  747. static void rtc_dropped_irq(unsigned long data)
  748. {
  749. unsigned long freq;
  750. spin_lock_irq (&rtc_lock);
  751. /* Just in case someone disabled the timer from behind our back... */
  752. if (rtc_status & RTC_TIMER_ON)
  753. mod_timer(&rtc_irq_timer, jiffies + HZ/rtc_freq + 2*HZ/100);
  754. rtc_irq_data += ((rtc_freq/HZ)<<8);
  755. rtc_irq_data &= ~0xff;
  756. rtc_irq_data |= (CMOS_READ(RTC_INTR_FLAGS) & 0xF0); /* restart */
  757. freq = rtc_freq;
  758. spin_unlock_irq(&rtc_lock);
  759. printk(KERN_WARNING "rtc: lost some interrupts at %ldHz.n", freq);
  760. /* Now we have new data */
  761. wake_up_interruptible(&rtc_wait);
  762. kill_fasync (&rtc_async_queue, SIGIO, POLL_IN);
  763. }
  764. #endif
  765. /*
  766.  * Info exported via "/proc/driver/rtc".
  767.  */
  768. static int rtc_proc_output (char *buf)
  769. {
  770. #define YN(bit) ((ctrl & bit) ? "yes" : "no")
  771. #define NY(bit) ((ctrl & bit) ? "no" : "yes")
  772. char *p;
  773. struct rtc_time tm;
  774. unsigned char batt, ctrl;
  775. unsigned long freq;
  776. spin_lock_irq(&rtc_lock);
  777. batt = CMOS_READ(RTC_VALID) & RTC_VRT;
  778. ctrl = CMOS_READ(RTC_CONTROL);
  779. freq = rtc_freq;
  780. spin_unlock_irq(&rtc_lock);
  781. p = buf;
  782. get_rtc_time(&tm);
  783. /*
  784.  * There is no way to tell if the luser has the RTC set for local
  785.  * time or for Universal Standard Time (GMT). Probably local though.
  786.  */
  787. p += sprintf(p,
  788.      "rtc_timet: %02d:%02d:%02dn"
  789.      "rtc_datet: %04d-%02d-%02dn"
  790.        "rtc_epocht: %04lun",
  791.      tm.tm_hour, tm.tm_min, tm.tm_sec,
  792.      tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, epoch);
  793. get_rtc_alm_time(&tm);
  794. /*
  795.  * We implicitly assume 24hr mode here. Alarm values >= 0xc0 will
  796.  * match any value for that particular field. Values that are
  797.  * greater than a valid time, but less than 0xc0 shouldn't appear.
  798.  */
  799. p += sprintf(p, "alarmtt: ");
  800. if (tm.tm_hour <= 24)
  801. p += sprintf(p, "%02d:", tm.tm_hour);
  802. else
  803. p += sprintf(p, "**:");
  804. if (tm.tm_min <= 59)
  805. p += sprintf(p, "%02d:", tm.tm_min);
  806. else
  807. p += sprintf(p, "**:");
  808. if (tm.tm_sec <= 59)
  809. p += sprintf(p, "%02dn", tm.tm_sec);
  810. else
  811. p += sprintf(p, "**n");
  812. p += sprintf(p,
  813.      "DST_enablet: %sn"
  814.      "BCDtt: %sn"
  815.      "24hrtt: %sn"
  816.      "square_wavet: %sn"
  817.      "alarm_IRQt: %sn"
  818.      "update_IRQt: %sn"
  819.      "periodic_IRQt: %sn"
  820.      "periodic_freqt: %ldn"
  821.      "batt_statust: %sn",
  822.      YN(RTC_DST_EN),
  823.      NY(RTC_DM_BINARY),
  824.      YN(RTC_24H),
  825.      YN(RTC_SQWE),
  826.      YN(RTC_AIE),
  827.      YN(RTC_UIE),
  828.      YN(RTC_PIE),
  829.      freq,
  830.      batt ? "okay" : "dead");
  831. return  p - buf;
  832. #undef YN
  833. #undef NY
  834. }
  835. static int rtc_read_proc(char *page, char **start, off_t off,
  836.                          int count, int *eof, void *data)
  837. {
  838.         int len = rtc_proc_output (page);
  839.         if (len <= off+count) *eof = 1;
  840.         *start = page + off;
  841.         len -= off;
  842.         if (len>count) len = count;
  843.         if (len<0) len = 0;
  844.         return len;
  845. }
  846. /*
  847.  * Returns true if a clock update is in progress
  848.  */
  849. /* FIXME shouldn't this be above rtc_init to make it fully inlined? */
  850. static inline unsigned char rtc_is_updating(void)
  851. {
  852. unsigned char uip;
  853. spin_lock_irq(&rtc_lock);
  854. uip = (CMOS_READ(RTC_FREQ_SELECT) & RTC_UIP);
  855. spin_unlock_irq(&rtc_lock);
  856. return uip;
  857. }
  858. static void get_rtc_time(struct rtc_time *rtc_tm)
  859. {
  860. unsigned long uip_watchdog = jiffies;
  861. unsigned char ctrl;
  862. #ifdef CONFIG_DECSTATION
  863. unsigned int real_year;
  864. #endif
  865. /*
  866.  * read RTC once any update in progress is done. The update
  867.  * can take just over 2ms. We wait 10 to 20ms. There is no need to
  868.  * to poll-wait (up to 1s - eeccch) for the falling edge of RTC_UIP.
  869.  * If you need to know *exactly* when a second has started, enable
  870.  * periodic update complete interrupts, (via ioctl) and then 
  871.  * immediately read /dev/rtc which will block until you get the IRQ.
  872.  * Once the read clears, read the RTC time (again via ioctl). Easy.
  873.  */
  874. if (rtc_is_updating() != 0)
  875. while (jiffies - uip_watchdog < 2*HZ/100) {
  876. barrier();
  877. cpu_relax();
  878. }
  879. /*
  880.  * Only the values that we read from the RTC are set. We leave
  881.  * tm_wday, tm_yday and tm_isdst untouched. Even though the
  882.  * RTC has RTC_DAY_OF_WEEK, we ignore it, as it is only updated
  883.  * by the RTC when initially set to a non-zero value.
  884.  */
  885. spin_lock_irq(&rtc_lock);
  886. rtc_tm->tm_sec = CMOS_READ(RTC_SECONDS);
  887. rtc_tm->tm_min = CMOS_READ(RTC_MINUTES);
  888. rtc_tm->tm_hour = CMOS_READ(RTC_HOURS);
  889. rtc_tm->tm_mday = CMOS_READ(RTC_DAY_OF_MONTH);
  890. rtc_tm->tm_mon = CMOS_READ(RTC_MONTH);
  891. rtc_tm->tm_year = CMOS_READ(RTC_YEAR);
  892. #ifdef CONFIG_DECSTATION
  893. real_year = CMOS_READ(RTC_DEC_YEAR);
  894. #endif
  895. ctrl = CMOS_READ(RTC_CONTROL);
  896. spin_unlock_irq(&rtc_lock);
  897. if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
  898. {
  899. BCD_TO_BIN(rtc_tm->tm_sec);
  900. BCD_TO_BIN(rtc_tm->tm_min);
  901. BCD_TO_BIN(rtc_tm->tm_hour);
  902. BCD_TO_BIN(rtc_tm->tm_mday);
  903. BCD_TO_BIN(rtc_tm->tm_mon);
  904. BCD_TO_BIN(rtc_tm->tm_year);
  905. }
  906. #ifdef CONFIG_DECSTATION
  907. rtc_tm->tm_year += real_year - 72;
  908. #endif
  909. /*
  910.  * Account for differences between how the RTC uses the values
  911.  * and how they are defined in a struct rtc_time;
  912.  */
  913. if ((rtc_tm->tm_year += (epoch - 1900)) <= 69)
  914. rtc_tm->tm_year += 100;
  915. rtc_tm->tm_mon--;
  916. }
  917. static void get_rtc_alm_time(struct rtc_time *alm_tm)
  918. {
  919. unsigned char ctrl;
  920. /*
  921.  * Only the values that we read from the RTC are set. That
  922.  * means only tm_hour, tm_min, and tm_sec.
  923.  */
  924. spin_lock_irq(&rtc_lock);
  925. alm_tm->tm_sec = CMOS_READ(RTC_SECONDS_ALARM);
  926. alm_tm->tm_min = CMOS_READ(RTC_MINUTES_ALARM);
  927. alm_tm->tm_hour = CMOS_READ(RTC_HOURS_ALARM);
  928. ctrl = CMOS_READ(RTC_CONTROL);
  929. spin_unlock_irq(&rtc_lock);
  930. if (!(ctrl & RTC_DM_BINARY) || RTC_ALWAYS_BCD)
  931. {
  932. BCD_TO_BIN(alm_tm->tm_sec);
  933. BCD_TO_BIN(alm_tm->tm_min);
  934. BCD_TO_BIN(alm_tm->tm_hour);
  935. }
  936. }
  937. #if RTC_IRQ
  938. /*
  939.  * Used to disable/enable interrupts for any one of UIE, AIE, PIE.
  940.  * Rumour has it that if you frob the interrupt enable/disable
  941.  * bits in RTC_CONTROL, you should read RTC_INTR_FLAGS, to
  942.  * ensure you actually start getting interrupts. Probably for
  943.  * compatibility with older/broken chipset RTC implementations.
  944.  * We also clear out any old irq data after an ioctl() that
  945.  * meddles with the interrupt enable/disable bits.
  946.  */
  947. static void mask_rtc_irq_bit(unsigned char bit)
  948. {
  949. unsigned char val;
  950. spin_lock_irq(&rtc_lock);
  951. val = CMOS_READ(RTC_CONTROL);
  952. val &=  ~bit;
  953. CMOS_WRITE(val, RTC_CONTROL);
  954. CMOS_READ(RTC_INTR_FLAGS);
  955. rtc_irq_data = 0;
  956. spin_unlock_irq(&rtc_lock);
  957. }
  958. static void set_rtc_irq_bit(unsigned char bit)
  959. {
  960. unsigned char val;
  961. spin_lock_irq(&rtc_lock);
  962. val = CMOS_READ(RTC_CONTROL);
  963. val |= bit;
  964. CMOS_WRITE(val, RTC_CONTROL);
  965. CMOS_READ(RTC_INTR_FLAGS);
  966. rtc_irq_data = 0;
  967. spin_unlock_irq(&rtc_lock);
  968. }
  969. #endif
  970. MODULE_AUTHOR("Paul Gortmaker");
  971. MODULE_LICENSE("GPL");