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