Merge branch 'sched-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6] / 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 MAINTENANCE_OUT       0xa4
110 #define MOVE_MEDIUM           0xa5
111 #define EXCHANGE_MEDIUM       0xa6
112 #define READ_12               0xa8
113 #define WRITE_12              0xaa
114 #define WRITE_VERIFY_12       0xae
115 #define SEARCH_HIGH_12        0xb0
116 #define SEARCH_EQUAL_12       0xb1
117 #define SEARCH_LOW_12         0xb2
118 #define READ_ELEMENT_STATUS   0xb8
119 #define SEND_VOLUME_TAG       0xb6
120 #define WRITE_LONG_2          0xea
121 #define READ_16               0x88
122 #define WRITE_16              0x8a
123 #define VERIFY_16             0x8f
124 #define SERVICE_ACTION_IN     0x9e
125 /* values for service action in */
126 #define SAI_READ_CAPACITY_16  0x10
127 /* values for maintenance in */
128 #define MI_REPORT_TARGET_PGS  0x0a
129 /* values for maintenance out */
130 #define MO_SET_TARGET_PGS     0x0a
131
132 /* Values for T10/04-262r7 */
133 #define ATA_16                0x85      /* 16-byte pass-thru */
134 #define ATA_12                0xa1      /* 12-byte pass-thru */
135
136 /*
137  *      SCSI command lengths
138  */
139
140 #define SCSI_MAX_VARLEN_CDB_SIZE 260
141
142 /* defined in T10 SCSI Primary Commands-2 (SPC2) */
143 struct scsi_varlen_cdb_hdr {
144         u8 opcode;        /* opcode always == VARIABLE_LENGTH_CMD */
145         u8 control;
146         u8 misc[5];
147         u8 additional_cdb_length;         /* total cdb length - 8 */
148         __be16 service_action;
149         /* service specific data follows */
150 };
151
152 static inline unsigned
153 scsi_varlen_cdb_length(const void *hdr)
154 {
155         return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
156 }
157
158 extern const unsigned char scsi_command_size_tbl[8];
159 #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
160
161 static inline unsigned
162 scsi_command_size(const unsigned char *cmnd)
163 {
164         return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
165                 scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
166 }
167
168 /*
169  *  SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft
170  *  T10/1561-D Revision 4 Draft dated 7th November 2002.
171  */
172 #define SAM_STAT_GOOD            0x00
173 #define SAM_STAT_CHECK_CONDITION 0x02
174 #define SAM_STAT_CONDITION_MET   0x04
175 #define SAM_STAT_BUSY            0x08
176 #define SAM_STAT_INTERMEDIATE    0x10
177 #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14
178 #define SAM_STAT_RESERVATION_CONFLICT 0x18
179 #define SAM_STAT_COMMAND_TERMINATED 0x22        /* obsolete in SAM-3 */
180 #define SAM_STAT_TASK_SET_FULL   0x28
181 #define SAM_STAT_ACA_ACTIVE      0x30
182 #define SAM_STAT_TASK_ABORTED    0x40
183
184 /** scsi_status_is_good - check the status return.
185  *
186  * @status: the status passed up from the driver (including host and
187  *          driver components)
188  *
189  * This returns true for known good conditions that may be treated as
190  * command completed normally
191  */
192 static inline int scsi_status_is_good(int status)
193 {
194         /*
195          * FIXME: bit0 is listed as reserved in SCSI-2, but is
196          * significant in SCSI-3.  For now, we follow the SCSI-2
197          * behaviour and ignore reserved bits.
198          */
199         status &= 0xfe;
200         return ((status == SAM_STAT_GOOD) ||
201                 (status == SAM_STAT_INTERMEDIATE) ||
202                 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
203                 /* FIXME: this is obsolete in SAM-3 */
204                 (status == SAM_STAT_COMMAND_TERMINATED));
205 }
206
207 /*
208  *  Status codes. These are deprecated as they are shifted 1 bit right
209  *  from those found in the SCSI standards. This causes confusion for
210  *  applications that are ported to several OSes. Prefer SAM Status codes
211  *  above.
212  */
213
214 #define GOOD                 0x00
215 #define CHECK_CONDITION      0x01
216 #define CONDITION_GOOD       0x02
217 #define BUSY                 0x04
218 #define INTERMEDIATE_GOOD    0x08
219 #define INTERMEDIATE_C_GOOD  0x0a
220 #define RESERVATION_CONFLICT 0x0c
221 #define COMMAND_TERMINATED   0x11
222 #define QUEUE_FULL           0x14
223 #define ACA_ACTIVE           0x18
224 #define TASK_ABORTED         0x20
225
226 #define STATUS_MASK          0xfe
227
228 /*
229  *  SENSE KEYS
230  */
231
232 #define NO_SENSE            0x00
233 #define RECOVERED_ERROR     0x01
234 #define NOT_READY           0x02
235 #define MEDIUM_ERROR        0x03
236 #define HARDWARE_ERROR      0x04
237 #define ILLEGAL_REQUEST     0x05
238 #define UNIT_ATTENTION      0x06
239 #define DATA_PROTECT        0x07
240 #define BLANK_CHECK         0x08
241 #define COPY_ABORTED        0x0a
242 #define ABORTED_COMMAND     0x0b
243 #define VOLUME_OVERFLOW     0x0d
244 #define MISCOMPARE          0x0e
245
246
247 /*
248  *  DEVICE TYPES
249  *  Please keep them in 0x%02x format for $MODALIAS to work
250  */
251
252 #define TYPE_DISK           0x00
253 #define TYPE_TAPE           0x01
254 #define TYPE_PRINTER        0x02
255 #define TYPE_PROCESSOR      0x03    /* HP scanners use this */
256 #define TYPE_WORM           0x04    /* Treated as ROM by our system */
257 #define TYPE_ROM            0x05
258 #define TYPE_SCANNER        0x06
259 #define TYPE_MOD            0x07    /* Magneto-optical disk - 
260                                      * - treated as TYPE_DISK */
261 #define TYPE_MEDIUM_CHANGER 0x08
262 #define TYPE_COMM           0x09    /* Communications device */
263 #define TYPE_RAID           0x0c
264 #define TYPE_ENCLOSURE      0x0d    /* Enclosure Services Device */
265 #define TYPE_RBC            0x0e
266 #define TYPE_NO_LUN         0x7f
267
268 /* SCSI protocols; these are taken from SPC-3 section 7.5 */
269 enum scsi_protocol {
270         SCSI_PROTOCOL_FCP = 0,  /* Fibre Channel */
271         SCSI_PROTOCOL_SPI = 1,  /* parallel SCSI */
272         SCSI_PROTOCOL_SSA = 2,  /* Serial Storage Architecture - Obsolete */
273         SCSI_PROTOCOL_SBP = 3,  /* firewire */
274         SCSI_PROTOCOL_SRP = 4,  /* Infiniband RDMA */
275         SCSI_PROTOCOL_ISCSI = 5,
276         SCSI_PROTOCOL_SAS = 6,
277         SCSI_PROTOCOL_ADT = 7,  /* Media Changers */
278         SCSI_PROTOCOL_ATA = 8,
279         SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
280 };
281
282 /* Returns a human-readable name for the device */
283 extern const char * scsi_device_type(unsigned type);
284
285 /*
286  * standard mode-select header prepended to all mode-select commands
287  */
288
289 struct ccs_modesel_head {
290         __u8 _r1;                       /* reserved */
291         __u8 medium;            /* device-specific medium type */
292         __u8 _r2;                       /* reserved */
293         __u8 block_desc_length; /* block descriptor length */
294         __u8 density;           /* device-specific density code */
295         __u8 number_blocks_hi;  /* number of blocks in this block desc */
296         __u8 number_blocks_med;
297         __u8 number_blocks_lo;
298         __u8 _r3;
299         __u8 block_length_hi;   /* block length for blocks in this desc */
300         __u8 block_length_med;
301         __u8 block_length_lo;
302 };
303
304 /*
305  * ScsiLun: 8 byte LUN.
306  */
307 struct scsi_lun {
308         __u8 scsi_lun[8];
309 };
310
311 /*
312  *  MESSAGE CODES
313  */
314
315 #define COMMAND_COMPLETE    0x00
316 #define EXTENDED_MESSAGE    0x01
317 #define     EXTENDED_MODIFY_DATA_POINTER    0x00
318 #define     EXTENDED_SDTR                   0x01
319 #define     EXTENDED_EXTENDED_IDENTIFY      0x02    /* SCSI-I only */
320 #define     EXTENDED_WDTR                   0x03
321 #define     EXTENDED_PPR                    0x04
322 #define     EXTENDED_MODIFY_BIDI_DATA_PTR   0x05
323 #define SAVE_POINTERS       0x02
324 #define RESTORE_POINTERS    0x03
325 #define DISCONNECT          0x04
326 #define INITIATOR_ERROR     0x05
327 #define ABORT_TASK_SET      0x06
328 #define MESSAGE_REJECT      0x07
329 #define NOP                 0x08
330 #define MSG_PARITY_ERROR    0x09
331 #define LINKED_CMD_COMPLETE 0x0a
332 #define LINKED_FLG_CMD_COMPLETE 0x0b
333 #define TARGET_RESET        0x0c
334 #define ABORT_TASK          0x0d
335 #define CLEAR_TASK_SET      0x0e
336 #define INITIATE_RECOVERY   0x0f            /* SCSI-II only */
337 #define RELEASE_RECOVERY    0x10            /* SCSI-II only */
338 #define CLEAR_ACA           0x16
339 #define LOGICAL_UNIT_RESET  0x17
340 #define SIMPLE_QUEUE_TAG    0x20
341 #define HEAD_OF_QUEUE_TAG   0x21
342 #define ORDERED_QUEUE_TAG   0x22
343 #define IGNORE_WIDE_RESIDUE 0x23
344 #define ACA                 0x24
345 #define QAS_REQUEST         0x55
346
347 /* Old SCSI2 names, don't use in new code */
348 #define BUS_DEVICE_RESET    TARGET_RESET
349 #define ABORT               ABORT_TASK_SET
350
351 /*
352  * Host byte codes
353  */
354
355 #define DID_OK          0x00    /* NO error                                */
356 #define DID_NO_CONNECT  0x01    /* Couldn't connect before timeout period  */
357 #define DID_BUS_BUSY    0x02    /* BUS stayed busy through time out period */
358 #define DID_TIME_OUT    0x03    /* TIMED OUT for other reason              */
359 #define DID_BAD_TARGET  0x04    /* BAD target.                             */
360 #define DID_ABORT       0x05    /* Told to abort for some other reason     */
361 #define DID_PARITY      0x06    /* Parity error                            */
362 #define DID_ERROR       0x07    /* Internal error                          */
363 #define DID_RESET       0x08    /* Reset by somebody.                      */
364 #define DID_BAD_INTR    0x09    /* Got an interrupt we weren't expecting.  */
365 #define DID_PASSTHROUGH 0x0a    /* Force command past mid-layer            */
366 #define DID_SOFT_ERROR  0x0b    /* The low level driver just wish a retry  */
367 #define DID_IMM_RETRY   0x0c    /* Retry without decrementing retry count  */
368 #define DID_REQUEUE     0x0d    /* Requeue command (no immediate retry) also
369                                  * without decrementing the retry count    */
370 #define DRIVER_OK       0x00    /* Driver status                           */
371
372 /*
373  *  These indicate the error that occurred, and what is available.
374  */
375
376 #define DRIVER_BUSY         0x01
377 #define DRIVER_SOFT         0x02
378 #define DRIVER_MEDIA        0x03
379 #define DRIVER_ERROR        0x04
380
381 #define DRIVER_INVALID      0x05
382 #define DRIVER_TIMEOUT      0x06
383 #define DRIVER_HARD         0x07
384 #define DRIVER_SENSE        0x08
385
386 #define SUGGEST_RETRY       0x10
387 #define SUGGEST_ABORT       0x20
388 #define SUGGEST_REMAP       0x30
389 #define SUGGEST_DIE         0x40
390 #define SUGGEST_SENSE       0x80
391 #define SUGGEST_IS_OK       0xff
392
393 #define DRIVER_MASK         0x0f
394 #define SUGGEST_MASK        0xf0
395
396 /*
397  * Internal return values.
398  */
399
400 #define NEEDS_RETRY     0x2001
401 #define SUCCESS         0x2002
402 #define FAILED          0x2003
403 #define QUEUED          0x2004
404 #define SOFT_ERROR      0x2005
405 #define ADD_TO_MLQUEUE  0x2006
406 #define TIMEOUT_ERROR   0x2007
407 #define SCSI_RETURN_NOT_HANDLED   0x2008
408
409 /*
410  * Midlevel queue return values.
411  */
412 #define SCSI_MLQUEUE_HOST_BUSY   0x1055
413 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
414 #define SCSI_MLQUEUE_EH_RETRY    0x1057
415
416 /*
417  *  Use these to separate status msg and our bytes
418  *
419  *  These are set by:
420  *
421  *      status byte = set from target device
422  *      msg_byte    = return status from host adapter itself.
423  *      host_byte   = set by low-level driver to indicate status.
424  *      driver_byte = set by mid-level.
425  */
426 #define status_byte(result) (((result) >> 1) & 0x7f)
427 #define msg_byte(result)    (((result) >> 8) & 0xff)
428 #define host_byte(result)   (((result) >> 16) & 0xff)
429 #define driver_byte(result) (((result) >> 24) & 0xff)
430 #define suggestion(result)  (driver_byte(result) & SUGGEST_MASK)
431
432 static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
433 {
434         cmd->result |= status << 8;
435 }
436
437 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
438 {
439         cmd->result |= status << 16;
440 }
441
442 static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
443 {
444         cmd->result |= status << 24;
445 }
446
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) */
511 static 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 */