[WATCHDOG] Documentation/watchdog update
[linux-2.6.git] / Documentation / watchdog / pcwd-watchdog.txt
1                      Berkshire Products PC Watchdog Card
2                    Support for ISA Cards  Revision A and C
3            Documentation and Driver by Ken Hollis <kenji@bitgate.com>
4
5  The PC Watchdog is a card that offers the same type of functionality that
6  the WDT card does, only it doesn't require an IRQ to run.  Furthermore,
7  the Revision C card allows you to monitor any IO Port to automatically
8  trigger the card into being reset.  This way you can make the card
9  monitor hard drive status, or anything else you need.
10
11  The Watchdog Driver has one basic role: to talk to the card and send
12  signals to it so it doesn't reset your computer ... at least during
13  normal operation.
14
15  The Watchdog Driver will automatically find your watchdog card, and will
16  attach a running driver for use with that card.  After the watchdog
17  drivers have initialized, you can then talk to the card using the PC
18  Watchdog program, available from http://ftp.bitgate.com/pcwd/.
19
20  I suggest putting a "watchdog -d" before the beginning of an fsck, and
21  a "watchdog -e -t 1" immediately after the end of an fsck.  (Remember
22  to run the program with an "&" to run it in the background!)
23
24  If you want to write a program to be compatible with the PC Watchdog
25  driver, simply use of modify the watchdog test program:
26  Documentation/watchdog/src/watchdog-test.c
27
28
29  Other IOCTL functions include:
30
31         WDIOC_GETSUPPORT
32                 This returns the support of the card itself.  This
33                 returns in structure "PCWDS" which returns:
34                         options = WDIOS_TEMPPANIC
35                                   (This card supports temperature)
36                         firmware_version = xxxx
37                                   (Firmware version of the card)
38
39         WDIOC_GETSTATUS
40                 This returns the status of the card, with the bits of
41                 WDIOF_* bitwise-anded into the value.  (The comments
42                 are in linux/pcwd.h)
43
44         WDIOC_GETBOOTSTATUS
45                 This returns the status of the card that was reported
46                 at bootup.
47
48         WDIOC_GETTEMP
49                 This returns the temperature of the card.  (You can also
50                 read /dev/watchdog, which gives a temperature update
51                 every second.)
52
53         WDIOC_SETOPTIONS
54                 This lets you set the options of the card.  You can either
55                 enable or disable the card this way.
56
57         WDIOC_KEEPALIVE
58                 This pings the card to tell it not to reset your computer.
59
60  And that's all she wrote!
61
62  -- Ken Hollis
63     (kenji@bitgate.com)
64
65 (This documentation may be out of date.  Check
66  http://ftp.bitgate.com/pcwd/ for the absolute latest additions.)