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/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * This header file contains public constants and structures used by
4 * the SCSI initiator code.
5 */
6#ifndef _SCSI_SCSI_H
7#define _SCSI_SCSI_H
8
9#include <linux/types.h>
10#include <linux/scatterlist.h>
11#include <linux/kernel.h>
12#include <scsi/scsi_common.h>
13#include <scsi/scsi_proto.h>
14
15struct scsi_cmnd;
16
17enum scsi_timeouts {
18 SCSI_DEFAULT_EH_TIMEOUT = 10 * HZ,
19};
20
21/*
22 * DIX-capable adapters effectively support infinite chaining for the
23 * protection information scatterlist
24 */
25#define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF
26
27/*
28 * Special value for scanning to specify scanning or rescanning of all
29 * possible channels, (target) ids, or luns on a given shost.
30 */
31#define SCAN_WILD_CARD ~0
32
33/** scsi_status_is_good - check the status return.
34 *
35 * @status: the status passed up from the driver (including host and
36 * driver components)
37 *
38 * This returns true for known good conditions that may be treated as
39 * command completed normally
40 */
41static inline int scsi_status_is_good(int status)
42{
43 /*
44 * FIXME: bit0 is listed as reserved in SCSI-2, but is
45 * significant in SCSI-3. For now, we follow the SCSI-2
46 * behaviour and ignore reserved bits.
47 */
48 status &= 0xfe;
49 return ((status == SAM_STAT_GOOD) ||
50 (status == SAM_STAT_CONDITION_MET) ||
51 /* Next two "intermediate" statuses are obsolete in SAM-4 */
52 (status == SAM_STAT_INTERMEDIATE) ||
53 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
54 /* FIXME: this is obsolete in SAM-3 */
55 (status == SAM_STAT_COMMAND_TERMINATED));
56}
57
58
59/*
60 * standard mode-select header prepended to all mode-select commands
61 */
62
63struct ccs_modesel_head {
64 __u8 _r1; /* reserved */
65 __u8 medium; /* device-specific medium type */
66 __u8 _r2; /* reserved */
67 __u8 block_desc_length; /* block descriptor length */
68 __u8 density; /* device-specific density code */
69 __u8 number_blocks_hi; /* number of blocks in this block desc */
70 __u8 number_blocks_med;
71 __u8 number_blocks_lo;
72 __u8 _r3;
73 __u8 block_length_hi; /* block length for blocks in this desc */
74 __u8 block_length_med;
75 __u8 block_length_lo;
76};
77
78/*
79 * The Well Known LUNS (SAM-3) in our int representation of a LUN
80 */
81#define SCSI_W_LUN_BASE 0xc100
82#define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
83#define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
84#define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
85
86static inline int scsi_is_wlun(u64 lun)
87{
88 return (lun & 0xff00) == SCSI_W_LUN_BASE;
89}
90
91
92/*
93 * MESSAGE CODES
94 */
95
96#define COMMAND_COMPLETE 0x00
97#define EXTENDED_MESSAGE 0x01
98#define EXTENDED_MODIFY_DATA_POINTER 0x00
99#define EXTENDED_SDTR 0x01
100#define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
101#define EXTENDED_WDTR 0x03
102#define EXTENDED_PPR 0x04
103#define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
104#define SAVE_POINTERS 0x02
105#define RESTORE_POINTERS 0x03
106#define DISCONNECT 0x04
107#define INITIATOR_ERROR 0x05
108#define ABORT_TASK_SET 0x06
109#define MESSAGE_REJECT 0x07
110#define NOP 0x08
111#define MSG_PARITY_ERROR 0x09
112#define LINKED_CMD_COMPLETE 0x0a
113#define LINKED_FLG_CMD_COMPLETE 0x0b
114#define TARGET_RESET 0x0c
115#define ABORT_TASK 0x0d
116#define CLEAR_TASK_SET 0x0e
117#define INITIATE_RECOVERY 0x0f /* SCSI-II only */
118#define RELEASE_RECOVERY 0x10 /* SCSI-II only */
119#define CLEAR_ACA 0x16
120#define LOGICAL_UNIT_RESET 0x17
121#define SIMPLE_QUEUE_TAG 0x20
122#define HEAD_OF_QUEUE_TAG 0x21
123#define ORDERED_QUEUE_TAG 0x22
124#define IGNORE_WIDE_RESIDUE 0x23
125#define ACA 0x24
126#define QAS_REQUEST 0x55
127
128/* Old SCSI2 names, don't use in new code */
129#define BUS_DEVICE_RESET TARGET_RESET
130#define ABORT ABORT_TASK_SET
131
132/*
133 * Host byte codes
134 */
135
136#define DID_OK 0x00 /* NO error */
137#define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */
138#define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */
139#define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */
140#define DID_BAD_TARGET 0x04 /* BAD target. */
141#define DID_ABORT 0x05 /* Told to abort for some other reason */
142#define DID_PARITY 0x06 /* Parity error */
143#define DID_ERROR 0x07 /* Internal error */
144#define DID_RESET 0x08 /* Reset by somebody. */
145#define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */
146#define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */
147#define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */
148#define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */
149#define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also
150 * without decrementing the retry count */
151#define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution
152 * and the driver blocked the port to
153 * recover the link. Transport class will
154 * retry or fail IO */
155#define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */
156#define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on
157 * other paths */
158#define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other
159 * paths might yield different results */
160#define DID_ALLOC_FAILURE 0x12 /* Space allocation on the device failed */
161#define DID_MEDIUM_ERROR 0x13 /* Medium error */
162#define DRIVER_OK 0x00 /* Driver status */
163
164/*
165 * These indicate the error that occurred, and what is available.
166 */
167
168#define DRIVER_BUSY 0x01
169#define DRIVER_SOFT 0x02
170#define DRIVER_MEDIA 0x03
171#define DRIVER_ERROR 0x04
172
173#define DRIVER_INVALID 0x05
174#define DRIVER_TIMEOUT 0x06
175#define DRIVER_HARD 0x07
176#define DRIVER_SENSE 0x08
177
178/*
179 * Internal return values.
180 */
181
182#define NEEDS_RETRY 0x2001
183#define SUCCESS 0x2002
184#define FAILED 0x2003
185#define QUEUED 0x2004
186#define SOFT_ERROR 0x2005
187#define ADD_TO_MLQUEUE 0x2006
188#define TIMEOUT_ERROR 0x2007
189#define SCSI_RETURN_NOT_HANDLED 0x2008
190#define FAST_IO_FAIL 0x2009
191
192/*
193 * Midlevel queue return values.
194 */
195#define SCSI_MLQUEUE_HOST_BUSY 0x1055
196#define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
197#define SCSI_MLQUEUE_EH_RETRY 0x1057
198#define SCSI_MLQUEUE_TARGET_BUSY 0x1058
199
200/*
201 * Use these to separate status msg and our bytes
202 *
203 * These are set by:
204 *
205 * status byte = set from target device
206 * msg_byte = return status from host adapter itself.
207 * host_byte = set by low-level driver to indicate status.
208 * driver_byte = set by mid-level.
209 */
210#define status_byte(result) (((result) >> 1) & 0x7f)
211#define msg_byte(result) (((result) >> 8) & 0xff)
212#define host_byte(result) (((result) >> 16) & 0xff)
213#define driver_byte(result) (((result) >> 24) & 0xff)
214
215#define sense_class(sense) (((sense) >> 4) & 0x7)
216#define sense_error(sense) ((sense) & 0xf)
217#define sense_valid(sense) ((sense) & 0x80)
218
219/*
220 * default timeouts
221*/
222#define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
223#define START_STOP_TIMEOUT (60 * HZ)
224#define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
225#define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
226#define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
227
228
229#define IDENTIFY_BASE 0x80
230#define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
231 ((can_disconnect) ? 0x40 : 0) |\
232 ((lun) & 0x07))
233
234/*
235 * struct scsi_device::scsi_level values. For SCSI devices other than those
236 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
237 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
238 * variable is visible to the user via sysfs.
239 */
240
241#define SCSI_UNKNOWN 0
242#define SCSI_1 1
243#define SCSI_1_CCS 2
244#define SCSI_2 3
245#define SCSI_3 4 /* SPC */
246#define SCSI_SPC_2 5
247#define SCSI_SPC_3 6
248
249/*
250 * INQ PERIPHERAL QUALIFIERS
251 */
252#define SCSI_INQ_PQ_CON 0x00
253#define SCSI_INQ_PQ_NOT_CON 0x01
254#define SCSI_INQ_PQ_NOT_CAP 0x03
255
256
257/*
258 * Here are some scsi specific ioctl commands which are sometimes useful.
259 *
260 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
261 */
262
263/* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
264#define SCSI_IOCTL_GET_IDLUN 0x5382
265
266/* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
267
268/* Used to obtain the host number of a device. */
269#define SCSI_IOCTL_PROBE_HOST 0x5385
270
271/* Used to obtain the bus number for a device */
272#define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
273
274/* Used to obtain the PCI location of a device */
275#define SCSI_IOCTL_GET_PCI 0x5387
276
277#endif /* _SCSI_SCSI_H */