Changeset View
Standalone View
share/man/man4/wdatwd.4
- This file was added.
.\"- | |||||||||||
.\" Copyright (c) 2022 Tetsuya Uemura <t_uemura@macome.co.jp> | |||||||||||
.\" All rights reserved. | |||||||||||
hrs: Please drop this line if you can accept. See https://reviews.freebsd.org/rS333391 for more… | |||||||||||
.\" | |||||||||||
.\" 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 described by ACPI WDAT (Watchdog | |||||||||||
hrsUnsubmitted Done Inline Actionss/described by/in/ hrs: s/described by/in/
s/found on found on some ACPI implementations.// | |||||||||||
Action Table) found on some ACPI implementations. | |||||||||||
.Pp | |||||||||||
Since WDAT itself is an abstraction for the real hardware such as ICH WDT, | |||||||||||
hrsUnsubmitted Done Inline ActionsI 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 Inline ActionsAgreed. 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… | |||||||||||
WDAT doesn't require the knowledge about the hardware at all. Thus, | |||||||||||
takawataUnsubmitted Done Inline Actions
mandoc -Tlint say new line, new sentence. takawata: mandoc -Tlint say new line, new sentence.
e.g. add new line after period. | |||||||||||
.Nm | |||||||||||
for example may support the newer generation hardwares that | |||||||||||
.Xr ichwd 4 | |||||||||||
driver is yet to support. | |||||||||||
.Sh SYSCTL VARIABLES | |||||||||||
The following read-only | |||||||||||
.Xr sysctl 8 | |||||||||||
variables are available: | |||||||||||
.Bl -tag -width indent | |||||||||||
.It Va dev.wdat.%d.can_set_timeout | |||||||||||
hrsUnsubmitted Done Inline ActionsThe 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` | |||||||||||
0 if WDAT doesn't allow users to set the custom timeout, or any positive | |||||||||||
hrsUnsubmitted Done Inline Actions"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… | |||||||||||
integer if allowed. If 0, the watchdog will fire after its BIOS default timeout | |||||||||||
takawataUnsubmitted Done Inline Actionssame above. takawata: same above. | |||||||||||
hrsUnsubmitted Done Inline ActionsDrop 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… | |||||||||||
period. | |||||||||||
.It Va dev.wdat.%d.default_timeout_ms | |||||||||||
hrsUnsubmitted Done Inline ActionsSame as L.65 hrs: Same as L.65 | |||||||||||
If WDAT describes the action to guess the default timeout, it will be | |||||||||||
hrsUnsubmitted Done Inline Actions"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". | |||||||||||
converted to milli-sec order and is set to this variable. | |||||||||||
.It Va dev.wdat.%d.running | |||||||||||
hrsUnsubmitted Done Inline ActionsSame as L.65 hrs: Same as L.65 | |||||||||||
0 if the watchdog is in stopped state or 1 in running state. | |||||||||||
hrsUnsubmitted Done Inline Actions"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."
| |||||||||||
.It Va dev.wdat.%d.timeout_ms | |||||||||||
hrsUnsubmitted Done Inline ActionsSame as L.65 hrs: Same as L.65 | |||||||||||
Currently configured timeout period in milli-sec order. | |||||||||||
hrsUnsubmitted Done Inline Actions"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… | |||||||||||
.El | |||||||||||
.Sh SEE ALSO | |||||||||||
.Xr watchdog 4 , | |||||||||||
.Xr ichwd 4 , | |||||||||||
.Xr watchdog 8 , | |||||||||||
takawataUnsubmitted Done Inline Actionssort .Xr item in word, not section, mandoc -Tlint says. takawata: sort .Xr item in word, not section, mandoc -Tlint says. | |||||||||||
.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 | |||||||||||
.Re | |||||||||||
.Sh HISTORY | |||||||||||
The | |||||||||||
.Nm | |||||||||||
driver still in-development. | |||||||||||
hrsUnsubmitted Done Inline ActionsDrop 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.
| |||||||||||
.Sh AUTHORS | |||||||||||
.An -nosplit | |||||||||||
The | |||||||||||
.Nm | |||||||||||
driver was written by | |||||||||||
.An Tetsuya Uemura Aq Mt t_uemura@macome.co.jp | |||||||||||
of MACOME, Corporation. |
Please drop this line if you can accept. See https://reviews.freebsd.org/rS333391 for more details.