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