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