linux-stable/arch/m68k/include/asm/mcfwdebug.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

119 lines
5 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/****************************************************************************/
/*
* mcfdebug.h -- ColdFire Debug Module support.
*
* (C) Copyright 2001, Lineo Inc. (www.lineo.com)
*/
/****************************************************************************/
#ifndef mcfdebug_h
#define mcfdebug_h
/****************************************************************************/
/* Define the debug module registers */
#define MCFDEBUG_CSR 0x0 /* Configuration status */
#define MCFDEBUG_BAAR 0x5 /* BDM address attribute */
#define MCFDEBUG_AATR 0x6 /* Address attribute trigger */
#define MCFDEBUG_TDR 0x7 /* Trigger definition */
#define MCFDEBUG_PBR 0x8 /* PC breakpoint */
#define MCFDEBUG_PBMR 0x9 /* PC breakpoint mask */
#define MCFDEBUG_ABHR 0xc /* High address breakpoint */
#define MCFDEBUG_ABLR 0xd /* Low address breakpoint */
#define MCFDEBUG_DBR 0xe /* Data breakpoint */
#define MCFDEBUG_DBMR 0xf /* Data breakpoint mask */
/* Define some handy constants for the trigger definition register */
#define MCFDEBUG_TDR_TRC_DISP 0x00000000 /* display on DDATA only */
#define MCFDEBUG_TDR_TRC_HALT 0x40000000 /* Processor halt on BP */
#define MCFDEBUG_TDR_TRC_INTR 0x80000000 /* Debug intr on BP */
#define MCFDEBUG_TDR_LXT1 0x00004000 /* TDR level 1 */
#define MCFDEBUG_TDR_LXT2 0x00008000 /* TDR level 2 */
#define MCFDEBUG_TDR_EBL1 0x00002000 /* Enable breakpoint level 1 */
#define MCFDEBUG_TDR_EBL2 0x20000000 /* Enable breakpoint level 2 */
#define MCFDEBUG_TDR_EDLW1 0x00001000 /* Enable data BP longword */
#define MCFDEBUG_TDR_EDLW2 0x10000000
#define MCFDEBUG_TDR_EDWL1 0x00000800 /* Enable data BP lower word */
#define MCFDEBUG_TDR_EDWL2 0x08000000
#define MCFDEBUG_TDR_EDWU1 0x00000400 /* Enable data BP upper word */
#define MCFDEBUG_TDR_EDWU2 0x04000000
#define MCFDEBUG_TDR_EDLL1 0x00000200 /* Enable data BP low low byte */
#define MCFDEBUG_TDR_EDLL2 0x02000000
#define MCFDEBUG_TDR_EDLM1 0x00000100 /* Enable data BP low mid byte */
#define MCFDEBUG_TDR_EDLM2 0x01000000
#define MCFDEBUG_TDR_EDUM1 0x00000080 /* Enable data BP up mid byte */
#define MCFDEBUG_TDR_EDUM2 0x00800000
#define MCFDEBUG_TDR_EDUU1 0x00000040 /* Enable data BP up up byte */
#define MCFDEBUG_TDR_EDUU2 0x00400000
#define MCFDEBUG_TDR_DI1 0x00000020 /* Data BP invert */
#define MCFDEBUG_TDR_DI2 0x00200000
#define MCFDEBUG_TDR_EAI1 0x00000010 /* Enable address BP inverted */
#define MCFDEBUG_TDR_EAI2 0x00100000
#define MCFDEBUG_TDR_EAR1 0x00000008 /* Enable address BP range */
#define MCFDEBUG_TDR_EAR2 0x00080000
#define MCFDEBUG_TDR_EAL1 0x00000004 /* Enable address BP low */
#define MCFDEBUG_TDR_EAL2 0x00040000
#define MCFDEBUG_TDR_EPC1 0x00000002 /* Enable PC BP */
#define MCFDEBUG_TDR_EPC2 0x00020000
#define MCFDEBUG_TDR_PCI1 0x00000001 /* PC BP invert */
#define MCFDEBUG_TDR_PCI2 0x00010000
/* Constants for the address attribute trigger register */
#define MCFDEBUG_AAR_RESET 0x00000005
/* Fields not yet implemented */
/* And some definitions for the writable sections of the CSR */
#define MCFDEBUG_CSR_RESET 0x00100000
#define MCFDEBUG_CSR_PSTCLK 0x00020000 /* PSTCLK disable */
#define MCFDEBUG_CSR_IPW 0x00010000 /* Inhibit processor writes */
#define MCFDEBUG_CSR_MAP 0x00008000 /* Processor refs in emul mode */
#define MCFDEBUG_CSR_TRC 0x00004000 /* Emul mode on trace exception */
#define MCFDEBUG_CSR_EMU 0x00002000 /* Force emulation mode */
#define MCFDEBUG_CSR_DDC_READ 0x00000800 /* Debug data control */
#define MCFDEBUG_CSR_DDC_WRITE 0x00001000
#define MCFDEBUG_CSR_UHE 0x00000400 /* User mode halt enable */
#define MCFDEBUG_CSR_BTB0 0x00000000 /* Branch target 0 bytes */
#define MCFDEBUG_CSR_BTB2 0x00000100 /* Branch target 2 bytes */
#define MCFDEBUG_CSR_BTB3 0x00000200 /* Branch target 3 bytes */
#define MCFDEBUG_CSR_BTB4 0x00000300 /* Branch target 4 bytes */
#define MCFDEBUG_CSR_NPL 0x00000040 /* Non-pipelined mode */
#define MCFDEBUG_CSR_SSM 0x00000010 /* Single step mode */
/* Constants for the BDM address attribute register */
#define MCFDEBUG_BAAR_RESET 0x00000005
/* Fields not yet implemented */
/* This routine wrappers up the wdebug asm instruction so that the register
* and value can be relatively easily specified. The biggest hassle here is
* that the debug module instructions (2 longs) must be long word aligned and
* some pointer fiddling is performed to ensure this.
*/
static inline void wdebug(int reg, unsigned long data) {
unsigned short dbg_spc[6];
unsigned short *dbg;
// Force alignment to long word boundary
dbg = (unsigned short *)((((unsigned long)dbg_spc) + 3) & 0xfffffffc);
// Build up the debug instruction
dbg[0] = 0x2c80 | (reg & 0xf);
dbg[1] = (data >> 16) & 0xffff;
dbg[2] = data & 0xffff;
dbg[3] = 0;
// Perform the wdebug instruction
#if 0
// This strain is for gas which doesn't have the wdebug instructions defined
asm( "move.l %0, %%a0\n\t"
".word 0xfbd0\n\t"
".word 0x0003\n\t"
:: "g" (dbg) : "a0");
#else
// And this is for when it does
asm( "wdebug (%0)" :: "a" (dbg));
#endif
}
#endif