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