kernel_optimize_test/drivers/scsi/wd719x.h

249 lines
9.5 KiB
C
Raw Normal View History

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-01 22:07:57 +08:00
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _WD719X_H_
#define _WD719X_H_
#define WD719X_SG 255 /* Scatter/gather size */
struct wd719x_sglist {
__le32 ptr;
__le32 length;
} __packed;
enum wd719x_card_type {
WD719X_TYPE_UNKNOWN = 0,
WD719X_TYPE_7193,
WD719X_TYPE_7197,
WD719X_TYPE_7296,
};
union wd719x_regs {
__le32 all; /* All Status at once */
struct {
u8 OPC; /* Opcode register */
u8 SCSI; /* SCSI Errors */
u8 SUE; /* Spider unique Errors */
u8 INT; /* Interrupt Status */
} bytes;
};
/* Spider Command Block (SCB) */
struct wd719x_scb {
__le32 Int_SCB; /* 00-03 Internal SCB link pointer (must be cleared) */
u8 SCB_opcode; /* 04 SCB Command opcode */
u8 CDB_tag; /* 05 SCSI Tag byte for CDB queues (0 if untagged) */
u8 lun; /* 06 SCSI LUN */
u8 devid; /* 07 SCSI Device ID */
u8 CDB[16]; /* 08-23 SCSI CDB (16 bytes as defined by ANSI spec. */
__le32 data_p; /* 24-27 Data transfer address (or SG list address) */
__le32 data_length; /* 28-31 Data transfer Length (or SG list length) */
__le32 CDB_link; /* 32-35 SCSI CDB Link Ptr */
__le32 sense_buf; /* 36-39 Auto request sense buffer address */
u8 sense_buf_length;/* 40 Auto request sense transfer length */
u8 reserved; /* 41 reserved */
u8 SCB_options; /* 42 SCB-options */
u8 SCB_tag_msg; /* 43 Tagged messages options */
/* Not filled in by host */
__le32 req_ptr; /* 44-47 Ptr to Host Request returned on interrupt */
u8 host_opcode; /* 48 Host Command Opcode (same as AMR_00) */
u8 scsi_stat; /* 49 SCSI Status returned */
u8 ret_error; /* 50 SPIDER Unique Error Code returned (SUE) */
u8 int_stat; /* 51 Message u8 / Interrupt Status byte returned */
__le32 transferred; /* 52-55 Bytes Transferred */
u8 last_trans[3]; /* 56-58 Bytes Transferred in last session */
u8 length; /* 59 SCSI Messages Length (1-8) */
u8 sync_offset; /* 60 Synchronous offset */
u8 sync_rate; /* 61 Synchronous rate */
u8 flags[2]; /* 62-63 SCB specific flags (local to each thread) */
/* everything below is for driver use (not used by card) */
dma_addr_t phys; /* bus address of the SCB */
struct scsi_cmnd *cmd; /* a copy of the pointer we were passed */
struct list_head list;
struct wd719x_sglist sg_list[WD719X_SG] __aligned(8); /* SG list */
} __packed;
struct wd719x {
struct Scsi_Host *sh; /* pointer to host structure */
struct pci_dev *pdev;
void __iomem *base;
enum wd719x_card_type type; /* type of card */
void *fw_virt; /* firmware buffer CPU address */
dma_addr_t fw_phys; /* firmware buffer bus address */
size_t fw_size; /* firmware buffer size */
struct wd719x_host_param *params; /* host parameters (EEPROM) */
dma_addr_t params_phys; /* host parameters bus address */
void *hash_virt; /* hash table CPU address */
dma_addr_t hash_phys; /* hash table bus address */
struct list_head active_scbs;
struct list_head free_scbs;
};
/* timeout delays in microsecs */
#define WD719X_WAIT_FOR_CMD_READY 500
#define WD719X_WAIT_FOR_RISC 2000
#define WD719X_WAIT_FOR_SCSI_RESET 3000000
/* All commands except 0x00 generate an interrupt */
#define WD719X_CMD_READY 0x00 /* Command register ready (or noop) */
#define WD719X_CMD_INIT_RISC 0x01 /* Initialize RISC */
/* 0x02 is reserved */
#define WD719X_CMD_BUSRESET 0x03 /* Assert SCSI bus reset */
#define WD719X_CMD_READ_FIRMVER 0x04 /* Read the Firmware Revision */
#define WD719X_CMD_ECHO_BYTES 0x05 /* Echo command bytes (DW) */
/* 0x06 is reserved */
/* 0x07 is reserved */
#define WD719X_CMD_GET_PARAM 0x08 /* Get programmable parameters */
#define WD719X_CMD_SET_PARAM 0x09 /* Set programmable parameters */
#define WD719X_CMD_SLEEP 0x0a /* Put SPIDER to sleep */
#define WD719X_CMD_READ_INIT 0x0b /* Read initialization parameters */
#define WD719X_CMD_RESTORE_INIT 0x0c /* Restore initialization parameters */
/* 0x0d is reserved */
/* 0x0e is reserved */
/* 0x0f is reserved */
#define WD719X_CMD_ABORT_TAG 0x10 /* Send Abort tag message to target */
#define WD719X_CMD_ABORT 0x11 /* Send Abort message to target */
#define WD719X_CMD_RESET 0x12 /* Send Reset message to target */
#define WD719X_CMD_INIT_SCAM 0x13 /* Initiate SCAM */
#define WD719X_CMD_GET_SYNC 0x14 /* Get synchronous rates */
#define WD719X_CMD_SET_SYNC 0x15 /* Set synchronous rates */
#define WD719X_CMD_GET_WIDTH 0x16 /* Get SCSI bus width */
#define WD719X_CMD_SET_WIDTH 0x17 /* Set SCSI bus width */
#define WD719X_CMD_GET_TAGS 0x18 /* Get tag flags */
#define WD719X_CMD_SET_TAGS 0x19 /* Set tag flags */
#define WD719X_CMD_GET_PARAM2 0x1a /* Get programmable params (format 2) */
#define WD719X_CMD_SET_PARAM2 0x1b /* Set programmable params (format 2) */
/* Commands with request pointers (mailbox) */
#define WD719X_CMD_PROCESS_SCB 0x80 /* Process SCSI Control Block (SCB) */
/* No interrupt generated on acceptance of SCB pointer */
/* interrupt status defines */
#define WD719X_INT_NONE 0x00 /* No interrupt pending */
#define WD719X_INT_NOERRORS 0x01 /* Command completed with no errors */
#define WD719X_INT_LINKNOERRORS 0x02 /* link cmd completed with no errors */
#define WD719X_INT_LINKNOSTATUS 0x03 /* link cmd completed with no flag set */
#define WD719X_INT_ERRORSLOGGED 0x04 /* cmd completed with errors logged */
#define WD719X_INT_SPIDERFAILED 0x05 /* cmd failed without valid SCSI status */
#define WD719X_INT_BADINT 0x80 /* unsolicited interrupt */
#define WD719X_INT_PIOREADY 0xf0 /* data ready for PIO output */
/* Spider Unique Error Codes (SUE) */
#define WD719X_SUE_NOERRORS 0x00 /* No errors detected by SPIDER */
#define WD719X_SUE_REJECTED 0x01 /* Command Rejected (bad opcode/param) */
#define WD719X_SUE_SCBQFULL 0x02 /* SCB queue full */
/* 0x03 is reserved */
#define WD719X_SUE_TERM 0x04 /* Host terminated SCB via primative cmd */
#define WD719X_SUE_CHAN1PAR 0x05 /* PCI Channel 1 parity error occurred */
#define WD719X_SUE_CHAN1ABORT 0x06 /* PCI Channel 1 system abort occurred */
#define WD719X_SUE_CHAN23PAR 0x07 /* PCI Channel 2/3 parity error occurred */
#define WD719X_SUE_CHAN23ABORT 0x08 /* PCI Channel 2/3 system abort occurred */
#define WD719X_SUE_TIMEOUT 0x10 /* Selection/reselection timeout */
#define WD719X_SUE_RESET 0x11 /* SCSI bus reset occurred */
#define WD719X_SUE_BUSERROR 0x12 /* SCSI bus error */
#define WD719X_SUE_WRONGWAY 0x13 /* Wrong data transfer dir set by target */
#define WD719X_SUE_BADPHASE 0x14 /* SCSI phase illegal or unexpected */
#define WD719X_SUE_TOOLONG 0x15 /* target requested too much data */
#define WD719X_SUE_BUSFREE 0x16 /* Unexpected SCSI bus free */
#define WD719X_SUE_ARSDONE 0x17 /* Auto request sense executed */
#define WD719X_SUE_IGNORED 0x18 /* SCSI message was ignored by target */
#define WD719X_SUE_WRONGTAGS 0x19 /* Tagged SCB & tags off (or vice versa) */
#define WD719X_SUE_BADTAGS 0x1a /* Wrong tag message type for target */
#define WD719X_SUE_NOSCAMID 0x1b /* No SCAM soft ID available */
/* code sizes */
#define WD719X_HASH_TABLE_SIZE 4096
/* Advanced Mode Registers */
/* Regs 0x00..0x1f are for Advanced Mode of the card (RISC is running). */
#define WD719X_AMR_COMMAND 0x00
#define WD719X_AMR_CMD_PARAM 0x01
#define WD719X_AMR_CMD_PARAM_2 0x02
#define WD719X_AMR_CMD_PARAM_3 0x03
#define WD719X_AMR_SCB_IN 0x04
#define WD719X_AMR_BIOS_SHARE_INT 0x0f
#define WD719X_AMR_SCB_OUT 0x18
#define WD719X_AMR_OP_CODE 0x1c
#define WD719X_AMR_SCSI_STATUS 0x1d
#define WD719X_AMR_SCB_ERROR 0x1e
#define WD719X_AMR_INT_STATUS 0x1f
#define WD719X_DISABLE_INT 0x80
/* SCB flags */
#define WD719X_SCB_FLAGS_CHECK_DIRECTION 0x01
#define WD719X_SCB_FLAGS_PCI_TO_SCSI 0x02
#define WD719X_SCB_FLAGS_AUTO_REQUEST_SENSE 0x10
#define WD719X_SCB_FLAGS_DO_SCATTER_GATHER 0x20
#define WD719X_SCB_FLAGS_NO_DISCONNECT 0x40
/* PCI Registers used for reset, initial code download */
/* Regs 0x20..0x3f are for Normal (DOS) mode (RISC is asleep). */
#define WD719X_PCI_GPIO_CONTROL 0x3C
#define WD719X_PCI_GPIO_DATA 0x3D
#define WD719X_PCI_PORT_RESET 0x3E
#define WD719X_PCI_MODE_SELECT 0x3F
#define WD719X_PCI_EXTERNAL_ADDR 0x60
#define WD719X_PCI_INTERNAL_ADDR 0x64
#define WD719X_PCI_DMA_TRANSFER_SIZE 0x66
#define WD719X_PCI_CHANNEL2_3CMD 0x68
#define WD719X_PCI_CHANNEL2_3STATUS 0x69
#define WD719X_GPIO_ID_BITS 0x0a
#define WD719X_PRAM_BASE_ADDR 0x00
/* codes written to or read from the card */
#define WD719X_PCI_RESET 0x01
#define WD719X_ENABLE_ADVANCE_MODE 0x01
#define WD719X_START_CHANNEL2_3DMA 0x17
#define WD719X_START_CHANNEL2_3DONE 0x01
#define WD719X_START_CHANNEL2_3ABORT 0x20
/* 33C296 GPIO bits for EEPROM pins */
#define WD719X_EE_DI (1 << 1)
#define WD719X_EE_CS (1 << 2)
#define WD719X_EE_CLK (1 << 3)
#define WD719X_EE_DO (1 << 4)
/* EEPROM contents */
struct wd719x_eeprom_header {
u8 sig1;
u8 sig2;
u8 version;
u8 checksum;
u8 cfg_offset;
u8 cfg_size;
u8 setup_offset;
u8 setup_size;
} __packed;
#define WD719X_EE_SIG1 0
#define WD719X_EE_SIG2 1
#define WD719X_EE_VERSION 2
#define WD719X_EE_CHECKSUM 3
#define WD719X_EE_CFG_OFFSET 4
#define WD719X_EE_CFG_SIZE 5
#define WD719X_EE_SETUP_OFFSET 6
#define WD719X_EE_SETUP_SIZE 7
#define WD719X_EE_SCSI_ID_MASK 0xf
/* SPIDER Host Parameters Block (=EEPROM configuration block) */
struct wd719x_host_param {
u8 ch_1_th; /* FIFO threshold */
u8 scsi_conf; /* SCSI configuration */
u8 own_scsi_id; /* controller SCSI ID */
u8 sel_timeout; /* selection timeout*/
u8 sleep_timer; /* seep timer */
__le16 cdb_size;/* CDB size groups */
__le16 tag_en; /* Tag msg enables (ID 0-15) */
u8 scsi_pad; /* SCSI pad control */
__le32 wide; /* WIDE msg options (ID 0-15) */
__le32 sync; /* SYNC msg options (ID 0-15) */
u8 soft_mask; /* soft error mask */
u8 unsol_mask; /* unsolicited error mask */
} __packed;
#endif /* _WD719X_H_ */