ds1286.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:13k
源码类别:

嵌入式Linux

开发平台:

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