freebsd-dev/share/man/man4/wdatwd.4
Takanori Watanabe 99aeb219ca wdatwd: Add support for ACPI WDAT based watchdog timer.
Simply said, WDAT is an abstraction for the real WDT hardware. For
instance, to add a newer generation WDT to ichwd(4), one must know the
detailed hardware registers, etc..

With WDAT, the necessary IO accesses to operate the WDT are comprehensively
described in it and no hardware knowledge is required.

With this driver, the WDT on Advantech ARK-1124C, Dell R210 and Dell R240 are
detected and operated flawlessly.
* While R210 is also supported by ichwd(4), others are not supported yet.

The unfortunate thing is that not all systems have WDAT defined.

Submitted by: t_uemura at macome.co.jp
Reviewed by: hrs
Differential Revision: https://reviews.freebsd.org/D37493
2023-01-04 00:36:24 +09:00

92 lines
3.2 KiB
Groff

.\"-
.\" Copyright (c) 2022 Tetsuya Uemura <t_uemura@macome.co.jp>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd November 18, 2022
.Dt WDATWD 4
.Os
.Sh NAME
.Nm wdatwd
.Nd device driver for the ACPI WDAT based watchdog interrupt timer
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following line in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device wdatwd"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
wdatwd_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides
.Xr watchdog 4
support for the watchdog interrupt timer in ACPI WDAT (Watchdog Action Table).
.Pp
Since WDAT itself is an abstraction for the real hardware such as ICH WDT, it
must be noted that only one driver can be used at a time, either the real
hardware specific driver or this driver.
.Sh SYSCTL VARIABLES
The following read-only
.Xr sysctl 8
variables are available:
.Bl -tag -width indent
.It Va dev.wdatwd.%d.running
The status of the watchdog timer. 0 if not running, or 1 if running.
.It Va dev.wdatwd.%d.timeout
The current value of the watchdog timeout in millisecond.
This can be 0 on some systems, and the zero value means that the default
timeout is used.
.It Va dev.wdatwd.%d.timeout_configurable
Whether the timeout is configurable or not.
It is 0 if configurable or any positive value if not.
.It Va dev.wdatwd.%d.timeout_default
The default value of the watchdog timeout in millisecond if any.
.El
.Sh SEE ALSO
.Xr ichwd 4 ,
.Xr watchdog 4 ,
.Xr watchdog 8 ,
.Xr watchdogd 8 ,
.Xr watchdog 9
.Rs
.%T Hardware Watchdog Timers Design Specification
.%R Requirements for Hardware Watchdog Timers Supported by Microsoft(R) Windows Vista(R) and Microsoft Windows Server(R) 2008 Operating Systems
.%A Microsoft Corporation
.%U http://msdn.microsoft.com/en-us/windows/hardware/gg463320.aspx
.%D 2006
.Re
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Tetsuya Uemura Aq Mt t_uemura@macome.co.jp
of MACOME, Corporation.