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