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

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  * DS1286 Real Time Clock interface for Linux
  3.  *
  4.  * Copyright (C) 1998, 1999, 2000 Ralf Baechle
  5.  *
  6.  * Based on code written by Paul Gortmaker.
  7.  *
  8.  * This driver allows use of the real time clock (built into nearly all
  9.  * computers) from user space. It exports the /dev/rtc interface supporting
  10.  * various ioctl() and also the /proc/rtc pseudo-file for status
  11.  * information.
  12.  *
  13.  * The ioctls can be used to set the interrupt behaviour and generation rate
  14.  * from the RTC via IRQ 8. Then the /dev/rtc interface can be used to make
  15.  * use of these timer interrupts, be they interval or alarm based.
  16.  *
  17.  * The /dev/rtc interface will block on reads until an interrupt has been
  18.  * received. If a RTC interrupt has already happened, it will output an
  19.  * unsigned long and then block. The output value contains the interrupt
  20.  * status in the low byte and the number of interrupts since the last read
  21.  * in the remaining high bytes. The /dev/rtc interface can also be used with
  22.  * the select(2) call.
  23.  *
  24.  * This program is free software; you can redistribute it and/or modify it
  25.  * under the terms of the GNU General Public License as published by the
  26.  * Free Software Foundation; either version 2 of the License, or (at your
  27.  * option) any later version.
  28.  */
  29. #include <linux/types.h>
  30. #include <linux/errno.h>
  31. #include <linux/miscdevice.h>
  32. #include <linux/slab.h>
  33. #include <linux/ioport.h>
  34. #include <linux/fcntl.h>
  35. #include <linux/init.h>
  36. #include <linux/poll.h>
  37. #include <linux/rtc.h>
  38. #include <linux/spinlock.h>
  39. #include <asm/ds1286.h>
  40. #include <asm/io.h>
  41. #include <asm/uaccess.h>
  42. #include <asm/system.h>
  43. #define DS1286_VERSION "1.0"
  44. /*
  45.  * We sponge a minor off of the misc major. No need slurping
  46.  * up another valuable major dev number for this. If you add
  47.  * an ioctl, make sure you don't conflict with SPARC's RTC
  48.  * ioctls.
  49.  */
  50. static DECLARE_WAIT_QUEUE_HEAD(ds1286_wait);
  51. static ssize_t ds1286_read(struct file *file, char *buf,
  52. size_t count, loff_t *ppos);
  53. static int ds1286_ioctl(struct inode *inode, struct file *file,
  54.                         unsigned int cmd, unsigned long arg);
  55. static unsigned int ds1286_poll(struct file *file, poll_table *wait);
  56. void ds1286_get_alm_time (struct rtc_time *alm_tm);
  57. void ds1286_get_time(struct rtc_time *rtc_tm);
  58. int ds1286_set_time(struct rtc_time *rtc_tm);
  59. void set_rtc_irq_bit(unsigned char bit);
  60. void clear_rtc_irq_bit(unsigned char bit);
  61. static inline unsigned char ds1286_is_updating(void);
  62. static spinlock_t ds1286_lock = SPIN_LOCK_UNLOCKED;
  63. /*
  64.  * Bits in rtc_status. (7 bits of room for future expansion)
  65.  */
  66. #define RTC_IS_OPEN 0x01 /* means /dev/rtc is in use */
  67. #define RTC_TIMER_ON 0x02 /* missed irq timer active */
  68. unsigned char ds1286_status; /* bitmapped status byte. */
  69. unsigned long ds1286_freq; /* Current periodic IRQ rate */
  70. unsigned char days_in_mo[] =
  71. {0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
  72. /*
  73.  * Now all the various file operations that we export.
  74.  */
  75. static ssize_t ds1286_read(struct file *file, char *buf,
  76.                            size_t count, loff_t *ppos)
  77. {
  78. return -EIO;
  79. }
  80. static int ds1286_ioctl(struct inode *inode, struct file *file,
  81.                         unsigned int cmd, unsigned long arg)
  82. {
  83. struct rtc_time wtime;
  84. switch (cmd) {
  85. case RTC_AIE_OFF: /* Mask alarm int. enab. bit */
  86. {
  87. unsigned int flags;
  88. unsigned char val;
  89. if (!capable(CAP_SYS_TIME))
  90. return -EACCES;
  91. spin_lock_irqsave(&ds1286_lock, flags);
  92. val = CMOS_READ(RTC_CMD);
  93. val |=  RTC_TDM;
  94. CMOS_WRITE(val, RTC_CMD);
  95. spin_unlock_irqrestore(&ds1286_lock, flags);
  96. return 0;
  97. }
  98. case RTC_AIE_ON: /* Allow alarm interrupts. */
  99. {
  100. unsigned int flags;
  101. unsigned char val;
  102. if (!capable(CAP_SYS_TIME))
  103. return -EACCES;
  104. spin_lock_irqsave(&ds1286_lock, flags);
  105. val = CMOS_READ(RTC_CMD);
  106. val &=  ~RTC_TDM;
  107. CMOS_WRITE(val, RTC_CMD);
  108. spin_unlock_irqrestore(&ds1286_lock, flags);
  109. return 0;
  110. }
  111. case RTC_WIE_OFF: /* Mask watchdog int. enab. bit */
  112. {
  113. unsigned int flags;
  114. unsigned char val;
  115. if (!capable(CAP_SYS_TIME))
  116. return -EACCES;
  117. spin_lock_irqsave(&ds1286_lock, flags);
  118. val = CMOS_READ(RTC_CMD);
  119. val |= RTC_WAM;
  120. CMOS_WRITE(val, RTC_CMD);
  121. spin_unlock_irqrestore(&ds1286_lock, flags);
  122. return 0;
  123. }
  124. case RTC_WIE_ON: /* Allow watchdog interrupts. */
  125. {
  126. unsigned int flags;
  127. unsigned char val;
  128. if (!capable(CAP_SYS_TIME))
  129. return -EACCES;
  130. spin_lock_irqsave(&ds1286_lock, flags);
  131. val = CMOS_READ(RTC_CMD);
  132. val &= ~RTC_WAM;
  133. CMOS_WRITE(val, RTC_CMD);
  134. spin_unlock_irqrestore(&ds1286_lock, flags);
  135. return 0;
  136. }
  137. case RTC_ALM_READ: /* Read the present alarm time */
  138. {
  139. /*
  140.  * This returns a struct rtc_time. Reading >= 0xc0
  141.  * means "don't care" or "match all". Only the tm_hour,
  142.  * tm_min, and tm_sec values are filled in.
  143.  */
  144. ds1286_get_alm_time(&wtime);
  145. break;
  146. }
  147. case RTC_ALM_SET: /* Store a time into the alarm */
  148. {
  149. /*
  150.  * This expects a struct rtc_time. Writing 0xff means
  151.  * "don't care" or "match all". Only the tm_hour,
  152.  * tm_min and tm_sec are used.
  153.  */
  154. unsigned char hrs, min, sec;
  155. struct rtc_time alm_tm;
  156. if (!capable(CAP_SYS_TIME))
  157. return -EACCES;
  158. if (copy_from_user(&alm_tm, (struct rtc_time*)arg,
  159.    sizeof(struct rtc_time)))
  160. return -EFAULT;
  161. hrs = alm_tm.tm_hour;
  162. min = alm_tm.tm_min;
  163. if (hrs >= 24)
  164. hrs = 0xff;
  165. if (min >= 60)
  166. min = 0xff;
  167. BIN_TO_BCD(sec);
  168. BIN_TO_BCD(min);
  169. BIN_TO_BCD(hrs);
  170. spin_lock(&ds1286_lock);
  171. CMOS_WRITE(hrs, RTC_HOURS_ALARM);
  172. CMOS_WRITE(min, RTC_MINUTES_ALARM);
  173. spin_unlock(&ds1286_lock);
  174. return 0;
  175. }
  176. case RTC_RD_TIME: /* Read the time/date from RTC */
  177. {
  178. ds1286_get_time(&wtime);
  179. break;
  180. }
  181. case RTC_SET_TIME: /* Set the RTC */
  182. {
  183. struct rtc_time rtc_tm;
  184. if (!capable(CAP_SYS_TIME))
  185. return -EACCES;
  186. if (copy_from_user(&rtc_tm, (struct rtc_time*)arg,
  187.    sizeof(struct rtc_time)))
  188. return -EFAULT;
  189. return ds1286_set_time(&rtc_tm);
  190. }
  191. default:
  192. return -EINVAL;
  193. }
  194. return copy_to_user((void *)arg, &wtime, sizeof wtime) ? -EFAULT : 0;
  195. }
  196. /*
  197.  * We enforce only one user at a time here with the open/close.
  198.  * Also clear the previous interrupt data on an open, and clean
  199.  * up things on a close.
  200.  */
  201. static int ds1286_open(struct inode *inode, struct file *file)
  202. {
  203. spin_lock_irq(&ds1286_lock);
  204. if (ds1286_status & RTC_IS_OPEN)
  205. goto out_busy;
  206. ds1286_status |= RTC_IS_OPEN;
  207. spin_lock_irq(&ds1286_lock);
  208. return 0;
  209. out_busy:
  210. spin_lock_irq(&ds1286_lock);
  211. return -EBUSY;
  212. }
  213. static int ds1286_release(struct inode *inode, struct file *file)
  214. {
  215. ds1286_status &= ~RTC_IS_OPEN;
  216. return 0;
  217. }
  218. static unsigned int ds1286_poll(struct file *file, poll_table *wait)
  219. {
  220. poll_wait(file, &ds1286_wait, wait);
  221. return 0;
  222. }
  223. /*
  224.  * The various file operations we support.
  225.  */
  226. static struct file_operations ds1286_fops = {
  227. llseek: no_llseek,
  228. read: ds1286_read,
  229. poll: ds1286_poll,
  230. ioctl: ds1286_ioctl,
  231. open: ds1286_open,
  232. release: ds1286_release,
  233. };
  234. static struct miscdevice ds1286_dev=
  235. {
  236. RTC_MINOR,
  237. "rtc",
  238. &ds1286_fops
  239. };
  240. int __init ds1286_init(void)
  241. {
  242. printk(KERN_INFO "DS1286 Real Time Clock Driver v%sn", DS1286_VERSION);
  243. misc_register(&ds1286_dev);
  244. return 0;
  245. }
  246. static char *days[] = {
  247. "***", "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
  248. };
  249. /*
  250.  * Info exported via "/proc/rtc".
  251.  */
  252. int get_ds1286_status(char *buf)
  253. {
  254. char *p, *s;
  255. struct rtc_time tm;
  256. unsigned char hundredth, month, cmd, amode;
  257. p = buf;
  258. ds1286_get_time(&tm);
  259. hundredth = CMOS_READ(RTC_HUNDREDTH_SECOND);
  260. BCD_TO_BIN(hundredth);
  261. p += sprintf(p,
  262.              "rtc_timet: %02d:%02d:%02d.%02dn"
  263.              "rtc_datet: %04d-%02d-%02dn",
  264.      tm.tm_hour, tm.tm_min, tm.tm_sec, hundredth,
  265.      tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday);
  266. /*
  267.  * We implicitly assume 24hr mode here. Alarm values >= 0xc0 will
  268.  * match any value for that particular field. Values that are
  269.  * greater than a valid time, but less than 0xc0 shouldn't appear.
  270.  */
  271. ds1286_get_alm_time(&tm);
  272. p += sprintf(p, "alarmtt: %s ", days[tm.tm_wday]);
  273. if (tm.tm_hour <= 24)
  274. p += sprintf(p, "%02d:", tm.tm_hour);
  275. else
  276. p += sprintf(p, "**:");
  277. if (tm.tm_min <= 59)
  278. p += sprintf(p, "%02dn", tm.tm_min);
  279. else
  280. p += sprintf(p, "**n");
  281. month = CMOS_READ(RTC_MONTH);
  282. p += sprintf(p,
  283.              "oscillatort: %sn"
  284.              "square_wavet: %sn",
  285.              (month & RTC_EOSC) ? "disabled" : "enabled",
  286.              (month & RTC_ESQW) ? "disabled" : "enabled");
  287. amode = ((CMOS_READ(RTC_MINUTES_ALARM) & 0x80) >> 5) |
  288.         ((CMOS_READ(RTC_HOURS_ALARM) & 0x80) >> 6) |
  289.         ((CMOS_READ(RTC_DAY_ALARM) & 0x80) >> 7);
  290. if (amode == 7)      s = "each minute";
  291. else if (amode == 3) s = "minutes match";
  292. else if (amode == 1) s = "hours and minutes match";
  293. else if (amode == 0) s = "days, hours and minutes match";
  294. else                 s = "invalid";
  295. p += sprintf(p, "alarm_modet: %sn", s);
  296. cmd = CMOS_READ(RTC_CMD);
  297. p += sprintf(p,
  298.              "alarm_enablet: %sn"
  299.              "wdog_alarmt: %sn"
  300.              "alarm_maskt: %sn"
  301.              "wdog_alarm_maskt: %sn"
  302.              "interrupt_modet: %sn"
  303.              "INTB_modet: %s_activen"
  304.              "interrupt_pinst: %sn",
  305.      (cmd & RTC_TDF) ? "yes" : "no",
  306.      (cmd & RTC_WAF) ? "yes" : "no",
  307.      (cmd & RTC_TDM) ? "disabled" : "enabled",
  308.      (cmd & RTC_WAM) ? "disabled" : "enabled",
  309.      (cmd & RTC_PU_LVL) ? "pulse" : "level",
  310.      (cmd & RTC_IBH_LO) ? "low" : "high",
  311.              (cmd & RTC_IPSW) ? "unswapped" : "swapped");
  312. return  p - buf;
  313. }
  314. /*
  315.  * Returns true if a clock update is in progress
  316.  */
  317. static inline unsigned char ds1286_is_updating(void)
  318. {
  319. return CMOS_READ(RTC_CMD) & RTC_TE;
  320. }
  321. void ds1286_get_time(struct rtc_time *rtc_tm)
  322. {
  323. unsigned char save_control;
  324. unsigned int flags;
  325. unsigned long uip_watchdog = jiffies;
  326. /*
  327.  * read RTC once any update in progress is done. The update
  328.  * can take just over 2ms. We wait 10 to 20ms. There is no need to
  329.  * to poll-wait (up to 1s - eeccch) for the falling edge of RTC_UIP.
  330.  * If you need to know *exactly* when a second has started, enable
  331.  * periodic update complete interrupts, (via ioctl) and then
  332.  * immediately read /dev/rtc which will block until you get the IRQ.
  333.  * Once the read clears, read the RTC time (again via ioctl). Easy.
  334.  */
  335. if (ds1286_is_updating() != 0)
  336. while (jiffies - uip_watchdog < 2*HZ/100)
  337. barrier();
  338. /*
  339.  * Only the values that we read from the RTC are set. We leave
  340.  * tm_wday, tm_yday and tm_isdst untouched. Even though the
  341.  * RTC has RTC_DAY_OF_WEEK, we ignore it, as it is only updated
  342.  * by the RTC when initially set to a non-zero value.
  343.  */
  344. spin_lock_irqsave(&ds1286_lock, flags);
  345. save_control = CMOS_READ(RTC_CMD);
  346. CMOS_WRITE((save_control|RTC_TE), RTC_CMD);
  347. rtc_tm->tm_sec = CMOS_READ(RTC_SECONDS);
  348. rtc_tm->tm_min = CMOS_READ(RTC_MINUTES);
  349. rtc_tm->tm_hour = CMOS_READ(RTC_HOURS) & 0x1f;
  350. rtc_tm->tm_mday = CMOS_READ(RTC_DATE);
  351. rtc_tm->tm_mon = CMOS_READ(RTC_MONTH) & 0x1f;
  352. rtc_tm->tm_year = CMOS_READ(RTC_YEAR);
  353. CMOS_WRITE(save_control, RTC_CMD);
  354. spin_unlock_irqrestore(&ds1286_lock, flags);
  355. BCD_TO_BIN(rtc_tm->tm_sec);
  356. BCD_TO_BIN(rtc_tm->tm_min);
  357. BCD_TO_BIN(rtc_tm->tm_hour);
  358. BCD_TO_BIN(rtc_tm->tm_mday);
  359. BCD_TO_BIN(rtc_tm->tm_mon);
  360. BCD_TO_BIN(rtc_tm->tm_year);
  361. /*
  362.  * Account for differences between how the RTC uses the values
  363.  * and how they are defined in a struct rtc_time;
  364.  */
  365. if (rtc_tm->tm_year < 45)
  366. rtc_tm->tm_year += 30;
  367. if ((rtc_tm->tm_year += 40) < 70)
  368. rtc_tm->tm_year += 100;
  369. rtc_tm->tm_mon--;
  370. }
  371. int ds1286_set_time(struct rtc_time *rtc_tm)
  372. {
  373. unsigned char mon, day, hrs, min, sec, leap_yr;
  374. unsigned char save_control;
  375. unsigned int yrs, flags;
  376. yrs = rtc_tm->tm_year + 1900;
  377. mon = rtc_tm->tm_mon + 1;   /* tm_mon starts at zero */
  378. day = rtc_tm->tm_mday;
  379. hrs = rtc_tm->tm_hour;
  380. min = rtc_tm->tm_min;
  381. sec = rtc_tm->tm_sec;
  382. if (yrs < 1970)
  383. return -EINVAL;
  384. leap_yr = ((!(yrs % 4) && (yrs % 100)) || !(yrs % 400));
  385. if ((mon > 12) || (day == 0))
  386. return -EINVAL;
  387. if (day > (days_in_mo[mon] + ((mon == 2) && leap_yr)))
  388. return -EINVAL;
  389. if ((hrs >= 24) || (min >= 60) || (sec >= 60))
  390. return -EINVAL;
  391. if ((yrs -= 1940) > 255)    /* They are unsigned */
  392. return -EINVAL;
  393. if (yrs >= 100)
  394. yrs -= 100;
  395. BIN_TO_BCD(sec);
  396. BIN_TO_BCD(min);
  397. BIN_TO_BCD(hrs);
  398. BIN_TO_BCD(day);
  399. BIN_TO_BCD(mon);
  400. BIN_TO_BCD(yrs);
  401. spin_lock_irqsave(&ds1286_lock, flags);
  402. save_control = CMOS_READ(RTC_CMD);
  403. CMOS_WRITE((save_control|RTC_TE), RTC_CMD);
  404. CMOS_WRITE(yrs, RTC_YEAR);
  405. CMOS_WRITE(mon, RTC_MONTH);
  406. CMOS_WRITE(day, RTC_DATE);
  407. CMOS_WRITE(hrs, RTC_HOURS);
  408. CMOS_WRITE(min, RTC_MINUTES);
  409. CMOS_WRITE(sec, RTC_SECONDS);
  410. CMOS_WRITE(0, RTC_HUNDREDTH_SECOND);
  411. CMOS_WRITE(save_control, RTC_CMD);
  412. spin_unlock_irqrestore(&ds1286_lock, flags);
  413. return 0;
  414. }
  415. void ds1286_get_alm_time(struct rtc_time *alm_tm)
  416. {
  417. unsigned char cmd;
  418. unsigned int flags;
  419. /*
  420.  * Only the values that we read from the RTC are set. That
  421.  * means only tm_wday, tm_hour, tm_min.
  422.  */
  423. spin_lock_irqsave(&ds1286_lock, flags);
  424. alm_tm->tm_min = CMOS_READ(RTC_MINUTES_ALARM) & 0x7f;
  425. alm_tm->tm_hour = CMOS_READ(RTC_HOURS_ALARM)  & 0x1f;
  426. alm_tm->tm_wday = CMOS_READ(RTC_DAY_ALARM)    & 0x07;
  427. cmd = CMOS_READ(RTC_CMD);
  428. spin_unlock_irqrestore(&ds1286_lock, flags);
  429. BCD_TO_BIN(alm_tm->tm_min);
  430. BCD_TO_BIN(alm_tm->tm_hour);
  431. alm_tm->tm_sec = 0;
  432. }