linux-stable/include/linux/ulpi/regs.h
Greg Kroah-Hartman b24413180f 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-02 11:10:55 +01:00

131 lines
4 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __LINUX_ULPI_REGS_H
#define __LINUX_ULPI_REGS_H
/*
* Macros for Set and Clear
* See ULPI 1.1 specification to find the registers with Set and Clear offsets
*/
#define ULPI_SET(a) (a + 1)
#define ULPI_CLR(a) (a + 2)
/*
* Register Map
*/
#define ULPI_VENDOR_ID_LOW 0x00
#define ULPI_VENDOR_ID_HIGH 0x01
#define ULPI_PRODUCT_ID_LOW 0x02
#define ULPI_PRODUCT_ID_HIGH 0x03
#define ULPI_FUNC_CTRL 0x04
#define ULPI_IFC_CTRL 0x07
#define ULPI_OTG_CTRL 0x0a
#define ULPI_USB_INT_EN_RISE 0x0d
#define ULPI_USB_INT_EN_FALL 0x10
#define ULPI_USB_INT_STS 0x13
#define ULPI_USB_INT_LATCH 0x14
#define ULPI_DEBUG 0x15
#define ULPI_SCRATCH 0x16
/* Optional Carkit Registers */
#define ULPI_CARKIT_CTRL 0x19
#define ULPI_CARKIT_INT_DELAY 0x1c
#define ULPI_CARKIT_INT_EN 0x1d
#define ULPI_CARKIT_INT_STS 0x20
#define ULPI_CARKIT_INT_LATCH 0x21
#define ULPI_CARKIT_PLS_CTRL 0x22
/* Other Optional Registers */
#define ULPI_TX_POS_WIDTH 0x25
#define ULPI_TX_NEG_WIDTH 0x26
#define ULPI_POLARITY_RECOVERY 0x27
/* Access Extended Register Set */
#define ULPI_ACCESS_EXTENDED 0x2f
/* Vendor Specific */
#define ULPI_VENDOR_SPECIFIC 0x30
/* Extended Registers */
#define ULPI_EXT_VENDOR_SPECIFIC 0x80
/*
* Register Bits
*/
/* Function Control */
#define ULPI_FUNC_CTRL_XCVRSEL BIT(0)
#define ULPI_FUNC_CTRL_XCVRSEL_MASK 0x3
#define ULPI_FUNC_CTRL_HIGH_SPEED 0x0
#define ULPI_FUNC_CTRL_FULL_SPEED 0x1
#define ULPI_FUNC_CTRL_LOW_SPEED 0x2
#define ULPI_FUNC_CTRL_FS4LS 0x3
#define ULPI_FUNC_CTRL_TERMSELECT BIT(2)
#define ULPI_FUNC_CTRL_OPMODE BIT(3)
#define ULPI_FUNC_CTRL_OPMODE_MASK (0x3 << 3)
#define ULPI_FUNC_CTRL_OPMODE_NORMAL (0x0 << 3)
#define ULPI_FUNC_CTRL_OPMODE_NONDRIVING (0x1 << 3)
#define ULPI_FUNC_CTRL_OPMODE_DISABLE_NRZI (0x2 << 3)
#define ULPI_FUNC_CTRL_OPMODE_NOSYNC_NOEOP (0x3 << 3)
#define ULPI_FUNC_CTRL_RESET BIT(5)
#define ULPI_FUNC_CTRL_SUSPENDM BIT(6)
/* Interface Control */
#define ULPI_IFC_CTRL_6_PIN_SERIAL_MODE BIT(0)
#define ULPI_IFC_CTRL_3_PIN_SERIAL_MODE BIT(1)
#define ULPI_IFC_CTRL_CARKITMODE BIT(2)
#define ULPI_IFC_CTRL_CLOCKSUSPENDM BIT(3)
#define ULPI_IFC_CTRL_AUTORESUME BIT(4)
#define ULPI_IFC_CTRL_EXTERNAL_VBUS BIT(5)
#define ULPI_IFC_CTRL_PASSTHRU BIT(6)
#define ULPI_IFC_CTRL_PROTECT_IFC_DISABLE BIT(7)
/* OTG Control */
#define ULPI_OTG_CTRL_ID_PULLUP BIT(0)
#define ULPI_OTG_CTRL_DP_PULLDOWN BIT(1)
#define ULPI_OTG_CTRL_DM_PULLDOWN BIT(2)
#define ULPI_OTG_CTRL_DISCHRGVBUS BIT(3)
#define ULPI_OTG_CTRL_CHRGVBUS BIT(4)
#define ULPI_OTG_CTRL_DRVVBUS BIT(5)
#define ULPI_OTG_CTRL_DRVVBUS_EXT BIT(6)
#define ULPI_OTG_CTRL_EXTVBUSIND BIT(7)
/* USB Interrupt Enable Rising,
* USB Interrupt Enable Falling,
* USB Interrupt Status and
* USB Interrupt Latch
*/
#define ULPI_INT_HOST_DISCONNECT BIT(0)
#define ULPI_INT_VBUS_VALID BIT(1)
#define ULPI_INT_SESS_VALID BIT(2)
#define ULPI_INT_SESS_END BIT(3)
#define ULPI_INT_IDGRD BIT(4)
/* Debug */
#define ULPI_DEBUG_LINESTATE0 BIT(0)
#define ULPI_DEBUG_LINESTATE1 BIT(1)
/* Carkit Control */
#define ULPI_CARKIT_CTRL_CARKITPWR BIT(0)
#define ULPI_CARKIT_CTRL_IDGNDDRV BIT(1)
#define ULPI_CARKIT_CTRL_TXDEN BIT(2)
#define ULPI_CARKIT_CTRL_RXDEN BIT(3)
#define ULPI_CARKIT_CTRL_SPKLEFTEN BIT(4)
#define ULPI_CARKIT_CTRL_SPKRIGHTEN BIT(5)
#define ULPI_CARKIT_CTRL_MICEN BIT(6)
/* Carkit Interrupt Enable */
#define ULPI_CARKIT_INT_EN_IDFLOAT_RISE BIT(0)
#define ULPI_CARKIT_INT_EN_IDFLOAT_FALL BIT(1)
#define ULPI_CARKIT_INT_EN_CARINTDET BIT(2)
#define ULPI_CARKIT_INT_EN_DP_RISE BIT(3)
#define ULPI_CARKIT_INT_EN_DP_FALL BIT(4)
/* Carkit Interrupt Status and
* Carkit Interrupt Latch
*/
#define ULPI_CARKIT_INT_IDFLOAT BIT(0)
#define ULPI_CARKIT_INT_CARINTDET BIT(1)
#define ULPI_CARKIT_INT_DP BIT(2)
/* Carkit Pulse Control*/
#define ULPI_CARKIT_PLS_CTRL_TXPLSEN BIT(0)
#define ULPI_CARKIT_PLS_CTRL_RXPLSEN BIT(1)
#define ULPI_CARKIT_PLS_CTRL_SPKRLEFT_BIASEN BIT(2)
#define ULPI_CARKIT_PLS_CTRL_SPKRRIGHT_BIASEN BIT(3)
#endif /* __LINUX_ULPI_REGS_H */