1 /* 2 * This header file contains public constants and structures used by 3 * the scsi code for linux. 4 * 5 * For documentation on the OPCODES, MESSAGES, and SENSE values, 6 * please consult the SCSI standard. 7 */ 8 #ifndef _SCSI_SCSI_H 9 #define _SCSI_SCSI_H 10 11 #include <linux/types.h> 12 13 struct scsi_cmnd; 14 15 /* 16 * The maximum number of SG segments that we will put inside a 17 * scatterlist (unless chaining is used). Should ideally fit inside a 18 * single page, to avoid a higher order allocation. We could define this 19 * to SG_MAX_SINGLE_ALLOC to pack correctly at the highest order. The 20 * minimum value is 32 21 */ 22 #define SCSI_MAX_SG_SEGMENTS 128 23 24 /* 25 * Like SCSI_MAX_SG_SEGMENTS, but for archs that have sg chaining. This limit 26 * is totally arbitrary, a setting of 2048 will get you at least 8mb ios. 27 */ 28 #ifdef ARCH_HAS_SG_CHAIN 29 #define SCSI_MAX_SG_CHAIN_SEGMENTS 2048 30 #else 31 #define SCSI_MAX_SG_CHAIN_SEGMENTS SCSI_MAX_SG_SEGMENTS 32 #endif 33 34 /* 35 * Special value for scanning to specify scanning or rescanning of all 36 * possible channels, (target) ids, or luns on a given shost. 37 */ 38 #define SCAN_WILD_CARD ~0 39 40 /* 41 * SCSI opcodes 42 */ 43 44 #define TEST_UNIT_READY 0x00 45 #define REZERO_UNIT 0x01 46 #define REQUEST_SENSE 0x03 47 #define FORMAT_UNIT 0x04 48 #define READ_BLOCK_LIMITS 0x05 49 #define REASSIGN_BLOCKS 0x07 50 #define INITIALIZE_ELEMENT_STATUS 0x07 51 #define READ_6 0x08 52 #define WRITE_6 0x0a 53 #define SEEK_6 0x0b 54 #define READ_REVERSE 0x0f 55 #define WRITE_FILEMARKS 0x10 56 #define SPACE 0x11 57 #define INQUIRY 0x12 58 #define RECOVER_BUFFERED_DATA 0x14 59 #define MODE_SELECT 0x15 60 #define RESERVE 0x16 61 #define RELEASE 0x17 62 #define COPY 0x18 63 #define ERASE 0x19 64 #define MODE_SENSE 0x1a 65 #define START_STOP 0x1b 66 #define RECEIVE_DIAGNOSTIC 0x1c 67 #define SEND_DIAGNOSTIC 0x1d 68 #define ALLOW_MEDIUM_REMOVAL 0x1e 69 70 #define SET_WINDOW 0x24 71 #define READ_CAPACITY 0x25 72 #define READ_10 0x28 73 #define WRITE_10 0x2a 74 #define SEEK_10 0x2b 75 #define POSITION_TO_ELEMENT 0x2b 76 #define WRITE_VERIFY 0x2e 77 #define VERIFY 0x2f 78 #define SEARCH_HIGH 0x30 79 #define SEARCH_EQUAL 0x31 80 #define SEARCH_LOW 0x32 81 #define SET_LIMITS 0x33 82 #define PRE_FETCH 0x34 83 #define READ_POSITION 0x34 84 #define SYNCHRONIZE_CACHE 0x35 85 #define LOCK_UNLOCK_CACHE 0x36 86 #define READ_DEFECT_DATA 0x37 87 #define MEDIUM_SCAN 0x38 88 #define COMPARE 0x39 89 #define COPY_VERIFY 0x3a 90 #define WRITE_BUFFER 0x3b 91 #define READ_BUFFER 0x3c 92 #define UPDATE_BLOCK 0x3d 93 #define READ_LONG 0x3e 94 #define WRITE_LONG 0x3f 95 #define CHANGE_DEFINITION 0x40 96 #define WRITE_SAME 0x41 97 #define UNMAP 0x42 98 #define READ_TOC 0x43 99 #define LOG_SELECT 0x4c 100 #define LOG_SENSE 0x4d 101 #define XDWRITEREAD_10 0x53 102 #define MODE_SELECT_10 0x55 103 #define RESERVE_10 0x56 104 #define RELEASE_10 0x57 105 #define MODE_SENSE_10 0x5a 106 #define PERSISTENT_RESERVE_IN 0x5e 107 #define PERSISTENT_RESERVE_OUT 0x5f 108 #define VARIABLE_LENGTH_CMD 0x7f 109 #define REPORT_LUNS 0xa0 110 #define MAINTENANCE_IN 0xa3 111 #define MAINTENANCE_OUT 0xa4 112 #define MOVE_MEDIUM 0xa5 113 #define EXCHANGE_MEDIUM 0xa6 114 #define READ_12 0xa8 115 #define WRITE_12 0xaa 116 #define WRITE_VERIFY_12 0xae 117 #define SEARCH_HIGH_12 0xb0 118 #define SEARCH_EQUAL_12 0xb1 119 #define SEARCH_LOW_12 0xb2 120 #define READ_ELEMENT_STATUS 0xb8 121 #define SEND_VOLUME_TAG 0xb6 122 #define WRITE_LONG_2 0xea 123 #define READ_16 0x88 124 #define WRITE_16 0x8a 125 #define VERIFY_16 0x8f 126 #define WRITE_SAME_16 0x93 127 #define SERVICE_ACTION_IN 0x9e 128 /* values for service action in */ 129 #define SAI_READ_CAPACITY_16 0x10 130 #define SAI_GET_LBA_STATUS 0x12 131 /* values for maintenance in */ 132 #define MI_REPORT_TARGET_PGS 0x0a 133 /* values for maintenance out */ 134 #define MO_SET_TARGET_PGS 0x0a 135 /* values for variable length command */ 136 #define READ_32 0x09 137 #define WRITE_32 0x0b 138 #define WRITE_SAME_32 0x0d 139 140 /* Values for T10/04-262r7 */ 141 #define ATA_16 0x85 /* 16-byte pass-thru */ 142 #define ATA_12 0xa1 /* 12-byte pass-thru */ 143 144 /* 145 * SCSI command lengths 146 */ 147 148 #define SCSI_MAX_VARLEN_CDB_SIZE 260 149 150 /* defined in T10 SCSI Primary Commands-2 (SPC2) */ 151 struct scsi_varlen_cdb_hdr { 152 u8 opcode; /* opcode always == VARIABLE_LENGTH_CMD */ 153 u8 control; 154 u8 misc[5]; 155 u8 additional_cdb_length; /* total cdb length - 8 */ 156 __be16 service_action; 157 /* service specific data follows */ 158 }; 159 160 static inline unsigned 161 scsi_varlen_cdb_length(const void *hdr) 162 { 163 return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8; 164 } 165 166 extern const unsigned char scsi_command_size_tbl[8]; 167 #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7] 168 169 static inline unsigned 170 scsi_command_size(const unsigned char *cmnd) 171 { 172 return (cmnd[0] == VARIABLE_LENGTH_CMD) ? 173 scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]); 174 } 175 176 /* 177 * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft 178 * T10/1561-D Revision 4 Draft dated 7th November 2002. 179 */ 180 #define SAM_STAT_GOOD 0x00 181 #define SAM_STAT_CHECK_CONDITION 0x02 182 #define SAM_STAT_CONDITION_MET 0x04 183 #define SAM_STAT_BUSY 0x08 184 #define SAM_STAT_INTERMEDIATE 0x10 185 #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14 186 #define SAM_STAT_RESERVATION_CONFLICT 0x18 187 #define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */ 188 #define SAM_STAT_TASK_SET_FULL 0x28 189 #define SAM_STAT_ACA_ACTIVE 0x30 190 #define SAM_STAT_TASK_ABORTED 0x40 191 192 /** scsi_status_is_good - check the status return. 193 * 194 * @status: the status passed up from the driver (including host and 195 * driver components) 196 * 197 * This returns true for known good conditions that may be treated as 198 * command completed normally 199 */ 200 static inline int scsi_status_is_good(int status) 201 { 202 /* 203 * FIXME: bit0 is listed as reserved in SCSI-2, but is 204 * significant in SCSI-3. For now, we follow the SCSI-2 205 * behaviour and ignore reserved bits. 206 */ 207 status &= 0xfe; 208 return ((status == SAM_STAT_GOOD) || 209 (status == SAM_STAT_INTERMEDIATE) || 210 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) || 211 /* FIXME: this is obsolete in SAM-3 */ 212 (status == SAM_STAT_COMMAND_TERMINATED)); 213 } 214 215 /* 216 * Status codes. These are deprecated as they are shifted 1 bit right 217 * from those found in the SCSI standards. This causes confusion for 218 * applications that are ported to several OSes. Prefer SAM Status codes 219 * above. 220 */ 221 222 #define GOOD 0x00 223 #define CHECK_CONDITION 0x01 224 #define CONDITION_GOOD 0x02 225 #define BUSY 0x04 226 #define INTERMEDIATE_GOOD 0x08 227 #define INTERMEDIATE_C_GOOD 0x0a 228 #define RESERVATION_CONFLICT 0x0c 229 #define COMMAND_TERMINATED 0x11 230 #define QUEUE_FULL 0x14 231 #define ACA_ACTIVE 0x18 232 #define TASK_ABORTED 0x20 233 234 #define STATUS_MASK 0xfe 235 236 /* 237 * SENSE KEYS 238 */ 239 240 #define NO_SENSE 0x00 241 #define RECOVERED_ERROR 0x01 242 #define NOT_READY 0x02 243 #define MEDIUM_ERROR 0x03 244 #define HARDWARE_ERROR 0x04 245 #define ILLEGAL_REQUEST 0x05 246 #define UNIT_ATTENTION 0x06 247 #define DATA_PROTECT 0x07 248 #define BLANK_CHECK 0x08 249 #define COPY_ABORTED 0x0a 250 #define ABORTED_COMMAND 0x0b 251 #define VOLUME_OVERFLOW 0x0d 252 #define MISCOMPARE 0x0e 253 254 255 /* 256 * DEVICE TYPES 257 * Please keep them in 0x%02x format for $MODALIAS to work 258 */ 259 260 #define TYPE_DISK 0x00 261 #define TYPE_TAPE 0x01 262 #define TYPE_PRINTER 0x02 263 #define TYPE_PROCESSOR 0x03 /* HP scanners use this */ 264 #define TYPE_WORM 0x04 /* Treated as ROM by our system */ 265 #define TYPE_ROM 0x05 266 #define TYPE_SCANNER 0x06 267 #define TYPE_MOD 0x07 /* Magneto-optical disk - 268 * - treated as TYPE_DISK */ 269 #define TYPE_MEDIUM_CHANGER 0x08 270 #define TYPE_COMM 0x09 /* Communications device */ 271 #define TYPE_RAID 0x0c 272 #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */ 273 #define TYPE_RBC 0x0e 274 #define TYPE_OSD 0x11 275 #define TYPE_NO_LUN 0x7f 276 277 /* SCSI protocols; these are taken from SPC-3 section 7.5 */ 278 enum scsi_protocol { 279 SCSI_PROTOCOL_FCP = 0, /* Fibre Channel */ 280 SCSI_PROTOCOL_SPI = 1, /* parallel SCSI */ 281 SCSI_PROTOCOL_SSA = 2, /* Serial Storage Architecture - Obsolete */ 282 SCSI_PROTOCOL_SBP = 3, /* firewire */ 283 SCSI_PROTOCOL_SRP = 4, /* Infiniband RDMA */ 284 SCSI_PROTOCOL_ISCSI = 5, 285 SCSI_PROTOCOL_SAS = 6, 286 SCSI_PROTOCOL_ADT = 7, /* Media Changers */ 287 SCSI_PROTOCOL_ATA = 8, 288 SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */ 289 }; 290 291 /* Returns a human-readable name for the device */ 292 extern const char * scsi_device_type(unsigned type); 293 294 /* 295 * standard mode-select header prepended to all mode-select commands 296 */ 297 298 struct ccs_modesel_head { 299 __u8 _r1; /* reserved */ 300 __u8 medium; /* device-specific medium type */ 301 __u8 _r2; /* reserved */ 302 __u8 block_desc_length; /* block descriptor length */ 303 __u8 density; /* device-specific density code */ 304 __u8 number_blocks_hi; /* number of blocks in this block desc */ 305 __u8 number_blocks_med; 306 __u8 number_blocks_lo; 307 __u8 _r3; 308 __u8 block_length_hi; /* block length for blocks in this desc */ 309 __u8 block_length_med; 310 __u8 block_length_lo; 311 }; 312 313 /* 314 * ScsiLun: 8 byte LUN. 315 */ 316 struct scsi_lun { 317 __u8 scsi_lun[8]; 318 }; 319 320 /* 321 * The Well Known LUNS (SAM-3) in our int representation of a LUN 322 */ 323 #define SCSI_W_LUN_BASE 0xc100 324 #define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1) 325 #define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2) 326 #define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3) 327 328 static inline int scsi_is_wlun(unsigned int lun) 329 { 330 return (lun & 0xff00) == SCSI_W_LUN_BASE; 331 } 332 333 334 /* 335 * MESSAGE CODES 336 */ 337 338 #define COMMAND_COMPLETE 0x00 339 #define EXTENDED_MESSAGE 0x01 340 #define EXTENDED_MODIFY_DATA_POINTER 0x00 341 #define EXTENDED_SDTR 0x01 342 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */ 343 #define EXTENDED_WDTR 0x03 344 #define EXTENDED_PPR 0x04 345 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05 346 #define SAVE_POINTERS 0x02 347 #define RESTORE_POINTERS 0x03 348 #define DISCONNECT 0x04 349 #define INITIATOR_ERROR 0x05 350 #define ABORT_TASK_SET 0x06 351 #define MESSAGE_REJECT 0x07 352 #define NOP 0x08 353 #define MSG_PARITY_ERROR 0x09 354 #define LINKED_CMD_COMPLETE 0x0a 355 #define LINKED_FLG_CMD_COMPLETE 0x0b 356 #define TARGET_RESET 0x0c 357 #define ABORT_TASK 0x0d 358 #define CLEAR_TASK_SET 0x0e 359 #define INITIATE_RECOVERY 0x0f /* SCSI-II only */ 360 #define RELEASE_RECOVERY 0x10 /* SCSI-II only */ 361 #define CLEAR_ACA 0x16 362 #define LOGICAL_UNIT_RESET 0x17 363 #define SIMPLE_QUEUE_TAG 0x20 364 #define HEAD_OF_QUEUE_TAG 0x21 365 #define ORDERED_QUEUE_TAG 0x22 366 #define IGNORE_WIDE_RESIDUE 0x23 367 #define ACA 0x24 368 #define QAS_REQUEST 0x55 369 370 /* Old SCSI2 names, don't use in new code */ 371 #define BUS_DEVICE_RESET TARGET_RESET 372 #define ABORT ABORT_TASK_SET 373 374 /* 375 * Host byte codes 376 */ 377 378 #define DID_OK 0x00 /* NO error */ 379 #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */ 380 #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */ 381 #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */ 382 #define DID_BAD_TARGET 0x04 /* BAD target. */ 383 #define DID_ABORT 0x05 /* Told to abort for some other reason */ 384 #define DID_PARITY 0x06 /* Parity error */ 385 #define DID_ERROR 0x07 /* Internal error */ 386 #define DID_RESET 0x08 /* Reset by somebody. */ 387 #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */ 388 #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */ 389 #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */ 390 #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */ 391 #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also 392 * without decrementing the retry count */ 393 #define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution 394 * and the driver blocked the port to 395 * recover the link. Transport class will 396 * retry or fail IO */ 397 #define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */ 398 #define DRIVER_OK 0x00 /* Driver status */ 399 400 /* 401 * These indicate the error that occurred, and what is available. 402 */ 403 404 #define DRIVER_BUSY 0x01 405 #define DRIVER_SOFT 0x02 406 #define DRIVER_MEDIA 0x03 407 #define DRIVER_ERROR 0x04 408 409 #define DRIVER_INVALID 0x05 410 #define DRIVER_TIMEOUT 0x06 411 #define DRIVER_HARD 0x07 412 #define DRIVER_SENSE 0x08 413 414 /* 415 * Internal return values. 416 */ 417 418 #define NEEDS_RETRY 0x2001 419 #define SUCCESS 0x2002 420 #define FAILED 0x2003 421 #define QUEUED 0x2004 422 #define SOFT_ERROR 0x2005 423 #define ADD_TO_MLQUEUE 0x2006 424 #define TIMEOUT_ERROR 0x2007 425 #define SCSI_RETURN_NOT_HANDLED 0x2008 426 427 /* 428 * Midlevel queue return values. 429 */ 430 #define SCSI_MLQUEUE_HOST_BUSY 0x1055 431 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056 432 #define SCSI_MLQUEUE_EH_RETRY 0x1057 433 #define SCSI_MLQUEUE_TARGET_BUSY 0x1058 434 435 /* 436 * Use these to separate status msg and our bytes 437 * 438 * These are set by: 439 * 440 * status byte = set from target device 441 * msg_byte = return status from host adapter itself. 442 * host_byte = set by low-level driver to indicate status. 443 * driver_byte = set by mid-level. 444 */ 445 #define status_byte(result) (((result) >> 1) & 0x7f) 446 #define msg_byte(result) (((result) >> 8) & 0xff) 447 #define host_byte(result) (((result) >> 16) & 0xff) 448 #define driver_byte(result) (((result) >> 24) & 0xff) 449 450 #define sense_class(sense) (((sense) >> 4) & 0x7) 451 #define sense_error(sense) ((sense) & 0xf) 452 #define sense_valid(sense) ((sense) & 0x80); 453 454 /* 455 * default timeouts 456 */ 457 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ) 458 #define START_STOP_TIMEOUT (60 * HZ) 459 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ) 460 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ) 461 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ ) 462 463 464 #define IDENTIFY_BASE 0x80 465 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\ 466 ((can_disconnect) ? 0x40 : 0) |\ 467 ((lun) & 0x07)) 468 469 /* 470 * struct scsi_device::scsi_level values. For SCSI devices other than those 471 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1) 472 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level 473 * variable is visible to the user via sysfs. 474 */ 475 476 #define SCSI_UNKNOWN 0 477 #define SCSI_1 1 478 #define SCSI_1_CCS 2 479 #define SCSI_2 3 480 #define SCSI_3 4 /* SPC */ 481 #define SCSI_SPC_2 5 482 #define SCSI_SPC_3 6 483 484 /* 485 * INQ PERIPHERAL QUALIFIERS 486 */ 487 #define SCSI_INQ_PQ_CON 0x00 488 #define SCSI_INQ_PQ_NOT_CON 0x01 489 #define SCSI_INQ_PQ_NOT_CAP 0x03 490 491 492 /* 493 * Here are some scsi specific ioctl commands which are sometimes useful. 494 * 495 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395 496 */ 497 498 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */ 499 #define SCSI_IOCTL_GET_IDLUN 0x5382 500 501 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */ 502 503 /* Used to obtain the host number of a device. */ 504 #define SCSI_IOCTL_PROBE_HOST 0x5385 505 506 /* Used to obtain the bus number for a device */ 507 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386 508 509 /* Used to obtain the PCI location of a device */ 510 #define SCSI_IOCTL_GET_PCI 0x5387 511 512 /* Pull a u32 out of a SCSI message (using BE SCSI conventions) */ 513 static inline __u32 scsi_to_u32(__u8 *ptr) 514 { 515 return (ptr[0]<<24) + (ptr[1]<<16) + (ptr[2]<<8) + ptr[3]; 516 } 517 518 #endif /* _SCSI_SCSI_H */ 519