2 * Watchdog Timer Driver
3 * for ITE IT87xx Environment Control - Low Pin Count Input / Output
7 * Based on softdog.c by Alan Cox,
8 * 83977f_wdt.c by Jose Goncalves,
9 * it87.c by Chris Gauthron, Jean Delvare
11 * Data-sheets: Publicly available at the ITE website
12 * http://www.ite.com.tw/
14 * Support of the watchdog timers, which are available on
15 * IT8620, IT8702, IT8712, IT8716, IT8718, IT8720, IT8721, IT8726,
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License
20 * as published by the Free Software Foundation; either version
21 * 2 of the License, or (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/types.h>
38 #include <linux/kernel.h>
40 #include <linux/miscdevice.h>
41 #include <linux/init.h>
42 #include <linux/ioport.h>
43 #include <linux/watchdog.h>
44 #include <linux/notifier.h>
45 #include <linux/reboot.h>
46 #include <linux/uaccess.h>
50 #define WATCHDOG_VERSION "1.14"
51 #define WATCHDOG_NAME "IT87 WDT"
52 #define DRIVER_VERSION WATCHDOG_NAME " driver, v" WATCHDOG_VERSION "\n"
55 /* Defaults for Module Parameter */
56 #define DEFAULT_NOGAMEPORT 0
57 #define DEFAULT_NOCIR 0
58 #define DEFAULT_EXCLUSIVE 1
59 #define DEFAULT_TIMEOUT 60
60 #define DEFAULT_TESTMODE 0
61 #define DEFAULT_NOWAYOUT WATCHDOG_NOWAYOUT
67 /* Logical device Numbers LDN */
72 /* Configuration Registers and Functions */
80 #define NO_DEV_ID 0xffff
81 #define IT8620_ID 0x8620
82 #define IT8702_ID 0x8702
83 #define IT8705_ID 0x8705
84 #define IT8712_ID 0x8712
85 #define IT8716_ID 0x8716
86 #define IT8718_ID 0x8718
87 #define IT8720_ID 0x8720
88 #define IT8721_ID 0x8721
89 #define IT8726_ID 0x8726 /* the data sheet suggest wrongly 0x8716 */
90 #define IT8728_ID 0x8728
91 #define IT8783_ID 0x8783
93 /* GPIO Configuration Registers LDN=0x07 */
96 #define WDTVALLSB 0x73
97 #define WDTVALMSB 0x74
99 /* GPIO Bits WDTCTRL */
100 #define WDT_CIRINT 0x80
101 #define WDT_MOUSEINT 0x40
102 #define WDT_KYBINT 0x20
103 #define WDT_GAMEPORT 0x10 /* not in it8718, it8720, it8721, it8728 */
104 #define WDT_FORCE 0x02
105 #define WDT_ZERO 0x01
107 /* GPIO Bits WDTCFG */
108 #define WDT_TOV1 0x80
109 #define WDT_KRST 0x40
110 #define WDT_TOVE 0x20
111 #define WDT_PWROK 0x10 /* not in it8721 */
112 #define WDT_INT_MASK 0x0f
114 /* CIR Configuration Register LDN=0x0a */
117 /* The default Base address is not always available, we use this */
118 #define CIR_BASE 0x0208
121 #define CIR_DR(b) (b)
122 #define CIR_IER(b) (b + 1)
123 #define CIR_RCR(b) (b + 2)
124 #define CIR_TCR1(b) (b + 3)
125 #define CIR_TCR2(b) (b + 4)
126 #define CIR_TSR(b) (b + 5)
127 #define CIR_RSR(b) (b + 6)
128 #define CIR_BDLR(b) (b + 5)
129 #define CIR_BDHR(b) (b + 6)
130 #define CIR_IIR(b) (b + 7)
132 /* Default Base address of Game port */
133 #define GP_BASE_DEFAULT 0x0201
136 #define WDTS_TIMER_RUN 0
137 #define WDTS_DEV_OPEN 1
138 #define WDTS_KEEPALIVE 2
139 #define WDTS_LOCKED 3
140 #define WDTS_USE_GP 4
141 #define WDTS_EXPECTED 5
142 #define WDTS_USE_CIR 6
144 static unsigned int base, gpact, ciract, max_units, chip_type;
145 static unsigned long wdt_status;
147 static int nogameport = DEFAULT_NOGAMEPORT;
148 static int nocir = DEFAULT_NOCIR;
149 static int exclusive = DEFAULT_EXCLUSIVE;
150 static int timeout = DEFAULT_TIMEOUT;
151 static int testmode = DEFAULT_TESTMODE;
152 static bool nowayout = DEFAULT_NOWAYOUT;
154 module_param(nogameport, int, 0);
155 MODULE_PARM_DESC(nogameport, "Forbid the activation of game port, default="
156 __MODULE_STRING(DEFAULT_NOGAMEPORT));
157 module_param(nocir, int, 0);
158 MODULE_PARM_DESC(nocir, "Forbid the use of Consumer IR interrupts to reset timer, default="
159 __MODULE_STRING(DEFAULT_NOCIR));
160 module_param(exclusive, int, 0);
161 MODULE_PARM_DESC(exclusive, "Watchdog exclusive device open, default="
162 __MODULE_STRING(DEFAULT_EXCLUSIVE));
163 module_param(timeout, int, 0);
164 MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds, default="
165 __MODULE_STRING(DEFAULT_TIMEOUT));
166 module_param(testmode, int, 0);
167 MODULE_PARM_DESC(testmode, "Watchdog test mode (1 = no reboot), default="
168 __MODULE_STRING(DEFAULT_TESTMODE));
169 module_param(nowayout, bool, 0);
170 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started, default="
171 __MODULE_STRING(WATCHDOG_NOWAYOUT));
175 static inline int superio_enter(void)
178 * Try to reserve REG and REG + 1 for exclusive access.
180 if (!request_muxed_region(REG, 2, WATCHDOG_NAME))
190 static inline void superio_exit(void)
194 release_region(REG, 2);
197 static inline void superio_select(int ldn)
203 static inline int superio_inb(int reg)
209 static inline void superio_outb(int val, int reg)
215 static inline int superio_inw(int reg)
225 static inline void superio_outw(int val, int reg)
233 /* Internal function, should be called after superio_select(GPIO) */
234 static void wdt_update_timeout(void)
236 unsigned char cfg = WDT_KRST;
247 if (chip_type != IT8721_ID)
250 superio_outb(cfg, WDTCFG);
251 superio_outb(tm, WDTVALLSB);
253 superio_outb(tm>>8, WDTVALMSB);
256 static int wdt_round_time(int t)
263 /* watchdog timer handling */
265 static void wdt_keepalive(void)
267 if (test_bit(WDTS_USE_GP, &wdt_status))
269 else if (test_bit(WDTS_USE_CIR, &wdt_status))
270 /* The timer reloads with around 5 msec delay */
271 outb(0x55, CIR_DR(base));
276 superio_select(GPIO);
277 wdt_update_timeout();
280 set_bit(WDTS_KEEPALIVE, &wdt_status);
283 static int wdt_start(void)
285 int ret = superio_enter();
289 superio_select(GPIO);
290 if (test_bit(WDTS_USE_GP, &wdt_status))
291 superio_outb(WDT_GAMEPORT, WDTCTRL);
292 else if (test_bit(WDTS_USE_CIR, &wdt_status))
293 superio_outb(WDT_CIRINT, WDTCTRL);
294 wdt_update_timeout();
301 static int wdt_stop(void)
303 int ret = superio_enter();
307 superio_select(GPIO);
308 superio_outb(0x00, WDTCTRL);
309 superio_outb(WDT_TOV1, WDTCFG);
310 superio_outb(0x00, WDTVALLSB);
312 superio_outb(0x00, WDTVALMSB);
319 * wdt_set_timeout - set a new timeout value with watchdog ioctl
320 * @t: timeout value in seconds
322 * The hardware device has a 8 or 16 bit watchdog timer (depends on
323 * chip version) that can be configured to count seconds or minutes.
325 * Used within WDIOC_SETTIMEOUT watchdog device ioctl.
328 static int wdt_set_timeout(int t)
330 if (t < 1 || t > max_units * 60)
334 timeout = wdt_round_time(t);
338 if (test_bit(WDTS_TIMER_RUN, &wdt_status)) {
339 int ret = superio_enter();
343 superio_select(GPIO);
344 wdt_update_timeout();
351 * wdt_get_status - determines the status supported by watchdog ioctl
352 * @status: status returned to user space
354 * The status bit of the device does not allow to distinguish
355 * between a regular system reset and a watchdog forced reset.
356 * But, in test mode it is useful, so it is supported through
357 * WDIOC_GETSTATUS watchdog ioctl. Additionally the driver
358 * reports the keepalive signal and the acception of the magic.
360 * Used within WDIOC_GETSTATUS watchdog device ioctl.
363 static int wdt_get_status(int *status)
367 int ret = superio_enter();
371 superio_select(GPIO);
372 if (superio_inb(WDTCTRL) & WDT_ZERO) {
373 superio_outb(0x00, WDTCTRL);
374 clear_bit(WDTS_TIMER_RUN, &wdt_status);
375 *status |= WDIOF_CARDRESET;
380 if (test_and_clear_bit(WDTS_KEEPALIVE, &wdt_status))
381 *status |= WDIOF_KEEPALIVEPING;
382 if (test_bit(WDTS_EXPECTED, &wdt_status))
383 *status |= WDIOF_MAGICCLOSE;
387 /* /dev/watchdog handling */
390 * wdt_open - watchdog file_operations .open
391 * @inode: inode of the device
392 * @file: file handle to the device
394 * The watchdog timer starts by opening the device.
396 * Used within the file operation of the watchdog device.
399 static int wdt_open(struct inode *inode, struct file *file)
401 if (exclusive && test_and_set_bit(WDTS_DEV_OPEN, &wdt_status))
403 if (!test_and_set_bit(WDTS_TIMER_RUN, &wdt_status)) {
405 if (nowayout && !test_and_set_bit(WDTS_LOCKED, &wdt_status))
406 __module_get(THIS_MODULE);
410 clear_bit(WDTS_LOCKED, &wdt_status);
411 clear_bit(WDTS_TIMER_RUN, &wdt_status);
412 clear_bit(WDTS_DEV_OPEN, &wdt_status);
416 return nonseekable_open(inode, file);
420 * wdt_release - watchdog file_operations .release
421 * @inode: inode of the device
422 * @file: file handle to the device
424 * Closing the watchdog device either stops the watchdog timer
425 * or in the case, that nowayout is set or the magic character
426 * wasn't written, a critical warning about an running watchdog
429 * Used within the file operation of the watchdog device.
432 static int wdt_release(struct inode *inode, struct file *file)
434 if (test_bit(WDTS_TIMER_RUN, &wdt_status)) {
435 if (test_and_clear_bit(WDTS_EXPECTED, &wdt_status)) {
436 int ret = wdt_stop();
439 * Stop failed. Just keep the watchdog alive
440 * and hope nothing bad happens.
442 set_bit(WDTS_EXPECTED, &wdt_status);
446 clear_bit(WDTS_TIMER_RUN, &wdt_status);
449 pr_crit("unexpected close, not stopping watchdog!\n");
452 clear_bit(WDTS_DEV_OPEN, &wdt_status);
457 * wdt_write - watchdog file_operations .write
458 * @file: file handle to the watchdog
459 * @buf: buffer to write
460 * @count: count of bytes
461 * @ppos: pointer to the position to write. No seeks allowed
463 * A write to a watchdog device is defined as a keepalive signal. Any
464 * write of data will do, as we don't define content meaning.
466 * Used within the file operation of the watchdog device.
469 static ssize_t wdt_write(struct file *file, const char __user *buf,
470 size_t count, loff_t *ppos)
473 clear_bit(WDTS_EXPECTED, &wdt_status);
479 /* note: just in case someone wrote the magic character long ago */
480 for (ofs = 0; ofs != count; ofs++) {
482 if (get_user(c, buf + ofs))
485 set_bit(WDTS_EXPECTED, &wdt_status);
491 static const struct watchdog_info ident = {
492 .options = WDIOF_SETTIMEOUT | WDIOF_MAGICCLOSE | WDIOF_KEEPALIVEPING,
493 .firmware_version = 1,
494 .identity = WATCHDOG_NAME,
498 * wdt_ioctl - watchdog file_operations .unlocked_ioctl
499 * @file: file handle to the device
500 * @cmd: watchdog command
501 * @arg: argument pointer
503 * The watchdog API defines a common set of functions for all watchdogs
504 * according to their available features.
506 * Used within the file operation of the watchdog device.
509 static long wdt_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
511 int rc = 0, status, new_options, new_timeout;
513 struct watchdog_info __user *ident;
517 uarg.i = (int __user *)arg;
520 case WDIOC_GETSUPPORT:
521 return copy_to_user(uarg.ident,
522 &ident, sizeof(ident)) ? -EFAULT : 0;
524 case WDIOC_GETSTATUS:
525 rc = wdt_get_status(&status);
528 return put_user(status, uarg.i);
530 case WDIOC_GETBOOTSTATUS:
531 return put_user(0, uarg.i);
533 case WDIOC_KEEPALIVE:
537 case WDIOC_SETOPTIONS:
538 if (get_user(new_options, uarg.i))
541 switch (new_options) {
542 case WDIOS_DISABLECARD:
543 if (test_bit(WDTS_TIMER_RUN, &wdt_status)) {
548 clear_bit(WDTS_TIMER_RUN, &wdt_status);
551 case WDIOS_ENABLECARD:
552 if (!test_and_set_bit(WDTS_TIMER_RUN, &wdt_status)) {
555 clear_bit(WDTS_TIMER_RUN, &wdt_status);
565 case WDIOC_SETTIMEOUT:
566 if (get_user(new_timeout, uarg.i))
568 rc = wdt_set_timeout(new_timeout);
569 case WDIOC_GETTIMEOUT:
570 if (put_user(timeout, uarg.i))
579 static int wdt_notify_sys(struct notifier_block *this, unsigned long code,
582 if (code == SYS_DOWN || code == SYS_HALT)
587 static const struct file_operations wdt_fops = {
588 .owner = THIS_MODULE,
591 .unlocked_ioctl = wdt_ioctl,
593 .release = wdt_release,
596 static struct miscdevice wdt_miscdev = {
597 .minor = WATCHDOG_MINOR,
602 static struct notifier_block wdt_notifier = {
603 .notifier_call = wdt_notify_sys,
606 static int __init it87_wdt_init(void)
609 int try_gameport = !nogameport;
611 int gp_rreq_fail = 0;
615 rc = superio_enter();
619 chip_type = superio_inw(CHIPID);
620 chip_rev = superio_inb(CHIPREV) & 0x0f;
628 max_units = (chip_rev < 8) ? 255 : 65535;
644 pr_err("Unsupported Chip found, Chip %04x Revision %02x\n",
645 chip_type, chip_rev);
648 pr_err("no device\n");
651 pr_err("Unknown Chip found, Chip %04x Revision %04x\n",
652 chip_type, chip_rev);
656 rc = superio_enter();
660 superio_select(GPIO);
661 superio_outb(WDT_TOV1, WDTCFG);
662 superio_outb(0x00, WDTCTRL);
664 /* First try to get Gameport support */
666 superio_select(GAMEPORT);
667 base = superio_inw(BASEREG);
669 base = GP_BASE_DEFAULT;
670 superio_outw(base, BASEREG);
672 gpact = superio_inb(ACTREG);
673 superio_outb(0x01, ACTREG);
674 if (request_region(base, 1, WATCHDOG_NAME))
675 set_bit(WDTS_USE_GP, &wdt_status);
680 /* If we haven't Gameport support, try to get CIR support */
681 if (!nocir && !test_bit(WDTS_USE_GP, &wdt_status)) {
682 if (!request_region(CIR_BASE, 8, WATCHDOG_NAME)) {
684 pr_err("I/O Address 0x%04x and 0x%04x already in use\n",
687 pr_err("I/O Address 0x%04x already in use\n",
695 superio_outw(base, BASEREG);
696 superio_outb(0x00, CIR_ILS);
697 ciract = superio_inb(ACTREG);
698 superio_outb(0x01, ACTREG);
700 superio_select(GAMEPORT);
701 superio_outb(gpact, ACTREG);
703 set_bit(WDTS_USE_CIR, &wdt_status);
706 if (timeout < 1 || timeout > max_units * 60) {
707 timeout = DEFAULT_TIMEOUT;
708 pr_warn("Timeout value out of range, use default %d sec\n",
712 if (timeout > max_units)
713 timeout = wdt_round_time(timeout);
715 rc = register_reboot_notifier(&wdt_notifier);
717 pr_err("Cannot register reboot notifier (err=%d)\n", rc);
721 rc = misc_register(&wdt_miscdev);
723 pr_err("Cannot register miscdev on minor=%d (err=%d)\n",
724 wdt_miscdev.minor, rc);
728 /* Initialize CIR to use it as keepalive source */
729 if (test_bit(WDTS_USE_CIR, &wdt_status)) {
730 outb(0x00, CIR_RCR(base));
731 outb(0xc0, CIR_TCR1(base));
732 outb(0x5c, CIR_TCR2(base));
733 outb(0x10, CIR_IER(base));
734 outb(0x00, CIR_BDHR(base));
735 outb(0x01, CIR_BDLR(base));
736 outb(0x09, CIR_IER(base));
739 pr_info("Chip IT%04x revision %d initialized. timeout=%d sec (nowayout=%d testmode=%d exclusive=%d nogameport=%d nocir=%d)\n",
740 chip_type, chip_rev, timeout,
741 nowayout, testmode, exclusive, nogameport, nocir);
747 unregister_reboot_notifier(&wdt_notifier);
749 if (test_bit(WDTS_USE_GP, &wdt_status))
750 release_region(base, 1);
751 else if (test_bit(WDTS_USE_CIR, &wdt_status)) {
752 release_region(base, 8);
754 superio_outb(ciract, ACTREG);
758 superio_select(GAMEPORT);
759 superio_outb(gpact, ACTREG);
766 static void __exit it87_wdt_exit(void)
768 if (superio_enter() == 0) {
769 superio_select(GPIO);
770 superio_outb(0x00, WDTCTRL);
771 superio_outb(0x00, WDTCFG);
772 superio_outb(0x00, WDTVALLSB);
774 superio_outb(0x00, WDTVALMSB);
775 if (test_bit(WDTS_USE_GP, &wdt_status)) {
776 superio_select(GAMEPORT);
777 superio_outb(gpact, ACTREG);
778 } else if (test_bit(WDTS_USE_CIR, &wdt_status)) {
780 superio_outb(ciract, ACTREG);
785 misc_deregister(&wdt_miscdev);
786 unregister_reboot_notifier(&wdt_notifier);
788 if (test_bit(WDTS_USE_GP, &wdt_status))
789 release_region(base, 1);
790 else if (test_bit(WDTS_USE_CIR, &wdt_status))
791 release_region(base, 8);
794 module_init(it87_wdt_init);
795 module_exit(it87_wdt_exit);
797 MODULE_AUTHOR("Oliver Schuster");
798 MODULE_DESCRIPTION("Hardware Watchdog Device Driver for IT87xx EC-LPC I/O");
799 MODULE_LICENSE("GPL");