WATCHDOG(4) BSD Kernel Interfaces Manual WATCHDOG(4)NAME
watchdog -- hardware and software watchdog
SYNOPSIS
#include <sys/watchdog.h>
DESCRIPTION
The watchdog facility is used for controlling hardware and software watchdogs.
/dev/fido responds to a single ioctl(2) call, WDIOCPATPAT. It takes a single argument which represents a timeout value specified as a power
of two nanoseconds, or-ed with a flag selecting active or passive control of the watchdog.
WD_ACTIVE indicates that the watchdog will be kept from timing out from userland, for instance by the watchdogd(8) daemon. WD_PASSIVE indi-
cates that the watchdog will be kept from timing out from the kernel.
The ioctl(2) call will return success if just one of the available watchdog(9) implementations supports setting the timeout to the specified
timeout. This means that at least one watchdog is armed. If the call fails, for instance if none of watchdog(9) implementations support the
timeout length, all watchdogs are disabled and must be explicitly re-enabled.
To disable the watchdogs pass WD_TO_NEVER. If disarming the watchdog(s) failed an error is returned. The watchdog might still be armed!
RETURN VALUES
The ioctl returns zero on success and non-zero on failure.
[EOPNOTSUPP] No watchdog present in the kernel (timeout value other than 0).
[EOPNOTSUPP] Watchdog could not be disabled (timeout value of 0).
[EINVALID] Invalid flag combination passed.
[EINVALID] None of the watchdogs supports the requested timeout value.
EXAMPLES
#include <paths.h>
#include <sys/watchdog.h>
#define WDPATH "/dev/" _PATH_WATCHDOG
int wdfd = -1;
static void
wd_init(void)
{
wdfd = open(WDPATH, O_RDWR);
if (wdfd == -1)
err(1, WDPATH);
}
static void
wd_reset(u_int timeout)
{
if (ioctl(wdfd, WDIOCPATPAT, &timeout) == -1)
err(1, "WDIOCPATPAT");
}
/* in main() */
wd_init();
wd_reset(WD_ACTIVE|WD_TO_8SEC);
/* potential freeze point */
wd_reset(WD_TO_NEVER);
Enables a watchdog to recover from a potentially freezing piece of code.
options SW_WATCHDOG
in your kernel config adds a software watchdog in the kernel, dropping to KDB or panic-ing when firing.
SEE ALSO watchdogd(8), watchdog(9)HISTORY
The watchdog code first appeared in FreeBSD 5.1.
BUGS
The WD_PASSIVE option has not yet been implemented.
AUTHORS
The watchdog facility was written by Poul-Henning Kamp <phk@FreeBSD.org>. The software watchdog code and this manual page were written by
Sean Kelly <smkelly@FreeBSD.org>. Some contributions were made by Jeff Roberson <jeff@FreeBSD.org>.
BSD June 25, 2003 BSD
Check Out this Related Man Page
WDOGCTL(8) BSD System Manager's Manual WDOGCTL(8)NAME
wdogctl -- Watchdog timer control utility
SYNOPSIS
wdogctl
wdogctl -d
wdogctl -e [-A] [-p seconds] timer
wdogctl -k [-A] [-p seconds] timer
wdogctl -t
wdogctl -u [-A] [-p seconds] timer
wdogctl -x [-A] [-p seconds] timer
DESCRIPTION
wdogctl is used to manipulate watchdog timers. Watchdog timers provide a means of ensuring that a system continues to make progress. This
is accomplished by use of a timer, provided by either hardware or software; when the timer expires, the watchdog resets the system. In this
case of a hardware watchdog timer, this is accomplished by asserting the system's hardware reset signal. In the case of a software watchdog
timer, this is accomplished by calling the kernel's normal reboot path. In order to prevent the system from rebooting, something must
refresh the timer to prevent it from expiring.
The NetBSD kernel provides three basic modes in which watchdog timers may operate: kernel tickle mode, user tickle mode, and external tickle
mode. In kernel tickle mode, a timer in the kernel refreshes the watchdog timer. In user tickle mode, wdogctl runs in the background and
refreshes the watchdog timer. In kernel tickle mode, progress of the kernel is ensured. In user tickle mode, the ability for user programs
to run within a known period of time is ensured. Note that user tickle mode must be used with caution; on a heavily loaded system, the timer
may expire accidentally, even though user programs may be making (very slow) progress. A user-mode timer is disarmed (if possible) when the
device is closed, unless the timer is activated with the -x option.
External-mode watchdogs are similar to user-mode watchdogs, except that the tickle must be done explicitly by a separate invocation of the
program with the -t option.
In the first two modes, an attempt is made to refresh the watchdog timer in one half the timer's configured period. That is, if the watchdog
timer has a period of 30 seconds, a refresh attempt is made every 15 seconds.
If called without arguments, wdogctl will list the timers available on the system. When arming a watchdog timer, the timer argument is the
name of the timer to arm.
Only one timer may be armed at a time; if an attempt is made to arm a timer when one is already armed, an error message will be displayed and
no action will be taken.
The options are as follows:
-A When arming a timer, this flag indicates that an audible alarm is to sound when the watchdog timer expires and resets the
system. If the selected timer does not support an audible alarm, this option will be silently ignored.
-d This flag disarms the currently active timer. Note that not all watchdog timers can be disabled once armed. If the
selected timer can not be disabled, an error message will be displayed and the timer will remain armed.
-e Arm timer in external tickle mode.
-k Arm timer in kernel tickle mode.
-p period When arming a timer, this flag configures the timer period to period seconds. If the specified period is outside the
timer's range, an error message will be displayed and no action will be taken.
-t This flag tickles an external mode timer.
-u Arm timer in user tickle mode.
-x Arm timer in a modified user tickle mode: closing the device will not disarm the timer.
FILES
/dev/watchdog -- the system monitor watchdog timer device
SEE ALSO acpiwdrt(4), evbarm/iopwdog(4), i386/elansc(4), i386/gcscpcib(4), i386/geodewdog(4), ipmi(4), itesio(4), pcweasel(4), pwdog(4), swwdog(4),
x86/ichlpcib(4)HISTORY
The wdogctl command first appeared in NetBSD 1.6.
AUTHORS
The wdogctl command and the NetBSD watchdog timer framework were written by Jason R. Thorpe <thorpej@zembu.com>, and contributed by Zembu
Labs, Inc.
BSD August 11, 2011 BSD