2005-04-16 22:20:36 +00:00
|
|
|
/*
|
|
|
|
|
* Generic watchdog defines. Derived from..
|
|
|
|
|
*
|
|
|
|
|
* Berkshire PC Watchdog Defines
|
|
|
|
|
* by Ken Hollis <khollis@bitgate.com>
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
#ifndef _LINUX_WATCHDOG_H
|
|
|
|
|
#define _LINUX_WATCHDOG_H
|
|
|
|
|
|
2005-07-27 18:43:58 +00:00
|
|
|
|
2011-11-29 15:24:16 +00:00
|
|
|
#include <linux/bitops.h>
|
2012-05-10 19:48:59 +00:00
|
|
|
#include <linux/cdev.h>
|
2016-02-28 21:12:15 +00:00
|
|
|
#include <linux/device.h>
|
|
|
|
|
#include <linux/kernel.h>
|
2015-11-16 17:27:59 +00:00
|
|
|
#include <linux/notifier.h>
|
2012-10-13 09:46:48 +00:00
|
|
|
#include <uapi/linux/watchdog.h>
|
2005-07-27 18:43:58 +00:00
|
|
|
|
2011-07-22 18:55:18 +00:00
|
|
|
struct watchdog_ops;
|
|
|
|
|
struct watchdog_device;
|
watchdog: Separate and maintain variables based on variable lifetime
All variables required by the watchdog core to manage a watchdog are
currently stored in struct watchdog_device. The lifetime of those
variables is determined by the watchdog driver. However, the lifetime
of variables used by the watchdog core differs from the lifetime of
struct watchdog_device. To remedy this situation, watchdog drivers
can implement ref and unref callbacks, to be used by the watchdog
core to lock struct watchdog_device in memory.
While this solves the immediate problem, it depends on watchdog drivers
to actually implement the ref/unref callbacks. This is error prone,
often not implemented in the first place, or not implemented correctly.
To solve the problem without requiring driver support, split the variables
in struct watchdog_device into two data structures - one for variables
associated with the watchdog driver, one for variables associated with
the watchdog core. With this approach, the watchdog core can keep track
of its variable lifetime and no longer depends on ref/unref callbacks
in the driver. As a side effect, some of the variables originally in
struct watchdog_driver are now private to the watchdog core and no longer
visible in watchdog drivers.
As a side effect of the changes made, an ioctl will now always fail
with -ENODEV after a watchdog device was unregistered with the character
device still open. Previously, it would only fail with -ENODEV in some
situations. Also, ioctl operations are now atomic from driver perspective.
With this change, it is now guaranteed that the driver will not unregister
a watchdog between a timeout change and the subsequent ping.
The 'ref' and 'unref' callbacks in struct watchdog_driver are no longer
used and marked as deprecated.
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@iguana.be>
2015-12-26 00:01:42 +00:00
|
|
|
struct watchdog_core_data;
|
2011-07-22 18:55:18 +00:00
|
|
|
|
|
|
|
|
/** 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.
|
2011-07-22 18:56:38 +00:00
|
|
|
* @status: The routine that shows the status of the watchdog device.
|
2015-11-03 08:00:16 +00:00
|
|
|
* @set_timeout:The routine for setting the watchdog devices timeout value (in seconds).
|
|
|
|
|
* @get_timeleft:The routine that gets the time left before a reset (in seconds).
|
2015-11-16 17:27:59 +00:00
|
|
|
* @restart: The routine for restarting the machine.
|
2011-07-22 18:59:49 +00:00
|
|
|
* @ioctl: The routines that handles extra ioctl calls.
|
2011-07-22 18:55:18 +00:00
|
|
|
*
|
|
|
|
|
* 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
|
2015-11-03 08:00:15 +00:00
|
|
|
* functions are optional.
|
2011-07-22 18:55:18 +00:00
|
|
|
*/
|
|
|
|
|
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 *);
|
2011-07-22 18:56:38 +00:00
|
|
|
unsigned int (*status)(struct watchdog_device *);
|
2011-07-22 18:58:21 +00:00
|
|
|
int (*set_timeout)(struct watchdog_device *, unsigned int);
|
2012-03-16 08:14:00 +00:00
|
|
|
unsigned int (*get_timeleft)(struct watchdog_device *);
|
2016-02-27 01:32:49 +00:00
|
|
|
int (*restart)(struct watchdog_device *, unsigned long, void *);
|
2011-07-22 18:59:49 +00:00
|
|
|
long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
|
2011-07-22 18:55:18 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** struct watchdog_device - The structure that defines a watchdog device
|
|
|
|
|
*
|
2012-05-10 19:48:59 +00:00
|
|
|
* @id: The watchdog's ID. (Allocated by watchdog_register_device)
|
2012-05-11 10:00:20 +00:00
|
|
|
* @parent: The parent bus device
|
2016-01-03 23:11:56 +00:00
|
|
|
* @groups: List of sysfs attribute groups to create when creating the
|
|
|
|
|
* watchdog device.
|
2011-07-22 18:55:18 +00:00
|
|
|
* @info: Pointer to a watchdog_info structure.
|
|
|
|
|
* @ops: Pointer to the list of watchdog operations.
|
2011-07-22 18:56:38 +00:00
|
|
|
* @bootstatus: Status of the watchdog device at boot.
|
2015-11-03 08:00:16 +00:00
|
|
|
* @timeout: The watchdog devices timeout value (in seconds).
|
|
|
|
|
* @min_timeout:The watchdog devices minimum timeout value (in seconds).
|
2016-02-28 21:12:15 +00:00
|
|
|
* @max_timeout:The watchdog devices maximum timeout value (in seconds)
|
|
|
|
|
* as configurable from user space. Only relevant if
|
|
|
|
|
* max_hw_heartbeat_ms is not provided.
|
2016-02-28 21:12:18 +00:00
|
|
|
* @min_hw_heartbeat_ms:
|
2016-05-27 21:19:06 +00:00
|
|
|
* Hardware limit for minimum time between heartbeats,
|
|
|
|
|
* in milli-seconds.
|
2016-02-28 21:12:15 +00:00
|
|
|
* @max_hw_heartbeat_ms:
|
|
|
|
|
* Hardware limit for maximum timeout, in milli-seconds.
|
|
|
|
|
* Replaces max_timeout if specified.
|
2015-11-20 21:54:51 +00:00
|
|
|
* @reboot_nb: The notifier block to stop watchdog on reboot.
|
2015-11-16 17:27:59 +00:00
|
|
|
* @restart_nb: The notifier block to register a restart function.
|
watchdog: Separate and maintain variables based on variable lifetime
All variables required by the watchdog core to manage a watchdog are
currently stored in struct watchdog_device. The lifetime of those
variables is determined by the watchdog driver. However, the lifetime
of variables used by the watchdog core differs from the lifetime of
struct watchdog_device. To remedy this situation, watchdog drivers
can implement ref and unref callbacks, to be used by the watchdog
core to lock struct watchdog_device in memory.
While this solves the immediate problem, it depends on watchdog drivers
to actually implement the ref/unref callbacks. This is error prone,
often not implemented in the first place, or not implemented correctly.
To solve the problem without requiring driver support, split the variables
in struct watchdog_device into two data structures - one for variables
associated with the watchdog driver, one for variables associated with
the watchdog core. With this approach, the watchdog core can keep track
of its variable lifetime and no longer depends on ref/unref callbacks
in the driver. As a side effect, some of the variables originally in
struct watchdog_driver are now private to the watchdog core and no longer
visible in watchdog drivers.
As a side effect of the changes made, an ioctl will now always fail
with -ENODEV after a watchdog device was unregistered with the character
device still open. Previously, it would only fail with -ENODEV in some
situations. Also, ioctl operations are now atomic from driver perspective.
With this change, it is now guaranteed that the driver will not unregister
a watchdog between a timeout change and the subsequent ping.
The 'ref' and 'unref' callbacks in struct watchdog_driver are no longer
used and marked as deprecated.
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@iguana.be>
2015-12-26 00:01:42 +00:00
|
|
|
* @driver_data:Pointer to the drivers private data.
|
|
|
|
|
* @wd_data: Pointer to watchdog core internal data.
|
2011-07-22 18:55:18 +00:00
|
|
|
* @status: Field that contains the devices internal status bits.
|
2016-02-28 21:12:15 +00:00
|
|
|
* @deferred: Entry in wtd_deferred_reg_list which is used to
|
|
|
|
|
* register early initialized watchdogs.
|
2011-07-22 18:55:18 +00:00
|
|
|
*
|
|
|
|
|
* 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.
|
2012-05-22 09:40:26 +00:00
|
|
|
*
|
|
|
|
|
* The lock field is for watchdog core internal use only and should not be
|
|
|
|
|
* touched.
|
2011-07-22 18:55:18 +00:00
|
|
|
*/
|
|
|
|
|
struct watchdog_device {
|
2012-05-10 19:48:59 +00:00
|
|
|
int id;
|
2012-05-11 10:00:20 +00:00
|
|
|
struct device *parent;
|
2016-01-03 23:11:56 +00:00
|
|
|
const struct attribute_group **groups;
|
2011-07-22 18:55:18 +00:00
|
|
|
const struct watchdog_info *info;
|
|
|
|
|
const struct watchdog_ops *ops;
|
2011-07-22 18:56:38 +00:00
|
|
|
unsigned int bootstatus;
|
2011-07-22 18:58:21 +00:00
|
|
|
unsigned int timeout;
|
2011-07-22 19:00:16 +00:00
|
|
|
unsigned int min_timeout;
|
|
|
|
|
unsigned int max_timeout;
|
2016-02-28 21:12:18 +00:00
|
|
|
unsigned int min_hw_heartbeat_ms;
|
2016-02-28 21:12:15 +00:00
|
|
|
unsigned int max_hw_heartbeat_ms;
|
2015-11-20 21:54:51 +00:00
|
|
|
struct notifier_block reboot_nb;
|
2015-11-16 17:27:59 +00:00
|
|
|
struct notifier_block restart_nb;
|
2011-07-22 18:55:18 +00:00
|
|
|
void *driver_data;
|
watchdog: Separate and maintain variables based on variable lifetime
All variables required by the watchdog core to manage a watchdog are
currently stored in struct watchdog_device. The lifetime of those
variables is determined by the watchdog driver. However, the lifetime
of variables used by the watchdog core differs from the lifetime of
struct watchdog_device. To remedy this situation, watchdog drivers
can implement ref and unref callbacks, to be used by the watchdog
core to lock struct watchdog_device in memory.
While this solves the immediate problem, it depends on watchdog drivers
to actually implement the ref/unref callbacks. This is error prone,
often not implemented in the first place, or not implemented correctly.
To solve the problem without requiring driver support, split the variables
in struct watchdog_device into two data structures - one for variables
associated with the watchdog driver, one for variables associated with
the watchdog core. With this approach, the watchdog core can keep track
of its variable lifetime and no longer depends on ref/unref callbacks
in the driver. As a side effect, some of the variables originally in
struct watchdog_driver are now private to the watchdog core and no longer
visible in watchdog drivers.
As a side effect of the changes made, an ioctl will now always fail
with -ENODEV after a watchdog device was unregistered with the character
device still open. Previously, it would only fail with -ENODEV in some
situations. Also, ioctl operations are now atomic from driver perspective.
With this change, it is now guaranteed that the driver will not unregister
a watchdog between a timeout change and the subsequent ping.
The 'ref' and 'unref' callbacks in struct watchdog_driver are no longer
used and marked as deprecated.
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@iguana.be>
2015-12-26 00:01:42 +00:00
|
|
|
struct watchdog_core_data *wd_data;
|
2011-07-22 18:55:18 +00:00
|
|
|
unsigned long status;
|
|
|
|
|
/* Bit numbers for status flags */
|
2011-07-22 18:57:55 +00:00
|
|
|
#define WDOG_ACTIVE 0 /* Is the watchdog running/active */
|
watchdog: Separate and maintain variables based on variable lifetime
All variables required by the watchdog core to manage a watchdog are
currently stored in struct watchdog_device. The lifetime of those
variables is determined by the watchdog driver. However, the lifetime
of variables used by the watchdog core differs from the lifetime of
struct watchdog_device. To remedy this situation, watchdog drivers
can implement ref and unref callbacks, to be used by the watchdog
core to lock struct watchdog_device in memory.
While this solves the immediate problem, it depends on watchdog drivers
to actually implement the ref/unref callbacks. This is error prone,
often not implemented in the first place, or not implemented correctly.
To solve the problem without requiring driver support, split the variables
in struct watchdog_device into two data structures - one for variables
associated with the watchdog driver, one for variables associated with
the watchdog core. With this approach, the watchdog core can keep track
of its variable lifetime and no longer depends on ref/unref callbacks
in the driver. As a side effect, some of the variables originally in
struct watchdog_driver are now private to the watchdog core and no longer
visible in watchdog drivers.
As a side effect of the changes made, an ioctl will now always fail
with -ENODEV after a watchdog device was unregistered with the character
device still open. Previously, it would only fail with -ENODEV in some
situations. Also, ioctl operations are now atomic from driver perspective.
With this change, it is now guaranteed that the driver will not unregister
a watchdog between a timeout change and the subsequent ping.
The 'ref' and 'unref' callbacks in struct watchdog_driver are no longer
used and marked as deprecated.
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@iguana.be>
2015-12-26 00:01:42 +00:00
|
|
|
#define WDOG_NO_WAY_OUT 1 /* Is 'nowayout' feature set ? */
|
|
|
|
|
#define WDOG_STOP_ON_REBOOT 2 /* Should be stopped on reboot */
|
2016-02-28 21:12:16 +00:00
|
|
|
#define WDOG_HW_RUNNING 3 /* True if HW watchdog running */
|
2015-06-09 16:55:02 +00:00
|
|
|
struct list_head deferred;
|
2011-07-22 18:55:18 +00:00
|
|
|
};
|
|
|
|
|
|
2014-09-09 20:18:31 +00:00
|
|
|
#define WATCHDOG_NOWAYOUT IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT)
|
|
|
|
|
#define WATCHDOG_NOWAYOUT_INIT_STATUS (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)
|
2011-11-29 15:24:16 +00:00
|
|
|
|
2012-09-20 01:48:00 +00:00
|
|
|
/* Use the following function to check whether or not the watchdog is active */
|
2012-03-12 04:21:56 +00:00
|
|
|
static inline bool watchdog_active(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
return test_bit(WDOG_ACTIVE, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-28 21:12:16 +00:00
|
|
|
/*
|
|
|
|
|
* Use the following function to check whether or not the hardware watchdog
|
|
|
|
|
* is running
|
|
|
|
|
*/
|
|
|
|
|
static inline bool watchdog_hw_running(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
return test_bit(WDOG_HW_RUNNING, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2011-11-29 15:24:16 +00:00
|
|
|
/* Use the following function to set the nowayout feature */
|
2012-03-05 15:51:11 +00:00
|
|
|
static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout)
|
2011-11-29 15:24:16 +00:00
|
|
|
{
|
|
|
|
|
if (nowayout)
|
|
|
|
|
set_bit(WDOG_NO_WAY_OUT, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2015-11-20 21:54:51 +00:00
|
|
|
/* Use the following function to stop the watchdog on reboot */
|
|
|
|
|
static inline void watchdog_stop_on_reboot(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
set_bit(WDOG_STOP_ON_REBOOT, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2013-01-08 10:04:10 +00:00
|
|
|
/* Use the following function to check if a timeout value is invalid */
|
|
|
|
|
static inline bool watchdog_timeout_invalid(struct watchdog_device *wdd, unsigned int t)
|
|
|
|
|
{
|
2015-09-29 08:27:24 +00:00
|
|
|
/*
|
|
|
|
|
* The timeout is invalid if
|
2016-02-28 21:12:15 +00:00
|
|
|
* - the requested value is larger than UINT_MAX / 1000
|
|
|
|
|
* (since internal calculations are done in milli-seconds),
|
|
|
|
|
* or
|
2015-09-29 08:27:24 +00:00
|
|
|
* - the requested value is smaller than the configured minimum timeout,
|
|
|
|
|
* or
|
2016-02-28 21:12:15 +00:00
|
|
|
* - a maximum hardware timeout is not configured, a maximum timeout
|
|
|
|
|
* is configured, and the requested value is larger than the
|
|
|
|
|
* configured maximum timeout.
|
2015-09-29 08:27:24 +00:00
|
|
|
*/
|
2016-02-28 21:12:15 +00:00
|
|
|
return t > UINT_MAX / 1000 || t < wdd->min_timeout ||
|
|
|
|
|
(!wdd->max_hw_heartbeat_ms && wdd->max_timeout &&
|
|
|
|
|
t > wdd->max_timeout);
|
2013-01-08 10:04:10 +00:00
|
|
|
}
|
|
|
|
|
|
2011-07-22 18:55:18 +00:00
|
|
|
/* 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;
|
|
|
|
|
}
|
|
|
|
|
|
2012-10-05 10:16:09 +00:00
|
|
|
/* drivers/watchdog/watchdog_core.c */
|
2015-11-16 17:27:59 +00:00
|
|
|
void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority);
|
2013-01-08 10:04:10 +00:00
|
|
|
extern int watchdog_init_timeout(struct watchdog_device *wdd,
|
|
|
|
|
unsigned int timeout_parm, struct device *dev);
|
2011-07-22 18:55:18 +00:00
|
|
|
extern int watchdog_register_device(struct watchdog_device *);
|
|
|
|
|
extern void watchdog_unregister_device(struct watchdog_device *);
|
|
|
|
|
|
2016-05-27 15:33:54 +00:00
|
|
|
/* devres register variant */
|
|
|
|
|
int devm_watchdog_register_device(struct device *dev, struct watchdog_device *);
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
#endif /* ifndef _LINUX_WATCHDOG_H */
|