1 /*-
2 * Largely written by Julian Elischer (julian@tfs.com)
3 * for TRW Financial Systems.
4 *
5 * TRW Financial Systems, in accordance with their agreement with Carnegie
6 * Mellon University, makes this software available to CMU to distribute
7 * or use in any manner that they see fit as long as this message is kept with
8 * the software. For this reason TFS also grants any other persons or
9 * organisations permission to use or modify this software.
10 *
11 * TFS supplies this software to be publicly redistributed
12 * on the understanding that TFS is not responsible for the correct
13 * functioning of this software in any circumstances.
14 *
15 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
16 *
17 * $FreeBSD: releng/6.3/sys/cam/scsi/scsi_all.h 162172 2006-09-09 07:21:18Z ken $
18 */
19
20 /*
21 * SCSI general interface description
22 */
23
24 #ifndef _SCSI_SCSI_ALL_H
25 #define _SCSI_SCSI_ALL_H 1
26
27 #include <sys/cdefs.h>
28
29 #ifdef _KERNEL
30 /*
31 * This is the number of seconds we wait for devices to settle after a SCSI
32 * bus reset.
33 */
34 extern int scsi_delay;
35 #endif /* _KERNEL */
36
37 /*
38 * SCSI command format
39 */
40
41 /*
42 * Define dome bits that are in ALL (or a lot of) scsi commands
43 */
44 #define SCSI_CTL_LINK 0x01
45 #define SCSI_CTL_FLAG 0x02
46 #define SCSI_CTL_VENDOR 0xC0
47 #define SCSI_CMD_LUN 0xA0 /* these two should not be needed */
48 #define SCSI_CMD_LUN_SHIFT 5 /* LUN in the cmd is no longer SCSI */
49
50 #define SCSI_MAX_CDBLEN 16 /*
51 * 16 byte commands are in the
52 * SCSI-3 spec
53 */
54 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
55 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
56 #endif
57
58 /* 6byte CDBs special case 0 length to be 256 */
59 #define SCSI_CDB6_LEN(len) ((len) == 0 ? 256 : len)
60
61 /*
62 * This type defines actions to be taken when a particular sense code is
63 * received. Right now, these flags are only defined to take up 16 bits,
64 * but can be expanded in the future if necessary.
65 */
66 typedef enum {
67 SS_NOP = 0x000000, /* Do nothing */
68 SS_RETRY = 0x010000, /* Retry the command */
69 SS_FAIL = 0x020000, /* Bail out */
70 SS_START = 0x030000, /* Send a Start Unit command to the device,
71 * then retry the original command.
72 */
73 SS_TUR = 0x040000, /* Send a Test Unit Ready command to the
74 * device, then retry the original command.
75 */
76 SS_REQSENSE = 0x050000, /* Send a RequestSense command to the
77 * device, then retry the original command.
78 */
79 SS_MASK = 0xff0000
80 } scsi_sense_action;
81
82 typedef enum {
83 SSQ_NONE = 0x0000,
84 SSQ_DECREMENT_COUNT = 0x0100, /* Decrement the retry count */
85 SSQ_MANY = 0x0200, /* send lots of recovery commands */
86 SSQ_RANGE = 0x0400, /*
87 * This table entry represents the
88 * end of a range of ASCQs that
89 * have identical error actions
90 * and text.
91 */
92 SSQ_PRINT_SENSE = 0x0800,
93 SSQ_MASK = 0xff00
94 } scsi_sense_action_qualifier;
95
96 /* Mask for error status values */
97 #define SS_ERRMASK 0xff
98
99 /* The default, retyable, error action */
100 #define SS_RDEF SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
101
102 /* The retyable, error action, with table specified error code */
103 #define SS_RET SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
104
105 /* Fatal error action, with table specified error code */
106 #define SS_FATAL SS_FAIL|SSQ_PRINT_SENSE
107
108 struct scsi_generic
109 {
110 u_int8_t opcode;
111 u_int8_t bytes[11];
112 };
113
114 struct scsi_request_sense
115 {
116 u_int8_t opcode;
117 u_int8_t byte2;
118 u_int8_t unused[2];
119 u_int8_t length;
120 u_int8_t control;
121 };
122
123 struct scsi_test_unit_ready
124 {
125 u_int8_t opcode;
126 u_int8_t byte2;
127 u_int8_t unused[3];
128 u_int8_t control;
129 };
130
131 struct scsi_send_diag
132 {
133 u_int8_t opcode;
134 u_int8_t byte2;
135 #define SSD_UOL 0x01
136 #define SSD_DOL 0x02
137 #define SSD_SELFTEST 0x04
138 #define SSD_PF 0x10
139 u_int8_t unused[1];
140 u_int8_t paramlen[2];
141 u_int8_t control;
142 };
143
144 struct scsi_sense
145 {
146 u_int8_t opcode;
147 u_int8_t byte2;
148 u_int8_t unused[2];
149 u_int8_t length;
150 u_int8_t control;
151 };
152
153 struct scsi_inquiry
154 {
155 u_int8_t opcode;
156 u_int8_t byte2;
157 #define SI_EVPD 0x01
158 u_int8_t page_code;
159 u_int8_t reserved;
160 u_int8_t length;
161 u_int8_t control;
162 };
163
164 struct scsi_mode_sense_6
165 {
166 u_int8_t opcode;
167 u_int8_t byte2;
168 #define SMS_DBD 0x08
169 u_int8_t page;
170 #define SMS_PAGE_CODE 0x3F
171 #define SMS_VENDOR_SPECIFIC_PAGE 0x00
172 #define SMS_DISCONNECT_RECONNECT_PAGE 0x02
173 #define SMS_PERIPHERAL_DEVICE_PAGE 0x09
174 #define SMS_CONTROL_MODE_PAGE 0x0A
175 #define SMS_ALL_PAGES_PAGE 0x3F
176 #define SMS_PAGE_CTRL_MASK 0xC0
177 #define SMS_PAGE_CTRL_CURRENT 0x00
178 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
179 #define SMS_PAGE_CTRL_DEFAULT 0x80
180 #define SMS_PAGE_CTRL_SAVED 0xC0
181 u_int8_t unused;
182 u_int8_t length;
183 u_int8_t control;
184 };
185
186 struct scsi_mode_sense_10
187 {
188 u_int8_t opcode;
189 u_int8_t byte2; /* same bits as small version */
190 u_int8_t page; /* same bits as small version */
191 u_int8_t unused[4];
192 u_int8_t length[2];
193 u_int8_t control;
194 };
195
196 struct scsi_mode_select_6
197 {
198 u_int8_t opcode;
199 u_int8_t byte2;
200 #define SMS_SP 0x01
201 #define SMS_PF 0x10
202 u_int8_t unused[2];
203 u_int8_t length;
204 u_int8_t control;
205 };
206
207 struct scsi_mode_select_10
208 {
209 u_int8_t opcode;
210 u_int8_t byte2; /* same bits as small version */
211 u_int8_t unused[5];
212 u_int8_t length[2];
213 u_int8_t control;
214 };
215
216 /*
217 * When sending a mode select to a tape drive, the medium type must be 0.
218 */
219 struct scsi_mode_hdr_6
220 {
221 u_int8_t datalen;
222 u_int8_t medium_type;
223 u_int8_t dev_specific;
224 u_int8_t block_descr_len;
225 };
226
227 struct scsi_mode_hdr_10
228 {
229 u_int8_t datalen[2];
230 u_int8_t medium_type;
231 u_int8_t dev_specific;
232 u_int8_t reserved[2];
233 u_int8_t block_descr_len[2];
234 };
235
236 struct scsi_mode_block_descr
237 {
238 u_int8_t density_code;
239 u_int8_t num_blocks[3];
240 u_int8_t reserved;
241 u_int8_t block_len[3];
242 };
243
244 struct scsi_log_sense
245 {
246 u_int8_t opcode;
247 u_int8_t byte2;
248 #define SLS_SP 0x01
249 #define SLS_PPC 0x02
250 u_int8_t page;
251 #define SLS_PAGE_CODE 0x3F
252 #define SLS_ALL_PAGES_PAGE 0x00
253 #define SLS_OVERRUN_PAGE 0x01
254 #define SLS_ERROR_WRITE_PAGE 0x02
255 #define SLS_ERROR_READ_PAGE 0x03
256 #define SLS_ERROR_READREVERSE_PAGE 0x04
257 #define SLS_ERROR_VERIFY_PAGE 0x05
258 #define SLS_ERROR_NONMEDIUM_PAGE 0x06
259 #define SLS_ERROR_LASTN_PAGE 0x07
260 #define SLS_PAGE_CTRL_MASK 0xC0
261 #define SLS_PAGE_CTRL_THRESHOLD 0x00
262 #define SLS_PAGE_CTRL_CUMULATIVE 0x40
263 #define SLS_PAGE_CTRL_THRESH_DEFAULT 0x80
264 #define SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0
265 u_int8_t reserved[2];
266 u_int8_t paramptr[2];
267 u_int8_t length[2];
268 u_int8_t control;
269 };
270
271 struct scsi_log_select
272 {
273 u_int8_t opcode;
274 u_int8_t byte2;
275 /* SLS_SP 0x01 */
276 #define SLS_PCR 0x02
277 u_int8_t page;
278 /* SLS_PAGE_CTRL_MASK 0xC0 */
279 /* SLS_PAGE_CTRL_THRESHOLD 0x00 */
280 /* SLS_PAGE_CTRL_CUMULATIVE 0x40 */
281 /* SLS_PAGE_CTRL_THRESH_DEFAULT 0x80 */
282 /* SLS_PAGE_CTRL_CUMUL_DEFAULT 0xC0 */
283 u_int8_t reserved[4];
284 u_int8_t length[2];
285 u_int8_t control;
286 };
287
288 struct scsi_log_header
289 {
290 u_int8_t page;
291 u_int8_t reserved;
292 u_int8_t datalen[2];
293 };
294
295 struct scsi_log_param_header {
296 u_int8_t param_code[2];
297 u_int8_t param_control;
298 #define SLP_LP 0x01
299 #define SLP_LBIN 0x02
300 #define SLP_TMC_MASK 0x0C
301 #define SLP_TMC_ALWAYS 0x00
302 #define SLP_TMC_EQUAL 0x04
303 #define SLP_TMC_NOTEQUAL 0x08
304 #define SLP_TMC_GREATER 0x0C
305 #define SLP_ETC 0x10
306 #define SLP_TSD 0x20
307 #define SLP_DS 0x40
308 #define SLP_DU 0x80
309 u_int8_t param_len;
310 };
311
312 struct scsi_control_page {
313 u_int8_t page_code;
314 u_int8_t page_length;
315 u_int8_t rlec;
316 #define SCB_RLEC 0x01 /*Report Log Exception Cond*/
317 u_int8_t queue_flags;
318 #define SCP_QUEUE_ALG_MASK 0xF0
319 #define SCP_QUEUE_ALG_RESTRICTED 0x00
320 #define SCP_QUEUE_ALG_UNRESTRICTED 0x10
321 #define SCP_QUEUE_ERR 0x02 /*Queued I/O aborted for CACs*/
322 #define SCP_QUEUE_DQUE 0x01 /*Queued I/O disabled*/
323 u_int8_t eca_and_aen;
324 #define SCP_EECA 0x80 /*Enable Extended CA*/
325 #define SCP_RAENP 0x04 /*Ready AEN Permission*/
326 #define SCP_UAAENP 0x02 /*UA AEN Permission*/
327 #define SCP_EAENP 0x01 /*Error AEN Permission*/
328 u_int8_t reserved;
329 u_int8_t aen_holdoff_period[2];
330 };
331
332 struct scsi_reserve
333 {
334 u_int8_t opcode;
335 u_int8_t byte2;
336 u_int8_t unused[2];
337 u_int8_t length;
338 u_int8_t control;
339 };
340
341 struct scsi_release
342 {
343 u_int8_t opcode;
344 u_int8_t byte2;
345 u_int8_t unused[2];
346 u_int8_t length;
347 u_int8_t control;
348 };
349
350 struct scsi_prevent
351 {
352 u_int8_t opcode;
353 u_int8_t byte2;
354 u_int8_t unused[2];
355 u_int8_t how;
356 u_int8_t control;
357 };
358 #define PR_PREVENT 0x01
359 #define PR_ALLOW 0x00
360
361 struct scsi_sync_cache
362 {
363 u_int8_t opcode;
364 u_int8_t byte2;
365 u_int8_t begin_lba[4];
366 u_int8_t reserved;
367 u_int8_t lb_count[2];
368 u_int8_t control;
369 };
370
371
372 struct scsi_changedef
373 {
374 u_int8_t opcode;
375 u_int8_t byte2;
376 u_int8_t unused1;
377 u_int8_t how;
378 u_int8_t unused[4];
379 u_int8_t datalen;
380 u_int8_t control;
381 };
382
383 struct scsi_read_buffer
384 {
385 u_int8_t opcode;
386 u_int8_t byte2;
387 #define RWB_MODE 0x07
388 #define RWB_MODE_HDR_DATA 0x00
389 #define RWB_MODE_DATA 0x02
390 #define RWB_MODE_DOWNLOAD 0x04
391 #define RWB_MODE_DOWNLOAD_SAVE 0x05
392 u_int8_t buffer_id;
393 u_int8_t offset[3];
394 u_int8_t length[3];
395 u_int8_t control;
396 };
397
398 struct scsi_write_buffer
399 {
400 u_int8_t opcode;
401 u_int8_t byte2;
402 u_int8_t buffer_id;
403 u_int8_t offset[3];
404 u_int8_t length[3];
405 u_int8_t control;
406 };
407
408 struct scsi_rw_6
409 {
410 u_int8_t opcode;
411 u_int8_t addr[3];
412 /* only 5 bits are valid in the MSB address byte */
413 #define SRW_TOPADDR 0x1F
414 u_int8_t length;
415 u_int8_t control;
416 };
417
418 struct scsi_rw_10
419 {
420 u_int8_t opcode;
421 #define SRW10_RELADDR 0x01
422 /* EBP defined for WRITE(10) only */
423 #define SRW10_EBP 0x04
424 #define SRW10_FUA 0x08
425 #define SRW10_DPO 0x10
426 u_int8_t byte2;
427 u_int8_t addr[4];
428 u_int8_t reserved;
429 u_int8_t length[2];
430 u_int8_t control;
431 };
432
433 struct scsi_rw_12
434 {
435 u_int8_t opcode;
436 #define SRW12_RELADDR 0x01
437 #define SRW12_FUA 0x08
438 #define SRW12_DPO 0x10
439 u_int8_t byte2;
440 u_int8_t addr[4];
441 u_int8_t length[4];
442 u_int8_t reserved;
443 u_int8_t control;
444 };
445
446 struct scsi_rw_16
447 {
448 u_int8_t opcode;
449 #define SRW16_RELADDR 0x01
450 #define SRW16_FUA 0x08
451 #define SRW16_DPO 0x10
452 u_int8_t byte2;
453 u_int8_t addr[8];
454 u_int8_t length[4];
455 u_int8_t reserved;
456 u_int8_t control;
457 };
458
459 struct scsi_start_stop_unit
460 {
461 u_int8_t opcode;
462 u_int8_t byte2;
463 #define SSS_IMMED 0x01
464 u_int8_t reserved[2];
465 u_int8_t how;
466 #define SSS_START 0x01
467 #define SSS_LOEJ 0x02
468 u_int8_t control;
469 };
470
471 #define SC_SCSI_1 0x01
472 #define SC_SCSI_2 0x03
473
474 /*
475 * Opcodes
476 */
477
478 #define TEST_UNIT_READY 0x00
479 #define REQUEST_SENSE 0x03
480 #define READ_6 0x08
481 #define WRITE_6 0x0a
482 #define INQUIRY 0x12
483 #define MODE_SELECT_6 0x15
484 #define MODE_SENSE_6 0x1a
485 #define START_STOP_UNIT 0x1b
486 #define START_STOP 0x1b
487 #define RESERVE 0x16
488 #define RELEASE 0x17
489 #define RECEIVE_DIAGNOSTIC 0x1c
490 #define SEND_DIAGNOSTIC 0x1d
491 #define PREVENT_ALLOW 0x1e
492 #define READ_CAPACITY 0x25
493 #define READ_10 0x28
494 #define WRITE_10 0x2a
495 #define POSITION_TO_ELEMENT 0x2b
496 #define SYNCHRONIZE_CACHE 0x35
497 #define WRITE_BUFFER 0x3b
498 #define READ_BUFFER 0x3c
499 #define CHANGE_DEFINITION 0x40
500 #define LOG_SELECT 0x4c
501 #define LOG_SENSE 0x4d
502 #define MODE_SELECT_10 0x55
503 #define MODE_SENSE_10 0x5A
504 #define READ_16 0x88
505 #define WRITE_16 0x8a
506 #define SERVICE_ACTION_IN 0x9e
507 #define REPORT_LUNS 0xA0
508 #define MOVE_MEDIUM 0xa5
509 #define READ_12 0xa8
510 #define WRITE_12 0xaa
511 #define READ_ELEMENT_STATUS 0xb8
512
513
514 /*
515 * Device Types
516 */
517 #define T_DIRECT 0x00
518 #define T_SEQUENTIAL 0x01
519 #define T_PRINTER 0x02
520 #define T_PROCESSOR 0x03
521 #define T_WORM 0x04
522 #define T_CDROM 0x05
523 #define T_SCANNER 0x06
524 #define T_OPTICAL 0x07
525 #define T_CHANGER 0x08
526 #define T_COMM 0x09
527 #define T_ASC0 0x0a
528 #define T_ASC1 0x0b
529 #define T_STORARRAY 0x0c
530 #define T_ENCLOSURE 0x0d
531 #define T_RBC 0x0e
532 #define T_OCRW 0x0f
533 #define T_NODEVICE 0x1F
534 #define T_ANY 0xFF /* Used in Quirk table matches */
535
536 #define T_REMOV 1
537 #define T_FIXED 0
538
539 /*
540 * This length is the initial inquiry length used by the probe code, as
541 * well as the legnth necessary for scsi_print_inquiry() to function
542 * correctly. If either use requires a different length in the future,
543 * the two values should be de-coupled.
544 */
545 #define SHORT_INQUIRY_LENGTH 36
546
547 struct scsi_inquiry_data
548 {
549 u_int8_t device;
550 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
551 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
552 #define SID_QUAL_LU_CONNECTED 0x00 /*
553 * The specified peripheral device
554 * type is currently connected to
555 * logical unit. If the target cannot
556 * determine whether or not a physical
557 * device is currently connected, it
558 * shall also use this peripheral
559 * qualifier when returning the INQUIRY
560 * data. This peripheral qualifier
561 * does not mean that the device is
562 * ready for access by the initiator.
563 */
564 #define SID_QUAL_LU_OFFLINE 0x01 /*
565 * The target is capable of supporting
566 * the specified peripheral device type
567 * on this logical unit; however, the
568 * physical device is not currently
569 * connected to this logical unit.
570 */
571 #define SID_QUAL_RSVD 0x02
572 #define SID_QUAL_BAD_LU 0x03 /*
573 * The target is not capable of
574 * supporting a physical device on
575 * this logical unit. For this
576 * peripheral qualifier the peripheral
577 * device type shall be set to 1Fh to
578 * provide compatibility with previous
579 * versions of SCSI. All other
580 * peripheral device type values are
581 * reserved for this peripheral
582 * qualifier.
583 */
584 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
585 u_int8_t dev_qual2;
586 #define SID_QUAL2 0x7F
587 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
588 u_int8_t version;
589 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
590 #define SCSI_REV_0 0
591 #define SCSI_REV_CCS 1
592 #define SCSI_REV_2 2
593 #define SCSI_REV_SPC 3
594 #define SCSI_REV_SPC2 4
595
596 #define SID_ECMA 0x38
597 #define SID_ISO 0xC0
598 u_int8_t response_format;
599 #define SID_AENC 0x80
600 #define SID_TrmIOP 0x40
601 u_int8_t additional_length;
602 u_int8_t reserved;
603 u_int8_t spc2_flags;
604 #define SPC2_SID_MChngr 0x08
605 #define SPC2_SID_MultiP 0x10
606 #define SPC2_SID_EncServ 0x40
607 #define SPC2_SID_BQueue 0x80
608
609 #define INQ_DATA_TQ_ENABLED(iqd) \
610 ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
611 (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
612 (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
613
614
615 u_int8_t flags;
616 #define SID_SftRe 0x01
617 #define SID_CmdQue 0x02
618 #define SID_Linked 0x08
619 #define SID_Sync 0x10
620 #define SID_WBus16 0x20
621 #define SID_WBus32 0x40
622 #define SID_RelAdr 0x80
623 #define SID_VENDOR_SIZE 8
624 char vendor[SID_VENDOR_SIZE];
625 #define SID_PRODUCT_SIZE 16
626 char product[SID_PRODUCT_SIZE];
627 #define SID_REVISION_SIZE 4
628 char revision[SID_REVISION_SIZE];
629 /*
630 * The following fields were taken from SCSI Primary Commands - 2
631 * (SPC-2) Revision 14, Dated 11 November 1999
632 */
633 #define SID_VENDOR_SPECIFIC_0_SIZE 20
634 u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
635 /*
636 * An extension of SCSI Parallel Specific Values
637 */
638 #define SID_SPI_IUS 0x01
639 #define SID_SPI_QAS 0x02
640 #define SID_SPI_CLOCK_ST 0x00
641 #define SID_SPI_CLOCK_DT 0x04
642 #define SID_SPI_CLOCK_DT_ST 0x0C
643 #define SID_SPI_MASK 0x0F
644 u_int8_t spi3data;
645 u_int8_t reserved2;
646 /*
647 * Version Descriptors, stored 2 byte values.
648 */
649 u_int8_t version1[2];
650 u_int8_t version2[2];
651 u_int8_t version3[2];
652 u_int8_t version4[2];
653 u_int8_t version5[2];
654 u_int8_t version6[2];
655 u_int8_t version7[2];
656 u_int8_t version8[2];
657
658 u_int8_t reserved3[22];
659
660 #define SID_VENDOR_SPECIFIC_1_SIZE 160
661 u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
662 };
663
664 struct scsi_vpd_unit_serial_number
665 {
666 u_int8_t device;
667 u_int8_t page_code;
668 #define SVPD_UNIT_SERIAL_NUMBER 0x80
669 u_int8_t reserved;
670 u_int8_t length; /* serial number length */
671 #define SVPD_SERIAL_NUM_SIZE 251
672 u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
673 };
674
675 struct scsi_read_capacity
676 {
677 u_int8_t opcode;
678 u_int8_t byte2;
679 u_int8_t addr[4];
680 u_int8_t unused[3];
681 u_int8_t control;
682 };
683
684 struct scsi_read_capacity_16
685 {
686 uint8_t opcode;
687 #define SRC16_SERVICE_ACTION 0x10
688 uint8_t service_action;
689 uint8_t addr[8];
690 uint8_t alloc_len[4];
691 #define SRC16_PMI 0x01
692 #define SRC16_RELADR 0x02
693 uint8_t reladr;
694 uint8_t control;
695 };
696
697 struct scsi_read_capacity_data
698 {
699 u_int8_t addr[4];
700 u_int8_t length[4];
701 };
702
703 struct scsi_read_capacity_data_long
704 {
705 uint8_t addr[8];
706 uint8_t length[4];
707 };
708
709 struct scsi_report_luns
710 {
711 uint8_t opcode;
712 uint8_t reserved1;
713 #define RPL_REPORT_DEFAULT 0x00
714 #define RPL_REPORT_WELLKNOWN 0x01
715 #define RPL_REPORT_ALL 0x02
716 uint8_t select_report;
717 uint8_t reserved2[3];
718 uint8_t length[4];
719 uint8_t reserved3;
720 uint8_t control;
721 };
722
723 struct scsi_report_luns_data {
724 u_int8_t length[4]; /* length of LUN inventory, in bytes */
725 u_int8_t reserved[4]; /* unused */
726 /*
727 * LUN inventory- we only support the type zero form for now.
728 */
729 struct {
730 u_int8_t lundata[8];
731 } luns[0];
732 };
733 #define RPL_LUNDATA_PERIPH_BUS_MASK 0x3f
734 #define RPL_LUNDATA_FLAT_LUN_MASK 0x3f
735 #define RPL_LUNDATA_LUN_TARG_MASK 0x3f
736 #define RPL_LUNDATA_LUN_BUS_MASK 0xe0
737 #define RPL_LUNDATA_LUN_LUN_MASK 0x1f
738 #define RPL_LUNDATA_EXT_LEN_MASK 0x30
739 #define RPL_LUNDATA_EXT_EAM_MASK 0x0f
740 #define RPL_LUNDATA_EXT_EAM_WK 0x01
741 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC 0x0f
742 #define RPL_LUNDATA_ATYP_MASK 0xc0 /* MBZ for type 0 lun */
743 #define RPL_LUNDATA_ATYP_PERIPH 0x00
744 #define RPL_LUNDATA_ATYP_FLAT 0x40
745 #define RPL_LUNDATA_ATYP_LUN 0x80
746 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
747
748
749 struct scsi_sense_data
750 {
751 u_int8_t error_code;
752 #define SSD_ERRCODE 0x7F
753 #define SSD_CURRENT_ERROR 0x70
754 #define SSD_DEFERRED_ERROR 0x71
755 #define SSD_ERRCODE_VALID 0x80
756 u_int8_t segment;
757 u_int8_t flags;
758 #define SSD_KEY 0x0F
759 #define SSD_KEY_NO_SENSE 0x00
760 #define SSD_KEY_RECOVERED_ERROR 0x01
761 #define SSD_KEY_NOT_READY 0x02
762 #define SSD_KEY_MEDIUM_ERROR 0x03
763 #define SSD_KEY_HARDWARE_ERROR 0x04
764 #define SSD_KEY_ILLEGAL_REQUEST 0x05
765 #define SSD_KEY_UNIT_ATTENTION 0x06
766 #define SSD_KEY_DATA_PROTECT 0x07
767 #define SSD_KEY_BLANK_CHECK 0x08
768 #define SSD_KEY_Vendor_Specific 0x09
769 #define SSD_KEY_COPY_ABORTED 0x0a
770 #define SSD_KEY_ABORTED_COMMAND 0x0b
771 #define SSD_KEY_EQUAL 0x0c
772 #define SSD_KEY_VOLUME_OVERFLOW 0x0d
773 #define SSD_KEY_MISCOMPARE 0x0e
774 #define SSD_KEY_RESERVED 0x0f
775 #define SSD_ILI 0x20
776 #define SSD_EOM 0x40
777 #define SSD_FILEMARK 0x80
778 u_int8_t info[4];
779 u_int8_t extra_len;
780 u_int8_t cmd_spec_info[4];
781 u_int8_t add_sense_code;
782 u_int8_t add_sense_code_qual;
783 u_int8_t fru;
784 u_int8_t sense_key_spec[3];
785 #define SSD_SCS_VALID 0x80
786 #define SSD_FIELDPTR_CMD 0x40
787 #define SSD_BITPTR_VALID 0x08
788 #define SSD_BITPTR_VALUE 0x07
789 #define SSD_MIN_SIZE 18
790 u_int8_t extra_bytes[14];
791 #define SSD_FULL_SIZE sizeof(struct scsi_sense_data)
792 };
793
794 struct scsi_mode_header_6
795 {
796 u_int8_t data_length; /* Sense data length */
797 u_int8_t medium_type;
798 u_int8_t dev_spec;
799 u_int8_t blk_desc_len;
800 };
801
802 struct scsi_mode_header_10
803 {
804 u_int8_t data_length[2];/* Sense data length */
805 u_int8_t medium_type;
806 u_int8_t dev_spec;
807 u_int8_t unused[2];
808 u_int8_t blk_desc_len[2];
809 };
810
811 struct scsi_mode_page_header
812 {
813 u_int8_t page_code;
814 u_int8_t page_length;
815 };
816
817 struct scsi_mode_blk_desc
818 {
819 u_int8_t density;
820 u_int8_t nblocks[3];
821 u_int8_t reserved;
822 u_int8_t blklen[3];
823 };
824
825 #define SCSI_DEFAULT_DENSITY 0x00 /* use 'default' density */
826 #define SCSI_SAME_DENSITY 0x7f /* use 'same' density- >= SCSI-2 only */
827
828
829 /*
830 * Status Byte
831 */
832 #define SCSI_STATUS_OK 0x00
833 #define SCSI_STATUS_CHECK_COND 0x02
834 #define SCSI_STATUS_COND_MET 0x04
835 #define SCSI_STATUS_BUSY 0x08
836 #define SCSI_STATUS_INTERMED 0x10
837 #define SCSI_STATUS_INTERMED_COND_MET 0x14
838 #define SCSI_STATUS_RESERV_CONFLICT 0x18
839 #define SCSI_STATUS_CMD_TERMINATED 0x22 /* Obsolete in SAM-2 */
840 #define SCSI_STATUS_QUEUE_FULL 0x28
841 #define SCSI_STATUS_ACA_ACTIVE 0x30
842 #define SCSI_STATUS_TASK_ABORTED 0x40
843
844 struct scsi_inquiry_pattern {
845 u_int8_t type;
846 u_int8_t media_type;
847 #define SIP_MEDIA_REMOVABLE 0x01
848 #define SIP_MEDIA_FIXED 0x02
849 const char *vendor;
850 const char *product;
851 const char *revision;
852 };
853
854 struct scsi_static_inquiry_pattern {
855 u_int8_t type;
856 u_int8_t media_type;
857 char vendor[SID_VENDOR_SIZE+1];
858 char product[SID_PRODUCT_SIZE+1];
859 char revision[SID_REVISION_SIZE+1];
860 };
861
862 struct scsi_sense_quirk_entry {
863 struct scsi_inquiry_pattern inq_pat;
864 int num_sense_keys;
865 int num_ascs;
866 struct sense_key_table_entry *sense_key_info;
867 struct asc_table_entry *asc_info;
868 };
869
870 struct sense_key_table_entry {
871 u_int8_t sense_key;
872 u_int32_t action;
873 const char *desc;
874 };
875
876 struct asc_table_entry {
877 u_int8_t asc;
878 u_int8_t ascq;
879 u_int32_t action;
880 const char *desc;
881 };
882
883 struct op_table_entry {
884 u_int8_t opcode;
885 u_int16_t opmask;
886 const char *desc;
887 };
888
889 struct scsi_op_quirk_entry {
890 struct scsi_inquiry_pattern inq_pat;
891 int num_ops;
892 struct op_table_entry *op_table;
893 };
894
895 typedef enum {
896 SSS_FLAG_NONE = 0x00,
897 SSS_FLAG_PRINT_COMMAND = 0x01
898 } scsi_sense_string_flags;
899
900 struct ccb_scsiio;
901 struct cam_periph;
902 union ccb;
903 #ifndef _KERNEL
904 struct cam_device;
905 #endif
906
907 extern const char *scsi_sense_key_text[];
908
909 struct sbuf;
910
911 __BEGIN_DECLS
912 void scsi_sense_desc(int sense_key, int asc, int ascq,
913 struct scsi_inquiry_data *inq_data,
914 const char **sense_key_desc, const char **asc_desc);
915 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
916 struct scsi_inquiry_data *inq_data,
917 u_int32_t sense_flags);
918 const char * scsi_status_string(struct ccb_scsiio *csio);
919 #ifdef _KERNEL
920 int scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
921 int scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
922 scsi_sense_string_flags flags);
923 char * scsi_sense_string(struct ccb_scsiio *csio,
924 char *str, int str_len);
925 void scsi_sense_print(struct ccb_scsiio *csio);
926 int scsi_interpret_sense(union ccb *ccb,
927 u_int32_t sense_flags,
928 u_int32_t *relsim_flags,
929 u_int32_t *reduction,
930 u_int32_t *timeout,
931 scsi_sense_action error_action);
932 #else /* _KERNEL */
933 int scsi_command_string(struct cam_device *device,
934 struct ccb_scsiio *csio, struct sbuf *sb);
935 int scsi_sense_sbuf(struct cam_device *device,
936 struct ccb_scsiio *csio, struct sbuf *sb,
937 scsi_sense_string_flags flags);
938 char * scsi_sense_string(struct cam_device *device,
939 struct ccb_scsiio *csio,
940 char *str, int str_len);
941 void scsi_sense_print(struct cam_device *device,
942 struct ccb_scsiio *csio, FILE *ofile);
943 int scsi_interpret_sense(struct cam_device *device,
944 union ccb *ccb,
945 u_int32_t sense_flags,
946 u_int32_t *relsim_flags,
947 u_int32_t *reduction,
948 u_int32_t *timeout,
949 scsi_sense_action error_action);
950 #endif /* _KERNEL */
951
952 #define SF_RETRY_UA 0x01
953 #define SF_NO_PRINT 0x02
954 #define SF_QUIET_IR 0x04 /* Be quiet about Illegal Request reponses */
955 #define SF_PRINT_ALWAYS 0x08
956
957
958 const char * scsi_op_desc(u_int16_t opcode,
959 struct scsi_inquiry_data *inq_data);
960 char * scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
961 size_t len);
962
963 void scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
964
965 u_int scsi_calc_syncsrate(u_int period_factor);
966 u_int scsi_calc_syncparam(u_int period);
967
968 void scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
969 void (*cbfcnp)(struct cam_periph *,
970 union ccb *),
971 u_int8_t tag_action,
972 u_int8_t sense_len, u_int32_t timeout);
973
974 void scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
975 void (*cbfcnp)(struct cam_periph *,
976 union ccb *),
977 void *data_ptr, u_int8_t dxfer_len,
978 u_int8_t tag_action, u_int8_t sense_len,
979 u_int32_t timeout);
980
981 void scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
982 void (*cbfcnp)(struct cam_periph *, union ccb *),
983 u_int8_t tag_action, u_int8_t *inq_buf,
984 u_int32_t inq_len, int evpd, u_int8_t page_code,
985 u_int8_t sense_len, u_int32_t timeout);
986
987 void scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
988 void (*cbfcnp)(struct cam_periph *,
989 union ccb *),
990 u_int8_t tag_action, int dbd,
991 u_int8_t page_code, u_int8_t page,
992 u_int8_t *param_buf, u_int32_t param_len,
993 u_int8_t sense_len, u_int32_t timeout);
994
995 void scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
996 void (*cbfcnp)(struct cam_periph *,
997 union ccb *),
998 u_int8_t tag_action, int dbd,
999 u_int8_t page_code, u_int8_t page,
1000 u_int8_t *param_buf, u_int32_t param_len,
1001 int minimum_cmd_size, u_int8_t sense_len,
1002 u_int32_t timeout);
1003
1004 void scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
1005 void (*cbfcnp)(struct cam_periph *,
1006 union ccb *),
1007 u_int8_t tag_action, int scsi_page_fmt,
1008 int save_pages, u_int8_t *param_buf,
1009 u_int32_t param_len, u_int8_t sense_len,
1010 u_int32_t timeout);
1011
1012 void scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
1013 void (*cbfcnp)(struct cam_periph *,
1014 union ccb *),
1015 u_int8_t tag_action, int scsi_page_fmt,
1016 int save_pages, u_int8_t *param_buf,
1017 u_int32_t param_len, int minimum_cmd_size,
1018 u_int8_t sense_len, u_int32_t timeout);
1019
1020 void scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
1021 void (*cbfcnp)(struct cam_periph *, union ccb *),
1022 u_int8_t tag_action, u_int8_t page_code,
1023 u_int8_t page, int save_pages, int ppc,
1024 u_int32_t paramptr, u_int8_t *param_buf,
1025 u_int32_t param_len, u_int8_t sense_len,
1026 u_int32_t timeout);
1027
1028 void scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
1029 void (*cbfcnp)(struct cam_periph *,
1030 union ccb *), u_int8_t tag_action,
1031 u_int8_t page_code, int save_pages,
1032 int pc_reset, u_int8_t *param_buf,
1033 u_int32_t param_len, u_int8_t sense_len,
1034 u_int32_t timeout);
1035
1036 void scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
1037 void (*cbfcnp)(struct cam_periph *, union ccb *),
1038 u_int8_t tag_action, u_int8_t action,
1039 u_int8_t sense_len, u_int32_t timeout);
1040
1041 void scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
1042 void (*cbfcnp)(struct cam_periph *,
1043 union ccb *), u_int8_t tag_action,
1044 struct scsi_read_capacity_data *,
1045 u_int8_t sense_len, u_int32_t timeout);
1046 void scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
1047 void (*cbfcnp)(struct cam_periph *,
1048 union ccb *), uint8_t tag_action,
1049 uint64_t lba, int reladr, int pmi,
1050 struct scsi_read_capacity_data_long
1051 *rcap_buf, uint8_t sense_len,
1052 uint32_t timeout);
1053
1054 void scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
1055 void (*cbfcnp)(struct cam_periph *,
1056 union ccb *), u_int8_t tag_action,
1057 u_int8_t select_report,
1058 struct scsi_report_luns_data *rpl_buf,
1059 u_int32_t alloc_len, u_int8_t sense_len,
1060 u_int32_t timeout);
1061
1062 void scsi_synchronize_cache(struct ccb_scsiio *csio,
1063 u_int32_t retries,
1064 void (*cbfcnp)(struct cam_periph *,
1065 union ccb *), u_int8_t tag_action,
1066 u_int32_t begin_lba, u_int16_t lb_count,
1067 u_int8_t sense_len, u_int32_t timeout);
1068
1069 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
1070 void (*cbfcnp)(struct cam_periph *, union ccb *),
1071 u_int8_t tag_action, int readop, u_int8_t byte2,
1072 int minimum_cmd_size, u_int64_t lba,
1073 u_int32_t block_count, u_int8_t *data_ptr,
1074 u_int32_t dxfer_len, u_int8_t sense_len,
1075 u_int32_t timeout);
1076
1077 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
1078 void (*cbfcnp)(struct cam_periph *, union ccb *),
1079 u_int8_t tag_action, int start, int load_eject,
1080 int immediate, u_int8_t sense_len, u_int32_t timeout);
1081
1082 int scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
1083 int scsi_static_inquiry_match(caddr_t inqbuffer,
1084 caddr_t table_entry);
1085
1086 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1087 int *error_code, int *sense_key,
1088 int *asc, int *ascq);
1089 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
1090 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
1091 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
1092 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
1093 static __inline u_int32_t scsi_2btoul(u_int8_t *bytes);
1094 static __inline u_int32_t scsi_3btoul(u_int8_t *bytes);
1095 static __inline int32_t scsi_3btol(u_int8_t *bytes);
1096 static __inline u_int32_t scsi_4btoul(u_int8_t *bytes);
1097 static __inline u_int64_t scsi_8btou64(u_int8_t *bytes);
1098 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
1099 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
1100
1101 static __inline void scsi_extract_sense(struct scsi_sense_data *sense,
1102 int *error_code, int *sense_key,
1103 int *asc, int *ascq)
1104 {
1105 *error_code = sense->error_code & SSD_ERRCODE;
1106 *sense_key = sense->flags & SSD_KEY;
1107 *asc = (sense->extra_len >= 5) ? sense->add_sense_code : 0;
1108 *ascq = (sense->extra_len >= 6) ? sense->add_sense_code_qual : 0;
1109 }
1110
1111 static __inline void
1112 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
1113 {
1114
1115 bytes[0] = (val >> 8) & 0xff;
1116 bytes[1] = val & 0xff;
1117 }
1118
1119 static __inline void
1120 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
1121 {
1122
1123 bytes[0] = (val >> 16) & 0xff;
1124 bytes[1] = (val >> 8) & 0xff;
1125 bytes[2] = val & 0xff;
1126 }
1127
1128 static __inline void
1129 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
1130 {
1131
1132 bytes[0] = (val >> 24) & 0xff;
1133 bytes[1] = (val >> 16) & 0xff;
1134 bytes[2] = (val >> 8) & 0xff;
1135 bytes[3] = val & 0xff;
1136 }
1137
1138 static __inline void
1139 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
1140 {
1141
1142 bytes[0] = (val >> 56) & 0xff;
1143 bytes[1] = (val >> 48) & 0xff;
1144 bytes[2] = (val >> 40) & 0xff;
1145 bytes[3] = (val >> 32) & 0xff;
1146 bytes[4] = (val >> 24) & 0xff;
1147 bytes[5] = (val >> 16) & 0xff;
1148 bytes[6] = (val >> 8) & 0xff;
1149 bytes[7] = val & 0xff;
1150 }
1151
1152 static __inline u_int32_t
1153 scsi_2btoul(u_int8_t *bytes)
1154 {
1155 u_int32_t rv;
1156
1157 rv = (bytes[0] << 8) |
1158 bytes[1];
1159 return (rv);
1160 }
1161
1162 static __inline u_int32_t
1163 scsi_3btoul(u_int8_t *bytes)
1164 {
1165 u_int32_t rv;
1166
1167 rv = (bytes[0] << 16) |
1168 (bytes[1] << 8) |
1169 bytes[2];
1170 return (rv);
1171 }
1172
1173 static __inline int32_t
1174 scsi_3btol(u_int8_t *bytes)
1175 {
1176 u_int32_t rc = scsi_3btoul(bytes);
1177
1178 if (rc & 0x00800000)
1179 rc |= 0xff000000;
1180
1181 return (int32_t) rc;
1182 }
1183
1184 static __inline u_int32_t
1185 scsi_4btoul(u_int8_t *bytes)
1186 {
1187 u_int32_t rv;
1188
1189 rv = (bytes[0] << 24) |
1190 (bytes[1] << 16) |
1191 (bytes[2] << 8) |
1192 bytes[3];
1193 return (rv);
1194 }
1195
1196 static __inline uint64_t
1197 scsi_8btou64(uint8_t *bytes)
1198 {
1199 uint64_t rv;
1200
1201 rv = (((uint64_t)bytes[0]) << 56) |
1202 (((uint64_t)bytes[1]) << 48) |
1203 (((uint64_t)bytes[2]) << 40) |
1204 (((uint64_t)bytes[3]) << 32) |
1205 (((uint64_t)bytes[4]) << 24) |
1206 (((uint64_t)bytes[5]) << 16) |
1207 (((uint64_t)bytes[6]) << 8) |
1208 bytes[7];
1209 return (rv);
1210 }
1211
1212 /*
1213 * Given the pointer to a returned mode sense buffer, return a pointer to
1214 * the start of the first mode page.
1215 */
1216 static __inline void *
1217 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
1218 {
1219 void *page_start;
1220
1221 page_start = (void *)((u_int8_t *)&mode_header[1] +
1222 mode_header->blk_desc_len);
1223
1224 return(page_start);
1225 }
1226
1227 static __inline void *
1228 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
1229 {
1230 void *page_start;
1231
1232 page_start = (void *)((u_int8_t *)&mode_header[1] +
1233 scsi_2btoul(mode_header->blk_desc_len));
1234
1235 return(page_start);
1236 }
1237
1238 __END_DECLS
1239
1240 #endif /*_SCSI_SCSI_ALL_H*/
Cache object: a0962b68ea3c59931cbdee57913c41c5
|