mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-05 10:29:37 +00:00
Code Issues Releases Wiki Activity
linux-stable/drivers/net/wireless/broadcom/b43legacy/dma.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

232 lines
6.7 KiB
C
Raw Blame History

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef B43legacy_DMA_H_
#define B43legacy_DMA_H_
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/linkage.h>
#include <linux/atomic.h>
#include "b43legacy.h"
/* DMA-Interrupt reasons. */
#define B43legacy_DMAIRQ_FATALMASK ((1 << 10) | (1 << 11) | (1 << 12) \
| (1 << 14) | (1 << 15))
#define B43legacy_DMAIRQ_NONFATALMASK (1 << 13)
#define B43legacy_DMAIRQ_RX_DONE (1 << 16)
/*** 32-bit DMA Engine. ***/
/* 32-bit DMA controller registers. */
#define B43legacy_DMA32_TXCTL 0x00
#define B43legacy_DMA32_TXENABLE 0x00000001
#define B43legacy_DMA32_TXSUSPEND 0x00000002
#define B43legacy_DMA32_TXLOOPBACK 0x00000004
#define B43legacy_DMA32_TXFLUSH 0x00000010
#define B43legacy_DMA32_TXADDREXT_MASK 0x00030000
#define B43legacy_DMA32_TXADDREXT_SHIFT 16
#define B43legacy_DMA32_TXRING 0x04
#define B43legacy_DMA32_TXINDEX 0x08
#define B43legacy_DMA32_TXSTATUS 0x0C
#define B43legacy_DMA32_TXDPTR 0x00000FFF
#define B43legacy_DMA32_TXSTATE 0x0000F000
#define B43legacy_DMA32_TXSTAT_DISABLED 0x00000000
#define B43legacy_DMA32_TXSTAT_ACTIVE 0x00001000
#define B43legacy_DMA32_TXSTAT_IDLEWAIT 0x00002000
#define B43legacy_DMA32_TXSTAT_STOPPED 0x00003000
#define B43legacy_DMA32_TXSTAT_SUSP 0x00004000
#define B43legacy_DMA32_TXERROR 0x000F0000
#define B43legacy_DMA32_TXERR_NOERR 0x00000000
#define B43legacy_DMA32_TXERR_PROT 0x00010000
#define B43legacy_DMA32_TXERR_UNDERRUN 0x00020000
#define B43legacy_DMA32_TXERR_BUFREAD 0x00030000
#define B43legacy_DMA32_TXERR_DESCREAD 0x00040000
#define B43legacy_DMA32_TXACTIVE 0xFFF00000
#define B43legacy_DMA32_RXCTL 0x10
#define B43legacy_DMA32_RXENABLE 0x00000001
#define B43legacy_DMA32_RXFROFF_MASK 0x000000FE
#define B43legacy_DMA32_RXFROFF_SHIFT 1
#define B43legacy_DMA32_RXDIRECTFIFO 0x00000100
#define B43legacy_DMA32_RXADDREXT_MASK 0x00030000
#define B43legacy_DMA32_RXADDREXT_SHIFT 16
#define B43legacy_DMA32_RXRING 0x14
#define B43legacy_DMA32_RXINDEX 0x18
#define B43legacy_DMA32_RXSTATUS 0x1C
#define B43legacy_DMA32_RXDPTR 0x00000FFF
#define B43legacy_DMA32_RXSTATE 0x0000F000
#define B43legacy_DMA32_RXSTAT_DISABLED 0x00000000
#define B43legacy_DMA32_RXSTAT_ACTIVE 0x00001000
#define B43legacy_DMA32_RXSTAT_IDLEWAIT 0x00002000
#define B43legacy_DMA32_RXSTAT_STOPPED 0x00003000
#define B43legacy_DMA32_RXERROR 0x000F0000
#define B43legacy_DMA32_RXERR_NOERR 0x00000000
#define B43legacy_DMA32_RXERR_PROT 0x00010000
#define B43legacy_DMA32_RXERR_OVERFLOW 0x00020000
#define B43legacy_DMA32_RXERR_BUFWRITE 0x00030000
#define B43legacy_DMA32_RXERR_DESCREAD 0x00040000
#define B43legacy_DMA32_RXACTIVE 0xFFF00000
/* 32-bit DMA descriptor. */
struct b43legacy_dmadesc32 {
__le32 control;
__le32 address;
} __packed;
#define B43legacy_DMA32_DCTL_BYTECNT 0x00001FFF
#define B43legacy_DMA32_DCTL_ADDREXT_MASK 0x00030000
#define B43legacy_DMA32_DCTL_ADDREXT_SHIFT 16
#define B43legacy_DMA32_DCTL_DTABLEEND 0x10000000
#define B43legacy_DMA32_DCTL_IRQ 0x20000000
#define B43legacy_DMA32_DCTL_FRAMEEND 0x40000000
#define B43legacy_DMA32_DCTL_FRAMESTART 0x80000000
/* Misc DMA constants */
#define B43legacy_DMA_RINGMEMSIZE PAGE_SIZE
#define B43legacy_DMA0_RX_FRAMEOFFSET 30
#define B43legacy_DMA3_RX_FRAMEOFFSET 0
/* DMA engine tuning knobs */
#define B43legacy_TXRING_SLOTS 128
#define B43legacy_RXRING_SLOTS 64
#define B43legacy_DMA0_RX_BUFFERSIZE (2304 + 100)
#define B43legacy_DMA3_RX_BUFFERSIZE 16
#ifdef CONFIG_B43LEGACY_DMA
struct sk_buff;
struct b43legacy_private;
struct b43legacy_txstatus;
struct b43legacy_dmadesc_meta {
/* The kernel DMA-able buffer. */
struct sk_buff *skb;
/* DMA base bus-address of the descriptor buffer. */
dma_addr_t dmaaddr;
/* ieee80211 TX status. Only used once per 802.11 frag. */
bool is_last_fragment;
};
enum b43legacy_dmatype {
B43legacy_DMA_30BIT = 30,
B43legacy_DMA_32BIT = 32,
};
struct b43legacy_dmaring {
/* Kernel virtual base address of the ring memory. */
void *descbase;
/* Meta data about all descriptors. */
struct b43legacy_dmadesc_meta *meta;
/* Cache of TX headers for each slot.
* This is to avoid an allocation on each TX.
* This is NULL for an RX ring.
*/
u8 *txhdr_cache;
/* (Unadjusted) DMA base bus-address of the ring memory. */
dma_addr_t dmabase;
/* Number of descriptor slots in the ring. */
int nr_slots;
/* Number of used descriptor slots. */
int used_slots;
/* Currently used slot in the ring. */
int current_slot;
/* Frameoffset in octets. */
u32 frameoffset;
/* Descriptor buffer size. */
u16 rx_buffersize;
/* The MMIO base register of the DMA controller. */
u16 mmio_base;
/* DMA controller index number (0-5). */
int index;
/* Boolean. Is this a TX ring? */
bool tx;
/* The type of DMA engine used. */
enum b43legacy_dmatype type;
/* Boolean. Is this ring stopped at ieee80211 level? */
bool stopped;
/* The QOS priority assigned to this ring. Only used for TX rings.
* This is the mac80211 "queue" value. */
u8 queue_prio;
struct b43legacy_wldev *dev;
#ifdef CONFIG_B43LEGACY_DEBUG
/* Maximum number of used slots. */
int max_used_slots;
/* Last time we injected a ring overflow. */
unsigned long last_injected_overflow;
#endif /* CONFIG_B43LEGACY_DEBUG*/
};
static inline
u32 b43legacy_dma_read(struct b43legacy_dmaring *ring,
u16 offset)
{
return b43legacy_read32(ring->dev, ring->mmio_base + offset);
}
static inline
void b43legacy_dma_write(struct b43legacy_dmaring *ring,
u16 offset, u32 value)
{
b43legacy_write32(ring->dev, ring->mmio_base + offset, value);
}
int b43legacy_dma_init(struct b43legacy_wldev *dev);
void b43legacy_dma_free(struct b43legacy_wldev *dev);
void b43legacy_dma_tx_suspend(struct b43legacy_wldev *dev);
void b43legacy_dma_tx_resume(struct b43legacy_wldev *dev);
int b43legacy_dma_tx(struct b43legacy_wldev *dev,
struct sk_buff *skb);
void b43legacy_dma_handle_txstatus(struct b43legacy_wldev *dev,
const struct b43legacy_txstatus *status);
void b43legacy_dma_rx(struct b43legacy_dmaring *ring);
#else /* CONFIG_B43LEGACY_DMA */
static inline
int b43legacy_dma_init(struct b43legacy_wldev *dev)
{
return 0;
}
static inline
void b43legacy_dma_free(struct b43legacy_wldev *dev)
{
}
static inline
int b43legacy_dma_tx(struct b43legacy_wldev *dev,
struct sk_buff *skb)
{
return 0;
}
static inline
void b43legacy_dma_handle_txstatus(struct b43legacy_wldev *dev,
const struct b43legacy_txstatus *status)
{
}
static inline
void b43legacy_dma_rx(struct b43legacy_dmaring *ring)
{
}
static inline
void b43legacy_dma_tx_suspend(struct b43legacy_wldev *dev)
{
}
static inline
void b43legacy_dma_tx_resume(struct b43legacy_wldev *dev)
{
}
#endif /* CONFIG_B43LEGACY_DMA */
#endif /* B43legacy_DMA_H_ */
Reference in a new issue View git blame Copy permalink