Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Generic watchdog defines. Derived from.. |
| 3 | * |
| 4 | * Berkshire PC Watchdog Defines |
| 5 | * by Ken Hollis <khollis@bitgate.com> |
| 6 | * |
| 7 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | #ifndef _LINUX_WATCHDOG_H |
| 9 | #define _LINUX_WATCHDOG_H |
| 10 | |
Andrey Panin | 4bfdf37 | 2005-07-27 11:43:58 -0700 | [diff] [blame] | 11 | |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 12 | #include <linux/bitops.h> |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 13 | #include <linux/device.h> |
| 14 | #include <linux/cdev.h> |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame] | 15 | #include <uapi/linux/watchdog.h> |
Andrey Panin | 4bfdf37 | 2005-07-27 11:43:58 -0700 | [diff] [blame] | 16 | |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 17 | struct watchdog_ops; |
| 18 | struct watchdog_device; |
| 19 | |
| 20 | /** struct watchdog_ops - The watchdog-devices operations |
| 21 | * |
| 22 | * @owner: The module owner. |
| 23 | * @start: The routine for starting the watchdog device. |
| 24 | * @stop: The routine for stopping the watchdog device. |
| 25 | * @ping: The routine that sends a keepalive ping to the watchdog device. |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 26 | * @status: The routine that shows the status of the watchdog device. |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 27 | * @set_timeout:The routine for setting the watchdog devices timeout value. |
Viresh Kumar | fd7b673 | 2012-03-16 09:14:00 +0100 | [diff] [blame] | 28 | * @get_timeleft:The routine that get's the time that's left before a reset. |
Hans de Goede | e907df3 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 29 | * @ref: The ref operation for dyn. allocated watchdog_device structs |
| 30 | * @unref: The unref operation for dyn. allocated watchdog_device structs |
Wim Van Sebroeck | 78d88fc | 2011-07-22 18:59:49 +0000 | [diff] [blame] | 31 | * @ioctl: The routines that handles extra ioctl calls. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 32 | * |
| 33 | * The watchdog_ops structure contains a list of low-level operations |
| 34 | * that control a watchdog device. It also contains the module that owns |
| 35 | * these operations. The start and stop function are mandatory, all other |
| 36 | * functions are optonal. |
| 37 | */ |
| 38 | struct watchdog_ops { |
| 39 | struct module *owner; |
| 40 | /* mandatory operations */ |
| 41 | int (*start)(struct watchdog_device *); |
| 42 | int (*stop)(struct watchdog_device *); |
| 43 | /* optional operations */ |
| 44 | int (*ping)(struct watchdog_device *); |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 45 | unsigned int (*status)(struct watchdog_device *); |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 46 | int (*set_timeout)(struct watchdog_device *, unsigned int); |
Viresh Kumar | fd7b673 | 2012-03-16 09:14:00 +0100 | [diff] [blame] | 47 | unsigned int (*get_timeleft)(struct watchdog_device *); |
Hans de Goede | e907df3 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 48 | void (*ref)(struct watchdog_device *); |
| 49 | void (*unref)(struct watchdog_device *); |
Wim Van Sebroeck | 78d88fc | 2011-07-22 18:59:49 +0000 | [diff] [blame] | 50 | long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long); |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 51 | }; |
| 52 | |
| 53 | /** struct watchdog_device - The structure that defines a watchdog device |
| 54 | * |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 55 | * @id: The watchdog's ID. (Allocated by watchdog_register_device) |
| 56 | * @cdev: The watchdog's Character device. |
Alan Cox | d6b469d | 2012-05-11 12:00:20 +0200 | [diff] [blame] | 57 | * @dev: The device for our watchdog |
| 58 | * @parent: The parent bus device |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 59 | * @info: Pointer to a watchdog_info structure. |
| 60 | * @ops: Pointer to the list of watchdog operations. |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 61 | * @bootstatus: Status of the watchdog device at boot. |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 62 | * @timeout: The watchdog devices timeout value. |
Wim Van Sebroeck | 3f43f68 | 2011-07-22 19:00:16 +0000 | [diff] [blame] | 63 | * @min_timeout:The watchdog devices minimum timeout value. |
| 64 | * @max_timeout:The watchdog devices maximum timeout value. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 65 | * @driver-data:Pointer to the drivers private data. |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 66 | * @lock: Lock for watchdog core internal use only. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 67 | * @status: Field that contains the devices internal status bits. |
Jean-Baptiste Theou | ef90174 | 2015-06-09 09:55:02 -0700 | [diff] [blame] | 68 | * @deferred: entry in wtd_deferred_reg_list which is used to |
| 69 | * register early initialized watchdogs. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 70 | * |
| 71 | * The watchdog_device structure contains all information about a |
| 72 | * watchdog timer device. |
| 73 | * |
| 74 | * The driver-data field may not be accessed directly. It must be accessed |
| 75 | * via the watchdog_set_drvdata and watchdog_get_drvdata helpers. |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 76 | * |
| 77 | * The lock field is for watchdog core internal use only and should not be |
| 78 | * touched. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 79 | */ |
| 80 | struct watchdog_device { |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 81 | int id; |
| 82 | struct cdev cdev; |
Alan Cox | d6b469d | 2012-05-11 12:00:20 +0200 | [diff] [blame] | 83 | struct device *dev; |
| 84 | struct device *parent; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 85 | const struct watchdog_info *info; |
| 86 | const struct watchdog_ops *ops; |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 87 | unsigned int bootstatus; |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 88 | unsigned int timeout; |
Wim Van Sebroeck | 3f43f68 | 2011-07-22 19:00:16 +0000 | [diff] [blame] | 89 | unsigned int min_timeout; |
| 90 | unsigned int max_timeout; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 91 | void *driver_data; |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 92 | struct mutex lock; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 93 | unsigned long status; |
| 94 | /* Bit numbers for status flags */ |
Wim Van Sebroeck | 234445b | 2011-07-22 18:57:55 +0000 | [diff] [blame] | 95 | #define WDOG_ACTIVE 0 /* Is the watchdog running/active */ |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 96 | #define WDOG_DEV_OPEN 1 /* Opened via /dev/watchdog ? */ |
Wim Van Sebroeck | 017cf08 | 2011-07-22 18:58:54 +0000 | [diff] [blame] | 97 | #define WDOG_ALLOW_RELEASE 2 /* Did we receive the magic char ? */ |
Wim Van Sebroeck | 7e192b9 | 2011-07-22 18:59:17 +0000 | [diff] [blame] | 98 | #define WDOG_NO_WAY_OUT 3 /* Is 'nowayout' feature set ? */ |
Hans de Goede | e907df3 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 99 | #define WDOG_UNREGISTERED 4 /* Has the device been unregistered */ |
Jean-Baptiste Theou | ef90174 | 2015-06-09 09:55:02 -0700 | [diff] [blame] | 100 | struct list_head deferred; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 101 | }; |
| 102 | |
Uwe Kleine-König | 4846e37 | 2014-09-09 22:18:31 +0200 | [diff] [blame] | 103 | #define WATCHDOG_NOWAYOUT IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT) |
| 104 | #define WATCHDOG_NOWAYOUT_INIT_STATUS (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT) |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 105 | |
Adam Buchbinder | 48fc7f7 | 2012-09-19 21:48:00 -0400 | [diff] [blame] | 106 | /* Use the following function to check whether or not the watchdog is active */ |
Viresh Kumar | 257f8c4 | 2012-03-12 09:51:56 +0530 | [diff] [blame] | 107 | static inline bool watchdog_active(struct watchdog_device *wdd) |
| 108 | { |
| 109 | return test_bit(WDOG_ACTIVE, &wdd->status); |
| 110 | } |
| 111 | |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 112 | /* Use the following function to set the nowayout feature */ |
Wim Van Sebroeck | 86a1e18 | 2012-03-05 16:51:11 +0100 | [diff] [blame] | 113 | static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout) |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 114 | { |
| 115 | if (nowayout) |
| 116 | set_bit(WDOG_NO_WAY_OUT, &wdd->status); |
| 117 | } |
| 118 | |
Fabio Porcedda | 3048253 | 2013-01-08 11:04:10 +0100 | [diff] [blame] | 119 | /* Use the following function to check if a timeout value is invalid */ |
| 120 | static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigned int t) |
| 121 | { |
| 122 | return ((wdd->max_timeout != 0) && |
| 123 | (t < wdd->min_timeout || t > wdd->max_timeout)); |
| 124 | } |
| 125 | |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 126 | /* Use the following functions to manipulate watchdog driver specific data */ |
| 127 | static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data) |
| 128 | { |
| 129 | wdd->driver_data = data; |
| 130 | } |
| 131 | |
| 132 | static inline void *watchdog_get_drvdata(struct watchdog_device *wdd) |
| 133 | { |
| 134 | return wdd->driver_data; |
| 135 | } |
| 136 | |
Fabio Porcedda | cf13a84 | 2012-10-05 12:16:09 +0200 | [diff] [blame] | 137 | /* drivers/watchdog/watchdog_core.c */ |
Fabio Porcedda | 3048253 | 2013-01-08 11:04:10 +0100 | [diff] [blame] | 138 | extern int watchdog_init_timeout(struct watchdog_device *wdd, |
| 139 | unsigned int timeout_parm, struct device *dev); |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 140 | extern int watchdog_register_device(struct watchdog_device *); |
| 141 | extern void watchdog_unregister_device(struct watchdog_device *); |
| 142 | |
Stephane Eranian | b3738d2 | 2014-11-17 20:07:03 +0100 | [diff] [blame] | 143 | #ifdef CONFIG_HARDLOCKUP_DETECTOR |
| 144 | void watchdog_nmi_disable_all(void); |
| 145 | void watchdog_nmi_enable_all(void); |
| 146 | #else |
| 147 | static inline void watchdog_nmi_disable_all(void) {} |
| 148 | static inline void watchdog_nmi_enable_all(void) {} |
| 149 | #endif |
| 150 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | #endif /* ifndef _LINUX_WATCHDOG_H */ |