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
15 struct scsi_cmnd;
16
17 enum 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 */
scsi_status_is_good(int status)41 static 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
63 struct 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
scsi_is_wlun(u64 lun)86 static inline int scsi_is_wlun(u64 lun)
87 {
88 return (lun & 0xff00) == SCSI_W_LUN_BASE;
89 }
90
91 /**
92 * scsi_status_is_check_condition - check the status return.
93 *
94 * @status: the status passed up from the driver (including host and
95 * driver components)
96 *
97 * This returns true if the status code is SAM_STAT_CHECK_CONDITION.
98 */
scsi_status_is_check_condition(int status)99 static inline int scsi_status_is_check_condition(int status)
100 {
101 if (status < 0)
102 return false;
103 status &= 0xfe;
104 return status == SAM_STAT_CHECK_CONDITION;
105 }
106
107 /*
108 * MESSAGE CODES
109 */
110
111 #define COMMAND_COMPLETE 0x00
112 #define EXTENDED_MESSAGE 0x01
113 #define EXTENDED_MODIFY_DATA_POINTER 0x00
114 #define EXTENDED_SDTR 0x01
115 #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */
116 #define EXTENDED_WDTR 0x03
117 #define EXTENDED_PPR 0x04
118 #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05
119 #define SAVE_POINTERS 0x02
120 #define RESTORE_POINTERS 0x03
121 #define DISCONNECT 0x04
122 #define INITIATOR_ERROR 0x05
123 #define ABORT_TASK_SET 0x06
124 #define MESSAGE_REJECT 0x07
125 #define NOP 0x08
126 #define MSG_PARITY_ERROR 0x09
127 #define LINKED_CMD_COMPLETE 0x0a
128 #define LINKED_FLG_CMD_COMPLETE 0x0b
129 #define TARGET_RESET 0x0c
130 #define ABORT_TASK 0x0d
131 #define CLEAR_TASK_SET 0x0e
132 #define INITIATE_RECOVERY 0x0f /* SCSI-II only */
133 #define RELEASE_RECOVERY 0x10 /* SCSI-II only */
134 #define CLEAR_ACA 0x16
135 #define LOGICAL_UNIT_RESET 0x17
136 #define SIMPLE_QUEUE_TAG 0x20
137 #define HEAD_OF_QUEUE_TAG 0x21
138 #define ORDERED_QUEUE_TAG 0x22
139 #define IGNORE_WIDE_RESIDUE 0x23
140 #define ACA 0x24
141 #define QAS_REQUEST 0x55
142
143 /* Old SCSI2 names, don't use in new code */
144 #define BUS_DEVICE_RESET TARGET_RESET
145 #define ABORT ABORT_TASK_SET
146
147 /*
148 * Host byte codes
149 */
150
151 #define DID_OK 0x00 /* NO error */
152 #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */
153 #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */
154 #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */
155 #define DID_BAD_TARGET 0x04 /* BAD target. */
156 #define DID_ABORT 0x05 /* Told to abort for some other reason */
157 #define DID_PARITY 0x06 /* Parity error */
158 #define DID_ERROR 0x07 /* Internal error */
159 #define DID_RESET 0x08 /* Reset by somebody. */
160 #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */
161 #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */
162 #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */
163 #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */
164 #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also
165 * without decrementing the retry count */
166 #define DID_TRANSPORT_DISRUPTED 0x0e /* Transport error disrupted execution
167 * and the driver blocked the port to
168 * recover the link. Transport class will
169 * retry or fail IO */
170 #define DID_TRANSPORT_FAILFAST 0x0f /* Transport class fastfailed the io */
171 #define DID_TARGET_FAILURE 0x10 /* Permanent target failure, do not retry on
172 * other paths */
173 #define DID_NEXUS_FAILURE 0x11 /* Permanent nexus failure, retry on other
174 * paths might yield different results */
175 #define DID_ALLOC_FAILURE 0x12 /* Space allocation on the device failed */
176 #define DID_MEDIUM_ERROR 0x13 /* Medium error */
177 #define DRIVER_OK 0x00 /* Driver status */
178
179 /*
180 * These indicate the error that occurred, and what is available.
181 */
182
183 #define DRIVER_BUSY 0x01
184 #define DRIVER_SOFT 0x02
185 #define DRIVER_MEDIA 0x03
186 #define DRIVER_ERROR 0x04
187
188 #define DRIVER_INVALID 0x05
189 #define DRIVER_TIMEOUT 0x06
190 #define DRIVER_HARD 0x07
191 #define DRIVER_SENSE 0x08
192
193 /*
194 * Internal return values.
195 */
196
197 #define NEEDS_RETRY 0x2001
198 #define SUCCESS 0x2002
199 #define FAILED 0x2003
200 #define QUEUED 0x2004
201 #define SOFT_ERROR 0x2005
202 #define ADD_TO_MLQUEUE 0x2006
203 #define TIMEOUT_ERROR 0x2007
204 #define SCSI_RETURN_NOT_HANDLED 0x2008
205 #define FAST_IO_FAIL 0x2009
206
207 /*
208 * Midlevel queue return values.
209 */
210 #define SCSI_MLQUEUE_HOST_BUSY 0x1055
211 #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056
212 #define SCSI_MLQUEUE_EH_RETRY 0x1057
213 #define SCSI_MLQUEUE_TARGET_BUSY 0x1058
214
215 /*
216 * Use these to separate status msg and our bytes
217 *
218 * These are set by:
219 *
220 * status byte = set from target device
221 * msg_byte = return status from host adapter itself.
222 * host_byte = set by low-level driver to indicate status.
223 * driver_byte = set by mid-level.
224 */
225 #define status_byte(result) (((result) >> 1) & 0x7f)
226 #define msg_byte(result) (((result) >> 8) & 0xff)
227 #define host_byte(result) (((result) >> 16) & 0xff)
228 #define driver_byte(result) (((result) >> 24) & 0xff)
229
230 #define sense_class(sense) (((sense) >> 4) & 0x7)
231 #define sense_error(sense) ((sense) & 0xf)
232 #define sense_valid(sense) ((sense) & 0x80)
233
234 /*
235 * default timeouts
236 */
237 #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ)
238 #define START_STOP_TIMEOUT (60 * HZ)
239 #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ)
240 #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ)
241 #define READ_DEFECT_DATA_TIMEOUT (60 * HZ )
242
243
244 #define IDENTIFY_BASE 0x80
245 #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\
246 ((can_disconnect) ? 0x40 : 0) |\
247 ((lun) & 0x07))
248
249 /*
250 * struct scsi_device::scsi_level values. For SCSI devices other than those
251 * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1)
252 * where "resp" is a byte array of the response to an INQUIRY. The scsi_level
253 * variable is visible to the user via sysfs.
254 */
255
256 #define SCSI_UNKNOWN 0
257 #define SCSI_1 1
258 #define SCSI_1_CCS 2
259 #define SCSI_2 3
260 #define SCSI_3 4 /* SPC */
261 #define SCSI_SPC_2 5
262 #define SCSI_SPC_3 6
263
264 /*
265 * INQ PERIPHERAL QUALIFIERS
266 */
267 #define SCSI_INQ_PQ_CON 0x00
268 #define SCSI_INQ_PQ_NOT_CON 0x01
269 #define SCSI_INQ_PQ_NOT_CAP 0x03
270
271
272 /*
273 * Here are some scsi specific ioctl commands which are sometimes useful.
274 *
275 * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395
276 */
277
278 /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */
279 #define SCSI_IOCTL_GET_IDLUN 0x5382
280
281 /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */
282
283 /* Used to obtain the host number of a device. */
284 #define SCSI_IOCTL_PROBE_HOST 0x5385
285
286 /* Used to obtain the bus number for a device */
287 #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386
288
289 /* Used to obtain the PCI location of a device */
290 #define SCSI_IOCTL_GET_PCI 0x5387
291
292 #endif /* _SCSI_SCSI_H */
293