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