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