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