1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * This header file contains public constants and structures used by 4 * the SCSI initiator code. 5 */ 6#ifndef _SCSI_SCSI_H 7#define _SCSI_SCSI_H 8 9#include <linux/types.h> 10#include <linux/scatterlist.h> 11#include <linux/kernel.h> 12#include <scsi/scsi_common.h> 13#include <scsi/scsi_proto.h> 14 15struct scsi_cmnd; 16 17enum scsi_timeouts { 18 SCSI_DEFAULT_EH_TIMEOUT = 10 * HZ, 19}; 20 21/* 22 * DIX-capable adapters effectively support infinite chaining for the 23 * protection information scatterlist 24 */ 25#define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF 26 27/* 28 * Special value for scanning to specify scanning or rescanning of all 29 * possible channels, (target) ids, or luns on a given shost. 30 */ 31#define SCAN_WILD_CARD ~0 32 33/* 34 * standard mode-select header prepended to all mode-select commands 35 */ 36 37struct ccs_modesel_head { 38 __u8 _r1; /* reserved */ 39 __u8 medium; /* device-specific medium type */ 40 __u8 _r2; /* reserved */ 41 __u8 block_desc_length; /* block descriptor length */ 42 __u8 density; /* device-specific density code */ 43 __u8 number_blocks_hi; /* number of blocks in this block desc */ 44 __u8 number_blocks_med; 45 __u8 number_blocks_lo; 46 __u8 _r3; 47 __u8 block_length_hi; /* block length for blocks in this desc */ 48 __u8 block_length_med; 49 __u8 block_length_lo; 50}; 51 52/* 53 * The Well Known LUNS (SAM-3) in our int representation of a LUN 54 */ 55#define SCSI_W_LUN_BASE 0xc100 56#define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1) 57#define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2) 58#define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3) 59 60static inline int scsi_is_wlun(u64 lun) 61{ 62 return (lun & 0xff00) == SCSI_W_LUN_BASE; 63} 64 65 66/* 67 * MESSAGE CODES 68 */ 69 70#define COMMAND_COMPLETE 0x00 71#define EXTENDED_MESSAGE 0x01 72#define EXTENDED_MODIFY_DATA_POINTER 0x00 73#define EXTENDED_SDTR 0x01 74#define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */ 75#define EXTENDED_WDTR 0x03 76#define EXTENDED_PPR 0x04 77#define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05 78#define SAVE_POINTERS 0x02 79#define RESTORE_POINTERS 0x03 80#define DISCONNECT 0x04 81#define INITIATOR_ERROR 0x05 82#define ABORT_TASK_SET 0x06 83#define MESSAGE_REJECT 0x07 84#define NOP 0x08 85#define MSG_PARITY_ERROR 0x09 86#define LINKED_CMD_COMPLETE 0x0a 87#define LINKED_FLG_CMD_COMPLETE 0x0b 88#define TARGET_RESET 0x0c 89#define ABORT_TASK 0x0d 90#define CLEAR_TASK_SET 0x0e 91#define INITIATE_RECOVERY 0x0f /* SCSI-II only */ 92#define RELEASE_RECOVERY 0x10 /* SCSI-II only */ 93#define CLEAR_ACA 0x16 94#define LOGICAL_UNIT_RESET 0x17 95#define SIMPLE_QUEUE_TAG 0x20 96#define HEAD_OF_QUEUE_TAG 0x21 97#define ORDERED_QUEUE_TAG 0x22 98#define IGNORE_WIDE_RESIDUE 0x23 99#define ACA 0x24 100#define QAS_REQUEST 0x55 101 102/* Old SCSI2 names, don't use in new code */ 103#define BUS_DEVICE_RESET TARGET_RESET 104#define ABORT ABORT_TASK_SET 105 106/* 107 * Host byte codes 108 */ 109 110#define DID_OK 0x00 /* NO error */ 111#define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */ 112#define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */ 113#define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */ 114#define DID_BAD_TARGET 0x04 /* BAD target. */ 115#define DID_ABORT 0x05 /* Told to abort for some other reason */ 116#define DID_PARITY 0x06 /* Parity error */ 117#define DID_ERROR 0x07 /* Internal error */ 118#define DID_RESET 0x08 /* Reset by somebody. */ 119#define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */ 120#define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */ 121#define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */ 122#define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */ 123#define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also 124 * without decrementing the retry count */ 125#define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution 126 * and the driver blocked the port to 127 * recover the link. Transport class will 128 * retry or fail IO */ 129#define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */ 130#define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on 131 * other paths */ 132#define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other 133 * paths might yield different results */ 134#define DID_ALLOC_FAILURE 0x12 /* Space allocation on the device failed */ 135#define DID_MEDIUM_ERROR 0x13 /* Medium error */ 136#define DRIVER_OK 0x00 /* Driver status */ 137 138/* 139 * These indicate the error that occurred, and what is available. 140 */ 141 142#define DRIVER_BUSY 0x01 143#define DRIVER_SOFT 0x02 144#define DRIVER_MEDIA 0x03 145#define DRIVER_ERROR 0x04 146 147#define DRIVER_INVALID 0x05 148#define DRIVER_TIMEOUT 0x06 149#define DRIVER_HARD 0x07 150#define DRIVER_SENSE 0x08 151 152/* 153 * Internal return values. 154 */ 155enum scsi_disposition { 156 NEEDS_RETRY = 0x2001, 157 SUCCESS = 0x2002, 158 FAILED = 0x2003, 159 QUEUED = 0x2004, 160 SOFT_ERROR = 0x2005, 161 ADD_TO_MLQUEUE = 0x2006, 162 TIMEOUT_ERROR = 0x2007, 163 SCSI_RETURN_NOT_HANDLED = 0x2008, 164 FAST_IO_FAIL = 0x2009, 165}; 166 167/* 168 * Midlevel queue return values. 169 */ 170#define SCSI_MLQUEUE_HOST_BUSY 0x1055 171#define SCSI_MLQUEUE_DEVICE_BUSY 0x1056 172#define SCSI_MLQUEUE_EH_RETRY 0x1057 173#define SCSI_MLQUEUE_TARGET_BUSY 0x1058 174 175/* 176 * Use these to separate status msg and our bytes 177 * 178 * These are set by: 179 * 180 * status byte = set from target device 181 * msg_byte = return status from host adapter itself. 182 * host_byte = set by low-level driver to indicate status. 183 * driver_byte = set by mid-level. 184 */ 185#define status_byte(result) (((result) >> 1) & 0x7f) 186#define msg_byte(result) (((result) >> 8) & 0xff) 187#define host_byte(result) (((result) >> 16) & 0xff) 188#define driver_byte(result) (((result) >> 24) & 0xff) 189 190#define sense_class(sense) (((sense) >> 4) & 0x7) 191#define sense_error(sense) ((sense) & 0xf) 192#define sense_valid(sense) ((sense) & 0x80) 193 194/* 195 * default timeouts 196*/ 197#define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ) 198#define START_STOP_TIMEOUT (60 * HZ) 199#define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ) 200#define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ) 201#define READ_DEFECT_DATA_TIMEOUT (60 * HZ ) 202 203 204#define IDENTIFY_BASE 0x80 205#define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\ 206 ((can_disconnect) ? 0x40 : 0) |\ 207 ((lun) & 0x07)) 208 209/* 210 * struct scsi_device::scsi_level values. For SCSI devices other than those 211 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1) 212 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level 213 * variable is visible to the user via sysfs. 214 */ 215 216#define SCSI_UNKNOWN 0 217#define SCSI_1 1 218#define SCSI_1_CCS 2 219#define SCSI_2 3 220#define SCSI_3 4 /* SPC */ 221#define SCSI_SPC_2 5 222#define SCSI_SPC_3 6 223 224/* 225 * INQ PERIPHERAL QUALIFIERS 226 */ 227#define SCSI_INQ_PQ_CON 0x00 228#define SCSI_INQ_PQ_NOT_CON 0x01 229#define SCSI_INQ_PQ_NOT_CAP 0x03 230 231 232/* 233 * Here are some scsi specific ioctl commands which are sometimes useful. 234 * 235 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395 236 */ 237 238/* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */ 239#define SCSI_IOCTL_GET_IDLUN 0x5382 240 241/* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */ 242 243/* Used to obtain the host number of a device. */ 244#define SCSI_IOCTL_PROBE_HOST 0x5385 245 246/* Used to obtain the bus number for a device */ 247#define SCSI_IOCTL_GET_BUS_NUMBER 0x5386 248 249/* Used to obtain the PCI location of a device */ 250#define SCSI_IOCTL_GET_PCI 0x5387 251 252/** scsi_status_is_good - check the status return. 253 * 254 * @status: the status passed up from the driver (including host and 255 * driver components) 256 * 257 * This returns true for known good conditions that may be treated as 258 * command completed normally 259 */ 260static inline int scsi_status_is_good(int status) 261{ 262 if (host_byte(status) == DID_NO_CONNECT) 263 return 0; 264 265 /* 266 * FIXME: bit0 is listed as reserved in SCSI-2, but is 267 * significant in SCSI-3. For now, we follow the SCSI-2 268 * behaviour and ignore reserved bits. 269 */ 270 status &= 0xfe; 271 return ((status == SAM_STAT_GOOD) || 272 (status == SAM_STAT_CONDITION_MET) || 273 /* Next two "intermediate" statuses are obsolete in SAM-4 */ 274 (status == SAM_STAT_INTERMEDIATE) || 275 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) || 276 /* FIXME: this is obsolete in SAM-3 */ 277 (status == SAM_STAT_COMMAND_TERMINATED)); 278} 279 280#endif /* _SCSI_SCSI_H */ 281