2 * Watchdog Timer Driver
3 * for ITE IT87xx Environment Control - Low Pin Count Input / Output
5 * (c) Copyright 2007 Oliver Schuster <olivers137@aol.com>
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 * IT8702, IT8712, IT8716, IT8718, IT8720 and IT8726.
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License
19 * as published by the Free Software Foundation; either version
20 * 2 of the License, or (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/types.h>
35 #include <linux/kernel.h>
37 #include <linux/miscdevice.h>
38 #include <linux/init.h>
39 #include <linux/ioport.h>
40 #include <linux/watchdog.h>
41 #include <linux/notifier.h>
42 #include <linux/reboot.h>
43 #include <linux/uaccess.h>
46 #include <asm/system.h>
48 #define WATCHDOG_VERSION "1.13"
49 #define WATCHDOG_NAME "IT87 WDT"
50 #define PFX WATCHDOG_NAME ": "
51 #define DRIVER_VERSION WATCHDOG_NAME " driver, v" WATCHDOG_VERSION "\n"
54 /* Defaults for Module Parameter */
55 #define DEFAULT_NOGAMEPORT 0
56 #define DEFAULT_EXCLUSIVE 1
57 #define DEFAULT_TIMEOUT 60
58 #define DEFAULT_TESTMODE 0
59 #define DEFAULT_NOWAYOUT WATCHDOG_NOWAYOUT
65 /* Logical device Numbers LDN */
70 /* Configuration Registers and Functions */
78 #define NO_DEV_ID 0xffff
79 #define IT8702_ID 0x8702
80 #define IT8705_ID 0x8705
81 #define IT8712_ID 0x8712
82 #define IT8716_ID 0x8716
83 #define IT8718_ID 0x8718
84 #define IT8720_ID 0x8720
85 #define IT8726_ID 0x8726 /* the data sheet suggest wrongly 0x8716 */
87 /* GPIO Configuration Registers LDN=0x07 */
90 #define WDTVALLSB 0x73
91 #define WDTVALMSB 0x74
93 /* GPIO Bits WDTCTRL */
94 #define WDT_CIRINT 0x80
95 #define WDT_MOUSEINT 0x40
96 #define WDT_KYBINT 0x20
97 #define WDT_GAMEPORT 0x10 /* not in it8718, it8720 */
98 #define WDT_FORCE 0x02
101 /* GPIO Bits WDTCFG */
102 #define WDT_TOV1 0x80
103 #define WDT_KRST 0x40
104 #define WDT_TOVE 0x20
105 #define WDT_PWROK 0x10
106 #define WDT_INT_MASK 0x0f
108 /* CIR Configuration Register LDN=0x0a */
111 /* The default Base address is not always available, we use this */
112 #define CIR_BASE 0x0208
115 #define CIR_DR(b) (b)
116 #define CIR_IER(b) (b + 1)
117 #define CIR_RCR(b) (b + 2)
118 #define CIR_TCR1(b) (b + 3)
119 #define CIR_TCR2(b) (b + 4)
120 #define CIR_TSR(b) (b + 5)
121 #define CIR_RSR(b) (b + 6)
122 #define CIR_BDLR(b) (b + 5)
123 #define CIR_BDHR(b) (b + 6)
124 #define CIR_IIR(b) (b + 7)
126 /* Default Base address of Game port */
127 #define GP_BASE_DEFAULT 0x0201
130 #define WDTS_TIMER_RUN 0
131 #define WDTS_DEV_OPEN 1
132 #define WDTS_KEEPALIVE 2
133 #define WDTS_LOCKED 3
134 #define WDTS_USE_GP 4
135 #define WDTS_EXPECTED 5
137 static unsigned int base
, gpact
, ciract
, max_units
;
138 static unsigned long wdt_status
;
139 static DEFINE_SPINLOCK(spinlock
);
141 static int nogameport
= DEFAULT_NOGAMEPORT
;
142 static int exclusive
= DEFAULT_EXCLUSIVE
;
143 static int timeout
= DEFAULT_TIMEOUT
;
144 static int testmode
= DEFAULT_TESTMODE
;
145 static int nowayout
= DEFAULT_NOWAYOUT
;
147 module_param(nogameport
, int, 0);
148 MODULE_PARM_DESC(nogameport
, "Forbid the activation of game port, default="
149 __MODULE_STRING(DEFAULT_NOGAMEPORT
));
150 module_param(exclusive
, int, 0);
151 MODULE_PARM_DESC(exclusive
, "Watchdog exclusive device open, default="
152 __MODULE_STRING(DEFAULT_EXCLUSIVE
));
153 module_param(timeout
, int, 0);
154 MODULE_PARM_DESC(timeout
, "Watchdog timeout in seconds, default="
155 __MODULE_STRING(DEFAULT_TIMEOUT
));
156 module_param(testmode
, int, 0);
157 MODULE_PARM_DESC(testmode
, "Watchdog test mode (1 = no reboot), default="
158 __MODULE_STRING(DEFAULT_TESTMODE
));
159 module_param(nowayout
, int, 0);
160 MODULE_PARM_DESC(nowayout
, "Watchdog cannot be stopped once started, default="
161 __MODULE_STRING(WATCHDOG_NOWAYOUT
));
165 static inline void superio_enter(void)
173 static inline void superio_exit(void)
179 static inline void superio_select(int ldn
)
185 static inline int superio_inb(int reg
)
191 static inline void superio_outb(int val
, int reg
)
197 static inline int superio_inw(int reg
)
207 static inline void superio_outw(int val
, int reg
)
215 /* Internal function, should be called after superio_select(GPIO) */
216 static void wdt_update_timeout(void)
218 unsigned char cfg
= WDT_KRST
| WDT_PWROK
;
229 superio_outb(cfg
, WDTCFG
);
230 superio_outb(tm
, WDTVALLSB
);
232 superio_outb(tm
>>8, WDTVALMSB
);
235 static int wdt_round_time(int t
)
242 /* watchdog timer handling */
244 static void wdt_keepalive(void)
246 if (test_bit(WDTS_USE_GP
, &wdt_status
))
249 /* The timer reloads with around 5 msec delay */
250 outb(0x55, CIR_DR(base
));
251 set_bit(WDTS_KEEPALIVE
, &wdt_status
);
254 static void wdt_start(void)
258 spin_lock_irqsave(&spinlock
, flags
);
261 superio_select(GPIO
);
262 if (test_bit(WDTS_USE_GP
, &wdt_status
))
263 superio_outb(WDT_GAMEPORT
, WDTCTRL
);
265 superio_outb(WDT_CIRINT
, WDTCTRL
);
266 wdt_update_timeout();
269 spin_unlock_irqrestore(&spinlock
, flags
);
272 static void wdt_stop(void)
276 spin_lock_irqsave(&spinlock
, flags
);
279 superio_select(GPIO
);
280 superio_outb(0x00, WDTCTRL
);
281 superio_outb(WDT_TOV1
, WDTCFG
);
282 superio_outb(0x00, WDTVALLSB
);
284 superio_outb(0x00, WDTVALMSB
);
287 spin_unlock_irqrestore(&spinlock
, flags
);
291 * wdt_set_timeout - set a new timeout value with watchdog ioctl
292 * @t: timeout value in seconds
294 * The hardware device has a 8 or 16 bit watchdog timer (depends on
295 * chip version) that can be configured to count seconds or minutes.
297 * Used within WDIOC_SETTIMEOUT watchdog device ioctl.
300 static int wdt_set_timeout(int t
)
304 if (t
< 1 || t
> max_units
* 60)
308 timeout
= wdt_round_time(t
);
312 spin_lock_irqsave(&spinlock
, flags
);
313 if (test_bit(WDTS_TIMER_RUN
, &wdt_status
)) {
315 superio_select(GPIO
);
316 wdt_update_timeout();
319 spin_unlock_irqrestore(&spinlock
, flags
);
324 * wdt_get_status - determines the status supported by watchdog ioctl
325 * @status: status returned to user space
327 * The status bit of the device does not allow to distinguish
328 * between a regular system reset and a watchdog forced reset.
329 * But, in test mode it is useful, so it is supported through
330 * WDIOC_GETSTATUS watchdog ioctl. Additionally the driver
331 * reports the keepalive signal and the acception of the magic.
333 * Used within WDIOC_GETSTATUS watchdog device ioctl.
336 static int wdt_get_status(int *status
)
342 spin_lock_irqsave(&spinlock
, flags
);
344 superio_select(GPIO
);
345 if (superio_inb(WDTCTRL
) & WDT_ZERO
) {
346 superio_outb(0x00, WDTCTRL
);
347 clear_bit(WDTS_TIMER_RUN
, &wdt_status
);
348 *status
|= WDIOF_CARDRESET
;
352 spin_unlock_irqrestore(&spinlock
, flags
);
354 if (test_and_clear_bit(WDTS_KEEPALIVE
, &wdt_status
))
355 *status
|= WDIOF_KEEPALIVEPING
;
356 if (test_bit(WDTS_EXPECTED
, &wdt_status
))
357 *status
|= WDIOF_MAGICCLOSE
;
361 /* /dev/watchdog handling */
364 * wdt_open - watchdog file_operations .open
365 * @inode: inode of the device
366 * @file: file handle to the device
368 * The watchdog timer starts by opening the device.
370 * Used within the file operation of the watchdog device.
373 static int wdt_open(struct inode
*inode
, struct file
*file
)
375 if (exclusive
&& test_and_set_bit(WDTS_DEV_OPEN
, &wdt_status
))
377 if (!test_and_set_bit(WDTS_TIMER_RUN
, &wdt_status
)) {
378 if (nowayout
&& !test_and_set_bit(WDTS_LOCKED
, &wdt_status
))
379 __module_get(THIS_MODULE
);
382 return nonseekable_open(inode
, file
);
386 * wdt_release - watchdog file_operations .release
387 * @inode: inode of the device
388 * @file: file handle to the device
390 * Closing the watchdog device either stops the watchdog timer
391 * or in the case, that nowayout is set or the magic character
392 * wasn't written, a critical warning about an running watchdog
395 * Used within the file operation of the watchdog device.
398 static int wdt_release(struct inode
*inode
, struct file
*file
)
400 if (test_bit(WDTS_TIMER_RUN
, &wdt_status
)) {
401 if (test_and_clear_bit(WDTS_EXPECTED
, &wdt_status
)) {
403 clear_bit(WDTS_TIMER_RUN
, &wdt_status
);
407 "unexpected close, not stopping watchdog!\n");
410 clear_bit(WDTS_DEV_OPEN
, &wdt_status
);
415 * wdt_write - watchdog file_operations .write
416 * @file: file handle to the watchdog
417 * @buf: buffer to write
418 * @count: count of bytes
419 * @ppos: pointer to the position to write. No seeks allowed
421 * A write to a watchdog device is defined as a keepalive signal. Any
422 * write of data will do, as we don't define content meaning.
424 * Used within the file operation of the watchdog device.
427 static ssize_t
wdt_write(struct file
*file
, const char __user
*buf
,
428 size_t count
, loff_t
*ppos
)
431 clear_bit(WDTS_EXPECTED
, &wdt_status
);
437 /* note: just in case someone wrote the magic character long ago */
438 for (ofs
= 0; ofs
!= count
; ofs
++) {
440 if (get_user(c
, buf
+ ofs
))
443 set_bit(WDTS_EXPECTED
, &wdt_status
);
449 static const struct watchdog_info ident
= {
450 .options
= WDIOF_SETTIMEOUT
| WDIOF_MAGICCLOSE
| WDIOF_KEEPALIVEPING
,
451 .firmware_version
= 1,
452 .identity
= WATCHDOG_NAME
,
456 * wdt_ioctl - watchdog file_operations .unlocked_ioctl
457 * @file: file handle to the device
458 * @cmd: watchdog command
459 * @arg: argument pointer
461 * The watchdog API defines a common set of functions for all watchdogs
462 * according to their available features.
464 * Used within the file operation of the watchdog device.
467 static long wdt_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
469 int rc
= 0, status
, new_options
, new_timeout
;
471 struct watchdog_info __user
*ident
;
475 uarg
.i
= (int __user
*)arg
;
478 case WDIOC_GETSUPPORT
:
479 return copy_to_user(uarg
.ident
,
480 &ident
, sizeof(ident
)) ? -EFAULT
: 0;
482 case WDIOC_GETSTATUS
:
483 wdt_get_status(&status
);
484 return put_user(status
, uarg
.i
);
486 case WDIOC_GETBOOTSTATUS
:
487 return put_user(0, uarg
.i
);
489 case WDIOC_KEEPALIVE
:
493 case WDIOC_SETOPTIONS
:
494 if (get_user(new_options
, uarg
.i
))
497 switch (new_options
) {
498 case WDIOS_DISABLECARD
:
499 if (test_bit(WDTS_TIMER_RUN
, &wdt_status
))
501 clear_bit(WDTS_TIMER_RUN
, &wdt_status
);
504 case WDIOS_ENABLECARD
:
505 if (!test_and_set_bit(WDTS_TIMER_RUN
, &wdt_status
))
513 case WDIOC_SETTIMEOUT
:
514 if (get_user(new_timeout
, uarg
.i
))
516 rc
= wdt_set_timeout(new_timeout
);
517 case WDIOC_GETTIMEOUT
:
518 if (put_user(timeout
, uarg
.i
))
527 static int wdt_notify_sys(struct notifier_block
*this, unsigned long code
,
530 if (code
== SYS_DOWN
|| code
== SYS_HALT
)
535 static const struct file_operations wdt_fops
= {
536 .owner
= THIS_MODULE
,
539 .unlocked_ioctl
= wdt_ioctl
,
541 .release
= wdt_release
,
544 static struct miscdevice wdt_miscdev
= {
545 .minor
= WATCHDOG_MINOR
,
550 static struct notifier_block wdt_notifier
= {
551 .notifier_call
= wdt_notify_sys
,
554 static int __init
it87_wdt_init(void)
557 int try_gameport
= !nogameport
;
564 spin_lock_irqsave(&spinlock
, flags
);
566 chip_type
= superio_inw(CHIPID
);
567 chip_rev
= superio_inb(CHIPREV
) & 0x0f;
569 spin_unlock_irqrestore(&spinlock
, flags
);
576 max_units
= (chip_rev
< 8) ? 255 : 65535;
589 "Unsupported Chip found, Chip %04x Revision %02x\n",
590 chip_type
, chip_rev
);
593 printk(KERN_ERR PFX
"no device\n");
597 "Unknown Chip found, Chip %04x Revision %04x\n",
598 chip_type
, chip_rev
);
602 spin_lock_irqsave(&spinlock
, flags
);
605 superio_select(GPIO
);
606 superio_outb(WDT_TOV1
, WDTCFG
);
607 superio_outb(0x00, WDTCTRL
);
609 /* First try to get Gameport support */
611 superio_select(GAMEPORT
);
612 base
= superio_inw(BASEREG
);
614 base
= GP_BASE_DEFAULT
;
615 superio_outw(base
, BASEREG
);
617 gpact
= superio_inb(ACTREG
);
618 superio_outb(0x01, ACTREG
);
620 spin_unlock_irqrestore(&spinlock
, flags
);
621 if (request_region(base
, 1, WATCHDOG_NAME
))
622 set_bit(WDTS_USE_GP
, &wdt_status
);
627 spin_unlock_irqrestore(&spinlock
, flags
);
630 /* If we haven't Gameport support, try to get CIR support */
631 if (!test_bit(WDTS_USE_GP
, &wdt_status
)) {
632 if (!request_region(CIR_BASE
, 8, WATCHDOG_NAME
)) {
635 "I/O Address 0x%04x and 0x%04x"
636 " already in use\n", base
, CIR_BASE
);
639 "I/O Address 0x%04x already in use\n",
645 spin_lock_irqsave(&spinlock
, flags
);
649 superio_outw(base
, BASEREG
);
650 superio_outb(0x00, CIR_ILS
);
651 ciract
= superio_inb(ACTREG
);
652 superio_outb(0x01, ACTREG
);
654 superio_select(GAMEPORT
);
655 superio_outb(gpact
, ACTREG
);
659 spin_unlock_irqrestore(&spinlock
, flags
);
662 if (timeout
< 1 || timeout
> max_units
* 60) {
663 timeout
= DEFAULT_TIMEOUT
;
664 printk(KERN_WARNING PFX
665 "Timeout value out of range, use default %d sec\n",
669 if (timeout
> max_units
)
670 timeout
= wdt_round_time(timeout
);
672 rc
= register_reboot_notifier(&wdt_notifier
);
675 "Cannot register reboot notifier (err=%d)\n", rc
);
679 rc
= misc_register(&wdt_miscdev
);
682 "Cannot register miscdev on minor=%d (err=%d)\n",
683 wdt_miscdev
.minor
, rc
);
687 /* Initialize CIR to use it as keepalive source */
688 if (!test_bit(WDTS_USE_GP
, &wdt_status
)) {
689 outb(0x00, CIR_RCR(base
));
690 outb(0xc0, CIR_TCR1(base
));
691 outb(0x5c, CIR_TCR2(base
));
692 outb(0x10, CIR_IER(base
));
693 outb(0x00, CIR_BDHR(base
));
694 outb(0x01, CIR_BDLR(base
));
695 outb(0x09, CIR_IER(base
));
698 printk(KERN_INFO PFX
"Chip IT%04x revision %d initialized. "
699 "timeout=%d sec (nowayout=%d testmode=%d exclusive=%d "
700 "nogameport=%d)\n", chip_type
, chip_rev
, timeout
,
701 nowayout
, testmode
, exclusive
, nogameport
);
706 unregister_reboot_notifier(&wdt_notifier
);
708 release_region(base
, test_bit(WDTS_USE_GP
, &wdt_status
) ? 1 : 8);
709 if (!test_bit(WDTS_USE_GP
, &wdt_status
)) {
710 spin_lock_irqsave(&spinlock
, flags
);
713 superio_outb(ciract
, ACTREG
);
715 spin_unlock_irqrestore(&spinlock
, flags
);
719 spin_lock_irqsave(&spinlock
, flags
);
721 superio_select(GAMEPORT
);
722 superio_outb(gpact
, ACTREG
);
724 spin_unlock_irqrestore(&spinlock
, flags
);
730 static void __exit
it87_wdt_exit(void)
735 nolock
= !spin_trylock_irqsave(&spinlock
, flags
);
737 superio_select(GPIO
);
738 superio_outb(0x00, WDTCTRL
);
739 superio_outb(0x00, WDTCFG
);
740 superio_outb(0x00, WDTVALLSB
);
742 superio_outb(0x00, WDTVALMSB
);
743 if (test_bit(WDTS_USE_GP
, &wdt_status
)) {
744 superio_select(GAMEPORT
);
745 superio_outb(gpact
, ACTREG
);
748 superio_outb(ciract
, ACTREG
);
752 spin_unlock_irqrestore(&spinlock
, flags
);
754 misc_deregister(&wdt_miscdev
);
755 unregister_reboot_notifier(&wdt_notifier
);
756 release_region(base
, test_bit(WDTS_USE_GP
, &wdt_status
) ? 1 : 8);
759 module_init(it87_wdt_init
);
760 module_exit(it87_wdt_exit
);
762 MODULE_AUTHOR("Oliver Schuster");
763 MODULE_DESCRIPTION("Hardware Watchdog Device Driver for IT87xx EC-LPC I/O");
764 MODULE_LICENSE("GPL");
765 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);