mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-04 18:09:57 +00:00
![Greg Kroah-Hartman](/assets/img/avatar_default.png)
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>
446 lines
14 KiB
C
446 lines
14 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_RESET_H_
|
|
#define _LINUX_RESET_H_
|
|
|
|
#include <linux/device.h>
|
|
|
|
struct reset_control;
|
|
|
|
#ifdef CONFIG_RESET_CONTROLLER
|
|
|
|
int reset_control_reset(struct reset_control *rstc);
|
|
int reset_control_assert(struct reset_control *rstc);
|
|
int reset_control_deassert(struct reset_control *rstc);
|
|
int reset_control_status(struct reset_control *rstc);
|
|
|
|
struct reset_control *__of_reset_control_get(struct device_node *node,
|
|
const char *id, int index, bool shared,
|
|
bool optional);
|
|
struct reset_control *__reset_control_get(struct device *dev, const char *id,
|
|
int index, bool shared,
|
|
bool optional);
|
|
void reset_control_put(struct reset_control *rstc);
|
|
struct reset_control *__devm_reset_control_get(struct device *dev,
|
|
const char *id, int index, bool shared,
|
|
bool optional);
|
|
|
|
int __must_check device_reset(struct device *dev);
|
|
|
|
struct reset_control *devm_reset_control_array_get(struct device *dev,
|
|
bool shared, bool optional);
|
|
struct reset_control *of_reset_control_array_get(struct device_node *np,
|
|
bool shared, bool optional);
|
|
|
|
static inline int device_reset_optional(struct device *dev)
|
|
{
|
|
return device_reset(dev);
|
|
}
|
|
|
|
#else
|
|
|
|
static inline int reset_control_reset(struct reset_control *rstc)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline int reset_control_assert(struct reset_control *rstc)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline int reset_control_deassert(struct reset_control *rstc)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline int reset_control_status(struct reset_control *rstc)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline void reset_control_put(struct reset_control *rstc)
|
|
{
|
|
}
|
|
|
|
static inline int __must_check device_reset(struct device *dev)
|
|
{
|
|
WARN_ON(1);
|
|
return -ENOTSUPP;
|
|
}
|
|
|
|
static inline int device_reset_optional(struct device *dev)
|
|
{
|
|
return -ENOTSUPP;
|
|
}
|
|
|
|
static inline struct reset_control *__of_reset_control_get(
|
|
struct device_node *node,
|
|
const char *id, int index, bool shared,
|
|
bool optional)
|
|
{
|
|
return optional ? NULL : ERR_PTR(-ENOTSUPP);
|
|
}
|
|
|
|
static inline struct reset_control *__reset_control_get(
|
|
struct device *dev, const char *id,
|
|
int index, bool shared, bool optional)
|
|
{
|
|
return optional ? NULL : ERR_PTR(-ENOTSUPP);
|
|
}
|
|
|
|
static inline struct reset_control *__devm_reset_control_get(
|
|
struct device *dev, const char *id,
|
|
int index, bool shared, bool optional)
|
|
{
|
|
return optional ? NULL : ERR_PTR(-ENOTSUPP);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
devm_reset_control_array_get(struct device *dev, bool shared, bool optional)
|
|
{
|
|
return optional ? NULL : ERR_PTR(-ENOTSUPP);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
of_reset_control_array_get(struct device_node *np, bool shared, bool optional)
|
|
{
|
|
return optional ? NULL : ERR_PTR(-ENOTSUPP);
|
|
}
|
|
|
|
#endif /* CONFIG_RESET_CONTROLLER */
|
|
|
|
/**
|
|
* reset_control_get_exclusive - Lookup and obtain an exclusive reference
|
|
* to a reset controller.
|
|
* @dev: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* Returns a struct reset_control or IS_ERR() condition containing errno.
|
|
* If this function is called more then once for the same reset_control it will
|
|
* return -EBUSY.
|
|
*
|
|
* See reset_control_get_shared for details on shared references to
|
|
* reset-controls.
|
|
*
|
|
* Use of id names is optional.
|
|
*/
|
|
static inline struct reset_control *
|
|
__must_check reset_control_get_exclusive(struct device *dev, const char *id)
|
|
{
|
|
#ifndef CONFIG_RESET_CONTROLLER
|
|
WARN_ON(1);
|
|
#endif
|
|
return __reset_control_get(dev, id, 0, false, false);
|
|
}
|
|
|
|
/**
|
|
* reset_control_get_shared - Lookup and obtain a shared reference to a
|
|
* reset controller.
|
|
* @dev: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* Returns a struct reset_control or IS_ERR() condition containing errno.
|
|
* This function is intended for use with reset-controls which are shared
|
|
* between hardware-blocks.
|
|
*
|
|
* When a reset-control is shared, the behavior of reset_control_assert /
|
|
* deassert is changed, the reset-core will keep track of a deassert_count
|
|
* and only (re-)assert the reset after reset_control_assert has been called
|
|
* as many times as reset_control_deassert was called. Also see the remark
|
|
* about shared reset-controls in the reset_control_assert docs.
|
|
*
|
|
* Calling reset_control_assert without first calling reset_control_deassert
|
|
* is not allowed on a shared reset control. Calling reset_control_reset is
|
|
* also not allowed on a shared reset control.
|
|
*
|
|
* Use of id names is optional.
|
|
*/
|
|
static inline struct reset_control *reset_control_get_shared(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __reset_control_get(dev, id, 0, true, false);
|
|
}
|
|
|
|
static inline struct reset_control *reset_control_get_optional_exclusive(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __reset_control_get(dev, id, 0, false, true);
|
|
}
|
|
|
|
static inline struct reset_control *reset_control_get_optional_shared(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __reset_control_get(dev, id, 0, true, true);
|
|
}
|
|
|
|
/**
|
|
* of_reset_control_get_exclusive - Lookup and obtain an exclusive reference
|
|
* to a reset controller.
|
|
* @node: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* Returns a struct reset_control or IS_ERR() condition containing errno.
|
|
*
|
|
* Use of id names is optional.
|
|
*/
|
|
static inline struct reset_control *of_reset_control_get_exclusive(
|
|
struct device_node *node, const char *id)
|
|
{
|
|
return __of_reset_control_get(node, id, 0, false, false);
|
|
}
|
|
|
|
/**
|
|
* of_reset_control_get_shared - Lookup and obtain an shared reference
|
|
* to a reset controller.
|
|
* @node: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* When a reset-control is shared, the behavior of reset_control_assert /
|
|
* deassert is changed, the reset-core will keep track of a deassert_count
|
|
* and only (re-)assert the reset after reset_control_assert has been called
|
|
* as many times as reset_control_deassert was called. Also see the remark
|
|
* about shared reset-controls in the reset_control_assert docs.
|
|
*
|
|
* Calling reset_control_assert without first calling reset_control_deassert
|
|
* is not allowed on a shared reset control. Calling reset_control_reset is
|
|
* also not allowed on a shared reset control.
|
|
* Returns a struct reset_control or IS_ERR() condition containing errno.
|
|
*
|
|
* Use of id names is optional.
|
|
*/
|
|
static inline struct reset_control *of_reset_control_get_shared(
|
|
struct device_node *node, const char *id)
|
|
{
|
|
return __of_reset_control_get(node, id, 0, true, false);
|
|
}
|
|
|
|
/**
|
|
* of_reset_control_get_exclusive_by_index - Lookup and obtain an exclusive
|
|
* reference to a reset controller
|
|
* by index.
|
|
* @node: device to be reset by the controller
|
|
* @index: index of the reset controller
|
|
*
|
|
* This is to be used to perform a list of resets for a device or power domain
|
|
* in whatever order. Returns a struct reset_control or IS_ERR() condition
|
|
* containing errno.
|
|
*/
|
|
static inline struct reset_control *of_reset_control_get_exclusive_by_index(
|
|
struct device_node *node, int index)
|
|
{
|
|
return __of_reset_control_get(node, NULL, index, false, false);
|
|
}
|
|
|
|
/**
|
|
* of_reset_control_get_shared_by_index - Lookup and obtain an shared
|
|
* reference to a reset controller
|
|
* by index.
|
|
* @node: device to be reset by the controller
|
|
* @index: index of the reset controller
|
|
*
|
|
* When a reset-control is shared, the behavior of reset_control_assert /
|
|
* deassert is changed, the reset-core will keep track of a deassert_count
|
|
* and only (re-)assert the reset after reset_control_assert has been called
|
|
* as many times as reset_control_deassert was called. Also see the remark
|
|
* about shared reset-controls in the reset_control_assert docs.
|
|
*
|
|
* Calling reset_control_assert without first calling reset_control_deassert
|
|
* is not allowed on a shared reset control. Calling reset_control_reset is
|
|
* also not allowed on a shared reset control.
|
|
* Returns a struct reset_control or IS_ERR() condition containing errno.
|
|
*
|
|
* This is to be used to perform a list of resets for a device or power domain
|
|
* in whatever order. Returns a struct reset_control or IS_ERR() condition
|
|
* containing errno.
|
|
*/
|
|
static inline struct reset_control *of_reset_control_get_shared_by_index(
|
|
struct device_node *node, int index)
|
|
{
|
|
return __of_reset_control_get(node, NULL, index, true, false);
|
|
}
|
|
|
|
/**
|
|
* devm_reset_control_get_exclusive - resource managed
|
|
* reset_control_get_exclusive()
|
|
* @dev: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* Managed reset_control_get_exclusive(). For reset controllers returned
|
|
* from this function, reset_control_put() is called automatically on driver
|
|
* detach.
|
|
*
|
|
* See reset_control_get_exclusive() for more information.
|
|
*/
|
|
static inline struct reset_control *
|
|
__must_check devm_reset_control_get_exclusive(struct device *dev,
|
|
const char *id)
|
|
{
|
|
#ifndef CONFIG_RESET_CONTROLLER
|
|
WARN_ON(1);
|
|
#endif
|
|
return __devm_reset_control_get(dev, id, 0, false, false);
|
|
}
|
|
|
|
/**
|
|
* devm_reset_control_get_shared - resource managed reset_control_get_shared()
|
|
* @dev: device to be reset by the controller
|
|
* @id: reset line name
|
|
*
|
|
* Managed reset_control_get_shared(). For reset controllers returned from
|
|
* this function, reset_control_put() is called automatically on driver detach.
|
|
* See reset_control_get_shared() for more information.
|
|
*/
|
|
static inline struct reset_control *devm_reset_control_get_shared(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __devm_reset_control_get(dev, id, 0, true, false);
|
|
}
|
|
|
|
static inline struct reset_control *devm_reset_control_get_optional_exclusive(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __devm_reset_control_get(dev, id, 0, false, true);
|
|
}
|
|
|
|
static inline struct reset_control *devm_reset_control_get_optional_shared(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return __devm_reset_control_get(dev, id, 0, true, true);
|
|
}
|
|
|
|
/**
|
|
* devm_reset_control_get_exclusive_by_index - resource managed
|
|
* reset_control_get_exclusive()
|
|
* @dev: device to be reset by the controller
|
|
* @index: index of the reset controller
|
|
*
|
|
* Managed reset_control_get_exclusive(). For reset controllers returned from
|
|
* this function, reset_control_put() is called automatically on driver
|
|
* detach.
|
|
*
|
|
* See reset_control_get_exclusive() for more information.
|
|
*/
|
|
static inline struct reset_control *
|
|
devm_reset_control_get_exclusive_by_index(struct device *dev, int index)
|
|
{
|
|
return __devm_reset_control_get(dev, NULL, index, false, false);
|
|
}
|
|
|
|
/**
|
|
* devm_reset_control_get_shared_by_index - resource managed
|
|
* reset_control_get_shared
|
|
* @dev: device to be reset by the controller
|
|
* @index: index of the reset controller
|
|
*
|
|
* Managed reset_control_get_shared(). For reset controllers returned from
|
|
* this function, reset_control_put() is called automatically on driver detach.
|
|
* See reset_control_get_shared() for more information.
|
|
*/
|
|
static inline struct reset_control *
|
|
devm_reset_control_get_shared_by_index(struct device *dev, int index)
|
|
{
|
|
return __devm_reset_control_get(dev, NULL, index, true, false);
|
|
}
|
|
|
|
/*
|
|
* TEMPORARY calls to use during transition:
|
|
*
|
|
* of_reset_control_get() => of_reset_control_get_exclusive()
|
|
*
|
|
* These inline function calls will be removed once all consumers
|
|
* have been moved over to the new explicit API.
|
|
*/
|
|
static inline struct reset_control *reset_control_get(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return reset_control_get_exclusive(dev, id);
|
|
}
|
|
|
|
static inline struct reset_control *reset_control_get_optional(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return reset_control_get_optional_exclusive(dev, id);
|
|
}
|
|
|
|
static inline struct reset_control *of_reset_control_get(
|
|
struct device_node *node, const char *id)
|
|
{
|
|
return of_reset_control_get_exclusive(node, id);
|
|
}
|
|
|
|
static inline struct reset_control *of_reset_control_get_by_index(
|
|
struct device_node *node, int index)
|
|
{
|
|
return of_reset_control_get_exclusive_by_index(node, index);
|
|
}
|
|
|
|
static inline struct reset_control *devm_reset_control_get(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return devm_reset_control_get_exclusive(dev, id);
|
|
}
|
|
|
|
static inline struct reset_control *devm_reset_control_get_optional(
|
|
struct device *dev, const char *id)
|
|
{
|
|
return devm_reset_control_get_optional_exclusive(dev, id);
|
|
|
|
}
|
|
|
|
static inline struct reset_control *devm_reset_control_get_by_index(
|
|
struct device *dev, int index)
|
|
{
|
|
return devm_reset_control_get_exclusive_by_index(dev, index);
|
|
}
|
|
|
|
/*
|
|
* APIs to manage a list of reset controllers
|
|
*/
|
|
static inline struct reset_control *
|
|
devm_reset_control_array_get_exclusive(struct device *dev)
|
|
{
|
|
return devm_reset_control_array_get(dev, false, false);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
devm_reset_control_array_get_shared(struct device *dev)
|
|
{
|
|
return devm_reset_control_array_get(dev, true, false);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
devm_reset_control_array_get_optional_exclusive(struct device *dev)
|
|
{
|
|
return devm_reset_control_array_get(dev, false, true);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
devm_reset_control_array_get_optional_shared(struct device *dev)
|
|
{
|
|
return devm_reset_control_array_get(dev, true, true);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
of_reset_control_array_get_exclusive(struct device_node *node)
|
|
{
|
|
return of_reset_control_array_get(node, false, false);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
of_reset_control_array_get_shared(struct device_node *node)
|
|
{
|
|
return of_reset_control_array_get(node, true, false);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
of_reset_control_array_get_optional_exclusive(struct device_node *node)
|
|
{
|
|
return of_reset_control_array_get(node, false, true);
|
|
}
|
|
|
|
static inline struct reset_control *
|
|
of_reset_control_array_get_optional_shared(struct device_node *node)
|
|
{
|
|
return of_reset_control_array_get(node, true, true);
|
|
}
|
|
#endif
|