4 * (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
7 * (c) Copyright 2008-2011 Wim Van Sebroeck <wim@iguana.be>.
10 * This source code is part of the generic code that can be used
11 * by all the watchdog timer drivers.
13 * This part of the generic code takes care of the following
14 * misc device: /dev/watchdog.
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>
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.
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.
33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
35 #include <linux/cdev.h> /* For character device */
36 #include <linux/errno.h> /* For the -ENODEV/... values */
37 #include <linux/fs.h> /* For file operations */
38 #include <linux/init.h> /* For __init/__exit/... */
39 #include <linux/jiffies.h> /* For timeout functions */
40 #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 */
48 #include <linux/workqueue.h> /* For workqueue */
49 #include <linux/uaccess.h> /* For copy_to_user/put_user/... */
51 #include "watchdog_core.h"
52 #include "watchdog_pretimeout.h"
55 * struct watchdog_core_data - watchdog core internal data
56 * @kref: Reference count.
57 * @cdev: The watchdog's Character device.
58 * @wdd: Pointer to watchdog device.
59 * @lock: Lock for watchdog core.
60 * @status: Watchdog core internal status bits.
62 struct watchdog_core_data
{
65 struct watchdog_device
*wdd
;
67 unsigned long last_keepalive
;
68 unsigned long last_hw_keepalive
;
69 struct delayed_work work
;
70 unsigned long status
; /* Internal status bits */
71 #define _WDOG_DEV_OPEN 0 /* Opened ? */
72 #define _WDOG_ALLOW_RELEASE 1 /* Did we receive the magic char ? */
73 #define _WDOG_KEEPALIVE 2 /* Did we receive a keepalive ? */
76 /* the dev_t structure to store the dynamically allocated watchdog devices */
77 static dev_t watchdog_devt
;
78 /* Reference to watchdog device behind /dev/watchdog */
79 static struct watchdog_core_data
*old_wd_data
;
81 static struct workqueue_struct
*watchdog_wq
;
83 static bool handle_boot_enabled
=
84 IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED
);
86 static inline bool watchdog_need_worker(struct watchdog_device
*wdd
)
88 /* All variables in milli-seconds */
89 unsigned int hm
= wdd
->max_hw_heartbeat_ms
;
90 unsigned int t
= wdd
->timeout
* 1000;
93 * A worker to generate heartbeat requests is needed if all of the
94 * following conditions are true.
95 * - Userspace activated the watchdog.
96 * - The driver provided a value for the maximum hardware timeout, and
97 * thus is aware that the framework supports generating heartbeat
99 * - Userspace requests a longer timeout than the hardware can handle.
101 * Alternatively, if userspace has not opened the watchdog
102 * device, we take care of feeding the watchdog if it is
105 return (hm
&& watchdog_active(wdd
) && t
> hm
) ||
106 (t
&& !watchdog_active(wdd
) && watchdog_hw_running(wdd
));
109 static long watchdog_next_keepalive(struct watchdog_device
*wdd
)
111 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
112 unsigned int timeout_ms
= wdd
->timeout
* 1000;
113 unsigned long keepalive_interval
;
114 unsigned long last_heartbeat
;
115 unsigned long virt_timeout
;
116 unsigned int hw_heartbeat_ms
;
118 virt_timeout
= wd_data
->last_keepalive
+ msecs_to_jiffies(timeout_ms
);
119 hw_heartbeat_ms
= min_not_zero(timeout_ms
, wdd
->max_hw_heartbeat_ms
);
120 keepalive_interval
= msecs_to_jiffies(hw_heartbeat_ms
/ 2);
122 if (!watchdog_active(wdd
))
123 return keepalive_interval
;
126 * To ensure that the watchdog times out wdd->timeout seconds
127 * after the most recent ping from userspace, the last
128 * worker ping has to come in hw_heartbeat_ms before this timeout.
130 last_heartbeat
= virt_timeout
- msecs_to_jiffies(hw_heartbeat_ms
);
131 return min_t(long, last_heartbeat
- jiffies
, keepalive_interval
);
134 static inline void watchdog_update_worker(struct watchdog_device
*wdd
)
136 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
138 if (watchdog_need_worker(wdd
)) {
139 long t
= watchdog_next_keepalive(wdd
);
142 mod_delayed_work(watchdog_wq
, &wd_data
->work
, t
);
144 cancel_delayed_work(&wd_data
->work
);
148 static int __watchdog_ping(struct watchdog_device
*wdd
)
150 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
151 unsigned long earliest_keepalive
= wd_data
->last_hw_keepalive
+
152 msecs_to_jiffies(wdd
->min_hw_heartbeat_ms
);
155 if (time_is_after_jiffies(earliest_keepalive
)) {
156 mod_delayed_work(watchdog_wq
, &wd_data
->work
,
157 earliest_keepalive
- jiffies
);
161 wd_data
->last_hw_keepalive
= jiffies
;
164 err
= wdd
->ops
->ping(wdd
); /* ping the watchdog */
166 err
= wdd
->ops
->start(wdd
); /* restart watchdog */
168 watchdog_update_worker(wdd
);
174 * watchdog_ping: ping the watchdog.
175 * @wdd: the watchdog device to ping
177 * The caller must hold wd_data->lock.
179 * If the watchdog has no own ping operation then it needs to be
180 * restarted via the start operation. This wrapper function does
182 * We only ping when the watchdog device is running.
185 static int watchdog_ping(struct watchdog_device
*wdd
)
187 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
189 if (!watchdog_active(wdd
) && !watchdog_hw_running(wdd
))
192 set_bit(_WDOG_KEEPALIVE
, &wd_data
->status
);
194 wd_data
->last_keepalive
= jiffies
;
195 return __watchdog_ping(wdd
);
198 static void watchdog_ping_work(struct work_struct
*work
)
200 struct watchdog_core_data
*wd_data
;
201 struct watchdog_device
*wdd
;
203 wd_data
= container_of(to_delayed_work(work
), struct watchdog_core_data
,
206 mutex_lock(&wd_data
->lock
);
208 if (wdd
&& (watchdog_active(wdd
) || watchdog_hw_running(wdd
)))
209 __watchdog_ping(wdd
);
210 mutex_unlock(&wd_data
->lock
);
214 * watchdog_start: wrapper to start the watchdog.
215 * @wdd: the watchdog device to start
217 * The caller must hold wd_data->lock.
219 * Start the watchdog if it is not active and mark it active.
220 * This function returns zero on success or a negative errno code for
224 static int watchdog_start(struct watchdog_device
*wdd
)
226 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
227 unsigned long started_at
;
230 if (watchdog_active(wdd
))
233 set_bit(_WDOG_KEEPALIVE
, &wd_data
->status
);
235 started_at
= jiffies
;
236 if (watchdog_hw_running(wdd
) && wdd
->ops
->ping
)
237 err
= wdd
->ops
->ping(wdd
);
239 err
= wdd
->ops
->start(wdd
);
241 set_bit(WDOG_ACTIVE
, &wdd
->status
);
242 wd_data
->last_keepalive
= started_at
;
243 watchdog_update_worker(wdd
);
250 * watchdog_stop: wrapper to stop the watchdog.
251 * @wdd: the watchdog device to stop
253 * The caller must hold wd_data->lock.
255 * Stop the watchdog if it is still active and unmark it active.
256 * This function returns zero on success or a negative errno code for
258 * If the 'nowayout' feature was set, the watchdog cannot be stopped.
261 static int watchdog_stop(struct watchdog_device
*wdd
)
265 if (!watchdog_active(wdd
))
268 if (test_bit(WDOG_NO_WAY_OUT
, &wdd
->status
)) {
269 pr_info("watchdog%d: nowayout prevents watchdog being stopped!\n",
274 if (wdd
->ops
->stop
) {
275 clear_bit(WDOG_HW_RUNNING
, &wdd
->status
);
276 err
= wdd
->ops
->stop(wdd
);
278 set_bit(WDOG_HW_RUNNING
, &wdd
->status
);
282 clear_bit(WDOG_ACTIVE
, &wdd
->status
);
283 watchdog_update_worker(wdd
);
290 * watchdog_get_status: wrapper to get the watchdog status
291 * @wdd: the watchdog device to get the status from
293 * The caller must hold wd_data->lock.
295 * Get the watchdog's status flags.
298 static unsigned int watchdog_get_status(struct watchdog_device
*wdd
)
300 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
303 if (wdd
->ops
->status
)
304 status
= wdd
->ops
->status(wdd
);
306 status
= wdd
->bootstatus
& (WDIOF_CARDRESET
|
314 if (test_bit(_WDOG_ALLOW_RELEASE
, &wd_data
->status
))
315 status
|= WDIOF_MAGICCLOSE
;
317 if (test_and_clear_bit(_WDOG_KEEPALIVE
, &wd_data
->status
))
318 status
|= WDIOF_KEEPALIVEPING
;
324 * watchdog_set_timeout: set the watchdog timer timeout
325 * @wdd: the watchdog device to set the timeout for
326 * @timeout: timeout to set in seconds
328 * The caller must hold wd_data->lock.
331 static int watchdog_set_timeout(struct watchdog_device
*wdd
,
332 unsigned int timeout
)
336 if (!(wdd
->info
->options
& WDIOF_SETTIMEOUT
))
339 if (watchdog_timeout_invalid(wdd
, timeout
))
342 if (wdd
->ops
->set_timeout
) {
343 err
= wdd
->ops
->set_timeout(wdd
, timeout
);
345 wdd
->timeout
= timeout
;
346 /* Disable pretimeout if it doesn't fit the new timeout */
347 if (wdd
->pretimeout
>= wdd
->timeout
)
351 watchdog_update_worker(wdd
);
357 * watchdog_set_pretimeout: set the watchdog timer pretimeout
358 * @wdd: the watchdog device to set the timeout for
359 * @timeout: pretimeout to set in seconds
362 static int watchdog_set_pretimeout(struct watchdog_device
*wdd
,
363 unsigned int timeout
)
367 if (!(wdd
->info
->options
& WDIOF_PRETIMEOUT
))
370 if (watchdog_pretimeout_invalid(wdd
, timeout
))
373 if (wdd
->ops
->set_pretimeout
)
374 err
= wdd
->ops
->set_pretimeout(wdd
, timeout
);
376 wdd
->pretimeout
= timeout
;
382 * watchdog_get_timeleft: wrapper to get the time left before a reboot
383 * @wdd: the watchdog device to get the remaining time from
384 * @timeleft: the time that's left
386 * The caller must hold wd_data->lock.
388 * Get the time before a watchdog will reboot (if not pinged).
391 static int watchdog_get_timeleft(struct watchdog_device
*wdd
,
392 unsigned int *timeleft
)
396 if (!wdd
->ops
->get_timeleft
)
399 *timeleft
= wdd
->ops
->get_timeleft(wdd
);
404 #ifdef CONFIG_WATCHDOG_SYSFS
405 static ssize_t
nowayout_show(struct device
*dev
, struct device_attribute
*attr
,
408 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
410 return sprintf(buf
, "%d\n", !!test_bit(WDOG_NO_WAY_OUT
, &wdd
->status
));
412 static DEVICE_ATTR_RO(nowayout
);
414 static ssize_t
status_show(struct device
*dev
, struct device_attribute
*attr
,
417 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
418 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
421 mutex_lock(&wd_data
->lock
);
422 status
= watchdog_get_status(wdd
);
423 mutex_unlock(&wd_data
->lock
);
425 return sprintf(buf
, "0x%x\n", status
);
427 static DEVICE_ATTR_RO(status
);
429 static ssize_t
bootstatus_show(struct device
*dev
,
430 struct device_attribute
*attr
, char *buf
)
432 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
434 return sprintf(buf
, "%u\n", wdd
->bootstatus
);
436 static DEVICE_ATTR_RO(bootstatus
);
438 static ssize_t
timeleft_show(struct device
*dev
, struct device_attribute
*attr
,
441 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
442 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
446 mutex_lock(&wd_data
->lock
);
447 status
= watchdog_get_timeleft(wdd
, &val
);
448 mutex_unlock(&wd_data
->lock
);
450 status
= sprintf(buf
, "%u\n", val
);
454 static DEVICE_ATTR_RO(timeleft
);
456 static ssize_t
timeout_show(struct device
*dev
, struct device_attribute
*attr
,
459 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
461 return sprintf(buf
, "%u\n", wdd
->timeout
);
463 static DEVICE_ATTR_RO(timeout
);
465 static ssize_t
pretimeout_show(struct device
*dev
,
466 struct device_attribute
*attr
, char *buf
)
468 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
470 return sprintf(buf
, "%u\n", wdd
->pretimeout
);
472 static DEVICE_ATTR_RO(pretimeout
);
474 static ssize_t
identity_show(struct device
*dev
, struct device_attribute
*attr
,
477 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
479 return sprintf(buf
, "%s\n", wdd
->info
->identity
);
481 static DEVICE_ATTR_RO(identity
);
483 static ssize_t
state_show(struct device
*dev
, struct device_attribute
*attr
,
486 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
488 if (watchdog_active(wdd
))
489 return sprintf(buf
, "active\n");
491 return sprintf(buf
, "inactive\n");
493 static DEVICE_ATTR_RO(state
);
495 static ssize_t
pretimeout_available_governors_show(struct device
*dev
,
496 struct device_attribute
*attr
, char *buf
)
498 return watchdog_pretimeout_available_governors_get(buf
);
500 static DEVICE_ATTR_RO(pretimeout_available_governors
);
502 static ssize_t
pretimeout_governor_show(struct device
*dev
,
503 struct device_attribute
*attr
,
506 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
508 return watchdog_pretimeout_governor_get(wdd
, buf
);
511 static ssize_t
pretimeout_governor_store(struct device
*dev
,
512 struct device_attribute
*attr
,
513 const char *buf
, size_t count
)
515 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
516 int ret
= watchdog_pretimeout_governor_set(wdd
, buf
);
523 static DEVICE_ATTR_RW(pretimeout_governor
);
525 static umode_t
wdt_is_visible(struct kobject
*kobj
, struct attribute
*attr
,
528 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
529 struct watchdog_device
*wdd
= dev_get_drvdata(dev
);
530 umode_t mode
= attr
->mode
;
532 if (attr
== &dev_attr_timeleft
.attr
&& !wdd
->ops
->get_timeleft
)
534 else if (attr
== &dev_attr_pretimeout
.attr
&&
535 !(wdd
->info
->options
& WDIOF_PRETIMEOUT
))
537 else if ((attr
== &dev_attr_pretimeout_governor
.attr
||
538 attr
== &dev_attr_pretimeout_available_governors
.attr
) &&
539 (!(wdd
->info
->options
& WDIOF_PRETIMEOUT
) ||
540 !IS_ENABLED(CONFIG_WATCHDOG_PRETIMEOUT_GOV
)))
545 static struct attribute
*wdt_attrs
[] = {
546 &dev_attr_state
.attr
,
547 &dev_attr_identity
.attr
,
548 &dev_attr_timeout
.attr
,
549 &dev_attr_pretimeout
.attr
,
550 &dev_attr_timeleft
.attr
,
551 &dev_attr_bootstatus
.attr
,
552 &dev_attr_status
.attr
,
553 &dev_attr_nowayout
.attr
,
554 &dev_attr_pretimeout_governor
.attr
,
555 &dev_attr_pretimeout_available_governors
.attr
,
559 static const struct attribute_group wdt_group
= {
561 .is_visible
= wdt_is_visible
,
563 __ATTRIBUTE_GROUPS(wdt
);
565 #define wdt_groups NULL
569 * watchdog_ioctl_op: call the watchdog drivers ioctl op if defined
570 * @wdd: the watchdog device to do the ioctl on
571 * @cmd: watchdog command
572 * @arg: argument pointer
574 * The caller must hold wd_data->lock.
577 static int watchdog_ioctl_op(struct watchdog_device
*wdd
, unsigned int cmd
,
580 if (!wdd
->ops
->ioctl
)
583 return wdd
->ops
->ioctl(wdd
, cmd
, arg
);
587 * watchdog_write: writes to the watchdog.
588 * @file: file from VFS
589 * @data: user address of data
590 * @len: length of data
591 * @ppos: pointer to the file offset
593 * A write to a watchdog device is defined as a keepalive ping.
594 * Writing the magic 'V' sequence allows the next close to turn
595 * off the watchdog (if 'nowayout' is not set).
598 static ssize_t
watchdog_write(struct file
*file
, const char __user
*data
,
599 size_t len
, loff_t
*ppos
)
601 struct watchdog_core_data
*wd_data
= file
->private_data
;
602 struct watchdog_device
*wdd
;
611 * Note: just in case someone wrote the magic character
614 clear_bit(_WDOG_ALLOW_RELEASE
, &wd_data
->status
);
616 /* scan to see whether or not we got the magic character */
617 for (i
= 0; i
!= len
; i
++) {
618 if (get_user(c
, data
+ i
))
621 set_bit(_WDOG_ALLOW_RELEASE
, &wd_data
->status
);
624 /* someone wrote to us, so we send the watchdog a keepalive ping */
627 mutex_lock(&wd_data
->lock
);
630 err
= watchdog_ping(wdd
);
631 mutex_unlock(&wd_data
->lock
);
640 * watchdog_ioctl: handle the different ioctl's for the watchdog device.
641 * @file: file handle to the device
642 * @cmd: watchdog command
643 * @arg: argument pointer
645 * The watchdog API defines a common set of functions for all watchdogs
646 * according to their available features.
649 static long watchdog_ioctl(struct file
*file
, unsigned int cmd
,
652 struct watchdog_core_data
*wd_data
= file
->private_data
;
653 void __user
*argp
= (void __user
*)arg
;
654 struct watchdog_device
*wdd
;
655 int __user
*p
= argp
;
659 mutex_lock(&wd_data
->lock
);
667 err
= watchdog_ioctl_op(wdd
, cmd
, arg
);
668 if (err
!= -ENOIOCTLCMD
)
672 case WDIOC_GETSUPPORT
:
673 err
= copy_to_user(argp
, wdd
->info
,
674 sizeof(struct watchdog_info
)) ? -EFAULT
: 0;
676 case WDIOC_GETSTATUS
:
677 val
= watchdog_get_status(wdd
);
678 err
= put_user(val
, p
);
680 case WDIOC_GETBOOTSTATUS
:
681 err
= put_user(wdd
->bootstatus
, p
);
683 case WDIOC_SETOPTIONS
:
684 if (get_user(val
, p
)) {
688 if (val
& WDIOS_DISABLECARD
) {
689 err
= watchdog_stop(wdd
);
693 if (val
& WDIOS_ENABLECARD
)
694 err
= watchdog_start(wdd
);
696 case WDIOC_KEEPALIVE
:
697 if (!(wdd
->info
->options
& WDIOF_KEEPALIVEPING
)) {
701 err
= watchdog_ping(wdd
);
703 case WDIOC_SETTIMEOUT
:
704 if (get_user(val
, p
)) {
708 err
= watchdog_set_timeout(wdd
, val
);
711 /* If the watchdog is active then we send a keepalive ping
712 * to make sure that the watchdog keep's running (and if
713 * possible that it takes the new timeout) */
714 err
= watchdog_ping(wdd
);
718 case WDIOC_GETTIMEOUT
:
719 /* timeout == 0 means that we don't know the timeout */
720 if (wdd
->timeout
== 0) {
724 err
= put_user(wdd
->timeout
, p
);
726 case WDIOC_GETTIMELEFT
:
727 err
= watchdog_get_timeleft(wdd
, &val
);
730 err
= put_user(val
, p
);
732 case WDIOC_SETPRETIMEOUT
:
733 if (get_user(val
, p
)) {
737 err
= watchdog_set_pretimeout(wdd
, val
);
739 case WDIOC_GETPRETIMEOUT
:
740 err
= put_user(wdd
->pretimeout
, p
);
748 mutex_unlock(&wd_data
->lock
);
753 * watchdog_open: open the /dev/watchdog* devices.
754 * @inode: inode of device
755 * @file: file handle to device
757 * When the /dev/watchdog* device gets opened, we start the watchdog.
758 * Watch out: the /dev/watchdog device is single open, so we make sure
759 * it can only be opened once.
762 static int watchdog_open(struct inode
*inode
, struct file
*file
)
764 struct watchdog_core_data
*wd_data
;
765 struct watchdog_device
*wdd
;
768 /* Get the corresponding watchdog device */
769 if (imajor(inode
) == MISC_MAJOR
)
770 wd_data
= old_wd_data
;
772 wd_data
= container_of(inode
->i_cdev
, struct watchdog_core_data
,
775 /* the watchdog is single open! */
776 if (test_and_set_bit(_WDOG_DEV_OPEN
, &wd_data
->status
))
782 * If the /dev/watchdog device is open, we don't want the module
785 if (!watchdog_hw_running(wdd
) && !try_module_get(wdd
->ops
->owner
)) {
790 err
= watchdog_start(wdd
);
794 file
->private_data
= wd_data
;
796 if (!watchdog_hw_running(wdd
))
797 kref_get(&wd_data
->kref
);
799 /* dev/watchdog is a virtual (and thus non-seekable) filesystem */
800 return nonseekable_open(inode
, file
);
803 module_put(wd_data
->wdd
->ops
->owner
);
805 clear_bit(_WDOG_DEV_OPEN
, &wd_data
->status
);
809 static void watchdog_core_data_release(struct kref
*kref
)
811 struct watchdog_core_data
*wd_data
;
813 wd_data
= container_of(kref
, struct watchdog_core_data
, kref
);
819 * watchdog_release: release the watchdog device.
820 * @inode: inode of device
821 * @file: file handle to device
823 * This is the code for when /dev/watchdog gets closed. We will only
824 * stop the watchdog when we have received the magic char (and nowayout
825 * was not set), else the watchdog will keep running.
828 static int watchdog_release(struct inode
*inode
, struct file
*file
)
830 struct watchdog_core_data
*wd_data
= file
->private_data
;
831 struct watchdog_device
*wdd
;
835 mutex_lock(&wd_data
->lock
);
842 * We only stop the watchdog if we received the magic character
843 * or if WDIOF_MAGICCLOSE is not set. If nowayout was set then
844 * watchdog_stop will fail.
846 if (!test_bit(WDOG_ACTIVE
, &wdd
->status
))
848 else if (test_and_clear_bit(_WDOG_ALLOW_RELEASE
, &wd_data
->status
) ||
849 !(wdd
->info
->options
& WDIOF_MAGICCLOSE
))
850 err
= watchdog_stop(wdd
);
852 /* If the watchdog was not stopped, send a keepalive ping */
854 pr_crit("watchdog%d: watchdog did not stop!\n", wdd
->id
);
858 watchdog_update_worker(wdd
);
860 /* make sure that /dev/watchdog can be re-opened */
861 clear_bit(_WDOG_DEV_OPEN
, &wd_data
->status
);
864 running
= wdd
&& watchdog_hw_running(wdd
);
865 mutex_unlock(&wd_data
->lock
);
867 * Allow the owner module to be unloaded again unless the watchdog
868 * is still running. If the watchdog is still running, it can not
869 * be stopped, and its driver must not be unloaded.
872 module_put(wd_data
->cdev
.owner
);
873 kref_put(&wd_data
->kref
, watchdog_core_data_release
);
878 static const struct file_operations watchdog_fops
= {
879 .owner
= THIS_MODULE
,
880 .write
= watchdog_write
,
881 .unlocked_ioctl
= watchdog_ioctl
,
882 .open
= watchdog_open
,
883 .release
= watchdog_release
,
886 static struct miscdevice watchdog_miscdev
= {
887 .minor
= WATCHDOG_MINOR
,
889 .fops
= &watchdog_fops
,
893 * watchdog_cdev_register: register watchdog character device
894 * @wdd: watchdog device
895 * @devno: character device number
897 * Register a watchdog character device including handling the legacy
898 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
899 * thus we set it up like that.
902 static int watchdog_cdev_register(struct watchdog_device
*wdd
, dev_t devno
)
904 struct watchdog_core_data
*wd_data
;
907 wd_data
= kzalloc(sizeof(struct watchdog_core_data
), GFP_KERNEL
);
910 kref_init(&wd_data
->kref
);
911 mutex_init(&wd_data
->lock
);
914 wdd
->wd_data
= wd_data
;
919 INIT_DELAYED_WORK(&wd_data
->work
, watchdog_ping_work
);
922 old_wd_data
= wd_data
;
923 watchdog_miscdev
.parent
= wdd
->parent
;
924 err
= misc_register(&watchdog_miscdev
);
926 pr_err("%s: cannot register miscdev on minor=%d (err=%d).\n",
927 wdd
->info
->identity
, WATCHDOG_MINOR
, err
);
929 pr_err("%s: a legacy watchdog module is probably present.\n",
930 wdd
->info
->identity
);
937 /* Fill in the data structures */
938 cdev_init(&wd_data
->cdev
, &watchdog_fops
);
939 wd_data
->cdev
.owner
= wdd
->ops
->owner
;
942 err
= cdev_add(&wd_data
->cdev
, devno
, 1);
944 pr_err("watchdog%d unable to add device %d:%d\n",
945 wdd
->id
, MAJOR(watchdog_devt
), wdd
->id
);
947 misc_deregister(&watchdog_miscdev
);
949 kref_put(&wd_data
->kref
, watchdog_core_data_release
);
954 /* Record time of most recent heartbeat as 'just before now'. */
955 wd_data
->last_hw_keepalive
= jiffies
- 1;
958 * If the watchdog is running, prevent its driver from being unloaded,
959 * and schedule an immediate ping.
961 if (watchdog_hw_running(wdd
)) {
962 if (handle_boot_enabled
) {
963 __module_get(wdd
->ops
->owner
);
964 kref_get(&wd_data
->kref
);
965 queue_delayed_work(watchdog_wq
, &wd_data
->work
, 0);
967 pr_info("watchdog%d running and kernel based pre-userspace handler disabled\n",
976 * watchdog_cdev_unregister: unregister watchdog character device
977 * @watchdog: watchdog device
979 * Unregister watchdog character device and if needed the legacy
980 * /dev/watchdog device.
983 static void watchdog_cdev_unregister(struct watchdog_device
*wdd
)
985 struct watchdog_core_data
*wd_data
= wdd
->wd_data
;
987 cdev_del(&wd_data
->cdev
);
989 misc_deregister(&watchdog_miscdev
);
993 mutex_lock(&wd_data
->lock
);
996 mutex_unlock(&wd_data
->lock
);
998 if (watchdog_active(wdd
) &&
999 test_bit(WDOG_STOP_ON_UNREGISTER
, &wdd
->status
)) {
1003 cancel_delayed_work_sync(&wd_data
->work
);
1005 kref_put(&wd_data
->kref
, watchdog_core_data_release
);
1008 static struct class watchdog_class
= {
1010 .owner
= THIS_MODULE
,
1011 .dev_groups
= wdt_groups
,
1015 * watchdog_dev_register: register a watchdog device
1016 * @wdd: watchdog device
1018 * Register a watchdog device including handling the legacy
1019 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
1020 * thus we set it up like that.
1023 int watchdog_dev_register(struct watchdog_device
*wdd
)
1029 devno
= MKDEV(MAJOR(watchdog_devt
), wdd
->id
);
1031 ret
= watchdog_cdev_register(wdd
, devno
);
1035 dev
= device_create_with_groups(&watchdog_class
, wdd
->parent
,
1036 devno
, wdd
, wdd
->groups
,
1037 "watchdog%d", wdd
->id
);
1039 watchdog_cdev_unregister(wdd
);
1040 return PTR_ERR(dev
);
1043 ret
= watchdog_register_pretimeout(wdd
);
1045 device_destroy(&watchdog_class
, devno
);
1046 watchdog_cdev_unregister(wdd
);
1053 * watchdog_dev_unregister: unregister a watchdog device
1054 * @watchdog: watchdog device
1056 * Unregister watchdog device and if needed the legacy
1057 * /dev/watchdog device.
1060 void watchdog_dev_unregister(struct watchdog_device
*wdd
)
1062 watchdog_unregister_pretimeout(wdd
);
1063 device_destroy(&watchdog_class
, wdd
->wd_data
->cdev
.dev
);
1064 watchdog_cdev_unregister(wdd
);
1068 * watchdog_dev_init: init dev part of watchdog core
1070 * Allocate a range of chardev nodes to use for watchdog devices
1073 int __init
watchdog_dev_init(void)
1077 watchdog_wq
= alloc_workqueue("watchdogd",
1078 WQ_HIGHPRI
| WQ_MEM_RECLAIM
, 0);
1080 pr_err("Failed to create watchdog workqueue\n");
1084 err
= class_register(&watchdog_class
);
1086 pr_err("couldn't register class\n");
1090 err
= alloc_chrdev_region(&watchdog_devt
, 0, MAX_DOGS
, "watchdog");
1092 pr_err("watchdog: unable to allocate char dev region\n");
1099 class_unregister(&watchdog_class
);
1101 destroy_workqueue(watchdog_wq
);
1106 * watchdog_dev_exit: exit dev part of watchdog core
1108 * Release the range of chardev nodes used for watchdog devices
1111 void __exit
watchdog_dev_exit(void)
1113 unregister_chrdev_region(watchdog_devt
, MAX_DOGS
);
1114 class_unregister(&watchdog_class
);
1115 destroy_workqueue(watchdog_wq
);
1118 module_param(handle_boot_enabled
, bool, 0444);
1119 MODULE_PARM_DESC(handle_boot_enabled
,
1120 "Watchdog core auto-updates boot enabled watchdogs before userspace takes over (default="
1121 __MODULE_STRING(IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED
)) ")");