1 /* SPDX-License-Identifier: GPL-2.0 */
3 * This header file contains public constants and structures used by
4 * the SCSI initiator code.
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 #include <scsi/scsi_status.h>
19 SCSI_DEFAULT_EH_TIMEOUT = 10 * HZ,
23 * DIX-capable adapters effectively support infinite chaining for the
24 * protection information scatterlist
26 #define SCSI_MAX_PROT_SG_SEGMENTS 0xFFFF
29 * Special value for scanning to specify scanning or rescanning of all
30 * possible channels, (target) ids, or luns on a given shost.
32 #define SCAN_WILD_CARD ~0
35 * standard mode-select header prepended to all mode-select commands
38 struct ccs_modesel_head {
39 __u8 _r1; /* reserved */
40 __u8 medium; /* device-specific medium type */
41 __u8 _r2; /* reserved */
42 __u8 block_desc_length; /* block descriptor length */
43 __u8 density; /* device-specific density code */
44 __u8 number_blocks_hi; /* number of blocks in this block desc */
45 __u8 number_blocks_med;
46 __u8 number_blocks_lo;
48 __u8 block_length_hi; /* block length for blocks in this desc */
49 __u8 block_length_med;
54 * The Well Known LUNS (SAM-3) in our int representation of a LUN
56 #define SCSI_W_LUN_BASE 0xc100
57 #define SCSI_W_LUN_REPORT_LUNS (SCSI_W_LUN_BASE + 1)
58 #define SCSI_W_LUN_ACCESS_CONTROL (SCSI_W_LUN_BASE + 2)
59 #define SCSI_W_LUN_TARGET_LOG_PAGE (SCSI_W_LUN_BASE + 3)
61 static inline int scsi_is_wlun(u64 lun)
63 return (lun & 0xff00) == SCSI_W_LUN_BASE;
67 * scsi_status_is_check_condition - check the status return.
69 * @status: the status passed up from the driver (including host and
72 * This returns true if the status code is SAM_STAT_CHECK_CONDITION.
74 static inline int scsi_status_is_check_condition(int status)
79 return status == SAM_STAT_CHECK_CONDITION;
83 * Extended message codes.
85 #define EXTENDED_MODIFY_DATA_POINTER 0x00
86 #define EXTENDED_SDTR 0x01
87 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
88 #define EXTENDED_WDTR 0x03
89 #define EXTENDED_PPR 0x04
90 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
93 * Internal return values.
95 enum scsi_disposition {
101 ADD_TO_MLQUEUE = 0x2006,
102 TIMEOUT_ERROR = 0x2007,
103 SCSI_RETURN_NOT_HANDLED = 0x2008,
104 FAST_IO_FAIL = 0x2009,
108 * Midlevel queue return values.
110 #define SCSI_MLQUEUE_HOST_BUSY 0x1055
111 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
112 #define SCSI_MLQUEUE_EH_RETRY 0x1057
113 #define SCSI_MLQUEUE_TARGET_BUSY 0x1058
116 * Use these to separate status msg and our bytes
120 * status byte = set from target device
122 * host_byte = set by low-level driver to indicate status.
124 #define host_byte(result) (((result) >> 16) & 0xff)
126 #define sense_class(sense) (((sense) >> 4) & 0x7)
127 #define sense_error(sense) ((sense) & 0xf)
128 #define sense_valid(sense) ((sense) & 0x80)
133 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
134 #define START_STOP_TIMEOUT (60 * HZ)
135 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
136 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
137 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
140 #define IDENTIFY_BASE 0x80
141 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
142 ((can_disconnect) ? 0x40 : 0) |\
146 * struct scsi_device::scsi_level values. For SCSI devices other than those
147 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
148 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
149 * variable is visible to the user via sysfs.
152 #define SCSI_UNKNOWN 0
156 #define SCSI_3 4 /* SPC */
161 * INQ PERIPHERAL QUALIFIERS
163 #define SCSI_INQ_PQ_CON 0x00
164 #define SCSI_INQ_PQ_NOT_CON 0x01
165 #define SCSI_INQ_PQ_NOT_CAP 0x03
169 * Here are some scsi specific ioctl commands which are sometimes useful.
171 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
174 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
175 #define SCSI_IOCTL_GET_IDLUN 0x5382
177 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
179 /* Used to obtain the host number of a device. */
180 #define SCSI_IOCTL_PROBE_HOST 0x5385
182 /* Used to obtain the bus number for a device */
183 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
185 /* Used to obtain the PCI location of a device */
186 #define SCSI_IOCTL_GET_PCI 0x5387
188 /** scsi_status_is_good - check the status return.
190 * @status: the status passed up from the driver (including host and
193 * This returns true for known good conditions that may be treated as
194 * command completed normally
196 static inline bool scsi_status_is_good(int status)
201 if (host_byte(status) == DID_NO_CONNECT)
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.
210 return ((status == SAM_STAT_GOOD) ||
211 (status == SAM_STAT_CONDITION_MET) ||
212 /* Next two "intermediate" statuses are obsolete in SAM-4 */
213 (status == SAM_STAT_INTERMEDIATE) ||
214 (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) ||
215 /* FIXME: this is obsolete in SAM-3 */
216 (status == SAM_STAT_COMMAND_TERMINATED));
219 #endif /* _SCSI_SCSI_H */