Merge tag 'docs-6.4-2' of git://git.lwn.net/linux
[linux-block.git] / Documentation / watchdog / wdt.rst
CommitLineData
cc2a2d19
MCC
1============================================================
2WDT Watchdog Timer Interfaces For The Linux Operating System
3============================================================
4
4d389dce
AC
5Last Reviewed: 10/05/2007
6
cc2a2d19 7Alan Cox <alan@lxorguk.ukuu.org.uk>
4d389dce 8
cc2a2d19
MCC
9 - ICS WDT501-P
10 - ICS WDT501-P (no fan tachometer)
11 - ICS WDT500-P
4d389dce
AC
12
13All the interfaces provide /dev/watchdog, which when open must be written
14to within a timeout or the machine will reboot. Each write delays the reboot
15time another timeout. In the case of the software watchdog the ability to
16reboot will depend on the state of the machines and interrupts. The hardware
17boards physically pull the machine down off their own onboard timers and
18will reboot from almost anything.
19
4724ba57 20A second temperature monitoring interface is available on the WDT501P cards.
4d389dce
AC
21This provides /dev/temperature. This is the machine internal temperature in
22degrees Fahrenheit. Each read returns a single byte giving the temperature.
23
24The third interface logs kernel messages on additional alert events.
25
4724ba57 26The ICS ISA-bus wdt card cannot be safely probed for. Instead you need to
cc2a2d19
MCC
27pass IO address and IRQ boot parameters. E.g.::
28
4724ba57
RD
29 wdt.io=0x240 wdt.irq=11
30
31Other "wdt" driver parameters are:
cc2a2d19
MCC
32
33 =========== ======================================================
4724ba57
RD
34 heartbeat Watchdog heartbeat in seconds (default 60)
35 nowayout Watchdog cannot be stopped once started (kernel
cc2a2d19 36 build parameter)
4724ba57
RD
37 tachometer WDT501-P Fan Tachometer support (0=disable, default=0)
38 type WDT501-P Card type (500 or 501, default=500)
cc2a2d19 39 =========== ======================================================
4d389dce
AC
40
41Features
42--------
cc2a2d19
MCC
43
44================ ======= =======
45 WDT501P WDT500P
46================ ======= =======
4d389dce
AC
47Reboot Timer X X
48External Reboot X X
49I/O Port Monitor o o
50Temperature X o
51Fan Speed X o
52Power Under X o
53Power Over X o
54Overheat X o
cc2a2d19 55================ ======= =======
4d389dce
AC
56
57The external event interfaces on the WDT boards are not currently supported.
58Minor numbers are however allocated for it.
59
60
cc2a2d19
MCC
61Example Watchdog Driver:
62
63 see samples/watchdog/watchdog-simple.c