docs: watchdog: convert docs to ReST and rename to *.rst

			Default: 3 = cyan.

	watchdog timers	[HW,WDT] For information on watchdog timers,

			see Documentation/watchdog/watchdog-parameters.txt

			see Documentation/watchdog/watchdog-parameters.rst

			or other driver-specific files in the

			Documentation/watchdog/ directory.

2.	Boot with "nosoftlockup=0", which will also prevent these kthreads

	from being created.  Other related watchdog and softlockup boot

	parameters may be found in Documentation/admin-guide/kernel-parameters.rst

	and Documentation/watchdog/watchdog-parameters.txt.

	and Documentation/watchdog/watchdog-parameters.rst.

3.	Echo a zero to /proc/sys/kernel/watchdog to disable the

	watchdog timer.

4.	Echo a large number of /proc/sys/kernel/watchdog_thresh in

=========================================================

Converting old watchdog drivers to the watchdog framework

by Wolfram Sang <w.sang@pengutronix.de>

=========================================================

by Wolfram Sang <w.sang@pengutronix.de>

Before the watchdog framework came into the kernel, every driver had to

implement the API on its own. Now, as the framework factored out the common

components, those drivers can be lightened making it a user of the framework.

  -ENOIOCTLCMD, the IOCTLs of the framework will be tried, too. Any other error

  is directly given to the user.

Example conversion:

Example conversion::

  -static const struct file_operations s3c2410wdt_fops = {

  -       .owner          = THIS_MODULE,

Since the file_operations are gone now, you can also remove the 'struct

miscdevice'. The framework will create it on watchdog_dev_register() called by

watchdog_register_device().

watchdog_register_device()::

  -static struct miscdevice s3c2410wdt_miscdev = {

  -       .minor          = WATCHDOG_MINOR,

------------------------------------

Because of the simplifications, a few defines are probably unused now. Remove

them. Includes can be removed, too. For example:

them. Includes can be removed, too. For example::

  - #include <linux/fs.h>

  - #include <linux/miscdevice.h> (if MODULE_ALIAS_MISCDEV is not used)

here simply happens the direct hardware access. If you have device-specific

code left from the above steps, it should be refactored into these callbacks.

Here is a simple example:

Here is a simple example::

  +static struct watchdog_ops s3c2410wdt_ops = {

  +       .owner = THIS_MODULE,

  +       .set_timeout = s3c2410wdt_set_heartbeat,

  +};

A typical function-header change looks like:

A typical function-header change looks like::

  -static void s3c2410wdt_keepalive(void)

  +static int s3c2410wdt_keepalive(struct watchdog_device *wdd)

watchdog_device. Note that the timeout values are unsigned int. Some drivers

use signed int, so this has to be converted, too.

Here is a simple example for a watchdog device:

Here is a simple example for a watchdog device::

  +static struct watchdog_device s3c2410_wdd = {

  +       .info = &s3c2410_wdt_ident,

A few drivers use nowayout statically, i.e. there is no module parameter for it

and only CONFIG_WATCHDOG_NOWAYOUT determines if the feature is going to be

used. This needs to be converted by initializing the status variable of the

watchdog_device like this:

watchdog_device like this::

        .status = WATCHDOG_NOWAYOUT_INIT_STATUS,

Most drivers, however, also allow runtime configuration of nowayout, usually

by adding a module parameter. The conversion for this would be something like:

by adding a module parameter. The conversion for this would be something like::

	watchdog_set_nowayout(&s3c2410_wdd, nowayout);

Replace misc_register(&miscdev) with watchdog_register_device(&watchdog_dev).

Make sure the return value gets checked and the error message, if present,

still fits. Also convert the unregister case.

still fits. Also convert the unregister case::

  -       ret = misc_register(&s3c2410wdt_miscdev);

  +       ret = watchdog_register_device(&s3c2410_wdd);

Make sure you understood Documentation/process/submitting-patches.rst and send your patch to

linux-watchdog@vger.kernel.org. We are looking forward to it :)

Last reviewed: 08/20/2018

===========================

HPE iLO NMI Watchdog Driver

===========================

for iLO based ProLiant Servers

==============================

Last reviewed: 08/20/2018

 The HPE iLO NMI Watchdog driver is a kernel module that provides basic

 watchdog functionality and handler for the iLO "Generate NMI to System"

 The hpwdt driver also has the following module parameters:

 soft_margin - allows the user to set the watchdog timer value.

 ============  ================================================================

 soft_margin   allows the user to set the watchdog timer value.

               Default value is 30 seconds.

 timeout     - an alias of soft_margin.

 pretimeout  - allows the user to set the watchdog pretimeout value.

 timeout       an alias of soft_margin.

 pretimeout    allows the user to set the watchdog pretimeout value.

               This is the number of seconds before timeout when an

               NMI is delivered to the system. Setting the value to

               zero disables the pretimeout NMI.

               Default value is 9 seconds.

 nowayout    - basic watchdog parameter that does not allow the timer to

 nowayout      basic watchdog parameter that does not allow the timer to

               be restarted or an impending ASR to be escaped.

               Default value is set when compiling the kernel. If it is set

               to "Y", then there is no way of disabling the watchdog once

               it has been started.

 ============  ================================================================

 NOTE: More information about watchdog drivers in general, including the ioctl

 NOTE:

       More information about watchdog drivers in general, including the ioctl

       interface to /dev/watchdog can be found in

       Documentation/watchdog/watchdog-api.txt and Documentation/IPMI.txt.

       Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.txt.

 Due to limitations in the iLO hardware, the NMI pretimeout if enabled,

 can only be set to 9 seconds.  Attempts to set pretimeout to other

 The HPE iLO NMI Watchdog Driver and documentation were originally developed

 by Tom Mingarelli.

:orphan:

======================

Linux Watchdog Support

======================

.. toctree::

    :maxdepth: 1

    hpwdt

    mlx-wdt

    pcwd-watchdog

    watchdog-api

    watchdog-kernel-api

    watchdog-parameters

    watchdog-pm

    wdt

    convert_drivers_to_kernel_api

.. only::  subproject and html

   Indices

   =======

   * :ref:`genindex`