blob: 4b381a6be2ff5a45e80f8a336e1ec9631b356c4c [file] [log] [blame]
Wim Van Sebroeck43316042011-07-22 18:55:18 +00001/*
2 * watchdog_dev.c
3 *
4 * (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
5 * All Rights Reserved.
6 *
7 * (c) Copyright 2008-2011 Wim Van Sebroeck <wim@iguana.be>.
8 *
9 *
10 * This source code is part of the generic code that can be used
11 * by all the watchdog timer drivers.
12 *
13 * This part of the generic code takes care of the following
14 * misc device: /dev/watchdog.
15 *
16 * Based on source code of the following authors:
17 * Matt Domsch <Matt_Domsch@dell.com>,
18 * Rob Radez <rob@osinvestor.com>,
19 * Rusty Lynch <rusty@linux.co.intel.com>
20 * Satyam Sharma <satyam@infradead.org>
21 * Randy Dunlap <randy.dunlap@oracle.com>
22 *
23 * This program is free software; you can redistribute it and/or
24 * modify it under the terms of the GNU General Public License
25 * as published by the Free Software Foundation; either version
26 * 2 of the License, or (at your option) any later version.
27 *
28 * Neither Alan Cox, CymruNet Ltd., Wim Van Sebroeck nor Iguana vzw.
29 * admit liability nor provide warranty for any of this software.
30 * This material is provided "AS-IS" and at no charge.
31 */
32
33#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
34
Guenter Roeckb4ffb192015-12-25 16:01:42 -080035#include <linux/cdev.h> /* For character device */
Wim Van Sebroeck43316042011-07-22 18:55:18 +000036#include <linux/errno.h> /* For the -ENODEV/... values */
Wim Van Sebroeck43316042011-07-22 18:55:18 +000037#include <linux/fs.h> /* For file operations */
Wim Van Sebroeck43316042011-07-22 18:55:18 +000038#include <linux/init.h> /* For __init/__exit/... */
Guenter Roeck664a3922016-02-28 13:12:15 -080039#include <linux/jiffies.h> /* For timeout functions */
Guenter Roeckb4ffb192015-12-25 16:01:42 -080040#include <linux/kernel.h> /* For printk/panic/... */
41#include <linux/kref.h> /* For data references */
42#include <linux/miscdevice.h> /* For handling misc devices */
43#include <linux/module.h> /* For module stuff/... */
44#include <linux/mutex.h> /* For mutexes */
45#include <linux/slab.h> /* For memory functions */
46#include <linux/types.h> /* For standard types (like size_t) */
47#include <linux/watchdog.h> /* For watchdog specific items */
Guenter Roeck664a3922016-02-28 13:12:15 -080048#include <linux/workqueue.h> /* For workqueue */
Wim Van Sebroeck43316042011-07-22 18:55:18 +000049#include <linux/uaccess.h> /* For copy_to_user/put_user/... */
50
Wim Van Sebroeck6cfb5aa2012-05-21 15:31:06 +020051#include "watchdog_core.h"
H Hartley Sweeten09a46e72012-04-20 13:28:24 -070052
Guenter Roeckb4ffb192015-12-25 16:01:42 -080053/*
54 * struct watchdog_core_data - watchdog core internal data
55 * @kref: Reference count.
56 * @cdev: The watchdog's Character device.
57 * @wdd: Pointer to watchdog device.
58 * @lock: Lock for watchdog core.
59 * @status: Watchdog core internal status bits.
60 */
61struct watchdog_core_data {
62 struct kref kref;
63 struct cdev cdev;
64 struct watchdog_device *wdd;
65 struct mutex lock;
Guenter Roeck664a3922016-02-28 13:12:15 -080066 unsigned long last_keepalive;
Guenter Roeck15013ad2016-02-28 13:12:18 -080067 unsigned long last_hw_keepalive;
Guenter Roeck664a3922016-02-28 13:12:15 -080068 struct delayed_work work;
Guenter Roeckb4ffb192015-12-25 16:01:42 -080069 unsigned long status; /* Internal status bits */
70#define _WDOG_DEV_OPEN 0 /* Opened ? */
71#define _WDOG_ALLOW_RELEASE 1 /* Did we receive the magic char ? */
Guenter Roeck90b826f2016-07-17 15:04:11 -070072#define _WDOG_KEEPALIVE 2 /* Did we receive a keepalive ? */
Guenter Roeckb4ffb192015-12-25 16:01:42 -080073};
74
Alan Cox45f5fed2012-05-10 21:48:59 +020075/* the dev_t structure to store the dynamically allocated watchdog devices */
76static dev_t watchdog_devt;
Guenter Roeckb4ffb192015-12-25 16:01:42 -080077/* Reference to watchdog device behind /dev/watchdog */
78static struct watchdog_core_data *old_wd_data;
Wim Van Sebroeck43316042011-07-22 18:55:18 +000079
Guenter Roeck664a3922016-02-28 13:12:15 -080080static struct workqueue_struct *watchdog_wq;
81
82static inline bool watchdog_need_worker(struct watchdog_device *wdd)
83{
84 /* All variables in milli-seconds */
85 unsigned int hm = wdd->max_hw_heartbeat_ms;
86 unsigned int t = wdd->timeout * 1000;
87
88 /*
89 * A worker to generate heartbeat requests is needed if all of the
90 * following conditions are true.
91 * - Userspace activated the watchdog.
92 * - The driver provided a value for the maximum hardware timeout, and
93 * thus is aware that the framework supports generating heartbeat
94 * requests.
95 * - Userspace requests a longer timeout than the hardware can handle.
Rasmus Villemoes3fbfe922016-07-14 11:16:26 +020096 *
97 * Alternatively, if userspace has not opened the watchdog
98 * device, we take care of feeding the watchdog if it is
99 * running.
Guenter Roeck664a3922016-02-28 13:12:15 -0800100 */
Rasmus Villemoes3fbfe922016-07-14 11:16:26 +0200101 return (hm && watchdog_active(wdd) && t > hm) ||
102 (t && !watchdog_active(wdd) && watchdog_hw_running(wdd));
Guenter Roeck664a3922016-02-28 13:12:15 -0800103}
104
105static long watchdog_next_keepalive(struct watchdog_device *wdd)
106{
107 struct watchdog_core_data *wd_data = wdd->wd_data;
108 unsigned int timeout_ms = wdd->timeout * 1000;
109 unsigned long keepalive_interval;
110 unsigned long last_heartbeat;
111 unsigned long virt_timeout;
112 unsigned int hw_heartbeat_ms;
113
114 virt_timeout = wd_data->last_keepalive + msecs_to_jiffies(timeout_ms);
Rasmus Villemoes3fbfe922016-07-14 11:16:26 +0200115 hw_heartbeat_ms = min_not_zero(timeout_ms, wdd->max_hw_heartbeat_ms);
Guenter Roeck664a3922016-02-28 13:12:15 -0800116 keepalive_interval = msecs_to_jiffies(hw_heartbeat_ms / 2);
117
Guenter Roeckee142882016-02-28 13:12:16 -0800118 if (!watchdog_active(wdd))
119 return keepalive_interval;
120
Guenter Roeck664a3922016-02-28 13:12:15 -0800121 /*
122 * To ensure that the watchdog times out wdd->timeout seconds
123 * after the most recent ping from userspace, the last
124 * worker ping has to come in hw_heartbeat_ms before this timeout.
125 */
126 last_heartbeat = virt_timeout - msecs_to_jiffies(hw_heartbeat_ms);
127 return min_t(long, last_heartbeat - jiffies, keepalive_interval);
128}
129
130static inline void watchdog_update_worker(struct watchdog_device *wdd)
131{
132 struct watchdog_core_data *wd_data = wdd->wd_data;
133
134 if (watchdog_need_worker(wdd)) {
135 long t = watchdog_next_keepalive(wdd);
136
137 if (t > 0)
138 mod_delayed_work(watchdog_wq, &wd_data->work, t);
139 } else {
140 cancel_delayed_work(&wd_data->work);
141 }
142}
143
144static int __watchdog_ping(struct watchdog_device *wdd)
145{
Guenter Roeck15013ad2016-02-28 13:12:18 -0800146 struct watchdog_core_data *wd_data = wdd->wd_data;
147 unsigned long earliest_keepalive = wd_data->last_hw_keepalive +
148 msecs_to_jiffies(wdd->min_hw_heartbeat_ms);
Guenter Roeck664a3922016-02-28 13:12:15 -0800149 int err;
150
Guenter Roeck15013ad2016-02-28 13:12:18 -0800151 if (time_is_after_jiffies(earliest_keepalive)) {
152 mod_delayed_work(watchdog_wq, &wd_data->work,
153 earliest_keepalive - jiffies);
154 return 0;
155 }
156
157 wd_data->last_hw_keepalive = jiffies;
158
Guenter Roeck664a3922016-02-28 13:12:15 -0800159 if (wdd->ops->ping)
160 err = wdd->ops->ping(wdd); /* ping the watchdog */
161 else
162 err = wdd->ops->start(wdd); /* restart watchdog */
163
164 watchdog_update_worker(wdd);
165
166 return err;
167}
168
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000169/*
170 * watchdog_ping: ping the watchdog.
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700171 * @wdd: the watchdog device to ping
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000172 *
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800173 * The caller must hold wd_data->lock.
174 *
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000175 * If the watchdog has no own ping operation then it needs to be
176 * restarted via the start operation. This wrapper function does
177 * exactly that.
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000178 * We only ping when the watchdog device is running.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000179 */
180
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700181static int watchdog_ping(struct watchdog_device *wdd)
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000182{
Guenter Roeck664a3922016-02-28 13:12:15 -0800183 struct watchdog_core_data *wd_data = wdd->wd_data;
Hans de Goedee907df32012-05-22 11:40:26 +0200184
Guenter Roeckee142882016-02-28 13:12:16 -0800185 if (!watchdog_active(wdd) && !watchdog_hw_running(wdd))
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800186 return 0;
Hans de Goede7a879822012-05-22 11:40:26 +0200187
Guenter Roeck90b826f2016-07-17 15:04:11 -0700188 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
189
Guenter Roeck664a3922016-02-28 13:12:15 -0800190 wd_data->last_keepalive = jiffies;
191 return __watchdog_ping(wdd);
192}
Hans de Goede7a879822012-05-22 11:40:26 +0200193
Guenter Roeck664a3922016-02-28 13:12:15 -0800194static void watchdog_ping_work(struct work_struct *work)
195{
196 struct watchdog_core_data *wd_data;
197 struct watchdog_device *wdd;
198
199 wd_data = container_of(to_delayed_work(work), struct watchdog_core_data,
200 work);
201
202 mutex_lock(&wd_data->lock);
203 wdd = wd_data->wdd;
Guenter Roeckee142882016-02-28 13:12:16 -0800204 if (wdd && (watchdog_active(wdd) || watchdog_hw_running(wdd)))
Guenter Roeck664a3922016-02-28 13:12:15 -0800205 __watchdog_ping(wdd);
206 mutex_unlock(&wd_data->lock);
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000207}
208
209/*
210 * watchdog_start: wrapper to start the watchdog.
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700211 * @wdd: the watchdog device to start
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000212 *
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800213 * The caller must hold wd_data->lock.
214 *
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000215 * Start the watchdog if it is not active and mark it active.
216 * This function returns zero on success or a negative errno code for
217 * failure.
218 */
219
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700220static int watchdog_start(struct watchdog_device *wdd)
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000221{
Guenter Roeck664a3922016-02-28 13:12:15 -0800222 struct watchdog_core_data *wd_data = wdd->wd_data;
223 unsigned long started_at;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800224 int err;
Hans de Goedee907df32012-05-22 11:40:26 +0200225
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700226 if (watchdog_active(wdd))
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800227 return 0;
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000228
Guenter Roeck90b826f2016-07-17 15:04:11 -0700229 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
230
Guenter Roeck664a3922016-02-28 13:12:15 -0800231 started_at = jiffies;
Guenter Roeckee142882016-02-28 13:12:16 -0800232 if (watchdog_hw_running(wdd) && wdd->ops->ping)
233 err = wdd->ops->ping(wdd);
234 else
235 err = wdd->ops->start(wdd);
Guenter Roeck664a3922016-02-28 13:12:15 -0800236 if (err == 0) {
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700237 set_bit(WDOG_ACTIVE, &wdd->status);
Guenter Roeck664a3922016-02-28 13:12:15 -0800238 wd_data->last_keepalive = started_at;
239 watchdog_update_worker(wdd);
240 }
Hans de Goede7a879822012-05-22 11:40:26 +0200241
Hans de Goede7a879822012-05-22 11:40:26 +0200242 return err;
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000243}
244
245/*
246 * watchdog_stop: wrapper to stop the watchdog.
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700247 * @wdd: the watchdog device to stop
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000248 *
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800249 * The caller must hold wd_data->lock.
250 *
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000251 * Stop the watchdog if it is still active and unmark it active.
252 * This function returns zero on success or a negative errno code for
253 * failure.
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000254 * If the 'nowayout' feature was set, the watchdog cannot be stopped.
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000255 */
256
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700257static int watchdog_stop(struct watchdog_device *wdd)
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000258{
Guenter Roeckee142882016-02-28 13:12:16 -0800259 int err = 0;
Hans de Goedee907df32012-05-22 11:40:26 +0200260
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700261 if (!watchdog_active(wdd))
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800262 return 0;
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000263
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700264 if (test_bit(WDOG_NO_WAY_OUT, &wdd->status)) {
Guenter Roeck0254e952016-01-03 15:11:58 -0800265 pr_info("watchdog%d: nowayout prevents watchdog being stopped!\n",
266 wdd->id);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800267 return -EBUSY;
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000268 }
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000269
Guenter Roeck3c10bbd2016-07-21 14:21:56 -0700270 if (wdd->ops->stop) {
271 clear_bit(WDOG_HW_RUNNING, &wdd->status);
Guenter Roeckd0684c82016-02-28 13:12:17 -0800272 err = wdd->ops->stop(wdd);
Guenter Roeck3c10bbd2016-07-21 14:21:56 -0700273 } else {
Guenter Roeckd0684c82016-02-28 13:12:17 -0800274 set_bit(WDOG_HW_RUNNING, &wdd->status);
Guenter Roeck3c10bbd2016-07-21 14:21:56 -0700275 }
Guenter Roeckd0684c82016-02-28 13:12:17 -0800276
Guenter Roeck664a3922016-02-28 13:12:15 -0800277 if (err == 0) {
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700278 clear_bit(WDOG_ACTIVE, &wdd->status);
Guenter Roeckee142882016-02-28 13:12:16 -0800279 watchdog_update_worker(wdd);
Guenter Roeck664a3922016-02-28 13:12:15 -0800280 }
Hans de Goede7a879822012-05-22 11:40:26 +0200281
Hans de Goede7a879822012-05-22 11:40:26 +0200282 return err;
283}
284
285/*
286 * watchdog_get_status: wrapper to get the watchdog status
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700287 * @wdd: the watchdog device to get the status from
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800288 *
289 * The caller must hold wd_data->lock.
Hans de Goede7a879822012-05-22 11:40:26 +0200290 *
291 * Get the watchdog's status flags.
292 */
293
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800294static unsigned int watchdog_get_status(struct watchdog_device *wdd)
Hans de Goede7a879822012-05-22 11:40:26 +0200295{
Guenter Roeck90b826f2016-07-17 15:04:11 -0700296 struct watchdog_core_data *wd_data = wdd->wd_data;
297 unsigned int status;
Hans de Goede7a879822012-05-22 11:40:26 +0200298
Guenter Roeck90b826f2016-07-17 15:04:11 -0700299 if (wdd->ops->status)
300 status = wdd->ops->status(wdd);
301 else
302 status = wdd->bootstatus & (WDIOF_CARDRESET |
303 WDIOF_OVERHEAT |
304 WDIOF_FANFAULT |
305 WDIOF_EXTERN1 |
306 WDIOF_EXTERN2 |
307 WDIOF_POWERUNDER |
308 WDIOF_POWEROVER);
309
310 if (test_bit(_WDOG_ALLOW_RELEASE, &wd_data->status))
311 status |= WDIOF_MAGICCLOSE;
312
313 if (test_and_clear_bit(_WDOG_KEEPALIVE, &wd_data->status))
314 status |= WDIOF_KEEPALIVEPING;
315
316 return status;
Hans de Goede7a879822012-05-22 11:40:26 +0200317}
318
319/*
320 * watchdog_set_timeout: set the watchdog timer timeout
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700321 * @wdd: the watchdog device to set the timeout for
Hans de Goede7a879822012-05-22 11:40:26 +0200322 * @timeout: timeout to set in seconds
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800323 *
324 * The caller must hold wd_data->lock.
Hans de Goede7a879822012-05-22 11:40:26 +0200325 */
326
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700327static int watchdog_set_timeout(struct watchdog_device *wdd,
Hans de Goede7a879822012-05-22 11:40:26 +0200328 unsigned int timeout)
329{
Guenter Roeckfb32e9b2016-02-28 13:12:14 -0800330 int err = 0;
331
332 if (!(wdd->info->options & WDIOF_SETTIMEOUT))
Hans de Goede7a879822012-05-22 11:40:26 +0200333 return -EOPNOTSUPP;
334
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700335 if (watchdog_timeout_invalid(wdd, timeout))
Hans de Goede7a879822012-05-22 11:40:26 +0200336 return -EINVAL;
337
Wolfram Sangdf044e02016-08-31 14:52:41 +0300338 if (wdd->ops->set_timeout) {
Guenter Roeckfb32e9b2016-02-28 13:12:14 -0800339 err = wdd->ops->set_timeout(wdd, timeout);
Wolfram Sangdf044e02016-08-31 14:52:41 +0300340 } else {
Guenter Roeckfb32e9b2016-02-28 13:12:14 -0800341 wdd->timeout = timeout;
Wolfram Sangdf044e02016-08-31 14:52:41 +0300342 /* Disable pretimeout if it doesn't fit the new timeout */
343 if (wdd->pretimeout >= wdd->timeout)
344 wdd->pretimeout = 0;
345 }
Guenter Roeckfb32e9b2016-02-28 13:12:14 -0800346
Guenter Roeck664a3922016-02-28 13:12:15 -0800347 watchdog_update_worker(wdd);
348
Guenter Roeckfb32e9b2016-02-28 13:12:14 -0800349 return err;
Hans de Goede7a879822012-05-22 11:40:26 +0200350}
351
352/*
Wolfram Sangdf044e02016-08-31 14:52:41 +0300353 * watchdog_set_pretimeout: set the watchdog timer pretimeout
354 * @wdd: the watchdog device to set the timeout for
355 * @timeout: pretimeout to set in seconds
356 */
357
358static int watchdog_set_pretimeout(struct watchdog_device *wdd,
359 unsigned int timeout)
360{
361 int err = 0;
362
363 if (!(wdd->info->options & WDIOF_PRETIMEOUT))
364 return -EOPNOTSUPP;
365
366 if (watchdog_pretimeout_invalid(wdd, timeout))
367 return -EINVAL;
368
369 if (wdd->ops->set_pretimeout)
370 err = wdd->ops->set_pretimeout(wdd, timeout);
371 else
372 wdd->pretimeout = timeout;
373
374 return err;
375}
376
377/*
Hans de Goede7a879822012-05-22 11:40:26 +0200378 * watchdog_get_timeleft: wrapper to get the time left before a reboot
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700379 * @wdd: the watchdog device to get the remaining time from
Hans de Goede7a879822012-05-22 11:40:26 +0200380 * @timeleft: the time that's left
381 *
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800382 * The caller must hold wd_data->lock.
383 *
Hans de Goede7a879822012-05-22 11:40:26 +0200384 * Get the time before a watchdog will reboot (if not pinged).
385 */
386
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700387static int watchdog_get_timeleft(struct watchdog_device *wdd,
Hans de Goede7a879822012-05-22 11:40:26 +0200388 unsigned int *timeleft)
389{
Hans de Goede7a879822012-05-22 11:40:26 +0200390 *timeleft = 0;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800391
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700392 if (!wdd->ops->get_timeleft)
Hans de Goede7a879822012-05-22 11:40:26 +0200393 return -EOPNOTSUPP;
394
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700395 *timeleft = wdd->ops->get_timeleft(wdd);
Hans de Goede7a879822012-05-22 11:40:26 +0200396
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800397 return 0;
Hans de Goede7a879822012-05-22 11:40:26 +0200398}
399
Pratyush Anand33b71122015-12-17 17:53:59 +0530400#ifdef CONFIG_WATCHDOG_SYSFS
401static ssize_t nowayout_show(struct device *dev, struct device_attribute *attr,
402 char *buf)
403{
404 struct watchdog_device *wdd = dev_get_drvdata(dev);
405
406 return sprintf(buf, "%d\n", !!test_bit(WDOG_NO_WAY_OUT, &wdd->status));
407}
408static DEVICE_ATTR_RO(nowayout);
409
410static ssize_t status_show(struct device *dev, struct device_attribute *attr,
411 char *buf)
412{
413 struct watchdog_device *wdd = dev_get_drvdata(dev);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800414 struct watchdog_core_data *wd_data = wdd->wd_data;
415 unsigned int status;
Pratyush Anand33b71122015-12-17 17:53:59 +0530416
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800417 mutex_lock(&wd_data->lock);
418 status = watchdog_get_status(wdd);
419 mutex_unlock(&wd_data->lock);
Pratyush Anand33b71122015-12-17 17:53:59 +0530420
Guenter Roeck90b826f2016-07-17 15:04:11 -0700421 return sprintf(buf, "0x%x\n", status);
Pratyush Anand33b71122015-12-17 17:53:59 +0530422}
423static DEVICE_ATTR_RO(status);
424
425static ssize_t bootstatus_show(struct device *dev,
426 struct device_attribute *attr, char *buf)
427{
428 struct watchdog_device *wdd = dev_get_drvdata(dev);
429
430 return sprintf(buf, "%u\n", wdd->bootstatus);
431}
432static DEVICE_ATTR_RO(bootstatus);
433
434static ssize_t timeleft_show(struct device *dev, struct device_attribute *attr,
435 char *buf)
436{
437 struct watchdog_device *wdd = dev_get_drvdata(dev);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800438 struct watchdog_core_data *wd_data = wdd->wd_data;
Pratyush Anand33b71122015-12-17 17:53:59 +0530439 ssize_t status;
440 unsigned int val;
441
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800442 mutex_lock(&wd_data->lock);
Pratyush Anand33b71122015-12-17 17:53:59 +0530443 status = watchdog_get_timeleft(wdd, &val);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800444 mutex_unlock(&wd_data->lock);
Pratyush Anand33b71122015-12-17 17:53:59 +0530445 if (!status)
446 status = sprintf(buf, "%u\n", val);
447
448 return status;
449}
450static DEVICE_ATTR_RO(timeleft);
451
452static ssize_t timeout_show(struct device *dev, struct device_attribute *attr,
453 char *buf)
454{
455 struct watchdog_device *wdd = dev_get_drvdata(dev);
456
457 return sprintf(buf, "%u\n", wdd->timeout);
458}
459static DEVICE_ATTR_RO(timeout);
460
Wolfram Sangdf044e02016-08-31 14:52:41 +0300461static ssize_t pretimeout_show(struct device *dev,
462 struct device_attribute *attr, char *buf)
463{
464 struct watchdog_device *wdd = dev_get_drvdata(dev);
465
466 return sprintf(buf, "%u\n", wdd->pretimeout);
467}
468static DEVICE_ATTR_RO(pretimeout);
469
Pratyush Anand33b71122015-12-17 17:53:59 +0530470static ssize_t identity_show(struct device *dev, struct device_attribute *attr,
471 char *buf)
472{
473 struct watchdog_device *wdd = dev_get_drvdata(dev);
474
475 return sprintf(buf, "%s\n", wdd->info->identity);
476}
477static DEVICE_ATTR_RO(identity);
478
479static ssize_t state_show(struct device *dev, struct device_attribute *attr,
480 char *buf)
481{
482 struct watchdog_device *wdd = dev_get_drvdata(dev);
483
484 if (watchdog_active(wdd))
485 return sprintf(buf, "active\n");
486
487 return sprintf(buf, "inactive\n");
488}
489static DEVICE_ATTR_RO(state);
490
491static umode_t wdt_is_visible(struct kobject *kobj, struct attribute *attr,
492 int n)
493{
494 struct device *dev = container_of(kobj, struct device, kobj);
495 struct watchdog_device *wdd = dev_get_drvdata(dev);
496 umode_t mode = attr->mode;
497
Guenter Roeck90b826f2016-07-17 15:04:11 -0700498 if (attr == &dev_attr_timeleft.attr && !wdd->ops->get_timeleft)
Pratyush Anand33b71122015-12-17 17:53:59 +0530499 mode = 0;
Wolfram Sangdf044e02016-08-31 14:52:41 +0300500 else if (attr == &dev_attr_pretimeout.attr &&
501 !(wdd->info->options & WDIOF_PRETIMEOUT))
502 mode = 0;
Pratyush Anand33b71122015-12-17 17:53:59 +0530503
504 return mode;
505}
506static struct attribute *wdt_attrs[] = {
507 &dev_attr_state.attr,
508 &dev_attr_identity.attr,
509 &dev_attr_timeout.attr,
Wolfram Sangdf044e02016-08-31 14:52:41 +0300510 &dev_attr_pretimeout.attr,
Pratyush Anand33b71122015-12-17 17:53:59 +0530511 &dev_attr_timeleft.attr,
512 &dev_attr_bootstatus.attr,
513 &dev_attr_status.attr,
514 &dev_attr_nowayout.attr,
515 NULL,
516};
517
518static const struct attribute_group wdt_group = {
519 .attrs = wdt_attrs,
520 .is_visible = wdt_is_visible,
521};
522__ATTRIBUTE_GROUPS(wdt);
523#else
524#define wdt_groups NULL
525#endif
526
Hans de Goede7a879822012-05-22 11:40:26 +0200527/*
528 * watchdog_ioctl_op: call the watchdog drivers ioctl op if defined
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700529 * @wdd: the watchdog device to do the ioctl on
Hans de Goede7a879822012-05-22 11:40:26 +0200530 * @cmd: watchdog command
531 * @arg: argument pointer
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800532 *
533 * The caller must hold wd_data->lock.
Hans de Goede7a879822012-05-22 11:40:26 +0200534 */
535
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700536static int watchdog_ioctl_op(struct watchdog_device *wdd, unsigned int cmd,
Hans de Goede7a879822012-05-22 11:40:26 +0200537 unsigned long arg)
538{
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700539 if (!wdd->ops->ioctl)
Hans de Goede7a879822012-05-22 11:40:26 +0200540 return -ENOIOCTLCMD;
541
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800542 return wdd->ops->ioctl(wdd, cmd, arg);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000543}
544
545/*
546 * watchdog_write: writes to the watchdog.
547 * @file: file from VFS
548 * @data: user address of data
549 * @len: length of data
550 * @ppos: pointer to the file offset
551 *
552 * A write to a watchdog device is defined as a keepalive ping.
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000553 * Writing the magic 'V' sequence allows the next close to turn
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000554 * off the watchdog (if 'nowayout' is not set).
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000555 */
556
557static ssize_t watchdog_write(struct file *file, const char __user *data,
558 size_t len, loff_t *ppos)
559{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800560 struct watchdog_core_data *wd_data = file->private_data;
561 struct watchdog_device *wdd;
562 int err;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000563 size_t i;
564 char c;
565
566 if (len == 0)
567 return 0;
568
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000569 /*
570 * Note: just in case someone wrote the magic character
571 * five months ago...
572 */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800573 clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000574
575 /* scan to see whether or not we got the magic character */
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000576 for (i = 0; i != len; i++) {
577 if (get_user(c, data + i))
578 return -EFAULT;
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000579 if (c == 'V')
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800580 set_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000581 }
582
583 /* someone wrote to us, so we send the watchdog a keepalive ping */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800584
585 err = -ENODEV;
586 mutex_lock(&wd_data->lock);
587 wdd = wd_data->wdd;
588 if (wdd)
589 err = watchdog_ping(wdd);
590 mutex_unlock(&wd_data->lock);
591
Alexander Usyskin5ef79662015-10-26 14:07:58 +0200592 if (err < 0)
593 return err;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000594
595 return len;
596}
597
598/*
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000599 * watchdog_ioctl: handle the different ioctl's for the watchdog device.
600 * @file: file handle to the device
601 * @cmd: watchdog command
602 * @arg: argument pointer
603 *
604 * The watchdog API defines a common set of functions for all watchdogs
605 * according to their available features.
606 */
607
608static long watchdog_ioctl(struct file *file, unsigned int cmd,
609 unsigned long arg)
610{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800611 struct watchdog_core_data *wd_data = file->private_data;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000612 void __user *argp = (void __user *)arg;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800613 struct watchdog_device *wdd;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000614 int __user *p = argp;
615 unsigned int val;
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000616 int err;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000617
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800618 mutex_lock(&wd_data->lock);
619
620 wdd = wd_data->wdd;
621 if (!wdd) {
622 err = -ENODEV;
623 goto out_ioctl;
624 }
625
Hans de Goede7a879822012-05-22 11:40:26 +0200626 err = watchdog_ioctl_op(wdd, cmd, arg);
627 if (err != -ENOIOCTLCMD)
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800628 goto out_ioctl;
Wim Van Sebroeck78d88fc2011-07-22 18:59:49 +0000629
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000630 switch (cmd) {
631 case WDIOC_GETSUPPORT:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800632 err = copy_to_user(argp, wdd->info,
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000633 sizeof(struct watchdog_info)) ? -EFAULT : 0;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800634 break;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000635 case WDIOC_GETSTATUS:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800636 val = watchdog_get_status(wdd);
637 err = put_user(val, p);
638 break;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000639 case WDIOC_GETBOOTSTATUS:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800640 err = put_user(wdd->bootstatus, p);
641 break;
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000642 case WDIOC_SETOPTIONS:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800643 if (get_user(val, p)) {
644 err = -EFAULT;
645 break;
646 }
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000647 if (val & WDIOS_DISABLECARD) {
648 err = watchdog_stop(wdd);
649 if (err < 0)
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800650 break;
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000651 }
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800652 if (val & WDIOS_ENABLECARD)
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000653 err = watchdog_start(wdd);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800654 break;
Wim Van Sebroeckc2dc00e2011-07-22 18:57:23 +0000655 case WDIOC_KEEPALIVE:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800656 if (!(wdd->info->options & WDIOF_KEEPALIVEPING)) {
657 err = -EOPNOTSUPP;
658 break;
659 }
660 err = watchdog_ping(wdd);
661 break;
Wim Van Sebroeck014d6942011-07-22 18:58:21 +0000662 case WDIOC_SETTIMEOUT:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800663 if (get_user(val, p)) {
664 err = -EFAULT;
665 break;
666 }
Hans de Goede7a879822012-05-22 11:40:26 +0200667 err = watchdog_set_timeout(wdd, val);
Wim Van Sebroeck014d6942011-07-22 18:58:21 +0000668 if (err < 0)
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800669 break;
Wim Van Sebroeck014d6942011-07-22 18:58:21 +0000670 /* If the watchdog is active then we send a keepalive ping
671 * to make sure that the watchdog keep's running (and if
672 * possible that it takes the new timeout) */
Alexander Usyskin5ef79662015-10-26 14:07:58 +0200673 err = watchdog_ping(wdd);
674 if (err < 0)
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800675 break;
Wim Van Sebroeck014d6942011-07-22 18:58:21 +0000676 /* Fall */
677 case WDIOC_GETTIMEOUT:
678 /* timeout == 0 means that we don't know the timeout */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800679 if (wdd->timeout == 0) {
680 err = -EOPNOTSUPP;
681 break;
682 }
683 err = put_user(wdd->timeout, p);
684 break;
Viresh Kumarfd7b6732012-03-16 09:14:00 +0100685 case WDIOC_GETTIMELEFT:
Hans de Goede7a879822012-05-22 11:40:26 +0200686 err = watchdog_get_timeleft(wdd, &val);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800687 if (err < 0)
688 break;
689 err = put_user(val, p);
690 break;
Wolfram Sangdf044e02016-08-31 14:52:41 +0300691 case WDIOC_SETPRETIMEOUT:
692 if (get_user(val, p)) {
693 err = -EFAULT;
694 break;
695 }
696 err = watchdog_set_pretimeout(wdd, val);
697 break;
698 case WDIOC_GETPRETIMEOUT:
699 err = put_user(wdd->pretimeout, p);
700 break;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000701 default:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800702 err = -ENOTTY;
703 break;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000704 }
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800705
706out_ioctl:
707 mutex_unlock(&wd_data->lock);
708 return err;
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000709}
710
711/*
Alan Cox45f5fed2012-05-10 21:48:59 +0200712 * watchdog_open: open the /dev/watchdog* devices.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000713 * @inode: inode of device
714 * @file: file handle to device
715 *
Alan Cox45f5fed2012-05-10 21:48:59 +0200716 * When the /dev/watchdog* device gets opened, we start the watchdog.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000717 * Watch out: the /dev/watchdog device is single open, so we make sure
718 * it can only be opened once.
719 */
720
721static int watchdog_open(struct inode *inode, struct file *file)
722{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800723 struct watchdog_core_data *wd_data;
Alan Cox45f5fed2012-05-10 21:48:59 +0200724 struct watchdog_device *wdd;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800725 int err;
Alan Cox45f5fed2012-05-10 21:48:59 +0200726
727 /* Get the corresponding watchdog device */
728 if (imajor(inode) == MISC_MAJOR)
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800729 wd_data = old_wd_data;
Alan Cox45f5fed2012-05-10 21:48:59 +0200730 else
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800731 wd_data = container_of(inode->i_cdev, struct watchdog_core_data,
732 cdev);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000733
734 /* the watchdog is single open! */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800735 if (test_and_set_bit(_WDOG_DEV_OPEN, &wd_data->status))
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000736 return -EBUSY;
737
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800738 wdd = wd_data->wdd;
739
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000740 /*
741 * If the /dev/watchdog device is open, we don't want the module
742 * to be unloaded.
743 */
Guenter Roeckee142882016-02-28 13:12:16 -0800744 if (!watchdog_hw_running(wdd) && !try_module_get(wdd->ops->owner)) {
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800745 err = -EBUSY;
746 goto out_clear;
747 }
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000748
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000749 err = watchdog_start(wdd);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000750 if (err < 0)
751 goto out_mod;
752
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800753 file->private_data = wd_data;
Alan Cox45f5fed2012-05-10 21:48:59 +0200754
Guenter Roeckee142882016-02-28 13:12:16 -0800755 if (!watchdog_hw_running(wdd))
756 kref_get(&wd_data->kref);
Hans de Goedee907df32012-05-22 11:40:26 +0200757
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000758 /* dev/watchdog is a virtual (and thus non-seekable) filesystem */
759 return nonseekable_open(inode, file);
760
761out_mod:
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800762 module_put(wd_data->wdd->ops->owner);
763out_clear:
764 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000765 return err;
766}
767
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800768static void watchdog_core_data_release(struct kref *kref)
769{
770 struct watchdog_core_data *wd_data;
771
772 wd_data = container_of(kref, struct watchdog_core_data, kref);
773
774 kfree(wd_data);
775}
776
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000777/*
Alan Cox45f5fed2012-05-10 21:48:59 +0200778 * watchdog_release: release the watchdog device.
779 * @inode: inode of device
780 * @file: file handle to device
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000781 *
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000782 * This is the code for when /dev/watchdog gets closed. We will only
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000783 * stop the watchdog when we have received the magic char (and nowayout
784 * was not set), else the watchdog will keep running.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000785 */
786
787static int watchdog_release(struct inode *inode, struct file *file)
788{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800789 struct watchdog_core_data *wd_data = file->private_data;
790 struct watchdog_device *wdd;
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000791 int err = -EBUSY;
Guenter Roeckd1ed3ba2016-03-08 18:46:13 -0800792 bool running;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000793
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800794 mutex_lock(&wd_data->lock);
795
796 wdd = wd_data->wdd;
797 if (!wdd)
798 goto done;
799
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000800 /*
801 * We only stop the watchdog if we received the magic character
Wim Van Sebroeck7e192b92011-07-22 18:59:17 +0000802 * or if WDIOF_MAGICCLOSE is not set. If nowayout was set then
803 * watchdog_stop will fail.
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000804 */
Hector Palaciosfcf95672013-04-08 17:06:32 +0200805 if (!test_bit(WDOG_ACTIVE, &wdd->status))
806 err = 0;
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800807 else if (test_and_clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status) ||
Hector Palaciosfcf95672013-04-08 17:06:32 +0200808 !(wdd->info->options & WDIOF_MAGICCLOSE))
Wim Van Sebroeck017cf082011-07-22 18:58:54 +0000809 err = watchdog_stop(wdd);
810
811 /* If the watchdog was not stopped, send a keepalive ping */
Wim Van Sebroeck234445b2011-07-22 18:57:55 +0000812 if (err < 0) {
Guenter Roeck0254e952016-01-03 15:11:58 -0800813 pr_crit("watchdog%d: watchdog did not stop!\n", wdd->id);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000814 watchdog_ping(wdd);
815 }
816
Guenter Roeckee142882016-02-28 13:12:16 -0800817 watchdog_update_worker(wdd);
Guenter Roeck664a3922016-02-28 13:12:15 -0800818
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000819 /* make sure that /dev/watchdog can be re-opened */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800820 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000821
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800822done:
Guenter Roeckd1ed3ba2016-03-08 18:46:13 -0800823 running = wdd && watchdog_hw_running(wdd);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800824 mutex_unlock(&wd_data->lock);
Guenter Roeckee142882016-02-28 13:12:16 -0800825 /*
826 * Allow the owner module to be unloaded again unless the watchdog
827 * is still running. If the watchdog is still running, it can not
828 * be stopped, and its driver must not be unloaded.
829 */
Guenter Roeckd1ed3ba2016-03-08 18:46:13 -0800830 if (!running) {
831 module_put(wd_data->cdev.owner);
Guenter Roeckee142882016-02-28 13:12:16 -0800832 kref_put(&wd_data->kref, watchdog_core_data_release);
833 }
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000834 return 0;
835}
836
837static const struct file_operations watchdog_fops = {
838 .owner = THIS_MODULE,
839 .write = watchdog_write,
Wim Van Sebroeck2fa03562011-07-22 18:56:38 +0000840 .unlocked_ioctl = watchdog_ioctl,
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000841 .open = watchdog_open,
842 .release = watchdog_release,
843};
844
845static struct miscdevice watchdog_miscdev = {
846 .minor = WATCHDOG_MINOR,
847 .name = "watchdog",
848 .fops = &watchdog_fops,
849};
850
851/*
Guenter Roeck32ecc632015-12-25 16:01:40 -0800852 * watchdog_cdev_register: register watchdog character device
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700853 * @wdd: watchdog device
Guenter Roeck32ecc632015-12-25 16:01:40 -0800854 * @devno: character device number
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000855 *
Guenter Roeck32ecc632015-12-25 16:01:40 -0800856 * Register a watchdog character device including handling the legacy
Alan Cox45f5fed2012-05-10 21:48:59 +0200857 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
858 * thus we set it up like that.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000859 */
860
Guenter Roeck32ecc632015-12-25 16:01:40 -0800861static int watchdog_cdev_register(struct watchdog_device *wdd, dev_t devno)
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000862{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800863 struct watchdog_core_data *wd_data;
Guenter Roeck32ecc632015-12-25 16:01:40 -0800864 int err;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000865
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800866 wd_data = kzalloc(sizeof(struct watchdog_core_data), GFP_KERNEL);
867 if (!wd_data)
868 return -ENOMEM;
869 kref_init(&wd_data->kref);
870 mutex_init(&wd_data->lock);
871
872 wd_data->wdd = wdd;
873 wdd->wd_data = wd_data;
874
Guenter Roeck664a3922016-02-28 13:12:15 -0800875 if (!watchdog_wq)
876 return -ENODEV;
877
878 INIT_DELAYED_WORK(&wd_data->work, watchdog_ping_work);
879
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700880 if (wdd->id == 0) {
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800881 old_wd_data = wd_data;
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700882 watchdog_miscdev.parent = wdd->parent;
Alan Cox45f5fed2012-05-10 21:48:59 +0200883 err = misc_register(&watchdog_miscdev);
884 if (err != 0) {
885 pr_err("%s: cannot register miscdev on minor=%d (err=%d).\n",
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700886 wdd->info->identity, WATCHDOG_MINOR, err);
Alan Cox45f5fed2012-05-10 21:48:59 +0200887 if (err == -EBUSY)
888 pr_err("%s: a legacy watchdog module is probably present.\n",
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700889 wdd->info->identity);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800890 old_wd_data = NULL;
891 kfree(wd_data);
Alan Cox45f5fed2012-05-10 21:48:59 +0200892 return err;
893 }
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000894 }
895
Alan Cox45f5fed2012-05-10 21:48:59 +0200896 /* Fill in the data structures */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800897 cdev_init(&wd_data->cdev, &watchdog_fops);
898 wd_data->cdev.owner = wdd->ops->owner;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000899
Alan Cox45f5fed2012-05-10 21:48:59 +0200900 /* Add the device */
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800901 err = cdev_add(&wd_data->cdev, devno, 1);
Alan Cox45f5fed2012-05-10 21:48:59 +0200902 if (err) {
903 pr_err("watchdog%d unable to add device %d:%d\n",
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700904 wdd->id, MAJOR(watchdog_devt), wdd->id);
905 if (wdd->id == 0) {
Alan Cox45f5fed2012-05-10 21:48:59 +0200906 misc_deregister(&watchdog_miscdev);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800907 old_wd_data = NULL;
908 kref_put(&wd_data->kref, watchdog_core_data_release);
Alan Cox45f5fed2012-05-10 21:48:59 +0200909 }
Guenter Roeckee142882016-02-28 13:12:16 -0800910 return err;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000911 }
Guenter Roeckee142882016-02-28 13:12:16 -0800912
Guenter Roeck15013ad2016-02-28 13:12:18 -0800913 /* Record time of most recent heartbeat as 'just before now'. */
914 wd_data->last_hw_keepalive = jiffies - 1;
915
Guenter Roeckee142882016-02-28 13:12:16 -0800916 /*
917 * If the watchdog is running, prevent its driver from being unloaded,
918 * and schedule an immediate ping.
919 */
920 if (watchdog_hw_running(wdd)) {
921 __module_get(wdd->ops->owner);
922 kref_get(&wd_data->kref);
923 queue_delayed_work(watchdog_wq, &wd_data->work, 0);
924 }
925
926 return 0;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000927}
928
929/*
Guenter Roeck32ecc632015-12-25 16:01:40 -0800930 * watchdog_cdev_unregister: unregister watchdog character device
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000931 * @watchdog: watchdog device
932 *
Guenter Roeck32ecc632015-12-25 16:01:40 -0800933 * Unregister watchdog character device and if needed the legacy
934 * /dev/watchdog device.
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000935 */
936
Guenter Roeck32ecc632015-12-25 16:01:40 -0800937static void watchdog_cdev_unregister(struct watchdog_device *wdd)
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000938{
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800939 struct watchdog_core_data *wd_data = wdd->wd_data;
Hans de Goedee907df32012-05-22 11:40:26 +0200940
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800941 cdev_del(&wd_data->cdev);
Guenter Roeckbc794ac2015-09-29 01:27:25 -0700942 if (wdd->id == 0) {
Alan Cox45f5fed2012-05-10 21:48:59 +0200943 misc_deregister(&watchdog_miscdev);
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800944 old_wd_data = NULL;
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000945 }
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800946
947 mutex_lock(&wd_data->lock);
948 wd_data->wdd = NULL;
949 wdd->wd_data = NULL;
950 mutex_unlock(&wd_data->lock);
951
Guenter Roeck664a3922016-02-28 13:12:15 -0800952 cancel_delayed_work_sync(&wd_data->work);
953
Guenter Roeckb4ffb192015-12-25 16:01:42 -0800954 kref_put(&wd_data->kref, watchdog_core_data_release);
Wim Van Sebroeck43316042011-07-22 18:55:18 +0000955}
Alan Cox45f5fed2012-05-10 21:48:59 +0200956
Pratyush Anand906d7a52015-12-17 17:53:58 +0530957static struct class watchdog_class = {
958 .name = "watchdog",
959 .owner = THIS_MODULE,
Pratyush Anand33b71122015-12-17 17:53:59 +0530960 .dev_groups = wdt_groups,
Pratyush Anand906d7a52015-12-17 17:53:58 +0530961};
962
Alan Cox45f5fed2012-05-10 21:48:59 +0200963/*
Guenter Roeck32ecc632015-12-25 16:01:40 -0800964 * watchdog_dev_register: register a watchdog device
965 * @wdd: watchdog device
966 *
967 * Register a watchdog device including handling the legacy
968 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
969 * thus we set it up like that.
970 */
971
972int watchdog_dev_register(struct watchdog_device *wdd)
973{
974 struct device *dev;
975 dev_t devno;
976 int ret;
977
978 devno = MKDEV(MAJOR(watchdog_devt), wdd->id);
979
980 ret = watchdog_cdev_register(wdd, devno);
981 if (ret)
982 return ret;
983
Guenter Roeckfaa58472016-01-03 15:11:56 -0800984 dev = device_create_with_groups(&watchdog_class, wdd->parent,
985 devno, wdd, wdd->groups,
986 "watchdog%d", wdd->id);
Guenter Roeck32ecc632015-12-25 16:01:40 -0800987 if (IS_ERR(dev)) {
988 watchdog_cdev_unregister(wdd);
989 return PTR_ERR(dev);
990 }
Guenter Roeck32ecc632015-12-25 16:01:40 -0800991
992 return ret;
993}
994
995/*
996 * watchdog_dev_unregister: unregister a watchdog device
997 * @watchdog: watchdog device
998 *
999 * Unregister watchdog device and if needed the legacy
1000 * /dev/watchdog device.
1001 */
1002
1003void watchdog_dev_unregister(struct watchdog_device *wdd)
1004{
Guenter Roeck0254e952016-01-03 15:11:58 -08001005 device_destroy(&watchdog_class, wdd->wd_data->cdev.dev);
Guenter Roeckb4ffb192015-12-25 16:01:42 -08001006 watchdog_cdev_unregister(wdd);
Guenter Roeck32ecc632015-12-25 16:01:40 -08001007}
1008
1009/*
Alan Cox45f5fed2012-05-10 21:48:59 +02001010 * watchdog_dev_init: init dev part of watchdog core
1011 *
1012 * Allocate a range of chardev nodes to use for watchdog devices
1013 */
1014
Guenter Roeck32ecc632015-12-25 16:01:40 -08001015int __init watchdog_dev_init(void)
Alan Cox45f5fed2012-05-10 21:48:59 +02001016{
Pratyush Anand906d7a52015-12-17 17:53:58 +05301017 int err;
1018
Guenter Roeck664a3922016-02-28 13:12:15 -08001019 watchdog_wq = alloc_workqueue("watchdogd",
1020 WQ_HIGHPRI | WQ_MEM_RECLAIM, 0);
1021 if (!watchdog_wq) {
1022 pr_err("Failed to create watchdog workqueue\n");
1023 return -ENOMEM;
1024 }
1025
Pratyush Anand906d7a52015-12-17 17:53:58 +05301026 err = class_register(&watchdog_class);
1027 if (err < 0) {
1028 pr_err("couldn't register class\n");
Wei Yongjun138913c2016-07-19 11:22:34 +00001029 goto err_register;
Pratyush Anand906d7a52015-12-17 17:53:58 +05301030 }
1031
1032 err = alloc_chrdev_region(&watchdog_devt, 0, MAX_DOGS, "watchdog");
1033 if (err < 0) {
Alan Cox45f5fed2012-05-10 21:48:59 +02001034 pr_err("watchdog: unable to allocate char dev region\n");
Wei Yongjun138913c2016-07-19 11:22:34 +00001035 goto err_alloc;
Pratyush Anand906d7a52015-12-17 17:53:58 +05301036 }
1037
Guenter Roeck32ecc632015-12-25 16:01:40 -08001038 return 0;
Wei Yongjun138913c2016-07-19 11:22:34 +00001039
1040err_alloc:
1041 class_unregister(&watchdog_class);
1042err_register:
1043 destroy_workqueue(watchdog_wq);
1044 return err;
Alan Cox45f5fed2012-05-10 21:48:59 +02001045}
1046
1047/*
1048 * watchdog_dev_exit: exit dev part of watchdog core
1049 *
1050 * Release the range of chardev nodes used for watchdog devices
1051 */
1052
1053void __exit watchdog_dev_exit(void)
1054{
1055 unregister_chrdev_region(watchdog_devt, MAX_DOGS);
Pratyush Anand906d7a52015-12-17 17:53:58 +05301056 class_unregister(&watchdog_class);
Guenter Roeck664a3922016-02-28 13:12:15 -08001057 destroy_workqueue(watchdog_wq);
Alan Cox45f5fed2012-05-10 21:48:59 +02001058}