watchdog: WatchDog Timer Driver Core - Add Magic Close feature
[linux-drm-fsl-dcu.git] / Documentation / watchdog / watchdog-kernel-api.txt
1 The Linux WatchDog Timer Driver Core kernel API.
2 ===============================================
3 Last reviewed: 22-Jul-2011
4
5 Wim Van Sebroeck <wim@iguana.be>
6
7 Introduction
8 ------------
9 This document does not describe what a WatchDog Timer (WDT) Driver or Device is.
10 It also does not describe the API which can be used by user space to communicate
11 with a WatchDog Timer. If you want to know this then please read the following
12 file: Documentation/watchdog/watchdog-api.txt .
13
14 So what does this document describe? It describes the API that can be used by
15 WatchDog Timer Drivers that want to use the WatchDog Timer Driver Core
16 Framework. This framework provides all interfacing towards user space so that
17 the same code does not have to be reproduced each time. This also means that
18 a watchdog timer driver then only needs to provide the different routines
19 (operations) that control the watchdog timer (WDT).
20
21 The API
22 -------
23 Each watchdog timer driver that wants to use the WatchDog Timer Driver Core
24 must #include <linux/watchdog.h> (you would have to do this anyway when
25 writing a watchdog device driver). This include file contains following
26 register/unregister routines:
27
28 extern int watchdog_register_device(struct watchdog_device *);
29 extern void watchdog_unregister_device(struct watchdog_device *);
30
31 The watchdog_register_device routine registers a watchdog timer device.
32 The parameter of this routine is a pointer to a watchdog_device structure.
33 This routine returns zero on success and a negative errno code for failure.
34
35 The watchdog_unregister_device routine deregisters a registered watchdog timer
36 device. The parameter of this routine is the pointer to the registered
37 watchdog_device structure.
38
39 The watchdog device structure looks like this:
40
41 struct watchdog_device {
42         const struct watchdog_info *info;
43         const struct watchdog_ops *ops;
44         unsigned int bootstatus;
45         unsigned int timeout;
46         void *driver_data;
47         unsigned long status;
48 };
49
50 It contains following fields:
51 * info: a pointer to a watchdog_info structure. This structure gives some
52   additional information about the watchdog timer itself. (Like it's unique name)
53 * ops: a pointer to the list of watchdog operations that the watchdog supports.
54 * timeout: the watchdog timer's timeout value (in seconds).
55 * bootstatus: status of the device after booting (reported with watchdog
56   WDIOF_* status bits).
57 * driver_data: a pointer to the drivers private data of a watchdog device.
58   This data should only be accessed via the watchdog_set_drvadata and
59   watchdog_get_drvdata routines.
60 * status: this field contains a number of status bits that give extra
61   information about the status of the device (Like: is the watchdog timer
62   running/active, is the device opened via the /dev/watchdog interface or not,
63   ...).
64
65 The list of watchdog operations is defined as:
66
67 struct watchdog_ops {
68         struct module *owner;
69         /* mandatory operations */
70         int (*start)(struct watchdog_device *);
71         int (*stop)(struct watchdog_device *);
72         /* optional operations */
73         int (*ping)(struct watchdog_device *);
74         unsigned int (*status)(struct watchdog_device *);
75         int (*set_timeout)(struct watchdog_device *, unsigned int);
76 };
77
78 It is important that you first define the module owner of the watchdog timer
79 driver's operations. This module owner will be used to lock the module when
80 the watchdog is active. (This to avoid a system crash when you unload the
81 module and /dev/watchdog is still open).
82 Some operations are mandatory and some are optional. The mandatory operations
83 are:
84 * start: this is a pointer to the routine that starts the watchdog timer
85   device.
86   The routine needs a pointer to the watchdog timer device structure as a
87   parameter. It returns zero on success or a negative errno code for failure.
88 * stop: with this routine the watchdog timer device is being stopped.
89   The routine needs a pointer to the watchdog timer device structure as a
90   parameter. It returns zero on success or a negative errno code for failure.
91   Some watchdog timer hardware can only be started and not be stopped. The
92   driver supporting this hardware needs to make sure that a start and stop
93   routine is being provided. This can be done by using a timer in the driver
94   that regularly sends a keepalive ping to the watchdog timer hardware.
95
96 Not all watchdog timer hardware supports the same functionality. That's why
97 all other routines/operations are optional. They only need to be provided if
98 they are supported. These optional routines/operations are:
99 * ping: this is the routine that sends a keepalive ping to the watchdog timer
100   hardware.
101   The routine needs a pointer to the watchdog timer device structure as a
102   parameter. It returns zero on success or a negative errno code for failure.
103   Most hardware that does not support this as a separate function uses the
104   start function to restart the watchdog timer hardware. And that's also what
105   the watchdog timer driver core does: to send a keepalive ping to the watchdog
106   timer hardware it will either use the ping operation (when available) or the
107   start operation (when the ping operation is not available).
108   (Note: the WDIOC_KEEPALIVE ioctl call will only be active when the
109   WDIOF_KEEPALIVEPING bit has been set in the option field on the watchdog's
110   info structure).
111 * status: this routine checks the status of the watchdog timer device. The
112   status of the device is reported with watchdog WDIOF_* status flags/bits.
113 * set_timeout: this routine checks and changes the timeout of the watchdog
114   timer device. It returns 0 on success, -EINVAL for "parameter out of range"
115   and -EIO for "could not write value to the watchdog". On success the timeout
116   value of the watchdog_device will be changed to the value that was just used
117   to re-program the watchdog timer device.
118   (Note: the WDIOF_SETTIMEOUT needs to be set in the options field of the
119   watchdog's info structure).
120
121 The status bits should (preferably) be set with the set_bit and clear_bit alike
122 bit-operations. The status bits that are defined are:
123 * WDOG_ACTIVE: this status bit indicates whether or not a watchdog timer device
124   is active or not. When the watchdog is active after booting, then you should
125   set this status bit (Note: when you register the watchdog timer device with
126   this bit set, then opening /dev/watchdog will skip the start operation)
127 * WDOG_DEV_OPEN: this status bit shows whether or not the watchdog device
128   was opened via /dev/watchdog.
129   (This bit should only be used by the WatchDog Timer Driver Core).
130 * WDOG_ALLOW_RELEASE: this bit stores whether or not the magic close character
131   has been sent (so that we can support the magic close feature).
132   (This bit should only be used by the WatchDog Timer Driver Core).
133
134 Note: The WatchDog Timer Driver Core supports the magic close feature. To use
135 the magic close feature you must set the WDIOF_MAGICCLOSE bit in the options
136 field of the watchdog's info structure.
137
138 To get or set driver specific data the following two helper functions should be
139 used:
140
141 static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data)
142 static inline void *watchdog_get_drvdata(struct watchdog_device *wdd)
143
144 The watchdog_set_drvdata function allows you to add driver specific data. The
145 arguments of this function are the watchdog device where you want to add the
146 driver specific data to and a pointer to the data itself.
147
148 The watchdog_get_drvdata function allows you to retrieve driver specific data.
149 The argument of this function is the watchdog device where you want to retrieve
150 data from. The function retruns the pointer to the driver specific data.