1 // SPDX-License-Identifier: GPL-2.0+
5 * (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
8 * (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 * Based on source code of the following authors:
14 * Matt Domsch <Matt_Domsch@dell.com>,
15 * Rob Radez <rob@osinvestor.com>,
16 * Rusty Lynch <rusty@linux.co.intel.com>
17 * Satyam Sharma <satyam@infradead.org>
18 * Randy Dunlap <randy.dunlap@oracle.com>
20 * Neither Alan Cox, CymruNet Ltd., Wim Van Sebroeck nor Iguana vzw.
21 * admit liability nor provide warranty for any of this software.
22 * This material is provided "AS-IS" and at no charge.
25 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27 #include <linux/module.h> /* For EXPORT_SYMBOL/module stuff/... */
28 #include <linux/types.h> /* For standard types */
29 #include <linux/errno.h> /* For the -ENODEV/... values */
30 #include <linux/kernel.h> /* For printk/panic/... */
31 #include <linux/reboot.h> /* For restart handler */
32 #include <linux/watchdog.h> /* For watchdog specific items */
33 #include <linux/init.h> /* For __init/__exit/... */
34 #include <linux/idr.h> /* For ida_* macros */
35 #include <linux/err.h> /* For IS_ERR macros */
36 #include <linux/of.h> /* For of_get_timeout_sec */
38 #include "watchdog_core.h" /* For watchdog_dev_register/... */
40 static DEFINE_IDA(watchdog_ida);
43 * Deferred Registration infrastructure.
45 * Sometimes watchdog drivers needs to be loaded as soon as possible,
46 * for example when it's impossible to disable it. To do so,
47 * raising the initcall level of the watchdog driver is a solution.
48 * But in such case, the miscdev is maybe not ready (subsys_initcall), and
49 * watchdog_core need miscdev to register the watchdog as a char device.
51 * The deferred registration infrastructure offer a way for the watchdog
52 * subsystem to register a watchdog properly, even before miscdev is ready.
55 static DEFINE_MUTEX(wtd_deferred_reg_mutex);
56 static LIST_HEAD(wtd_deferred_reg_list);
57 static bool wtd_deferred_reg_done;
59 static void watchdog_deferred_registration_add(struct watchdog_device *wdd)
61 list_add_tail(&wdd->deferred,
62 &wtd_deferred_reg_list);
65 static void watchdog_deferred_registration_del(struct watchdog_device *wdd)
67 struct list_head *p, *n;
68 struct watchdog_device *wdd_tmp;
70 list_for_each_safe(p, n, &wtd_deferred_reg_list) {
71 wdd_tmp = list_entry(p, struct watchdog_device,
74 list_del(&wdd_tmp->deferred);
80 static void watchdog_check_min_max_timeout(struct watchdog_device *wdd)
83 * Check that we have valid min and max timeout values, if
84 * not reset them both to 0 (=not used or unknown)
86 if (!wdd->max_hw_heartbeat_ms && wdd->min_timeout > wdd->max_timeout) {
87 pr_info("Invalid min and max timeout values, resetting to 0!\n");
94 * watchdog_init_timeout() - initialize the timeout field
95 * @wdd: watchdog device
96 * @timeout_parm: timeout module parameter
97 * @dev: Device that stores the timeout-sec property
99 * Initialize the timeout field of the watchdog_device struct with either the
100 * timeout module parameter (if it is valid value) or the timeout-sec property
101 * (only if it is a valid value and the timeout_parm is out of bounds).
102 * If none of them are valid then we keep the old value (which should normally
103 * be the default timeout value). Note that for the module parameter, '0' means
104 * 'use default' while it is an invalid value for the timeout-sec property.
105 * It should simply be dropped if you want to use the default value then.
107 * A zero is returned on success or -EINVAL if all provided values are out of
110 int watchdog_init_timeout(struct watchdog_device *wdd,
111 unsigned int timeout_parm, struct device *dev)
113 const char *dev_str = wdd->parent ? dev_name(wdd->parent) :
114 (const char *)wdd->info->identity;
118 watchdog_check_min_max_timeout(wdd);
120 /* check the driver supplied value (likely a module parameter) first */
122 if (!watchdog_timeout_invalid(wdd, timeout_parm)) {
123 wdd->timeout = timeout_parm;
126 pr_err("%s: driver supplied timeout (%u) out of range\n",
127 dev_str, timeout_parm);
131 /* try to get the timeout_sec property */
132 if (dev && dev->of_node &&
133 of_property_read_u32(dev->of_node, "timeout-sec", &t) == 0) {
134 if (t && !watchdog_timeout_invalid(wdd, t)) {
138 pr_err("%s: DT supplied timeout (%u) out of range\n", dev_str, t);
142 if (ret < 0 && wdd->timeout)
143 pr_warn("%s: falling back to default timeout (%u)\n", dev_str,
148 EXPORT_SYMBOL_GPL(watchdog_init_timeout);
150 static int watchdog_reboot_notifier(struct notifier_block *nb,
151 unsigned long code, void *data)
153 struct watchdog_device *wdd;
155 wdd = container_of(nb, struct watchdog_device, reboot_nb);
156 if (code == SYS_DOWN || code == SYS_HALT) {
157 if (watchdog_active(wdd)) {
160 ret = wdd->ops->stop(wdd);
169 static int watchdog_restart_notifier(struct notifier_block *nb,
170 unsigned long action, void *data)
172 struct watchdog_device *wdd = container_of(nb, struct watchdog_device,
177 ret = wdd->ops->restart(wdd, action, data);
185 * watchdog_set_restart_priority - Change priority of restart handler
186 * @wdd: watchdog device
187 * @priority: priority of the restart handler, should follow these guidelines:
188 * 0: use watchdog's restart function as last resort, has limited restart
190 * 128: default restart handler, use if no other handler is expected to be
191 * available and/or if restart is sufficient to restart the entire system
192 * 255: preempt all other handlers
194 * If a wdd->ops->restart function is provided when watchdog_register_device is
195 * called, it will be registered as a restart handler with the priority given
198 void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority)
200 wdd->restart_nb.priority = priority;
202 EXPORT_SYMBOL_GPL(watchdog_set_restart_priority);
204 static int __watchdog_register_device(struct watchdog_device *wdd)
208 if (wdd == NULL || wdd->info == NULL || wdd->ops == NULL)
211 /* Mandatory operations need to be supported */
212 if (!wdd->ops->start || (!wdd->ops->stop && !wdd->max_hw_heartbeat_ms))
215 watchdog_check_min_max_timeout(wdd);
218 * Note: now that all watchdog_device data has been verified, we
219 * will not check this anymore in other functions. If data gets
220 * corrupted in a later stage then we expect a kernel panic!
223 /* Use alias for watchdog id if possible */
225 ret = of_alias_get_id(wdd->parent->of_node, "watchdog");
227 id = ida_simple_get(&watchdog_ida, ret,
228 ret + 1, GFP_KERNEL);
232 id = ida_simple_get(&watchdog_ida, 0, MAX_DOGS, GFP_KERNEL);
238 ret = watchdog_dev_register(wdd);
240 ida_simple_remove(&watchdog_ida, id);
241 if (!(id == 0 && ret == -EBUSY))
244 /* Retry in case a legacy watchdog module exists */
245 id = ida_simple_get(&watchdog_ida, 1, MAX_DOGS, GFP_KERNEL);
250 ret = watchdog_dev_register(wdd);
252 ida_simple_remove(&watchdog_ida, id);
257 if (test_bit(WDOG_STOP_ON_REBOOT, &wdd->status)) {
259 pr_warn("watchdog%d: stop_on_reboot not supported\n", wdd->id);
261 wdd->reboot_nb.notifier_call = watchdog_reboot_notifier;
263 ret = register_reboot_notifier(&wdd->reboot_nb);
265 pr_err("watchdog%d: Cannot register reboot notifier (%d)\n",
267 watchdog_dev_unregister(wdd);
268 ida_simple_remove(&watchdog_ida, id);
274 if (wdd->ops->restart) {
275 wdd->restart_nb.notifier_call = watchdog_restart_notifier;
277 ret = register_restart_handler(&wdd->restart_nb);
279 pr_warn("watchdog%d: Cannot register restart handler (%d)\n",
287 * watchdog_register_device() - register a watchdog device
288 * @wdd: watchdog device
290 * Register a watchdog device with the kernel so that the
291 * watchdog timer can be accessed from userspace.
293 * A zero is returned on success and a negative errno code for
297 int watchdog_register_device(struct watchdog_device *wdd)
302 mutex_lock(&wtd_deferred_reg_mutex);
303 if (wtd_deferred_reg_done)
304 ret = __watchdog_register_device(wdd);
306 watchdog_deferred_registration_add(wdd);
307 mutex_unlock(&wtd_deferred_reg_mutex);
310 dev_str = wdd->parent ? dev_name(wdd->parent) :
311 (const char *)wdd->info->identity;
312 pr_err("%s: failed to register watchdog device (err = %d)\n",
318 EXPORT_SYMBOL_GPL(watchdog_register_device);
320 static void __watchdog_unregister_device(struct watchdog_device *wdd)
325 if (wdd->ops->restart)
326 unregister_restart_handler(&wdd->restart_nb);
328 if (test_bit(WDOG_STOP_ON_REBOOT, &wdd->status))
329 unregister_reboot_notifier(&wdd->reboot_nb);
331 watchdog_dev_unregister(wdd);
332 ida_simple_remove(&watchdog_ida, wdd->id);
336 * watchdog_unregister_device() - unregister a watchdog device
337 * @wdd: watchdog device to unregister
339 * Unregister a watchdog device that was previously successfully
340 * registered with watchdog_register_device().
343 void watchdog_unregister_device(struct watchdog_device *wdd)
345 mutex_lock(&wtd_deferred_reg_mutex);
346 if (wtd_deferred_reg_done)
347 __watchdog_unregister_device(wdd);
349 watchdog_deferred_registration_del(wdd);
350 mutex_unlock(&wtd_deferred_reg_mutex);
353 EXPORT_SYMBOL_GPL(watchdog_unregister_device);
355 static void devm_watchdog_unregister_device(struct device *dev, void *res)
357 watchdog_unregister_device(*(struct watchdog_device **)res);
361 * devm_watchdog_register_device() - resource managed watchdog_register_device()
362 * @dev: device that is registering this watchdog device
363 * @wdd: watchdog device
365 * Managed watchdog_register_device(). For watchdog device registered by this
366 * function, watchdog_unregister_device() is automatically called on driver
367 * detach. See watchdog_register_device() for more information.
369 int devm_watchdog_register_device(struct device *dev,
370 struct watchdog_device *wdd)
372 struct watchdog_device **rcwdd;
375 rcwdd = devres_alloc(devm_watchdog_unregister_device, sizeof(*rcwdd),
380 ret = watchdog_register_device(wdd);
383 devres_add(dev, rcwdd);
390 EXPORT_SYMBOL_GPL(devm_watchdog_register_device);
392 static int __init watchdog_deferred_registration(void)
394 mutex_lock(&wtd_deferred_reg_mutex);
395 wtd_deferred_reg_done = true;
396 while (!list_empty(&wtd_deferred_reg_list)) {
397 struct watchdog_device *wdd;
399 wdd = list_first_entry(&wtd_deferred_reg_list,
400 struct watchdog_device, deferred);
401 list_del(&wdd->deferred);
402 __watchdog_register_device(wdd);
404 mutex_unlock(&wtd_deferred_reg_mutex);
408 static int __init watchdog_init(void)
412 err = watchdog_dev_init();
416 watchdog_deferred_registration();
420 static void __exit watchdog_exit(void)
423 ida_destroy(&watchdog_ida);
426 subsys_initcall_sync(watchdog_init);
427 module_exit(watchdog_exit);
429 MODULE_AUTHOR("Alan Cox <alan@lxorguk.ukuu.org.uk>");
430 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
431 MODULE_DESCRIPTION("WatchDog Timer Driver Core");
432 MODULE_LICENSE("GPL");