2 * HP i8042 SDC + MSM-58321 BBRTC driver.
4 * Copyright (c) 2001 Brian S. Julin
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * Alternatively, this software may be distributed under the terms of the
17 * GNU General Public License ("GPL").
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * System Device Controller Microprocessor Firmware Theory of Operation
31 * for Part Number 1820-4784 Revision B. Dwg No. A-1820-4784-2
32 * efirtc.c by Stephane Eranian/Hewlett Packard
36 #include <linux/hp_sdc.h>
37 #include <linux/errno.h>
38 #include <linux/smp_lock.h>
39 #include <linux/types.h>
40 #include <linux/init.h>
41 #include <linux/module.h>
42 #include <linux/time.h>
43 #include <linux/miscdevice.h>
44 #include <linux/proc_fs.h>
45 #include <linux/poll.h>
46 #include <linux/rtc.h>
47 #include <linux/semaphore.h>
49 MODULE_AUTHOR("Brian S. Julin <bri@calyx.com>");
50 MODULE_DESCRIPTION("HP i8042 SDC + MSM-58321 RTC Driver");
51 MODULE_LICENSE("Dual BSD/GPL");
53 #define RTC_VERSION "1.10d"
55 static unsigned long epoch = 2000;
57 static struct semaphore i8042tregs;
59 static hp_sdc_irqhook hp_sdc_rtc_isr;
61 static struct fasync_struct *hp_sdc_rtc_async_queue;
63 static DECLARE_WAIT_QUEUE_HEAD(hp_sdc_rtc_wait);
65 static ssize_t hp_sdc_rtc_read(struct file *file, char __user *buf,
66 size_t count, loff_t *ppos);
68 static int hp_sdc_rtc_ioctl(struct inode *inode, struct file *file,
69 unsigned int cmd, unsigned long arg);
71 static unsigned int hp_sdc_rtc_poll(struct file *file, poll_table *wait);
73 static int hp_sdc_rtc_open(struct inode *inode, struct file *file);
74 static int hp_sdc_rtc_release(struct inode *inode, struct file *file);
75 static int hp_sdc_rtc_fasync (int fd, struct file *filp, int on);
77 static int hp_sdc_rtc_read_proc(char *page, char **start, off_t off,
78 int count, int *eof, void *data);
80 static void hp_sdc_rtc_isr (int irq, void *dev_id,
81 uint8_t status, uint8_t data)
86 static int hp_sdc_rtc_do_read_bbrtc (struct rtc_time *rtctm)
88 struct semaphore tsem;
95 tseq[i++] = HP_SDC_ACT_DATAREG |
96 HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN;
97 tseq[i++] = 0x01; /* write i8042[0x70] */
98 tseq[i] = i / 7; /* BBRTC reg address */
100 tseq[i++] = HP_SDC_CMD_DO_RTCR; /* Trigger command */
101 tseq[i++] = 2; /* expect 1 stat/dat pair back. */
102 i++; i++; /* buffer for stat/dat pair */
104 tseq[84] |= HP_SDC_ACT_SEMAPHORE;
107 t.act.semaphore = &tsem;
108 init_MUTEX_LOCKED(&tsem);
110 if (hp_sdc_enqueue_transaction(&t)) return -1;
112 down_interruptible(&tsem); /* Put ourselves to sleep for results. */
114 /* Check for nonpresence of BBRTC */
115 if (!((tseq[83] | tseq[90] | tseq[69] | tseq[76] |
116 tseq[55] | tseq[62] | tseq[34] | tseq[41] |
117 tseq[20] | tseq[27] | tseq[6] | tseq[13]) & 0x0f))
120 memset(rtctm, 0, sizeof(struct rtc_time));
121 rtctm->tm_year = (tseq[83] & 0x0f) + (tseq[90] & 0x0f) * 10;
122 rtctm->tm_mon = (tseq[69] & 0x0f) + (tseq[76] & 0x0f) * 10;
123 rtctm->tm_mday = (tseq[55] & 0x0f) + (tseq[62] & 0x0f) * 10;
124 rtctm->tm_wday = (tseq[48] & 0x0f);
125 rtctm->tm_hour = (tseq[34] & 0x0f) + (tseq[41] & 0x0f) * 10;
126 rtctm->tm_min = (tseq[20] & 0x0f) + (tseq[27] & 0x0f) * 10;
127 rtctm->tm_sec = (tseq[6] & 0x0f) + (tseq[13] & 0x0f) * 10;
132 static int hp_sdc_rtc_read_bbrtc (struct rtc_time *rtctm)
134 struct rtc_time tm, tm_last;
137 /* MSM-58321 has no read latch, so must read twice and compare. */
139 if (hp_sdc_rtc_do_read_bbrtc(&tm_last)) return -1;
140 if (hp_sdc_rtc_do_read_bbrtc(&tm)) return -1;
142 while (memcmp(&tm, &tm_last, sizeof(struct rtc_time))) {
143 if (i++ > 4) return -1;
144 memcpy(&tm_last, &tm, sizeof(struct rtc_time));
145 if (hp_sdc_rtc_do_read_bbrtc(&tm)) return -1;
148 memcpy(rtctm, &tm, sizeof(struct rtc_time));
154 static int64_t hp_sdc_rtc_read_i8042timer (uint8_t loadcmd, int numreg)
156 hp_sdc_transaction t;
158 HP_SDC_ACT_PRECMD | HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN,
160 HP_SDC_CMD_READ_T1, 2, 0, 0,
161 HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN,
162 HP_SDC_CMD_READ_T2, 2, 0, 0,
163 HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN,
164 HP_SDC_CMD_READ_T3, 2, 0, 0,
165 HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN,
166 HP_SDC_CMD_READ_T4, 2, 0, 0,
167 HP_SDC_ACT_POSTCMD | HP_SDC_ACT_DATAIN,
168 HP_SDC_CMD_READ_T5, 2, 0, 0
171 t.endidx = numreg * 5;
174 tseq[t.endidx - 4] |= HP_SDC_ACT_SEMAPHORE; /* numreg assumed > 1 */
177 t.act.semaphore = &i8042tregs;
179 down_interruptible(&i8042tregs); /* Sleep if output regs in use. */
181 if (hp_sdc_enqueue_transaction(&t)) return -1;
183 down_interruptible(&i8042tregs); /* Sleep until results come back. */
187 ((uint64_t)(tseq[10]) << 8) | ((uint64_t)(tseq[15]) << 16) |
188 ((uint64_t)(tseq[20]) << 24) | ((uint64_t)(tseq[25]) << 32));
192 /* Read the i8042 real-time clock */
193 static inline int hp_sdc_rtc_read_rt(struct timeval *res) {
198 raw = hp_sdc_rtc_read_i8042timer(HP_SDC_CMD_LOAD_RT, 5);
199 if (raw < 0) return -1;
201 tenms = (uint32_t)raw & 0xffffff;
202 days = (unsigned int)(raw >> 24) & 0xffff;
204 res->tv_usec = (suseconds_t)(tenms % 100) * 10000;
205 res->tv_sec = (time_t)(tenms / 100) + days * 86400;
211 /* Read the i8042 fast handshake timer */
212 static inline int hp_sdc_rtc_read_fhs(struct timeval *res) {
216 raw = hp_sdc_rtc_read_i8042timer(HP_SDC_CMD_LOAD_FHS, 2);
217 if (raw < 0) return -1;
219 tenms = (unsigned int)raw & 0xffff;
221 res->tv_usec = (suseconds_t)(tenms % 100) * 10000;
222 res->tv_sec = (time_t)(tenms / 100);
228 /* Read the i8042 match timer (a.k.a. alarm) */
229 static inline int hp_sdc_rtc_read_mt(struct timeval *res) {
233 raw = hp_sdc_rtc_read_i8042timer(HP_SDC_CMD_LOAD_MT, 3);
234 if (raw < 0) return -1;
236 tenms = (uint32_t)raw & 0xffffff;
238 res->tv_usec = (suseconds_t)(tenms % 100) * 10000;
239 res->tv_sec = (time_t)(tenms / 100);
245 /* Read the i8042 delay timer */
246 static inline int hp_sdc_rtc_read_dt(struct timeval *res) {
250 raw = hp_sdc_rtc_read_i8042timer(HP_SDC_CMD_LOAD_DT, 3);
251 if (raw < 0) return -1;
253 tenms = (uint32_t)raw & 0xffffff;
255 res->tv_usec = (suseconds_t)(tenms % 100) * 10000;
256 res->tv_sec = (time_t)(tenms / 100);
262 /* Read the i8042 cycle timer (a.k.a. periodic) */
263 static inline int hp_sdc_rtc_read_ct(struct timeval *res) {
267 raw = hp_sdc_rtc_read_i8042timer(HP_SDC_CMD_LOAD_CT, 3);
268 if (raw < 0) return -1;
270 tenms = (uint32_t)raw & 0xffffff;
272 res->tv_usec = (suseconds_t)(tenms % 100) * 10000;
273 res->tv_sec = (time_t)(tenms / 100);
279 /* Set the i8042 real-time clock */
280 static int hp_sdc_rtc_set_rt (struct timeval *setto)
284 hp_sdc_transaction t;
286 HP_SDC_ACT_PRECMD | HP_SDC_ACT_DATAOUT,
287 HP_SDC_CMD_SET_RTMS, 3, 0, 0, 0,
288 HP_SDC_ACT_PRECMD | HP_SDC_ACT_DATAOUT,
289 HP_SDC_CMD_SET_RTD, 2, 0, 0
294 if (0xffff < setto->tv_sec / 86400) return -1;
295 days = setto->tv_sec / 86400;
296 if (0xffff < setto->tv_usec / 1000000 / 86400) return -1;
297 days += ((setto->tv_sec % 86400) + setto->tv_usec / 1000000) / 86400;
298 if (days > 0xffff) return -1;
300 if (0xffffff < setto->tv_sec) return -1;
301 tenms = setto->tv_sec * 100;
302 if (0xffffff < setto->tv_usec / 10000) return -1;
303 tenms += setto->tv_usec / 10000;
304 if (tenms > 0xffffff) return -1;
306 tseq[3] = (uint8_t)(tenms & 0xff);
307 tseq[4] = (uint8_t)((tenms >> 8) & 0xff);
308 tseq[5] = (uint8_t)((tenms >> 16) & 0xff);
310 tseq[9] = (uint8_t)(days & 0xff);
311 tseq[10] = (uint8_t)((days >> 8) & 0xff);
315 if (hp_sdc_enqueue_transaction(&t)) return -1;
319 /* Set the i8042 fast handshake timer */
320 static int hp_sdc_rtc_set_fhs (struct timeval *setto)
323 hp_sdc_transaction t;
325 HP_SDC_ACT_PRECMD | HP_SDC_ACT_DATAOUT,
326 HP_SDC_CMD_SET_FHS, 2, 0, 0
331 if (0xffff < setto->tv_sec) return -1;
332 tenms = setto->tv_sec * 100;
333 if (0xffff < setto->tv_usec / 10000) return -1;
334 tenms += setto->tv_usec / 10000;
335 if (tenms > 0xffff) return -1;
337 tseq[3] = (uint8_t)(tenms & 0xff);
338 tseq[4] = (uint8_t)((tenms >> 8) & 0xff);
342 if (hp_sdc_enqueue_transaction(&t)) return -1;
347 /* Set the i8042 match timer (a.k.a. alarm) */
348 #define hp_sdc_rtc_set_mt (setto) \
349 hp_sdc_rtc_set_i8042timer(setto, HP_SDC_CMD_SET_MT)
351 /* Set the i8042 delay timer */
352 #define hp_sdc_rtc_set_dt (setto) \
353 hp_sdc_rtc_set_i8042timer(setto, HP_SDC_CMD_SET_DT)
355 /* Set the i8042 cycle timer (a.k.a. periodic) */
356 #define hp_sdc_rtc_set_ct (setto) \
357 hp_sdc_rtc_set_i8042timer(setto, HP_SDC_CMD_SET_CT)
359 /* Set one of the i8042 3-byte wide timers */
360 static int hp_sdc_rtc_set_i8042timer (struct timeval *setto, uint8_t setcmd)
363 hp_sdc_transaction t;
365 HP_SDC_ACT_PRECMD | HP_SDC_ACT_DATAOUT,
371 if (0xffffff < setto->tv_sec) return -1;
372 tenms = setto->tv_sec * 100;
373 if (0xffffff < setto->tv_usec / 10000) return -1;
374 tenms += setto->tv_usec / 10000;
375 if (tenms > 0xffffff) return -1;
378 tseq[3] = (uint8_t)(tenms & 0xff);
379 tseq[4] = (uint8_t)((tenms >> 8) & 0xff);
380 tseq[5] = (uint8_t)((tenms >> 16) & 0xff);
384 if (hp_sdc_enqueue_transaction(&t)) {
390 static ssize_t hp_sdc_rtc_read(struct file *file, char __user *buf,
391 size_t count, loff_t *ppos) {
394 if (count < sizeof(unsigned long))
397 retval = put_user(68, (unsigned long __user *)buf);
401 static unsigned int hp_sdc_rtc_poll(struct file *file, poll_table *wait)
407 return POLLIN | POLLRDNORM;
411 static int hp_sdc_rtc_open(struct inode *inode, struct file *file)
417 static int hp_sdc_rtc_release(struct inode *inode, struct file *file)
419 /* Turn off interrupts? */
421 if (file->f_flags & FASYNC) {
422 hp_sdc_rtc_fasync (-1, file, 0);
428 static int hp_sdc_rtc_fasync (int fd, struct file *filp, int on)
430 return fasync_helper (fd, filp, on, &hp_sdc_rtc_async_queue);
433 static int hp_sdc_rtc_proc_output (char *buf)
435 #define YN(bit) ("no")
436 #define NY(bit) ("yes")
441 memset(&tm, 0, sizeof(struct rtc_time));
445 if (hp_sdc_rtc_read_bbrtc(&tm)) {
446 p += sprintf(p, "BBRTC\t\t: READ FAILED!\n");
449 "rtc_time\t: %02d:%02d:%02d\n"
450 "rtc_date\t: %04d-%02d-%02d\n"
451 "rtc_epoch\t: %04lu\n",
452 tm.tm_hour, tm.tm_min, tm.tm_sec,
453 tm.tm_year + 1900, tm.tm_mon + 1,
457 if (hp_sdc_rtc_read_rt(&tv)) {
458 p += sprintf(p, "i8042 rtc\t: READ FAILED!\n");
460 p += sprintf(p, "i8042 rtc\t: %ld.%02d seconds\n",
461 tv.tv_sec, tv.tv_usec/1000);
464 if (hp_sdc_rtc_read_fhs(&tv)) {
465 p += sprintf(p, "handshake\t: READ FAILED!\n");
467 p += sprintf(p, "handshake\t: %ld.%02d seconds\n",
468 tv.tv_sec, tv.tv_usec/1000);
471 if (hp_sdc_rtc_read_mt(&tv)) {
472 p += sprintf(p, "alarm\t\t: READ FAILED!\n");
474 p += sprintf(p, "alarm\t\t: %ld.%02d seconds\n",
475 tv.tv_sec, tv.tv_usec/1000);
478 if (hp_sdc_rtc_read_dt(&tv)) {
479 p += sprintf(p, "delay\t\t: READ FAILED!\n");
481 p += sprintf(p, "delay\t\t: %ld.%02d seconds\n",
482 tv.tv_sec, tv.tv_usec/1000);
485 if (hp_sdc_rtc_read_ct(&tv)) {
486 p += sprintf(p, "periodic\t: READ FAILED!\n");
488 p += sprintf(p, "periodic\t: %ld.%02d seconds\n",
489 tv.tv_sec, tv.tv_usec/1000);
496 "square_wave\t: %s\n"
499 "periodic_IRQ\t: %s\n"
500 "periodic_freq\t: %ld\n"
501 "batt_status\t: %s\n",
510 1 ? "okay" : "dead");
517 static int hp_sdc_rtc_read_proc(char *page, char **start, off_t off,
518 int count, int *eof, void *data)
520 int len = hp_sdc_rtc_proc_output (page);
521 if (len <= off+count) *eof = 1;
524 if (len>count) len = count;
529 static int hp_sdc_rtc_ioctl(struct inode *inode, struct file *file,
530 unsigned int cmd, unsigned long arg)
536 struct rtc_time wtime;
537 struct timeval ttime;
540 /* This needs major work. */
544 case RTC_AIE_OFF: /* Mask alarm int. enab. bit */
545 case RTC_AIE_ON: /* Allow alarm interrupts. */
546 case RTC_PIE_OFF: /* Mask periodic int. enab. bit */
547 case RTC_PIE_ON: /* Allow periodic ints */
548 case RTC_UIE_ON: /* Allow ints for RTC updates. */
549 case RTC_UIE_OFF: /* Allow ints for RTC updates. */
551 /* We cannot mask individual user timers and we
552 cannot tell them apart when they occur, so it
553 would be disingenuous to succeed these IOCTLs */
556 case RTC_ALM_READ: /* Read the present alarm time */
558 if (hp_sdc_rtc_read_mt(&ttime)) return -EFAULT;
559 if (hp_sdc_rtc_read_bbrtc(&wtime)) return -EFAULT;
561 wtime.tm_hour = ttime.tv_sec / 3600; ttime.tv_sec %= 3600;
562 wtime.tm_min = ttime.tv_sec / 60; ttime.tv_sec %= 60;
563 wtime.tm_sec = ttime.tv_sec;
567 case RTC_IRQP_READ: /* Read the periodic IRQ rate. */
569 return put_user(hp_sdc_rtc_freq, (unsigned long *)arg);
571 case RTC_IRQP_SET: /* Set periodic IRQ rate. */
574 * The max we can do is 100Hz.
577 if ((arg < 1) || (arg > 100)) return -EINVAL;
579 ttime.tv_usec = 1000000 / arg;
580 if (hp_sdc_rtc_set_ct(&ttime)) return -EFAULT;
581 hp_sdc_rtc_freq = arg;
584 case RTC_ALM_SET: /* Store a time into the alarm */
587 * This expects a struct hp_sdc_rtc_time. Writing 0xff means
588 * "don't care" or "match all" for PC timers. The HP SDC
589 * does not support that perk, but it could be emulated fairly
590 * easily. Only the tm_hour, tm_min and tm_sec are used.
591 * We could do it with 10ms accuracy with the HP SDC, if the
592 * rtc interface left us a way to do that.
594 struct hp_sdc_rtc_time alm_tm;
596 if (copy_from_user(&alm_tm, (struct hp_sdc_rtc_time*)arg,
597 sizeof(struct hp_sdc_rtc_time)))
600 if (alm_tm.tm_hour > 23) return -EINVAL;
601 if (alm_tm.tm_min > 59) return -EINVAL;
602 if (alm_tm.tm_sec > 59) return -EINVAL;
604 ttime.sec = alm_tm.tm_hour * 3600 +
605 alm_tm.tm_min * 60 + alm_tm.tm_sec;
607 if (hp_sdc_rtc_set_mt(&ttime)) return -EFAULT;
610 case RTC_RD_TIME: /* Read the time/date from RTC */
612 if (hp_sdc_rtc_read_bbrtc(&wtime)) return -EFAULT;
615 case RTC_SET_TIME: /* Set the RTC */
617 struct rtc_time hp_sdc_rtc_tm;
618 unsigned char mon, day, hrs, min, sec, leap_yr;
621 if (!capable(CAP_SYS_TIME))
623 if (copy_from_user(&hp_sdc_rtc_tm, (struct rtc_time *)arg,
624 sizeof(struct rtc_time)))
627 yrs = hp_sdc_rtc_tm.tm_year + 1900;
628 mon = hp_sdc_rtc_tm.tm_mon + 1; /* tm_mon starts at zero */
629 day = hp_sdc_rtc_tm.tm_mday;
630 hrs = hp_sdc_rtc_tm.tm_hour;
631 min = hp_sdc_rtc_tm.tm_min;
632 sec = hp_sdc_rtc_tm.tm_sec;
637 leap_yr = ((!(yrs % 4) && (yrs % 100)) || !(yrs % 400));
639 if ((mon > 12) || (day == 0))
641 if (day > (days_in_mo[mon] + ((mon == 2) && leap_yr)))
643 if ((hrs >= 24) || (min >= 60) || (sec >= 60))
646 if ((yrs -= eH) > 255) /* They are unsigned */
652 case RTC_EPOCH_READ: /* Read the epoch. */
654 return put_user (epoch, (unsigned long *)arg);
656 case RTC_EPOCH_SET: /* Set the epoch. */
659 * There were no RTC clocks before 1900.
663 if (!capable(CAP_SYS_TIME))
672 return copy_to_user((void *)arg, &wtime, sizeof wtime) ? -EFAULT : 0;
676 static const struct file_operations hp_sdc_rtc_fops = {
677 .owner = THIS_MODULE,
679 .read = hp_sdc_rtc_read,
680 .poll = hp_sdc_rtc_poll,
681 .ioctl = hp_sdc_rtc_ioctl,
682 .open = hp_sdc_rtc_open,
683 .release = hp_sdc_rtc_release,
684 .fasync = hp_sdc_rtc_fasync,
687 static struct miscdevice hp_sdc_rtc_dev = {
690 .fops = &hp_sdc_rtc_fops
693 static int __init hp_sdc_rtc_init(void)
702 init_MUTEX(&i8042tregs);
704 if ((ret = hp_sdc_request_timer_irq(&hp_sdc_rtc_isr)))
706 if (misc_register(&hp_sdc_rtc_dev) != 0)
707 printk(KERN_INFO "Could not register misc. dev for i8042 rtc\n");
709 create_proc_read_entry ("driver/rtc", 0, NULL,
710 hp_sdc_rtc_read_proc, NULL);
712 printk(KERN_INFO "HP i8042 SDC + MSM-58321 RTC support loaded "
713 "(RTC v " RTC_VERSION ")\n");
718 static void __exit hp_sdc_rtc_exit(void)
720 remove_proc_entry ("driver/rtc", NULL);
721 misc_deregister(&hp_sdc_rtc_dev);
722 hp_sdc_release_timer_irq(hp_sdc_rtc_isr);
723 printk(KERN_INFO "HP i8042 SDC + MSM-58321 RTC support unloaded\n");
726 module_init(hp_sdc_rtc_init);
727 module_exit(hp_sdc_rtc_exit);