]>
Commit | Line | Data |
---|---|---|
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 AC |
13 | #include <linux/device.h> |
14 | #include <linux/cdev.h> | |
2165bf52 | 15 | #include <linux/notifier.h> |
607ca46e | 16 | #include <uapi/linux/watchdog.h> |
4bfdf378 | 17 | |
43316044 WVS |
18 | struct watchdog_ops; |
19 | struct watchdog_device; | |
20 | ||
21 | /** struct watchdog_ops - The watchdog-devices operations | |
22 | * | |
23 | * @owner: The module owner. | |
24 | * @start: The routine for starting the watchdog device. | |
25 | * @stop: The routine for stopping the watchdog device. | |
26 | * @ping: The routine that sends a keepalive ping to the watchdog device. | |
2fa03560 | 27 | * @status: The routine that shows the status of the watchdog device. |
760d2800 WS |
28 | * @set_timeout:The routine for setting the watchdog devices timeout value (in seconds). |
29 | * @get_timeleft:The routine that gets the time left before a reset (in seconds). | |
2165bf52 | 30 | * @restart: The routine for restarting the machine. |
e907df32 HG |
31 | * @ref: The ref operation for dyn. allocated watchdog_device structs |
32 | * @unref: The unref operation for dyn. allocated watchdog_device structs | |
78d88fc0 | 33 | * @ioctl: The routines that handles extra ioctl calls. |
43316044 WVS |
34 | * |
35 | * The watchdog_ops structure contains a list of low-level operations | |
36 | * that control a watchdog device. It also contains the module that owns | |
37 | * these operations. The start and stop function are mandatory, all other | |
80220fa7 | 38 | * functions are optional. |
43316044 WVS |
39 | */ |
40 | struct watchdog_ops { | |
41 | struct module *owner; | |
42 | /* mandatory operations */ | |
43 | int (*start)(struct watchdog_device *); | |
44 | int (*stop)(struct watchdog_device *); | |
45 | /* optional operations */ | |
46 | int (*ping)(struct watchdog_device *); | |
2fa03560 | 47 | unsigned int (*status)(struct watchdog_device *); |
014d694e | 48 | int (*set_timeout)(struct watchdog_device *, unsigned int); |
fd7b673c | 49 | unsigned int (*get_timeleft)(struct watchdog_device *); |
2165bf52 | 50 | int (*restart)(struct watchdog_device *); |
e907df32 HG |
51 | void (*ref)(struct watchdog_device *); |
52 | void (*unref)(struct watchdog_device *); | |
78d88fc0 | 53 | long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long); |
43316044 WVS |
54 | }; |
55 | ||
56 | /** struct watchdog_device - The structure that defines a watchdog device | |
57 | * | |
45f5fed3 AC |
58 | * @id: The watchdog's ID. (Allocated by watchdog_register_device) |
59 | * @cdev: The watchdog's Character device. | |
d6b469d9 AC |
60 | * @dev: The device for our watchdog |
61 | * @parent: The parent bus device | |
43316044 WVS |
62 | * @info: Pointer to a watchdog_info structure. |
63 | * @ops: Pointer to the list of watchdog operations. | |
2fa03560 | 64 | * @bootstatus: Status of the watchdog device at boot. |
760d2800 WS |
65 | * @timeout: The watchdog devices timeout value (in seconds). |
66 | * @min_timeout:The watchdog devices minimum timeout value (in seconds). | |
67 | * @max_timeout:The watchdog devices maximum timeout value (in seconds). | |
e1313196 | 68 | * @reboot_nb: The notifier block to stop watchdog on reboot. |
2165bf52 | 69 | * @restart_nb: The notifier block to register a restart function. |
43316044 | 70 | * @driver-data:Pointer to the drivers private data. |
f4e9c82f | 71 | * @lock: Lock for watchdog core internal use only. |
43316044 | 72 | * @status: Field that contains the devices internal status bits. |
ef90174f JBT |
73 | * @deferred: entry in wtd_deferred_reg_list which is used to |
74 | * register early initialized watchdogs. | |
43316044 WVS |
75 | * |
76 | * The watchdog_device structure contains all information about a | |
77 | * watchdog timer device. | |
78 | * | |
79 | * The driver-data field may not be accessed directly. It must be accessed | |
80 | * via the watchdog_set_drvdata and watchdog_get_drvdata helpers. | |
f4e9c82f HG |
81 | * |
82 | * The lock field is for watchdog core internal use only and should not be | |
83 | * touched. | |
43316044 WVS |
84 | */ |
85 | struct watchdog_device { | |
45f5fed3 AC |
86 | int id; |
87 | struct cdev cdev; | |
d6b469d9 AC |
88 | struct device *dev; |
89 | struct device *parent; | |
43316044 WVS |
90 | const struct watchdog_info *info; |
91 | const struct watchdog_ops *ops; | |
2fa03560 | 92 | unsigned int bootstatus; |
014d694e | 93 | unsigned int timeout; |
3f43f68e WVS |
94 | unsigned int min_timeout; |
95 | unsigned int max_timeout; | |
e1313196 | 96 | struct notifier_block reboot_nb; |
2165bf52 | 97 | struct notifier_block restart_nb; |
43316044 | 98 | void *driver_data; |
f4e9c82f | 99 | struct mutex lock; |
43316044 WVS |
100 | unsigned long status; |
101 | /* Bit numbers for status flags */ | |
234445b4 | 102 | #define WDOG_ACTIVE 0 /* Is the watchdog running/active */ |
43316044 | 103 | #define WDOG_DEV_OPEN 1 /* Opened via /dev/watchdog ? */ |
017cf080 | 104 | #define WDOG_ALLOW_RELEASE 2 /* Did we receive the magic char ? */ |
7e192b9c | 105 | #define WDOG_NO_WAY_OUT 3 /* Is 'nowayout' feature set ? */ |
e907df32 | 106 | #define WDOG_UNREGISTERED 4 /* Has the device been unregistered */ |
e1313196 | 107 | #define WDOG_STOP_ON_REBOOT 5 /* Should be stopped on reboot */ |
ef90174f | 108 | struct list_head deferred; |
43316044 WVS |
109 | }; |
110 | ||
4846e378 UKK |
111 | #define WATCHDOG_NOWAYOUT IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT) |
112 | #define WATCHDOG_NOWAYOUT_INIT_STATUS (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT) | |
ff0b3cd4 | 113 | |
48fc7f7e | 114 | /* Use the following function to check whether or not the watchdog is active */ |
257f8c4a VK |
115 | static inline bool watchdog_active(struct watchdog_device *wdd) |
116 | { | |
117 | return test_bit(WDOG_ACTIVE, &wdd->status); | |
118 | } | |
119 | ||
ff0b3cd4 | 120 | /* Use the following function to set the nowayout feature */ |
86a1e189 | 121 | static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout) |
ff0b3cd4 WVS |
122 | { |
123 | if (nowayout) | |
124 | set_bit(WDOG_NO_WAY_OUT, &wdd->status); | |
125 | } | |
126 | ||
e1313196 DR |
127 | /* Use the following function to stop the watchdog on reboot */ |
128 | static inline void watchdog_stop_on_reboot(struct watchdog_device *wdd) | |
129 | { | |
130 | set_bit(WDOG_STOP_ON_REBOOT, &wdd->status); | |
131 | } | |
132 | ||
3048253e FP |
133 | /* Use the following function to check if a timeout value is invalid */ |
134 | static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigned int t) | |
135 | { | |
1e935949 GR |
136 | /* |
137 | * The timeout is invalid if | |
138 | * - the requested value is smaller than the configured minimum timeout, | |
139 | * or | |
140 | * - a maximum timeout is configured, and the requested value is larger | |
141 | * than the maximum timeout. | |
142 | */ | |
143 | return t < wdd->min_timeout || | |
144 | (wdd->max_timeout && t > wdd->max_timeout); | |
3048253e FP |
145 | } |
146 | ||
43316044 WVS |
147 | /* Use the following functions to manipulate watchdog driver specific data */ |
148 | static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data) | |
149 | { | |
150 | wdd->driver_data = data; | |
151 | } | |
152 | ||
153 | static inline void *watchdog_get_drvdata(struct watchdog_device *wdd) | |
154 | { | |
155 | return wdd->driver_data; | |
156 | } | |
157 | ||
cf13a84d | 158 | /* drivers/watchdog/watchdog_core.c */ |
2165bf52 | 159 | void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority); |
3048253e FP |
160 | extern int watchdog_init_timeout(struct watchdog_device *wdd, |
161 | unsigned int timeout_parm, struct device *dev); | |
43316044 WVS |
162 | extern int watchdog_register_device(struct watchdog_device *); |
163 | extern void watchdog_unregister_device(struct watchdog_device *); | |
164 | ||
1da177e4 | 165 | #endif /* ifndef _LINUX_WATCHDOG_H */ |