2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-26 22:24:09 +08:00
linux-next/drivers/atm/idt77105.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

93 lines
3.8 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/* drivers/atm/idt77105.h - IDT77105 (PHY) declarations */
/* Written 1999 by Greg Banks, NEC Australia <gnb@linuxfan.com>. Based on suni.h */
#ifndef DRIVER_ATM_IDT77105_H
#define DRIVER_ATM_IDT77105_H
#include <linux/atmdev.h>
#include <linux/atmioc.h>
/* IDT77105 registers */
#define IDT77105_MCR 0x0 /* Master Control Register */
#define IDT77105_ISTAT 0x1 /* Interrupt Status */
#define IDT77105_DIAG 0x2 /* Diagnostic Control */
#define IDT77105_LEDHEC 0x3 /* LED Driver & HEC Status/Control */
#define IDT77105_CTRLO 0x4 /* Low Byte Counter Register */
#define IDT77105_CTRHI 0x5 /* High Byte Counter Register */
#define IDT77105_CTRSEL 0x6 /* Counter Register Read Select */
/* IDT77105 register values */
/* MCR */
#define IDT77105_MCR_UPLO 0x80 /* R/W, User Prog'le Output Latch */
#define IDT77105_MCR_DREC 0x40 /* R/W, Discard Receive Error Cells */
#define IDT77105_MCR_ECEIO 0x20 /* R/W, Enable Cell Error Interrupts
* Only */
#define IDT77105_MCR_TDPC 0x10 /* R/W, Transmit Data Parity Check */
#define IDT77105_MCR_DRIC 0x08 /* R/W, Discard Received Idle Cells */
#define IDT77105_MCR_HALTTX 0x04 /* R/W, Halt Tx */
#define IDT77105_MCR_UMODE 0x02 /* R/W, Utopia (cell/byte) Mode */
#define IDT77105_MCR_EIP 0x01 /* R/W, Enable Interrupt Pin */
/* ISTAT */
#define IDT77105_ISTAT_GOODSIG 0x40 /* R, Good Signal Bit */
#define IDT77105_ISTAT_HECERR 0x20 /* sticky, HEC Error*/
#define IDT77105_ISTAT_SCR 0x10 /* sticky, Short Cell Received */
#define IDT77105_ISTAT_TPE 0x08 /* sticky, Transmit Parity Error */
#define IDT77105_ISTAT_RSCC 0x04 /* sticky, Rx Signal Condition Change */
#define IDT77105_ISTAT_RSE 0x02 /* sticky, Rx Symbol Error */
#define IDT77105_ISTAT_RFO 0x01 /* sticky, Rx FIFO Overrun */
/* DIAG */
#define IDT77105_DIAG_FTD 0x80 /* R/W, Force TxClav deassert */
#define IDT77105_DIAG_ROS 0x40 /* R/W, RxClav operation select */
#define IDT77105_DIAG_MPCS 0x20 /* R/W, Multi-PHY config'n select */
#define IDT77105_DIAG_RFLUSH 0x10 /* R/W, clear receive FIFO */
#define IDT77105_DIAG_ITPE 0x08 /* R/W, Insert Tx payload error */
#define IDT77105_DIAG_ITHE 0x04 /* R/W, Insert Tx HEC error */
#define IDT77105_DIAG_UMODE 0x02 /* R/W, Utopia (cell/byte) Mode */
#define IDT77105_DIAG_LCMASK 0x03 /* R/W, Loopback Control */
#define IDT77105_DIAG_LC_NORMAL 0x00 /* Receive from network */
#define IDT77105_DIAG_LC_PHY_LOOPBACK 0x02
#define IDT77105_DIAG_LC_LINE_LOOPBACK 0x03
/* LEDHEC */
#define IDT77105_LEDHEC_DRHC 0x40 /* R/W, Disable Rx HEC check */
#define IDT77105_LEDHEC_DTHC 0x20 /* R/W, Disable Tx HEC calculation */
#define IDT77105_LEDHEC_RPWMASK 0x18 /* R/W, RxRef pulse width select */
#define IDT77105_LEDHEC_TFS 0x04 /* R, Tx FIFO Status (1=empty) */
#define IDT77105_LEDHEC_TLS 0x02 /* R, Tx LED Status (1=lit) */
#define IDT77105_LEDHEC_RLS 0x01 /* R, Rx LED Status (1=lit) */
#define IDT77105_LEDHEC_RPW_1 0x00 /* RxRef active for 1 RxClk cycle */
#define IDT77105_LEDHEC_RPW_2 0x08 /* RxRef active for 2 RxClk cycle */
#define IDT77105_LEDHEC_RPW_4 0x10 /* RxRef active for 4 RxClk cycle */
#define IDT77105_LEDHEC_RPW_8 0x18 /* RxRef active for 8 RxClk cycle */
/* CTRSEL */
#define IDT77105_CTRSEL_SEC 0x08 /* W, Symbol Error Counter */
#define IDT77105_CTRSEL_TCC 0x04 /* W, Tx Cell Counter */
#define IDT77105_CTRSEL_RCC 0x02 /* W, Rx Cell Counter */
#define IDT77105_CTRSEL_RHEC 0x01 /* W, Rx HEC Error Counter */
#ifdef __KERNEL__
int idt77105_init(struct atm_dev *dev);
#endif
/*
* Tunable parameters
*/
/* Time between samples of the hardware cell counters. Should be <= 1 sec */
#define IDT77105_STATS_TIMER_PERIOD (HZ)
/* Time between checks to see if the signal has been found again */
#define IDT77105_RESTART_TIMER_PERIOD (5 * HZ)
#endif