License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2005-04-17 06:20:36 +08: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-28 02:43:58 +08:00
|
|
|
|
2011-11-29 23:24:16 +08:00
|
|
|
#include <linux/bitops.h>
|
2012-05-11 03:48:59 +08:00
|
|
|
#include <linux/cdev.h>
|
2016-02-29 05:12:15 +08:00
|
|
|
#include <linux/device.h>
|
|
|
|
|
#include <linux/kernel.h>
|
2015-11-17 01:27:59 +08:00
|
|
|
#include <linux/notifier.h>
|
2012-10-13 17:46:48 +08:00
|
|
|
#include <uapi/linux/watchdog.h>
|
2005-07-28 02:43:58 +08:00
|
|
|
|
2011-07-23 02:55:18 +08: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 08:01:42 +08:00
|
|
|
struct watchdog_core_data;
|
2016-10-07 20:39:54 +08:00
|
|
|
struct watchdog_governor;
|
2011-07-23 02:55:18 +08: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-23 02:56:38 +08:00
|
|
|
* @status: The routine that shows the status of the watchdog device.
|
2015-11-03 16:00:16 +08:00
|
|
|
* @set_timeout:The routine for setting the watchdog devices timeout value (in seconds).
|
2016-08-31 19:52:41 +08:00
|
|
|
* @set_pretimeout:The routine for setting the watchdog devices pretimeout.
|
2015-11-03 16:00:16 +08:00
|
|
|
* @get_timeleft:The routine that gets the time left before a reset (in seconds).
|
2015-11-17 01:27:59 +08:00
|
|
|
* @restart: The routine for restarting the machine.
|
2011-07-23 02:59:49 +08:00
|
|
|
* @ioctl: The routines that handles extra ioctl calls.
|
2011-07-23 02:55:18 +08:00
|
|
|
*
|
|
|
|
|
* The watchdog_ops structure contains a list of low-level operations
|
|
|
|
|
* that control a watchdog device. It also contains the module that owns
|
2020-04-03 11:15:07 +08:00
|
|
|
* these operations. The start function is mandatory, all other
|
2015-11-03 16:00:15 +08:00
|
|
|
* functions are optional.
|
2011-07-23 02:55:18 +08:00
|
|
|
*/
|
|
|
|
|
struct watchdog_ops {
|
|
|
|
|
struct module *owner;
|
|
|
|
|
/* mandatory operations */
|
|
|
|
|
int (*start)(struct watchdog_device *);
|
|
|
|
|
/* optional operations */
|
2020-04-03 11:15:07 +08:00
|
|
|
int (*stop)(struct watchdog_device *);
|
2011-07-23 02:55:18 +08:00
|
|
|
int (*ping)(struct watchdog_device *);
|
2011-07-23 02:56:38 +08:00
|
|
|
unsigned int (*status)(struct watchdog_device *);
|
2011-07-23 02:58:21 +08:00
|
|
|
int (*set_timeout)(struct watchdog_device *, unsigned int);
|
2016-08-31 19:52:41 +08:00
|
|
|
int (*set_pretimeout)(struct watchdog_device *, unsigned int);
|
2012-03-16 16:14:00 +08:00
|
|
|
unsigned int (*get_timeleft)(struct watchdog_device *);
|
2016-02-27 09:32:49 +08:00
|
|
|
int (*restart)(struct watchdog_device *, unsigned long, void *);
|
2011-07-23 02:59:49 +08:00
|
|
|
long (*ioctl)(struct watchdog_device *, unsigned int, unsigned long);
|
2011-07-23 02:55:18 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** struct watchdog_device - The structure that defines a watchdog device
|
|
|
|
|
*
|
2012-05-11 03:48:59 +08:00
|
|
|
* @id: The watchdog's ID. (Allocated by watchdog_register_device)
|
2012-05-11 18:00:20 +08:00
|
|
|
* @parent: The parent bus device
|
2016-01-04 07:11:56 +08:00
|
|
|
* @groups: List of sysfs attribute groups to create when creating the
|
|
|
|
|
* watchdog device.
|
2011-07-23 02:55:18 +08:00
|
|
|
* @info: Pointer to a watchdog_info structure.
|
|
|
|
|
* @ops: Pointer to the list of watchdog operations.
|
2016-10-07 20:39:54 +08:00
|
|
|
* @gov: Pointer to watchdog pretimeout governor.
|
2011-07-23 02:56:38 +08:00
|
|
|
* @bootstatus: Status of the watchdog device at boot.
|
2015-11-03 16:00:16 +08:00
|
|
|
* @timeout: The watchdog devices timeout value (in seconds).
|
2016-08-31 19:52:41 +08:00
|
|
|
* @pretimeout: The watchdog devices pre_timeout value.
|
2015-11-03 16:00:16 +08:00
|
|
|
* @min_timeout:The watchdog devices minimum timeout value (in seconds).
|
2016-02-29 05:12:15 +08: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-29 05:12:18 +08:00
|
|
|
* @min_hw_heartbeat_ms:
|
2016-05-28 05:19:06 +08:00
|
|
|
* Hardware limit for minimum time between heartbeats,
|
|
|
|
|
* in milli-seconds.
|
2016-02-29 05:12:15 +08:00
|
|
|
* @max_hw_heartbeat_ms:
|
|
|
|
|
* Hardware limit for maximum timeout, in milli-seconds.
|
|
|
|
|
* Replaces max_timeout if specified.
|
2015-11-21 05:54:51 +08:00
|
|
|
* @reboot_nb: The notifier block to stop watchdog on reboot.
|
2015-11-17 01:27:59 +08: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 08:01:42 +08:00
|
|
|
* @driver_data:Pointer to the drivers private data.
|
|
|
|
|
* @wd_data: Pointer to watchdog core internal data.
|
2011-07-23 02:55:18 +08:00
|
|
|
* @status: Field that contains the devices internal status bits.
|
2016-02-29 05:12:15 +08:00
|
|
|
* @deferred: Entry in wtd_deferred_reg_list which is used to
|
|
|
|
|
* register early initialized watchdogs.
|
2011-07-23 02:55:18 +08: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.
|
|
|
|
|
*/
|
|
|
|
|
struct watchdog_device {
|
2012-05-11 03:48:59 +08:00
|
|
|
int id;
|
2012-05-11 18:00:20 +08:00
|
|
|
struct device *parent;
|
2016-01-04 07:11:56 +08:00
|
|
|
const struct attribute_group **groups;
|
2011-07-23 02:55:18 +08:00
|
|
|
const struct watchdog_info *info;
|
|
|
|
|
const struct watchdog_ops *ops;
|
2016-10-07 20:39:54 +08:00
|
|
|
const struct watchdog_governor *gov;
|
2011-07-23 02:56:38 +08:00
|
|
|
unsigned int bootstatus;
|
2011-07-23 02:58:21 +08:00
|
|
|
unsigned int timeout;
|
2016-08-31 19:52:41 +08:00
|
|
|
unsigned int pretimeout;
|
2011-07-23 03:00:16 +08:00
|
|
|
unsigned int min_timeout;
|
|
|
|
|
unsigned int max_timeout;
|
2016-02-29 05:12:18 +08:00
|
|
|
unsigned int min_hw_heartbeat_ms;
|
2016-02-29 05:12:15 +08:00
|
|
|
unsigned int max_hw_heartbeat_ms;
|
2015-11-21 05:54:51 +08:00
|
|
|
struct notifier_block reboot_nb;
|
2015-11-17 01:27:59 +08:00
|
|
|
struct notifier_block restart_nb;
|
2011-07-23 02:55:18 +08: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 08:01:42 +08:00
|
|
|
struct watchdog_core_data *wd_data;
|
2011-07-23 02:55:18 +08:00
|
|
|
unsigned long status;
|
|
|
|
|
/* Bit numbers for status flags */
|
2011-07-23 02:57:55 +08: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 08:01:42 +08:00
|
|
|
#define WDOG_NO_WAY_OUT 1 /* Is 'nowayout' feature set ? */
|
|
|
|
|
#define WDOG_STOP_ON_REBOOT 2 /* Should be stopped on reboot */
|
2016-02-29 05:12:16 +08:00
|
|
|
#define WDOG_HW_RUNNING 3 /* True if HW watchdog running */
|
2017-01-26 06:21:10 +08:00
|
|
|
#define WDOG_STOP_ON_UNREGISTER 4 /* Should be stopped on unregister */
|
2015-06-10 00:55:02 +08:00
|
|
|
struct list_head deferred;
|
2011-07-23 02:55:18 +08:00
|
|
|
};
|
|
|
|
|
|
2014-09-10 04:18:31 +08:00
|
|
|
#define WATCHDOG_NOWAYOUT IS_BUILTIN(CONFIG_WATCHDOG_NOWAYOUT)
|
|
|
|
|
#define WATCHDOG_NOWAYOUT_INIT_STATUS (WATCHDOG_NOWAYOUT << WDOG_NO_WAY_OUT)
|
2011-11-29 23:24:16 +08:00
|
|
|
|
2012-09-20 09:48:00 +08:00
|
|
|
/* Use the following function to check whether or not the watchdog is active */
|
2012-03-12 12:21:56 +08:00
|
|
|
static inline bool watchdog_active(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
return test_bit(WDOG_ACTIVE, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-29 05:12:16 +08: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 23:24:16 +08:00
|
|
|
/* Use the following function to set the nowayout feature */
|
2012-03-05 23:51:11 +08:00
|
|
|
static inline void watchdog_set_nowayout(struct watchdog_device *wdd, bool nowayout)
|
2011-11-29 23:24:16 +08:00
|
|
|
{
|
|
|
|
|
if (nowayout)
|
|
|
|
|
set_bit(WDOG_NO_WAY_OUT, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2015-11-21 05:54:51 +08: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);
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-26 06:21:10 +08:00
|
|
|
/* Use the following function to stop the watchdog when unregistering it */
|
|
|
|
|
static inline void watchdog_stop_on_unregister(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
set_bit(WDOG_STOP_ON_UNREGISTER, &wdd->status);
|
|
|
|
|
}
|
|
|
|
|
|
2013-01-08 18:04:10 +08: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 16:27:24 +08:00
|
|
|
/*
|
|
|
|
|
* The timeout is invalid if
|
2016-02-29 05:12:15 +08:00
|
|
|
* - the requested value is larger than UINT_MAX / 1000
|
|
|
|
|
* (since internal calculations are done in milli-seconds),
|
|
|
|
|
* or
|
2015-09-29 16:27:24 +08:00
|
|
|
* - the requested value is smaller than the configured minimum timeout,
|
|
|
|
|
* or
|
2016-02-29 05:12:15 +08: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 16:27:24 +08:00
|
|
|
*/
|
2016-02-29 05:12:15 +08: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 18:04:10 +08:00
|
|
|
}
|
|
|
|
|
|
2016-08-31 19:52:41 +08:00
|
|
|
/* Use the following function to check if a pretimeout value is invalid */
|
|
|
|
|
static inline bool watchdog_pretimeout_invalid(struct watchdog_device *wdd,
|
|
|
|
|
unsigned int t)
|
|
|
|
|
{
|
|
|
|
|
return t && wdd->timeout && t >= wdd->timeout;
|
|
|
|
|
}
|
|
|
|
|
|
2011-07-23 02:55:18 +08: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;
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-07 20:39:54 +08:00
|
|
|
/* Use the following functions to report watchdog pretimeout event */
|
|
|
|
|
#if IS_ENABLED(CONFIG_WATCHDOG_PRETIMEOUT_GOV)
|
|
|
|
|
void watchdog_notify_pretimeout(struct watchdog_device *wdd);
|
|
|
|
|
#else
|
|
|
|
|
static inline void watchdog_notify_pretimeout(struct watchdog_device *wdd)
|
|
|
|
|
{
|
|
|
|
|
pr_alert("watchdog%d: pretimeout event\n", wdd->id);
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2012-10-05 18:16:09 +08:00
|
|
|
/* drivers/watchdog/watchdog_core.c */
|
2015-11-17 01:27:59 +08:00
|
|
|
void watchdog_set_restart_priority(struct watchdog_device *wdd, int priority);
|
2013-01-08 18:04:10 +08:00
|
|
|
extern int watchdog_init_timeout(struct watchdog_device *wdd,
|
|
|
|
|
unsigned int timeout_parm, struct device *dev);
|
2011-07-23 02:55:18 +08:00
|
|
|
extern int watchdog_register_device(struct watchdog_device *);
|
|
|
|
|
extern void watchdog_unregister_device(struct watchdog_device *);
|
|
|
|
|
|
2020-07-17 21:29:56 +08:00
|
|
|
int watchdog_set_last_hw_keepalive(struct watchdog_device *, unsigned int);
|
|
|
|
|
|
2016-05-27 23:33:54 +08:00
|
|
|
/* devres register variant */
|
|
|
|
|
int devm_watchdog_register_device(struct device *dev, struct watchdog_device *);
|
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
#endif /* ifndef _LINUX_WATCHDOG_H */
|