Merge branch 'sched/urgent' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
[sfrench/cifs-2.6.git] / Documentation / watchdog / hpwdt.txt
1 Last reviewed: 08/20/2018
2
3                      HPE iLO NMI Watchdog Driver
4                    for iLO based ProLiant Servers
5
6  The HPE iLO NMI Watchdog driver is a kernel module that provides basic
7  watchdog functionality and handler for the iLO "Generate NMI to System"
8  virtual button.
9
10  All references to iLO in this document imply it also works on iLO2 and all
11  subsequent generations.
12
13  Watchdog functionality is enabled like any other common watchdog driver. That
14  is, an application needs to be started that kicks off the watchdog timer. A
15  basic application exists in tools/testing/selftests/watchdog/ named
16  watchdog-test.c. Simply compile the C file and kick it off. If the system
17  gets into a bad state and hangs, the HPE ProLiant iLO timer register will
18  not be updated in a timely fashion and a hardware system reset (also known as
19  an Automatic Server Recovery (ASR)) event will occur.
20
21  The hpwdt driver also has the following module parameters:
22
23  soft_margin - allows the user to set the watchdog timer value.
24                Default value is 30 seconds.
25  timeout     - an alias of soft_margin.
26  pretimeout  - allows the user to set the watchdog pretimeout value.
27                This is the number of seconds before timeout when an
28                NMI is delivered to the system. Setting the value to
29                zero disables the pretimeout NMI.
30                Default value is 9 seconds.
31  nowayout    - basic watchdog parameter that does not allow the timer to
32                be restarted or an impending ASR to be escaped.
33                Default value is set when compiling the kernel. If it is set
34                to "Y", then there is no way of disabling the watchdog once
35                it has been started.
36
37  NOTE: More information about watchdog drivers in general, including the ioctl
38        interface to /dev/watchdog can be found in
39        Documentation/watchdog/watchdog-api.txt and Documentation/IPMI.txt.
40
41  Due to limitations in the iLO hardware, the NMI pretimeout if enabled,
42  can only be set to 9 seconds.  Attempts to set pretimeout to other
43  non-zero values will be rounded, possibly to zero.  Users should verify
44  the pretimeout value after attempting to set pretimeout or timeout.
45
46  Upon receipt of an NMI from the iLO, the hpwdt driver will initiate a
47  panic. This is to allow for a crash dump to be collected.  It is incumbent
48  upon the user to have properly configured the system for kdump.
49
50  The default Linux kernel behavior upon panic is to print a kernel tombstone
51  and loop forever.  This is generally not what a watchdog user wants.
52
53  For those wishing to learn more please see:
54         Documentation/kdump/kdump.txt
55         Documentation/admin-guide/kernel-parameters.txt (panic=)
56         Your Linux Distribution specific documentation.
57
58  If the hpwdt does not receive the NMI associated with an expiring timer,
59  the iLO will proceed to reset the system at timeout if the timer hasn't
60  been updated.
61
62 --
63
64  The HPE iLO NMI Watchdog Driver and documentation were originally developed
65  by Tom Mingarelli.
66