watchdog_core.c 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  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. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  29. #include <linux/module.h> /* For EXPORT_SYMBOL/module stuff/... */
  30. #include <linux/types.h> /* For standard types */
  31. #include <linux/errno.h> /* For the -ENODEV/... values */
  32. #include <linux/kernel.h> /* For printk/panic/... */
  33. #include <linux/watchdog.h> /* For watchdog specific items */
  34. #include <linux/init.h> /* For __init/__exit/... */
  35. #include <linux/idr.h> /* For ida_* macros */
  36. #include <linux/err.h> /* For IS_ERR macros */
  37. #include "watchdog_core.h" /* For watchdog_dev_register/... */
  38. static DEFINE_IDA(watchdog_ida);
  39. static struct class *watchdog_class;
  40. /**
  41. * watchdog_register_device() - register a watchdog device
  42. * @wdd: watchdog device
  43. *
  44. * Register a watchdog device with the kernel so that the
  45. * watchdog timer can be accessed from userspace.
  46. *
  47. * A zero is returned on success and a negative errno code for
  48. * failure.
  49. */
  50. int watchdog_register_device(struct watchdog_device *wdd)
  51. {
  52. int ret, id, devno;
  53. if (wdd == NULL || wdd->info == NULL || wdd->ops == NULL)
  54. return -EINVAL;
  55. /* Mandatory operations need to be supported */
  56. if (wdd->ops->start == NULL || wdd->ops->stop == NULL)
  57. return -EINVAL;
  58. /*
  59. * Check that we have valid min and max timeout values, if
  60. * not reset them both to 0 (=not used or unknown)
  61. */
  62. if (wdd->min_timeout > wdd->max_timeout) {
  63. pr_info("Invalid min and max timeout values, resetting to 0!\n");
  64. wdd->min_timeout = 0;
  65. wdd->max_timeout = 0;
  66. }
  67. /*
  68. * Note: now that all watchdog_device data has been verified, we
  69. * will not check this anymore in other functions. If data gets
  70. * corrupted in a later stage then we expect a kernel panic!
  71. */
  72. mutex_init(&wdd->lock);
  73. id = ida_simple_get(&watchdog_ida, 0, MAX_DOGS, GFP_KERNEL);
  74. if (id < 0)
  75. return id;
  76. wdd->id = id;
  77. ret = watchdog_dev_register(wdd);
  78. if (ret) {
  79. ida_simple_remove(&watchdog_ida, id);
  80. if (!(id == 0 && ret == -EBUSY))
  81. return ret;
  82. /* Retry in case a legacy watchdog module exists */
  83. id = ida_simple_get(&watchdog_ida, 1, MAX_DOGS, GFP_KERNEL);
  84. if (id < 0)
  85. return id;
  86. wdd->id = id;
  87. ret = watchdog_dev_register(wdd);
  88. if (ret) {
  89. ida_simple_remove(&watchdog_ida, id);
  90. return ret;
  91. }
  92. }
  93. devno = wdd->cdev.dev;
  94. wdd->dev = device_create(watchdog_class, wdd->parent, devno,
  95. NULL, "watchdog%d", wdd->id);
  96. if (IS_ERR(wdd->dev)) {
  97. watchdog_dev_unregister(wdd);
  98. ida_simple_remove(&watchdog_ida, id);
  99. ret = PTR_ERR(wdd->dev);
  100. return ret;
  101. }
  102. return 0;
  103. }
  104. EXPORT_SYMBOL_GPL(watchdog_register_device);
  105. /**
  106. * watchdog_unregister_device() - unregister a watchdog device
  107. * @wdd: watchdog device to unregister
  108. *
  109. * Unregister a watchdog device that was previously successfully
  110. * registered with watchdog_register_device().
  111. */
  112. void watchdog_unregister_device(struct watchdog_device *wdd)
  113. {
  114. int ret;
  115. int devno = wdd->cdev.dev;
  116. if (wdd == NULL)
  117. return;
  118. ret = watchdog_dev_unregister(wdd);
  119. if (ret)
  120. pr_err("error unregistering /dev/watchdog (err=%d)\n", ret);
  121. device_destroy(watchdog_class, devno);
  122. ida_simple_remove(&watchdog_ida, wdd->id);
  123. wdd->dev = NULL;
  124. }
  125. EXPORT_SYMBOL_GPL(watchdog_unregister_device);
  126. static int __init watchdog_init(void)
  127. {
  128. int err;
  129. watchdog_class = class_create(THIS_MODULE, "watchdog");
  130. if (IS_ERR(watchdog_class)) {
  131. pr_err("couldn't create class\n");
  132. return PTR_ERR(watchdog_class);
  133. }
  134. err = watchdog_dev_init();
  135. if (err < 0) {
  136. class_destroy(watchdog_class);
  137. return err;
  138. }
  139. return 0;
  140. }
  141. static void __exit watchdog_exit(void)
  142. {
  143. watchdog_dev_exit();
  144. class_destroy(watchdog_class);
  145. ida_destroy(&watchdog_ida);
  146. }
  147. subsys_initcall(watchdog_init);
  148. module_exit(watchdog_exit);
  149. MODULE_AUTHOR("Alan Cox <alan@lxorguk.ukuu.org.uk>");
  150. MODULE_AUTHOR("Wim Van Sebroeck <wim@iguana.be>");
  151. MODULE_DESCRIPTION("WatchDog Timer Driver Core");
  152. MODULE_LICENSE("GPL");