drivers/watchdog/watchdog_core.c

   1 /*
   2  *      watchdog_core.c
   3  *
   4  *      (c) Copyright 2008-2011 Alan Cox <alan@lxorguk.ukuu.org.uk>,
   5  *                                              All Rights Reserved.
   6  *
   7  *      (c) Copyright 2008-2011 Wim Van Sebroeck <wim@iguana.be>.
   8  *
   9  *      This source code is part of the generic code that can be used
  10  *      by all the watchdog timer drivers.
  11  *
  12  *      Based on source code of the following authors:
  13  *        Matt Domsch <Matt_Domsch@dell.com>,
  14  *        Rob Radez <rob@osinvestor.com>,
  15  *        Rusty Lynch <rusty@linux.co.intel.com>
  16  *        Satyam Sharma <satyam@infradead.org>
  17  *        Randy Dunlap <randy.dunlap@oracle.com>
  18  *
  19  *      This program is free software; you can redistribute it and/or
  20  *      modify it under the terms of the GNU General Public License
  21  *      as published by the Free Software Foundation; either version
  22  *      2 of the License, or (at your option) any later version.
  23  *
  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.
  27  */
  28
  29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/module.h>       /* For EXPORT_SYMBOL/module stuff/... */
  32 #include <linux/types.h>        /* For standard types */
  33 #include <linux/errno.h>        /* For the -ENODEV/... values */
  34 #include <linux/kernel.h>       /* For printk/panic/... */
  35 #include <linux/reboot.h>       /* For restart handler */
  36 #include <linux/watchdog.h>     /* For watchdog specific items */
  37 #include <linux/init.h>         /* For __init/__exit/... */
  38 #include <linux/idr.h>          /* For ida_* macros */
  39 #include <linux/err.h>          /* For IS_ERR macros */
  40 #include <linux/of.h>           /* For of_get_timeout_sec */
  41
  42 #include "watchdog_core.h"      /* For watchdog_dev_register/... */
  43
  44 static DEFINE_IDA(watchdog_ida);
  45
  46 /*
  47  * Deferred Registration infrastructure.
  48  *
  49  * Sometimes watchdog drivers needs to be loaded as soon as possible,
  50  * for example when it's impossible to disable it. To do so,
  51  * raising the initcall level of the watchdog driver is a solution.
  52  * But in such case, the miscdev is maybe not ready (subsys_initcall), and
  53  * watchdog_core need miscdev to register the watchdog as a char device.
  54  *
  55  * The deferred registration infrastructure offer a way for the watchdog
  56  * subsystem to register a watchdog properly, even before miscdev is ready.
  57  */
  58
  59 static DEFINE_MUTEX(wtd_deferred_reg_mutex);
  60 static LIST_HEAD(wtd_deferred_reg_list);
  61 static bool wtd_deferred_reg_done;
  62
  63 static int watchdog_deferred_registration_add(struct watchdog_device *wdd)
  64 {
  65         list_add_tail(&wdd->deferred,
  66                       &wtd_deferred_reg_list);
  67         return 0;
  68 }
  69
  70 static void watchdog_deferred_registration_del(struct watchdog_device *wdd)
  71 {
  72         struct list_head *p, *n;
  73         struct watchdog_device *wdd_tmp;
  74
  75         list_for_each_safe(p, n, &wtd_deferred_reg_list) {
  76                 wdd_tmp = list_entry(p, struct watchdog_device,
  77                                      deferred);
  78                 if (wdd_tmp == wdd) {
  79                         list_del(&wdd_tmp->deferred);
  80                         break;
  81                 }
  82         }
  83 }
  84
  85 static void watchdog_check_min_max_timeout(struct watchdog_device *wdd)
  86 {
  87         /*
  88          * Check that we have valid min and max timeout values, if
  89          * not reset them both to 0 (=not used or unknown)
  90          */
  91         if (!wdd->max_hw_heartbeat_ms && wdd->min_timeout > wdd->max_timeout) {
  92                 pr_info("Invalid min and max timeout values, resetting to 0!\n");
  93                 wdd->min_timeout = 0;
  94                 wdd->max_timeout = 0;
  95         }
  96 }
  97
  98 /**
  99  * watchdog_init_timeout() - initialize the timeout field
 100  * @wdd: watchdog device
 101  * @timeout_parm: timeout module parameter
 102  * @dev: Device that stores the timeout-sec property
 103  *
 104  * Initialize the timeout field of the watchdog_device struct with either the
 105  * timeout module parameter (if it is valid value) or the timeout-sec property
 106  * (only if it is a valid value and the timeout_parm is out of bounds).
 107  * If none of them are valid then we keep the old value (which should normally
 108  * be the default timeout value).
 109  *
 110  * A zero is returned on success and -EINVAL for failure.
 111  */
 112 int watchdog_init_timeout(struct watchdog_device *wdd,
 113                                 unsigned int timeout_parm, struct device *dev)
 114 {
 115         unsigned int t = 0;
 116         int ret = 0;
 117
 118         watchdog_check_min_max_timeout(wdd);
 119
 120         /* try to get the timeout module parameter first */
 121         if (!watchdog_timeout_invalid(wdd, timeout_parm) && timeout_parm) {
 122                 wdd->timeout = timeout_parm;
 123                 return ret;
 124         }
 125         if (timeout_parm)
 126                 ret = -EINVAL;
 127
 128         /* try to get the timeout_sec property */
 129         if (dev == NULL || dev->of_node == NULL)
 130                 return ret;
 131         of_property_read_u32(dev->of_node, "timeout-sec", &t);
 132         if (!watchdog_timeout_invalid(wdd, t) && t)
 133                 wdd->timeout = t;
 134         else
 135                 ret = -EINVAL;
 136
 137         return ret;
 138 }
 139 EXPORT_SYMBOL_GPL(watchdog_init_timeout);
 140
 141 static int watchdog_reboot_notifier(struct notifier_block *nb,
 142                                     unsigned long code, void *data)
 143 {
 144         struct watchdog_device *wdd;
 145
 146         wdd = container_of(nb, struct watchdog_device, reboot_nb);
 147         if (code == SYS_DOWN || code == SYS_HALT) {
 148                 if (watchdog_active(wdd)) {
 149                         int ret;
 150
 151                         ret = wdd->ops->stop(wdd);
 152                         if (ret)
 153                                 return NOTIFY_BAD;
 154                 }
 155         }
 156
 157         return NOTIFY_DONE;
 158 }
 159
 160 static int watchdog_restart_notifier(struct notifier_block *nb,
 161                                      unsigned long action, void *data)
 162 {
 163         struct watchdog_device *wdd = container_of(nb, struct watchdog_device,
 164                                                    restart_nb);
 165
 166         int ret;
 167
 168         ret = wdd->ops->restart(wdd, action, data);
 169         if (ret)
 170                 return NOTIFY_BAD;
 171
 172         return NOTIFY_DONE;
 173 }
 174
 175 /**
 176  * watchdog_set_restart_priority - Change priority of restart handler
 177  * @wdd: watchdog device
 178  * @priority: priority of the restart handler, should follow these guidelines:
 179  *   0:   use watchdog's restart function as last resort, has limited restart
 180  *        capabilies
 181  *   128: default restart handler, use if no other handler is expected to be
 182  *        available and/or if restart is sufficient to restart the entire system
 183  *   255: preempt all other handlers
 184  *
 185  * If a wdd->ops->restart function is provided when watchdog_register_device is
 186  * called, it will be registered as a restart handler with the priority given
 187  * here.
 188  */
 189 void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority)
 190 {
 191         wdd->restart_nb.priority = priority;
 192 }
 193 EXPORT_SYMBOL_GPL(watchdog_set_restart_priority);
 194
 195 static int __watchdog_register_device(struct watchdog_device *wdd)
 196 {
 197         int ret, id = -1;
 198
 199         if (wdd == NULL || wdd->info == NULL || wdd->ops == NULL)
 200                 return -EINVAL;
 201
 202         /* Mandatory operations need to be supported */
 203         if (!wdd->ops->start || (!wdd->ops->stop && !wdd->max_hw_heartbeat_ms))
 204                 return -EINVAL;
 205
 206         watchdog_check_min_max_timeout(wdd);
 207
 208         /*
 209          * Note: now that all watchdog_device data has been verified, we
 210          * will not check this anymore in other functions. If data gets
 211          * corrupted in a later stage then we expect a kernel panic!
 212          */
 213
 214         /* Use alias for watchdog id if possible */
 215         if (wdd->parent) {
 216                 ret = of_alias_get_id(wdd->parent->of_node, "watchdog");
 217                 if (ret >= 0)
 218                         id = ida_simple_get(&watchdog_ida, ret,
 219                                             ret + 1, GFP_KERNEL);
 220         }
 221
 222         if (id < 0)
 223                 id = ida_simple_get(&watchdog_ida, 0, MAX_DOGS, GFP_KERNEL);
 224
 225         if (id < 0)
 226                 return id;
 227         wdd->id = id;
 228
 229         ret = watchdog_dev_register(wdd);
 230         if (ret) {
 231                 ida_simple_remove(&watchdog_ida, id);
 232                 if (!(id == 0 && ret == -EBUSY))
 233                         return ret;
 234
 235                 /* Retry in case a legacy watchdog module exists */
 236                 id = ida_simple_get(&watchdog_ida, 1, MAX_DOGS, GFP_KERNEL);
 237                 if (id < 0)
 238                         return id;
 239                 wdd->id = id;
 240
 241                 ret = watchdog_dev_register(wdd);
 242                 if (ret) {
 243                         ida_simple_remove(&watchdog_ida, id);
 244                         return ret;
 245                 }
 246         }
 247
 248         if (test_bit(WDOG_STOP_ON_REBOOT, &wdd->status)) {
 249                 if (!wdd->ops->stop)
 250                         pr_warn("watchdog%d: stop_on_reboot not supported\n", wdd->id);
 251                 else {
 252                         wdd->reboot_nb.notifier_call = watchdog_reboot_notifier;
 253
 254                         ret = register_reboot_notifier(&wdd->reboot_nb);
 255                         if (ret) {
 256                                 pr_err("watchdog%d: Cannot register reboot notifier (%d)\n",
 257                                         wdd->id, ret);
 258                                 watchdog_dev_unregister(wdd);
 259                                 ida_simple_remove(&watchdog_ida, id);
 260                                 return ret;
 261                         }
 262                 }
 263         }
 264
 265         if (wdd->ops->restart) {
 266                 wdd->restart_nb.notifier_call = watchdog_restart_notifier;
 267
 268                 ret = register_restart_handler(&wdd->restart_nb);
 269                 if (ret)
 270                         pr_warn("watchdog%d: Cannot register restart handler (%d)\n",
 271                                 wdd->id, ret);
 272         }
 273
 274         return 0;
 275 }
 276
 277 /**
 278  * watchdog_register_device() - register a watchdog device
 279  * @wdd: watchdog device
 280  *
 281  * Register a watchdog device with the kernel so that the
 282  * watchdog timer can be accessed from userspace.
 283  *
 284  * A zero is returned on success and a negative errno code for
 285  * failure.
 286  */
 287
 288 int watchdog_register_device(struct watchdog_device *wdd)
 289 {
 290         int ret;
 291
 292         mutex_lock(&wtd_deferred_reg_mutex);
 293         if (wtd_deferred_reg_done)
 294                 ret = __watchdog_register_device(wdd);
 295         else
 296                 ret = watchdog_deferred_registration_add(wdd);
 297         mutex_unlock(&wtd_deferred_reg_mutex);
 298         return ret;
 299 }
 300 EXPORT_SYMBOL_GPL(watchdog_register_device);
 301
 302 static void __watchdog_unregister_device(struct watchdog_device *wdd)
 303 {
 304         if (wdd == NULL)
 305                 return;
 306
 307         if (wdd->ops->restart)
 308                 unregister_restart_handler(&wdd->restart_nb);
 309
 310         if (test_bit(WDOG_STOP_ON_REBOOT, &wdd->status))
 311                 unregister_reboot_notifier(&wdd->reboot_nb);
 312
 313         watchdog_dev_unregister(wdd);
 314         ida_simple_remove(&watchdog_ida, wdd->id);
 315 }
 316
 317 /**
 318  * watchdog_unregister_device() - unregister a watchdog device
 319  * @wdd: watchdog device to unregister
 320  *
 321  * Unregister a watchdog device that was previously successfully
 322  * registered with watchdog_register_device().
 323  */
 324
 325 void watchdog_unregister_device(struct watchdog_device *wdd)
 326 {
 327         mutex_lock(&wtd_deferred_reg_mutex);
 328         if (wtd_deferred_reg_done)
 329                 __watchdog_unregister_device(wdd);
 330         else
 331                 watchdog_deferred_registration_del(wdd);
 332         mutex_unlock(&wtd_deferred_reg_mutex);
 333 }
 334
 335 EXPORT_SYMBOL_GPL(watchdog_unregister_device);
 336
 337 static void devm_watchdog_unregister_device(struct device *dev, void *res)
 338 {
 339         watchdog_unregister_device(*(struct watchdog_device **)res);
 340 }
 341
 342 /**
 343  * devm_watchdog_register_device() - resource managed watchdog_register_device()
 344  * @dev: device that is registering this watchdog device
 345  * @wdd: watchdog device
 346  *
 347  * Managed watchdog_register_device(). For watchdog device registered by this
 348  * function,  watchdog_unregister_device() is automatically called on driver
 349  * detach. See watchdog_register_device() for more information.
 350  */
 351 int devm_watchdog_register_device(struct device *dev,
 352                                 struct watchdog_device *wdd)
 353 {
 354         struct watchdog_device **rcwdd;
 355         int ret;
 356
 357         rcwdd = devres_alloc(devm_watchdog_unregister_device, sizeof(*rcwdd),
 358                              GFP_KERNEL);
 359         if (!rcwdd)
 360                 return -ENOMEM;
 361
 362         ret = watchdog_register_device(wdd);
 363         if (!ret) {
 364                 *rcwdd = wdd;
 365                 devres_add(dev, rcwdd);
 366         } else {
 367                 devres_free(rcwdd);
 368         }
 369
 370         return ret;
 371 }
 372 EXPORT_SYMBOL_GPL(devm_watchdog_register_device);
 373
 374 static int __init watchdog_deferred_registration(void)
 375 {
 376         mutex_lock(&wtd_deferred_reg_mutex);
 377         wtd_deferred_reg_done = true;
 378         while (!list_empty(&wtd_deferred_reg_list)) {
 379                 struct watchdog_device *wdd;
 380
 381                 wdd = list_first_entry(&wtd_deferred_reg_list,
 382                                        struct watchdog_device, deferred);
 383                 list_del(&wdd->deferred);
 384                 __watchdog_register_device(wdd);
 385         }
 386         mutex_unlock(&wtd_deferred_reg_mutex);
 387         return 0;
 388 }
 389
 390 static int __init watchdog_init(void)
 391 {
 392         int err;
 393
 394         err = watchdog_dev_init();
 395         if (err < 0)
 396                 return err;
 397
 398         watchdog_deferred_registration();
 399         return 0;
 400 }
 401
 402 static void __exit watchdog_exit(void)
 403 {
 404         watchdog_dev_exit();
 405         ida_destroy(&watchdog_ida);
 406 }
 407
 408 subsys_initcall_sync(watchdog_init);
 409 module_exit(watchdog_exit);
 410
 411 MODULE_AUTHOR("Alan Cox <alan@lxorguk.ukuu.org.uk>");
 412 MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
 413 MODULE_DESCRIPTION("WatchDog Timer Driver Core");
 414 MODULE_LICENSE("GPL");