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