]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/watchdog.h
Revert "x86/spec_ctrl: Add sysctl knobs to enable/disable SPEC_CTRL feature"
[mirror_ubuntu-artful-kernel.git] / include / linux / watchdog.h
CommitLineData
1da177e4
LT
1/*
2 * Generic watchdog defines. Derived from..
3 *
4 * Berkshire PC Watchdog Defines
5 * by Ken Hollis <khollis@bitgate.com>
6 *
7 */
1da177e4
LT
8#ifndef _LINUX_WATCHDOG_H
9#define _LINUX_WATCHDOG_H
10
4bfdf378 11
ff0b3cd4 12#include <linux/bitops.h>
45f5fed3 13#include <linux/cdev.h>
664a3923
GR
14#include <linux/device.h>
15#include <linux/kernel.h>
2165bf52 16#include <linux/notifier.h>
607ca46e 17#include <uapi/linux/watchdog.h>
4bfdf378 18
43316044
WVS
19struct watchdog_ops;
20struct watchdog_device;
b4ffb190 21struct watchdog_core_data;
ff84136c 22struct watchdog_governor;
43316044
WVS
23
24/** struct watchdog_ops - The watchdog-devices operations
25 *
26 * @owner: The module owner.
27 * @start: The routine for starting the watchdog device.
28 * @stop: The routine for stopping the watchdog device.
29 * @ping: The routine that sends a keepalive ping to the watchdog device.
2fa03560 30 * @status: The routine that shows the status of the watchdog device.
760d2800 31 * @set_timeout:The routine for setting the watchdog devices timeout value (in seconds).
df044e02 32 * @set_pretimeout:The routine for setting the watchdog devices pretimeout.
760d2800 33 * @get_timeleft:The routine that gets the time left before a reset (in seconds).
2165bf52 34 * @restart: The routine for restarting the machine.
78d88fc0 35 * @ioctl: The routines that handles extra ioctl calls.
43316044
WVS
36 *
37 * The watchdog_ops structure contains a list of low-level operations
38 * that control a watchdog device. It also contains the module that owns
39 * these operations. The start and stop function are mandatory, all other
80220fa7 40 * functions are optional.
43316044
WVS
41 */
42struct watchdog_ops {
43 struct module *owner;
44 /* mandatory operations */
45 int (*start)(struct watchdog_device *);
46 int (*stop)(struct watchdog_device *);
47 /* optional operations */
48 int (*ping)(struct watchdog_device *);
2fa03560 49 unsigned int (*status)(struct watchdog_device *);
014d694e 50 int (*set_timeout)(struct watchdog_device *, unsigned int);
df044e02 51 int (*set_pretimeout)(struct watchdog_device *, unsigned int);
fd7b673c 52 unsigned int (*get_timeleft)(struct watchdog_device *);
4d8b229d 53 int (*restart)(struct watchdog_device *, unsigned long, void *);
78d88fc0 54 long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
43316044
WVS
55};
56
57/** struct watchdog_device - The structure that defines a watchdog device
58 *
45f5fed3 59 * @id: The watchdog's ID. (Allocated by watchdog_register_device)
d6b469d9 60 * @parent: The parent bus device
faa58475
GR
61 * @groups: List of sysfs attribute groups to create when creating the
62 * watchdog device.
43316044
WVS
63 * @info: Pointer to a watchdog_info structure.
64 * @ops: Pointer to the list of watchdog operations.
ff84136c 65 * @gov: Pointer to watchdog pretimeout governor.
2fa03560 66 * @bootstatus: Status of the watchdog device at boot.
760d2800 67 * @timeout: The watchdog devices timeout value (in seconds).
df044e02 68 * @pretimeout: The watchdog devices pre_timeout value.
760d2800 69 * @min_timeout:The watchdog devices minimum timeout value (in seconds).
664a3923
GR
70 * @max_timeout:The watchdog devices maximum timeout value (in seconds)
71 * as configurable from user space. Only relevant if
72 * max_hw_heartbeat_ms is not provided.
15013ad8 73 * @min_hw_heartbeat_ms:
f9f535c1
GR
74 * Hardware limit for minimum time between heartbeats,
75 * in milli-seconds.
664a3923
GR
76 * @max_hw_heartbeat_ms:
77 * Hardware limit for maximum timeout, in milli-seconds.
78 * Replaces max_timeout if specified.
e1313196 79 * @reboot_nb: The notifier block to stop watchdog on reboot.
2165bf52 80 * @restart_nb: The notifier block to register a restart function.
b4ffb190
GR
81 * @driver_data:Pointer to the drivers private data.
82 * @wd_data: Pointer to watchdog core internal data.
43316044 83 * @status: Field that contains the devices internal status bits.
664a3923
GR
84 * @deferred: Entry in wtd_deferred_reg_list which is used to
85 * register early initialized watchdogs.
43316044
WVS
86 *
87 * The watchdog_device structure contains all information about a
88 * watchdog timer device.
89 *
90 * The driver-data field may not be accessed directly. It must be accessed
91 * via the watchdog_set_drvdata and watchdog_get_drvdata helpers.
f4e9c82f
HG
92 *
93 * The lock field is for watchdog core internal use only and should not be
94 * touched.
43316044
WVS
95 */
96struct watchdog_device {
45f5fed3 97 int id;
d6b469d9 98 struct device *parent;
faa58475 99 const struct attribute_group **groups;
43316044
WVS
100 const struct watchdog_info *info;
101 const struct watchdog_ops *ops;
ff84136c 102 const struct watchdog_governor *gov;
2fa03560 103 unsigned int bootstatus;
014d694e 104 unsigned int timeout;
df044e02 105 unsigned int pretimeout;
3f43f68e
WVS
106 unsigned int min_timeout;
107 unsigned int max_timeout;
15013ad8 108 unsigned int min_hw_heartbeat_ms;
664a3923 109 unsigned int max_hw_heartbeat_ms;
e1313196 110 struct notifier_block reboot_nb;
2165bf52 111 struct notifier_block restart_nb;
43316044 112 void *driver_data;
b4ffb190 113 struct watchdog_core_data *wd_data;
43316044
WVS
114 unsigned long status;
115/* Bit numbers for status flags */
234445b4 116#define WDOG_ACTIVE 0 /* Is the watchdog running/active */
b4ffb190
GR
117#define WDOG_NO_WAY_OUT 1 /* Is 'nowayout' feature set ? */
118#define WDOG_STOP_ON_REBOOT 2 /* Should be stopped on reboot */
ee142889 119#define WDOG_HW_RUNNING 3 /* True if HW watchdog running */
bb292ac1 120#define WDOG_STOP_ON_UNREGISTER 4 /* Should be stopped on unregister */
ef90174f 121 struct list_head deferred;
43316044
WVS
122};
123
4846e378
UKK
124#define WATCHDOG_NOWAYOUT IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT)
125#define WATCHDOG_NOWAYOUT_INIT_STATUS (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)
ff0b3cd4 126
48fc7f7e 127/* Use the following function to check whether or not the watchdog is active */
257f8c4a
VK
128static inline bool watchdog_active(struct watchdog_device *wdd)
129{
130 return test_bit(WDOG_ACTIVE, &wdd->status);
131}
132
ee142889
GR
133/*
134 * Use the following function to check whether or not the hardware watchdog
135 * is running
136 */
137static inline bool watchdog_hw_running(struct watchdog_device *wdd)
138{
139 return test_bit(WDOG_HW_RUNNING, &wdd->status);
140}
141
ff0b3cd4 142/* Use the following function to set the nowayout feature */
86a1e189 143static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout)
ff0b3cd4
WVS
144{
145 if (nowayout)
146 set_bit(WDOG_NO_WAY_OUT, &wdd->status);
147}
148
e1313196
DR
149/* Use the following function to stop the watchdog on reboot */
150static inline void watchdog_stop_on_reboot(struct watchdog_device *wdd)
151{
152 set_bit(WDOG_STOP_ON_REBOOT, &wdd->status);
153}
154
bb292ac1
GR
155/* Use the following function to stop the watchdog when unregistering it */
156static inline void watchdog_stop_on_unregister(struct watchdog_device *wdd)
157{
158 set_bit(WDOG_STOP_ON_UNREGISTER, &wdd->status);
159}
160
3048253e
FP
161/* Use the following function to check if a timeout value is invalid */
162static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigned int t)
163{
1e935949
GR
164 /*
165 * The timeout is invalid if
664a3923
GR
166 * - the requested value is larger than UINT_MAX / 1000
167 * (since internal calculations are done in milli-seconds),
168 * or
1e935949
GR
169 * - the requested value is smaller than the configured minimum timeout,
170 * or
664a3923
GR
171 * - a maximum hardware timeout is not configured, a maximum timeout
172 * is configured, and the requested value is larger than the
173 * configured maximum timeout.
1e935949 174 */
664a3923
GR
175 return t > UINT_MAX / 1000 || t < wdd->min_timeout ||
176 (!wdd->max_hw_heartbeat_ms && wdd->max_timeout &&
177 t > wdd->max_timeout);
3048253e
FP
178}
179
df044e02
WS
180/* Use the following function to check if a pretimeout value is invalid */
181static inline bool watchdog_pretimeout_invalid(struct watchdog_device *wdd,
182 unsigned int t)
183{
184 return t && wdd->timeout && t >= wdd->timeout;
185}
186
43316044
WVS
187/* Use the following functions to manipulate watchdog driver specific data */
188static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data)
189{
190 wdd->driver_data = data;
191}
192
193static inline void *watchdog_get_drvdata(struct watchdog_device *wdd)
194{
195 return wdd->driver_data;
196}
197
ff84136c
VZ
198/* Use the following functions to report watchdog pretimeout event */
199#if IS_ENABLED(CONFIG_WATCHDOG_PRETIMEOUT_GOV)
200void watchdog_notify_pretimeout(struct watchdog_device *wdd);
201#else
202static inline void watchdog_notify_pretimeout(struct watchdog_device *wdd)
203{
204 pr_alert("watchdog%d: pretimeout event\n", wdd->id);
205}
206#endif
207
cf13a84d 208/* drivers/watchdog/watchdog_core.c */
2165bf52 209void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority);
3048253e
FP
210extern int watchdog_init_timeout(struct watchdog_device *wdd,
211 unsigned int timeout_parm, struct device *dev);
43316044
WVS
212extern int watchdog_register_device(struct watchdog_device *);
213extern void watchdog_unregister_device(struct watchdog_device *);
214
83fbae5a
NA
215/* devres register variant */
216int devm_watchdog_register_device(struct device *dev, struct watchdog_device *);
217
1da177e4 218#endif /* ifndef _LINUX_WATCHDOG_H */