~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/watchdog.h

Version: ~ [ linux-5.15-rc3 ] ~ [ linux-5.14.8 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.69 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.149 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.208 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.248 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.284 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.285 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  *      Generic watchdog defines. Derived from..
  3  *
  4  * Berkshire PC Watchdog Defines
  5  * by Ken Hollis <khollis@bitgate.com>
  6  *
  7  */
  8 #ifndef _LINUX_WATCHDOG_H
  9 #define _LINUX_WATCHDOG_H
 10 
 11 
 12 #include <linux/bitops.h>
 13 #include <linux/device.h>
 14 #include <linux/cdev.h>
 15 #include <uapi/linux/watchdog.h>
 16 
 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.
 26  * @status:     The routine that shows the status of the watchdog device.
 27  * @set_timeout:The routine for setting the watchdog devices timeout value.
 28  * @get_timeleft:The routine that get's the time that's left before a reset.
 29  * @ref:        The ref operation for dyn. allocated watchdog_device structs
 30  * @unref:      The unref operation for dyn. allocated watchdog_device structs
 31  * @ioctl:      The routines that handles extra ioctl calls.
 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 *);
 45         unsigned int (*status)(struct watchdog_device *);
 46         int (*set_timeout)(struct watchdog_device *, unsigned int);
 47         unsigned int (*get_timeleft)(struct watchdog_device *);
 48         void (*ref)(struct watchdog_device *);
 49         void (*unref)(struct watchdog_device *);
 50         long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
 51 };
 52 
 53 /** struct watchdog_device - The structure that defines a watchdog device
 54  *
 55  * @id:         The watchdog's ID. (Allocated by watchdog_register_device)
 56  * @cdev:       The watchdog's Character device.
 57  * @dev:        The device for our watchdog
 58  * @parent:     The parent bus device
 59  * @info:       Pointer to a watchdog_info structure.
 60  * @ops:        Pointer to the list of watchdog operations.
 61  * @bootstatus: Status of the watchdog device at boot.
 62  * @timeout:    The watchdog devices timeout value.
 63  * @min_timeout:The watchdog devices minimum timeout value.
 64  * @max_timeout:The watchdog devices maximum timeout value.
 65  * @driver-data:Pointer to the drivers private data.
 66  * @lock:       Lock for watchdog core internal use only.
 67  * @status:     Field that contains the devices internal status bits.
 68  * @deferred: entry in wtd_deferred_reg_list which is used to
 69  *                         register early initialized watchdogs.
 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.
 76  *
 77  * The lock field is for watchdog core internal use only and should not be
 78  * touched.
 79  */
 80 struct watchdog_device {
 81         int id;
 82         struct cdev cdev;
 83         struct device *dev;
 84         struct device *parent;
 85         const struct watchdog_info *info;
 86         const struct watchdog_ops *ops;
 87         unsigned int bootstatus;
 88         unsigned int timeout;
 89         unsigned int min_timeout;
 90         unsigned int max_timeout;
 91         void *driver_data;
 92         struct mutex lock;
 93         unsigned long status;
 94 /* Bit numbers for status flags */
 95 #define WDOG_ACTIVE             0       /* Is the watchdog running/active */
 96 #define WDOG_DEV_OPEN           1       /* Opened via /dev/watchdog ? */
 97 #define WDOG_ALLOW_RELEASE      2       /* Did we receive the magic char ? */
 98 #define WDOG_NO_WAY_OUT         3       /* Is 'nowayout' feature set ? */
 99 #define WDOG_UNREGISTERED       4       /* Has the device been unregistered */
100         struct list_head deferred;
101 };
102 
103 #define WATCHDOG_NOWAYOUT               IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT)
104 #define WATCHDOG_NOWAYOUT_INIT_STATUS   (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)
105 
106 /* Use the following function to check whether or not the watchdog is active */
107 static inline bool watchdog_active(struct watchdog_device *wdd)
108 {
109         return test_bit(WDOG_ACTIVE, &wdd->status);
110 }
111 
112 /* Use the following function to set the nowayout feature */
113 static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout)
114 {
115         if (nowayout)
116                 set_bit(WDOG_NO_WAY_OUT, &wdd->status);
117 }
118 
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 
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 
137 /* drivers/watchdog/watchdog_core.c */
138 extern int watchdog_init_timeout(struct watchdog_device *wdd,
139                                   unsigned int timeout_parm, struct device *dev);
140 extern int watchdog_register_device(struct watchdog_device *);
141 extern void watchdog_unregister_device(struct watchdog_device *);
142 
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 
151 #endif  /* ifndef _LINUX_WATCHDOG_H */
152 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp