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