2 * SoftDog 0.07: A Software Watchdog Device
4 * (c) Copyright 1996 Alan Cox <alan@lxorguk.ukuu.org.uk>,
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
12 * Neither Alan Cox nor CymruNet Ltd. admit liability nor provide
13 * warranty for any of this software. This material is provided
14 * "AS-IS" and at no charge.
16 * (c) Copyright 1995 Alan Cox <alan@lxorguk.ukuu.org.uk>
18 * Software only watchdog driver. Unlike its big brother the WDT501P
19 * driver this won't always recover a failed machine.
21 * 03/96: Angelo Haritsis <ah@doc.ic.ac.uk> :
23 * Added soft_margin; use upon insmod to change the timer delay.
24 * NB: uses same minor as wdt (WATCHDOG_MINOR); we could use separate
28 * Made SMP safe for 2.3.x
30 * 20011127 Joel Becker (jlbec@evilplan.org>
31 * Added soft_noboot; Allows testing the softdog trigger without
32 * requiring a recompile.
33 * Added WDIOC_GETTIMEOUT and WDIOC_SETTIMOUT.
35 * 20020530 Joel Becker <joel.becker@oracle.com>
36 * Added Matt Domsch's nowayout module option.
39 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
41 #include <linux/module.h>
42 #include <linux/moduleparam.h>
43 #include <linux/types.h>
44 #include <linux/timer.h>
45 #include <linux/miscdevice.h>
46 #include <linux/watchdog.h>
48 #include <linux/notifier.h>
49 #include <linux/reboot.h>
50 #include <linux/init.h>
51 #include <linux/jiffies.h>
52 #include <linux/uaccess.h>
53 #include <linux/kernel.h>
55 #define TIMER_MARGIN 60 /* Default is 60 seconds */
56 static int soft_margin
= TIMER_MARGIN
; /* in seconds */
57 module_param(soft_margin
, int, 0);
58 MODULE_PARM_DESC(soft_margin
,
59 "Watchdog soft_margin in seconds. (0 < soft_margin < 65536, default="
60 __MODULE_STRING(TIMER_MARGIN
) ")");
62 static bool nowayout
= WATCHDOG_NOWAYOUT
;
63 module_param(nowayout
, bool, 0);
64 MODULE_PARM_DESC(nowayout
,
65 "Watchdog cannot be stopped once started (default="
66 __MODULE_STRING(WATCHDOG_NOWAYOUT
) ")");
69 static int soft_noboot
= 1;
71 static int soft_noboot
= 0;
72 #endif /* ONLY_TESTING */
74 module_param(soft_noboot
, int, 0);
75 MODULE_PARM_DESC(soft_noboot
,
76 "Softdog action, set to 1 to ignore reboots, 0 to reboot "
77 "(default depends on ONLY_TESTING)");
79 static int soft_panic
;
80 module_param(soft_panic
, int, 0);
81 MODULE_PARM_DESC(soft_panic
,
82 "Softdog action, set to 1 to panic, 0 to reboot (default=0)");
88 static void watchdog_fire(unsigned long);
90 static struct timer_list watchdog_ticktock
=
91 TIMER_INITIALIZER(watchdog_fire
, 0, 0);
92 static unsigned long driver_open
, orphan_timer
;
93 static char expect_close
;
97 * If the timer expires..
100 static void watchdog_fire(unsigned long data
)
102 if (test_and_clear_bit(0, &orphan_timer
))
103 module_put(THIS_MODULE
);
106 pr_crit("Triggered - Reboot ignored\n");
107 else if (soft_panic
) {
108 pr_crit("Initiating panic\n");
109 panic("Software Watchdog Timer expired");
111 pr_crit("Initiating system reboot\n");
113 pr_crit("Reboot didn't ?????\n");
121 static int softdog_keepalive(void)
123 mod_timer(&watchdog_ticktock
, jiffies
+(soft_margin
*HZ
));
127 static int softdog_stop(void)
129 del_timer(&watchdog_ticktock
);
133 static int softdog_set_heartbeat(int t
)
135 if ((t
< 0x0001) || (t
> 0xFFFF))
143 * /dev/watchdog handling
146 static int softdog_open(struct inode
*inode
, struct file
*file
)
148 if (test_and_set_bit(0, &driver_open
))
150 if (!test_and_clear_bit(0, &orphan_timer
))
151 __module_get(THIS_MODULE
);
156 return nonseekable_open(inode
, file
);
159 static int softdog_release(struct inode
*inode
, struct file
*file
)
162 * Shut off the timer.
163 * Lock it in if it's a module and we set nowayout
165 if (expect_close
== 42) {
167 module_put(THIS_MODULE
);
169 pr_crit("Unexpected close, not stopping watchdog!\n");
170 set_bit(0, &orphan_timer
);
173 clear_bit(0, &driver_open
);
178 static ssize_t
softdog_write(struct file
*file
, const char __user
*data
,
179 size_t len
, loff_t
*ppos
)
188 /* In case it was set long ago */
191 for (i
= 0; i
!= len
; i
++) {
194 if (get_user(c
, data
+ i
))
205 static long softdog_ioctl(struct file
*file
, unsigned int cmd
,
208 void __user
*argp
= (void __user
*)arg
;
209 int __user
*p
= argp
;
211 static const struct watchdog_info ident
= {
212 .options
= WDIOF_SETTIMEOUT
|
213 WDIOF_KEEPALIVEPING
|
215 .firmware_version
= 0,
216 .identity
= "Software Watchdog",
219 case WDIOC_GETSUPPORT
:
220 return copy_to_user(argp
, &ident
, sizeof(ident
)) ? -EFAULT
: 0;
221 case WDIOC_GETSTATUS
:
222 case WDIOC_GETBOOTSTATUS
:
223 return put_user(0, p
);
224 case WDIOC_KEEPALIVE
:
227 case WDIOC_SETTIMEOUT
:
228 if (get_user(new_margin
, p
))
230 if (softdog_set_heartbeat(new_margin
))
234 case WDIOC_GETTIMEOUT
:
235 return put_user(soft_margin
, p
);
242 * Notifier for system down
245 static int softdog_notify_sys(struct notifier_block
*this, unsigned long code
,
248 if (code
== SYS_DOWN
|| code
== SYS_HALT
)
249 /* Turn the WDT off */
258 static const struct file_operations softdog_fops
= {
259 .owner
= THIS_MODULE
,
261 .write
= softdog_write
,
262 .unlocked_ioctl
= softdog_ioctl
,
263 .open
= softdog_open
,
264 .release
= softdog_release
,
267 static struct miscdevice softdog_miscdev
= {
268 .minor
= WATCHDOG_MINOR
,
270 .fops
= &softdog_fops
,
273 static struct notifier_block softdog_notifier
= {
274 .notifier_call
= softdog_notify_sys
,
277 static int __init
watchdog_init(void)
281 /* Check that the soft_margin value is within it's range;
282 if not reset to the default */
283 if (softdog_set_heartbeat(soft_margin
)) {
284 softdog_set_heartbeat(TIMER_MARGIN
);
285 pr_info("soft_margin must be 0 < soft_margin < 65536, using %d\n",
289 ret
= register_reboot_notifier(&softdog_notifier
);
291 pr_err("cannot register reboot notifier (err=%d)\n", ret
);
295 ret
= misc_register(&softdog_miscdev
);
297 pr_err("cannot register miscdev on minor=%d (err=%d)\n",
298 WATCHDOG_MINOR
, ret
);
299 unregister_reboot_notifier(&softdog_notifier
);
303 pr_info("Software Watchdog Timer: 0.07 initialized. soft_noboot=%d soft_margin=%d sec soft_panic=%d (nowayout= %d)\n",
304 soft_noboot
, soft_margin
, soft_panic
, nowayout
);
309 static void __exit
watchdog_exit(void)
311 misc_deregister(&softdog_miscdev
);
312 unregister_reboot_notifier(&softdog_notifier
);
315 module_init(watchdog_init
);
316 module_exit(watchdog_exit
);
318 MODULE_AUTHOR("Alan Cox");
319 MODULE_DESCRIPTION("Software Watchdog Device Driver");
320 MODULE_LICENSE("GPL");
321 MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR
);