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