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.

The device /dev/fido supports several optional ioctl(2) calls for configuration, and responds to a set of operational ioctl(2) calls:

WDIOCPATPAT
    Pat the watchdog.

WDIOC_CONTROL
    Enable, disable, or reset the watchdog.

The WDIOCPATPAT ioctl(2) call takes a single argument which represents a timeout value specified as a sbintime_t of the timeout period for the watchdog.

The WDIOCPATPAT 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. By default, this will be a hardware watchdog if one is present, but if no hardware watchdog is able to process the request, a default software watchdog is enabled. 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 use the WDIOC_CONTROL ioctl(2) call with the WD_CTRL_DISABLE flag. If disarming the watchdog(s) failed an error is returned. The watchdog might still be armed! To reenable the watchdogs use the WDIOC_CONTROL ioctl(2) call with the WD_CTRL_ENABLE flag. Another way to pat the watchdog is with the WDIOC_CONTROL ioctl(2) call passing the WDIOC_CTRL_RESET flag.

The optional configuration ioctl(2) commands are listed here, along with the type of the parameter used. Examples of their use can be found in watchdogd(8).

WDIOC_SETTIMEOUT sbintime_t
    set/reset the timer

WDIOC_GETTIMEOUT sbintime_t
    get total timeout

WDIOC_GETTIMELEFT sbintime_t
    get time left

WDIOC_GETPRETIMEOUT sbintime_t
    get the pre-timeout

WDIOC_SETPRETIMEOUT sbintime_t
    set the pre-timeout

WDIOC_SETPRETIMEOUTACT int
    Set the action when a pre-timeout occurs (see WD_SOFT_* below).

WDIOC_SETSOFT int
    Use an internal software watchdog instead of hardware. There is also an external software watchdog, which is used by default if no hardware watchdog was attached.

WDIOC_SETSOFTTIMEOUTACT int
    Set the action when a soft timeout occurs.

The actions that may be specified for the pre-timeout or the internal software watchdog are listed here. Multiple actions can be specified by ORing values together.

WD_SOFT_PANIC
    panic

WD_SOFT_DDB
    enter debugger

WD_SOFT_LOG
    log(9)

WD_SOFT_PRINT
    printf(9)

RETURN VALUES
The WDIOCPATPAT ioctl(2) returns zero on success and non-zero on failure.

[EOPNOTSUPP]
    No watchdog present in the kernel or none of the watchdogs supports the requested timeout value (timeout value other than 0).

[EOPNOTSUPP]
    Watchdog could not be disabled (timeout value of 0).

[EINVAL]
    Invalid flag combination passed.

The configuration ioctl(2) operations return zero on success and non-zero on failure.

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 forces a software watchdog in the kernel to be configured even if a hardware watchdog is configured, dropping to KDB or panicking when firing, depending on the KDB and KDB_UNATTENDED kernel configuration options.

SEE ALSO
watchdogd(8), watchdog(9)

HISTORY
The watchdog code first appeared in FreeBSD 5.1.

AUTHORS
-nosplit 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>.

BUGS
The WD_PASSIVE option has not yet been implemented.