Linux 3.12.5
[linux/fpc-iii.git] / include / scsi / scsi.h
blob66d42edfb3fc341d8a33a0a0f9e9666b53111ec3
1 /*
2 * This header file contains public constants and structures used by
3 * the scsi code for linux.
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
11 #include <linux/types.h>
12 #include <linux/scatterlist.h>
13 #include <linux/kernel.h>
15 struct scsi_cmnd;
17 enum scsi_timeouts {
18 SCSI_DEFAULT_EH_TIMEOUT = 10 * HZ,
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
28 #define SCSI_MAX_SG_SEGMENTS 128
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.
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
41 * DIX-capable adapters effectively support infinite chaining for the
42 * protection information scatterlist
44 #define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF
47 * Special value for scanning to specify scanning or rescanning of all
48 * possible channels, (target) ids, or luns on a given shost.
50 #define SCAN_WILD_CARD ~0
53 * SCSI opcodes
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
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 /* values for VARIABLE_LENGTH_CMD service action codes
159 * see spc4r17 Section D.3.5, table D.7 and D.8 */
160 #define VLC_SA_RECEIVE_CREDENTIAL 0x1800
161 /* values for maintenance in */
162 #define MI_REPORT_IDENTIFYING_INFORMATION 0x05
163 #define MI_REPORT_TARGET_PGS 0x0a
164 #define MI_REPORT_ALIASES 0x0b
165 #define MI_REPORT_SUPPORTED_OPERATION_CODES 0x0c
166 #define MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS 0x0d
167 #define MI_REPORT_PRIORITY 0x0e
168 #define MI_REPORT_TIMESTAMP 0x0f
169 #define MI_MANAGEMENT_PROTOCOL_IN 0x10
170 /* value for MI_REPORT_TARGET_PGS ext header */
171 #define MI_EXT_HDR_PARAM_FMT 0x20
172 /* values for maintenance out */
173 #define MO_SET_IDENTIFYING_INFORMATION 0x06
174 #define MO_SET_TARGET_PGS 0x0a
175 #define MO_CHANGE_ALIASES 0x0b
176 #define MO_SET_PRIORITY 0x0e
177 #define MO_SET_TIMESTAMP 0x0f
178 #define MO_MANAGEMENT_PROTOCOL_OUT 0x10
179 /* values for variable length command */
180 #define XDREAD_32 0x03
181 #define XDWRITE_32 0x04
182 #define XPWRITE_32 0x06
183 #define XDWRITEREAD_32 0x07
184 #define READ_32 0x09
185 #define VERIFY_32 0x0a
186 #define WRITE_32 0x0b
187 #define WRITE_SAME_32 0x0d
189 /* Values for T10/04-262r7 */
190 #define ATA_16 0x85 /* 16-byte pass-thru */
191 #define ATA_12 0xa1 /* 12-byte pass-thru */
194 * SCSI command lengths
197 #define SCSI_MAX_VARLEN_CDB_SIZE 260
199 /* defined in T10 SCSI Primary Commands-2 (SPC2) */
200 struct scsi_varlen_cdb_hdr {
201 __u8 opcode; /* opcode always == VARIABLE_LENGTH_CMD */
202 __u8 control;
203 __u8 misc[5];
204 __u8 additional_cdb_length; /* total cdb length - 8 */
205 __be16 service_action;
206 /* service specific data follows */
209 static inline unsigned
210 scsi_varlen_cdb_length(const void *hdr)
212 return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
215 extern const unsigned char scsi_command_size_tbl[8];
216 #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
218 static inline unsigned
219 scsi_command_size(const unsigned char *cmnd)
221 return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
222 scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
225 #ifdef CONFIG_ACPI
226 struct acpi_bus_type;
228 extern int
229 scsi_register_acpi_bus_type(struct acpi_bus_type *bus);
231 extern void
232 scsi_unregister_acpi_bus_type(struct acpi_bus_type *bus);
233 #endif
236 * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft
237 * T10/1561-D Revision 4 Draft dated 7th November 2002.
239 #define SAM_STAT_GOOD 0x00
240 #define SAM_STAT_CHECK_CONDITION 0x02
241 #define SAM_STAT_CONDITION_MET 0x04
242 #define SAM_STAT_BUSY 0x08
243 #define SAM_STAT_INTERMEDIATE 0x10
244 #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14
245 #define SAM_STAT_RESERVATION_CONFLICT 0x18
246 #define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */
247 #define SAM_STAT_TASK_SET_FULL 0x28
248 #define SAM_STAT_ACA_ACTIVE 0x30
249 #define SAM_STAT_TASK_ABORTED 0x40
251 /** scsi_status_is_good - check the status return.
253 * @status: the status passed up from the driver (including host and
254 * driver components)
256 * This returns true for known good conditions that may be treated as
257 * command completed normally
259 static inline int scsi_status_is_good(int status)
262 * FIXME: bit0 is listed as reserved in SCSI-2, but is
263 * significant in SCSI-3. For now, we follow the SCSI-2
264 * behaviour and ignore reserved bits.
266 status &= 0xfe;
267 return ((status == SAM_STAT_GOOD) ||
268 (status == SAM_STAT_INTERMEDIATE) ||
269 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
270 /* FIXME: this is obsolete in SAM-3 */
271 (status == SAM_STAT_COMMAND_TERMINATED));
275 * Status codes. These are deprecated as they are shifted 1 bit right
276 * from those found in the SCSI standards. This causes confusion for
277 * applications that are ported to several OSes. Prefer SAM Status codes
278 * above.
281 #define GOOD 0x00
282 #define CHECK_CONDITION 0x01
283 #define CONDITION_GOOD 0x02
284 #define BUSY 0x04
285 #define INTERMEDIATE_GOOD 0x08
286 #define INTERMEDIATE_C_GOOD 0x0a
287 #define RESERVATION_CONFLICT 0x0c
288 #define COMMAND_TERMINATED 0x11
289 #define QUEUE_FULL 0x14
290 #define ACA_ACTIVE 0x18
291 #define TASK_ABORTED 0x20
293 #define STATUS_MASK 0xfe
296 * SENSE KEYS
299 #define NO_SENSE 0x00
300 #define RECOVERED_ERROR 0x01
301 #define NOT_READY 0x02
302 #define MEDIUM_ERROR 0x03
303 #define HARDWARE_ERROR 0x04
304 #define ILLEGAL_REQUEST 0x05
305 #define UNIT_ATTENTION 0x06
306 #define DATA_PROTECT 0x07
307 #define BLANK_CHECK 0x08
308 #define COPY_ABORTED 0x0a
309 #define ABORTED_COMMAND 0x0b
310 #define VOLUME_OVERFLOW 0x0d
311 #define MISCOMPARE 0x0e
315 * DEVICE TYPES
316 * Please keep them in 0x%02x format for $MODALIAS to work
319 #define TYPE_DISK 0x00
320 #define TYPE_TAPE 0x01
321 #define TYPE_PRINTER 0x02
322 #define TYPE_PROCESSOR 0x03 /* HP scanners use this */
323 #define TYPE_WORM 0x04 /* Treated as ROM by our system */
324 #define TYPE_ROM 0x05
325 #define TYPE_SCANNER 0x06
326 #define TYPE_MOD 0x07 /* Magneto-optical disk -
327 * - treated as TYPE_DISK */
328 #define TYPE_MEDIUM_CHANGER 0x08
329 #define TYPE_COMM 0x09 /* Communications device */
330 #define TYPE_RAID 0x0c
331 #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */
332 #define TYPE_RBC 0x0e
333 #define TYPE_OSD 0x11
334 #define TYPE_NO_LUN 0x7f
336 /* SCSI protocols; these are taken from SPC-3 section 7.5 */
337 enum scsi_protocol {
338 SCSI_PROTOCOL_FCP = 0, /* Fibre Channel */
339 SCSI_PROTOCOL_SPI = 1, /* parallel SCSI */
340 SCSI_PROTOCOL_SSA = 2, /* Serial Storage Architecture - Obsolete */
341 SCSI_PROTOCOL_SBP = 3, /* firewire */
342 SCSI_PROTOCOL_SRP = 4, /* Infiniband RDMA */
343 SCSI_PROTOCOL_ISCSI = 5,
344 SCSI_PROTOCOL_SAS = 6,
345 SCSI_PROTOCOL_ADT = 7, /* Media Changers */
346 SCSI_PROTOCOL_ATA = 8,
347 SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
350 /* Returns a human-readable name for the device */
351 extern const char * scsi_device_type(unsigned type);
354 * standard mode-select header prepended to all mode-select commands
357 struct ccs_modesel_head {
358 __u8 _r1; /* reserved */
359 __u8 medium; /* device-specific medium type */
360 __u8 _r2; /* reserved */
361 __u8 block_desc_length; /* block descriptor length */
362 __u8 density; /* device-specific density code */
363 __u8 number_blocks_hi; /* number of blocks in this block desc */
364 __u8 number_blocks_med;
365 __u8 number_blocks_lo;
366 __u8 _r3;
367 __u8 block_length_hi; /* block length for blocks in this desc */
368 __u8 block_length_med;
369 __u8 block_length_lo;
373 * ScsiLun: 8 byte LUN.
375 struct scsi_lun {
376 __u8 scsi_lun[8];
380 * The Well Known LUNS (SAM-3) in our int representation of a LUN
382 #define SCSI_W_LUN_BASE 0xc100
383 #define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
384 #define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
385 #define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
387 static inline int scsi_is_wlun(unsigned int lun)
389 return (lun & 0xff00) == SCSI_W_LUN_BASE;
394 * MESSAGE CODES
397 #define COMMAND_COMPLETE 0x00
398 #define EXTENDED_MESSAGE 0x01
399 #define EXTENDED_MODIFY_DATA_POINTER 0x00
400 #define EXTENDED_SDTR 0x01
401 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
402 #define EXTENDED_WDTR 0x03
403 #define EXTENDED_PPR 0x04
404 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
405 #define SAVE_POINTERS 0x02
406 #define RESTORE_POINTERS 0x03
407 #define DISCONNECT 0x04
408 #define INITIATOR_ERROR 0x05
409 #define ABORT_TASK_SET 0x06
410 #define MESSAGE_REJECT 0x07
411 #define NOP 0x08
412 #define MSG_PARITY_ERROR 0x09
413 #define LINKED_CMD_COMPLETE 0x0a
414 #define LINKED_FLG_CMD_COMPLETE 0x0b
415 #define TARGET_RESET 0x0c
416 #define ABORT_TASK 0x0d
417 #define CLEAR_TASK_SET 0x0e
418 #define INITIATE_RECOVERY 0x0f /* SCSI-II only */
419 #define RELEASE_RECOVERY 0x10 /* SCSI-II only */
420 #define CLEAR_ACA 0x16
421 #define LOGICAL_UNIT_RESET 0x17
422 #define SIMPLE_QUEUE_TAG 0x20
423 #define HEAD_OF_QUEUE_TAG 0x21
424 #define ORDERED_QUEUE_TAG 0x22
425 #define IGNORE_WIDE_RESIDUE 0x23
426 #define ACA 0x24
427 #define QAS_REQUEST 0x55
429 /* Old SCSI2 names, don't use in new code */
430 #define BUS_DEVICE_RESET TARGET_RESET
431 #define ABORT ABORT_TASK_SET
434 * Host byte codes
437 #define DID_OK 0x00 /* NO error */
438 #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */
439 #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */
440 #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */
441 #define DID_BAD_TARGET 0x04 /* BAD target. */
442 #define DID_ABORT 0x05 /* Told to abort for some other reason */
443 #define DID_PARITY 0x06 /* Parity error */
444 #define DID_ERROR 0x07 /* Internal error */
445 #define DID_RESET 0x08 /* Reset by somebody. */
446 #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */
447 #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */
448 #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */
449 #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */
450 #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also
451 * without decrementing the retry count */
452 #define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution
453 * and the driver blocked the port to
454 * recover the link. Transport class will
455 * retry or fail IO */
456 #define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */
457 #define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on
458 * other paths */
459 #define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other
460 * paths might yield different results */
461 #define DID_ALLOC_FAILURE 0x12 /* Space allocation on the device failed */
462 #define DID_MEDIUM_ERROR 0x13 /* Medium error */
463 #define DRIVER_OK 0x00 /* Driver status */
466 * These indicate the error that occurred, and what is available.
469 #define DRIVER_BUSY 0x01
470 #define DRIVER_SOFT 0x02
471 #define DRIVER_MEDIA 0x03
472 #define DRIVER_ERROR 0x04
474 #define DRIVER_INVALID 0x05
475 #define DRIVER_TIMEOUT 0x06
476 #define DRIVER_HARD 0x07
477 #define DRIVER_SENSE 0x08
480 * Internal return values.
483 #define NEEDS_RETRY 0x2001
484 #define SUCCESS 0x2002
485 #define FAILED 0x2003
486 #define QUEUED 0x2004
487 #define SOFT_ERROR 0x2005
488 #define ADD_TO_MLQUEUE 0x2006
489 #define TIMEOUT_ERROR 0x2007
490 #define SCSI_RETURN_NOT_HANDLED 0x2008
491 #define FAST_IO_FAIL 0x2009
494 * Midlevel queue return values.
496 #define SCSI_MLQUEUE_HOST_BUSY 0x1055
497 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
498 #define SCSI_MLQUEUE_EH_RETRY 0x1057
499 #define SCSI_MLQUEUE_TARGET_BUSY 0x1058
502 * Use these to separate status msg and our bytes
504 * These are set by:
506 * status byte = set from target device
507 * msg_byte = return status from host adapter itself.
508 * host_byte = set by low-level driver to indicate status.
509 * driver_byte = set by mid-level.
511 #define status_byte(result) (((result) >> 1) & 0x7f)
512 #define msg_byte(result) (((result) >> 8) & 0xff)
513 #define host_byte(result) (((result) >> 16) & 0xff)
514 #define driver_byte(result) (((result) >> 24) & 0xff)
516 #define sense_class(sense) (((sense) >> 4) & 0x7)
517 #define sense_error(sense) ((sense) & 0xf)
518 #define sense_valid(sense) ((sense) & 0x80)
521 * default timeouts
523 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
524 #define START_STOP_TIMEOUT (60 * HZ)
525 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
526 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
527 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
530 #define IDENTIFY_BASE 0x80
531 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
532 ((can_disconnect) ? 0x40 : 0) |\
533 ((lun) & 0x07))
536 * struct scsi_device::scsi_level values. For SCSI devices other than those
537 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
538 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
539 * variable is visible to the user via sysfs.
542 #define SCSI_UNKNOWN 0
543 #define SCSI_1 1
544 #define SCSI_1_CCS 2
545 #define SCSI_2 3
546 #define SCSI_3 4 /* SPC */
547 #define SCSI_SPC_2 5
548 #define SCSI_SPC_3 6
551 * INQ PERIPHERAL QUALIFIERS
553 #define SCSI_INQ_PQ_CON 0x00
554 #define SCSI_INQ_PQ_NOT_CON 0x01
555 #define SCSI_INQ_PQ_NOT_CAP 0x03
559 * Here are some scsi specific ioctl commands which are sometimes useful.
561 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
564 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
565 #define SCSI_IOCTL_GET_IDLUN 0x5382
567 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
569 /* Used to obtain the host number of a device. */
570 #define SCSI_IOCTL_PROBE_HOST 0x5385
572 /* Used to obtain the bus number for a device */
573 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
575 /* Used to obtain the PCI location of a device */
576 #define SCSI_IOCTL_GET_PCI 0x5387
578 /* Pull a u32 out of a SCSI message (using BE SCSI conventions) */
579 static inline __u32 scsi_to_u32(__u8 *ptr)
581 return (ptr[0]<<24) + (ptr[1]<<16) + (ptr[2]<<8) + ptr[3];
584 #endif /* _SCSI_SCSI_H */