include/scsi/scsi.h

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