[mirror_ubuntu-bionic-kernel.git] / include / linux / watchdog.h

/*
 *	Generic watchdog defines. Derived from..
 *
 * Berkshire PC Watchdog Defines
 * by Ken Hollis <khollis@bitgate.com>
 *
 */

#ifndef _LINUX_WATCHDOG_H
#define _LINUX_WATCHDOG_H

#include <linux/ioctl.h>
#include <linux/types.h>

#define	WATCHDOG_IOCTL_BASE	'W'

struct watchdog_info {
	__u32 options;		/* Options the card/driver supports */
	__u32 firmware_version;	/* Firmware version of the card */
	__u8  identity[32];	/* Identity of the board */
};

#define	WDIOC_GETSUPPORT	_IOR(WATCHDOG_IOCTL_BASE, 0, struct watchdog_info)
#define	WDIOC_GETSTATUS		_IOR(WATCHDOG_IOCTL_BASE, 1, int)
#define	WDIOC_GETBOOTSTATUS	_IOR(WATCHDOG_IOCTL_BASE, 2, int)
#define	WDIOC_GETTEMP		_IOR(WATCHDOG_IOCTL_BASE, 3, int)
#define	WDIOC_SETOPTIONS	_IOR(WATCHDOG_IOCTL_BASE, 4, int)
#define	WDIOC_KEEPALIVE		_IOR(WATCHDOG_IOCTL_BASE, 5, int)
#define	WDIOC_SETTIMEOUT        _IOWR(WATCHDOG_IOCTL_BASE, 6, int)
#define	WDIOC_GETTIMEOUT        _IOR(WATCHDOG_IOCTL_BASE, 7, int)
#define	WDIOC_SETPRETIMEOUT	_IOWR(WATCHDOG_IOCTL_BASE, 8, int)
#define	WDIOC_GETPRETIMEOUT	_IOR(WATCHDOG_IOCTL_BASE, 9, int)
#define	WDIOC_GETTIMELEFT	_IOR(WATCHDOG_IOCTL_BASE, 10, int)

#define	WDIOF_UNKNOWN		-1	/* Unknown flag error */
#define	WDIOS_UNKNOWN		-1	/* Unknown status error */

#define	WDIOF_OVERHEAT		0x0001	/* Reset due to CPU overheat */
#define	WDIOF_FANFAULT		0x0002	/* Fan failed */
#define	WDIOF_EXTERN1		0x0004	/* External relay 1 */
#define	WDIOF_EXTERN2		0x0008	/* External relay 2 */
#define	WDIOF_POWERUNDER	0x0010	/* Power bad/power fault */
#define	WDIOF_CARDRESET		0x0020	/* Card previously reset the CPU */
#define	WDIOF_POWEROVER		0x0040	/* Power over voltage */
#define	WDIOF_SETTIMEOUT	0x0080  /* Set timeout (in seconds) */
#define	WDIOF_MAGICCLOSE	0x0100	/* Supports magic close char */
#define	WDIOF_PRETIMEOUT	0x0200  /* Pretimeout (in seconds), get/set */
#define	WDIOF_KEEPALIVEPING	0x8000	/* Keep alive ping reply */

#define	WDIOS_DISABLECARD	0x0001	/* Turn off the watchdog timer */
#define	WDIOS_ENABLECARD	0x0002	/* Turn on the watchdog timer */
#define	WDIOS_TEMPPANIC		0x0004	/* Kernel panic on temperature trip */

#ifdef __KERNEL__

#ifdef CONFIG_WATCHDOG_NOWAYOUT
#define WATCHDOG_NOWAYOUT	1
#else
#define WATCHDOG_NOWAYOUT	0
#endif

struct watchdog_ops;
struct watchdog_device;

/** struct watchdog_ops - The watchdog-devices operations
 *
 * @owner:	The module owner.
 * @start:	The routine for starting the watchdog device.
 * @stop:	The routine for stopping the watchdog device.
 * @ping:	The routine that sends a keepalive ping to the watchdog device.
 * @status:	The routine that shows the status of the watchdog device.
 * @set_timeout:The routine for setting the watchdog devices timeout value.
 *
 * The watchdog_ops structure contains a list of low-level operations
 * that control a watchdog device. It also contains the module that owns
 * these operations. The start and stop function are mandatory, all other
 * functions are optonal.
 */
struct watchdog_ops {
	struct module *owner;
	/* mandatory operations */
	int (*start)(struct watchdog_device *);
	int (*stop)(struct watchdog_device *);
	/* optional operations */
	int (*ping)(struct watchdog_device *);
	unsigned int (*status)(struct watchdog_device *);
	int (*set_timeout)(struct watchdog_device *, unsigned int);
};

/** struct watchdog_device - The structure that defines a watchdog device
 *
 * @info:	Pointer to a watchdog_info structure.
 * @ops:	Pointer to the list of watchdog operations.
 * @bootstatus:	Status of the watchdog device at boot.
 * @timeout:	The watchdog devices timeout value.
 * @driver-data:Pointer to the drivers private data.
 * @status:	Field that contains the devices internal status bits.
 *
 * The watchdog_device structure contains all information about a
 * watchdog timer device.
 *
 * The driver-data field may not be accessed directly. It must be accessed
 * via the watchdog_set_drvdata and watchdog_get_drvdata helpers.
 */
struct watchdog_device {
	const struct watchdog_info *info;
	const struct watchdog_ops *ops;
	unsigned int bootstatus;
	unsigned int timeout;
	void *driver_data;
	unsigned long status;
/* Bit numbers for status flags */
#define WDOG_ACTIVE		0	/* Is the watchdog running/active */
#define WDOG_DEV_OPEN		1	/* Opened via /dev/watchdog ? */
#define WDOG_ALLOW_RELEASE	2	/* Did we receive the magic char ? */
#define WDOG_NO_WAY_OUT		3	/* Is 'nowayout' feature set ? */
};

/* Use the following functions to manipulate watchdog driver specific data */
static inline void watchdog_set_drvdata(struct watchdog_device *wdd, void *data)
{
	wdd->driver_data = data;
}

static inline void *watchdog_get_drvdata(struct watchdog_device *wdd)
{
	return wdd->driver_data;
}

/* drivers/watchdog/core/watchdog_core.c */
extern int watchdog_register_device(struct watchdog_device *);
extern void watchdog_unregister_device(struct watchdog_device *);

#endif	/* __KERNEL__ */

#endif  /* ifndef _LINUX_WATCHDOG_H */
Commit	Line	Data
1da177e4 LT	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)
e05b59fe CM	31	#define WDIOC_SETPRETIMEOUT _IOWR(WATCHDOG_IOCTL_BASE, 8, int)
e05b59fe CM	32	#define WDIOC_GETPRETIMEOUT _IOR(WATCHDOG_IOCTL_BASE, 9, int)
58b519f3	33	#define WDIOC_GETTIMELEFT _IOR(WATCHDOG_IOCTL_BASE, 10, int)
1da177e4 LT	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 */
58b519f3 WVS	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 */
e05b59fe	47	#define WDIOF_PRETIMEOUT 0x0200 /* Pretimeout (in seconds), get/set */
1da177e4 LT	48	#define WDIOF_KEEPALIVEPING 0x8000 /* Keep alive ping reply */
	49
	50	#define WDIOS_DISABLECARD 0x0001 /* Turn off the watchdog timer */
	51	#define WDIOS_ENABLECARD 0x0002 /* Turn on the watchdog timer */
	52	#define WDIOS_TEMPPANIC 0x0004 /* Kernel panic on temperature trip */
	53
4bfdf378 AP	54	#ifdef __KERNEL__
	55
	56	#ifdef CONFIG_WATCHDOG_NOWAYOUT
	57	#define WATCHDOG_NOWAYOUT 1
	58	#else
	59	#define WATCHDOG_NOWAYOUT 0
	60	#endif
	61
43316044 WVS	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.
2fa03560	71	* @status: The routine that shows the status of the watchdog device.
014d694e	72	* @set_timeout:The routine for setting the watchdog devices timeout value.
43316044 WVS	73	*
	74	* The watchdog_ops structure contains a list of low-level operations
	75	* that control a watchdog device. It also contains the module that owns
	76	* these operations. The start and stop function are mandatory, all other
	77	* functions are optonal.
	78	*/
	79	struct watchdog_ops {
	80	struct module *owner;
	81	/* mandatory operations */
	82	int (start)(struct watchdog_device );
	83	int (stop)(struct watchdog_device );
	84	/* optional operations */
	85	int (ping)(struct watchdog_device );
2fa03560	86	unsigned int (status)(struct watchdog_device );
014d694e	87	int (set_timeout)(struct watchdog_device , unsigned int);
43316044 WVS	88	};
	89
	90	/** struct watchdog_device - The structure that defines a watchdog device
	91	*
	92	* @info: Pointer to a watchdog_info structure.
	93	* @ops: Pointer to the list of watchdog operations.
2fa03560	94	* @bootstatus: Status of the watchdog device at boot.
014d694e	95	* @timeout: The watchdog devices timeout value.
43316044 WVS	96	* @driver-data:Pointer to the drivers private data.
	97	* @status: Field that contains the devices internal status bits.
	98	*
	99	* The watchdog_device structure contains all information about a
	100	* watchdog timer device.
	101	*
	102	* The driver-data field may not be accessed directly. It must be accessed
	103	* via the watchdog_set_drvdata and watchdog_get_drvdata helpers.
	104	*/
	105	struct watchdog_device {
	106	const struct watchdog_info *info;
	107	const struct watchdog_ops *ops;
2fa03560	108	unsigned int bootstatus;
014d694e	109	unsigned int timeout;
43316044 WVS	110	void *driver_data;
	111	unsigned long status;
	112	/* Bit numbers for status flags */
234445b4	113	#define WDOG_ACTIVE 0 /* Is the watchdog running/active */
43316044	114	#define WDOG_DEV_OPEN 1 /* Opened via /dev/watchdog ? */
017cf080	115	#define WDOG_ALLOW_RELEASE 2 /* Did we receive the magic char ? */
7e192b9c	116	#define WDOG_NO_WAY_OUT 3 /* Is 'nowayout' feature set ? */
43316044 WVS	117	};
	118
	119	/* Use the following functions to manipulate watchdog driver specific data */
	120	static inline void watchdog_set_drvdata(struct watchdog_device wdd, void data)
	121	{
	122	wdd->driver_data = data;
	123	}
	124
	125	static inline void watchdog_get_drvdata(struct watchdog_device wdd)
	126	{
	127	return wdd->driver_data;
	128	}
	129
	130	/* drivers/watchdog/core/watchdog_core.c */
	131	extern int watchdog_register_device(struct watchdog_device *);
	132	extern void watchdog_unregister_device(struct watchdog_device *);
	133
4bfdf378 AP	134	#endif /* __KERNEL__ */
4bfdf378 AP	135
1da177e4	136	#endif /* ifndef _LINUX_WATCHDOG_H */