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 14:07:57 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2017-03-21 11:56:47 +00:00
|
|
|
|
|
|
|
#ifndef __LINUX_USB_TYPEC_H
|
|
|
|
#define __LINUX_USB_TYPEC_H
|
|
|
|
|
|
|
|
#include <linux/types.h>
|
|
|
|
|
|
|
|
/* XXX: Once we have a header for USB Power Delivery, this belongs there */
|
|
|
|
#define ALTMODE_MAX_MODES 6
|
|
|
|
|
|
|
|
/* USB Type-C Specification releases */
|
|
|
|
#define USB_TYPEC_REV_1_0 0x100 /* 1.0 */
|
|
|
|
#define USB_TYPEC_REV_1_1 0x110 /* 1.1 */
|
|
|
|
#define USB_TYPEC_REV_1_2 0x120 /* 1.2 */
|
|
|
|
|
|
|
|
struct typec_altmode;
|
|
|
|
struct typec_partner;
|
|
|
|
struct typec_cable;
|
|
|
|
struct typec_plug;
|
|
|
|
struct typec_port;
|
|
|
|
|
|
|
|
struct fwnode_handle;
|
|
|
|
|
|
|
|
enum typec_port_type {
|
2018-03-20 12:57:05 +00:00
|
|
|
TYPEC_PORT_SRC,
|
|
|
|
TYPEC_PORT_SNK,
|
|
|
|
TYPEC_PORT_DRP,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_port_data {
|
2017-03-21 11:56:47 +00:00
|
|
|
TYPEC_PORT_DFP,
|
|
|
|
TYPEC_PORT_UFP,
|
2018-03-20 12:57:05 +00:00
|
|
|
TYPEC_PORT_DRD,
|
2017-03-21 11:56:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_plug_type {
|
|
|
|
USB_PLUG_NONE,
|
|
|
|
USB_PLUG_TYPE_A,
|
|
|
|
USB_PLUG_TYPE_B,
|
|
|
|
USB_PLUG_TYPE_C,
|
|
|
|
USB_PLUG_CAPTIVE,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_data_role {
|
|
|
|
TYPEC_DEVICE,
|
|
|
|
TYPEC_HOST,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_role {
|
|
|
|
TYPEC_SINK,
|
|
|
|
TYPEC_SOURCE,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_pwr_opmode {
|
|
|
|
TYPEC_PWR_MODE_USB,
|
|
|
|
TYPEC_PWR_MODE_1_5A,
|
|
|
|
TYPEC_PWR_MODE_3_0A,
|
|
|
|
TYPEC_PWR_MODE_PD,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum typec_accessory {
|
|
|
|
TYPEC_ACCESSORY_NONE,
|
|
|
|
TYPEC_ACCESSORY_AUDIO,
|
|
|
|
TYPEC_ACCESSORY_DEBUG,
|
|
|
|
};
|
|
|
|
|
|
|
|
#define TYPEC_MAX_ACCESSORY 3
|
|
|
|
|
2018-03-20 12:57:03 +00:00
|
|
|
enum typec_orientation {
|
|
|
|
TYPEC_ORIENTATION_NONE,
|
|
|
|
TYPEC_ORIENTATION_NORMAL,
|
|
|
|
TYPEC_ORIENTATION_REVERSE,
|
|
|
|
};
|
|
|
|
|
2017-03-21 11:56:47 +00:00
|
|
|
/*
|
|
|
|
* struct usb_pd_identity - USB Power Delivery identity data
|
|
|
|
* @id_header: ID Header VDO
|
|
|
|
* @cert_stat: Cert Stat VDO
|
|
|
|
* @product: Product VDO
|
|
|
|
*
|
|
|
|
* USB power delivery Discover Identity command response data.
|
|
|
|
*
|
|
|
|
* REVISIT: This is USB Power Delivery specific information, so this structure
|
|
|
|
* probable belongs to USB Power Delivery header file once we have them.
|
|
|
|
*/
|
|
|
|
struct usb_pd_identity {
|
|
|
|
u32 id_header;
|
|
|
|
u32 cert_stat;
|
|
|
|
u32 product;
|
|
|
|
};
|
|
|
|
|
|
|
|
int typec_partner_set_identity(struct typec_partner *partner);
|
|
|
|
int typec_cable_set_identity(struct typec_cable *cable);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_mode_desc - Individual Mode of an Alternate Mode
|
|
|
|
* @index: Index of the Mode within the SVID
|
|
|
|
* @vdo: VDO returned by Discover Modes USB PD command
|
|
|
|
* @desc: Optional human readable description of the mode
|
|
|
|
* @roles: Only for ports. DRP if the mode is available in both roles
|
|
|
|
*
|
|
|
|
* Description of a mode of an Alternate Mode which a connector, cable plug or
|
|
|
|
* partner supports. Every mode will have it's own sysfs group. The details are
|
|
|
|
* the VDO returned by discover modes command, description for the mode and
|
|
|
|
* active flag telling has the mode being entered or not.
|
|
|
|
*/
|
|
|
|
struct typec_mode_desc {
|
|
|
|
int index;
|
|
|
|
u32 vdo;
|
|
|
|
char *desc;
|
|
|
|
/* Only used with ports */
|
|
|
|
enum typec_port_type roles;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_altmode_desc - USB Type-C Alternate Mode Descriptor
|
|
|
|
* @svid: Standard or Vendor ID
|
|
|
|
* @n_modes: Number of modes
|
|
|
|
* @modes: Array of modes supported by the Alternate Mode
|
|
|
|
*
|
|
|
|
* Representation of an Alternate Mode that has SVID assigned by USB-IF. The
|
|
|
|
* array of modes will list the modes of a particular SVID that are supported by
|
|
|
|
* a connector, partner of a cable plug.
|
|
|
|
*/
|
|
|
|
struct typec_altmode_desc {
|
|
|
|
u16 svid;
|
|
|
|
int n_modes;
|
|
|
|
struct typec_mode_desc modes[ALTMODE_MAX_MODES];
|
|
|
|
};
|
|
|
|
|
|
|
|
struct typec_altmode
|
|
|
|
*typec_partner_register_altmode(struct typec_partner *partner,
|
2017-04-25 21:49:47 +00:00
|
|
|
const struct typec_altmode_desc *desc);
|
2017-03-21 11:56:47 +00:00
|
|
|
struct typec_altmode
|
|
|
|
*typec_plug_register_altmode(struct typec_plug *plug,
|
2017-04-25 21:49:47 +00:00
|
|
|
const struct typec_altmode_desc *desc);
|
2017-03-21 11:56:47 +00:00
|
|
|
struct typec_altmode
|
|
|
|
*typec_port_register_altmode(struct typec_port *port,
|
2017-04-25 21:49:47 +00:00
|
|
|
const struct typec_altmode_desc *desc);
|
2017-03-21 11:56:47 +00:00
|
|
|
void typec_unregister_altmode(struct typec_altmode *altmode);
|
|
|
|
|
|
|
|
struct typec_port *typec_altmode2port(struct typec_altmode *alt);
|
|
|
|
|
|
|
|
void typec_altmode_update_active(struct typec_altmode *alt, int mode,
|
|
|
|
bool active);
|
|
|
|
|
|
|
|
enum typec_plug_index {
|
|
|
|
TYPEC_PLUG_SOP_P,
|
|
|
|
TYPEC_PLUG_SOP_PP,
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_plug_desc - USB Type-C Cable Plug Descriptor
|
|
|
|
* @index: SOP Prime for the plug connected to DFP and SOP Double Prime for the
|
|
|
|
* plug connected to UFP
|
|
|
|
*
|
|
|
|
* Represents USB Type-C Cable Plug.
|
|
|
|
*/
|
|
|
|
struct typec_plug_desc {
|
|
|
|
enum typec_plug_index index;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_cable_desc - USB Type-C Cable Descriptor
|
|
|
|
* @type: The plug type from USB PD Cable VDO
|
|
|
|
* @active: Is the cable active or passive
|
|
|
|
* @identity: Result of Discover Identity command
|
|
|
|
*
|
|
|
|
* Represents USB Type-C Cable attached to USB Type-C port.
|
|
|
|
*/
|
|
|
|
struct typec_cable_desc {
|
|
|
|
enum typec_plug_type type;
|
|
|
|
unsigned int active:1;
|
|
|
|
struct usb_pd_identity *identity;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_partner_desc - USB Type-C Partner Descriptor
|
|
|
|
* @usb_pd: USB Power Delivery support
|
|
|
|
* @accessory: Audio, Debug or none.
|
|
|
|
* @identity: Discover Identity command data
|
|
|
|
*
|
|
|
|
* Details about a partner that is attached to USB Type-C port. If @identity
|
|
|
|
* member exists when partner is registered, a directory named "identity" is
|
|
|
|
* created to sysfs for the partner device.
|
|
|
|
*/
|
|
|
|
struct typec_partner_desc {
|
|
|
|
unsigned int usb_pd:1;
|
|
|
|
enum typec_accessory accessory;
|
|
|
|
struct usb_pd_identity *identity;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* struct typec_capability - USB Type-C Port Capabilities
|
2018-03-20 12:57:05 +00:00
|
|
|
* @type: Supported power role of the port
|
|
|
|
* @data: Supported data role of the port
|
2017-03-21 11:56:47 +00:00
|
|
|
* @revision: USB Type-C Specification release. Binary coded decimal
|
|
|
|
* @pd_revision: USB Power Delivery Specification revision if supported
|
2018-03-20 12:57:05 +00:00
|
|
|
* @prefer_role: Initial role preference (DRP ports).
|
2017-03-21 11:56:47 +00:00
|
|
|
* @accessory: Supported Accessory Modes
|
2018-03-20 12:57:03 +00:00
|
|
|
* @sw: Cable plug orientation switch
|
|
|
|
* @mux: Multiplexer switch for Alternate/Accessory Modes
|
2017-03-21 11:56:47 +00:00
|
|
|
* @fwnode: Optional fwnode of the port
|
|
|
|
* @try_role: Set data role preference for DRP port
|
|
|
|
* @dr_set: Set Data Role
|
|
|
|
* @pr_set: Set Power Role
|
|
|
|
* @vconn_set: Set VCONN Role
|
|
|
|
* @activate_mode: Enter/exit given Alternate Mode
|
2017-05-30 19:39:53 +00:00
|
|
|
* @port_type_set: Set port type
|
2017-03-21 11:56:47 +00:00
|
|
|
*
|
|
|
|
* Static capabilities of a single USB Type-C port.
|
|
|
|
*/
|
|
|
|
struct typec_capability {
|
|
|
|
enum typec_port_type type;
|
2018-03-20 12:57:05 +00:00
|
|
|
enum typec_port_data data;
|
2017-03-21 11:56:47 +00:00
|
|
|
u16 revision; /* 0120H = "1.2" */
|
|
|
|
u16 pd_revision; /* 0300H = "3.0" */
|
|
|
|
int prefer_role;
|
|
|
|
enum typec_accessory accessory[TYPEC_MAX_ACCESSORY];
|
|
|
|
|
2018-03-20 12:57:03 +00:00
|
|
|
struct typec_switch *sw;
|
|
|
|
struct typec_mux *mux;
|
2017-03-21 11:56:47 +00:00
|
|
|
struct fwnode_handle *fwnode;
|
|
|
|
|
|
|
|
int (*try_role)(const struct typec_capability *,
|
|
|
|
int role);
|
|
|
|
|
|
|
|
int (*dr_set)(const struct typec_capability *,
|
|
|
|
enum typec_data_role);
|
|
|
|
int (*pr_set)(const struct typec_capability *,
|
|
|
|
enum typec_role);
|
|
|
|
int (*vconn_set)(const struct typec_capability *,
|
|
|
|
enum typec_role);
|
|
|
|
|
|
|
|
int (*activate_mode)(const struct typec_capability *,
|
|
|
|
int mode, int activate);
|
2017-05-30 19:39:53 +00:00
|
|
|
int (*port_type_set)(const struct typec_capability *,
|
|
|
|
enum typec_port_type);
|
|
|
|
|
2017-03-21 11:56:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Specific to try_role(). Indicates the user want's to clear the preference. */
|
|
|
|
#define TYPEC_NO_PREFERRED_ROLE (-1)
|
|
|
|
|
|
|
|
struct typec_port *typec_register_port(struct device *parent,
|
|
|
|
const struct typec_capability *cap);
|
|
|
|
void typec_unregister_port(struct typec_port *port);
|
|
|
|
|
|
|
|
struct typec_partner *typec_register_partner(struct typec_port *port,
|
|
|
|
struct typec_partner_desc *desc);
|
|
|
|
void typec_unregister_partner(struct typec_partner *partner);
|
|
|
|
|
|
|
|
struct typec_cable *typec_register_cable(struct typec_port *port,
|
|
|
|
struct typec_cable_desc *desc);
|
|
|
|
void typec_unregister_cable(struct typec_cable *cable);
|
|
|
|
|
|
|
|
struct typec_plug *typec_register_plug(struct typec_cable *cable,
|
|
|
|
struct typec_plug_desc *desc);
|
|
|
|
void typec_unregister_plug(struct typec_plug *plug);
|
|
|
|
|
|
|
|
void typec_set_data_role(struct typec_port *port, enum typec_data_role role);
|
|
|
|
void typec_set_pwr_role(struct typec_port *port, enum typec_role role);
|
|
|
|
void typec_set_vconn_role(struct typec_port *port, enum typec_role role);
|
|
|
|
void typec_set_pwr_opmode(struct typec_port *port, enum typec_pwr_opmode mode);
|
|
|
|
|
2018-03-20 12:57:03 +00:00
|
|
|
int typec_set_orientation(struct typec_port *port,
|
|
|
|
enum typec_orientation orientation);
|
|
|
|
int typec_set_mode(struct typec_port *port, int mode);
|
|
|
|
|
2017-03-21 11:56:47 +00:00
|
|
|
#endif /* __LINUX_USB_TYPEC_H */
|