bnxt_en: Fix NULL ptr dereference crash in bnxt_fw_reset_task()
[linux/fpc-iii.git] / drivers / watchdog / watchdog_dev.c
blob3729f99fd8ecadb88d15e1b2bbb98ca5b2cc014d
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * watchdog_dev.c
5 * (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
6 * All Rights Reserved.
8 * (c) Copyright 2008-2011 Wim Van Sebroeck <wim@iguana.be>.
11 * This source code is part of the generic code that can be used
12 * by all the watchdog timer drivers.
14 * This part of the generic code takes care of the following
15 * misc device: /dev/watchdog.
17 * Based on source code of the following authors:
18 * Matt Domsch <Matt_Domsch@dell.com>,
19 * Rob Radez <rob@osinvestor.com>,
20 * Rusty Lynch <rusty@linux.co.intel.com>
21 * Satyam Sharma <satyam@infradead.org>
22 * Randy Dunlap <randy.dunlap@oracle.com>
24 * Neither Alan Cox, CymruNet Ltd., Wim Van Sebroeck nor Iguana vzw.
25 * admit liability nor provide warranty for any of this software.
26 * This material is provided "AS-IS" and at no charge.
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31 #include <linux/cdev.h> /* For character device */
32 #include <linux/errno.h> /* For the -ENODEV/... values */
33 #include <linux/fs.h> /* For file operations */
34 #include <linux/init.h> /* For __init/__exit/... */
35 #include <linux/hrtimer.h> /* For hrtimers */
36 #include <linux/kernel.h> /* For printk/panic/... */
37 #include <linux/kthread.h> /* For kthread_work */
38 #include <linux/miscdevice.h> /* For handling misc devices */
39 #include <linux/module.h> /* For module stuff/... */
40 #include <linux/mutex.h> /* For mutexes */
41 #include <linux/slab.h> /* For memory functions */
42 #include <linux/types.h> /* For standard types (like size_t) */
43 #include <linux/watchdog.h> /* For watchdog specific items */
44 #include <linux/uaccess.h> /* For copy_to_user/put_user/... */
46 #include <uapi/linux/sched/types.h> /* For struct sched_param */
48 #include "watchdog_core.h"
49 #include "watchdog_pretimeout.h"
52 * struct watchdog_core_data - watchdog core internal data
53 * @dev: The watchdog's internal device
54 * @cdev: The watchdog's Character device.
55 * @wdd: Pointer to watchdog device.
56 * @lock: Lock for watchdog core.
57 * @status: Watchdog core internal status bits.
59 struct watchdog_core_data {
60 struct device dev;
61 struct cdev cdev;
62 struct watchdog_device *wdd;
63 struct mutex lock;
64 ktime_t last_keepalive;
65 ktime_t last_hw_keepalive;
66 ktime_t open_deadline;
67 struct hrtimer timer;
68 struct kthread_work work;
69 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 ? */
72 #define _WDOG_KEEPALIVE 2 /* Did we receive a keepalive ? */
75 /* the dev_t structure to store the dynamically allocated watchdog devices */
76 static dev_t watchdog_devt;
77 /* Reference to watchdog device behind /dev/watchdog */
78 static struct watchdog_core_data *old_wd_data;
80 static struct kthread_worker *watchdog_kworker;
82 static bool handle_boot_enabled =
83 IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED);
85 static unsigned open_timeout = CONFIG_WATCHDOG_OPEN_TIMEOUT;
87 static bool watchdog_past_open_deadline(struct watchdog_core_data *data)
89 return ktime_after(ktime_get(), data->open_deadline);
92 static void watchdog_set_open_deadline(struct watchdog_core_data *data)
94 data->open_deadline = open_timeout ?
95 ktime_get() + ktime_set(open_timeout, 0) : KTIME_MAX;
98 static inline bool watchdog_need_worker(struct watchdog_device *wdd)
100 /* All variables in milli-seconds */
101 unsigned int hm = wdd->max_hw_heartbeat_ms;
102 unsigned int t = wdd->timeout * 1000;
105 * A worker to generate heartbeat requests is needed if all of the
106 * following conditions are true.
107 * - Userspace activated the watchdog.
108 * - The driver provided a value for the maximum hardware timeout, and
109 * thus is aware that the framework supports generating heartbeat
110 * requests.
111 * - Userspace requests a longer timeout than the hardware can handle.
113 * Alternatively, if userspace has not opened the watchdog
114 * device, we take care of feeding the watchdog if it is
115 * running.
117 return (hm && watchdog_active(wdd) && t > hm) ||
118 (t && !watchdog_active(wdd) && watchdog_hw_running(wdd));
121 static ktime_t watchdog_next_keepalive(struct watchdog_device *wdd)
123 struct watchdog_core_data *wd_data = wdd->wd_data;
124 unsigned int timeout_ms = wdd->timeout * 1000;
125 ktime_t keepalive_interval;
126 ktime_t last_heartbeat, latest_heartbeat;
127 ktime_t virt_timeout;
128 unsigned int hw_heartbeat_ms;
130 if (watchdog_active(wdd))
131 virt_timeout = ktime_add(wd_data->last_keepalive,
132 ms_to_ktime(timeout_ms));
133 else
134 virt_timeout = wd_data->open_deadline;
136 hw_heartbeat_ms = min_not_zero(timeout_ms, wdd->max_hw_heartbeat_ms);
137 keepalive_interval = ms_to_ktime(hw_heartbeat_ms / 2);
140 * To ensure that the watchdog times out wdd->timeout seconds
141 * after the most recent ping from userspace, the last
142 * worker ping has to come in hw_heartbeat_ms before this timeout.
144 last_heartbeat = ktime_sub(virt_timeout, ms_to_ktime(hw_heartbeat_ms));
145 latest_heartbeat = ktime_sub(last_heartbeat, ktime_get());
146 if (ktime_before(latest_heartbeat, keepalive_interval))
147 return latest_heartbeat;
148 return keepalive_interval;
151 static inline void watchdog_update_worker(struct watchdog_device *wdd)
153 struct watchdog_core_data *wd_data = wdd->wd_data;
155 if (watchdog_need_worker(wdd)) {
156 ktime_t t = watchdog_next_keepalive(wdd);
158 if (t > 0)
159 hrtimer_start(&wd_data->timer, t,
160 HRTIMER_MODE_REL_HARD);
161 } else {
162 hrtimer_cancel(&wd_data->timer);
166 static int __watchdog_ping(struct watchdog_device *wdd)
168 struct watchdog_core_data *wd_data = wdd->wd_data;
169 ktime_t earliest_keepalive, now;
170 int err;
172 earliest_keepalive = ktime_add(wd_data->last_hw_keepalive,
173 ms_to_ktime(wdd->min_hw_heartbeat_ms));
174 now = ktime_get();
176 if (ktime_after(earliest_keepalive, now)) {
177 hrtimer_start(&wd_data->timer,
178 ktime_sub(earliest_keepalive, now),
179 HRTIMER_MODE_REL_HARD);
180 return 0;
183 wd_data->last_hw_keepalive = now;
185 if (wdd->ops->ping)
186 err = wdd->ops->ping(wdd); /* ping the watchdog */
187 else
188 err = wdd->ops->start(wdd); /* restart watchdog */
190 watchdog_update_worker(wdd);
192 return err;
196 * watchdog_ping: ping the watchdog.
197 * @wdd: the watchdog device to ping
199 * The caller must hold wd_data->lock.
201 * If the watchdog has no own ping operation then it needs to be
202 * restarted via the start operation. This wrapper function does
203 * exactly that.
204 * We only ping when the watchdog device is running.
207 static int watchdog_ping(struct watchdog_device *wdd)
209 struct watchdog_core_data *wd_data = wdd->wd_data;
211 if (!watchdog_active(wdd) && !watchdog_hw_running(wdd))
212 return 0;
214 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
216 wd_data->last_keepalive = ktime_get();
217 return __watchdog_ping(wdd);
220 static bool watchdog_worker_should_ping(struct watchdog_core_data *wd_data)
222 struct watchdog_device *wdd = wd_data->wdd;
224 if (!wdd)
225 return false;
227 if (watchdog_active(wdd))
228 return true;
230 return watchdog_hw_running(wdd) && !watchdog_past_open_deadline(wd_data);
233 static void watchdog_ping_work(struct kthread_work *work)
235 struct watchdog_core_data *wd_data;
237 wd_data = container_of(work, struct watchdog_core_data, work);
239 mutex_lock(&wd_data->lock);
240 if (watchdog_worker_should_ping(wd_data))
241 __watchdog_ping(wd_data->wdd);
242 mutex_unlock(&wd_data->lock);
245 static enum hrtimer_restart watchdog_timer_expired(struct hrtimer *timer)
247 struct watchdog_core_data *wd_data;
249 wd_data = container_of(timer, struct watchdog_core_data, timer);
251 kthread_queue_work(watchdog_kworker, &wd_data->work);
252 return HRTIMER_NORESTART;
256 * watchdog_start: wrapper to start the watchdog.
257 * @wdd: the watchdog device to start
259 * The caller must hold wd_data->lock.
261 * Start the watchdog if it is not active and mark it active.
262 * This function returns zero on success or a negative errno code for
263 * failure.
266 static int watchdog_start(struct watchdog_device *wdd)
268 struct watchdog_core_data *wd_data = wdd->wd_data;
269 ktime_t started_at;
270 int err;
272 if (watchdog_active(wdd))
273 return 0;
275 set_bit(_WDOG_KEEPALIVE, &wd_data->status);
277 started_at = ktime_get();
278 if (watchdog_hw_running(wdd) && wdd->ops->ping)
279 err = wdd->ops->ping(wdd);
280 else
281 err = wdd->ops->start(wdd);
282 if (err == 0) {
283 set_bit(WDOG_ACTIVE, &wdd->status);
284 wd_data->last_keepalive = started_at;
285 wd_data->last_hw_keepalive = started_at;
286 watchdog_update_worker(wdd);
289 return err;
293 * watchdog_stop: wrapper to stop the watchdog.
294 * @wdd: the watchdog device to stop
296 * The caller must hold wd_data->lock.
298 * Stop the watchdog if it is still active and unmark it active.
299 * This function returns zero on success or a negative errno code for
300 * failure.
301 * If the 'nowayout' feature was set, the watchdog cannot be stopped.
304 static int watchdog_stop(struct watchdog_device *wdd)
306 int err = 0;
308 if (!watchdog_active(wdd))
309 return 0;
311 if (test_bit(WDOG_NO_WAY_OUT, &wdd->status)) {
312 pr_info("watchdog%d: nowayout prevents watchdog being stopped!\n",
313 wdd->id);
314 return -EBUSY;
317 if (wdd->ops->stop) {
318 clear_bit(WDOG_HW_RUNNING, &wdd->status);
319 err = wdd->ops->stop(wdd);
320 } else {
321 set_bit(WDOG_HW_RUNNING, &wdd->status);
324 if (err == 0) {
325 clear_bit(WDOG_ACTIVE, &wdd->status);
326 watchdog_update_worker(wdd);
329 return err;
333 * watchdog_get_status: wrapper to get the watchdog status
334 * @wdd: the watchdog device to get the status from
336 * The caller must hold wd_data->lock.
338 * Get the watchdog's status flags.
341 static unsigned int watchdog_get_status(struct watchdog_device *wdd)
343 struct watchdog_core_data *wd_data = wdd->wd_data;
344 unsigned int status;
346 if (wdd->ops->status)
347 status = wdd->ops->status(wdd);
348 else
349 status = wdd->bootstatus & (WDIOF_CARDRESET |
350 WDIOF_OVERHEAT |
351 WDIOF_FANFAULT |
352 WDIOF_EXTERN1 |
353 WDIOF_EXTERN2 |
354 WDIOF_POWERUNDER |
355 WDIOF_POWEROVER);
357 if (test_bit(_WDOG_ALLOW_RELEASE, &wd_data->status))
358 status |= WDIOF_MAGICCLOSE;
360 if (test_and_clear_bit(_WDOG_KEEPALIVE, &wd_data->status))
361 status |= WDIOF_KEEPALIVEPING;
363 return status;
367 * watchdog_set_timeout: set the watchdog timer timeout
368 * @wdd: the watchdog device to set the timeout for
369 * @timeout: timeout to set in seconds
371 * The caller must hold wd_data->lock.
374 static int watchdog_set_timeout(struct watchdog_device *wdd,
375 unsigned int timeout)
377 int err = 0;
379 if (!(wdd->info->options & WDIOF_SETTIMEOUT))
380 return -EOPNOTSUPP;
382 if (watchdog_timeout_invalid(wdd, timeout))
383 return -EINVAL;
385 if (wdd->ops->set_timeout) {
386 err = wdd->ops->set_timeout(wdd, timeout);
387 } else {
388 wdd->timeout = timeout;
389 /* Disable pretimeout if it doesn't fit the new timeout */
390 if (wdd->pretimeout >= wdd->timeout)
391 wdd->pretimeout = 0;
394 watchdog_update_worker(wdd);
396 return err;
400 * watchdog_set_pretimeout: set the watchdog timer pretimeout
401 * @wdd: the watchdog device to set the timeout for
402 * @timeout: pretimeout to set in seconds
405 static int watchdog_set_pretimeout(struct watchdog_device *wdd,
406 unsigned int timeout)
408 int err = 0;
410 if (!(wdd->info->options & WDIOF_PRETIMEOUT))
411 return -EOPNOTSUPP;
413 if (watchdog_pretimeout_invalid(wdd, timeout))
414 return -EINVAL;
416 if (wdd->ops->set_pretimeout)
417 err = wdd->ops->set_pretimeout(wdd, timeout);
418 else
419 wdd->pretimeout = timeout;
421 return err;
425 * watchdog_get_timeleft: wrapper to get the time left before a reboot
426 * @wdd: the watchdog device to get the remaining time from
427 * @timeleft: the time that's left
429 * The caller must hold wd_data->lock.
431 * Get the time before a watchdog will reboot (if not pinged).
434 static int watchdog_get_timeleft(struct watchdog_device *wdd,
435 unsigned int *timeleft)
437 *timeleft = 0;
439 if (!wdd->ops->get_timeleft)
440 return -EOPNOTSUPP;
442 *timeleft = wdd->ops->get_timeleft(wdd);
444 return 0;
447 #ifdef CONFIG_WATCHDOG_SYSFS
448 static ssize_t nowayout_show(struct device *dev, struct device_attribute *attr,
449 char *buf)
451 struct watchdog_device *wdd = dev_get_drvdata(dev);
453 return sprintf(buf, "%d\n", !!test_bit(WDOG_NO_WAY_OUT, &wdd->status));
455 static DEVICE_ATTR_RO(nowayout);
457 static ssize_t status_show(struct device *dev, struct device_attribute *attr,
458 char *buf)
460 struct watchdog_device *wdd = dev_get_drvdata(dev);
461 struct watchdog_core_data *wd_data = wdd->wd_data;
462 unsigned int status;
464 mutex_lock(&wd_data->lock);
465 status = watchdog_get_status(wdd);
466 mutex_unlock(&wd_data->lock);
468 return sprintf(buf, "0x%x\n", status);
470 static DEVICE_ATTR_RO(status);
472 static ssize_t bootstatus_show(struct device *dev,
473 struct device_attribute *attr, char *buf)
475 struct watchdog_device *wdd = dev_get_drvdata(dev);
477 return sprintf(buf, "%u\n", wdd->bootstatus);
479 static DEVICE_ATTR_RO(bootstatus);
481 static ssize_t timeleft_show(struct device *dev, struct device_attribute *attr,
482 char *buf)
484 struct watchdog_device *wdd = dev_get_drvdata(dev);
485 struct watchdog_core_data *wd_data = wdd->wd_data;
486 ssize_t status;
487 unsigned int val;
489 mutex_lock(&wd_data->lock);
490 status = watchdog_get_timeleft(wdd, &val);
491 mutex_unlock(&wd_data->lock);
492 if (!status)
493 status = sprintf(buf, "%u\n", val);
495 return status;
497 static DEVICE_ATTR_RO(timeleft);
499 static ssize_t timeout_show(struct device *dev, struct device_attribute *attr,
500 char *buf)
502 struct watchdog_device *wdd = dev_get_drvdata(dev);
504 return sprintf(buf, "%u\n", wdd->timeout);
506 static DEVICE_ATTR_RO(timeout);
508 static ssize_t pretimeout_show(struct device *dev,
509 struct device_attribute *attr, char *buf)
511 struct watchdog_device *wdd = dev_get_drvdata(dev);
513 return sprintf(buf, "%u\n", wdd->pretimeout);
515 static DEVICE_ATTR_RO(pretimeout);
517 static ssize_t identity_show(struct device *dev, struct device_attribute *attr,
518 char *buf)
520 struct watchdog_device *wdd = dev_get_drvdata(dev);
522 return sprintf(buf, "%s\n", wdd->info->identity);
524 static DEVICE_ATTR_RO(identity);
526 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
527 char *buf)
529 struct watchdog_device *wdd = dev_get_drvdata(dev);
531 if (watchdog_active(wdd))
532 return sprintf(buf, "active\n");
534 return sprintf(buf, "inactive\n");
536 static DEVICE_ATTR_RO(state);
538 static ssize_t pretimeout_available_governors_show(struct device *dev,
539 struct device_attribute *attr, char *buf)
541 return watchdog_pretimeout_available_governors_get(buf);
543 static DEVICE_ATTR_RO(pretimeout_available_governors);
545 static ssize_t pretimeout_governor_show(struct device *dev,
546 struct device_attribute *attr,
547 char *buf)
549 struct watchdog_device *wdd = dev_get_drvdata(dev);
551 return watchdog_pretimeout_governor_get(wdd, buf);
554 static ssize_t pretimeout_governor_store(struct device *dev,
555 struct device_attribute *attr,
556 const char *buf, size_t count)
558 struct watchdog_device *wdd = dev_get_drvdata(dev);
559 int ret = watchdog_pretimeout_governor_set(wdd, buf);
561 if (!ret)
562 ret = count;
564 return ret;
566 static DEVICE_ATTR_RW(pretimeout_governor);
568 static umode_t wdt_is_visible(struct kobject *kobj, struct attribute *attr,
569 int n)
571 struct device *dev = container_of(kobj, struct device, kobj);
572 struct watchdog_device *wdd = dev_get_drvdata(dev);
573 umode_t mode = attr->mode;
575 if (attr == &dev_attr_timeleft.attr && !wdd->ops->get_timeleft)
576 mode = 0;
577 else if (attr == &dev_attr_pretimeout.attr &&
578 !(wdd->info->options & WDIOF_PRETIMEOUT))
579 mode = 0;
580 else if ((attr == &dev_attr_pretimeout_governor.attr ||
581 attr == &dev_attr_pretimeout_available_governors.attr) &&
582 (!(wdd->info->options & WDIOF_PRETIMEOUT) ||
583 !IS_ENABLED(CONFIG_WATCHDOG_PRETIMEOUT_GOV)))
584 mode = 0;
586 return mode;
588 static struct attribute *wdt_attrs[] = {
589 &dev_attr_state.attr,
590 &dev_attr_identity.attr,
591 &dev_attr_timeout.attr,
592 &dev_attr_pretimeout.attr,
593 &dev_attr_timeleft.attr,
594 &dev_attr_bootstatus.attr,
595 &dev_attr_status.attr,
596 &dev_attr_nowayout.attr,
597 &dev_attr_pretimeout_governor.attr,
598 &dev_attr_pretimeout_available_governors.attr,
599 NULL,
602 static const struct attribute_group wdt_group = {
603 .attrs = wdt_attrs,
604 .is_visible = wdt_is_visible,
606 __ATTRIBUTE_GROUPS(wdt);
607 #else
608 #define wdt_groups NULL
609 #endif
612 * watchdog_ioctl_op: call the watchdog drivers ioctl op if defined
613 * @wdd: the watchdog device to do the ioctl on
614 * @cmd: watchdog command
615 * @arg: argument pointer
617 * The caller must hold wd_data->lock.
620 static int watchdog_ioctl_op(struct watchdog_device *wdd, unsigned int cmd,
621 unsigned long arg)
623 if (!wdd->ops->ioctl)
624 return -ENOIOCTLCMD;
626 return wdd->ops->ioctl(wdd, cmd, arg);
630 * watchdog_write: writes to the watchdog.
631 * @file: file from VFS
632 * @data: user address of data
633 * @len: length of data
634 * @ppos: pointer to the file offset
636 * A write to a watchdog device is defined as a keepalive ping.
637 * Writing the magic 'V' sequence allows the next close to turn
638 * off the watchdog (if 'nowayout' is not set).
641 static ssize_t watchdog_write(struct file *file, const char __user *data,
642 size_t len, loff_t *ppos)
644 struct watchdog_core_data *wd_data = file->private_data;
645 struct watchdog_device *wdd;
646 int err;
647 size_t i;
648 char c;
650 if (len == 0)
651 return 0;
654 * Note: just in case someone wrote the magic character
655 * five months ago...
657 clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
659 /* scan to see whether or not we got the magic character */
660 for (i = 0; i != len; i++) {
661 if (get_user(c, data + i))
662 return -EFAULT;
663 if (c == 'V')
664 set_bit(_WDOG_ALLOW_RELEASE, &wd_data->status);
667 /* someone wrote to us, so we send the watchdog a keepalive ping */
669 err = -ENODEV;
670 mutex_lock(&wd_data->lock);
671 wdd = wd_data->wdd;
672 if (wdd)
673 err = watchdog_ping(wdd);
674 mutex_unlock(&wd_data->lock);
676 if (err < 0)
677 return err;
679 return len;
683 * watchdog_ioctl: handle the different ioctl's for the watchdog device.
684 * @file: file handle to the device
685 * @cmd: watchdog command
686 * @arg: argument pointer
688 * The watchdog API defines a common set of functions for all watchdogs
689 * according to their available features.
692 static long watchdog_ioctl(struct file *file, unsigned int cmd,
693 unsigned long arg)
695 struct watchdog_core_data *wd_data = file->private_data;
696 void __user *argp = (void __user *)arg;
697 struct watchdog_device *wdd;
698 int __user *p = argp;
699 unsigned int val;
700 int err;
702 mutex_lock(&wd_data->lock);
704 wdd = wd_data->wdd;
705 if (!wdd) {
706 err = -ENODEV;
707 goto out_ioctl;
710 err = watchdog_ioctl_op(wdd, cmd, arg);
711 if (err != -ENOIOCTLCMD)
712 goto out_ioctl;
714 switch (cmd) {
715 case WDIOC_GETSUPPORT:
716 err = copy_to_user(argp, wdd->info,
717 sizeof(struct watchdog_info)) ? -EFAULT : 0;
718 break;
719 case WDIOC_GETSTATUS:
720 val = watchdog_get_status(wdd);
721 err = put_user(val, p);
722 break;
723 case WDIOC_GETBOOTSTATUS:
724 err = put_user(wdd->bootstatus, p);
725 break;
726 case WDIOC_SETOPTIONS:
727 if (get_user(val, p)) {
728 err = -EFAULT;
729 break;
731 if (val & WDIOS_DISABLECARD) {
732 err = watchdog_stop(wdd);
733 if (err < 0)
734 break;
736 if (val & WDIOS_ENABLECARD)
737 err = watchdog_start(wdd);
738 break;
739 case WDIOC_KEEPALIVE:
740 if (!(wdd->info->options & WDIOF_KEEPALIVEPING)) {
741 err = -EOPNOTSUPP;
742 break;
744 err = watchdog_ping(wdd);
745 break;
746 case WDIOC_SETTIMEOUT:
747 if (get_user(val, p)) {
748 err = -EFAULT;
749 break;
751 err = watchdog_set_timeout(wdd, val);
752 if (err < 0)
753 break;
754 /* If the watchdog is active then we send a keepalive ping
755 * to make sure that the watchdog keep's running (and if
756 * possible that it takes the new timeout) */
757 err = watchdog_ping(wdd);
758 if (err < 0)
759 break;
760 /* fall through */
761 case WDIOC_GETTIMEOUT:
762 /* timeout == 0 means that we don't know the timeout */
763 if (wdd->timeout == 0) {
764 err = -EOPNOTSUPP;
765 break;
767 err = put_user(wdd->timeout, p);
768 break;
769 case WDIOC_GETTIMELEFT:
770 err = watchdog_get_timeleft(wdd, &val);
771 if (err < 0)
772 break;
773 err = put_user(val, p);
774 break;
775 case WDIOC_SETPRETIMEOUT:
776 if (get_user(val, p)) {
777 err = -EFAULT;
778 break;
780 err = watchdog_set_pretimeout(wdd, val);
781 break;
782 case WDIOC_GETPRETIMEOUT:
783 err = put_user(wdd->pretimeout, p);
784 break;
785 default:
786 err = -ENOTTY;
787 break;
790 out_ioctl:
791 mutex_unlock(&wd_data->lock);
792 return err;
796 * watchdog_open: open the /dev/watchdog* devices.
797 * @inode: inode of device
798 * @file: file handle to device
800 * When the /dev/watchdog* device gets opened, we start the watchdog.
801 * Watch out: the /dev/watchdog device is single open, so we make sure
802 * it can only be opened once.
805 static int watchdog_open(struct inode *inode, struct file *file)
807 struct watchdog_core_data *wd_data;
808 struct watchdog_device *wdd;
809 bool hw_running;
810 int err;
812 /* Get the corresponding watchdog device */
813 if (imajor(inode) == MISC_MAJOR)
814 wd_data = old_wd_data;
815 else
816 wd_data = container_of(inode->i_cdev, struct watchdog_core_data,
817 cdev);
819 /* the watchdog is single open! */
820 if (test_and_set_bit(_WDOG_DEV_OPEN, &wd_data->status))
821 return -EBUSY;
823 wdd = wd_data->wdd;
826 * If the /dev/watchdog device is open, we don't want the module
827 * to be unloaded.
829 hw_running = watchdog_hw_running(wdd);
830 if (!hw_running && !try_module_get(wdd->ops->owner)) {
831 err = -EBUSY;
832 goto out_clear;
835 err = watchdog_start(wdd);
836 if (err < 0)
837 goto out_mod;
839 file->private_data = wd_data;
841 if (!hw_running)
842 get_device(&wd_data->dev);
845 * open_timeout only applies for the first open from
846 * userspace. Set open_deadline to infinity so that the kernel
847 * will take care of an always-running hardware watchdog in
848 * case the device gets magic-closed or WDIOS_DISABLECARD is
849 * applied.
851 wd_data->open_deadline = KTIME_MAX;
853 /* dev/watchdog is a virtual (and thus non-seekable) filesystem */
854 return stream_open(inode, file);
856 out_mod:
857 module_put(wd_data->wdd->ops->owner);
858 out_clear:
859 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
860 return err;
863 static void watchdog_core_data_release(struct device *dev)
865 struct watchdog_core_data *wd_data;
867 wd_data = container_of(dev, struct watchdog_core_data, dev);
869 kfree(wd_data);
873 * watchdog_release: release the watchdog device.
874 * @inode: inode of device
875 * @file: file handle to device
877 * This is the code for when /dev/watchdog gets closed. We will only
878 * stop the watchdog when we have received the magic char (and nowayout
879 * was not set), else the watchdog will keep running.
882 static int watchdog_release(struct inode *inode, struct file *file)
884 struct watchdog_core_data *wd_data = file->private_data;
885 struct watchdog_device *wdd;
886 int err = -EBUSY;
887 bool running;
889 mutex_lock(&wd_data->lock);
891 wdd = wd_data->wdd;
892 if (!wdd)
893 goto done;
896 * We only stop the watchdog if we received the magic character
897 * or if WDIOF_MAGICCLOSE is not set. If nowayout was set then
898 * watchdog_stop will fail.
900 if (!test_bit(WDOG_ACTIVE, &wdd->status))
901 err = 0;
902 else if (test_and_clear_bit(_WDOG_ALLOW_RELEASE, &wd_data->status) ||
903 !(wdd->info->options & WDIOF_MAGICCLOSE))
904 err = watchdog_stop(wdd);
906 /* If the watchdog was not stopped, send a keepalive ping */
907 if (err < 0) {
908 pr_crit("watchdog%d: watchdog did not stop!\n", wdd->id);
909 watchdog_ping(wdd);
912 watchdog_update_worker(wdd);
914 /* make sure that /dev/watchdog can be re-opened */
915 clear_bit(_WDOG_DEV_OPEN, &wd_data->status);
917 done:
918 running = wdd && watchdog_hw_running(wdd);
919 mutex_unlock(&wd_data->lock);
921 * Allow the owner module to be unloaded again unless the watchdog
922 * is still running. If the watchdog is still running, it can not
923 * be stopped, and its driver must not be unloaded.
925 if (!running) {
926 module_put(wd_data->cdev.owner);
927 put_device(&wd_data->dev);
929 return 0;
932 static const struct file_operations watchdog_fops = {
933 .owner = THIS_MODULE,
934 .write = watchdog_write,
935 .unlocked_ioctl = watchdog_ioctl,
936 .open = watchdog_open,
937 .release = watchdog_release,
940 static struct miscdevice watchdog_miscdev = {
941 .minor = WATCHDOG_MINOR,
942 .name = "watchdog",
943 .fops = &watchdog_fops,
946 static struct class watchdog_class = {
947 .name = "watchdog",
948 .owner = THIS_MODULE,
949 .dev_groups = wdt_groups,
953 * watchdog_cdev_register: register watchdog character device
954 * @wdd: watchdog device
956 * Register a watchdog character device including handling the legacy
957 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
958 * thus we set it up like that.
961 static int watchdog_cdev_register(struct watchdog_device *wdd)
963 struct watchdog_core_data *wd_data;
964 int err;
966 wd_data = kzalloc(sizeof(struct watchdog_core_data), GFP_KERNEL);
967 if (!wd_data)
968 return -ENOMEM;
969 mutex_init(&wd_data->lock);
971 wd_data->wdd = wdd;
972 wdd->wd_data = wd_data;
974 if (IS_ERR_OR_NULL(watchdog_kworker))
975 return -ENODEV;
977 device_initialize(&wd_data->dev);
978 wd_data->dev.devt = MKDEV(MAJOR(watchdog_devt), wdd->id);
979 wd_data->dev.class = &watchdog_class;
980 wd_data->dev.parent = wdd->parent;
981 wd_data->dev.groups = wdd->groups;
982 wd_data->dev.release = watchdog_core_data_release;
983 dev_set_drvdata(&wd_data->dev, wdd);
984 dev_set_name(&wd_data->dev, "watchdog%d", wdd->id);
986 kthread_init_work(&wd_data->work, watchdog_ping_work);
987 hrtimer_init(&wd_data->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_HARD);
988 wd_data->timer.function = watchdog_timer_expired;
990 if (wdd->id == 0) {
991 old_wd_data = wd_data;
992 watchdog_miscdev.parent = wdd->parent;
993 err = misc_register(&watchdog_miscdev);
994 if (err != 0) {
995 pr_err("%s: cannot register miscdev on minor=%d (err=%d).\n",
996 wdd->info->identity, WATCHDOG_MINOR, err);
997 if (err == -EBUSY)
998 pr_err("%s: a legacy watchdog module is probably present.\n",
999 wdd->info->identity);
1000 old_wd_data = NULL;
1001 kfree(wd_data);
1002 return err;
1006 /* Fill in the data structures */
1007 cdev_init(&wd_data->cdev, &watchdog_fops);
1009 /* Add the device */
1010 err = cdev_device_add(&wd_data->cdev, &wd_data->dev);
1011 if (err) {
1012 pr_err("watchdog%d unable to add device %d:%d\n",
1013 wdd->id, MAJOR(watchdog_devt), wdd->id);
1014 if (wdd->id == 0) {
1015 misc_deregister(&watchdog_miscdev);
1016 old_wd_data = NULL;
1017 put_device(&wd_data->dev);
1019 return err;
1022 wd_data->cdev.owner = wdd->ops->owner;
1024 /* Record time of most recent heartbeat as 'just before now'. */
1025 wd_data->last_hw_keepalive = ktime_sub(ktime_get(), 1);
1026 watchdog_set_open_deadline(wd_data);
1029 * If the watchdog is running, prevent its driver from being unloaded,
1030 * and schedule an immediate ping.
1032 if (watchdog_hw_running(wdd)) {
1033 __module_get(wdd->ops->owner);
1034 get_device(&wd_data->dev);
1035 if (handle_boot_enabled)
1036 hrtimer_start(&wd_data->timer, 0,
1037 HRTIMER_MODE_REL_HARD);
1038 else
1039 pr_info("watchdog%d running and kernel based pre-userspace handler disabled\n",
1040 wdd->id);
1043 return 0;
1047 * watchdog_cdev_unregister: unregister watchdog character device
1048 * @watchdog: watchdog device
1050 * Unregister watchdog character device and if needed the legacy
1051 * /dev/watchdog device.
1054 static void watchdog_cdev_unregister(struct watchdog_device *wdd)
1056 struct watchdog_core_data *wd_data = wdd->wd_data;
1058 cdev_device_del(&wd_data->cdev, &wd_data->dev);
1059 if (wdd->id == 0) {
1060 misc_deregister(&watchdog_miscdev);
1061 old_wd_data = NULL;
1064 if (watchdog_active(wdd) &&
1065 test_bit(WDOG_STOP_ON_UNREGISTER, &wdd->status)) {
1066 watchdog_stop(wdd);
1069 mutex_lock(&wd_data->lock);
1070 wd_data->wdd = NULL;
1071 wdd->wd_data = NULL;
1072 mutex_unlock(&wd_data->lock);
1074 hrtimer_cancel(&wd_data->timer);
1075 kthread_cancel_work_sync(&wd_data->work);
1077 put_device(&wd_data->dev);
1081 * watchdog_dev_register: register a watchdog device
1082 * @wdd: watchdog device
1084 * Register a watchdog device including handling the legacy
1085 * /dev/watchdog node. /dev/watchdog is actually a miscdevice and
1086 * thus we set it up like that.
1089 int watchdog_dev_register(struct watchdog_device *wdd)
1091 int ret;
1093 ret = watchdog_cdev_register(wdd);
1094 if (ret)
1095 return ret;
1097 ret = watchdog_register_pretimeout(wdd);
1098 if (ret)
1099 watchdog_cdev_unregister(wdd);
1101 return ret;
1105 * watchdog_dev_unregister: unregister a watchdog device
1106 * @watchdog: watchdog device
1108 * Unregister watchdog device and if needed the legacy
1109 * /dev/watchdog device.
1112 void watchdog_dev_unregister(struct watchdog_device *wdd)
1114 watchdog_unregister_pretimeout(wdd);
1115 watchdog_cdev_unregister(wdd);
1119 * watchdog_dev_init: init dev part of watchdog core
1121 * Allocate a range of chardev nodes to use for watchdog devices
1124 int __init watchdog_dev_init(void)
1126 int err;
1127 struct sched_param param = {.sched_priority = MAX_RT_PRIO - 1,};
1129 watchdog_kworker = kthread_create_worker(0, "watchdogd");
1130 if (IS_ERR(watchdog_kworker)) {
1131 pr_err("Failed to create watchdog kworker\n");
1132 return PTR_ERR(watchdog_kworker);
1134 sched_setscheduler(watchdog_kworker->task, SCHED_FIFO, &param);
1136 err = class_register(&watchdog_class);
1137 if (err < 0) {
1138 pr_err("couldn't register class\n");
1139 goto err_register;
1142 err = alloc_chrdev_region(&watchdog_devt, 0, MAX_DOGS, "watchdog");
1143 if (err < 0) {
1144 pr_err("watchdog: unable to allocate char dev region\n");
1145 goto err_alloc;
1148 return 0;
1150 err_alloc:
1151 class_unregister(&watchdog_class);
1152 err_register:
1153 kthread_destroy_worker(watchdog_kworker);
1154 return err;
1158 * watchdog_dev_exit: exit dev part of watchdog core
1160 * Release the range of chardev nodes used for watchdog devices
1163 void __exit watchdog_dev_exit(void)
1165 unregister_chrdev_region(watchdog_devt, MAX_DOGS);
1166 class_unregister(&watchdog_class);
1167 kthread_destroy_worker(watchdog_kworker);
1170 module_param(handle_boot_enabled, bool, 0444);
1171 MODULE_PARM_DESC(handle_boot_enabled,
1172 "Watchdog core auto-updates boot enabled watchdogs before userspace takes over (default="
1173 __MODULE_STRING(IS_ENABLED(CONFIG_WATCHDOG_HANDLE_BOOT_ENABLED)) ")");
1175 module_param(open_timeout, uint, 0644);
1176 MODULE_PARM_DESC(open_timeout,
1177 "Maximum time (in seconds, 0 means infinity) for userspace to take over a running watchdog (default="
1178 __MODULE_STRING(CONFIG_WATCHDOG_OPEN_TIMEOUT) ")");