Release 4.7 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/bitops.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/notifier.h>
#include <uapi/linux/watchdog.h>

struct watchdog_ops;
struct watchdog_device;
struct watchdog_core_data;

/** 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 (in seconds).
 * @get_timeleft:The routine that gets the time left before a reset (in seconds).
 * @restart:    The routine for restarting the machine.
 * @ioctl:      The routines that handles extra ioctl calls.
 *
 * 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 optional.
 */

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);
	
unsigned int (*get_timeleft)(struct watchdog_device *);
	
int (*restart)(struct watchdog_device *, unsigned long, void *);
	
long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
};

/** struct watchdog_device - The structure that defines a watchdog device
 *
 * @id:         The watchdog's ID. (Allocated by watchdog_register_device)
 * @parent:     The parent bus device
 * @groups:     List of sysfs attribute groups to create when creating the
 *              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 (in seconds).
 * @min_timeout:The watchdog devices minimum timeout value (in seconds).
 * @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.
 * @min_hw_heartbeat_ms:
 *              Minimum time between heartbeats, in milli-seconds.
 * @max_hw_heartbeat_ms:
 *              Hardware limit for maximum timeout, in milli-seconds.
 *              Replaces max_timeout if specified.
 * @reboot_nb:  The notifier block to stop watchdog on reboot.
 * @restart_nb: The notifier block to register a restart function.
 * @driver_data:Pointer to the drivers private data.
 * @wd_data:    Pointer to watchdog core internal data.
 * @status:     Field that contains the devices internal status bits.
 * @deferred:   Entry in wtd_deferred_reg_list which is used to
 *              register early initialized watchdogs.
 *
 * 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.
 *
 * The lock field is for watchdog core internal use only and should not be
 * touched.
 */

struct watchdog_device {
	
int id;
	
struct device *parent;
	
const struct attribute_group **groups;
	
const struct watchdog_info *info;
	
const struct watchdog_ops *ops;
	
unsigned int bootstatus;
	
unsigned int timeout;
	
unsigned int min_timeout;
	
unsigned int max_timeout;
	
unsigned int min_hw_heartbeat_ms;
	
unsigned int max_hw_heartbeat_ms;
	
struct notifier_block reboot_nb;
	
struct notifier_block restart_nb;
	
void *driver_data;
	
struct watchdog_core_data *wd_data;
	
unsigned long status;
/* Bit numbers for status flags */

#define WDOG_ACTIVE		0	/* Is the watchdog running/active */

#define WDOG_NO_WAY_OUT		1	/* Is 'nowayout' feature set ? */

#define WDOG_STOP_ON_REBOOT	2	/* Should be stopped on reboot */

#define WDOG_HW_RUNNING		3	/* True if HW watchdog running */
	
struct list_head deferred;
};


#define WATCHDOG_NOWAYOUT		IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT)

#define WATCHDOG_NOWAYOUT_INIT_STATUS	(WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)

/* Use the following function to check whether or not the watchdog is active */


static inline bool watchdog_active(struct watchdog_device *wdd)
{
	return test_bit(WDOG_ACTIVE, &wdd->status);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
viresh kumar
viresh kumar
23
100.00%
1
100.00%
Total
23
100.00%
1
100.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);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
guenter roeck
guenter roeck
23
100.00%
1
100.00%
Total
23
100.00%
1
100.00%

/* Use the following function to set the nowayout feature */


static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout)
{
	if (nowayout)
		set_bit(WDOG_NO_WAY_OUT, &wdd->status);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
wim van sebroeck
wim van sebroeck
29
100.00%
2
100.00%
Total
29
100.00%
2
100.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);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
damien riegel
damien riegel
22
100.00%
1
100.00%
Total
22
100.00%
1
100.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)
{
	/*
         * The timeout is invalid if
         * - the requested value is larger than UINT_MAX / 1000
         *   (since internal calculations are done in milli-seconds),
         * or
         * - the requested value is smaller than the configured minimum timeout,
         * or
         * - a maximum hardware timeout is not configured, a maximum timeout
         *   is configured, and the requested value is larger than the
         *   configured maximum timeout.
         */
	return t > UINT_MAX / 1000 || t < wdd->min_timeout ||
		(!wdd->max_hw_heartbeat_ms && wdd->max_timeout &&
		 t > wdd->max_timeout);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
fabio porcedda
fabio porcedda
30
63.83%
1
33.33%
guenter roeck
guenter roeck
17
36.17%
2
66.67%
Total
47
100.00%
3
100.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;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
wim van sebroeck
wim van sebroeck
22
100.00%
1
100.00%
Total
22
100.00%
1
100.00%



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
wim van sebroeck
wim van sebroeck
18
100.00%
1
100.00%
Total
18
100.00%
1
100.00%

/* drivers/watchdog/watchdog_core.c */
void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority);
extern int watchdog_init_timeout(struct watchdog_device *wdd,
				  unsigned int timeout_parm, struct device *dev);
extern int watchdog_register_device(struct watchdog_device *);
extern void watchdog_unregister_device(struct watchdog_device *);

#endif  /* ifndef _LINUX_WATCHDOG_H */
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
wim van sebroeck
wim van sebroeck
242
47.83%
9
28.12%
guenter roeck
guenter roeck
81
16.01%
7
21.88%
damien riegel
damien riegel
61
12.06%
2
6.25%
fabio porcedda
fabio porcedda
51
10.08%
2
6.25%
viresh kumar
viresh kumar
35
6.92%
2
6.25%
alan cox
alan cox
12
2.37%
2
6.25%
pre-git
pre-git
10
1.98%
2
6.25%
jean-baptiste theou
jean-baptiste theou
4
0.79%
1
3.12%
david howells
david howells
3
0.59%
1
3.12%
hans de goede
hans de goede
2
0.40%
1
3.12%
uwe kleine-koenig
uwe kleine-koenig
2
0.40%
1
3.12%
andrey panin
andrey panin
2
0.40%
1
3.12%
adam buchbinder
adam buchbinder
1
0.20%
1
3.12%
Total
506
100.00%
32
100.00%
  
Directory: include/linux

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.