2 * Acquire Single Board Computer Watchdog Timer driver
4 * Based on wdt.c. Original copyright messages:
6 * (c) Copyright 1996 Alan Cox <alan@redhat.com>, All Rights Reserved.
7 * http://www.redhat.com
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
14 * Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
15 * warranty for any of this software. This material is provided
16 * "AS-IS" and at no charge.
18 * (c) Copyright 1995 Alan Cox <alan@redhat.com>
20 * 14-Dec-2001 Matt Domsch <Matt_Domsch@dell.com>
21 * Added nowayout module option to override CONFIG_WATCHDOG_NOWAYOUT
22 * Can't add timeout - driver doesn't allow changing value
26 * Theory of Operation:
27 * The Watch-Dog Timer is provided to ensure that standalone
28 * Systems can always recover from catastrophic conditions that
29 * caused the CPU to crash. This condition may have occured by
30 * external EMI or a software bug. When the CPU stops working
31 * correctly, hardware on the board will either perform a hardware
32 * reset (cold boot) or a non-maskable interrupt (NMI) to bring the
33 * system back to a known state.
35 * The Watch-Dog Timer is controlled by two I/O Ports.
36 * 443 hex - Read - Enable or refresh the Watch-Dog Timer
37 * 043 hex - Read - Disable the Watch-Dog Timer
39 * To enable the Watch-Dog Timer, a read from I/O port 443h must
40 * be performed. This will enable and activate the countdown timer
41 * which will eventually time out and either reset the CPU or cause
42 * an NMI depending on the setting of a jumper. To ensure that this
43 * reset condition does not occur, the Watch-Dog Timer must be
44 * periodically refreshed by reading the same I/O port 443h.
45 * The Watch-Dog Timer is disabled by reading I/O port 043h.
47 * The Watch-Dog Timer Time-Out Period is set via jumpers.
48 * It can be 1, 2, 10, 20, 110 or 220 seconds.
51 #include <linux/module.h>
52 #include <linux/moduleparam.h>
53 #include <linux/types.h>
54 #include <linux/miscdevice.h>
55 #include <linux/watchdog.h>
57 #include <linux/ioport.h>
58 #include <linux/notifier.h>
59 #include <linux/reboot.h>
60 #include <linux/init.h>
63 #include <asm/uaccess.h>
64 #include <asm/system.h>
66 #define WATCHDOG_NAME "Acquire WDT"
67 #define PFX WATCHDOG_NAME ": "
68 #define WATCHDOG_HEARTBEAT 0 /* There is no way to see what the correct time-out period is */
70 static unsigned long acq_is_open
;
71 static char expect_close
;
74 * You must set these - there is no sane way to probe for this board.
77 static int wdt_stop
= 0x43;
78 module_param(wdt_stop
, int, 0);
79 MODULE_PARM_DESC(wdt_stop
, "Acquire WDT 'stop' io port (default 0x43)");
81 static int wdt_start
= 0x443;
82 module_param(wdt_start
, int, 0);
83 MODULE_PARM_DESC(wdt_start
, "Acquire WDT 'start' io port (default 0x443)");
85 static int nowayout
= WATCHDOG_NOWAYOUT
;
86 module_param(nowayout
, int, 0);
87 MODULE_PARM_DESC(nowayout
, "Watchdog cannot be stopped once started (default=CONFIG_WATCHDOG_NOWAYOUT)");
93 static void acq_keepalive(void)
95 /* Write a watchdog value */
99 static void acq_stop(void)
101 /* Turn the card off */
106 * /dev/watchdog handling.
109 static ssize_t
acq_write(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*ppos
)
111 /* See if we got the magic character 'V' and reload the timer */
116 /* note: just in case someone wrote the magic character
117 * five months ago... */
120 /* scan to see whether or not we got the magic character */
121 for (i
= 0; i
!= count
; i
++) {
123 if (get_user(c
, buf
+ i
))
130 /* Well, anyhow someone wrote to us, we should return that favour */
136 static int acq_ioctl(struct inode
*inode
, struct file
*file
, unsigned int cmd
,
139 int options
, retval
= -EINVAL
;
140 void __user
*argp
= (void __user
*)arg
;
141 int __user
*p
= argp
;
142 static struct watchdog_info ident
=
144 .options
= WDIOF_KEEPALIVEPING
| WDIOF_MAGICCLOSE
,
145 .firmware_version
= 1,
146 .identity
= "Acquire WDT",
151 case WDIOC_GETSUPPORT
:
152 return copy_to_user(argp
, &ident
, sizeof(ident
)) ? -EFAULT
: 0;
154 case WDIOC_GETSTATUS
:
155 case WDIOC_GETBOOTSTATUS
:
156 return put_user(0, p
);
158 case WDIOC_KEEPALIVE
:
162 case WDIOC_GETTIMEOUT
:
163 return put_user(WATCHDOG_HEARTBEAT
, p
);
165 case WDIOC_SETOPTIONS
:
167 if (get_user(options
, p
))
170 if (options
& WDIOS_DISABLECARD
)
176 if (options
& WDIOS_ENABLECARD
)
190 static int acq_open(struct inode
*inode
, struct file
*file
)
192 if (test_and_set_bit(0, &acq_is_open
))
196 __module_get(THIS_MODULE
);
200 return nonseekable_open(inode
, file
);
203 static int acq_close(struct inode
*inode
, struct file
*file
)
205 if (expect_close
== 42) {
208 printk(KERN_CRIT PFX
"Unexpected close, not stopping watchdog!\n");
211 clear_bit(0, &acq_is_open
);
217 * Notifier for system down
220 static int acq_notify_sys(struct notifier_block
*this, unsigned long code
,
223 if(code
==SYS_DOWN
|| code
==SYS_HALT
) {
224 /* Turn the WDT off */
234 static const struct file_operations acq_fops
= {
235 .owner
= THIS_MODULE
,
240 .release
= acq_close
,
243 static struct miscdevice acq_miscdev
=
245 .minor
= WATCHDOG_MINOR
,
251 * The WDT card needs to learn about soft shutdowns in order to
252 * turn the timebomb registers off.
255 static struct notifier_block acq_notifier
=
257 .notifier_call
= acq_notify_sys
,
260 static int __init
acq_init(void)
264 printk(KERN_INFO
"WDT driver for Acquire single board computer initialising.\n");
266 if (wdt_stop
!= wdt_start
) {
267 if (!request_region(wdt_stop
, 1, WATCHDOG_NAME
)) {
268 printk (KERN_ERR PFX
"I/O address 0x%04x already in use\n",
275 if (!request_region(wdt_start
, 1, WATCHDOG_NAME
)) {
276 printk (KERN_ERR PFX
"I/O address 0x%04x already in use\n",
282 ret
= register_reboot_notifier(&acq_notifier
);
284 printk (KERN_ERR PFX
"cannot register reboot notifier (err=%d)\n",
289 ret
= misc_register(&acq_miscdev
);
291 printk (KERN_ERR PFX
"cannot register miscdev on minor=%d (err=%d)\n",
292 WATCHDOG_MINOR
, ret
);
296 printk (KERN_INFO PFX
"initialized. (nowayout=%d)\n",
302 unregister_reboot_notifier(&acq_notifier
);
304 release_region(wdt_start
, 1);
306 if (wdt_stop
!= wdt_start
)
307 release_region(wdt_stop
, 1);
312 static void __exit
acq_exit(void)
314 misc_deregister(&acq_miscdev
);
315 unregister_reboot_notifier(&acq_notifier
);
316 if(wdt_stop
!= wdt_start
)
317 release_region(wdt_stop
,1);
318 release_region(wdt_start
,1);
321 module_init(acq_init
);
322 module_exit(acq_exit
);
324 MODULE_AUTHOR("David Woodhouse");
325 MODULE_DESCRIPTION("Acquire Inc. Single Board Computer Watchdog Timer driver");
326 MODULE_LICENSE("GPL");
327 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);