xen/grant-table: Use put_page instead of free_page
[linux/fpc-iii.git] / drivers / watchdog / watchdog_dev.c
blob1e971a50d7fb74ffc1d7af27e39ef4a3df4d4cc9
1 /*
2 * watchdog_dev.c
4 * (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
5 * All Rights Reserved.
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/reboot.h> /* For reboot notifier */
46 #include <linux/slab.h> /* For memory functions */
47 #include <linux/types.h> /* For standard types (like size_t) */
48 #include <linux/watchdog.h> /* For watchdog specific items */
49 #include <linux/workqueue.h> /* For workqueue */
50 #include <linux/uaccess.h> /* For copy_to_user/put_user/... */
52 #include "watchdog_core.h"
53 #include "watchdog_pretimeout.h"
56 * struct watchdog_core_data - watchdog core internal data
57 * @kref: Reference count.
58 * @cdev: The watchdog's Character device.
59 * @wdd: Pointer to watchdog device.
60 * @lock: Lock for watchdog core.
61 * @status: Watchdog core internal status bits.
63 struct watchdog_core_data {
64 struct kref kref;
65 struct cdev cdev;
66 struct watchdog_device *wdd;
67 struct mutex lock;
68 unsigned long last_keepalive;
69 unsigned long last_hw_keepalive;
70 struct delayed_work work;
71 unsigned long status; /* Internal status bits */
72 #define _WDOG_DEV_OPEN 0 /* Opened ? */
73 #define _WDOG_ALLOW_RELEASE 1 /* Did we receive the magic char ? */
74 #define _WDOG_KEEPALIVE 2 /* Did we receive a keepalive ? */
77 /* the dev_t structure to store the dynamically allocated watchdog devices */
78 static dev_t watchdog_devt;
79 /* Reference to watchdog device behind /dev/watchdog */
80 static struct watchdog_core_data *old_wd_data;
82 static struct workqueue_struct *watchdog_wq;
84 static bool handle_boot_enabled =
85 IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED);
87 static inline bool watchdog_need_worker(struct watchdog_device *wdd)
89 /* All variables in milli-seconds */
90 unsigned int hm = wdd->max_hw_heartbeat_ms;
91 unsigned int t = wdd->timeout * 1000;
94 * A worker to generate heartbeat requests is needed if all of the
95 * following conditions are true.
96 * - Userspace activated the watchdog.
97 * - The driver provided a value for the maximum hardware timeout, and
98 * thus is aware that the framework supports generating heartbeat
99 * requests.
100 * - Userspace requests a longer timeout than the hardware can handle.
102 * Alternatively, if userspace has not opened the watchdog
103 * device, we take care of feeding the watchdog if it is
104 * running.
106 return (hm && watchdog_active(wdd) && t > hm) ||
107 (t && !watchdog_active(wdd) && watchdog_hw_running(wdd));
110 static long watchdog_next_keepalive(struct watchdog_device *wdd)
112 struct watchdog_core_data *wd_data = wdd->wd_data;
113 unsigned int timeout_ms = wdd->timeout * 1000;
114 unsigned long keepalive_interval;
115 unsigned long last_heartbeat;
116 unsigned long virt_timeout;
117 unsigned int hw_heartbeat_ms;
119 virt_timeout = wd_data->last_keepalive + msecs_to_jiffies(timeout_ms);
120 hw_heartbeat_ms = min_not_zero(timeout_ms, wdd->max_hw_heartbeat_ms);
121 keepalive_interval = msecs_to_jiffies(hw_heartbeat_ms / 2);
123 if (!watchdog_active(wdd))
124 return keepalive_interval;
127 * To ensure that the watchdog times out wdd->timeout seconds
128 * after the most recent ping from userspace, the last
129 * worker ping has to come in hw_heartbeat_ms before this timeout.
131 last_heartbeat = virt_timeout - msecs_to_jiffies(hw_heartbeat_ms);
132 return min_t(long, last_heartbeat - jiffies, keepalive_interval);
135 static inline void watchdog_update_worker(struct watchdog_device *wdd)
137 struct watchdog_core_data *wd_data = wdd->wd_data;
139 if (watchdog_need_worker(wdd)) {
140 long t = watchdog_next_keepalive(wdd);
142 if (t > 0)
143 mod_delayed_work(watchdog_wq, &wd_data->work, t);
144 } else {
145 cancel_delayed_work(&wd_data->work);
149 static int __watchdog_ping(struct watchdog_device *wdd)
151 struct watchdog_core_data *wd_data = wdd->wd_data;
152 unsigned long earliest_keepalive = wd_data->last_hw_keepalive +
153 msecs_to_jiffies(wdd->min_hw_heartbeat_ms);
154 int err;
156 if (time_is_after_jiffies(earliest_keepalive)) {
157 mod_delayed_work(watchdog_wq, &wd_data->work,
158 earliest_keepalive - jiffies);
159 return 0;
162 wd_data->last_hw_keepalive = jiffies;
164 if (wdd->ops->ping)
165 err = wdd->ops->ping(wdd); /* ping the watchdog */
166 else
167 err = wdd->ops->start(wdd); /* restart watchdog */
169 watchdog_update_worker(wdd);
171 return err;
175 * watchdog_ping: ping the watchdog.
176 * @wdd: the watchdog device to ping
178 * The caller must hold wd_data->lock.
180 * If the watchdog has no own ping operation then it needs to be
181 * restarted via the start operation. This wrapper function does
182 * exactly that.
183 * We only ping when the watchdog device is running.
186 static int watchdog_ping(struct watchdog_device *wdd)
188 struct watchdog_core_data *wd_data = wdd->wd_data;
190 if (!watchdog_active(wdd) && !watchdog_hw_running(wdd))
191 return 0;
193 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
195 wd_data->last_keepalive = jiffies;
196 return __watchdog_ping(wdd);
199 static bool watchdog_worker_should_ping(struct watchdog_core_data *wd_data)
201 struct watchdog_device *wdd = wd_data->wdd;
203 return wdd && (watchdog_active(wdd) || watchdog_hw_running(wdd));
206 static void watchdog_ping_work(struct work_struct *work)
208 struct watchdog_core_data *wd_data;
210 wd_data = container_of(to_delayed_work(work), struct watchdog_core_data,
211 work);
213 mutex_lock(&wd_data->lock);
214 if (watchdog_worker_should_ping(wd_data))
215 __watchdog_ping(wd_data->wdd);
216 mutex_unlock(&wd_data->lock);
220 * watchdog_start: wrapper to start the watchdog.
221 * @wdd: the watchdog device to start
223 * The caller must hold wd_data->lock.
225 * Start the watchdog if it is not active and mark it active.
226 * This function returns zero on success or a negative errno code for
227 * failure.
230 static int watchdog_start(struct watchdog_device *wdd)
232 struct watchdog_core_data *wd_data = wdd->wd_data;
233 unsigned long started_at;
234 int err;
236 if (watchdog_active(wdd))
237 return 0;
239 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
241 started_at = jiffies;
242 if (watchdog_hw_running(wdd) && wdd->ops->ping)
243 err = wdd->ops->ping(wdd);
244 else
245 err = wdd->ops->start(wdd);
246 if (err == 0) {
247 set_bit(WDOG_ACTIVE, &wdd->status);
248 wd_data->last_keepalive = started_at;
249 watchdog_update_worker(wdd);
252 return err;
256 * watchdog_stop: wrapper to stop the watchdog.
257 * @wdd: the watchdog device to stop
259 * The caller must hold wd_data->lock.
261 * Stop the watchdog if it is still active and unmark it active.
262 * This function returns zero on success or a negative errno code for
263 * failure.
264 * If the 'nowayout' feature was set, the watchdog cannot be stopped.
267 static int watchdog_stop(struct watchdog_device *wdd)
269 int err = 0;
271 if (!watchdog_active(wdd))
272 return 0;
274 if (test_bit(WDOG_NO_WAY_OUT, &wdd->status)) {
275 pr_info("watchdog%d: nowayout prevents watchdog being stopped!\n",
276 wdd->id);
277 return -EBUSY;
280 if (wdd->ops->stop) {
281 clear_bit(WDOG_HW_RUNNING, &wdd->status);
282 err = wdd->ops->stop(wdd);
283 } else {
284 set_bit(WDOG_HW_RUNNING, &wdd->status);
287 if (err == 0) {
288 clear_bit(WDOG_ACTIVE, &wdd->status);
289 watchdog_update_worker(wdd);
292 return err;
296 * watchdog_get_status: wrapper to get the watchdog status
297 * @wdd: the watchdog device to get the status from
299 * The caller must hold wd_data->lock.
301 * Get the watchdog's status flags.
304 static unsigned int watchdog_get_status(struct watchdog_device *wdd)
306 struct watchdog_core_data *wd_data = wdd->wd_data;
307 unsigned int status;
309 if (wdd->ops->status)
310 status = wdd->ops->status(wdd);
311 else
312 status = wdd->bootstatus & (WDIOF_CARDRESET |
313 WDIOF_OVERHEAT |
314 WDIOF_FANFAULT |
315 WDIOF_EXTERN1 |
316 WDIOF_EXTERN2 |
317 WDIOF_POWERUNDER |
318 WDIOF_POWEROVER);
320 if (test_bit(_WDOG_ALLOW_RELEASE, &wd_data->status))
321 status |= WDIOF_MAGICCLOSE;
323 if (test_and_clear_bit(_WDOG_KEEPALIVE, &wd_data->status))
324 status |= WDIOF_KEEPALIVEPING;
326 return status;
330 * watchdog_set_timeout: set the watchdog timer timeout
331 * @wdd: the watchdog device to set the timeout for
332 * @timeout: timeout to set in seconds
334 * The caller must hold wd_data->lock.
337 static int watchdog_set_timeout(struct watchdog_device *wdd,
338 unsigned int timeout)
340 int err = 0;
342 if (!(wdd->info->options & WDIOF_SETTIMEOUT))
343 return -EOPNOTSUPP;
345 if (watchdog_timeout_invalid(wdd, timeout))
346 return -EINVAL;
348 if (wdd->ops->set_timeout) {
349 err = wdd->ops->set_timeout(wdd, timeout);
350 } else {
351 wdd->timeout = timeout;
352 /* Disable pretimeout if it doesn't fit the new timeout */
353 if (wdd->pretimeout >= wdd->timeout)
354 wdd->pretimeout = 0;
357 watchdog_update_worker(wdd);
359 return err;
363 * watchdog_set_pretimeout: set the watchdog timer pretimeout
364 * @wdd: the watchdog device to set the timeout for
365 * @timeout: pretimeout to set in seconds
368 static int watchdog_set_pretimeout(struct watchdog_device *wdd,
369 unsigned int timeout)
371 int err = 0;
373 if (!(wdd->info->options & WDIOF_PRETIMEOUT))
374 return -EOPNOTSUPP;
376 if (watchdog_pretimeout_invalid(wdd, timeout))
377 return -EINVAL;
379 if (wdd->ops->set_pretimeout)
380 err = wdd->ops->set_pretimeout(wdd, timeout);
381 else
382 wdd->pretimeout = timeout;
384 return err;
388 * watchdog_get_timeleft: wrapper to get the time left before a reboot
389 * @wdd: the watchdog device to get the remaining time from
390 * @timeleft: the time that's left
392 * The caller must hold wd_data->lock.
394 * Get the time before a watchdog will reboot (if not pinged).
397 static int watchdog_get_timeleft(struct watchdog_device *wdd,
398 unsigned int *timeleft)
400 *timeleft = 0;
402 if (!wdd->ops->get_timeleft)
403 return -EOPNOTSUPP;
405 *timeleft = wdd->ops->get_timeleft(wdd);
407 return 0;
410 #ifdef CONFIG_WATCHDOG_SYSFS
411 static ssize_t nowayout_show(struct device *dev, struct device_attribute *attr,
412 char *buf)
414 struct watchdog_device *wdd = dev_get_drvdata(dev);
416 return sprintf(buf, "%d\n", !!test_bit(WDOG_NO_WAY_OUT, &wdd->status));
418 static DEVICE_ATTR_RO(nowayout);
420 static ssize_t status_show(struct device *dev, struct device_attribute *attr,
421 char *buf)
423 struct watchdog_device *wdd = dev_get_drvdata(dev);
424 struct watchdog_core_data *wd_data = wdd->wd_data;
425 unsigned int status;
427 mutex_lock(&wd_data->lock);
428 status = watchdog_get_status(wdd);
429 mutex_unlock(&wd_data->lock);
431 return sprintf(buf, "0x%x\n", status);
433 static DEVICE_ATTR_RO(status);
435 static ssize_t bootstatus_show(struct device *dev,
436 struct device_attribute *attr, char *buf)
438 struct watchdog_device *wdd = dev_get_drvdata(dev);
440 return sprintf(buf, "%u\n", wdd->bootstatus);
442 static DEVICE_ATTR_RO(bootstatus);
444 static ssize_t timeleft_show(struct device *dev, struct device_attribute *attr,
445 char *buf)
447 struct watchdog_device *wdd = dev_get_drvdata(dev);
448 struct watchdog_core_data *wd_data = wdd->wd_data;
449 ssize_t status;
450 unsigned int val;
452 mutex_lock(&wd_data->lock);
453 status = watchdog_get_timeleft(wdd, &val);
454 mutex_unlock(&wd_data->lock);
455 if (!status)
456 status = sprintf(buf, "%u\n", val);
458 return status;
460 static DEVICE_ATTR_RO(timeleft);
462 static ssize_t timeout_show(struct device *dev, struct device_attribute *attr,
463 char *buf)
465 struct watchdog_device *wdd = dev_get_drvdata(dev);
467 return sprintf(buf, "%u\n", wdd->timeout);
469 static DEVICE_ATTR_RO(timeout);
471 static ssize_t pretimeout_show(struct device *dev,
472 struct device_attribute *attr, char *buf)
474 struct watchdog_device *wdd = dev_get_drvdata(dev);
476 return sprintf(buf, "%u\n", wdd->pretimeout);
478 static DEVICE_ATTR_RO(pretimeout);
480 static ssize_t identity_show(struct device *dev, struct device_attribute *attr,
481 char *buf)
483 struct watchdog_device *wdd = dev_get_drvdata(dev);
485 return sprintf(buf, "%s\n", wdd->info->identity);
487 static DEVICE_ATTR_RO(identity);
489 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
490 char *buf)
492 struct watchdog_device *wdd = dev_get_drvdata(dev);
494 if (watchdog_active(wdd))
495 return sprintf(buf, "active\n");
497 return sprintf(buf, "inactive\n");
499 static DEVICE_ATTR_RO(state);
501 static ssize_t pretimeout_available_governors_show(struct device *dev,
502 struct device_attribute *attr, char *buf)
504 return watchdog_pretimeout_available_governors_get(buf);
506 static DEVICE_ATTR_RO(pretimeout_available_governors);
508 static ssize_t pretimeout_governor_show(struct device *dev,
509 struct device_attribute *attr,
510 char *buf)
512 struct watchdog_device *wdd = dev_get_drvdata(dev);
514 return watchdog_pretimeout_governor_get(wdd, buf);
517 static ssize_t pretimeout_governor_store(struct device *dev,
518 struct device_attribute *attr,
519 const char *buf, size_t count)
521 struct watchdog_device *wdd = dev_get_drvdata(dev);
522 int ret = watchdog_pretimeout_governor_set(wdd, buf);
524 if (!ret)
525 ret = count;
527 return ret;
529 static DEVICE_ATTR_RW(pretimeout_governor);
531 static umode_t wdt_is_visible(struct kobject *kobj, struct attribute *attr,
532 int n)
534 struct device *dev = container_of(kobj, struct device, kobj);
535 struct watchdog_device *wdd = dev_get_drvdata(dev);
536 umode_t mode = attr->mode;
538 if (attr == &dev_attr_timeleft.attr && !wdd->ops->get_timeleft)
539 mode = 0;
540 else if (attr == &dev_attr_pretimeout.attr &&
541 !(wdd->info->options & WDIOF_PRETIMEOUT))
542 mode = 0;
543 else if ((attr == &dev_attr_pretimeout_governor.attr ||
544 attr == &dev_attr_pretimeout_available_governors.attr) &&
545 (!(wdd->info->options & WDIOF_PRETIMEOUT) ||
546 !IS_ENABLED(CONFIG_WATCHDOG_PRETIMEOUT_GOV)))
547 mode = 0;
549 return mode;
551 static struct attribute *wdt_attrs[] = {
552 &dev_attr_state.attr,
553 &dev_attr_identity.attr,
554 &dev_attr_timeout.attr,
555 &dev_attr_pretimeout.attr,
556 &dev_attr_timeleft.attr,
557 &dev_attr_bootstatus.attr,
558 &dev_attr_status.attr,
559 &dev_attr_nowayout.attr,
560 &dev_attr_pretimeout_governor.attr,
561 &dev_attr_pretimeout_available_governors.attr,
562 NULL,
565 static const struct attribute_group wdt_group = {
566 .attrs = wdt_attrs,
567 .is_visible = wdt_is_visible,
569 __ATTRIBUTE_GROUPS(wdt);
570 #else
571 #define wdt_groups NULL
572 #endif
575 * watchdog_ioctl_op: call the watchdog drivers ioctl op if defined
576 * @wdd: the watchdog device to do the ioctl on
577 * @cmd: watchdog command
578 * @arg: argument pointer
580 * The caller must hold wd_data->lock.
583 static int watchdog_ioctl_op(struct watchdog_device *wdd, unsigned int cmd,
584 unsigned long arg)
586 if (!wdd->ops->ioctl)
587 return -ENOIOCTLCMD;
589 return wdd->ops->ioctl(wdd, cmd, arg);
593 * watchdog_write: writes to the watchdog.
594 * @file: file from VFS
595 * @data: user address of data
596 * @len: length of data
597 * @ppos: pointer to the file offset
599 * A write to a watchdog device is defined as a keepalive ping.
600 * Writing the magic 'V' sequence allows the next close to turn
601 * off the watchdog (if 'nowayout' is not set).
604 static ssize_t watchdog_write(struct file *file, const char __user *data,
605 size_t len, loff_t *ppos)
607 struct watchdog_core_data *wd_data = file->private_data;
608 struct watchdog_device *wdd;
609 int err;
610 size_t i;
611 char c;
613 if (len == 0)
614 return 0;
617 * Note: just in case someone wrote the magic character
618 * five months ago...
620 clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
622 /* scan to see whether or not we got the magic character */
623 for (i = 0; i != len; i++) {
624 if (get_user(c, data + i))
625 return -EFAULT;
626 if (c == 'V')
627 set_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
630 /* someone wrote to us, so we send the watchdog a keepalive ping */
632 err = -ENODEV;
633 mutex_lock(&wd_data->lock);
634 wdd = wd_data->wdd;
635 if (wdd)
636 err = watchdog_ping(wdd);
637 mutex_unlock(&wd_data->lock);
639 if (err < 0)
640 return err;
642 return len;
646 * watchdog_ioctl: handle the different ioctl's for the watchdog device.
647 * @file: file handle to the device
648 * @cmd: watchdog command
649 * @arg: argument pointer
651 * The watchdog API defines a common set of functions for all watchdogs
652 * according to their available features.
655 static long watchdog_ioctl(struct file *file, unsigned int cmd,
656 unsigned long arg)
658 struct watchdog_core_data *wd_data = file->private_data;
659 void __user *argp = (void __user *)arg;
660 struct watchdog_device *wdd;
661 int __user *p = argp;
662 unsigned int val;
663 int err;
665 mutex_lock(&wd_data->lock);
667 wdd = wd_data->wdd;
668 if (!wdd) {
669 err = -ENODEV;
670 goto out_ioctl;
673 err = watchdog_ioctl_op(wdd, cmd, arg);
674 if (err != -ENOIOCTLCMD)
675 goto out_ioctl;
677 switch (cmd) {
678 case WDIOC_GETSUPPORT:
679 err = copy_to_user(argp, wdd->info,
680 sizeof(struct watchdog_info)) ? -EFAULT : 0;
681 break;
682 case WDIOC_GETSTATUS:
683 val = watchdog_get_status(wdd);
684 err = put_user(val, p);
685 break;
686 case WDIOC_GETBOOTSTATUS:
687 err = put_user(wdd->bootstatus, p);
688 break;
689 case WDIOC_SETOPTIONS:
690 if (get_user(val, p)) {
691 err = -EFAULT;
692 break;
694 if (val & WDIOS_DISABLECARD) {
695 err = watchdog_stop(wdd);
696 if (err < 0)
697 break;
699 if (val & WDIOS_ENABLECARD)
700 err = watchdog_start(wdd);
701 break;
702 case WDIOC_KEEPALIVE:
703 if (!(wdd->info->options & WDIOF_KEEPALIVEPING)) {
704 err = -EOPNOTSUPP;
705 break;
707 err = watchdog_ping(wdd);
708 break;
709 case WDIOC_SETTIMEOUT:
710 if (get_user(val, p)) {
711 err = -EFAULT;
712 break;
714 err = watchdog_set_timeout(wdd, val);
715 if (err < 0)
716 break;
717 /* If the watchdog is active then we send a keepalive ping
718 * to make sure that the watchdog keep's running (and if
719 * possible that it takes the new timeout) */
720 err = watchdog_ping(wdd);
721 if (err < 0)
722 break;
723 /* Fall */
724 case WDIOC_GETTIMEOUT:
725 /* timeout == 0 means that we don't know the timeout */
726 if (wdd->timeout == 0) {
727 err = -EOPNOTSUPP;
728 break;
730 err = put_user(wdd->timeout, p);
731 break;
732 case WDIOC_GETTIMELEFT:
733 err = watchdog_get_timeleft(wdd, &val);
734 if (err < 0)
735 break;
736 err = put_user(val, p);
737 break;
738 case WDIOC_SETPRETIMEOUT:
739 if (get_user(val, p)) {
740 err = -EFAULT;
741 break;
743 err = watchdog_set_pretimeout(wdd, val);
744 break;
745 case WDIOC_GETPRETIMEOUT:
746 err = put_user(wdd->pretimeout, p);
747 break;
748 default:
749 err = -ENOTTY;
750 break;
753 out_ioctl:
754 mutex_unlock(&wd_data->lock);
755 return err;
759 * watchdog_open: open the /dev/watchdog* devices.
760 * @inode: inode of device
761 * @file: file handle to device
763 * When the /dev/watchdog* device gets opened, we start the watchdog.
764 * Watch out: the /dev/watchdog device is single open, so we make sure
765 * it can only be opened once.
768 static int watchdog_open(struct inode *inode, struct file *file)
770 struct watchdog_core_data *wd_data;
771 struct watchdog_device *wdd;
772 int err;
774 /* Get the corresponding watchdog device */
775 if (imajor(inode) == MISC_MAJOR)
776 wd_data = old_wd_data;
777 else
778 wd_data = container_of(inode->i_cdev, struct watchdog_core_data,
779 cdev);
781 /* the watchdog is single open! */
782 if (test_and_set_bit(_WDOG_DEV_OPEN, &wd_data->status))
783 return -EBUSY;
785 wdd = wd_data->wdd;
788 * If the /dev/watchdog device is open, we don't want the module
789 * to be unloaded.
791 if (!watchdog_hw_running(wdd) && !try_module_get(wdd->ops->owner)) {
792 err = -EBUSY;
793 goto out_clear;
796 err = watchdog_start(wdd);
797 if (err < 0)
798 goto out_mod;
800 file->private_data = wd_data;
802 if (!watchdog_hw_running(wdd))
803 kref_get(&wd_data->kref);
805 /* dev/watchdog is a virtual (and thus non-seekable) filesystem */
806 return nonseekable_open(inode, file);
808 out_mod:
809 module_put(wd_data->wdd->ops->owner);
810 out_clear:
811 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
812 return err;
815 static void watchdog_core_data_release(struct kref *kref)
817 struct watchdog_core_data *wd_data;
819 wd_data = container_of(kref, struct watchdog_core_data, kref);
821 kfree(wd_data);
825 * watchdog_release: release the watchdog device.
826 * @inode: inode of device
827 * @file: file handle to device
829 * This is the code for when /dev/watchdog gets closed. We will only
830 * stop the watchdog when we have received the magic char (and nowayout
831 * was not set), else the watchdog will keep running.
834 static int watchdog_release(struct inode *inode, struct file *file)
836 struct watchdog_core_data *wd_data = file->private_data;
837 struct watchdog_device *wdd;
838 int err = -EBUSY;
839 bool running;
841 mutex_lock(&wd_data->lock);
843 wdd = wd_data->wdd;
844 if (!wdd)
845 goto done;
848 * We only stop the watchdog if we received the magic character
849 * or if WDIOF_MAGICCLOSE is not set. If nowayout was set then
850 * watchdog_stop will fail.
852 if (!test_bit(WDOG_ACTIVE, &wdd->status))
853 err = 0;
854 else if (test_and_clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status) ||
855 !(wdd->info->options & WDIOF_MAGICCLOSE))
856 err = watchdog_stop(wdd);
858 /* If the watchdog was not stopped, send a keepalive ping */
859 if (err < 0) {
860 pr_crit("watchdog%d: watchdog did not stop!\n", wdd->id);
861 watchdog_ping(wdd);
864 watchdog_update_worker(wdd);
866 /* make sure that /dev/watchdog can be re-opened */
867 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
869 done:
870 running = wdd && watchdog_hw_running(wdd);
871 mutex_unlock(&wd_data->lock);
873 * Allow the owner module to be unloaded again unless the watchdog
874 * is still running. If the watchdog is still running, it can not
875 * be stopped, and its driver must not be unloaded.
877 if (!running) {
878 module_put(wd_data->cdev.owner);
879 kref_put(&wd_data->kref, watchdog_core_data_release);
881 return 0;
884 static const struct file_operations watchdog_fops = {
885 .owner = THIS_MODULE,
886 .write = watchdog_write,
887 .unlocked_ioctl = watchdog_ioctl,
888 .open = watchdog_open,
889 .release = watchdog_release,
892 static struct miscdevice watchdog_miscdev = {
893 .minor = WATCHDOG_MINOR,
894 .name = "watchdog",
895 .fops = &watchdog_fops,
899 * watchdog_cdev_register: register watchdog character device
900 * @wdd: watchdog device
901 * @devno: character device number
903 * Register a watchdog character device including handling the legacy
904 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
905 * thus we set it up like that.
908 static int watchdog_cdev_register(struct watchdog_device *wdd, dev_t devno)
910 struct watchdog_core_data *wd_data;
911 int err;
913 wd_data = kzalloc(sizeof(struct watchdog_core_data), GFP_KERNEL);
914 if (!wd_data)
915 return -ENOMEM;
916 kref_init(&wd_data->kref);
917 mutex_init(&wd_data->lock);
919 wd_data->wdd = wdd;
920 wdd->wd_data = wd_data;
922 if (!watchdog_wq)
923 return -ENODEV;
925 INIT_DELAYED_WORK(&wd_data->work, watchdog_ping_work);
927 if (wdd->id == 0) {
928 old_wd_data = wd_data;
929 watchdog_miscdev.parent = wdd->parent;
930 err = misc_register(&watchdog_miscdev);
931 if (err != 0) {
932 pr_err("%s: cannot register miscdev on minor=%d (err=%d).\n",
933 wdd->info->identity, WATCHDOG_MINOR, err);
934 if (err == -EBUSY)
935 pr_err("%s: a legacy watchdog module is probably present.\n",
936 wdd->info->identity);
937 old_wd_data = NULL;
938 kfree(wd_data);
939 return err;
943 /* Fill in the data structures */
944 cdev_init(&wd_data->cdev, &watchdog_fops);
945 wd_data->cdev.owner = wdd->ops->owner;
947 /* Add the device */
948 err = cdev_add(&wd_data->cdev, devno, 1);
949 if (err) {
950 pr_err("watchdog%d unable to add device %d:%d\n",
951 wdd->id, MAJOR(watchdog_devt), wdd->id);
952 if (wdd->id == 0) {
953 misc_deregister(&watchdog_miscdev);
954 old_wd_data = NULL;
955 kref_put(&wd_data->kref, watchdog_core_data_release);
957 return err;
960 /* Record time of most recent heartbeat as 'just before now'. */
961 wd_data->last_hw_keepalive = jiffies - 1;
964 * If the watchdog is running, prevent its driver from being unloaded,
965 * and schedule an immediate ping.
967 if (watchdog_hw_running(wdd)) {
968 if (handle_boot_enabled) {
969 __module_get(wdd->ops->owner);
970 kref_get(&wd_data->kref);
971 queue_delayed_work(watchdog_wq, &wd_data->work, 0);
972 } else {
973 pr_info("watchdog%d running and kernel based pre-userspace handler disabled\n",
974 wdd->id);
978 return 0;
982 * watchdog_cdev_unregister: unregister watchdog character device
983 * @watchdog: watchdog device
985 * Unregister watchdog character device and if needed the legacy
986 * /dev/watchdog device.
989 static void watchdog_cdev_unregister(struct watchdog_device *wdd)
991 struct watchdog_core_data *wd_data = wdd->wd_data;
993 cdev_del(&wd_data->cdev);
994 if (wdd->id == 0) {
995 misc_deregister(&watchdog_miscdev);
996 old_wd_data = NULL;
999 mutex_lock(&wd_data->lock);
1000 wd_data->wdd = NULL;
1001 wdd->wd_data = NULL;
1002 mutex_unlock(&wd_data->lock);
1004 if (watchdog_active(wdd) &&
1005 test_bit(WDOG_STOP_ON_UNREGISTER, &wdd->status)) {
1006 watchdog_stop(wdd);
1009 cancel_delayed_work_sync(&wd_data->work);
1011 kref_put(&wd_data->kref, watchdog_core_data_release);
1014 static struct class watchdog_class = {
1015 .name = "watchdog",
1016 .owner = THIS_MODULE,
1017 .dev_groups = wdt_groups,
1020 static int watchdog_reboot_notifier(struct notifier_block *nb,
1021 unsigned long code, void *data)
1023 struct watchdog_device *wdd;
1025 wdd = container_of(nb, struct watchdog_device, reboot_nb);
1026 if (code == SYS_DOWN || code == SYS_HALT) {
1027 if (watchdog_active(wdd)) {
1028 int ret;
1030 ret = wdd->ops->stop(wdd);
1031 if (ret)
1032 return NOTIFY_BAD;
1036 return NOTIFY_DONE;
1040 * watchdog_dev_register: register a watchdog device
1041 * @wdd: watchdog device
1043 * Register a watchdog device including handling the legacy
1044 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
1045 * thus we set it up like that.
1048 int watchdog_dev_register(struct watchdog_device *wdd)
1050 struct device *dev;
1051 dev_t devno;
1052 int ret;
1054 devno = MKDEV(MAJOR(watchdog_devt), wdd->id);
1056 ret = watchdog_cdev_register(wdd, devno);
1057 if (ret)
1058 return ret;
1060 dev = device_create_with_groups(&watchdog_class, wdd->parent,
1061 devno, wdd, wdd->groups,
1062 "watchdog%d", wdd->id);
1063 if (IS_ERR(dev)) {
1064 watchdog_cdev_unregister(wdd);
1065 return PTR_ERR(dev);
1068 ret = watchdog_register_pretimeout(wdd);
1069 if (ret) {
1070 device_destroy(&watchdog_class, devno);
1071 watchdog_cdev_unregister(wdd);
1072 return ret;
1075 if (test_bit(WDOG_STOP_ON_REBOOT, &wdd->status)) {
1076 wdd->reboot_nb.notifier_call = watchdog_reboot_notifier;
1078 ret = devm_register_reboot_notifier(dev, &wdd->reboot_nb);
1079 if (ret) {
1080 pr_err("watchdog%d: Cannot register reboot notifier (%d)\n",
1081 wdd->id, ret);
1082 watchdog_dev_unregister(wdd);
1086 return ret;
1090 * watchdog_dev_unregister: unregister a watchdog device
1091 * @watchdog: watchdog device
1093 * Unregister watchdog device and if needed the legacy
1094 * /dev/watchdog device.
1097 void watchdog_dev_unregister(struct watchdog_device *wdd)
1099 watchdog_unregister_pretimeout(wdd);
1100 device_destroy(&watchdog_class, wdd->wd_data->cdev.dev);
1101 watchdog_cdev_unregister(wdd);
1105 * watchdog_dev_init: init dev part of watchdog core
1107 * Allocate a range of chardev nodes to use for watchdog devices
1110 int __init watchdog_dev_init(void)
1112 int err;
1114 watchdog_wq = alloc_workqueue("watchdogd",
1115 WQ_HIGHPRI | WQ_MEM_RECLAIM, 0);
1116 if (!watchdog_wq) {
1117 pr_err("Failed to create watchdog workqueue\n");
1118 return -ENOMEM;
1121 err = class_register(&watchdog_class);
1122 if (err < 0) {
1123 pr_err("couldn't register class\n");
1124 goto err_register;
1127 err = alloc_chrdev_region(&watchdog_devt, 0, MAX_DOGS, "watchdog");
1128 if (err < 0) {
1129 pr_err("watchdog: unable to allocate char dev region\n");
1130 goto err_alloc;
1133 return 0;
1135 err_alloc:
1136 class_unregister(&watchdog_class);
1137 err_register:
1138 destroy_workqueue(watchdog_wq);
1139 return err;
1143 * watchdog_dev_exit: exit dev part of watchdog core
1145 * Release the range of chardev nodes used for watchdog devices
1148 void __exit watchdog_dev_exit(void)
1150 unregister_chrdev_region(watchdog_devt, MAX_DOGS);
1151 class_unregister(&watchdog_class);
1152 destroy_workqueue(watchdog_wq);
1155 module_param(handle_boot_enabled, bool, 0444);
1156 MODULE_PARM_DESC(handle_boot_enabled,
1157 "Watchdog core auto-updates boot enabled watchdogs before userspace takes over (default="
1158 __MODULE_STRING(IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED)) ")");