Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
13 | /* | |
14 | * The maximum sg list length SCSI can cope with | |
15 | * (currently must be a power of 2 between 32 and 256) | |
16 | */ | |
17 | #define SCSI_MAX_PHYS_SEGMENTS MAX_PHYS_SEGMENTS | |
18 | ||
19 | ||
20 | /* | |
21 | * SCSI command lengths | |
22 | */ | |
23 | ||
24 | extern const unsigned char scsi_command_size[8]; | |
25 | #define COMMAND_SIZE(opcode) scsi_command_size[((opcode) >> 5) & 7] | |
26 | ||
27 | /* | |
28 | * SCSI device types | |
29 | */ | |
30 | ||
31 | #define MAX_SCSI_DEVICE_CODE 14 | |
32 | extern const char *const scsi_device_types[MAX_SCSI_DEVICE_CODE]; | |
33 | ||
34 | /* | |
35 | * SCSI opcodes | |
36 | */ | |
37 | ||
38 | #define TEST_UNIT_READY 0x00 | |
39 | #define REZERO_UNIT 0x01 | |
40 | #define REQUEST_SENSE 0x03 | |
41 | #define FORMAT_UNIT 0x04 | |
42 | #define READ_BLOCK_LIMITS 0x05 | |
43 | #define REASSIGN_BLOCKS 0x07 | |
daa6eda6 | 44 | #define INITIALIZE_ELEMENT_STATUS 0x07 |
1da177e4 LT |
45 | #define READ_6 0x08 |
46 | #define WRITE_6 0x0a | |
47 | #define SEEK_6 0x0b | |
48 | #define READ_REVERSE 0x0f | |
49 | #define WRITE_FILEMARKS 0x10 | |
50 | #define SPACE 0x11 | |
51 | #define INQUIRY 0x12 | |
52 | #define RECOVER_BUFFERED_DATA 0x14 | |
53 | #define MODE_SELECT 0x15 | |
54 | #define RESERVE 0x16 | |
55 | #define RELEASE 0x17 | |
56 | #define COPY 0x18 | |
57 | #define ERASE 0x19 | |
58 | #define MODE_SENSE 0x1a | |
59 | #define START_STOP 0x1b | |
60 | #define RECEIVE_DIAGNOSTIC 0x1c | |
61 | #define SEND_DIAGNOSTIC 0x1d | |
62 | #define ALLOW_MEDIUM_REMOVAL 0x1e | |
63 | ||
64 | #define SET_WINDOW 0x24 | |
65 | #define READ_CAPACITY 0x25 | |
66 | #define READ_10 0x28 | |
67 | #define WRITE_10 0x2a | |
68 | #define SEEK_10 0x2b | |
daa6eda6 | 69 | #define POSITION_TO_ELEMENT 0x2b |
1da177e4 LT |
70 | #define WRITE_VERIFY 0x2e |
71 | #define VERIFY 0x2f | |
72 | #define SEARCH_HIGH 0x30 | |
73 | #define SEARCH_EQUAL 0x31 | |
74 | #define SEARCH_LOW 0x32 | |
75 | #define SET_LIMITS 0x33 | |
76 | #define PRE_FETCH 0x34 | |
77 | #define READ_POSITION 0x34 | |
78 | #define SYNCHRONIZE_CACHE 0x35 | |
79 | #define LOCK_UNLOCK_CACHE 0x36 | |
80 | #define READ_DEFECT_DATA 0x37 | |
81 | #define MEDIUM_SCAN 0x38 | |
82 | #define COMPARE 0x39 | |
83 | #define COPY_VERIFY 0x3a | |
84 | #define WRITE_BUFFER 0x3b | |
85 | #define READ_BUFFER 0x3c | |
86 | #define UPDATE_BLOCK 0x3d | |
87 | #define READ_LONG 0x3e | |
88 | #define WRITE_LONG 0x3f | |
89 | #define CHANGE_DEFINITION 0x40 | |
90 | #define WRITE_SAME 0x41 | |
91 | #define READ_TOC 0x43 | |
92 | #define LOG_SELECT 0x4c | |
93 | #define LOG_SENSE 0x4d | |
94 | #define MODE_SELECT_10 0x55 | |
95 | #define RESERVE_10 0x56 | |
96 | #define RELEASE_10 0x57 | |
97 | #define MODE_SENSE_10 0x5a | |
98 | #define PERSISTENT_RESERVE_IN 0x5e | |
99 | #define PERSISTENT_RESERVE_OUT 0x5f | |
100 | #define REPORT_LUNS 0xa0 | |
101 | #define MOVE_MEDIUM 0xa5 | |
daa6eda6 | 102 | #define EXCHANGE_MEDIUM 0xa6 |
1da177e4 LT |
103 | #define READ_12 0xa8 |
104 | #define WRITE_12 0xaa | |
105 | #define WRITE_VERIFY_12 0xae | |
106 | #define SEARCH_HIGH_12 0xb0 | |
107 | #define SEARCH_EQUAL_12 0xb1 | |
108 | #define SEARCH_LOW_12 0xb2 | |
109 | #define READ_ELEMENT_STATUS 0xb8 | |
110 | #define SEND_VOLUME_TAG 0xb6 | |
111 | #define WRITE_LONG_2 0xea | |
112 | #define READ_16 0x88 | |
113 | #define WRITE_16 0x8a | |
114 | #define VERIFY_16 0x8f | |
115 | #define SERVICE_ACTION_IN 0x9e | |
116 | /* values for service action in */ | |
117 | #define SAI_READ_CAPACITY_16 0x10 | |
118 | ||
119 | ||
120 | /* | |
121 | * SCSI Architecture Model (SAM) Status codes. Taken from SAM-3 draft | |
122 | * T10/1561-D Revision 4 Draft dated 7th November 2002. | |
123 | */ | |
124 | #define SAM_STAT_GOOD 0x00 | |
125 | #define SAM_STAT_CHECK_CONDITION 0x02 | |
126 | #define SAM_STAT_CONDITION_MET 0x04 | |
127 | #define SAM_STAT_BUSY 0x08 | |
128 | #define SAM_STAT_INTERMEDIATE 0x10 | |
129 | #define SAM_STAT_INTERMEDIATE_CONDITION_MET 0x14 | |
130 | #define SAM_STAT_RESERVATION_CONFLICT 0x18 | |
131 | #define SAM_STAT_COMMAND_TERMINATED 0x22 /* obsolete in SAM-3 */ | |
132 | #define SAM_STAT_TASK_SET_FULL 0x28 | |
133 | #define SAM_STAT_ACA_ACTIVE 0x30 | |
134 | #define SAM_STAT_TASK_ABORTED 0x40 | |
135 | ||
136 | /** scsi_status_is_good - check the status return. | |
137 | * | |
138 | * @status: the status passed up from the driver (including host and | |
139 | * driver components) | |
140 | * | |
141 | * This returns true for known good conditions that may be treated as | |
142 | * command completed normally | |
143 | */ | |
144 | static inline int scsi_status_is_good(int status) | |
145 | { | |
146 | /* | |
147 | * FIXME: bit0 is listed as reserved in SCSI-2, but is | |
148 | * significant in SCSI-3. For now, we follow the SCSI-2 | |
149 | * behaviour and ignore reserved bits. | |
150 | */ | |
151 | status &= 0xfe; | |
152 | return ((status == SAM_STAT_GOOD) || | |
153 | (status == SAM_STAT_INTERMEDIATE) || | |
154 | (status == SAM_STAT_INTERMEDIATE_CONDITION_MET) || | |
155 | /* FIXME: this is obsolete in SAM-3 */ | |
156 | (status == SAM_STAT_COMMAND_TERMINATED)); | |
157 | } | |
158 | ||
159 | /* | |
160 | * Status codes. These are deprecated as they are shifted 1 bit right | |
161 | * from those found in the SCSI standards. This causes confusion for | |
162 | * applications that are ported to several OSes. Prefer SAM Status codes | |
163 | * above. | |
164 | */ | |
165 | ||
166 | #define GOOD 0x00 | |
167 | #define CHECK_CONDITION 0x01 | |
168 | #define CONDITION_GOOD 0x02 | |
169 | #define BUSY 0x04 | |
170 | #define INTERMEDIATE_GOOD 0x08 | |
171 | #define INTERMEDIATE_C_GOOD 0x0a | |
172 | #define RESERVATION_CONFLICT 0x0c | |
173 | #define COMMAND_TERMINATED 0x11 | |
174 | #define QUEUE_FULL 0x14 | |
175 | #define ACA_ACTIVE 0x18 | |
176 | #define TASK_ABORTED 0x20 | |
177 | ||
178 | #define STATUS_MASK 0xfe | |
179 | ||
180 | /* | |
181 | * SENSE KEYS | |
182 | */ | |
183 | ||
184 | #define NO_SENSE 0x00 | |
185 | #define RECOVERED_ERROR 0x01 | |
186 | #define NOT_READY 0x02 | |
187 | #define MEDIUM_ERROR 0x03 | |
188 | #define HARDWARE_ERROR 0x04 | |
189 | #define ILLEGAL_REQUEST 0x05 | |
190 | #define UNIT_ATTENTION 0x06 | |
191 | #define DATA_PROTECT 0x07 | |
192 | #define BLANK_CHECK 0x08 | |
193 | #define COPY_ABORTED 0x0a | |
194 | #define ABORTED_COMMAND 0x0b | |
195 | #define VOLUME_OVERFLOW 0x0d | |
196 | #define MISCOMPARE 0x0e | |
197 | ||
198 | ||
199 | /* | |
200 | * DEVICE TYPES | |
201 | */ | |
202 | ||
203 | #define TYPE_DISK 0x00 | |
204 | #define TYPE_TAPE 0x01 | |
205 | #define TYPE_PRINTER 0x02 | |
206 | #define TYPE_PROCESSOR 0x03 /* HP scanners use this */ | |
207 | #define TYPE_WORM 0x04 /* Treated as ROM by our system */ | |
208 | #define TYPE_ROM 0x05 | |
209 | #define TYPE_SCANNER 0x06 | |
210 | #define TYPE_MOD 0x07 /* Magneto-optical disk - | |
211 | * - treated as TYPE_DISK */ | |
212 | #define TYPE_MEDIUM_CHANGER 0x08 | |
213 | #define TYPE_COMM 0x09 /* Communications device */ | |
214 | #define TYPE_ENCLOSURE 0x0d /* Enclosure Services Device */ | |
215 | #define TYPE_RAID 0x0c | |
216 | #define TYPE_NO_LUN 0x7f | |
217 | ||
218 | /* | |
219 | * standard mode-select header prepended to all mode-select commands | |
220 | */ | |
221 | ||
222 | struct ccs_modesel_head { | |
223 | __u8 _r1; /* reserved */ | |
224 | __u8 medium; /* device-specific medium type */ | |
225 | __u8 _r2; /* reserved */ | |
226 | __u8 block_desc_length; /* block descriptor length */ | |
227 | __u8 density; /* device-specific density code */ | |
228 | __u8 number_blocks_hi; /* number of blocks in this block desc */ | |
229 | __u8 number_blocks_med; | |
230 | __u8 number_blocks_lo; | |
231 | __u8 _r3; | |
232 | __u8 block_length_hi; /* block length for blocks in this desc */ | |
233 | __u8 block_length_med; | |
234 | __u8 block_length_lo; | |
235 | }; | |
236 | ||
237 | /* | |
238 | * ScsiLun: 8 byte LUN. | |
239 | */ | |
240 | struct scsi_lun { | |
241 | __u8 scsi_lun[8]; | |
242 | }; | |
243 | ||
244 | /* | |
245 | * MESSAGE CODES | |
246 | */ | |
247 | ||
248 | #define COMMAND_COMPLETE 0x00 | |
249 | #define EXTENDED_MESSAGE 0x01 | |
250 | #define EXTENDED_MODIFY_DATA_POINTER 0x00 | |
251 | #define EXTENDED_SDTR 0x01 | |
252 | #define EXTENDED_EXTENDED_IDENTIFY 0x02 /* SCSI-I only */ | |
253 | #define EXTENDED_WDTR 0x03 | |
254 | #define EXTENDED_PPR 0x04 | |
255 | #define EXTENDED_MODIFY_BIDI_DATA_PTR 0x05 | |
256 | #define SAVE_POINTERS 0x02 | |
257 | #define RESTORE_POINTERS 0x03 | |
258 | #define DISCONNECT 0x04 | |
259 | #define INITIATOR_ERROR 0x05 | |
260 | #define ABORT_TASK_SET 0x06 | |
261 | #define MESSAGE_REJECT 0x07 | |
262 | #define NOP 0x08 | |
263 | #define MSG_PARITY_ERROR 0x09 | |
264 | #define LINKED_CMD_COMPLETE 0x0a | |
265 | #define LINKED_FLG_CMD_COMPLETE 0x0b | |
266 | #define TARGET_RESET 0x0c | |
267 | #define ABORT_TASK 0x0d | |
268 | #define CLEAR_TASK_SET 0x0e | |
269 | #define INITIATE_RECOVERY 0x0f /* SCSI-II only */ | |
270 | #define RELEASE_RECOVERY 0x10 /* SCSI-II only */ | |
271 | #define CLEAR_ACA 0x16 | |
272 | #define LOGICAL_UNIT_RESET 0x17 | |
273 | #define SIMPLE_QUEUE_TAG 0x20 | |
274 | #define HEAD_OF_QUEUE_TAG 0x21 | |
275 | #define ORDERED_QUEUE_TAG 0x22 | |
276 | #define IGNORE_WIDE_RESIDUE 0x23 | |
277 | #define ACA 0x24 | |
278 | #define QAS_REQUEST 0x55 | |
279 | ||
280 | /* Old SCSI2 names, don't use in new code */ | |
281 | #define BUS_DEVICE_RESET TARGET_RESET | |
282 | #define ABORT ABORT_TASK_SET | |
283 | ||
284 | /* | |
285 | * Host byte codes | |
286 | */ | |
287 | ||
288 | #define DID_OK 0x00 /* NO error */ | |
289 | #define DID_NO_CONNECT 0x01 /* Couldn't connect before timeout period */ | |
290 | #define DID_BUS_BUSY 0x02 /* BUS stayed busy through time out period */ | |
291 | #define DID_TIME_OUT 0x03 /* TIMED OUT for other reason */ | |
292 | #define DID_BAD_TARGET 0x04 /* BAD target. */ | |
293 | #define DID_ABORT 0x05 /* Told to abort for some other reason */ | |
294 | #define DID_PARITY 0x06 /* Parity error */ | |
295 | #define DID_ERROR 0x07 /* Internal error */ | |
296 | #define DID_RESET 0x08 /* Reset by somebody. */ | |
297 | #define DID_BAD_INTR 0x09 /* Got an interrupt we weren't expecting. */ | |
298 | #define DID_PASSTHROUGH 0x0a /* Force command past mid-layer */ | |
299 | #define DID_SOFT_ERROR 0x0b /* The low level driver just wish a retry */ | |
300 | #define DID_IMM_RETRY 0x0c /* Retry without decrementing retry count */ | |
bf341919 | 301 | #define DID_REQUEUE 0x0d /* Requeue command (no immediate retry) also |
302 | * without decrementing the retry count */ | |
1da177e4 LT |
303 | #define DRIVER_OK 0x00 /* Driver status */ |
304 | ||
305 | /* | |
306 | * These indicate the error that occurred, and what is available. | |
307 | */ | |
308 | ||
309 | #define DRIVER_BUSY 0x01 | |
310 | #define DRIVER_SOFT 0x02 | |
311 | #define DRIVER_MEDIA 0x03 | |
312 | #define DRIVER_ERROR 0x04 | |
313 | ||
314 | #define DRIVER_INVALID 0x05 | |
315 | #define DRIVER_TIMEOUT 0x06 | |
316 | #define DRIVER_HARD 0x07 | |
317 | #define DRIVER_SENSE 0x08 | |
318 | ||
319 | #define SUGGEST_RETRY 0x10 | |
320 | #define SUGGEST_ABORT 0x20 | |
321 | #define SUGGEST_REMAP 0x30 | |
322 | #define SUGGEST_DIE 0x40 | |
323 | #define SUGGEST_SENSE 0x80 | |
324 | #define SUGGEST_IS_OK 0xff | |
325 | ||
326 | #define DRIVER_MASK 0x0f | |
327 | #define SUGGEST_MASK 0xf0 | |
328 | ||
329 | /* | |
330 | * Internal return values. | |
331 | */ | |
332 | ||
333 | #define NEEDS_RETRY 0x2001 | |
334 | #define SUCCESS 0x2002 | |
335 | #define FAILED 0x2003 | |
336 | #define QUEUED 0x2004 | |
337 | #define SOFT_ERROR 0x2005 | |
338 | #define ADD_TO_MLQUEUE 0x2006 | |
339 | #define TIMEOUT_ERROR 0x2007 | |
340 | ||
341 | /* | |
342 | * Midlevel queue return values. | |
343 | */ | |
344 | #define SCSI_MLQUEUE_HOST_BUSY 0x1055 | |
345 | #define SCSI_MLQUEUE_DEVICE_BUSY 0x1056 | |
346 | #define SCSI_MLQUEUE_EH_RETRY 0x1057 | |
347 | ||
348 | /* | |
349 | * Use these to separate status msg and our bytes | |
350 | * | |
351 | * These are set by: | |
352 | * | |
353 | * status byte = set from target device | |
354 | * msg_byte = return status from host adapter itself. | |
355 | * host_byte = set by low-level driver to indicate status. | |
356 | * driver_byte = set by mid-level. | |
357 | */ | |
358 | #define status_byte(result) (((result) >> 1) & 0x7f) | |
359 | #define msg_byte(result) (((result) >> 8) & 0xff) | |
360 | #define host_byte(result) (((result) >> 16) & 0xff) | |
361 | #define driver_byte(result) (((result) >> 24) & 0xff) | |
362 | #define suggestion(result) (driver_byte(result) & SUGGEST_MASK) | |
363 | ||
364 | #define sense_class(sense) (((sense) >> 4) & 0x7) | |
365 | #define sense_error(sense) ((sense) & 0xf) | |
366 | #define sense_valid(sense) ((sense) & 0x80); | |
367 | ||
b6651129 | 368 | /* |
369 | * default timeouts | |
370 | */ | |
371 | #define FORMAT_UNIT_TIMEOUT (2 * 60 * 60 * HZ) | |
372 | #define START_STOP_TIMEOUT (60 * HZ) | |
373 | #define MOVE_MEDIUM_TIMEOUT (5 * 60 * HZ) | |
374 | #define READ_ELEMENT_STATUS_TIMEOUT (5 * 60 * HZ) | |
375 | #define READ_DEFECT_DATA_TIMEOUT (60 * HZ ) | |
376 | ||
1da177e4 LT |
377 | |
378 | #define IDENTIFY_BASE 0x80 | |
379 | #define IDENTIFY(can_disconnect, lun) (IDENTIFY_BASE |\ | |
380 | ((can_disconnect) ? 0x40 : 0) |\ | |
381 | ((lun) & 0x07)) | |
382 | ||
383 | /* | |
384 | * struct scsi_device::scsi_level values. For SCSI devices other than those | |
385 | * prior to SCSI-2 (i.e. over 12 years old) this value is (resp[2] + 1) | |
386 | * where "resp" is a byte array of the response to an INQUIRY. The scsi_level | |
387 | * variable is visible to the user via sysfs. | |
388 | */ | |
389 | ||
390 | #define SCSI_UNKNOWN 0 | |
391 | #define SCSI_1 1 | |
392 | #define SCSI_1_CCS 2 | |
393 | #define SCSI_2 3 | |
394 | #define SCSI_3 4 /* SPC */ | |
395 | #define SCSI_SPC_2 5 | |
396 | #define SCSI_SPC_3 6 | |
397 | ||
398 | /* | |
399 | * INQ PERIPHERAL QUALIFIERS | |
400 | */ | |
401 | #define SCSI_INQ_PQ_CON 0x00 | |
402 | #define SCSI_INQ_PQ_NOT_CON 0x01 | |
403 | #define SCSI_INQ_PQ_NOT_CAP 0x03 | |
404 | ||
405 | ||
406 | /* | |
407 | * Here are some scsi specific ioctl commands which are sometimes useful. | |
408 | * | |
409 | * Note that include/linux/cdrom.h also defines IOCTL 0x5300 - 0x5395 | |
410 | */ | |
411 | ||
412 | /* Used to obtain PUN and LUN info. Conflicts with CDROMAUDIOBUFSIZ */ | |
413 | #define SCSI_IOCTL_GET_IDLUN 0x5382 | |
414 | ||
415 | /* 0x5383 and 0x5384 were used for SCSI_IOCTL_TAGGED_{ENABLE,DISABLE} */ | |
416 | ||
417 | /* Used to obtain the host number of a device. */ | |
418 | #define SCSI_IOCTL_PROBE_HOST 0x5385 | |
419 | ||
420 | /* Used to obtain the bus number for a device */ | |
421 | #define SCSI_IOCTL_GET_BUS_NUMBER 0x5386 | |
422 | ||
423 | /* Used to obtain the PCI location of a device */ | |
424 | #define SCSI_IOCTL_GET_PCI 0x5387 | |
425 | ||
426 | #endif /* _SCSI_SCSI_H */ |