Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
scsi.h
Go to the documentation of this file.
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 
14 struct 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 SYNCHRONIZE_CACHE_16 0x91
147 #define WRITE_SAME_16 0x93
148 #define SERVICE_ACTION_IN 0x9e
149 /* values for service action in */
150 #define SAI_READ_CAPACITY_16 0x10
151 #define SAI_GET_LBA_STATUS 0x12
152 /* 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
155 /* values for maintenance in */
156 #define MI_REPORT_IDENTIFYING_INFORMATION 0x05
157 #define MI_REPORT_TARGET_PGS 0x0a
158 #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
164 /* value for MI_REPORT_TARGET_PGS ext header */
165 #define MI_EXT_HDR_PARAM_FMT 0x20
166 /* values for maintenance out */
167 #define MO_SET_IDENTIFYING_INFORMATION 0x06
168 #define MO_SET_TARGET_PGS 0x0a
169 #define MO_CHANGE_ALIASES 0x0b
170 #define MO_SET_PRIORITY 0x0e
171 #define MO_SET_TIMESTAMP 0x0f
172 #define MO_MANAGEMENT_PROTOCOL_OUT 0x10
173 /* values for variable length command */
174 #define XDREAD_32 0x03
175 #define XDWRITE_32 0x04
176 #define XPWRITE_32 0x06
177 #define XDWRITEREAD_32 0x07
178 #define READ_32 0x09
179 #define VERIFY_32 0x0a
180 #define WRITE_32 0x0b
181 #define WRITE_SAME_32 0x0d
182 
183 /* Values for T10/04-262r7 */
184 #define ATA_16 0x85 /* 16-byte pass-thru */
185 #define ATA_12 0xa1 /* 12-byte pass-thru */
186 
187 /*
188  * SCSI command lengths
189  */
190 
191 #define SCSI_MAX_VARLEN_CDB_SIZE 260
192 
193 /* defined in T10 SCSI Primary Commands-2 (SPC2) */
195  __u8 opcode; /* opcode always == VARIABLE_LENGTH_CMD */
197  __u8 misc[5];
198  __u8 additional_cdb_length; /* total cdb length - 8 */
200  /* service specific data follows */
201 };
202 
203 static inline unsigned
204 scsi_varlen_cdb_length(const void *hdr)
205 {
206  return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
207 }
208 
209 extern const unsigned char scsi_command_size_tbl[8];
210 #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
211 
212 static inline unsigned
213 scsi_command_size(const unsigned char *cmnd)
214 {
215  return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
216  scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
217 }
218 
219 #ifdef CONFIG_ACPI
220 struct acpi_bus_type;
221 
222 extern int
223 scsi_register_acpi_bus_type(struct acpi_bus_type *bus);
224 
225 extern void
226 scsi_unregister_acpi_bus_type(struct acpi_bus_type *bus);
227 #endif
228 
229 /*
230  * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft
231  * T10/1561-D Revision 4 Draft dated 7th November 2002.
232  */
233 #define SAM_STAT_GOOD 0x00
234 #define SAM_STAT_CHECK_CONDITION 0x02
235 #define SAM_STAT_CONDITION_MET 0x04
236 #define SAM_STAT_BUSY 0x08
237 #define SAM_STAT_INTERMEDIATE 0x10
238 #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14
239 #define SAM_STAT_RESERVATION_CONFLICT 0x18
240 #define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */
241 #define SAM_STAT_TASK_SET_FULL 0x28
242 #define SAM_STAT_ACA_ACTIVE 0x30
243 #define SAM_STAT_TASK_ABORTED 0x40
244 
253 static inline int scsi_status_is_good(int status)
254 {
255  /*
256  * FIXME: bit0 is listed as reserved in SCSI-2, but is
257  * significant in SCSI-3. For now, we follow the SCSI-2
258  * behaviour and ignore reserved bits.
259  */
260  status &= 0xfe;
261  return ((status == SAM_STAT_GOOD) ||
262  (status == SAM_STAT_INTERMEDIATE) ||
264  /* FIXME: this is obsolete in SAM-3 */
265  (status == SAM_STAT_COMMAND_TERMINATED));
266 }
267 
268 /*
269  * Status codes. These are deprecated as they are shifted 1 bit right
270  * from those found in the SCSI standards. This causes confusion for
271  * applications that are ported to several OSes. Prefer SAM Status codes
272  * above.
273  */
274 
275 #define GOOD 0x00
276 #define CHECK_CONDITION 0x01
277 #define CONDITION_GOOD 0x02
278 #define BUSY 0x04
279 #define INTERMEDIATE_GOOD 0x08
280 #define INTERMEDIATE_C_GOOD 0x0a
281 #define RESERVATION_CONFLICT 0x0c
282 #define COMMAND_TERMINATED 0x11
283 #define QUEUE_FULL 0x14
284 #define ACA_ACTIVE 0x18
285 #define TASK_ABORTED 0x20
286 
287 #define STATUS_MASK 0xfe
288 
289 /*
290  * SENSE KEYS
291  */
292 
293 #define NO_SENSE 0x00
294 #define RECOVERED_ERROR 0x01
295 #define NOT_READY 0x02
296 #define MEDIUM_ERROR 0x03
297 #define HARDWARE_ERROR 0x04
298 #define ILLEGAL_REQUEST 0x05
299 #define UNIT_ATTENTION 0x06
300 #define DATA_PROTECT 0x07
301 #define BLANK_CHECK 0x08
302 #define COPY_ABORTED 0x0a
303 #define ABORTED_COMMAND 0x0b
304 #define VOLUME_OVERFLOW 0x0d
305 #define MISCOMPARE 0x0e
306 
307 
308 /*
309  * DEVICE TYPES
310  * Please keep them in 0x%02x format for $MODALIAS to work
311  */
312 
313 #define TYPE_DISK 0x00
314 #define TYPE_TAPE 0x01
315 #define TYPE_PRINTER 0x02
316 #define TYPE_PROCESSOR 0x03 /* HP scanners use this */
317 #define TYPE_WORM 0x04 /* Treated as ROM by our system */
318 #define TYPE_ROM 0x05
319 #define TYPE_SCANNER 0x06
320 #define TYPE_MOD 0x07 /* Magneto-optical disk -
321  * - treated as TYPE_DISK */
322 #define TYPE_MEDIUM_CHANGER 0x08
323 #define TYPE_COMM 0x09 /* Communications device */
324 #define TYPE_RAID 0x0c
325 #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */
326 #define TYPE_RBC 0x0e
327 #define TYPE_OSD 0x11
328 #define TYPE_NO_LUN 0x7f
329 
330 /* SCSI protocols; these are taken from SPC-3 section 7.5 */
332  SCSI_PROTOCOL_FCP = 0, /* Fibre Channel */
333  SCSI_PROTOCOL_SPI = 1, /* parallel SCSI */
334  SCSI_PROTOCOL_SSA = 2, /* Serial Storage Architecture - Obsolete */
335  SCSI_PROTOCOL_SBP = 3, /* firewire */
336  SCSI_PROTOCOL_SRP = 4, /* Infiniband RDMA */
339  SCSI_PROTOCOL_ADT = 7, /* Media Changers */
341  SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
342 };
343 
344 /* Returns a human-readable name for the device */
345 extern const char * scsi_device_type(unsigned type);
346 
347 /*
348  * standard mode-select header prepended to all mode-select commands
349  */
352  __u8 _r1; /* reserved */
353  __u8 medium; /* device-specific medium type */
354  __u8 _r2; /* reserved */
355  __u8 block_desc_length; /* block descriptor length */
356  __u8 density; /* device-specific density code */
357  __u8 number_blocks_hi; /* number of blocks in this block desc */
361  __u8 block_length_hi; /* block length for blocks in this desc */
364 };
365 
366 /*
367  * ScsiLun: 8 byte LUN.
368  */
369 struct scsi_lun {
370  __u8 scsi_lun[8];
371 };
372 
373 /*
374  * The Well Known LUNS (SAM-3) in our int representation of a LUN
375  */
376 #define SCSI_W_LUN_BASE 0xc100
377 #define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
378 #define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
379 #define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
380 
381 static inline int scsi_is_wlun(unsigned int lun)
382 {
383  return (lun & 0xff00) == SCSI_W_LUN_BASE;
384 }
385 
386 
387 /*
388  * MESSAGE CODES
389  */
391 #define COMMAND_COMPLETE 0x00
392 #define EXTENDED_MESSAGE 0x01
393 #define EXTENDED_MODIFY_DATA_POINTER 0x00
394 #define EXTENDED_SDTR 0x01
395 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
396 #define EXTENDED_WDTR 0x03
397 #define EXTENDED_PPR 0x04
398 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
399 #define SAVE_POINTERS 0x02
400 #define RESTORE_POINTERS 0x03
401 #define DISCONNECT 0x04
402 #define INITIATOR_ERROR 0x05
403 #define ABORT_TASK_SET 0x06
404 #define MESSAGE_REJECT 0x07
405 #define NOP 0x08
406 #define MSG_PARITY_ERROR 0x09
407 #define LINKED_CMD_COMPLETE 0x0a
408 #define LINKED_FLG_CMD_COMPLETE 0x0b
409 #define TARGET_RESET 0x0c
410 #define ABORT_TASK 0x0d
411 #define CLEAR_TASK_SET 0x0e
412 #define INITIATE_RECOVERY 0x0f /* SCSI-II only */
413 #define RELEASE_RECOVERY 0x10 /* SCSI-II only */
414 #define CLEAR_ACA 0x16
415 #define LOGICAL_UNIT_RESET 0x17
416 #define SIMPLE_QUEUE_TAG 0x20
417 #define HEAD_OF_QUEUE_TAG 0x21
418 #define ORDERED_QUEUE_TAG 0x22
419 #define IGNORE_WIDE_RESIDUE 0x23
420 #define ACA 0x24
421 #define QAS_REQUEST 0x55
422 
423 /* Old SCSI2 names, don't use in new code */
424 #define BUS_DEVICE_RESET TARGET_RESET
425 #define ABORT ABORT_TASK_SET
426 
427 /*
428  * Host byte codes
429  */
431 #define DID_OK 0x00 /* NO error */
432 #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */
433 #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */
434 #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */
435 #define DID_BAD_TARGET 0x04 /* BAD target. */
436 #define DID_ABORT 0x05 /* Told to abort for some other reason */
437 #define DID_PARITY 0x06 /* Parity error */
438 #define DID_ERROR 0x07 /* Internal error */
439 #define DID_RESET 0x08 /* Reset by somebody. */
440 #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */
441 #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */
442 #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */
443 #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */
444 #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also
445  * without decrementing the retry count */
446 #define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution
447  * and the driver blocked the port to
448  * recover the link. Transport class will
449  * retry or fail IO */
450 #define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */
451 #define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on
452  * other paths */
453 #define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other
454  * paths might yield different results */
455 #define DRIVER_OK 0x00 /* Driver status */
457 /*
458  * These indicate the error that occurred, and what is available.
459  */
461 #define DRIVER_BUSY 0x01
462 #define DRIVER_SOFT 0x02
463 #define DRIVER_MEDIA 0x03
464 #define DRIVER_ERROR 0x04
465 
466 #define DRIVER_INVALID 0x05
467 #define DRIVER_TIMEOUT 0x06
468 #define DRIVER_HARD 0x07
469 #define DRIVER_SENSE 0x08
471 /*
472  * Internal return values.
473  */
475 #define NEEDS_RETRY 0x2001
476 #define SUCCESS 0x2002
477 #define FAILED 0x2003
478 #define QUEUED 0x2004
479 #define SOFT_ERROR 0x2005
480 #define ADD_TO_MLQUEUE 0x2006
481 #define TIMEOUT_ERROR 0x2007
482 #define SCSI_RETURN_NOT_HANDLED 0x2008
483 #define FAST_IO_FAIL 0x2009
484 #define TARGET_ERROR 0x200A
486 /*
487  * Midlevel queue return values.
488  */
489 #define SCSI_MLQUEUE_HOST_BUSY 0x1055
490 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
491 #define SCSI_MLQUEUE_EH_RETRY 0x1057
492 #define SCSI_MLQUEUE_TARGET_BUSY 0x1058
493 
494 /*
495  * Use these to separate status msg and our bytes
496  *
497  * These are set by:
498  *
499  * status byte = set from target device
500  * msg_byte = return status from host adapter itself.
501  * host_byte = set by low-level driver to indicate status.
502  * driver_byte = set by mid-level.
503  */
504 #define status_byte(result) (((result) >> 1) & 0x7f)
505 #define msg_byte(result) (((result) >> 8) & 0xff)
506 #define host_byte(result) (((result) >> 16) & 0xff)
507 #define driver_byte(result) (((result) >> 24) & 0xff)
508 
509 #define sense_class(sense) (((sense) >> 4) & 0x7)
510 #define sense_error(sense) ((sense) & 0xf)
511 #define sense_valid(sense) ((sense) & 0x80)
513 /*
514  * default timeouts
515 */
516 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
517 #define START_STOP_TIMEOUT (60 * HZ)
518 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
519 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
520 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
521 
522 
523 #define IDENTIFY_BASE 0x80
524 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
525  ((can_disconnect) ? 0x40 : 0) |\
526  ((lun) & 0x07))
527 
528 /*
529  * struct scsi_device::scsi_level values. For SCSI devices other than those
530  * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
531  * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
532  * variable is visible to the user via sysfs.
533  */
535 #define SCSI_UNKNOWN 0
536 #define SCSI_1 1
537 #define SCSI_1_CCS 2
538 #define SCSI_2 3
539 #define SCSI_3 4 /* SPC */
540 #define SCSI_SPC_2 5
541 #define SCSI_SPC_3 6
542 
543 /*
544  * INQ PERIPHERAL QUALIFIERS
545  */
546 #define SCSI_INQ_PQ_CON 0x00
547 #define SCSI_INQ_PQ_NOT_CON 0x01
548 #define SCSI_INQ_PQ_NOT_CAP 0x03
549 
550 
551 /*
552  * Here are some scsi specific ioctl commands which are sometimes useful.
553  *
554  * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
555  */
557 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
558 #define SCSI_IOCTL_GET_IDLUN 0x5382
560 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
561 
562 /* Used to obtain the host number of a device. */
563 #define SCSI_IOCTL_PROBE_HOST 0x5385
564 
565 /* Used to obtain the bus number for a device */
566 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
567 
568 /* Used to obtain the PCI location of a device */
569 #define SCSI_IOCTL_GET_PCI 0x5387
570 
571 /* Pull a u32 out of a SCSI message (using BE SCSI conventions) */
572 static inline __u32 scsi_to_u32(__u8 *ptr)
573 {
574  return (ptr[0]<<24) + (ptr[1]<<16) + (ptr[2]<<8) + ptr[3];
575 }
576 
577 #endif /* _SCSI_SCSI_H */