d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f2a480c25c
freebsd-skq/share/man/man4/wbwd.4

147 lines
3.9 KiB
Groff
Raw Normal View History

Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.\"-
.\" Copyright (c) 2012 Bjoern A. Zeeb <bz@FreeBSD.org>
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" $FreeBSD$
.\"
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
.Dd March 24, 2016
mdoc: document title should be all caps.
2012-03-25 19:34:05 +00:00
.Dt WBWD 4
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.Os
.Sh NAME
.Nm wbwd
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
.Nd device driver for Winbond/Nuvoton Super I/O chips watchdog timer
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.Sh SYNOPSIS
To compile this driver into the kernel, place the following line in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device wbwd"
.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
wbwd_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides
.Xr watchdog 4
support for the watchdog interrupt timer present on at least the following
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
Super I/O chips:
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.Bl -bullet -compact
.It
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
Winbond 83627HF/F/HG/G
.It
Winbond 83627S
.It
Winbond 83697HF
.It
Winbond 83697UG
.It
Winbond 83637HF
.It
Winbond 83627THF
.It
Winbond 83687THF
.It
Winbond 83627EHF
.It
Winbond 83627DHG
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.It
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
Winbond 83627UHG
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.It
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
Winbond 83667HG
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.It
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
Winbond 83627DHG-P
.It
Winbond 83667HG-B
.It
Nuvoton NCT6775
.It
Nuvoton NCT6776
.It
Nuvoton NCT6102
.It
Nuvoton NCT6779
.It
Nuvoton NCT6791
.It
Nuvoton NCT6792
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.El
Polish wbwd(4) driver and add more supported chips. MFC after: 1 month
2016-03-24 20:52:35 +00:00
.Pp
Driver may be forced to attach to unknown chips by adding to
.Pa /boot/device.hints :
.Cd hint.wbwd.0.at="isa"
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.Sh SYSCTL VARIABLES
The
.Nm
driver provides the following options as
.Xr sysctl 8
variables.
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Bl -tag -width "xxxxxx"
Provide wbwd(4), a driver for the watchdog timer found on various Winbond Super I/O chips. With minor efforts it should be possible the extend the driver to support further chips/revisions available from Winbond. In the simplest case only new IDs need to be added, while different chipsets might require their own function to enter extended function mode, etc. Sponsored by: Sandvine Incorporated ULC (in 2011) Reviewed by: emaste, brueffer MFC after: 2 weeks
2012-03-06 18:44:52 +00:00
.It Va dev.wbwd.0.timeout_override
This variable allows to program the timer to a value independent on the one
provided by the
.Xr watchdog 4
framework while still relying on the regular updates from e.g.
.Xr watchdogd 8 .
This is particularly useful if your system provides multiple watchdogs and
you want them to fire in a special sequence to trigger an NMI after a shorter
period than the reset timeout for example.
The value set must not be lower than the sleep time of
.Xr watchdogd 8 .
A value of 0 disables this feature and the timeout value provided by
.Xr watchdog 4
will be used.
.It Va dev.wbwd.0.debug_verbose
If set this sysctl will tell the driver to log its current state before and
after the timer reset on each invocation from
.Xr watchdog 9
to the kernel message buffer for debugging.
.It Va dev.wbwd.0.debug
This read-only value gives the state of some registers on last update.
.El
.Pp
The
.Nm
driver also provides further sysctl options that are hidden by default.
See the source code for more information.
.Sh SEE ALSO
.Xr watchdog 4 ,
.Xr device.hints 5 ,
.Xr watchdog 8 ,
.Xr watchdogd 8 ,
.Xr watchdog 9
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 10.0 .
.Sh AUTHORS
.An -nosplit
This manual page was written by
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:46:14 +00:00
.An Bjoern A. Zeeb Aq Mt bz@FreeBSD.org .
Reference in New Issue Copy Permalink