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