linux-stable/drivers/pcmcia/yenta_socket.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

136 lines
4.8 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __YENTA_H
#define __YENTA_H
#include <asm/io.h>
#define CB_SOCKET_EVENT 0x00
#define CB_CSTSEVENT 0x00000001 /* Card status event */
#define CB_CD1EVENT 0x00000002 /* Card detect 1 change event */
#define CB_CD2EVENT 0x00000004 /* Card detect 2 change event */
#define CB_PWREVENT 0x00000008 /* PWRCYCLE change event */
#define CB_SOCKET_MASK 0x04
#define CB_CSTSMASK 0x00000001 /* Card status mask */
#define CB_CDMASK 0x00000006 /* Card detect 1&2 mask */
#define CB_PWRMASK 0x00000008 /* PWRCYCLE change mask */
#define CB_SOCKET_STATE 0x08
#define CB_CARDSTS 0x00000001 /* CSTSCHG status */
#define CB_CDETECT1 0x00000002 /* Card detect status 1 */
#define CB_CDETECT2 0x00000004 /* Card detect status 2 */
#define CB_PWRCYCLE 0x00000008 /* Socket powered */
#define CB_16BITCARD 0x00000010 /* 16-bit card detected */
#define CB_CBCARD 0x00000020 /* CardBus card detected */
#define CB_IREQCINT 0x00000040 /* READY(xIRQ)/xCINT high */
#define CB_NOTACARD 0x00000080 /* Unrecognizable PC card detected */
#define CB_DATALOST 0x00000100 /* Potential data loss due to card removal */
#define CB_BADVCCREQ 0x00000200 /* Invalid Vcc request by host software */
#define CB_5VCARD 0x00000400 /* Card Vcc at 5.0 volts? */
#define CB_3VCARD 0x00000800 /* Card Vcc at 3.3 volts? */
#define CB_XVCARD 0x00001000 /* Card Vcc at X.X volts? */
#define CB_YVCARD 0x00002000 /* Card Vcc at Y.Y volts? */
#define CB_5VSOCKET 0x10000000 /* Socket Vcc at 5.0 volts? */
#define CB_3VSOCKET 0x20000000 /* Socket Vcc at 3.3 volts? */
#define CB_XVSOCKET 0x40000000 /* Socket Vcc at X.X volts? */
#define CB_YVSOCKET 0x80000000 /* Socket Vcc at Y.Y volts? */
#define CB_SOCKET_FORCE 0x0C
#define CB_FCARDSTS 0x00000001 /* Force CSTSCHG */
#define CB_FCDETECT1 0x00000002 /* Force CD1EVENT */
#define CB_FCDETECT2 0x00000004 /* Force CD2EVENT */
#define CB_FPWRCYCLE 0x00000008 /* Force PWREVENT */
#define CB_F16BITCARD 0x00000010 /* Force 16-bit PCMCIA card */
#define CB_FCBCARD 0x00000020 /* Force CardBus line */
#define CB_FNOTACARD 0x00000080 /* Force NOTACARD */
#define CB_FDATALOST 0x00000100 /* Force data lost */
#define CB_FBADVCCREQ 0x00000200 /* Force bad Vcc request */
#define CB_F5VCARD 0x00000400 /* Force 5.0 volt card */
#define CB_F3VCARD 0x00000800 /* Force 3.3 volt card */
#define CB_FXVCARD 0x00001000 /* Force X.X volt card */
#define CB_FYVCARD 0x00002000 /* Force Y.Y volt card */
#define CB_CVSTEST 0x00004000 /* Card VS test */
#define CB_SOCKET_CONTROL 0x10
#define CB_SC_VPP_MASK 0x00000007
#define CB_SC_VPP_OFF 0x00000000
#define CB_SC_VPP_12V 0x00000001
#define CB_SC_VPP_5V 0x00000002
#define CB_SC_VPP_3V 0x00000003
#define CB_SC_VPP_XV 0x00000004
#define CB_SC_VPP_YV 0x00000005
#define CB_SC_VCC_MASK 0x00000070
#define CB_SC_VCC_OFF 0x00000000
#define CB_SC_VCC_5V 0x00000020
#define CB_SC_VCC_3V 0x00000030
#define CB_SC_VCC_XV 0x00000040
#define CB_SC_VCC_YV 0x00000050
#define CB_SC_CCLK_STOP 0x00000080
#define CB_SOCKET_POWER 0x20
#define CB_SKTACCES 0x02000000 /* A PC card access has occurred (clear on read) */
#define CB_SKTMODE 0x01000000 /* Clock frequency has changed (clear on read) */
#define CB_CLKCTRLEN 0x00010000 /* Clock control enabled (RW) */
#define CB_CLKCTRL 0x00000001 /* Stop(0) or slow(1) CB clock (RW) */
/*
* Cardbus configuration space
*/
#define CB_BRIDGE_BASE(m) (0x1c + 8*(m))
#define CB_BRIDGE_LIMIT(m) (0x20 + 8*(m))
#define CB_BRIDGE_CONTROL 0x3e
#define CB_BRIDGE_CPERREN 0x00000001
#define CB_BRIDGE_CSERREN 0x00000002
#define CB_BRIDGE_ISAEN 0x00000004
#define CB_BRIDGE_VGAEN 0x00000008
#define CB_BRIDGE_MABTMODE 0x00000020
#define CB_BRIDGE_CRST 0x00000040
#define CB_BRIDGE_INTR 0x00000080
#define CB_BRIDGE_PREFETCH0 0x00000100
#define CB_BRIDGE_PREFETCH1 0x00000200
#define CB_BRIDGE_POSTEN 0x00000400
#define CB_LEGACY_MODE_BASE 0x44
/*
* ExCA area extensions in Yenta
*/
#define CB_MEM_PAGE(map) (0x40 + (map))
/* control how 16bit cards are powered */
#define YENTA_16BIT_POWER_EXCA 0x00000001
#define YENTA_16BIT_POWER_DF 0x00000002
struct yenta_socket;
struct cardbus_type {
int (*override)(struct yenta_socket *);
void (*save_state)(struct yenta_socket *);
void (*restore_state)(struct yenta_socket *);
int (*sock_init)(struct yenta_socket *);
};
struct yenta_socket {
struct pci_dev *dev;
int cb_irq, io_irq;
void __iomem *base;
struct timer_list poll_timer;
struct pcmcia_socket socket;
struct cardbus_type *type;
u32 flags;
/* for PCI interrupt probing */
unsigned int probe_status;
/* A few words of private data for special stuff of overrides... */
unsigned int private[8];
/* PCI saved state */
u32 saved_state[2];
};
#endif