linux/drivers/net/ethernet/seeq/sgiseeq.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

105 lines
4.5 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* sgiseeq.h: Defines for the Seeq8003 ethernet controller.
*
* Copyright (C) 1996 David S. Miller (davem@davemloft.net)
*/
#ifndef _SGISEEQ_H
#define _SGISEEQ_H
struct sgiseeq_wregs {
volatile unsigned int multicase_high[2];
volatile unsigned int frame_gap;
volatile unsigned int control;
};
struct sgiseeq_rregs {
volatile unsigned int collision_tx[2];
volatile unsigned int collision_all[2];
volatile unsigned int _unused0;
volatile unsigned int rflags;
};
struct sgiseeq_regs {
union {
volatile unsigned int eth_addr[6];
volatile unsigned int multicast_low[6];
struct sgiseeq_wregs wregs;
struct sgiseeq_rregs rregs;
} rw;
volatile unsigned int rstat;
volatile unsigned int tstat;
};
/* Seeq8003 receive status register */
#define SEEQ_RSTAT_OVERF 0x001 /* Overflow */
#define SEEQ_RSTAT_CERROR 0x002 /* CRC error */
#define SEEQ_RSTAT_DERROR 0x004 /* Dribble error */
#define SEEQ_RSTAT_SFRAME 0x008 /* Short frame */
#define SEEQ_RSTAT_REOF 0x010 /* Received end of frame */
#define SEEQ_RSTAT_FIG 0x020 /* Frame is good */
#define SEEQ_RSTAT_TIMEO 0x040 /* Timeout, or late receive */
#define SEEQ_RSTAT_WHICH 0x080 /* Which status, 1=old 0=new */
#define SEEQ_RSTAT_LITTLE 0x100 /* DMA is done in little endian format */
#define SEEQ_RSTAT_SDMA 0x200 /* DMA has started */
#define SEEQ_RSTAT_ADMA 0x400 /* DMA is active */
#define SEEQ_RSTAT_ROVERF 0x800 /* Receive buffer overflow */
/* Seeq8003 receive command register */
#define SEEQ_RCMD_RDISAB 0x000 /* Disable receiver on the Seeq8003 */
#define SEEQ_RCMD_IOVERF 0x001 /* IRQ on buffer overflows */
#define SEEQ_RCMD_ICRC 0x002 /* IRQ on CRC errors */
#define SEEQ_RCMD_IDRIB 0x004 /* IRQ on dribble errors */
#define SEEQ_RCMD_ISHORT 0x008 /* IRQ on short frames */
#define SEEQ_RCMD_IEOF 0x010 /* IRQ on end of frame */
#define SEEQ_RCMD_IGOOD 0x020 /* IRQ on good frames */
#define SEEQ_RCMD_RANY 0x040 /* Receive any frame */
#define SEEQ_RCMD_RBCAST 0x080 /* Receive broadcasts */
#define SEEQ_RCMD_RBMCAST 0x0c0 /* Receive broadcasts/multicasts */
/* Seeq8003 transmit status register */
#define SEEQ_TSTAT_UFLOW 0x001 /* Transmit buffer underflow */
#define SEEQ_TSTAT_CLS 0x002 /* Collision detected */
#define SEEQ_TSTAT_R16 0x004 /* Did 16 retries to tx a frame */
#define SEEQ_TSTAT_PTRANS 0x008 /* Packet was transmitted ok */
#define SEEQ_TSTAT_LCLS 0x010 /* Late collision occurred */
#define SEEQ_TSTAT_WHICH 0x080 /* Which status, 1=old 0=new */
#define SEEQ_TSTAT_TLE 0x100 /* DMA is done in little endian format */
#define SEEQ_TSTAT_SDMA 0x200 /* DMA has started */
#define SEEQ_TSTAT_ADMA 0x400 /* DMA is active */
/* Seeq8003 transmit command register */
#define SEEQ_TCMD_RB0 0x00 /* Register bank zero w/station addr */
#define SEEQ_TCMD_IUF 0x01 /* IRQ on tx underflow */
#define SEEQ_TCMD_IC 0x02 /* IRQ on collisions */
#define SEEQ_TCMD_I16 0x04 /* IRQ after 16 failed attempts to tx frame */
#define SEEQ_TCMD_IPT 0x08 /* IRQ when packet successfully transmitted */
#define SEEQ_TCMD_RB1 0x20 /* Register bank one w/multi-cast low byte */
#define SEEQ_TCMD_RB2 0x40 /* Register bank two w/multi-cast high byte */
/* Seeq8003 control register */
#define SEEQ_CTRL_XCNT 0x01
#define SEEQ_CTRL_ACCNT 0x02
#define SEEQ_CTRL_SFLAG 0x04
#define SEEQ_CTRL_EMULTI 0x08
#define SEEQ_CTRL_ESHORT 0x10
#define SEEQ_CTRL_ENCARR 0x20
/* Seeq8003 control registers on the SGI Hollywood HPC. */
#define SEEQ_HPIO_P1BITS 0x00000001 /* cycles to stay in P1 phase for PIO */
#define SEEQ_HPIO_P2BITS 0x00000060 /* cycles to stay in P2 phase for PIO */
#define SEEQ_HPIO_P3BITS 0x00000100 /* cycles to stay in P3 phase for PIO */
#define SEEQ_HDMA_D1BITS 0x00000006 /* cycles to stay in D1 phase for DMA */
#define SEEQ_HDMA_D2BITS 0x00000020 /* cycles to stay in D2 phase for DMA */
#define SEEQ_HDMA_D3BITS 0x00000000 /* cycles to stay in D3 phase for DMA */
#define SEEQ_HDMA_TIMEO 0x00030000 /* cycles for DMA timeout */
#define SEEQ_HCTL_NORM 0x00000000 /* Normal operation mode */
#define SEEQ_HCTL_RESET 0x00000001 /* Reset Seeq8003 and HPC interface */
#define SEEQ_HCTL_IPEND 0x00000002 /* IRQ is pending for the chip */
#define SEEQ_HCTL_IPG 0x00001000 /* Inter-packet gap */
#define SEEQ_HCTL_RFIX 0x00002000 /* At rxdc, clear end-of-packet */
#define SEEQ_HCTL_EFIX 0x00004000 /* fixes intr status bit settings */
#define SEEQ_HCTL_IFIX 0x00008000 /* enable startup timeouts */
#endif /* !(_SGISEEQ_H) */