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 | */ |
| 8 | |
| 9 | #ifndef _LINUX_WATCHDOG_H |
| 10 | #define _LINUX_WATCHDOG_H |
| 11 | |
| 12 | #include <linux/ioctl.h> |
| 13 | #include <linux/types.h> |
| 14 | |
| 15 | #define WATCHDOG_IOCTL_BASE 'W' |
| 16 | |
| 17 | struct watchdog_info { |
| 18 | __u32 options; /* Options the card/driver supports */ |
| 19 | __u32 firmware_version; /* Firmware version of the card */ |
| 20 | __u8 identity[32]; /* Identity of the board */ |
| 21 | }; |
| 22 | |
| 23 | #define WDIOC_GETSUPPORT _IOR(WATCHDOG_IOCTL_BASE, 0, struct watchdog_info) |
| 24 | #define WDIOC_GETSTATUS _IOR(WATCHDOG_IOCTL_BASE, 1, int) |
| 25 | #define WDIOC_GETBOOTSTATUS _IOR(WATCHDOG_IOCTL_BASE, 2, int) |
| 26 | #define WDIOC_GETTEMP _IOR(WATCHDOG_IOCTL_BASE, 3, int) |
| 27 | #define WDIOC_SETOPTIONS _IOR(WATCHDOG_IOCTL_BASE, 4, int) |
| 28 | #define WDIOC_KEEPALIVE _IOR(WATCHDOG_IOCTL_BASE, 5, int) |
| 29 | #define WDIOC_SETTIMEOUT _IOWR(WATCHDOG_IOCTL_BASE, 6, int) |
| 30 | #define WDIOC_GETTIMEOUT _IOR(WATCHDOG_IOCTL_BASE, 7, int) |
Corey Minyard | e05b59f | 2006-04-19 22:40:53 +0200 | [diff] [blame] | 31 | #define WDIOC_SETPRETIMEOUT _IOWR(WATCHDOG_IOCTL_BASE, 8, int) |
| 32 | #define WDIOC_GETPRETIMEOUT _IOR(WATCHDOG_IOCTL_BASE, 9, int) |
Wim Van Sebroeck | 58b519f | 2006-05-21 12:48:44 +0200 | [diff] [blame] | 33 | #define WDIOC_GETTIMELEFT _IOR(WATCHDOG_IOCTL_BASE, 10, int) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | |
| 35 | #define WDIOF_UNKNOWN -1 /* Unknown flag error */ |
| 36 | #define WDIOS_UNKNOWN -1 /* Unknown status error */ |
| 37 | |
| 38 | #define WDIOF_OVERHEAT 0x0001 /* Reset due to CPU overheat */ |
| 39 | #define WDIOF_FANFAULT 0x0002 /* Fan failed */ |
| 40 | #define WDIOF_EXTERN1 0x0004 /* External relay 1 */ |
| 41 | #define WDIOF_EXTERN2 0x0008 /* External relay 2 */ |
| 42 | #define WDIOF_POWERUNDER 0x0010 /* Power bad/power fault */ |
| 43 | #define WDIOF_CARDRESET 0x0020 /* Card previously reset the CPU */ |
Wim Van Sebroeck | 58b519f | 2006-05-21 12:48:44 +0200 | [diff] [blame] | 44 | #define WDIOF_POWEROVER 0x0040 /* Power over voltage */ |
| 45 | #define WDIOF_SETTIMEOUT 0x0080 /* Set timeout (in seconds) */ |
| 46 | #define WDIOF_MAGICCLOSE 0x0100 /* Supports magic close char */ |
Corey Minyard | e05b59f | 2006-04-19 22:40:53 +0200 | [diff] [blame] | 47 | #define WDIOF_PRETIMEOUT 0x0200 /* Pretimeout (in seconds), get/set */ |
Alan Cox | 2bbeed0 | 2012-05-11 12:00:19 +0200 | [diff] [blame] | 48 | #define WDIOF_ALARMONLY 0x0400 /* Watchdog triggers a management or |
| 49 | other external alarm not a reboot */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | #define WDIOF_KEEPALIVEPING 0x8000 /* Keep alive ping reply */ |
| 51 | |
| 52 | #define WDIOS_DISABLECARD 0x0001 /* Turn off the watchdog timer */ |
| 53 | #define WDIOS_ENABLECARD 0x0002 /* Turn on the watchdog timer */ |
| 54 | #define WDIOS_TEMPPANIC 0x0004 /* Kernel panic on temperature trip */ |
| 55 | |
Andrey Panin | 4bfdf37 | 2005-07-27 11:43:58 -0700 | [diff] [blame] | 56 | #ifdef __KERNEL__ |
| 57 | |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 58 | #include <linux/bitops.h> |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 59 | #include <linux/device.h> |
| 60 | #include <linux/cdev.h> |
Andrey Panin | 4bfdf37 | 2005-07-27 11:43:58 -0700 | [diff] [blame] | 61 | |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 62 | struct watchdog_ops; |
| 63 | struct watchdog_device; |
| 64 | |
| 65 | /** struct watchdog_ops - The watchdog-devices operations |
| 66 | * |
| 67 | * @owner: The module owner. |
| 68 | * @start: The routine for starting the watchdog device. |
| 69 | * @stop: The routine for stopping the watchdog device. |
| 70 | * @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] | 71 | * @status: The routine that shows the status of the watchdog device. |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 72 | * @set_timeout:The routine for setting the watchdog devices timeout value. |
Viresh Kumar | fd7b673 | 2012-03-16 09:14:00 +0100 | [diff] [blame] | 73 | * @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] | 74 | * @ref: The ref operation for dyn. allocated watchdog_device structs |
| 75 | * @unref: The unref operation for dyn. allocated watchdog_device structs |
Wim Van Sebroeck | 78d88fc | 2011-07-22 18:59:49 +0000 | [diff] [blame] | 76 | * @ioctl: The routines that handles extra ioctl calls. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 77 | * |
| 78 | * The watchdog_ops structure contains a list of low-level operations |
| 79 | * that control a watchdog device. It also contains the module that owns |
| 80 | * these operations. The start and stop function are mandatory, all other |
| 81 | * functions are optonal. |
| 82 | */ |
| 83 | struct watchdog_ops { |
| 84 | struct module *owner; |
| 85 | /* mandatory operations */ |
| 86 | int (*start)(struct watchdog_device *); |
| 87 | int (*stop)(struct watchdog_device *); |
| 88 | /* optional operations */ |
| 89 | int (*ping)(struct watchdog_device *); |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 90 | unsigned int (*status)(struct watchdog_device *); |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 91 | int (*set_timeout)(struct watchdog_device *, unsigned int); |
Viresh Kumar | fd7b673 | 2012-03-16 09:14:00 +0100 | [diff] [blame] | 92 | unsigned int (*get_timeleft)(struct watchdog_device *); |
Hans de Goede | e907df3 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 93 | void (*ref)(struct watchdog_device *); |
| 94 | void (*unref)(struct watchdog_device *); |
Wim Van Sebroeck | 78d88fc | 2011-07-22 18:59:49 +0000 | [diff] [blame] | 95 | long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long); |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 96 | }; |
| 97 | |
| 98 | /** struct watchdog_device - The structure that defines a watchdog device |
| 99 | * |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 100 | * @id: The watchdog's ID. (Allocated by watchdog_register_device) |
| 101 | * @cdev: The watchdog's Character device. |
Alan Cox | d6b469d | 2012-05-11 12:00:20 +0200 | [diff] [blame] | 102 | * @dev: The device for our watchdog |
| 103 | * @parent: The parent bus device |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 104 | * @info: Pointer to a watchdog_info structure. |
| 105 | * @ops: Pointer to the list of watchdog operations. |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 106 | * @bootstatus: Status of the watchdog device at boot. |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 107 | * @timeout: The watchdog devices timeout value. |
Wim Van Sebroeck | 3f43f68 | 2011-07-22 19:00:16 +0000 | [diff] [blame] | 108 | * @min_timeout:The watchdog devices minimum timeout value. |
| 109 | * @max_timeout:The watchdog devices maximum timeout value. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 110 | * @driver-data:Pointer to the drivers private data. |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 111 | * @lock: Lock for watchdog core internal use only. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 112 | * @status: Field that contains the devices internal status bits. |
| 113 | * |
| 114 | * The watchdog_device structure contains all information about a |
| 115 | * watchdog timer device. |
| 116 | * |
| 117 | * The driver-data field may not be accessed directly. It must be accessed |
| 118 | * via the watchdog_set_drvdata and watchdog_get_drvdata helpers. |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 119 | * |
| 120 | * The lock field is for watchdog core internal use only and should not be |
| 121 | * touched. |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 122 | */ |
| 123 | struct watchdog_device { |
Alan Cox | 45f5fed | 2012-05-10 21:48:59 +0200 | [diff] [blame] | 124 | int id; |
| 125 | struct cdev cdev; |
Alan Cox | d6b469d | 2012-05-11 12:00:20 +0200 | [diff] [blame] | 126 | struct device *dev; |
| 127 | struct device *parent; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 128 | const struct watchdog_info *info; |
| 129 | const struct watchdog_ops *ops; |
Wim Van Sebroeck | 2fa0356 | 2011-07-22 18:56:38 +0000 | [diff] [blame] | 130 | unsigned int bootstatus; |
Wim Van Sebroeck | 014d694 | 2011-07-22 18:58:21 +0000 | [diff] [blame] | 131 | unsigned int timeout; |
Wim Van Sebroeck | 3f43f68 | 2011-07-22 19:00:16 +0000 | [diff] [blame] | 132 | unsigned int min_timeout; |
| 133 | unsigned int max_timeout; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 134 | void *driver_data; |
Hans de Goede | f4e9c82 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 135 | struct mutex lock; |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 136 | unsigned long status; |
| 137 | /* Bit numbers for status flags */ |
Wim Van Sebroeck | 234445b | 2011-07-22 18:57:55 +0000 | [diff] [blame] | 138 | #define WDOG_ACTIVE 0 /* Is the watchdog running/active */ |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 139 | #define WDOG_DEV_OPEN 1 /* Opened via /dev/watchdog ? */ |
Wim Van Sebroeck | 017cf08 | 2011-07-22 18:58:54 +0000 | [diff] [blame] | 140 | #define WDOG_ALLOW_RELEASE 2 /* Did we receive the magic char ? */ |
Wim Van Sebroeck | 7e192b9 | 2011-07-22 18:59:17 +0000 | [diff] [blame] | 141 | #define WDOG_NO_WAY_OUT 3 /* Is 'nowayout' feature set ? */ |
Hans de Goede | e907df3 | 2012-05-22 11:40:26 +0200 | [diff] [blame] | 142 | #define WDOG_UNREGISTERED 4 /* Has the device been unregistered */ |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 143 | }; |
| 144 | |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 145 | #ifdef CONFIG_WATCHDOG_NOWAYOUT |
| 146 | #define WATCHDOG_NOWAYOUT 1 |
| 147 | #define WATCHDOG_NOWAYOUT_INIT_STATUS (1 << WDOG_NO_WAY_OUT) |
| 148 | #else |
| 149 | #define WATCHDOG_NOWAYOUT 0 |
| 150 | #define WATCHDOG_NOWAYOUT_INIT_STATUS 0 |
| 151 | #endif |
| 152 | |
Viresh Kumar | 257f8c4 | 2012-03-12 09:51:56 +0530 | [diff] [blame] | 153 | /* Use the following function to check wether or not the watchdog is active */ |
| 154 | static inline bool watchdog_active(struct watchdog_device *wdd) |
| 155 | { |
| 156 | return test_bit(WDOG_ACTIVE, &wdd->status); |
| 157 | } |
| 158 | |
Wim Van Sebroeck | ff0b3cd | 2011-11-29 16:24:16 +0100 | [diff] [blame] | 159 | /* Use the following function to set the nowayout feature */ |
Wim Van Sebroeck | 86a1e18 | 2012-03-05 16:51:11 +0100 | [diff] [blame] | 160 | 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] | 161 | { |
| 162 | if (nowayout) |
| 163 | set_bit(WDOG_NO_WAY_OUT, &wdd->status); |
| 164 | } |
| 165 | |
Wim Van Sebroeck | 4331604 | 2011-07-22 18:55:18 +0000 | [diff] [blame] | 166 | /* Use the following functions to manipulate watchdog driver specific data */ |
| 167 | static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data) |
| 168 | { |
| 169 | wdd->driver_data = data; |
| 170 | } |
| 171 | |
| 172 | static inline void *watchdog_get_drvdata(struct watchdog_device *wdd) |
| 173 | { |
| 174 | return wdd->driver_data; |
| 175 | } |
| 176 | |
| 177 | /* drivers/watchdog/core/watchdog_core.c */ |
| 178 | extern int watchdog_register_device(struct watchdog_device *); |
| 179 | extern void watchdog_unregister_device(struct watchdog_device *); |
| 180 | |
Andrey Panin | 4bfdf37 | 2005-07-27 11:43:58 -0700 | [diff] [blame] | 181 | #endif /* __KERNEL__ */ |
| 182 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | #endif /* ifndef _LINUX_WATCHDOG_H */ |