blob: f34a5a87af388eb3ced856b0749c77fd5dd2fbb3 [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>
David Dillowac61c462011-01-16 15:12:39 -050012#include <linux/scatterlist.h>
James Bottomleyf290f192009-02-08 21:59:48 -060013
14struct scsi_cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16/*
James Bottomleyd3f46f32008-01-15 11:11:46 -060017 * The maximum number of SG segments that we will put inside a
18 * scatterlist (unless chaining is used). Should ideally fit inside a
19 * single page, to avoid a higher order allocation. We could define this
20 * to SG_MAX_SINGLE_ALLOC to pack correctly at the highest order. The
21 * minimum value is 32
22 */
23#define SCSI_MAX_SG_SEGMENTS 128
24
25/*
26 * Like SCSI_MAX_SG_SEGMENTS, but for archs that have sg chaining. This limit
27 * is totally arbitrary, a setting of 2048 will get you at least 8mb ios.
28 */
29#ifdef ARCH_HAS_SG_CHAIN
30#define SCSI_MAX_SG_CHAIN_SEGMENTS 2048
31#else
32#define SCSI_MAX_SG_CHAIN_SEGMENTS SCSI_MAX_SG_SEGMENTS
33#endif
34
35/*
Martin K. Petersen13f05c82010-09-10 20:50:10 +020036 * DIX-capable adapters effectively support infinite chaining for the
37 * protection information scatterlist
38 */
39#define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF
40
41/*
Christoph Hellwige02f3f52006-01-13 19:04:00 +010042 * Special value for scanning to specify scanning or rescanning of all
43 * possible channels, (target) ids, or luns on a given shost.
44 */
45#define SCAN_WILD_CARD ~0
46
47/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 * SCSI opcodes
49 */
50
51#define TEST_UNIT_READY 0x00
52#define REZERO_UNIT 0x01
53#define REQUEST_SENSE 0x03
54#define FORMAT_UNIT 0x04
55#define READ_BLOCK_LIMITS 0x05
56#define REASSIGN_BLOCKS 0x07
Gerd Knorr daa6eda2005-05-10 10:59:13 +020057#define INITIALIZE_ELEMENT_STATUS 0x07
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define READ_6 0x08
59#define WRITE_6 0x0a
60#define SEEK_6 0x0b
61#define READ_REVERSE 0x0f
62#define WRITE_FILEMARKS 0x10
63#define SPACE 0x11
64#define INQUIRY 0x12
65#define RECOVER_BUFFERED_DATA 0x14
66#define MODE_SELECT 0x15
67#define RESERVE 0x16
68#define RELEASE 0x17
69#define COPY 0x18
70#define ERASE 0x19
71#define MODE_SENSE 0x1a
72#define START_STOP 0x1b
73#define RECEIVE_DIAGNOSTIC 0x1c
74#define SEND_DIAGNOSTIC 0x1d
75#define ALLOW_MEDIUM_REMOVAL 0x1e
76
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +020077#define READ_FORMAT_CAPACITIES 0x23
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define SET_WINDOW 0x24
79#define READ_CAPACITY 0x25
80#define READ_10 0x28
81#define WRITE_10 0x2a
82#define SEEK_10 0x2b
Gerd Knorr daa6eda2005-05-10 10:59:13 +020083#define POSITION_TO_ELEMENT 0x2b
Linus Torvalds1da177e2005-04-16 15:20:36 -070084#define WRITE_VERIFY 0x2e
85#define VERIFY 0x2f
86#define SEARCH_HIGH 0x30
87#define SEARCH_EQUAL 0x31
88#define SEARCH_LOW 0x32
89#define SET_LIMITS 0x33
90#define PRE_FETCH 0x34
91#define READ_POSITION 0x34
92#define SYNCHRONIZE_CACHE 0x35
93#define LOCK_UNLOCK_CACHE 0x36
94#define READ_DEFECT_DATA 0x37
95#define MEDIUM_SCAN 0x38
96#define COMPARE 0x39
97#define COPY_VERIFY 0x3a
98#define WRITE_BUFFER 0x3b
99#define READ_BUFFER 0x3c
100#define UPDATE_BLOCK 0x3d
101#define READ_LONG 0x3e
102#define WRITE_LONG 0x3f
103#define CHANGE_DEFINITION 0x40
104#define WRITE_SAME 0x41
Martin K. Petersenf57e4502009-10-15 14:43:23 -0400105#define UNMAP 0x42
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106#define READ_TOC 0x43
Michal Nazarewicz0a6a7172010-10-07 14:46:15 +0200107#define READ_HEADER 0x44
Tejun Heo93aae172010-12-16 17:52:17 +0100108#define GET_EVENT_STATUS_NOTIFICATION 0x4a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#define LOG_SELECT 0x4c
110#define LOG_SENSE 0x4d
FUJITA Tomonoric639d142008-01-23 01:32:01 +0900111#define XDWRITEREAD_10 0x53
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112#define MODE_SELECT_10 0x55
113#define RESERVE_10 0x56
114#define RELEASE_10 0x57
115#define MODE_SENSE_10 0x5a
116#define PERSISTENT_RESERVE_IN 0x5e
117#define PERSISTENT_RESERVE_OUT 0x5f
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300118#define VARIABLE_LENGTH_CMD 0x7f
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119#define REPORT_LUNS 0xa0
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800120#define SECURITY_PROTOCOL_IN 0xa2
Hannes Reinecke5a09e392006-10-20 09:58:47 +0200121#define MAINTENANCE_IN 0xa3
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700122#define MAINTENANCE_OUT 0xa4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#define MOVE_MEDIUM 0xa5
Gerd Knorr daa6eda2005-05-10 10:59:13 +0200124#define EXCHANGE_MEDIUM 0xa6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#define READ_12 0xa8
126#define WRITE_12 0xaa
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800127#define READ_MEDIA_SERIAL_NUMBER 0xab
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128#define WRITE_VERIFY_12 0xae
Martin K. Petersen59c31b62010-03-23 01:13:28 -0400129#define VERIFY_12 0xaf
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#define SEARCH_HIGH_12 0xb0
131#define SEARCH_EQUAL_12 0xb1
132#define SEARCH_LOW_12 0xb2
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800133#define SECURITY_PROTOCOL_OUT 0xb5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134#define READ_ELEMENT_STATUS 0xb8
135#define SEND_VOLUME_TAG 0xb6
136#define WRITE_LONG_2 0xea
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800137#define EXTENDED_COPY 0x83
138#define RECEIVE_COPY_RESULTS 0x84
139#define ACCESS_CONTROL_IN 0x86
140#define ACCESS_CONTROL_OUT 0x87
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#define READ_16 0x88
142#define WRITE_16 0x8a
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800143#define READ_ATTRIBUTE 0x8c
144#define WRITE_ATTRIBUTE 0x8d
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#define VERIFY_16 0x8f
Andy Grovercd0c72c2012-01-16 16:57:06 -0800146#define SYNCHRONIZE_CACHE_16 0x91
Martin K. Petersenf57e4502009-10-15 14:43:23 -0400147#define WRITE_SAME_16 0x93
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#define SERVICE_ACTION_IN 0x9e
149/* values for service action in */
150#define SAI_READ_CAPACITY_16 0x10
Martin K. Petersenf57e4502009-10-15 14:43:23 -0400151#define SAI_GET_LBA_STATUS 0x12
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800152/* values for VARIABLE_LENGTH_CMD service action codes
153 * see spc4r17 Section D.3.5, table D.7 and D.8 */
154#define VLC_SA_RECEIVE_CREDENTIAL 0x1800
Hannes Reinecke5a09e392006-10-20 09:58:47 +0200155/* values for maintenance in */
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800156#define MI_REPORT_IDENTIFYING_INFORMATION 0x05
Hannes Reinecke5a09e392006-10-20 09:58:47 +0200157#define MI_REPORT_TARGET_PGS 0x0a
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800158#define MI_REPORT_ALIASES 0x0b
159#define MI_REPORT_SUPPORTED_OPERATION_CODES 0x0c
160#define MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0d
161#define MI_REPORT_PRIORITY 0x0e
162#define MI_REPORT_TIMESTAMP 0x0f
163#define MI_MANAGEMENT_PROTOCOL_IN 0x10
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700164/* values for maintenance out */
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800165#define MO_SET_IDENTIFYING_INFORMATION 0x06
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700166#define MO_SET_TARGET_PGS 0x0a
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800167#define MO_CHANGE_ALIASES 0x0b
168#define MO_SET_PRIORITY 0x0e
169#define MO_SET_TIMESTAMP 0x0f
170#define MO_MANAGEMENT_PROTOCOL_OUT 0x10
Martin K. Petersen4e7392e2009-09-20 16:49:38 -0400171/* values for variable length command */
Nicholas Bellingere9ccc992010-12-17 13:11:16 -0800172#define XDREAD_32 0x03
173#define XDWRITE_32 0x04
174#define XPWRITE_32 0x06
175#define XDWRITEREAD_32 0x07
Martin K. Petersen4e7392e2009-09-20 16:49:38 -0400176#define READ_32 0x09
Martin K. Petersen59c31b62010-03-23 01:13:28 -0400177#define VERIFY_32 0x0a
Martin K. Petersen4e7392e2009-09-20 16:49:38 -0400178#define WRITE_32 0x0b
Martin K. Petersenf57e4502009-10-15 14:43:23 -0400179#define WRITE_SAME_32 0x0d
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Jeff Garzikb0955182005-05-12 15:45:22 -0400181/* Values for T10/04-262r7 */
182#define ATA_16 0x85 /* 16-byte pass-thru */
183#define ATA_12 0xa1 /* 12-byte pass-thru */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185/*
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300186 * SCSI command lengths
187 */
188
189#define SCSI_MAX_VARLEN_CDB_SIZE 260
190
191/* defined in T10 SCSI Primary Commands-2 (SPC2) */
192struct scsi_varlen_cdb_hdr {
Peter Korsgaard083c8c12010-08-10 18:01:24 -0700193 __u8 opcode; /* opcode always == VARIABLE_LENGTH_CMD */
194 __u8 control;
195 __u8 misc[5];
196 __u8 additional_cdb_length; /* total cdb length - 8 */
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300197 __be16 service_action;
198 /* service specific data follows */
199};
200
201static inline unsigned
202scsi_varlen_cdb_length(const void *hdr)
203{
204 return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
205}
206
207extern const unsigned char scsi_command_size_tbl[8];
208#define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
209
210static inline unsigned
211scsi_command_size(const unsigned char *cmnd)
212{
213 return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
214 scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
215}
216
217/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft
219 * T10/1561-D Revision 4 Draft dated 7th November 2002.
220 */
221#define SAM_STAT_GOOD 0x00
222#define SAM_STAT_CHECK_CONDITION 0x02
223#define SAM_STAT_CONDITION_MET 0x04
224#define SAM_STAT_BUSY 0x08
225#define SAM_STAT_INTERMEDIATE 0x10
226#define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14
227#define SAM_STAT_RESERVATION_CONFLICT 0x18
228#define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */
229#define SAM_STAT_TASK_SET_FULL 0x28
230#define SAM_STAT_ACA_ACTIVE 0x30
231#define SAM_STAT_TASK_ABORTED 0x40
232
233/** scsi_status_is_good - check the status return.
234 *
235 * @status: the status passed up from the driver (including host and
236 * driver components)
237 *
238 * This returns true for known good conditions that may be treated as
239 * command completed normally
240 */
241static inline int scsi_status_is_good(int status)
242{
243 /*
244 * FIXME: bit0 is listed as reserved in SCSI-2, but is
245 * significant in SCSI-3. For now, we follow the SCSI-2
246 * behaviour and ignore reserved bits.
247 */
248 status &= 0xfe;
249 return ((status == SAM_STAT_GOOD) ||
250 (status == SAM_STAT_INTERMEDIATE) ||
251 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
252 /* FIXME: this is obsolete in SAM-3 */
253 (status == SAM_STAT_COMMAND_TERMINATED));
254}
255
256/*
257 * Status codes. These are deprecated as they are shifted 1 bit right
258 * from those found in the SCSI standards. This causes confusion for
259 * applications that are ported to several OSes. Prefer SAM Status codes
260 * above.
261 */
262
263#define GOOD 0x00
264#define CHECK_CONDITION 0x01
265#define CONDITION_GOOD 0x02
266#define BUSY 0x04
267#define INTERMEDIATE_GOOD 0x08
268#define INTERMEDIATE_C_GOOD 0x0a
269#define RESERVATION_CONFLICT 0x0c
270#define COMMAND_TERMINATED 0x11
271#define QUEUE_FULL 0x14
272#define ACA_ACTIVE 0x18
273#define TASK_ABORTED 0x20
274
275#define STATUS_MASK 0xfe
276
277/*
278 * SENSE KEYS
279 */
280
281#define NO_SENSE 0x00
282#define RECOVERED_ERROR 0x01
283#define NOT_READY 0x02
284#define MEDIUM_ERROR 0x03
285#define HARDWARE_ERROR 0x04
286#define ILLEGAL_REQUEST 0x05
287#define UNIT_ATTENTION 0x06
288#define DATA_PROTECT 0x07
289#define BLANK_CHECK 0x08
290#define COPY_ABORTED 0x0a
291#define ABORTED_COMMAND 0x0b
292#define VOLUME_OVERFLOW 0x0d
293#define MISCOMPARE 0x0e
294
295
296/*
297 * DEVICE TYPES
Michael Tokarevd7b8bcb2006-10-27 16:02:37 +0400298 * Please keep them in 0x%02x format for $MODALIAS to work
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 */
300
301#define TYPE_DISK 0x00
302#define TYPE_TAPE 0x01
303#define TYPE_PRINTER 0x02
304#define TYPE_PROCESSOR 0x03 /* HP scanners use this */
305#define TYPE_WORM 0x04 /* Treated as ROM by our system */
306#define TYPE_ROM 0x05
307#define TYPE_SCANNER 0x06
308#define TYPE_MOD 0x07 /* Magneto-optical disk -
309 * - treated as TYPE_DISK */
310#define TYPE_MEDIUM_CHANGER 0x08
311#define TYPE_COMM 0x09 /* Communications device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312#define TYPE_RAID 0x0c
James Bottomley7f602c52005-05-21 10:24:37 -0500313#define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */
Al Viro 631e8a12005-05-16 01:59:55 +0100314#define TYPE_RBC 0x0e
Boaz Harrosh82443a52009-01-25 16:51:33 +0200315#define TYPE_OSD 0x11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#define TYPE_NO_LUN 0x7f
317
James Bottomley89dddbc2008-02-03 15:32:59 -0600318/* SCSI protocols; these are taken from SPC-3 section 7.5 */
319enum scsi_protocol {
320 SCSI_PROTOCOL_FCP = 0, /* Fibre Channel */
321 SCSI_PROTOCOL_SPI = 1, /* parallel SCSI */
322 SCSI_PROTOCOL_SSA = 2, /* Serial Storage Architecture - Obsolete */
323 SCSI_PROTOCOL_SBP = 3, /* firewire */
324 SCSI_PROTOCOL_SRP = 4, /* Infiniband RDMA */
325 SCSI_PROTOCOL_ISCSI = 5,
326 SCSI_PROTOCOL_SAS = 6,
327 SCSI_PROTOCOL_ADT = 7, /* Media Changers */
328 SCSI_PROTOCOL_ATA = 8,
329 SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
330};
331
Matthew Wilcox4ff36712006-07-04 12:15:20 -0600332/* Returns a human-readable name for the device */
333extern const char * scsi_device_type(unsigned type);
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335/*
336 * standard mode-select header prepended to all mode-select commands
337 */
338
339struct ccs_modesel_head {
340 __u8 _r1; /* reserved */
341 __u8 medium; /* device-specific medium type */
342 __u8 _r2; /* reserved */
343 __u8 block_desc_length; /* block descriptor length */
344 __u8 density; /* device-specific density code */
345 __u8 number_blocks_hi; /* number of blocks in this block desc */
346 __u8 number_blocks_med;
347 __u8 number_blocks_lo;
348 __u8 _r3;
349 __u8 block_length_hi; /* block length for blocks in this desc */
350 __u8 block_length_med;
351 __u8 block_length_lo;
352};
353
354/*
355 * ScsiLun: 8 byte LUN.
356 */
357struct scsi_lun {
358 __u8 scsi_lun[8];
359};
360
361/*
James Bottomley01b291b2008-08-21 15:14:14 -0500362 * The Well Known LUNS (SAM-3) in our int representation of a LUN
363 */
364#define SCSI_W_LUN_BASE 0xc100
365#define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
366#define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
367#define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
368
369static inline int scsi_is_wlun(unsigned int lun)
370{
371 return (lun & 0xff00) == SCSI_W_LUN_BASE;
372}
373
374
375/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 * MESSAGE CODES
377 */
378
379#define COMMAND_COMPLETE 0x00
380#define EXTENDED_MESSAGE 0x01
381#define EXTENDED_MODIFY_DATA_POINTER 0x00
382#define EXTENDED_SDTR 0x01
383#define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
384#define EXTENDED_WDTR 0x03
385#define EXTENDED_PPR 0x04
386#define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
387#define SAVE_POINTERS 0x02
388#define RESTORE_POINTERS 0x03
389#define DISCONNECT 0x04
390#define INITIATOR_ERROR 0x05
391#define ABORT_TASK_SET 0x06
392#define MESSAGE_REJECT 0x07
393#define NOP 0x08
394#define MSG_PARITY_ERROR 0x09
395#define LINKED_CMD_COMPLETE 0x0a
396#define LINKED_FLG_CMD_COMPLETE 0x0b
397#define TARGET_RESET 0x0c
398#define ABORT_TASK 0x0d
399#define CLEAR_TASK_SET 0x0e
400#define INITIATE_RECOVERY 0x0f /* SCSI-II only */
401#define RELEASE_RECOVERY 0x10 /* SCSI-II only */
402#define CLEAR_ACA 0x16
403#define LOGICAL_UNIT_RESET 0x17
404#define SIMPLE_QUEUE_TAG 0x20
405#define HEAD_OF_QUEUE_TAG 0x21
406#define ORDERED_QUEUE_TAG 0x22
407#define IGNORE_WIDE_RESIDUE 0x23
408#define ACA 0x24
409#define QAS_REQUEST 0x55
410
411/* Old SCSI2 names, don't use in new code */
412#define BUS_DEVICE_RESET TARGET_RESET
413#define ABORT ABORT_TASK_SET
414
415/*
416 * Host byte codes
417 */
418
419#define DID_OK 0x00 /* NO error */
420#define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */
421#define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */
422#define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */
423#define DID_BAD_TARGET 0x04 /* BAD target. */
424#define DID_ABORT 0x05 /* Told to abort for some other reason */
425#define DID_PARITY 0x06 /* Parity error */
426#define DID_ERROR 0x07 /* Internal error */
427#define DID_RESET 0x08 /* Reset by somebody. */
428#define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */
429#define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */
430#define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */
431#define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */
bf341912005-04-12 17:49:09 -0500432#define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also
433 * without decrementing the retry count */
Mike Christiea4dfaa62008-08-19 18:45:25 -0500434#define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution
435 * and the driver blocked the port to
436 * recover the link. Transport class will
437 * retry or fail IO */
438#define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100439#define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on
440 * other paths */
441#define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other
442 * paths might yield different results */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443#define DRIVER_OK 0x00 /* Driver status */
444
445/*
446 * These indicate the error that occurred, and what is available.
447 */
448
449#define DRIVER_BUSY 0x01
450#define DRIVER_SOFT 0x02
451#define DRIVER_MEDIA 0x03
452#define DRIVER_ERROR 0x04
453
454#define DRIVER_INVALID 0x05
455#define DRIVER_TIMEOUT 0x06
456#define DRIVER_HARD 0x07
457#define DRIVER_SENSE 0x08
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459/*
460 * Internal return values.
461 */
462
463#define NEEDS_RETRY 0x2001
464#define SUCCESS 0x2002
465#define FAILED 0x2003
466#define QUEUED 0x2004
467#define SOFT_ERROR 0x2005
468#define ADD_TO_MLQUEUE 0x2006
469#define TIMEOUT_ERROR 0x2007
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700470#define SCSI_RETURN_NOT_HANDLED 0x2008
Christof Schmitt2f2eb582010-03-24 16:50:30 +0100471#define FAST_IO_FAIL 0x2009
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100472#define TARGET_ERROR 0x200A
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474/*
475 * Midlevel queue return values.
476 */
477#define SCSI_MLQUEUE_HOST_BUSY 0x1055
478#define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
479#define SCSI_MLQUEUE_EH_RETRY 0x1057
Mike Christief0c0a372008-08-17 15:24:38 -0500480#define SCSI_MLQUEUE_TARGET_BUSY 0x1058
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482/*
483 * Use these to separate status msg and our bytes
484 *
485 * These are set by:
486 *
487 * status byte = set from target device
488 * msg_byte = return status from host adapter itself.
489 * host_byte = set by low-level driver to indicate status.
490 * driver_byte = set by mid-level.
491 */
492#define status_byte(result) (((result) >> 1) & 0x7f)
493#define msg_byte(result) (((result) >> 8) & 0xff)
494#define host_byte(result) (((result) >> 16) & 0xff)
495#define driver_byte(result) (((result) >> 24) & 0xff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497#define sense_class(sense) (((sense) >> 4) & 0x7)
498#define sense_error(sense) ((sense) & 0xf)
Phil Carmody497888c2011-07-14 15:07:13 +0300499#define sense_valid(sense) ((sense) & 0x80)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
b6651122005-04-03 14:52:44 -0500501/*
502 * default timeouts
503*/
504#define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
505#define START_STOP_TIMEOUT (60 * HZ)
506#define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
507#define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
508#define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511#define IDENTIFY_BASE 0x80
512#define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
513 ((can_disconnect) ? 0x40 : 0) |\
514 ((lun) & 0x07))
515
516/*
517 * struct scsi_device::scsi_level values. For SCSI devices other than those
518 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
519 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
520 * variable is visible to the user via sysfs.
521 */
522
523#define SCSI_UNKNOWN 0
524#define SCSI_1 1
525#define SCSI_1_CCS 2
526#define SCSI_2 3
527#define SCSI_3 4 /* SPC */
528#define SCSI_SPC_2 5
529#define SCSI_SPC_3 6
530
531/*
532 * INQ PERIPHERAL QUALIFIERS
533 */
534#define SCSI_INQ_PQ_CON 0x00
535#define SCSI_INQ_PQ_NOT_CON 0x01
536#define SCSI_INQ_PQ_NOT_CAP 0x03
537
538
539/*
540 * Here are some scsi specific ioctl commands which are sometimes useful.
541 *
542 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
543 */
544
545/* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
546#define SCSI_IOCTL_GET_IDLUN 0x5382
547
548/* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
549
550/* Used to obtain the host number of a device. */
551#define SCSI_IOCTL_PROBE_HOST 0x5385
552
553/* Used to obtain the bus number for a device */
554#define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
555
556/* Used to obtain the PCI location of a device */
557#define SCSI_IOCTL_GET_PCI 0x5387
558
James Bottomley2908d772006-08-29 09:22:51 -0500559/* Pull a u32 out of a SCSI message (using BE SCSI conventions) */
FUJITA Tomonori4a531e82006-10-20 09:08:18 +0900560static inline __u32 scsi_to_u32(__u8 *ptr)
James Bottomley2908d772006-08-29 09:22:51 -0500561{
562 return (ptr[0]<<24) + (ptr[1]<<16) + (ptr[2]<<8) + ptr[3];
563}
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565#endif /* _SCSI_SCSI_H */