Differential D37493 Diff 114731 share/man/man4/wdatwd.4

Changeset View

Standalone View

View Options

share/man/man4/wdatwd.4

This file was added.

.\"-

.\"

.\" Redistribution and use in source and binary forms, with or without

hrsUnsubmitted

Done

Please drop this line if you can accept. See https://reviews.freebsd.org/rS333391 for more details.

hrs: Please drop this line if you can accept. See https://reviews.freebsd.org/rS333391 for more…

.\" 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

hrsUnsubmitted

Done

s/described by/in/
s/found on found on some ACPI implementations.//

hrs: s/described by/in/ s/found on found on some ACPI implementations.//

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

hrsUnsubmitted

Done

I do not think this paragraph is needed (until L.59) because it is an implementation detail that the user does not need to care about.

hrs: I do not think this paragraph is needed (until L.59) because it is an implementation detail…

t_uemura_macome.co.jpAuthorUnsubmitted

Done

Agreed. But I noticed I should note that either the real hardware specific driver or this driver can be used at a time.

t_uemura_macome.co.jp: Agreed. But I noticed I should note that either the real hardware specific driver or this…

The following read-only

takawataUnsubmitted

Done

Since WDAT itself is an abstraction for the real hardware such as ICH WDT,

- WDAT doesn't require the knowledge about the hardware at all. Thus,

+ WDAT doesn't require the knowledge about the hardware at all.

+ Thus,

.Nm

for example may support the newer generation hardwares that

mandoc -Tlint say new line, new sentence.
e.g. add new line after period.

takawata: mandoc -Tlint say new line, new sentence. e.g. add new line after period.

.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

hrsUnsubmitted

Done

The sysctl node name should be dev.wdatwd.%d, not dev.wdat.%d

hrs: The sysctl node name should be `dev.wdatwd.%d`, not `dev.wdat.%d`

Whether the timeout is configurable or not.

hrsUnsubmitted

Done

"Whether the timeout is configurable or not. It is 0 if configurable or any positive value if not."

hrs: "Whether the timeout is configurable or not. It is 0 if configurable or any positive value if…

It is 0 if configurable or any positive value if not.

takawataUnsubmitted

Done

same above.

takawata: same above.

hrsUnsubmitted

Done

Drop the sentence after "If 0, the watchdog..." because the described behavior is not related directly to this sysctl variable.

hrs: Drop the sentence after "If 0, the watchdog..." because the described behavior is not related…

.It Va dev.wdatwd.%d.timeout_default

The default value of the watchdog timeout in millisecond if any.

hrsUnsubmitted

Done

Same as L.65

hrs: Same as L.65

.El

hrsUnsubmitted

Done

"The default value of the watchdog timeout in millisecond if any." Avoid to use "milli-sec".

hrs: "The default value of the watchdog timeout in millisecond if any." Avoid to use "milli-sec".

.Sh SEE ALSO

.Xr ichwd 4 ,

hrsUnsubmitted

Done

Same as L.65

hrs: Same as L.65

.Xr watchdog 4 ,

hrsUnsubmitted

Done

"The status of the watchdog timer. 0 if not running, or 1 if running."

hrs: "The status of the watchdog timer. 0 if not running, or 1 if running."

.Xr watchdog 8 ,

hrsUnsubmitted

Done

Same as L.65

hrs: Same as L.65

.Xr watchdogd 8 ,

hrsUnsubmitted

Done

"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."

hrs: "The current value of the watchdog timeout in millisecond. This can be 0 on some systems, and…

.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

takawataUnsubmitted

Done

sort .Xr item in word, not section, mandoc -Tlint says.

takawata: sort .Xr item in word, not section, mandoc -Tlint says.

.%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.

hrsUnsubmitted

Done

Drop this sentence because this says nothing. All of the drivers are always in development.

hrs: Drop this sentence because this says nothing. All of the drivers are always in development.