mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-26 10:49:33 +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>
172 lines
4.5 KiB
C
172 lines
4.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _ASM_GENERIC_GPIO_H
|
|
#define _ASM_GENERIC_GPIO_H
|
|
|
|
#include <linux/kernel.h>
|
|
#include <linux/types.h>
|
|
#include <linux/errno.h>
|
|
#include <linux/of.h>
|
|
|
|
#ifdef CONFIG_GPIOLIB
|
|
|
|
#include <linux/compiler.h>
|
|
#include <linux/gpio/driver.h>
|
|
#include <linux/gpio/consumer.h>
|
|
|
|
/* Platforms may implement their GPIO interface with library code,
|
|
* at a small performance cost for non-inlined operations and some
|
|
* extra memory (for code and for per-GPIO table entries).
|
|
*
|
|
* While the GPIO programming interface defines valid GPIO numbers
|
|
* to be in the range 0..MAX_INT, this library restricts them to the
|
|
* smaller range 0..ARCH_NR_GPIOS-1.
|
|
*
|
|
* ARCH_NR_GPIOS is somewhat arbitrary; it usually reflects the sum of
|
|
* builtin/SoC GPIOs plus a number of GPIOs on expanders; the latter is
|
|
* actually an estimate of a board-specific value.
|
|
*/
|
|
|
|
#ifndef ARCH_NR_GPIOS
|
|
#if defined(CONFIG_ARCH_NR_GPIO) && CONFIG_ARCH_NR_GPIO > 0
|
|
#define ARCH_NR_GPIOS CONFIG_ARCH_NR_GPIO
|
|
#else
|
|
#define ARCH_NR_GPIOS 512
|
|
#endif
|
|
#endif
|
|
|
|
/*
|
|
* "valid" GPIO numbers are nonnegative and may be passed to
|
|
* setup routines like gpio_request(). only some valid numbers
|
|
* can successfully be requested and used.
|
|
*
|
|
* Invalid GPIO numbers are useful for indicating no-such-GPIO in
|
|
* platform data and other tables.
|
|
*/
|
|
|
|
static inline bool gpio_is_valid(int number)
|
|
{
|
|
return number >= 0 && number < ARCH_NR_GPIOS;
|
|
}
|
|
|
|
struct device;
|
|
struct gpio;
|
|
struct seq_file;
|
|
struct module;
|
|
struct device_node;
|
|
struct gpio_desc;
|
|
|
|
/* caller holds gpio_lock *OR* gpio is marked as requested */
|
|
static inline struct gpio_chip *gpio_to_chip(unsigned gpio)
|
|
{
|
|
return gpiod_to_chip(gpio_to_desc(gpio));
|
|
}
|
|
|
|
/* Always use the library code for GPIO management calls,
|
|
* or when sleeping may be involved.
|
|
*/
|
|
extern int gpio_request(unsigned gpio, const char *label);
|
|
extern void gpio_free(unsigned gpio);
|
|
|
|
static inline int gpio_direction_input(unsigned gpio)
|
|
{
|
|
return gpiod_direction_input(gpio_to_desc(gpio));
|
|
}
|
|
static inline int gpio_direction_output(unsigned gpio, int value)
|
|
{
|
|
return gpiod_direction_output_raw(gpio_to_desc(gpio), value);
|
|
}
|
|
|
|
static inline int gpio_set_debounce(unsigned gpio, unsigned debounce)
|
|
{
|
|
return gpiod_set_debounce(gpio_to_desc(gpio), debounce);
|
|
}
|
|
|
|
static inline int gpio_get_value_cansleep(unsigned gpio)
|
|
{
|
|
return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio));
|
|
}
|
|
static inline void gpio_set_value_cansleep(unsigned gpio, int value)
|
|
{
|
|
return gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value);
|
|
}
|
|
|
|
|
|
/* A platform's <asm/gpio.h> code may want to inline the I/O calls when
|
|
* the GPIO is constant and refers to some always-present controller,
|
|
* giving direct access to chip registers and tight bitbanging loops.
|
|
*/
|
|
static inline int __gpio_get_value(unsigned gpio)
|
|
{
|
|
return gpiod_get_raw_value(gpio_to_desc(gpio));
|
|
}
|
|
static inline void __gpio_set_value(unsigned gpio, int value)
|
|
{
|
|
return gpiod_set_raw_value(gpio_to_desc(gpio), value);
|
|
}
|
|
|
|
static inline int __gpio_cansleep(unsigned gpio)
|
|
{
|
|
return gpiod_cansleep(gpio_to_desc(gpio));
|
|
}
|
|
|
|
static inline int __gpio_to_irq(unsigned gpio)
|
|
{
|
|
return gpiod_to_irq(gpio_to_desc(gpio));
|
|
}
|
|
|
|
extern int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
|
|
extern int gpio_request_array(const struct gpio *array, size_t num);
|
|
extern void gpio_free_array(const struct gpio *array, size_t num);
|
|
|
|
/*
|
|
* A sysfs interface can be exported by individual drivers if they want,
|
|
* but more typically is configured entirely from userspace.
|
|
*/
|
|
static inline int gpio_export(unsigned gpio, bool direction_may_change)
|
|
{
|
|
return gpiod_export(gpio_to_desc(gpio), direction_may_change);
|
|
}
|
|
|
|
static inline int gpio_export_link(struct device *dev, const char *name,
|
|
unsigned gpio)
|
|
{
|
|
return gpiod_export_link(dev, name, gpio_to_desc(gpio));
|
|
}
|
|
|
|
static inline void gpio_unexport(unsigned gpio)
|
|
{
|
|
gpiod_unexport(gpio_to_desc(gpio));
|
|
}
|
|
|
|
#else /* !CONFIG_GPIOLIB */
|
|
|
|
static inline bool gpio_is_valid(int number)
|
|
{
|
|
/* only non-negative numbers are valid */
|
|
return number >= 0;
|
|
}
|
|
|
|
/* platforms that don't directly support access to GPIOs through I2C, SPI,
|
|
* or other blocking infrastructure can use these wrappers.
|
|
*/
|
|
|
|
static inline int gpio_cansleep(unsigned gpio)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline int gpio_get_value_cansleep(unsigned gpio)
|
|
{
|
|
might_sleep();
|
|
return __gpio_get_value(gpio);
|
|
}
|
|
|
|
static inline void gpio_set_value_cansleep(unsigned gpio, int value)
|
|
{
|
|
might_sleep();
|
|
__gpio_set_value(gpio, value);
|
|
}
|
|
|
|
#endif /* !CONFIG_GPIOLIB */
|
|
|
|
#endif /* _ASM_GENERIC_GPIO_H */
|