xref: /freebsd/sys/cam/scsi/scsi_all.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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 
18 /*
19  * SCSI general  interface description
20  */
21 
22 #ifndef	_SCSI_SCSI_ALL_H
23 #define	_SCSI_SCSI_ALL_H 1
24 
25 #ifdef _KERNEL
26 #include <sys/malloc.h>
27 #include <machine/stdarg.h>
28 #else
29 #include <stdarg.h>
30 #endif
31 
32 #ifdef _KERNEL
33 /*
34  * This is the number of seconds we wait for devices to settle after a SCSI
35  * bus reset.
36  */
37 extern int scsi_delay;
38 #endif /* _KERNEL */
39 
40 /*
41  * SCSI command format
42  */
43 
44 /*
45  * Define dome bits that are in ALL (or a lot of) scsi commands
46  */
47 #define	SCSI_CTL_LINK		0x01
48 #define	SCSI_CTL_FLAG		0x02
49 #define	SCSI_CTL_VENDOR		0xC0
50 #define	SCSI_CMD_LUN		0xA0	/* these two should not be needed */
51 #define	SCSI_CMD_LUN_SHIFT	5	/* LUN in the cmd is no longer SCSI */
52 
53 #define	SCSI_MAX_CDBLEN		16	/*
54 					 * 16 byte commands are in the
55 					 * SCSI-3 spec
56 					 */
57 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
58 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
59 #endif
60 
61 /* 6byte CDBs special case 0 length to be 256 */
62 #define	SCSI_CDB6_LEN(len)	((len) == 0 ? 256 : len)
63 
64 /*
65  * This type defines actions to be taken when a particular sense code is
66  * received.  Right now, these flags are only defined to take up 16 bits,
67  * but can be expanded in the future if necessary.
68  */
69 typedef enum {
70 	SS_NOP      = 0x000000,	/* Do nothing */
71 	SS_RETRY    = 0x010000,	/* Retry the command */
72 	SS_FAIL     = 0x020000,	/* Bail out */
73 
74 	/* Actions larger than SS_START allocate a recovery CCB */
75 	SS_START    = 0x030000,	/* Send a Start Unit command to the device,
76 				 * then retry the original command.
77 				 */
78 	SS_TUR      = 0x040000,	/* Send a Test Unit Ready command to the
79 				 * device, then retry the original command.
80 				 */
81 	SS_MASK     = 0xff0000
82 } scsi_sense_action;
83 
84 typedef enum {
85 	SSQ_NONE		= 0x0000,
86 	SSQ_DECREMENT_COUNT	= 0x0100,  /* Decrement the retry count */
87 	SSQ_MANY		= 0x0200,  /* send lots of recovery commands */
88 	SSQ_RANGE		= 0x0400,  /*
89 					    * This table entry represents the
90 					    * end of a range of ASCQs that
91 					    * have identical error actions
92 					    * and text.
93 					    */
94 	SSQ_PRINT_SENSE		= 0x0800,
95 	SSQ_UA			= 0x1000,  /* Broadcast UA. */
96 	SSQ_RESCAN		= 0x2000,  /* Rescan target for LUNs. */
97 	SSQ_LOST		= 0x4000,  /* Destroy the LUNs. */
98 	SSQ_MASK		= 0xff00
99 } scsi_sense_action_qualifier;
100 
101 /* Mask for error status values */
102 #define	SS_ERRMASK	0xff
103 
104 /* The default, retyable, error action */
105 #define	SS_RDEF		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
106 
107 /* The retyable, error action, with table specified error code */
108 #define	SS_RET		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
109 
110 /* Wait for transient error status to change */
111 #define	SS_WAIT		SS_TUR|SSQ_MANY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
112 
113 /* Fatal error action, with table specified error code */
114 #define	SS_FATAL	SS_FAIL|SSQ_PRINT_SENSE
115 
116 struct scsi_generic
117 {
118 	uint8_t opcode;
119 	uint8_t bytes[11];
120 };
121 
122 struct scsi_request_sense
123 {
124 	uint8_t opcode;
125 	uint8_t byte2;
126 #define	SRS_DESC	0x01
127 	uint8_t unused[2];
128 	uint8_t length;
129 	uint8_t control;
130 };
131 
132 struct scsi_test_unit_ready
133 {
134 	uint8_t opcode;
135 	uint8_t byte2;
136 	uint8_t unused[3];
137 	uint8_t control;
138 };
139 
140 struct scsi_receive_diag {
141 	uint8_t opcode;
142 	uint8_t byte2;
143 #define SRD_PCV		0x01
144 	uint8_t page_code;
145 	uint8_t length[2];
146 	uint8_t control;
147 };
148 
149 struct scsi_send_diag {
150 	uint8_t opcode;
151 	uint8_t byte2;
152 #define SSD_UNITOFFL				0x01
153 #define SSD_DEVOFFL				0x02
154 #define SSD_SELFTEST				0x04
155 #define SSD_PF					0x10
156 #define SSD_SELF_TEST_CODE_MASK			0xE0
157 #define SSD_SELF_TEST_CODE_SHIFT		5
158 #define		SSD_SELF_TEST_CODE_NONE		0x00
159 #define		SSD_SELF_TEST_CODE_BG_SHORT	0x01
160 #define		SSD_SELF_TEST_CODE_BG_EXTENDED	0x02
161 #define		SSD_SELF_TEST_CODE_BG_ABORT	0x04
162 #define		SSD_SELF_TEST_CODE_FG_SHORT	0x05
163 #define		SSD_SELF_TEST_CODE_FG_EXTENDED	0x06
164 	uint8_t	reserved;
165 	uint8_t	length[2];
166 	uint8_t control;
167 };
168 
169 struct scsi_sense
170 {
171 	uint8_t opcode;
172 	uint8_t byte2;
173 	uint8_t unused[2];
174 	uint8_t length;
175 	uint8_t control;
176 };
177 
178 struct scsi_inquiry
179 {
180 	uint8_t opcode;
181 	uint8_t byte2;
182 #define	SI_EVPD 	0x01
183 #define	SI_CMDDT	0x02
184 	uint8_t page_code;
185 	uint8_t length[2];
186 	uint8_t control;
187 };
188 
189 struct scsi_mode_sense_6
190 {
191 	uint8_t opcode;
192 	uint8_t byte2;
193 #define	SMS_DBD				0x08
194 	uint8_t page;
195 #define	SMS_PAGE_CODE 			0x3F
196 #define	SMS_VENDOR_SPECIFIC_PAGE	0x00
197 #define	SMS_DISCONNECT_RECONNECT_PAGE	0x02
198 #define	SMS_FORMAT_DEVICE_PAGE		0x03
199 #define	SMS_GEOMETRY_PAGE		0x04
200 #define	SMS_CACHE_PAGE			0x08
201 #define	SMS_PERIPHERAL_DEVICE_PAGE	0x09
202 #define	SMS_CONTROL_MODE_PAGE		0x0A
203 #define	SMS_PROTO_SPECIFIC_PAGE		0x19
204 #define	SMS_INFO_EXCEPTIONS_PAGE	0x1C
205 #define	SMS_ALL_PAGES_PAGE		0x3F
206 #define	SMS_PAGE_CTRL_MASK		0xC0
207 #define	SMS_PAGE_CTRL_CURRENT 		0x00
208 #define	SMS_PAGE_CTRL_CHANGEABLE 	0x40
209 #define	SMS_PAGE_CTRL_DEFAULT 		0x80
210 #define	SMS_PAGE_CTRL_SAVED 		0xC0
211 	uint8_t subpage;
212 #define	SMS_SUBPAGE_PAGE_0		0x00
213 #define	SMS_SUBPAGE_ALL			0xff
214 	uint8_t length;
215 	uint8_t control;
216 };
217 
218 struct scsi_mode_sense_10
219 {
220 	uint8_t opcode;
221 	uint8_t byte2;		/* same bits as small version */
222 #define	SMS10_LLBAA			0x10
223 	uint8_t page; 		/* same bits as small version */
224 	uint8_t subpage;
225 	uint8_t unused[3];
226 	uint8_t length[2];
227 	uint8_t control;
228 };
229 
230 struct scsi_mode_select_6
231 {
232 	uint8_t opcode;
233 	uint8_t byte2;
234 #define	SMS_SP	0x01
235 #define	SMS_RTD	0x02
236 #define	SMS_PF	0x10
237 	uint8_t unused[2];
238 	uint8_t length;
239 	uint8_t control;
240 };
241 
242 struct scsi_mode_select_10
243 {
244 	uint8_t opcode;
245 	uint8_t byte2;		/* same bits as small version */
246 	uint8_t unused[5];
247 	uint8_t length[2];
248 	uint8_t control;
249 };
250 
251 /*
252  * When sending a mode select to a tape drive, the medium type must be 0.
253  */
254 struct scsi_mode_hdr_6
255 {
256 	uint8_t datalen;
257 	uint8_t medium_type;
258 	uint8_t dev_specific;
259 	uint8_t block_descr_len;
260 };
261 
262 struct scsi_mode_hdr_10
263 {
264 	uint8_t datalen[2];
265 	uint8_t medium_type;
266 	uint8_t dev_specific;
267 	uint8_t flags;
268 #define	SMH_LONGLBA	0x01
269 	uint8_t reserved;
270 	uint8_t block_descr_len[2];
271 };
272 
273 struct scsi_mode_block_descr
274 {
275 	uint8_t density_code;
276 	uint8_t num_blocks[3];
277 	uint8_t reserved;
278 	uint8_t block_len[3];
279 };
280 
281 struct scsi_mode_block_descr_dshort
282 {
283 	uint8_t num_blocks[4];
284 	uint8_t reserved;
285 	uint8_t block_len[3];
286 };
287 
288 struct scsi_mode_block_descr_dlong
289 {
290 	uint8_t num_blocks[8];
291 	uint8_t reserved[4];
292 	uint8_t block_len[4];
293 };
294 
295 struct scsi_per_res_in
296 {
297 	uint8_t opcode;
298 	uint8_t action;
299 #define	SPRI_RK	0x00
300 #define	SPRI_RR	0x01
301 #define	SPRI_RC	0x02
302 #define	SPRI_RS	0x03
303 	uint8_t reserved[5];
304 	uint8_t length[2];
305 #define	SPRI_MAX_LEN		0xffff
306 	uint8_t control;
307 };
308 
309 struct scsi_per_res_in_header
310 {
311 	uint8_t generation[4];
312 	uint8_t length[4];
313 };
314 
315 struct scsi_per_res_key
316 {
317 	uint8_t key[8];
318 };
319 
320 struct scsi_per_res_in_keys
321 {
322 	struct scsi_per_res_in_header header;
323 	struct scsi_per_res_key keys[0];
324 };
325 
326 struct scsi_per_res_cap
327 {
328 	uint8_t length[2];
329 	uint8_t flags1;
330 #define	SPRI_RLR_C		0x80
331 #define	SPRI_CRH		0x10
332 #define	SPRI_SIP_C		0x08
333 #define	SPRI_ATP_C		0x04
334 #define	SPRI_PTPL_C		0x01
335 	uint8_t flags2;
336 #define	SPRI_TMV		0x80
337 #define	SPRI_ALLOW_CMD_MASK	0x70
338 #define	SPRI_ALLOW_CMD_SHIFT	4
339 #define	SPRI_ALLOW_NA		0x00
340 #define	SPRI_ALLOW_1		0x10
341 #define	SPRI_ALLOW_2		0x20
342 #define	SPRI_ALLOW_3		0x30
343 #define	SPRI_ALLOW_4		0x40
344 #define	SPRI_ALLOW_5		0x50
345 #define	SPRI_PTPL_A		0x01
346 	uint8_t type_mask[2];
347 #define	SPRI_TM_WR_EX_AR	0x8000
348 #define	SPRI_TM_EX_AC_RO	0x4000
349 #define	SPRI_TM_WR_EX_RO	0x2000
350 #define	SPRI_TM_EX_AC		0x0800
351 #define	SPRI_TM_WR_EX		0x0200
352 #define	SPRI_TM_EX_AC_AR	0x0001
353 	uint8_t reserved[2];
354 };
355 
356 struct scsi_per_res_in_rsrv_data
357 {
358 	uint8_t reservation[8];
359 	uint8_t scope_addr[4];
360 	uint8_t reserved;
361 	uint8_t scopetype;
362 #define	SPRT_WE    0x01
363 #define	SPRT_EA    0x03
364 #define	SPRT_WERO  0x05
365 #define	SPRT_EARO  0x06
366 #define	SPRT_WEAR  0x07
367 #define	SPRT_EAAR  0x08
368 	uint8_t extent_length[2];
369 };
370 
371 struct scsi_per_res_in_rsrv
372 {
373 	struct scsi_per_res_in_header header;
374 	struct scsi_per_res_in_rsrv_data data;
375 };
376 
377 struct scsi_per_res_in_full_desc
378 {
379 	struct scsi_per_res_key res_key;
380 	uint8_t reserved1[4];
381 	uint8_t flags;
382 #define	SPRI_FULL_ALL_TG_PT	0x02
383 #define	SPRI_FULL_R_HOLDER	0x01
384 	uint8_t scopetype;
385 	uint8_t reserved2[4];
386 	uint8_t rel_trgt_port_id[2];
387 	uint8_t additional_length[4];
388 	uint8_t transport_id[];
389 };
390 
391 struct scsi_per_res_in_full
392 {
393 	struct scsi_per_res_in_header header;
394 	struct scsi_per_res_in_full_desc desc[];
395 };
396 
397 struct scsi_per_res_out
398 {
399 	uint8_t opcode;
400 	uint8_t action;
401 #define	SPRO_REGISTER		0x00
402 #define	SPRO_RESERVE		0x01
403 #define	SPRO_RELEASE		0x02
404 #define	SPRO_CLEAR		0x03
405 #define	SPRO_PREEMPT		0x04
406 #define	SPRO_PRE_ABO		0x05
407 #define	SPRO_REG_IGNO		0x06
408 #define	SPRO_REG_MOVE		0x07
409 #define	SPRO_REPL_LOST_RES	0x08
410 #define	SPRO_ACTION_MASK	0x1f
411 	uint8_t scope_type;
412 #define	SPR_SCOPE_MASK		0xf0
413 #define	SPR_SCOPE_SHIFT		4
414 #define	SPR_LU_SCOPE		0x00
415 #define	SPR_EXTENT_SCOPE	0x10
416 #define	SPR_ELEMENT_SCOPE	0x20
417 #define	SPR_TYPE_MASK		0x0f
418 #define	SPR_TYPE_RD_SHARED	0x00
419 #define	SPR_TYPE_WR_EX		0x01
420 #define	SPR_TYPE_RD_EX		0x02
421 #define	SPR_TYPE_EX_AC		0x03
422 #define	SPR_TYPE_SHARED		0x04
423 #define	SPR_TYPE_WR_EX_RO	0x05
424 #define	SPR_TYPE_EX_AC_RO	0x06
425 #define	SPR_TYPE_WR_EX_AR	0x07
426 #define	SPR_TYPE_EX_AC_AR	0x08
427 	uint8_t reserved[2];
428 	uint8_t length[4];
429 	uint8_t control;
430 };
431 
432 struct scsi_per_res_out_parms
433 {
434 	struct scsi_per_res_key res_key;
435 	uint8_t serv_act_res_key[8];
436 	uint8_t scope_spec_address[4];
437 	uint8_t flags;
438 #define	SPR_SPEC_I_PT		0x08
439 #define	SPR_ALL_TG_PT		0x04
440 #define	SPR_APTPL		0x01
441 	uint8_t reserved1;
442 	uint8_t extent_length[2];
443 	uint8_t transport_id_list[];
444 };
445 
446 struct scsi_per_res_out_trans_ids {
447 	uint8_t additional_length[4];
448 	uint8_t transport_ids[];
449 };
450 
451 /*
452  * Used with REGISTER AND MOVE serivce action of the PERSISTENT RESERVE OUT
453  * command.
454  */
455 struct scsi_per_res_reg_move
456 {
457 	struct scsi_per_res_key res_key;
458 	uint8_t serv_act_res_key[8];
459 	uint8_t reserved;
460 	uint8_t flags;
461 #define	SPR_REG_MOVE_UNREG	0x02
462 #define	SPR_REG_MOVE_APTPL	0x01
463 	uint8_t rel_trgt_port_id[2];
464 	uint8_t transport_id_length[4];
465 	uint8_t transport_id[];
466 };
467 
468 struct scsi_transportid_header
469 {
470 	uint8_t format_protocol;
471 #define	SCSI_TRN_FORMAT_MASK		0xc0
472 #define	SCSI_TRN_FORMAT_SHIFT		6
473 #define	SCSI_TRN_PROTO_MASK		0x0f
474 };
475 
476 struct scsi_transportid_fcp
477 {
478 	uint8_t format_protocol;
479 #define	SCSI_TRN_FCP_FORMAT_DEFAULT	0x00
480 	uint8_t reserved1[7];
481 	uint8_t n_port_name[8];
482 	uint8_t reserved2[8];
483 };
484 
485 struct scsi_transportid_spi
486 {
487 	uint8_t format_protocol;
488 #define	SCSI_TRN_SPI_FORMAT_DEFAULT	0x00
489 	uint8_t reserved1;
490 	uint8_t scsi_addr[2];
491 	uint8_t obsolete[2];
492 	uint8_t rel_trgt_port_id[2];
493 	uint8_t reserved2[16];
494 };
495 
496 struct scsi_transportid_1394
497 {
498 	uint8_t format_protocol;
499 #define	SCSI_TRN_1394_FORMAT_DEFAULT	0x00
500 	uint8_t reserved1[7];
501 	uint8_t eui64[8];
502 	uint8_t reserved2[8];
503 };
504 
505 struct scsi_transportid_rdma
506 {
507 	uint8_t format_protocol;
508 #define	SCSI_TRN_RDMA_FORMAT_DEFAULT	0x00
509 	uint8_t reserved[7];
510 #define	SCSI_TRN_RDMA_PORT_LEN		16
511 	uint8_t initiator_port_id[SCSI_TRN_RDMA_PORT_LEN];
512 };
513 
514 struct scsi_transportid_iscsi_device
515 {
516 	uint8_t format_protocol;
517 #define	SCSI_TRN_ISCSI_FORMAT_DEVICE	0x00
518 	uint8_t reserved;
519 	uint8_t additional_length[2];
520 	uint8_t iscsi_name[];
521 };
522 
523 struct scsi_transportid_iscsi_port
524 {
525 	uint8_t format_protocol;
526 #define	SCSI_TRN_ISCSI_FORMAT_PORT	0x40
527 	uint8_t reserved;
528 	uint8_t additional_length[2];
529 	uint8_t iscsi_name[];
530 	/*
531 	 * Followed by a separator and iSCSI initiator session ID
532 	 */
533 };
534 
535 struct scsi_transportid_sas
536 {
537 	uint8_t format_protocol;
538 #define	SCSI_TRN_SAS_FORMAT_DEFAULT	0x00
539 	uint8_t reserved1[3];
540 	uint8_t sas_address[8];
541 	uint8_t reserved2[12];
542 };
543 
544 struct scsi_sop_routing_id_norm {
545 	uint8_t bus;
546 	uint8_t devfunc;
547 #define	SCSI_TRN_SOP_BUS_MAX		0xff
548 #define	SCSI_TRN_SOP_DEV_MAX		0x1f
549 #define	SCSI_TRN_SOP_DEV_MASK		0xf8
550 #define	SCSI_TRN_SOP_DEV_SHIFT		3
551 #define	SCSI_TRN_SOP_FUNC_NORM_MASK	0x07
552 #define	SCSI_TRN_SOP_FUNC_NORM_MAX	0x07
553 };
554 
555 struct scsi_sop_routing_id_alt {
556 	uint8_t bus;
557 	uint8_t function;
558 #define	SCSI_TRN_SOP_FUNC_ALT_MAX	0xff
559 };
560 
561 struct scsi_transportid_sop
562 {
563 	uint8_t format_protocol;
564 #define	SCSI_TRN_SOP_FORMAT_DEFAULT	0x00
565 	uint8_t reserved1;
566 	uint8_t routing_id[2];
567 	uint8_t reserved2[20];
568 };
569 
570 struct scsi_log_sense
571 {
572 	uint8_t opcode;
573 	uint8_t byte2;
574 #define	SLS_SP				0x01
575 #define	SLS_PPC				0x02
576 	uint8_t page;
577 #define	SLS_PAGE_CODE 			0x3F
578 #define	SLS_SUPPORTED_PAGES_PAGE	0x00
579 #define	SLS_OVERRUN_PAGE		0x01
580 #define	SLS_ERROR_WRITE_PAGE		0x02
581 #define	SLS_ERROR_READ_PAGE		0x03
582 #define	SLS_ERROR_READREVERSE_PAGE	0x04
583 #define	SLS_ERROR_VERIFY_PAGE		0x05
584 #define	SLS_ERROR_NONMEDIUM_PAGE	0x06
585 #define	SLS_ERROR_LASTN_PAGE		0x07
586 #define	SLS_LOGICAL_BLOCK_PROVISIONING	0x0c
587 #define	SLS_TEMPERATURE			0x0d
588 #define	SLS_SELF_TEST_PAGE		0x10
589 #define	SLS_SOLID_STATE_MEDIA		0x11
590 #define	SLS_STAT_AND_PERF		0x19
591 #define	SLS_IE_PAGE			0x2f
592 #define	SLS_PAGE_CTRL_MASK		0xC0
593 #define	SLS_PAGE_CTRL_THRESHOLD		0x00
594 #define	SLS_PAGE_CTRL_CUMULATIVE	0x40
595 #define	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80
596 #define	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0
597 	uint8_t subpage;
598 #define	SLS_SUPPORTED_SUBPAGES_SUBPAGE	0xff
599 	uint8_t reserved;
600 	uint8_t paramptr[2];
601 	uint8_t length[2];
602 	uint8_t control;
603 };
604 
605 struct scsi_log_select
606 {
607 	uint8_t opcode;
608 	uint8_t byte2;
609 /*	SLS_SP				0x01 */
610 #define	SLS_PCR				0x02
611 	uint8_t page;
612 /*	SLS_PAGE_CTRL_MASK		0xC0 */
613 /*	SLS_PAGE_CTRL_THRESHOLD		0x00 */
614 /*	SLS_PAGE_CTRL_CUMULATIVE	0x40 */
615 /*	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80 */
616 /*	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0 */
617 	uint8_t reserved[4];
618 	uint8_t length[2];
619 	uint8_t control;
620 };
621 
622 struct scsi_log_header
623 {
624 	uint8_t page;
625 #define	SL_PAGE_CODE			0x3F
626 #define	SL_SPF				0x40
627 #define	SL_DS				0x80
628 	uint8_t subpage;
629 	uint8_t datalen[2];
630 };
631 
632 struct scsi_log_param_header {
633 	uint8_t param_code[2];
634 	uint8_t param_control;
635 #define	SLP_LP				0x01
636 #define	SLP_LBIN			0x02
637 #define	SLP_TMC_MASK			0x0C
638 #define	SLP_TMC_ALWAYS			0x00
639 #define	SLP_TMC_EQUAL			0x04
640 #define	SLP_TMC_NOTEQUAL		0x08
641 #define	SLP_TMC_GREATER			0x0C
642 #define	SLP_ETC				0x10
643 #define	SLP_TSD				0x20
644 #define	SLP_DS				0x40
645 #define	SLP_DU				0x80
646 	uint8_t param_len;
647 };
648 
649 struct scsi_log_media_pct_used {
650 	struct scsi_log_param_header hdr;
651 #define	SLP_SS_MEDIA_PCT_USED		0x0001
652 	uint8_t reserved[3];
653 	uint8_t pct_used;
654 };
655 
656 struct scsi_log_stat_and_perf {
657 	struct scsi_log_param_header hdr;
658 #define	SLP_SAP				0x0001
659 	uint8_t	read_num[8];
660 	uint8_t	write_num[8];
661 	uint8_t	recvieved_lba[8];
662 	uint8_t	transmitted_lba[8];
663 	uint8_t	read_int[8];
664 	uint8_t	write_int[8];
665 	uint8_t	weighted_num[8];
666 	uint8_t	weighted_int[8];
667 };
668 
669 struct scsi_log_idle_time {
670 	struct scsi_log_param_header hdr;
671 #define	SLP_IT				0x0002
672 	uint8_t	idle_int[8];
673 };
674 
675 struct scsi_log_time_interval {
676 	struct scsi_log_param_header hdr;
677 #define	SLP_TI				0x0003
678 	uint8_t	exponent[4];
679 	uint8_t	integer[4];
680 };
681 
682 struct scsi_log_fua_stat_and_perf {
683 	struct scsi_log_param_header hdr;
684 #define	SLP_FUA_SAP			0x0004
685 	uint8_t	fua_read_num[8];
686 	uint8_t	fua_write_num[8];
687 	uint8_t	fuanv_read_num[8];
688 	uint8_t	fuanv_write_num[8];
689 	uint8_t	fua_read_int[8];
690 	uint8_t	fua_write_int[8];
691 	uint8_t	fuanv_read_int[8];
692 	uint8_t	fuanv_write_int[8];
693 };
694 
695 struct scsi_log_informational_exceptions {
696 	struct scsi_log_param_header hdr;
697 #define	SLP_IE_GEN			0x0000
698 	uint8_t	ie_asc;
699 	uint8_t	ie_ascq;
700 	uint8_t	temperature;
701 };
702 
703 struct scsi_log_temperature {
704 	struct scsi_log_param_header hdr;
705 #define	SLP_TEMPERATURE			0x0000
706 #define	SLP_REFTEMPERATURE		0x0001
707 	uint8_t	reserved;
708 	uint8_t	temperature;
709 };
710 
711 struct scsi_control_page {
712 	uint8_t page_code;
713 	uint8_t page_length;
714 	uint8_t rlec;
715 #define	SCP_RLEC			0x01	/*Report Log Exception Cond*/
716 #define	SCP_GLTSD			0x02	/*Global Logging target
717 						  save disable */
718 #define	SCP_DSENSE			0x04	/*Descriptor Sense */
719 #define	SCP_DPICZ			0x08	/*Disable Prot. Info Check
720 						  if Prot. Field is Zero */
721 #define	SCP_TMF_ONLY			0x10	/*TM Functions Only*/
722 #define	SCP_TST_MASK			0xE0	/*Task Set Type Mask*/
723 #define	SCP_TST_ONE			0x00	/*One Task Set*/
724 #define	SCP_TST_SEPARATE		0x20	/*Separate Task Sets*/
725 	uint8_t queue_flags;
726 #define	SCP_QUEUE_ALG_MASK		0xF0
727 #define	SCP_QUEUE_ALG_RESTRICTED	0x00
728 #define	SCP_QUEUE_ALG_UNRESTRICTED	0x10
729 #define	SCP_NUAR			0x08	/*No UA on release*/
730 #define	SCP_QUEUE_ERR			0x02	/*Queued I/O aborted for CACs*/
731 #define	SCP_QUEUE_DQUE			0x01	/*Queued I/O disabled*/
732 	uint8_t eca_and_aen;
733 #define	SCP_EECA			0x80	/*Enable Extended CA*/
734 #define	SCP_RAC				0x40	/*Report a check*/
735 #define	SCP_SWP				0x08	/*Software Write Protect*/
736 #define	SCP_RAENP			0x04	/*Ready AEN Permission*/
737 #define	SCP_UAAENP			0x02	/*UA AEN Permission*/
738 #define	SCP_EAENP			0x01	/*Error AEN Permission*/
739 	uint8_t flags4;
740 #define	SCP_ATO				0x80	/*Application tag owner*/
741 #define	SCP_TAS				0x40	/*Task aborted status*/
742 #define	SCP_ATMPE			0x20	/*Application tag mode page*/
743 #define	SCP_RWWP			0x10	/*Reject write without prot*/
744 	uint8_t aen_holdoff_period[2];
745 	uint8_t busy_timeout_period[2];
746 	uint8_t extended_selftest_completion_time[2];
747 };
748 
749 struct scsi_control_ext_page {
750 	uint8_t page_code;
751 #define SCEP_PAGE_CODE			0x0a
752 	uint8_t subpage_code;
753 #define SCEP_SUBPAGE_CODE		0x01
754 	uint8_t page_length[2];
755 	uint8_t flags;
756 #define	SCEP_TCMOS			0x04	/* Timestamp Changeable by */
757 #define	SCEP_SCSIP			0x02	/* SCSI Precedence (clock) */
758 #define	SCEP_IALUAE			0x01	/* Implicit ALUA Enabled */
759 	uint8_t prio;
760 	uint8_t max_sense;
761 	uint8_t reserve[25];
762 };
763 
764 struct scsi_cache_page {
765 	uint8_t page_code;
766 #define	SCHP_PAGE_SAVABLE		0x80	/* Page is savable */
767 	uint8_t page_length;
768 	uint8_t cache_flags;
769 #define	SCHP_FLAGS_WCE			0x04	/* Write Cache Enable */
770 #define	SCHP_FLAGS_MF			0x02	/* Multiplication factor */
771 #define	SCHP_FLAGS_RCD			0x01	/* Read Cache Disable */
772 	uint8_t rw_cache_policy;
773 	uint8_t dis_prefetch[2];
774 	uint8_t min_prefetch[2];
775 	uint8_t max_prefetch[2];
776 	uint8_t max_prefetch_ceil[2];
777 };
778 
779 /*
780  * XXX KDM
781  * Updated version of the cache page, as of SBC.  Update this to SBC-3 and
782  * rationalize the two.
783  */
784 struct scsi_caching_page {
785 	uint8_t page_code;
786 #define	SMS_CACHING_PAGE		0x08
787 	uint8_t page_length;
788 	uint8_t flags1;
789 #define	SCP_IC		0x80
790 #define	SCP_ABPF	0x40
791 #define	SCP_CAP		0x20
792 #define	SCP_DISC	0x10
793 #define	SCP_SIZE	0x08
794 #define	SCP_WCE		0x04
795 #define	SCP_MF		0x02
796 #define	SCP_RCD		0x01
797 	uint8_t ret_priority;
798 	uint8_t disable_pf_transfer_len[2];
799 	uint8_t min_prefetch[2];
800 	uint8_t max_prefetch[2];
801 	uint8_t max_pf_ceiling[2];
802 	uint8_t flags2;
803 #define	SCP_FSW		0x80
804 #define	SCP_LBCSS	0x40
805 #define	SCP_DRA		0x20
806 #define	SCP_VS1		0x10
807 #define	SCP_VS2		0x08
808 	uint8_t cache_segments;
809 	uint8_t cache_seg_size[2];
810 	uint8_t reserved;
811 	uint8_t non_cache_seg_size[3];
812 };
813 
814 struct scsi_info_exceptions_page {
815 	uint8_t page_code;
816 #define	SIEP_PAGE_SAVABLE		0x80	/* Page is savable */
817 	uint8_t page_length;
818 	uint8_t info_flags;
819 #define	SIEP_FLAGS_PERF			0x80
820 #define	SIEP_FLAGS_EBF			0x20
821 #define	SIEP_FLAGS_EWASC		0x10
822 #define	SIEP_FLAGS_DEXCPT		0x08
823 #define	SIEP_FLAGS_TEST			0x04
824 #define	SIEP_FLAGS_EBACKERR		0x02
825 #define	SIEP_FLAGS_LOGERR		0x01
826 	uint8_t mrie;
827 #define	SIEP_MRIE_NO		0x00
828 #define	SIEP_MRIE_UA		0x02
829 #define	SIEP_MRIE_REC_COND	0x03
830 #define	SIEP_MRIE_REC_UNCOND	0x04
831 #define	SIEP_MRIE_NO_SENSE	0x05
832 #define	SIEP_MRIE_ON_REQ	0x06
833 	uint8_t interval_timer[4];
834 	uint8_t report_count[4];
835 };
836 
837 struct scsi_logical_block_provisioning_page_descr {
838 	uint8_t flags;
839 #define	SLBPPD_ENABLED		0x80
840 #define	SLBPPD_TYPE_MASK	0x38
841 #define	SLBPPD_ARMING_MASK	0x07
842 #define	SLBPPD_ARMING_DEC	0x02
843 #define	SLBPPD_ARMING_INC	0x01
844 	uint8_t resource;
845 	uint8_t reserved[2];
846 	uint8_t count[4];
847 };
848 
849 struct scsi_logical_block_provisioning_page {
850 	uint8_t page_code;
851 	uint8_t subpage_code;
852 	uint8_t page_length[2];
853 	uint8_t flags;
854 #define	SLBPP_SITUA		0x01
855 	uint8_t reserved[11];
856 	struct scsi_logical_block_provisioning_page_descr descr[0];
857 };
858 
859 /*
860  * SCSI protocol identifier values, current as of SPC4r36l.
861  */
862 #define	SCSI_PROTO_FC		0x00	/* Fibre Channel */
863 #define	SCSI_PROTO_SPI		0x01	/* Parallel SCSI */
864 #define	SCSI_PROTO_SSA		0x02	/* Serial Storage Arch. */
865 #define	SCSI_PROTO_1394		0x03	/* IEEE 1394 (Firewire) */
866 #define	SCSI_PROTO_RDMA		0x04	/* SCSI RDMA Protocol */
867 #define	SCSI_PROTO_ISCSI	0x05	/* Internet SCSI */
868 #define	SCSI_PROTO_iSCSI	0x05	/* Internet SCSI */
869 #define	SCSI_PROTO_SAS		0x06	/* SAS Serial SCSI Protocol */
870 #define	SCSI_PROTO_ADT		0x07	/* Automation/Drive Int. Trans. Prot.*/
871 #define	SCSI_PROTO_ADITP	0x07	/* Automation/Drive Int. Trans. Prot.*/
872 #define	SCSI_PROTO_ATA		0x08	/* AT Attachment Interface */
873 #define	SCSI_PROTO_UAS		0x09	/* USB Atached SCSI */
874 #define	SCSI_PROTO_SOP		0x0a	/* SCSI over PCI Express */
875 #define	SCSI_PROTO_NONE		0x0f	/* No specific protocol */
876 
877 struct scsi_proto_specific_page {
878 	uint8_t page_code;
879 #define	SPSP_PAGE_SAVABLE		0x80	/* Page is savable */
880 	uint8_t page_length;
881 	uint8_t protocol;
882 #define	SPSP_PROTO_FC			SCSI_PROTO_FC
883 #define	SPSP_PROTO_SPI			SCSI_PROTO_SPI
884 #define	SPSP_PROTO_SSA			SCSI_PROTO_SSA
885 #define	SPSP_PROTO_1394			SCSI_PROTO_1394
886 #define	SPSP_PROTO_RDMA			SCSI_PROTO_RDMA
887 #define	SPSP_PROTO_ISCSI		SCSI_PROTO_ISCSI
888 #define	SPSP_PROTO_SAS			SCSI_PROTO_SAS
889 #define	SPSP_PROTO_ADT			SCSI_PROTO_ADITP
890 #define	SPSP_PROTO_ATA			SCSI_PROTO_ATA
891 #define	SPSP_PROTO_UAS			SCSI_PROTO_UAS
892 #define	SPSP_PROTO_SOP			SCSI_PROTO_SOP
893 #define	SPSP_PROTO_NONE			SCSI_PROTO_NONE
894 };
895 
896 struct scsi_reserve
897 {
898 	uint8_t opcode;
899 	uint8_t byte2;
900 #define	SR_EXTENT	0x01
901 #define	SR_ID_MASK	0x0e
902 #define	SR_3RDPTY	0x10
903 #define	SR_LUN_MASK	0xe0
904 	uint8_t resv_id;
905 	uint8_t length[2];
906 	uint8_t control;
907 };
908 
909 struct scsi_reserve_10 {
910 	uint8_t	opcode;
911 	uint8_t	byte2;
912 #define	SR10_3RDPTY	0x10
913 #define	SR10_LONGID	0x02
914 #define	SR10_EXTENT	0x01
915 	uint8_t resv_id;
916 	uint8_t thirdparty_id;
917 	uint8_t reserved[3];
918 	uint8_t length[2];
919 	uint8_t control;
920 };
921 
922 struct scsi_release
923 {
924 	uint8_t opcode;
925 	uint8_t byte2;
926 	uint8_t resv_id;
927 	uint8_t unused[1];
928 	uint8_t length;
929 	uint8_t control;
930 };
931 
932 struct scsi_release_10 {
933 	uint8_t opcode;
934 	uint8_t byte2;
935 	uint8_t resv_id;
936 	uint8_t thirdparty_id;
937 	uint8_t reserved[3];
938 	uint8_t length[2];
939 	uint8_t control;
940 };
941 
942 struct scsi_prevent
943 {
944 	uint8_t opcode;
945 	uint8_t byte2;
946 	uint8_t unused[2];
947 	uint8_t how;
948 	uint8_t control;
949 };
950 #define	PR_PREVENT 0x01
951 #define	PR_ALLOW   0x00
952 
953 struct scsi_sync_cache
954 {
955 	uint8_t opcode;
956 	uint8_t byte2;
957 #define	SSC_IMMED	0x02
958 #define	SSC_RELADR	0x01
959 	uint8_t begin_lba[4];
960 	uint8_t reserved;
961 	uint8_t lb_count[2];
962 	uint8_t control;
963 };
964 
965 struct scsi_sync_cache_16
966 {
967 	uint8_t opcode;
968 	uint8_t byte2;
969 	uint8_t begin_lba[8];
970 	uint8_t lb_count[4];
971 	uint8_t reserved;
972 	uint8_t control;
973 };
974 
975 struct scsi_format {
976 	uint8_t opcode;
977 	uint8_t byte2;
978 #define	SF_LONGLIST		0x20
979 #define	SF_FMTDATA		0x10
980 #define	SF_CMPLIST		0x08
981 #define	SF_FORMAT_MASK		0x07
982 #define	SF_FORMAT_BLOCK		0x00
983 #define	SF_FORMAT_LONG_BLOCK	0x03
984 #define	SF_FORMAT_BFI		0x04
985 #define	SF_FORMAT_PHYS		0x05
986 	uint8_t vendor;
987 	uint8_t interleave[2];
988 	uint8_t control;
989 };
990 
991 struct scsi_format_header_short {
992 	uint8_t reserved;
993 #define	SF_DATA_FOV	0x80
994 #define	SF_DATA_DPRY	0x40
995 #define	SF_DATA_DCRT	0x20
996 #define	SF_DATA_STPF	0x10
997 #define	SF_DATA_IP	0x08
998 #define	SF_DATA_DSP	0x04
999 #define	SF_DATA_IMMED	0x02
1000 #define	SF_DATA_VS	0x01
1001 	uint8_t byte2;
1002 	uint8_t defect_list_len[2];
1003 };
1004 
1005 struct scsi_format_header_long {
1006 	uint8_t reserved;
1007 	uint8_t byte2;
1008 	uint8_t reserved2[2];
1009 	uint8_t defect_list_len[4];
1010 };
1011 
1012 struct scsi_changedef
1013 {
1014 	uint8_t opcode;
1015 	uint8_t byte2;
1016 	uint8_t unused1;
1017 	uint8_t how;
1018 	uint8_t unused[4];
1019 	uint8_t datalen;
1020 	uint8_t control;
1021 };
1022 
1023 struct scsi_read_buffer
1024 {
1025 	uint8_t opcode;
1026 	uint8_t byte2;
1027 #define	RWB_MODE		0x1F
1028 #define	RWB_MODE_HDR_DATA	0x00
1029 #define	RWB_MODE_VENDOR		0x01
1030 #define	RWB_MODE_DATA		0x02
1031 #define	RWB_MODE_DESCR		0x03
1032 #define	RWB_MODE_DOWNLOAD	0x04
1033 #define	RWB_MODE_DOWNLOAD_SAVE	0x05
1034 #define	RWB_MODE_ECHO		0x0A
1035 #define	RWB_MODE_ECHO_DESCR	0x0B
1036 #define	RWB_MODE_ERROR_HISTORY	0x1C
1037         uint8_t buffer_id;
1038         uint8_t offset[3];
1039         uint8_t length[3];
1040         uint8_t control;
1041 };
1042 
1043 struct scsi_read_buffer_16
1044 {
1045 	uint8_t opcode;
1046 	uint8_t byte2;
1047 	uint8_t offset[8];
1048 	uint8_t length[4];
1049 	uint8_t buffer_id;
1050 	uint8_t control;
1051 };
1052 
1053 struct scsi_write_buffer
1054 {
1055 	uint8_t opcode;
1056 	uint8_t byte2;
1057 	uint8_t buffer_id;
1058 	uint8_t offset[3];
1059 	uint8_t length[3];
1060 	uint8_t control;
1061 };
1062 
1063 struct scsi_read_attribute
1064 {
1065 	uint8_t opcode;
1066 	uint8_t service_action;
1067 #define	SRA_SA_ATTR_VALUES		0x00
1068 #define	SRA_SA_ATTR_LIST		0x01
1069 #define	SRA_SA_LOG_VOL_LIST		0x02
1070 #define	SRA_SA_PART_LIST		0x03
1071 #define	SRA_SA_RESTRICTED		0x04
1072 #define	SRA_SA_SUPPORTED_ATTRS		0x05
1073 #define	SRA_SA_MASK			0x1f
1074 	uint8_t element[2];
1075 	uint8_t elem_type;
1076 	uint8_t logical_volume;
1077 	uint8_t reserved1;
1078 	uint8_t partition;
1079 	uint8_t first_attribute[2];
1080 	uint8_t length[4];
1081 	uint8_t cache;
1082 #define	SRA_CACHE			0x01
1083 	uint8_t control;
1084 };
1085 
1086 struct scsi_write_attribute
1087 {
1088 	uint8_t opcode;
1089 	uint8_t byte2;
1090 #define	SWA_WTC				0x01
1091 	uint8_t element[3];
1092 	uint8_t logical_volume;
1093 	uint8_t reserved1;
1094 	uint8_t partition;
1095 	uint8_t reserved2[2];
1096 	uint8_t length[4];
1097 	uint8_t reserved3;
1098 	uint8_t control;
1099 };
1100 
1101 struct scsi_read_attribute_values
1102 {
1103 	uint8_t length[4];
1104 	uint8_t attribute_0[0];
1105 };
1106 
1107 struct scsi_mam_attribute_header
1108 {
1109 	uint8_t id[2];
1110 	/*
1111 	 * Attributes obtained from SPC-4r36g (section 7.4.2.2) and
1112 	 * SSC-4r03 (section 4.2.21).
1113 	 */
1114 #define	SMA_ATTR_ID_DEVICE_MIN		0x0000
1115 
1116 #define	SMA_ATTR_REM_CAP_PARTITION	0x0000
1117 #define	SMA_ATTR_MAX_CAP_PARTITION	0x0001
1118 #define	SMA_ATTR_TAPEALERT_FLAGS	0x0002
1119 #define	SMA_ATTR_LOAD_COUNT		0x0003
1120 #define	SMA_ATTR_MAM_SPACE_REMAINING	0x0004
1121 
1122 #define	SMA_ATTR_DEV_ASSIGNING_ORG	0x0005
1123 #define	SMA_ATTR_FORMAT_DENSITY_CODE	0x0006
1124 #define	SMA_ATTR_INITIALIZATION_COUNT	0x0007
1125 #define	SMA_ATTR_VOLUME_ID		0x0008
1126 #define	SMA_ATTR_VOLUME_CHANGE_REF	0x0009
1127 
1128 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD	0x020a
1129 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_1	0x020b
1130 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_2	0x020c
1131 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_3	0x020d
1132 
1133 #define	SMA_ATTR_TOTAL_MB_WRITTEN_LT	0x0220
1134 #define	SMA_ATTR_TOTAL_MB_READ_LT	0x0221
1135 #define	SMA_ATTR_TOTAL_MB_WRITTEN_CUR	0x0222
1136 #define	SMA_ATTR_TOTAL_MB_READ_CUR	0x0223
1137 #define	SMA_ATTR_FIRST_ENC_BLOCK	0x0224
1138 #define	SMA_ATTR_NEXT_UNENC_BLOCK	0x0225
1139 
1140 #define	SMA_ATTR_MEDIUM_USAGE_HIST	0x0340
1141 #define	SMA_ATTR_PART_USAGE_HIST	0x0341
1142 
1143 #define	SMA_ATTR_ID_DEVICE_MAX		0x03ff
1144 
1145 #define	SMA_ATTR_ID_MEDIUM_MIN		0x0400
1146 
1147 #define	SMA_ATTR_MED_MANUF		0x0400
1148 #define	SMA_ATTR_MED_SERIAL		0x0401
1149 
1150 #define	SMA_ATTR_MED_LENGTH		0x0402
1151 #define	SMA_ATTR_MED_WIDTH		0x0403
1152 #define	SMA_ATTR_MED_ASSIGNING_ORG	0x0404
1153 #define	SMA_ATTR_MED_DENSITY_CODE	0x0405
1154 
1155 #define	SMA_ATTR_MED_MANUF_DATE		0x0406
1156 #define	SMA_ATTR_MAM_CAPACITY		0x0407
1157 #define	SMA_ATTR_MED_TYPE		0x0408
1158 #define	SMA_ATTR_MED_TYPE_INFO		0x0409
1159 #define	SMA_ATTR_MED_SERIAL_NUM		0x040a
1160 
1161 #define	SMA_ATTR_ID_MEDIUM_MAX		0x07ff
1162 
1163 #define	SMA_ATTR_ID_HOST_MIN		0x0800
1164 
1165 #define	SMA_ATTR_APP_VENDOR		0x0800
1166 #define	SMA_ATTR_APP_NAME		0x0801
1167 #define	SMA_ATTR_APP_VERSION		0x0802
1168 #define	SMA_ATTR_USER_MED_TEXT_LABEL	0x0803
1169 #define	SMA_ATTR_LAST_WRITTEN_TIME	0x0804
1170 #define	SMA_ATTR_TEXT_LOCAL_ID		0x0805
1171 #define	SMA_ATTR_BARCODE		0x0806
1172 #define	SMA_ATTR_HOST_OWNER_NAME	0x0807
1173 #define	SMA_ATTR_MEDIA_POOL		0x0808
1174 #define	SMA_ATTR_PART_USER_LABEL	0x0809
1175 #define	SMA_ATTR_LOAD_UNLOAD_AT_PART	0x080a
1176 #define	SMA_ATTR_APP_FORMAT_VERSION	0x080b
1177 #define	SMA_ATTR_VOL_COHERENCY_INFO	0x080c
1178 
1179 #define	SMA_ATTR_ID_HOST_MAX		0x0bff
1180 
1181 #define	SMA_ATTR_VENDOR_DEVICE_MIN	0x0c00
1182 #define	SMA_ATTR_VENDOR_DEVICE_MAX	0x0fff
1183 #define	SMA_ATTR_VENDOR_MEDIUM_MIN	0x1000
1184 #define	SMA_ATTR_VENDOR_MEDIUM_MAX	0x13ff
1185 #define	SMA_ATTR_VENDOR_HOST_MIN	0x1400
1186 #define	SMA_ATTR_VENDOR_HOST_MAX	0x17ff
1187 	uint8_t byte2;
1188 #define	SMA_FORMAT_BINARY	0x00
1189 #define	SMA_FORMAT_ASCII	0x01
1190 #define	SMA_FORMAT_TEXT		0x02
1191 #define	SMA_FORMAT_MASK		0x03
1192 #define	SMA_READ_ONLY		0x80
1193 	uint8_t length[2];
1194 	uint8_t attribute[0];
1195 };
1196 
1197 struct scsi_attrib_list_header {
1198 	uint8_t length[4];
1199 	uint8_t first_attr_0[0];
1200 };
1201 
1202 struct scsi_attrib_lv_list {
1203 	uint8_t length[2];
1204 	uint8_t first_lv_number;
1205 	uint8_t num_logical_volumes;
1206 };
1207 
1208 struct scsi_attrib_vendser {
1209 	uint8_t vendor[8];
1210 	uint8_t serial_num[32];
1211 };
1212 
1213 /*
1214  * These values are used to decode the Volume Coherency Information
1215  * Attribute (0x080c) for LTFS-format coherency information.
1216  * Although the Application Client Specific lengths are different for
1217  * Version 0 and Version 1, the data is in fact the same.  The length
1218  * difference was due to a code bug.
1219  */
1220 #define	SCSI_LTFS_VER0_LEN	42
1221 #define	SCSI_LTFS_VER1_LEN	43
1222 #define	SCSI_LTFS_UUID_LEN	36
1223 #define	SCSI_LTFS_STR_NAME	"LTFS"
1224 #define	SCSI_LTFS_STR_LEN	4
1225 
1226 typedef enum {
1227 	SCSI_ATTR_FLAG_NONE		= 0x00,
1228 	SCSI_ATTR_FLAG_HEX		= 0x01,
1229 	SCSI_ATTR_FLAG_FP		= 0x02,
1230 	SCSI_ATTR_FLAG_DIV_10		= 0x04,
1231 	SCSI_ATTR_FLAG_FP_1DIGIT	= 0x08
1232 } scsi_attrib_flags;
1233 
1234 typedef enum {
1235 	SCSI_ATTR_OUTPUT_NONE		= 0x00,
1236 	SCSI_ATTR_OUTPUT_TEXT_MASK	= 0x03,
1237 	SCSI_ATTR_OUTPUT_TEXT_RAW	= 0x00,
1238 	SCSI_ATTR_OUTPUT_TEXT_ESC	= 0x01,
1239 	SCSI_ATTR_OUTPUT_TEXT_RSV1	= 0x02,
1240 	SCSI_ATTR_OUTPUT_TEXT_RSV2	= 0x03,
1241 	SCSI_ATTR_OUTPUT_NONASCII_MASK	= 0x0c,
1242 	SCSI_ATTR_OUTPUT_NONASCII_TRIM	= 0x00,
1243 	SCSI_ATTR_OUTPUT_NONASCII_ESC	= 0x04,
1244 	SCSI_ATTR_OUTPUT_NONASCII_RAW	= 0x08,
1245 	SCSI_ATTR_OUTPUT_NONASCII_RSV1	= 0x0c,
1246 	SCSI_ATTR_OUTPUT_FIELD_MASK	= 0xf0,
1247 	SCSI_ATTR_OUTPUT_FIELD_ALL	= 0xf0,
1248 	SCSI_ATTR_OUTPUT_FIELD_NONE	= 0x00,
1249 	SCSI_ATTR_OUTPUT_FIELD_DESC	= 0x10,
1250 	SCSI_ATTR_OUTPUT_FIELD_NUM	= 0x20,
1251 	SCSI_ATTR_OUTPUT_FIELD_SIZE	= 0x40,
1252 	SCSI_ATTR_OUTPUT_FIELD_RW	= 0x80
1253 } scsi_attrib_output_flags;
1254 
1255 struct sbuf;
1256 
1257 struct scsi_attrib_table_entry
1258 {
1259 	uint32_t id;
1260 	uint32_t flags;
1261 	const char *desc;
1262 	const char *suffix;
1263 	int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
1264 		      uint32_t valid_len, uint32_t flags,
1265 		      uint32_t output_flags, char *error_str,
1266 		      int error_str_len);
1267 	int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr,
1268 			 uint32_t alloc_len, uint32_t flags, char *error_str,
1269 			 int error_str_len);
1270 };
1271 
1272 struct scsi_rw_6
1273 {
1274 	uint8_t opcode;
1275 	uint8_t addr[3];
1276 /* only 5 bits are valid in the MSB address byte */
1277 #define	SRW_TOPADDR	0x1F
1278 	uint8_t length;
1279 	uint8_t control;
1280 };
1281 
1282 struct scsi_rw_10
1283 {
1284 	uint8_t opcode;
1285 #define	SRW10_RELADDR	0x01
1286 /* EBP defined for WRITE(10) only */
1287 #define	SRW10_EBP	0x04
1288 #define	SRW10_FUA	0x08
1289 #define	SRW10_DPO	0x10
1290 	uint8_t byte2;
1291 	uint8_t addr[4];
1292 	uint8_t reserved;
1293 	uint8_t length[2];
1294 	uint8_t control;
1295 };
1296 
1297 struct scsi_rw_12
1298 {
1299 	uint8_t opcode;
1300 #define	SRW12_RELADDR	0x01
1301 #define	SRW12_FUA	0x08
1302 #define	SRW12_DPO	0x10
1303 	uint8_t byte2;
1304 	uint8_t addr[4];
1305 	uint8_t length[4];
1306 	uint8_t reserved;
1307 	uint8_t control;
1308 };
1309 
1310 struct scsi_rw_16
1311 {
1312 	uint8_t opcode;
1313 #define	SRW16_RELADDR	0x01
1314 #define	SRW16_FUA	0x08
1315 #define	SRW16_DPO	0x10
1316 	uint8_t byte2;
1317 	uint8_t addr[8];
1318 	uint8_t length[4];
1319 	uint8_t reserved;
1320 	uint8_t control;
1321 };
1322 
1323 struct scsi_write_atomic_16
1324 {
1325 	uint8_t	opcode;
1326 	uint8_t	byte2;
1327 	uint8_t	addr[8];
1328 	uint8_t	boundary[2];
1329 	uint8_t	length[2];
1330 	uint8_t	group;
1331 	uint8_t	control;
1332 };
1333 
1334 struct scsi_write_same_10
1335 {
1336 	uint8_t	opcode;
1337 	uint8_t	byte2;
1338 #define	SWS_LBDATA	0x02
1339 #define	SWS_PBDATA	0x04
1340 #define	SWS_UNMAP	0x08
1341 #define	SWS_ANCHOR	0x10
1342 	uint8_t	addr[4];
1343 	uint8_t	group;
1344 	uint8_t	length[2];
1345 	uint8_t	control;
1346 };
1347 
1348 struct scsi_write_same_16
1349 {
1350 	uint8_t	opcode;
1351 	uint8_t	byte2;
1352 #define	SWS_NDOB	0x01
1353 	uint8_t	addr[8];
1354 	uint8_t	length[4];
1355 	uint8_t	group;
1356 	uint8_t	control;
1357 };
1358 
1359 struct scsi_unmap
1360 {
1361 	uint8_t	opcode;
1362 	uint8_t	byte2;
1363 #define	SU_ANCHOR	0x01
1364 	uint8_t	reserved[4];
1365 	uint8_t	group;
1366 	uint8_t	length[2];
1367 	uint8_t	control;
1368 };
1369 
1370 struct scsi_unmap_header
1371 {
1372 	uint8_t	length[2];
1373 	uint8_t	desc_length[2];
1374 	uint8_t	reserved[4];
1375 };
1376 
1377 struct scsi_unmap_desc
1378 {
1379 	uint8_t	lba[8];
1380 	uint8_t	length[4];
1381 	uint8_t	reserved[4];
1382 };
1383 
1384 struct scsi_write_verify_10
1385 {
1386 	uint8_t	opcode;
1387 	uint8_t	byte2;
1388 #define	SWV_BYTCHK		0x02
1389 #define	SWV_DPO			0x10
1390 #define	SWV_WRPROECT_MASK	0xe0
1391 	uint8_t	addr[4];
1392 	uint8_t	group;
1393 	uint8_t length[2];
1394 	uint8_t	control;
1395 };
1396 
1397 struct scsi_write_verify_12
1398 {
1399 	uint8_t	opcode;
1400 	uint8_t	byte2;
1401 	uint8_t	addr[4];
1402 	uint8_t	length[4];
1403 	uint8_t	group;
1404 	uint8_t	control;
1405 };
1406 
1407 struct scsi_write_verify_16
1408 {
1409 	uint8_t	opcode;
1410 	uint8_t	byte2;
1411 	uint8_t	addr[8];
1412 	uint8_t	length[4];
1413 	uint8_t	group;
1414 	uint8_t	control;
1415 };
1416 
1417 struct scsi_start_stop_unit
1418 {
1419 	uint8_t opcode;
1420 	uint8_t byte2;
1421 #define	SSS_IMMED		0x01
1422 	uint8_t reserved[2];
1423 	uint8_t how;
1424 #define	SSS_START		0x01
1425 #define	SSS_LOEJ		0x02
1426 #define	SSS_PC_MASK		0xf0
1427 #define	SSS_PC_START_VALID	0x00
1428 #define	SSS_PC_ACTIVE		0x10
1429 #define	SSS_PC_IDLE		0x20
1430 #define	SSS_PC_STANDBY		0x30
1431 #define	SSS_PC_LU_CONTROL	0x70
1432 #define	SSS_PC_FORCE_IDLE_0	0xa0
1433 #define	SSS_PC_FORCE_STANDBY_0	0xb0
1434 	uint8_t control;
1435 };
1436 
1437 struct ata_pass_12 {
1438 	uint8_t opcode;
1439 	uint8_t protocol;
1440 #define	AP_PROTO_HARD_RESET	(0x00 << 1)
1441 #define	AP_PROTO_SRST		(0x01 << 1)
1442 #define	AP_PROTO_NON_DATA	(0x03 << 1)
1443 #define	AP_PROTO_PIO_IN		(0x04 << 1)
1444 #define	AP_PROTO_PIO_OUT	(0x05 << 1)
1445 #define	AP_PROTO_DMA		(0x06 << 1)
1446 #define	AP_PROTO_DMA_QUEUED	(0x07 << 1)
1447 #define	AP_PROTO_DEVICE_DIAG	(0x08 << 1)
1448 #define	AP_PROTO_DEVICE_RESET	(0x09 << 1)
1449 #define	AP_PROTO_UDMA_IN	(0x0a << 1)
1450 #define	AP_PROTO_UDMA_OUT	(0x0b << 1)
1451 #define	AP_PROTO_FPDMA		(0x0c << 1)
1452 #define	AP_PROTO_RESP_INFO	(0x0f << 1)
1453 #define AP_PROTO_MASK		0x1e
1454 #define	AP_MULTI	0xe0
1455 	uint8_t flags;
1456 #define	AP_T_LEN	0x03
1457 #define	AP_BB		0x04
1458 #define	AP_T_DIR	0x08
1459 #define	AP_CK_COND	0x20
1460 #define	AP_OFFLINE	0x60
1461 	uint8_t features;
1462 	uint8_t sector_count;
1463 	uint8_t lba_low;
1464 	uint8_t lba_mid;
1465 	uint8_t lba_high;
1466 	uint8_t device;
1467 	uint8_t command;
1468 	uint8_t reserved;
1469 	uint8_t control;
1470 };
1471 
1472 struct scsi_maintenance_in
1473 {
1474         uint8_t  opcode;
1475         uint8_t  byte2;
1476 #define SERVICE_ACTION_MASK  0x1f
1477 #define SA_RPRT_TRGT_GRP     0x0a
1478         uint8_t  reserved[4];
1479 	uint8_t  length[4];
1480 	uint8_t  reserved1;
1481 	uint8_t  control;
1482 };
1483 
1484 struct scsi_report_ident_info
1485 {
1486 	uint8_t  opcode;
1487 	uint8_t  service_action;
1488 	uint8_t  reserved[4];
1489 	uint8_t  length[4];
1490 	uint8_t  type;
1491 #define RII_LUII		0x00
1492 #define RII_LUTII		0x04
1493 #define RII_IIS			0xfc
1494 	uint8_t  control;
1495 };
1496 
1497 struct scsi_report_ident_info_data
1498 {
1499 	uint8_t  reserved[2];
1500 	uint8_t  length[2];
1501 };
1502 
1503 struct scsi_report_ident_info_descr
1504 {
1505 	uint8_t  type;
1506 	uint8_t  reserved;
1507 	uint8_t  length[2];
1508 };
1509 
1510 struct scsi_report_supported_opcodes
1511 {
1512         uint8_t  opcode;
1513         uint8_t  service_action;
1514         uint8_t  options;
1515 #define RSO_RCTD		0x80
1516 #define RSO_OPTIONS_MASK	0x07
1517 #define RSO_OPTIONS_ALL		0x00
1518 #define RSO_OPTIONS_OC		0x01
1519 #define RSO_OPTIONS_OC_SA	0x02
1520 #define RSO_OPTIONS_OC_ASA	0x03
1521         uint8_t  requested_opcode;
1522         uint8_t  requested_service_action[2];
1523 	uint8_t  length[4];
1524 	uint8_t  reserved1;
1525 	uint8_t  control;
1526 };
1527 
1528 struct scsi_report_supported_opcodes_timeout
1529 {
1530 	uint8_t  length[2];
1531 	uint8_t  reserved;
1532 	uint8_t  cmd_specific;
1533 	uint8_t  nominal_time[4];
1534 	uint8_t  recommended_time[4];
1535 };
1536 
1537 struct scsi_report_supported_opcodes_descr
1538 {
1539 	uint8_t  opcode;
1540 	uint8_t  reserved;
1541 	uint8_t  service_action[2];
1542 	uint8_t  reserved2;
1543 	uint8_t  flags;
1544 #define RSO_SERVACTV		0x01
1545 #define RSO_CTDP		0x02
1546 #define RSO_CDLP_MASK		0x0c
1547 #define RSO_CDLP_NO		0x00
1548 #define RSO_CDLP_A		0x04
1549 #define RSO_CDLP_B		0x08
1550 	uint8_t  cdb_length[2];
1551 	struct scsi_report_supported_opcodes_timeout timeout[0];
1552 };
1553 
1554 struct scsi_report_supported_opcodes_all
1555 {
1556 	uint8_t  length[4];
1557 	struct scsi_report_supported_opcodes_descr descr[0];
1558 };
1559 
1560 struct scsi_report_supported_opcodes_one
1561 {
1562 	uint8_t  reserved;
1563 	uint8_t  support;
1564 #define RSO_ONE_CTDP		0x80
1565 #define RSO_ONE_CDLP_MASK	0x18
1566 #define RSO_ONE_CDLP_NO		0x00
1567 #define RSO_ONE_CDLP_A		0x08
1568 #define RSO_ONE_CDLP_B		0x10
1569 #define RSO_ONE_SUP_MASK	0x07
1570 #define RSO_ONE_SUP_UNAVAIL	0x00
1571 #define RSO_ONE_SUP_NOT_SUP	0x01
1572 #define RSO_ONE_SUP_AVAIL	0x03
1573 #define RSO_ONE_SUP_VENDOR	0x05
1574 	uint8_t  cdb_length[2];
1575 	uint8_t  cdb_usage[];
1576 };
1577 
1578 struct scsi_report_supported_tmf
1579 {
1580 	uint8_t  opcode;
1581 	uint8_t  service_action;
1582 	uint8_t  options;
1583 #define RST_REPD		0x80
1584 	uint8_t  reserved[3];
1585 	uint8_t  length[4];
1586 	uint8_t  reserved1;
1587 	uint8_t  control;
1588 };
1589 
1590 struct scsi_report_supported_tmf_data
1591 {
1592 	uint8_t  byte1;
1593 #define RST_WAKES		0x01
1594 #define RST_TRS			0x02
1595 #define RST_QTS			0x04
1596 #define RST_LURS		0x08
1597 #define RST_CTSS		0x10
1598 #define RST_CACAS		0x20
1599 #define RST_ATSS		0x40
1600 #define RST_ATS			0x80
1601 	uint8_t  byte2;
1602 #define RST_ITNRS		0x01
1603 #define RST_QTSS		0x02
1604 #define RST_QAES		0x04
1605 	uint8_t  reserved;
1606 	uint8_t  length;
1607 };
1608 
1609 struct scsi_report_supported_tmf_ext_data
1610 {
1611 	uint8_t  byte1;
1612 	uint8_t  byte2;
1613 	uint8_t  reserved;
1614 	uint8_t  length;
1615 	uint8_t  byte5;
1616 #define RST_TMFTMOV		0x01
1617 	uint8_t  reserved2;
1618 	uint8_t  byte7;
1619 #define RST_WAKETS		0x01
1620 #define RST_TRTS		0x02
1621 #define RST_QTTS		0x04
1622 #define RST_LURTS		0x08
1623 #define RST_CTSTS		0x10
1624 #define RST_CACATS		0x20
1625 #define RST_ATSTS		0x40
1626 #define RST_ATTS		0x80
1627 	uint8_t  byte8;
1628 #define RST_ITNRTS		0x01
1629 #define RST_QTSTS		0x02
1630 #define RST_QAETS		0x04
1631 	uint8_t  long_timeout[4];
1632 	uint8_t  short_timeout[4];
1633 };
1634 
1635 struct scsi_report_timestamp
1636 {
1637 	uint8_t  opcode;
1638 	uint8_t  service_action;
1639 	uint8_t  reserved[4];
1640 	uint8_t  length[4];
1641 	uint8_t  reserved1;
1642 	uint8_t  control;
1643 };
1644 
1645 struct scsi_report_timestamp_data
1646 {
1647 	uint8_t  length[2];
1648 	uint8_t  origin;
1649 #define RTS_ORIG_MASK		0x00
1650 #define RTS_ORIG_ZERO		0x00
1651 #define RTS_ORIG_SET		0x02
1652 #define RTS_ORIG_OUTSIDE	0x03
1653 	uint8_t  reserved;
1654 	uint8_t  timestamp[6];
1655 	uint8_t  reserve2[2];
1656 };
1657 
1658 struct scsi_receive_copy_status_lid1
1659 {
1660 	uint8_t  opcode;
1661 	uint8_t  service_action;
1662 #define RCS_RCS_LID1		0x00
1663 	uint8_t  list_identifier;
1664 	uint8_t  reserved[7];
1665 	uint8_t  length[4];
1666 	uint8_t  reserved1;
1667 	uint8_t  control;
1668 };
1669 
1670 struct scsi_receive_copy_status_lid1_data
1671 {
1672 	uint8_t  available_data[4];
1673 	uint8_t  copy_command_status;
1674 #define RCS_CCS_INPROG		0x00
1675 #define RCS_CCS_COMPLETED	0x01
1676 #define RCS_CCS_ERROR		0x02
1677 	uint8_t  segments_processed[2];
1678 	uint8_t  transfer_count_units;
1679 #define RCS_TC_BYTES		0x00
1680 #define RCS_TC_KBYTES		0x01
1681 #define RCS_TC_MBYTES		0x02
1682 #define RCS_TC_GBYTES		0x03
1683 #define RCS_TC_TBYTES		0x04
1684 #define RCS_TC_PBYTES		0x05
1685 #define RCS_TC_EBYTES		0x06
1686 #define RCS_TC_LBAS		0xf1
1687 	uint8_t  transfer_count[4];
1688 };
1689 
1690 struct scsi_receive_copy_failure_details
1691 {
1692 	uint8_t  opcode;
1693 	uint8_t  service_action;
1694 #define RCS_RCFD		0x04
1695 	uint8_t  list_identifier;
1696 	uint8_t  reserved[7];
1697 	uint8_t  length[4];
1698 	uint8_t  reserved1;
1699 	uint8_t  control;
1700 };
1701 
1702 struct scsi_receive_copy_failure_details_data
1703 {
1704 	uint8_t  available_data[4];
1705 	uint8_t  reserved[52];
1706 	uint8_t  copy_command_status;
1707 	uint8_t  reserved2;
1708 	uint8_t  sense_data_length[2];
1709 	uint8_t  sense_data[];
1710 };
1711 
1712 struct scsi_receive_copy_status_lid4
1713 {
1714 	uint8_t  opcode;
1715 	uint8_t  service_action;
1716 #define RCS_RCS_LID4		0x05
1717 	uint8_t  list_identifier[4];
1718 	uint8_t  reserved[4];
1719 	uint8_t  length[4];
1720 	uint8_t  reserved1;
1721 	uint8_t  control;
1722 };
1723 
1724 struct scsi_receive_copy_status_lid4_data
1725 {
1726 	uint8_t  available_data[4];
1727 	uint8_t  response_to_service_action;
1728 	uint8_t  copy_command_status;
1729 #define RCS_CCS_COMPLETED_PROD	0x03
1730 #define RCS_CCS_COMPLETED_RESID	0x04
1731 #define RCS_CCS_INPROG_FGBG	0x10
1732 #define RCS_CCS_INPROG_FG	0x11
1733 #define RCS_CCS_INPROG_BG	0x12
1734 #define RCS_CCS_ABORTED		0x60
1735 	uint8_t  operation_counter[2];
1736 	uint8_t  estimated_status_update_delay[4];
1737 	uint8_t  extended_copy_completion_status;
1738 	uint8_t  length_of_the_sense_data_field;
1739 	uint8_t  sense_data_length;
1740 	uint8_t  transfer_count_units;
1741 	uint8_t  transfer_count[8];
1742 	uint8_t  segments_processed[2];
1743 	uint8_t  reserved[6];
1744 	uint8_t  sense_data[];
1745 };
1746 
1747 struct scsi_receive_copy_operating_parameters
1748 {
1749 	uint8_t  opcode;
1750 	uint8_t  service_action;
1751 #define RCS_RCOP		0x03
1752 	uint8_t  reserved[8];
1753 	uint8_t  length[4];
1754 	uint8_t  reserved1;
1755 	uint8_t  control;
1756 };
1757 
1758 struct scsi_receive_copy_operating_parameters_data
1759 {
1760 	uint8_t  length[4];
1761 	uint8_t  snlid;
1762 #define RCOP_SNLID		0x01
1763 	uint8_t  reserved[3];
1764 	uint8_t  maximum_cscd_descriptor_count[2];
1765 	uint8_t  maximum_segment_descriptor_count[2];
1766 	uint8_t  maximum_descriptor_list_length[4];
1767 	uint8_t  maximum_segment_length[4];
1768 	uint8_t  maximum_inline_data_length[4];
1769 	uint8_t  held_data_limit[4];
1770 	uint8_t  maximum_stream_device_transfer_size[4];
1771 	uint8_t  reserved2[2];
1772 	uint8_t  total_concurrent_copies[2];
1773 	uint8_t  maximum_concurrent_copies;
1774 	uint8_t  data_segment_granularity;
1775 	uint8_t  inline_data_granularity;
1776 	uint8_t  held_data_granularity;
1777 	uint8_t  reserved3[3];
1778 	uint8_t  implemented_descriptor_list_length;
1779 	uint8_t  list_of_implemented_descriptor_type_codes[0];
1780 };
1781 
1782 struct scsi_extended_copy
1783 {
1784 	uint8_t  opcode;
1785 	uint8_t  service_action;
1786 #define EC_EC_LID1		0x00
1787 #define EC_EC_LID4		0x01
1788 	uint8_t  reserved[8];
1789 	uint8_t  length[4];
1790 	uint8_t  reserved1;
1791 	uint8_t  control;
1792 };
1793 
1794 struct scsi_ec_cscd_dtsp
1795 {
1796 	uint8_t  flags;
1797 #define EC_CSCD_FIXED		0x01
1798 #define EC_CSCD_PAD		0x04
1799 	uint8_t  block_length[3];
1800 };
1801 
1802 struct scsi_ec_cscd
1803 {
1804 	uint8_t  type_code;
1805 #define EC_CSCD_EXT		0xff
1806 	uint8_t  luidt_pdt;
1807 #define EC_NUL			0x20
1808 #define EC_LUIDT_MASK		0xc0
1809 #define EC_LUIDT_LUN		0x00
1810 #define EC_LUIDT_PROXY_TOKEN	0x40
1811 	uint8_t  relative_initiator_port[2];
1812 	uint8_t  cscd_params[24];
1813 	struct scsi_ec_cscd_dtsp dtsp;
1814 };
1815 
1816 struct scsi_ec_cscd_id
1817 {
1818 	uint8_t  type_code;
1819 #define EC_CSCD_ID		0xe4
1820 	uint8_t  luidt_pdt;
1821 	uint8_t  relative_initiator_port[2];
1822 	uint8_t  codeset;
1823 	uint8_t  id_type;
1824 	uint8_t  reserved;
1825 	uint8_t  length;
1826 	uint8_t  designator[20];
1827 	struct scsi_ec_cscd_dtsp dtsp;
1828 };
1829 
1830 struct scsi_ec_segment
1831 {
1832 	uint8_t  type_code;
1833 	uint8_t  flags;
1834 #define EC_SEG_DC		0x02
1835 #define EC_SEG_CAT		0x01
1836 	uint8_t  descr_length[2];
1837 	uint8_t  params[];
1838 };
1839 
1840 struct scsi_ec_segment_b2b
1841 {
1842 	uint8_t  type_code;
1843 #define EC_SEG_B2B		0x02
1844 	uint8_t  flags;
1845 	uint8_t  descr_length[2];
1846 	uint8_t  src_cscd[2];
1847 	uint8_t  dst_cscd[2];
1848 	uint8_t  reserved[2];
1849 	uint8_t  number_of_blocks[2];
1850 	uint8_t  src_lba[8];
1851 	uint8_t  dst_lba[8];
1852 };
1853 
1854 struct scsi_ec_segment_verify
1855 {
1856 	uint8_t  type_code;
1857 #define EC_SEG_VERIFY		0x07
1858 	uint8_t  reserved;
1859 	uint8_t  descr_length[2];
1860 	uint8_t  src_cscd[2];
1861 	uint8_t  reserved2[2];
1862 	uint8_t  tur;
1863 	uint8_t  reserved3[3];
1864 };
1865 
1866 struct scsi_ec_segment_register_key
1867 {
1868 	uint8_t  type_code;
1869 #define EC_SEG_REGISTER_KEY	0x14
1870 	uint8_t  reserved;
1871 	uint8_t  descr_length[2];
1872 	uint8_t  reserved2[2];
1873 	uint8_t  dst_cscd[2];
1874 	uint8_t  res_key[8];
1875 	uint8_t  sa_res_key[8];
1876 	uint8_t  reserved3[4];
1877 };
1878 
1879 struct scsi_extended_copy_lid1_data
1880 {
1881 	uint8_t  list_identifier;
1882 	uint8_t  flags;
1883 #define EC_PRIORITY		0x07
1884 #define EC_LIST_ID_USAGE_MASK	0x18
1885 #define EC_LIST_ID_USAGE_FULL	0x08
1886 #define EC_LIST_ID_USAGE_NOHOLD	0x10
1887 #define EC_LIST_ID_USAGE_NONE	0x18
1888 #define EC_STR			0x20
1889 	uint8_t  cscd_list_length[2];
1890 	uint8_t  reserved[4];
1891 	uint8_t  segment_list_length[4];
1892 	uint8_t  inline_data_length[4];
1893 	uint8_t  data[];
1894 };
1895 
1896 struct scsi_extended_copy_lid4_data
1897 {
1898 	uint8_t  list_format;
1899 #define EC_LIST_FORMAT		0x01
1900 	uint8_t  flags;
1901 	uint8_t  header_cscd_list_length[2];
1902 	uint8_t  reserved[11];
1903 	uint8_t  flags2;
1904 #define EC_IMMED		0x01
1905 #define EC_G_SENSE		0x02
1906 	uint8_t  header_cscd_type_code;
1907 	uint8_t  reserved2[3];
1908 	uint8_t  list_identifier[4];
1909 	uint8_t  reserved3[18];
1910 	uint8_t  cscd_list_length[2];
1911 	uint8_t  segment_list_length[2];
1912 	uint8_t  inline_data_length[2];
1913 	uint8_t  data[];
1914 };
1915 
1916 struct scsi_copy_operation_abort
1917 {
1918 	uint8_t  opcode;
1919 	uint8_t  service_action;
1920 #define EC_COA			0x1c
1921 	uint8_t  list_identifier[4];
1922 	uint8_t  reserved[9];
1923 	uint8_t  control;
1924 };
1925 
1926 struct scsi_populate_token
1927 {
1928 	uint8_t  opcode;
1929 	uint8_t  service_action;
1930 #define EC_PT			0x10
1931 	uint8_t  reserved[4];
1932 	uint8_t  list_identifier[4];
1933 	uint8_t  length[4];
1934 	uint8_t  group_number;
1935 	uint8_t  control;
1936 };
1937 
1938 struct scsi_range_desc
1939 {
1940 	uint8_t	lba[8];
1941 	uint8_t	length[4];
1942 	uint8_t	reserved[4];
1943 };
1944 
1945 struct scsi_populate_token_data
1946 {
1947 	uint8_t  length[2];
1948 	uint8_t  flags;
1949 #define EC_PT_IMMED			0x01
1950 #define EC_PT_RTV			0x02
1951 	uint8_t  reserved;
1952 	uint8_t  inactivity_timeout[4];
1953 	uint8_t  rod_type[4];
1954 	uint8_t  reserved2[2];
1955 	uint8_t  range_descriptor_length[2];
1956 	struct scsi_range_desc desc[];
1957 };
1958 
1959 struct scsi_write_using_token
1960 {
1961 	uint8_t  opcode;
1962 	uint8_t  service_action;
1963 #define EC_WUT			0x11
1964 	uint8_t  reserved[4];
1965 	uint8_t  list_identifier[4];
1966 	uint8_t  length[4];
1967 	uint8_t  group_number;
1968 	uint8_t  control;
1969 };
1970 
1971 struct scsi_write_using_token_data
1972 {
1973 	uint8_t  length[2];
1974 	uint8_t  flags;
1975 #define EC_WUT_IMMED			0x01
1976 #define EC_WUT_DEL_TKN			0x02
1977 	uint8_t  reserved[5];
1978 	uint8_t  offset_into_rod[8];
1979 	uint8_t  rod_token[512];
1980 	uint8_t  reserved2[6];
1981 	uint8_t  range_descriptor_length[2];
1982 	struct scsi_range_desc desc[];
1983 };
1984 
1985 struct scsi_receive_rod_token_information
1986 {
1987 	uint8_t  opcode;
1988 	uint8_t  service_action;
1989 #define RCS_RRTI		0x07
1990 	uint8_t  list_identifier[4];
1991 	uint8_t  reserved[4];
1992 	uint8_t  length[4];
1993 	uint8_t  reserved2;
1994 	uint8_t  control;
1995 };
1996 
1997 struct scsi_token
1998 {
1999 	uint8_t  type[4];
2000 #define ROD_TYPE_INTERNAL	0x00000000
2001 #define ROD_TYPE_AUR		0x00010000
2002 #define ROD_TYPE_PIT_DEF	0x00800000
2003 #define ROD_TYPE_PIT_VULN	0x00800001
2004 #define ROD_TYPE_PIT_PERS	0x00800002
2005 #define ROD_TYPE_PIT_ANY	0x0080FFFF
2006 #define ROD_TYPE_BLOCK_ZERO	0xFFFF0001
2007 	uint8_t  reserved[2];
2008 	uint8_t  length[2];
2009 	uint8_t  body[0];
2010 };
2011 
2012 struct scsi_report_all_rod_tokens
2013 {
2014 	uint8_t  opcode;
2015 	uint8_t  service_action;
2016 #define RCS_RART		0x08
2017 	uint8_t  reserved[8];
2018 	uint8_t  length[4];
2019 	uint8_t  reserved2;
2020 	uint8_t  control;
2021 };
2022 
2023 struct scsi_report_all_rod_tokens_data
2024 {
2025 	uint8_t  available_data[4];
2026 	uint8_t  reserved[4];
2027 	uint8_t  rod_management_token_list[];
2028 };
2029 
2030 struct ata_pass_16 {
2031 	uint8_t opcode;
2032 	uint8_t protocol;
2033 #define	AP_EXTEND	0x01
2034 	uint8_t flags;
2035 #define	AP_FLAG_TLEN_NO_DATA	(0 << 0)
2036 #define	AP_FLAG_TLEN_FEAT	(1 << 0)
2037 #define	AP_FLAG_TLEN_SECT_CNT	(2 << 0)
2038 #define	AP_FLAG_TLEN_STPSIU	(3 << 0)
2039 #define	AP_FLAG_BYT_BLOK_BYTES	(0 << 2)
2040 #define	AP_FLAG_BYT_BLOK_BLOCKS	(1 << 2)
2041 #define	AP_FLAG_TDIR_TO_DEV	(0 << 3)
2042 #define	AP_FLAG_TDIR_FROM_DEV	(1 << 3)
2043 #define	AP_FLAG_CHK_COND	(1 << 5)
2044 	uint8_t features_ext;
2045 	uint8_t features;
2046 	uint8_t sector_count_ext;
2047 	uint8_t sector_count;
2048 	uint8_t lba_low_ext;
2049 	uint8_t lba_low;
2050 	uint8_t lba_mid_ext;
2051 	uint8_t lba_mid;
2052 	uint8_t lba_high_ext;
2053 	uint8_t lba_high;
2054 	uint8_t device;
2055 	uint8_t command;
2056 	uint8_t control;
2057 };
2058 
2059 struct ata_pass_32 {
2060 	uint8_t opcode;
2061 	uint8_t control;
2062 	uint8_t reserved1[5];
2063 	uint8_t length;
2064 	uint8_t service_action[2];
2065 #define	ATA_PASS_32_SA		0x1ff0
2066 	uint8_t protocol;
2067 	uint8_t flags;
2068 	uint8_t reserved2[2];
2069 	uint8_t lba[6];
2070 	uint8_t features[2];
2071 	uint8_t count[2];
2072 	uint8_t device;
2073 	uint8_t command;
2074 	uint8_t reserved3;
2075 	uint8_t icc;
2076 	uint8_t auxiliary[4];
2077 };
2078 
2079 #define	SC_SCSI_1 0x01
2080 #define	SC_SCSI_2 0x03
2081 
2082 /*
2083  * Opcodes
2084  */
2085 
2086 #define	TEST_UNIT_READY		0x00
2087 #define	REQUEST_SENSE		0x03
2088 #define	READ_6			0x08
2089 #define	WRITE_6			0x0A
2090 #define	INQUIRY			0x12
2091 #define	MODE_SELECT_6		0x15
2092 #define	MODE_SENSE_6		0x1A
2093 #define	START_STOP_UNIT		0x1B
2094 #define	START_STOP		0x1B
2095 #define	RESERVE      		0x16
2096 #define	RELEASE      		0x17
2097 #define	RECEIVE_DIAGNOSTIC	0x1C
2098 #define	SEND_DIAGNOSTIC		0x1D
2099 #define	PREVENT_ALLOW		0x1E
2100 #define	READ_CAPACITY		0x25
2101 #define	READ_10			0x28
2102 #define	WRITE_10		0x2A
2103 #define	POSITION_TO_ELEMENT	0x2B
2104 #define	WRITE_VERIFY_10		0x2E
2105 #define	VERIFY_10		0x2F
2106 #define	SYNCHRONIZE_CACHE	0x35
2107 #define	WRITE_BUFFER            0x3B
2108 #define	READ_BUFFER             0x3C
2109 #define	CHANGE_DEFINITION	0x40
2110 #define	WRITE_SAME_10		0x41
2111 #define	UNMAP			0x42
2112 #define	LOG_SELECT		0x4C
2113 #define	LOG_SENSE		0x4D
2114 #define	MODE_SELECT_10		0x55
2115 #define	RESERVE_10		0x56
2116 #define	RELEASE_10		0x57
2117 #define	MODE_SENSE_10		0x5A
2118 #define	PERSISTENT_RES_IN	0x5E
2119 #define	PERSISTENT_RES_OUT	0x5F
2120 #define	EXTENDED_CDB		0x7E
2121 #define	VARIABLE_LEN_CDB	0x7F
2122 #define	EXTENDED_COPY		0x83
2123 #define	RECEIVE_COPY_STATUS	0x84
2124 #define	ATA_PASS_16		0x85
2125 #define	READ_16			0x88
2126 #define	COMPARE_AND_WRITE	0x89
2127 #define	WRITE_16		0x8A
2128 #define	READ_ATTRIBUTE		0x8C
2129 #define	WRITE_ATTRIBUTE		0x8D
2130 #define	WRITE_VERIFY_16		0x8E
2131 #define	VERIFY_16		0x8F
2132 #define	SYNCHRONIZE_CACHE_16	0x91
2133 #define	WRITE_SAME_16		0x93
2134 #define	READ_BUFFER_16		0x9B
2135 #define	WRITE_ATOMIC_16		0x9C
2136 #define	SERVICE_ACTION_IN	0x9E
2137 #define	REPORT_LUNS		0xA0
2138 #define	ATA_PASS_12		0xA1
2139 #define	SECURITY_PROTOCOL_IN	0xA2
2140 #define	MAINTENANCE_IN		0xA3
2141 #define	MAINTENANCE_OUT		0xA4
2142 #define	MOVE_MEDIUM     	0xA5
2143 #define	READ_12			0xA8
2144 #define	WRITE_12		0xAA
2145 #define	WRITE_VERIFY_12		0xAE
2146 #define	VERIFY_12		0xAF
2147 #define	SECURITY_PROTOCOL_OUT	0xB5
2148 #define	READ_ELEMENT_STATUS	0xB8
2149 #define	READ_CD			0xBE
2150 
2151 /* Maintenance In Service Action Codes */
2152 #define	REPORT_IDENTIFYING_INFRMATION		0x05
2153 #define	REPORT_TARGET_PORT_GROUPS		0x0A
2154 #define	REPORT_ALIASES				0x0B
2155 #define	REPORT_SUPPORTED_OPERATION_CODES	0x0C
2156 #define	REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS	0x0D
2157 #define	REPORT_PRIORITY				0x0E
2158 #define	REPORT_TIMESTAMP			0x0F
2159 #define	MANAGEMENT_PROTOCOL_IN			0x10
2160 #define GET_PHYSICAL_ELEMENT_STATUS		0x17
2161 #define REMOVE_ELEMENT_AND_TRUNCATE		0x18
2162 #define RESTORE_ELEMENTS_AND_REBUILD		0x19
2163 /* Maintenance Out Service Action Codes */
2164 #define	SET_IDENTIFY_INFORMATION		0x06
2165 #define	SET_TARGET_PORT_GROUPS			0x0A
2166 #define	CHANGE_ALIASES				0x0B
2167 #define	SET_PRIORITY				0x0E
2168 #define	SET_TIMESTAMP				0x0F
2169 #define	MANAGEMENT_PROTOCOL_OUT			0x10
2170 
2171 /*
2172  * Device Types
2173  */
2174 #define	T_DIRECT	0x00
2175 #define	T_SEQUENTIAL	0x01
2176 #define	T_PRINTER	0x02
2177 #define	T_PROCESSOR	0x03
2178 #define	T_WORM		0x04
2179 #define	T_CDROM		0x05
2180 #define	T_SCANNER	0x06
2181 #define	T_OPTICAL 	0x07
2182 #define	T_CHANGER	0x08
2183 #define	T_COMM		0x09
2184 #define	T_ASC0		0x0a
2185 #define	T_ASC1		0x0b
2186 #define	T_STORARRAY	0x0c
2187 #define	T_ENCLOSURE	0x0d
2188 #define	T_RBC		0x0e
2189 #define	T_OCRW		0x0f
2190 #define	T_OSD		0x11
2191 #define	T_ADC		0x12
2192 #define	T_ZBC_HM	0x14
2193 #define	T_NODEVICE	0x1f
2194 #define	T_ANY		0xff	/* Used in Quirk table matches */
2195 
2196 #define	T_REMOV		1
2197 #define	T_FIXED		0
2198 
2199 /*
2200  * This length is the initial inquiry length used by the probe code, as
2201  * well as the length necessary for scsi_print_inquiry() to function
2202  * correctly.  If either use requires a different length in the future,
2203  * the two values should be de-coupled.
2204  */
2205 #define	SHORT_INQUIRY_LENGTH	36
2206 
2207 struct scsi_inquiry_data
2208 {
2209 	uint8_t device;
2210 #define	SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
2211 #define	SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
2212 #define	SID_QUAL_LU_CONNECTED	0x00	/*
2213 					 * The specified peripheral device
2214 					 * type is currently connected to
2215 					 * logical unit.  If the target cannot
2216 					 * determine whether or not a physical
2217 					 * device is currently connected, it
2218 					 * shall also use this peripheral
2219 					 * qualifier when returning the INQUIRY
2220 					 * data.  This peripheral qualifier
2221 					 * does not mean that the device is
2222 					 * ready for access by the initiator.
2223 					 */
2224 #define	SID_QUAL_LU_OFFLINE	0x01	/*
2225 					 * The target is capable of supporting
2226 					 * the specified peripheral device type
2227 					 * on this logical unit; however, the
2228 					 * physical device is not currently
2229 					 * connected to this logical unit.
2230 					 */
2231 #define	SID_QUAL_RSVD		0x02
2232 #define	SID_QUAL_BAD_LU		0x03	/*
2233 					 * The target is not capable of
2234 					 * supporting a physical device on
2235 					 * this logical unit. For this
2236 					 * peripheral qualifier the peripheral
2237 					 * device type shall be set to 1Fh to
2238 					 * provide compatibility with previous
2239 					 * versions of SCSI. All other
2240 					 * peripheral device type values are
2241 					 * reserved for this peripheral
2242 					 * qualifier.
2243 					 */
2244 #define	SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0)
2245 	uint8_t dev_qual2;
2246 #define	SID_QUAL2	0x7F
2247 #define	SID_LU_CONG	0x40
2248 #define	SID_RMB		0x80
2249 #define	SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
2250 	uint8_t version;
2251 #define	SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
2252 #define		SCSI_REV_0		0
2253 #define		SCSI_REV_CCS		1
2254 #define		SCSI_REV_2		2
2255 #define		SCSI_REV_SPC		3
2256 #define		SCSI_REV_SPC2		4
2257 #define		SCSI_REV_SPC3		5
2258 #define		SCSI_REV_SPC4		6
2259 #define		SCSI_REV_SPC5		7
2260 
2261 #define	SID_ECMA	0x38
2262 #define	SID_ISO		0xC0
2263 	uint8_t response_format;
2264 #define	SID_AENC	0x80
2265 #define	SID_TrmIOP	0x40
2266 #define	SID_NormACA	0x20
2267 #define	SID_HiSup	0x10
2268 	uint8_t additional_length;
2269 #define	SID_ADDITIONAL_LENGTH(iqd)					\
2270 	((iqd)->additional_length +					\
2271 	__offsetof(struct scsi_inquiry_data, additional_length) + 1)
2272 	uint8_t spc3_flags;
2273 #define	SPC3_SID_PROTECT	0x01
2274 #define	SPC3_SID_3PC		0x08
2275 #define	SPC3_SID_TPGS_MASK	0x30
2276 #define	SPC3_SID_TPGS_IMPLICIT	0x10
2277 #define	SPC3_SID_TPGS_EXPLICIT	0x20
2278 #define	SPC3_SID_ACC		0x40
2279 #define	SPC3_SID_SCCS		0x80
2280 	uint8_t spc2_flags;
2281 #define	SPC2_SID_ADDR16		0x01
2282 #define	SPC2_SID_MChngr 	0x08
2283 #define	SPC2_SID_MultiP 	0x10
2284 #define	SPC2_SID_EncServ	0x40
2285 #define	SPC2_SID_BQueue		0x80
2286 
2287 #define	INQ_DATA_TQ_ENABLED(iqd)				\
2288     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) :	\
2289     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
2290     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
2291 
2292 	uint8_t flags;
2293 #define	SID_SftRe	0x01
2294 #define	SID_CmdQue	0x02
2295 #define	SID_Linked	0x08
2296 #define	SID_Sync	0x10
2297 #define	SID_WBus16	0x20
2298 #define	SID_WBus32	0x40
2299 #define	SID_RelAdr	0x80
2300 #define	SID_VENDOR_SIZE   8
2301 	char	 vendor[SID_VENDOR_SIZE];
2302 #define	SID_PRODUCT_SIZE  16
2303 	char	 product[SID_PRODUCT_SIZE];
2304 #define	SID_REVISION_SIZE 4
2305 	char	 revision[SID_REVISION_SIZE];
2306 	/*
2307 	 * The following fields were taken from SCSI Primary Commands - 2
2308 	 * (SPC-2) Revision 14, Dated 11 November 1999
2309 	 */
2310 #define	SID_VENDOR_SPECIFIC_0_SIZE	20
2311 	uint8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
2312 	/*
2313 	 * An extension of SCSI Parallel Specific Values
2314 	 */
2315 #define	SID_SPI_IUS		0x01
2316 #define	SID_SPI_QAS		0x02
2317 #define	SID_SPI_CLOCK_ST	0x00
2318 #define	SID_SPI_CLOCK_DT	0x04
2319 #define	SID_SPI_CLOCK_DT_ST	0x0C
2320 #define	SID_SPI_MASK		0x0F
2321 	uint8_t spi3data;
2322 	uint8_t reserved2;
2323 	/*
2324 	 * Version Descriptors, stored 2 byte values.
2325 	 */
2326 	uint8_t version1[2];
2327 	uint8_t version2[2];
2328 	uint8_t version3[2];
2329 	uint8_t version4[2];
2330 	uint8_t version5[2];
2331 	uint8_t version6[2];
2332 	uint8_t version7[2];
2333 	uint8_t version8[2];
2334 
2335 	uint8_t reserved3[22];
2336 
2337 #define	SID_VENDOR_SPECIFIC_1_SIZE	160
2338 	uint8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
2339 };
2340 
2341 /*
2342  * This structure is more suited to initiator operation, because the
2343  * maximum number of supported pages is already allocated.
2344  */
2345 struct scsi_vpd_supported_page_list
2346 {
2347 	uint8_t device;
2348 	uint8_t page_code;
2349 #define	SVPD_SUPPORTED_PAGE_LIST	0x00
2350 #define	SVPD_SUPPORTED_PAGES_HDR_LEN	4
2351 	uint8_t reserved;
2352 	uint8_t length;	/* number of VPD entries */
2353 #define	SVPD_SUPPORTED_PAGES_SIZE	251
2354 	uint8_t list[SVPD_SUPPORTED_PAGES_SIZE];
2355 };
2356 
2357 /*
2358  * This structure is more suited to target operation, because the
2359  * number of supported pages is left to the user to allocate.
2360  */
2361 struct scsi_vpd_supported_pages
2362 {
2363 	uint8_t device;
2364 	uint8_t page_code;
2365 	uint8_t reserved;
2366 #define	SVPD_SUPPORTED_PAGES	0x00
2367 	uint8_t length;
2368 	uint8_t page_list[0];
2369 };
2370 
2371 struct scsi_vpd_unit_serial_number
2372 {
2373 	uint8_t device;
2374 	uint8_t page_code;
2375 #define	SVPD_UNIT_SERIAL_NUMBER	0x80
2376 	uint8_t reserved;
2377 	uint8_t length; /* serial number length */
2378 #define	SVPD_SERIAL_NUM_SIZE 251
2379 	uint8_t serial_num[SVPD_SERIAL_NUM_SIZE];
2380 };
2381 
2382 struct scsi_vpd_device_id
2383 {
2384 	uint8_t device;
2385 	uint8_t page_code;
2386 #define	SVPD_DEVICE_ID			0x83
2387 #define	SVPD_DEVICE_ID_MAX_SIZE		252
2388 #define	SVPD_DEVICE_ID_HDR_LEN \
2389     __offsetof(struct scsi_vpd_device_id, desc_list)
2390 	uint8_t length[2];
2391 	uint8_t desc_list[];
2392 };
2393 
2394 struct scsi_vpd_id_descriptor
2395 {
2396 	uint8_t	proto_codeset;
2397 	/*
2398 	 * See the SCSI_PROTO definitions above for the protocols.
2399 	 */
2400 #define	SVPD_ID_PROTO_SHIFT	4
2401 #define	SVPD_ID_CODESET_BINARY	0x01
2402 #define	SVPD_ID_CODESET_ASCII	0x02
2403 #define	SVPD_ID_CODESET_UTF8	0x03
2404 #define	SVPD_ID_CODESET_MASK	0x0f
2405 	uint8_t	id_type;
2406 #define	SVPD_ID_PIV		0x80
2407 #define	SVPD_ID_ASSOC_LUN	0x00
2408 #define	SVPD_ID_ASSOC_PORT	0x10
2409 #define	SVPD_ID_ASSOC_TARGET	0x20
2410 #define	SVPD_ID_ASSOC_MASK	0x30
2411 #define	SVPD_ID_TYPE_VENDOR	0x00
2412 #define	SVPD_ID_TYPE_T10	0x01
2413 #define	SVPD_ID_TYPE_EUI64	0x02
2414 #define	SVPD_ID_TYPE_NAA	0x03
2415 #define	SVPD_ID_TYPE_RELTARG	0x04
2416 #define	SVPD_ID_TYPE_TPORTGRP	0x05
2417 #define	SVPD_ID_TYPE_LUNGRP	0x06
2418 #define	SVPD_ID_TYPE_MD5_LUN_ID	0x07
2419 #define	SVPD_ID_TYPE_SCSI_NAME	0x08
2420 #define	SVPD_ID_TYPE_PROTO	0x09
2421 #define	SVPD_ID_TYPE_UUID	0x0a
2422 #define	SVPD_ID_TYPE_MASK	0x0f
2423 	uint8_t	reserved;
2424 	uint8_t	length;
2425 #define	SVPD_DEVICE_ID_DESC_HDR_LEN \
2426     __offsetof(struct scsi_vpd_id_descriptor, identifier)
2427 	uint8_t	identifier[];
2428 };
2429 
2430 struct scsi_vpd_id_t10
2431 {
2432 	uint8_t	vendor[8];
2433 	uint8_t	vendor_spec_id[0];
2434 };
2435 
2436 struct scsi_vpd_id_eui64
2437 {
2438 	uint8_t	ieee_company_id[3];
2439 	uint8_t	extension_id[5];
2440 };
2441 
2442 struct scsi_vpd_id_naa_basic
2443 {
2444 	uint8_t naa;
2445 	/* big endian, packed:
2446 	uint8_t	naa : 4;
2447 	uint8_t naa_desig : 4;
2448 	*/
2449 #define	SVPD_ID_NAA_NAA_SHIFT		4
2450 #define	SVPD_ID_NAA_IEEE_EXT		0x02
2451 #define	SVPD_ID_NAA_LOCAL_REG		0x03
2452 #define	SVPD_ID_NAA_IEEE_REG		0x05
2453 #define	SVPD_ID_NAA_IEEE_REG_EXT	0x06
2454 	uint8_t	naa_data[];
2455 };
2456 
2457 struct scsi_vpd_id_naa_ieee_extended_id
2458 {
2459 	uint8_t naa;
2460 	uint8_t vendor_specific_id_a;
2461 	uint8_t ieee_company_id[3];
2462 	uint8_t vendor_specific_id_b[4];
2463 };
2464 
2465 struct scsi_vpd_id_naa_local_reg
2466 {
2467 	uint8_t naa;
2468 	uint8_t local_value[7];
2469 };
2470 
2471 struct scsi_vpd_id_naa_ieee_reg
2472 {
2473 	uint8_t naa;
2474 	uint8_t reg_value[7];
2475 	/* big endian, packed:
2476 	uint8_t naa_basic : 4;
2477 	uint8_t ieee_company_id_0 : 4;
2478 	uint8_t ieee_company_id_1[2];
2479 	uint8_t ieee_company_id_2 : 4;
2480 	uint8_t vendor_specific_id_0 : 4;
2481 	uint8_t vendor_specific_id_1[4];
2482 	*/
2483 };
2484 
2485 struct scsi_vpd_id_naa_ieee_reg_extended
2486 {
2487 	uint8_t naa;
2488 	uint8_t reg_value[15];
2489 	/* big endian, packed:
2490 	uint8_t naa_basic : 4;
2491 	uint8_t ieee_company_id_0 : 4;
2492 	uint8_t ieee_company_id_1[2];
2493 	uint8_t ieee_company_id_2 : 4;
2494 	uint8_t vendor_specific_id_0 : 4;
2495 	uint8_t vendor_specific_id_1[4];
2496 	uint8_t vendor_specific_id_ext[8];
2497 	*/
2498 };
2499 
2500 struct scsi_vpd_id_rel_trgt_port_id
2501 {
2502 	uint8_t obsolete[2];
2503 	uint8_t rel_trgt_port_id[2];
2504 };
2505 
2506 struct scsi_vpd_id_trgt_port_grp_id
2507 {
2508 	uint8_t reserved[2];
2509 	uint8_t trgt_port_grp[2];
2510 };
2511 
2512 struct scsi_vpd_id_lun_grp_id
2513 {
2514 	uint8_t reserved[2];
2515 	uint8_t log_unit_grp[2];
2516 };
2517 
2518 struct scsi_vpd_id_md5_lun_id
2519 {
2520 	uint8_t lun_id[16];
2521 };
2522 
2523 struct scsi_vpd_id_scsi_name
2524 {
2525 	uint8_t name_string[256];
2526 };
2527 
2528 struct scsi_service_action_in
2529 {
2530 	uint8_t opcode;
2531 	uint8_t service_action;
2532 	uint8_t action_dependent[13];
2533 	uint8_t control;
2534 };
2535 
2536 struct scsi_vpd_extended_inquiry_data
2537 {
2538 	uint8_t device;
2539 	uint8_t page_code;
2540 #define	SVPD_EXTENDED_INQUIRY_DATA	0x86
2541 	uint8_t page_length[2];
2542 	uint8_t flags1;
2543 
2544 	/* These values are for direct access devices */
2545 #define	SVPD_EID_AM_MASK	0xC0
2546 #define	SVPD_EID_AM_DEFER	0x80
2547 #define	SVPD_EID_AM_IMMED	0x40
2548 #define	SVPD_EID_AM_UNDEFINED	0x00
2549 #define	SVPD_EID_AM_RESERVED	0xc0
2550 #define	SVPD_EID_SPT		0x38
2551 #define	SVPD_EID_SPT_1		0x00
2552 #define	SVPD_EID_SPT_12		0x08
2553 #define	SVPD_EID_SPT_2		0x10
2554 #define	SVPD_EID_SPT_13		0x18
2555 #define	SVPD_EID_SPT_3		0x20
2556 #define	SVPD_EID_SPT_23		0x28
2557 #define	SVPD_EID_SPT_123	0x38
2558 
2559 	/* These values are for sequential access devices */
2560 #define	SVPD_EID_SA_SPT_LBP	0x08
2561 
2562 #define	SVPD_EID_GRD_CHK	0x04
2563 #define	SVPD_EID_APP_CHK	0x02
2564 #define	SVPD_EID_REF_CHK	0x01
2565 
2566 	uint8_t flags2;
2567 #define	SVPD_EID_UASK_SUP	0x20
2568 #define	SVPD_EID_GROUP_SUP	0x10
2569 #define	SVPD_EID_PRIOR_SUP	0x08
2570 #define	SVPD_EID_HEADSUP	0x04
2571 #define	SVPD_EID_ORDSUP		0x02
2572 #define	SVPD_EID_SIMPSUP	0x01
2573 	uint8_t flags3;
2574 #define	SVPD_EID_WU_SUP		0x08
2575 #define	SVPD_EID_CRD_SUP	0x04
2576 #define	SVPD_EID_NV_SUP		0x02
2577 #define	SVPD_EID_V_SUP		0x01
2578 	uint8_t flags4;
2579 #define	SVPD_EID_NO_PI_CHK	0x20
2580 #define	SVPD_EID_P_I_I_SUP	0x10
2581 #define	SVPD_EID_LUICLR		0x01
2582 	uint8_t flags5;
2583 #define	SVPD_EID_LUCT_MASK	0xe0
2584 #define	SVPD_EID_LUCT_NOT_REP	0x00
2585 #define	SVPD_EID_LUCT_CONGL	0x20
2586 #define	SVPD_EID_LUCT_GROUP	0x40
2587 #define	SVPD_EID_R_SUP		0x10
2588 #define	SVPD_EID_RTD_SUP	0x08
2589 #define	SVPD_EID_HSSRELEF	0x02
2590 #define	SVPD_EID_CBCS		0x01
2591 	uint8_t flags6;
2592 #define	SVPD_EID_MULTI_I_T_FW	0x0F
2593 #define	SVPD_EID_MC_VENDOR_SPEC	0x00
2594 #define	SVPD_EID_MC_MODE_1	0x01
2595 #define	SVPD_EID_MC_MODE_2	0x02
2596 #define	SVPD_EID_MC_MODE_3	0x03
2597 	uint8_t est[2];
2598 	uint8_t flags7;
2599 #define	SVPD_EID_POA_SUP	0x80
2600 #define	SVPD_EID_HRA_SUP	0x40
2601 #define	SVPD_EID_VSA_SUP	0x20
2602 	uint8_t max_sense_length;
2603 	uint8_t bind_flags;
2604 #define	SVPD_EID_IBS		0x80
2605 #define	SVPD_EID_IAS		0x40
2606 #define	SVPD_EID_SAC		0x04
2607 #define	SVPD_EID_NRD1		0x02
2608 #define	SVPD_EID_NRD0		0x01
2609 	uint8_t reserved2[49];
2610 };
2611 
2612 struct scsi_vpd_mode_page_policy_descr
2613 {
2614 	uint8_t page_code;
2615 	uint8_t subpage_code;
2616 	uint8_t policy;
2617 #define	SVPD_MPP_SHARED		0x00
2618 #define	SVPD_MPP_PORT		0x01
2619 #define	SVPD_MPP_I_T		0x03
2620 #define	SVPD_MPP_MLUS		0x80
2621 	uint8_t reserved;
2622 };
2623 
2624 struct scsi_vpd_mode_page_policy
2625 {
2626 	uint8_t device;
2627 	uint8_t page_code;
2628 #define	SVPD_MODE_PAGE_POLICY	0x87
2629 	uint8_t page_length[2];
2630 	struct scsi_vpd_mode_page_policy_descr descr[0];
2631 };
2632 
2633 struct scsi_diag_page {
2634 	uint8_t page_code;
2635 	uint8_t page_specific_flags;
2636 	uint8_t length[2];
2637 	uint8_t params[0];
2638 };
2639 
2640 struct scsi_vpd_port_designation
2641 {
2642 	uint8_t reserved[2];
2643 	uint8_t relative_port_id[2];
2644 	uint8_t reserved2[2];
2645 	uint8_t initiator_transportid_length[2];
2646 	uint8_t initiator_transportid[0];
2647 };
2648 
2649 struct scsi_vpd_port_designation_cont
2650 {
2651 	uint8_t reserved[2];
2652 	uint8_t target_port_descriptors_length[2];
2653 	struct scsi_vpd_id_descriptor target_port_descriptors[0];
2654 };
2655 
2656 struct scsi_vpd_scsi_ports
2657 {
2658 	uint8_t device;
2659 	uint8_t page_code;
2660 #define	SVPD_SCSI_PORTS		0x88
2661 	uint8_t page_length[2];
2662 	struct scsi_vpd_port_designation design[];
2663 };
2664 
2665 /*
2666  * ATA Information VPD Page based on
2667  * T10/2126-D Revision 04
2668  */
2669 #define SVPD_ATA_INFORMATION		0x89
2670 
2671 struct scsi_vpd_tpc_descriptor
2672 {
2673 	uint8_t desc_type[2];
2674 	uint8_t desc_length[2];
2675 	uint8_t parameters[];
2676 };
2677 
2678 struct scsi_vpd_tpc_descriptor_bdrl
2679 {
2680 	uint8_t desc_type[2];
2681 #define	SVPD_TPC_BDRL			0x0000
2682 	uint8_t desc_length[2];
2683 	uint8_t vendor_specific[6];
2684 	uint8_t maximum_ranges[2];
2685 	uint8_t maximum_inactivity_timeout[4];
2686 	uint8_t default_inactivity_timeout[4];
2687 	uint8_t maximum_token_transfer_size[8];
2688 	uint8_t optimal_transfer_count[8];
2689 };
2690 
2691 struct scsi_vpd_tpc_descriptor_sc_descr
2692 {
2693 	uint8_t opcode;
2694 	uint8_t sa_length;
2695 	uint8_t supported_service_actions[0];
2696 };
2697 
2698 struct scsi_vpd_tpc_descriptor_sc
2699 {
2700 	uint8_t desc_type[2];
2701 #define	SVPD_TPC_SC			0x0001
2702 	uint8_t desc_length[2];
2703 	uint8_t list_length;
2704 	struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2705 };
2706 
2707 struct scsi_vpd_tpc_descriptor_pd
2708 {
2709 	uint8_t desc_type[2];
2710 #define	SVPD_TPC_PD			0x0004
2711 	uint8_t desc_length[2];
2712 	uint8_t reserved[4];
2713 	uint8_t maximum_cscd_descriptor_count[2];
2714 	uint8_t maximum_segment_descriptor_count[2];
2715 	uint8_t maximum_descriptor_list_length[4];
2716 	uint8_t maximum_inline_data_length[4];
2717 	uint8_t reserved2[12];
2718 };
2719 
2720 struct scsi_vpd_tpc_descriptor_sd
2721 {
2722 	uint8_t desc_type[2];
2723 #define	SVPD_TPC_SD			0x0008
2724 	uint8_t desc_length[2];
2725 	uint8_t list_length;
2726 	uint8_t supported_descriptor_codes[];
2727 };
2728 
2729 struct scsi_vpd_tpc_descriptor_sdid
2730 {
2731 	uint8_t desc_type[2];
2732 #define	SVPD_TPC_SDID			0x000C
2733 	uint8_t desc_length[2];
2734 	uint8_t list_length[2];
2735 	uint8_t supported_descriptor_ids[];
2736 };
2737 
2738 struct scsi_vpd_tpc_descriptor_rtf_block
2739 {
2740 	uint8_t type_format;
2741 #define	SVPD_TPC_RTF_BLOCK			0x00
2742 	uint8_t reserved;
2743 	uint8_t desc_length[2];
2744 	uint8_t reserved2[2];
2745 	uint8_t optimal_length_granularity[2];
2746 	uint8_t maximum_bytes[8];
2747 	uint8_t optimal_bytes[8];
2748 	uint8_t optimal_bytes_to_token_per_segment[8];
2749 	uint8_t optimal_bytes_from_token_per_segment[8];
2750 	uint8_t reserved3[8];
2751 };
2752 
2753 struct scsi_vpd_tpc_descriptor_rtf
2754 {
2755 	uint8_t desc_type[2];
2756 #define	SVPD_TPC_RTF			0x0106
2757 	uint8_t desc_length[2];
2758 	uint8_t remote_tokens;
2759 	uint8_t reserved[11];
2760 	uint8_t minimum_token_lifetime[4];
2761 	uint8_t maximum_token_lifetime[4];
2762 	uint8_t maximum_token_inactivity_timeout[4];
2763 	uint8_t reserved2[18];
2764 	uint8_t type_specific_features_length[2];
2765 	uint8_t type_specific_features[0];
2766 };
2767 
2768 struct scsi_vpd_tpc_descriptor_srtd
2769 {
2770 	uint8_t rod_type[4];
2771 	uint8_t flags;
2772 #define	SVPD_TPC_SRTD_TOUT		0x01
2773 #define	SVPD_TPC_SRTD_TIN		0x02
2774 #define	SVPD_TPC_SRTD_ECPY		0x80
2775 	uint8_t reserved;
2776 	uint8_t preference_indicator[2];
2777 	uint8_t reserved2[56];
2778 };
2779 
2780 struct scsi_vpd_tpc_descriptor_srt
2781 {
2782 	uint8_t desc_type[2];
2783 #define	SVPD_TPC_SRT			0x0108
2784 	uint8_t desc_length[2];
2785 	uint8_t reserved[2];
2786 	uint8_t rod_type_descriptors_length[2];
2787 	uint8_t rod_type_descriptors[0];
2788 };
2789 
2790 struct scsi_vpd_tpc_descriptor_gco
2791 {
2792 	uint8_t desc_type[2];
2793 #define	SVPD_TPC_GCO			0x8001
2794 	uint8_t desc_length[2];
2795 	uint8_t total_concurrent_copies[4];
2796 	uint8_t maximum_identified_concurrent_copies[4];
2797 	uint8_t maximum_segment_length[4];
2798 	uint8_t data_segment_granularity;
2799 	uint8_t inline_data_granularity;
2800 	uint8_t reserved[18];
2801 };
2802 
2803 struct scsi_vpd_tpc
2804 {
2805 	uint8_t device;
2806 	uint8_t page_code;
2807 #define	SVPD_SCSI_TPC			0x8F
2808 	uint8_t page_length[2];
2809 	struct scsi_vpd_tpc_descriptor descr[];
2810 };
2811 
2812 /*
2813  * SCSI Feature Sets VPD Page
2814  */
2815 struct scsi_vpd_sfs
2816 {
2817 	uint8_t device;
2818 	uint8_t page_code;
2819 #define	SVPD_SCSI_SFS			0x92
2820 	uint8_t page_length[2];
2821 	uint8_t reserved[4];
2822 	uint8_t codes[];
2823 };
2824 
2825 /*
2826  * Block Device Characteristics VPD Page
2827  */
2828 struct scsi_vpd_block_device_characteristics
2829 {
2830 	uint8_t device;
2831 	uint8_t page_code;
2832 #define	SVPD_BDC		0xB1
2833 	uint8_t page_length[2];
2834 	uint8_t medium_rotation_rate[2];
2835 #define	SVPD_NOT_REPORTED	0x0000
2836 #define	SVPD_NON_ROTATING	0x0001
2837 	uint8_t product_type;
2838 	uint8_t wab_wac_ff;
2839 	uint8_t flags;
2840 #define	SVPD_VBULS		0x01
2841 #define	SVPD_FUAB		0x02
2842 #define	SVPD_BOCS		0x04
2843 #define	SVPD_RBWZ		0x08
2844 #define	SVPD_ZBC_NR		0x00	/* Not Reported */
2845 #define	SVPD_HAW_ZBC		0x10	/* Host Aware */
2846 #define	SVPD_DM_ZBC		0x20	/* Drive Managed */
2847 #define	SVPD_ZBC_MASK		0x30	/* Zoned mask */
2848 	uint8_t reserved[3];
2849 	uint8_t depopulation_time[4];
2850 	uint8_t reserved2[48];
2851 };
2852 _Static_assert(sizeof(struct scsi_vpd_block_device_characteristics) == 64,
2853     "scsi_vpd_block_characteristics wrong size");
2854 
2855 #define SBDC_IS_PRESENT(bdc, length, field)				   \
2856 	((length >= offsetof(struct scsi_vpd_block_device_characteristics, \
2857 	  field) + sizeof(bdc->field)) ? 1 : 0)
2858 
2859 /*
2860  * Logical Block Provisioning VPD Page based on
2861  * T10/1799-D Revision 31
2862  */
2863 struct scsi_vpd_logical_block_prov
2864 {
2865 	uint8_t device;
2866 	uint8_t page_code;
2867 #define	SVPD_LBP		0xB2
2868 	uint8_t page_length[2];
2869 #define SVPD_LBP_PL_BASIC	0x04
2870 	uint8_t threshold_exponent;
2871 	uint8_t flags;
2872 #define SVPD_LBP_UNMAP		0x80
2873 #define SVPD_LBP_WS16		0x40
2874 #define SVPD_LBP_WS10		0x20
2875 #define SVPD_LBP_RZ		0x04
2876 #define SVPD_LBP_ANC_SUP	0x02
2877 #define SVPD_LBP_DP		0x01
2878 	uint8_t prov_type;
2879 #define SVPD_LBP_RESOURCE	0x01
2880 #define SVPD_LBP_THIN		0x02
2881 	uint8_t reserved;
2882 	/*
2883 	 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
2884 	 * Its size can be determined from page_length - 4
2885 	 */
2886 };
2887 
2888 /*
2889  * Block Limits VDP Page based on SBC-4 Revision 17
2890  */
2891 struct scsi_vpd_block_limits
2892 {
2893 	uint8_t device;
2894 	uint8_t page_code;
2895 #define	SVPD_BLOCK_LIMITS	0xB0
2896 	uint8_t page_length[2];
2897 #define SVPD_BL_PL_BASIC	0x10
2898 #define SVPD_BL_PL_TP		0x3C
2899 	uint8_t flags;
2900 #define	SVPD_BL_WSNZ		0x01
2901 	uint8_t max_cmp_write_len;
2902 	uint8_t opt_txfer_len_grain[2];
2903 	uint8_t max_txfer_len[4];
2904 	uint8_t opt_txfer_len[4];
2905 	uint8_t max_prefetch[4];
2906 	uint8_t max_unmap_lba_cnt[4];
2907 	uint8_t max_unmap_blk_cnt[4];
2908 	uint8_t opt_unmap_grain[4];
2909 	uint8_t unmap_grain_align[4];
2910 	uint8_t max_write_same_length[8];
2911 	uint8_t max_atomic_transfer_length[4];
2912 	uint8_t atomic_alignment[4];
2913 	uint8_t atomic_transfer_length_granularity[4];
2914 	uint8_t max_atomic_transfer_length_with_atomic_boundary[4];
2915 	uint8_t max_atomic_boundary_size[4];
2916 };
2917 
2918 /*
2919  * Zoned Block Device Characacteristics VPD page.
2920  * From ZBC-r04, dated August 12, 2015.
2921  */
2922 struct scsi_vpd_zoned_bdc {
2923 	uint8_t device;
2924 	uint8_t page_code;
2925 #define	SVPD_ZONED_BDC		0xB6
2926 	uint8_t page_length[2];
2927 #define	SVPD_ZBDC_PL	0x3C
2928 	uint8_t flags;
2929 #define	SVPD_ZBDC_URSWRZ	0x01
2930 	uint8_t reserved1[3];
2931 	uint8_t optimal_seq_zones[4];
2932 #define	SVPD_ZBDC_OPT_SEQ_NR		0xffffffff
2933 	uint8_t optimal_nonseq_zones[4];
2934 #define SVPD_ZBDC_OPT_NONSEQ_NR		0xffffffff
2935 	uint8_t max_seq_req_zones[4];
2936 #define	SVPD_ZBDC_MAX_SEQ_UNLIMITED	0xffffffff
2937 	uint8_t reserved2[44];
2938 };
2939 
2940 struct scsi_read_capacity
2941 {
2942 	uint8_t opcode;
2943 	uint8_t byte2;
2944 #define	SRC_RELADR	0x01
2945 	uint8_t addr[4];
2946 	uint8_t unused[2];
2947 	uint8_t pmi;
2948 #define	SRC_PMI		0x01
2949 	uint8_t control;
2950 };
2951 
2952 struct scsi_read_capacity_16
2953 {
2954 	uint8_t opcode;
2955 #define	SRC16_SERVICE_ACTION	0x10
2956 	uint8_t service_action;
2957 	uint8_t addr[8];
2958 	uint8_t alloc_len[4];
2959 #define	SRC16_PMI		0x01
2960 #define	SRC16_RELADR		0x02
2961 	uint8_t reladr;
2962 	uint8_t control;
2963 };
2964 
2965 struct scsi_read_capacity_data
2966 {
2967 	uint8_t addr[4];
2968 	uint8_t length[4];
2969 };
2970 
2971 struct scsi_read_capacity_data_long
2972 {
2973 	uint8_t addr[8];
2974 	uint8_t length[4];
2975 #define	SRC16_PROT_EN		0x01
2976 #define	SRC16_P_TYPE		0x0e
2977 #define	SRC16_P_TYPE_SHIFT	1
2978 #define	SRC16_PTYPE_1		0x00
2979 #define	SRC16_PTYPE_2		0x02
2980 #define	SRC16_PTYPE_3		0x04
2981 	uint8_t prot;
2982 #define	SRC16_LBPPBE		0x0f
2983 #define	SRC16_PI_EXPONENT	0xf0
2984 #define	SRC16_PI_EXPONENT_SHIFT	4
2985 	uint8_t prot_lbppbe;
2986 #define	SRC16_LALBA		0x3f
2987 #define	SRC16_LBPRZ		0x40
2988 #define	SRC16_LBPME		0x80
2989 /*
2990  * Alternate versions of these macros that are intended for use on a 16-bit
2991  * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
2992  */
2993 #define	SRC16_LALBA_A		0x3fff
2994 #define	SRC16_LBPRZ_A		0x4000
2995 #define	SRC16_LBPME_A		0x8000
2996 	uint8_t lalba_lbp[2];
2997 	uint8_t	reserved[16];
2998 };
2999 
3000 struct scsi_get_lba_status
3001 {
3002 	uint8_t opcode;
3003 #define	SGLS_SERVICE_ACTION	0x12
3004 	uint8_t service_action;
3005 	uint8_t addr[8];
3006 	uint8_t alloc_len[4];
3007 	uint8_t reserved;
3008 	uint8_t control;
3009 };
3010 
3011 struct scsi_get_lba_status_data_descr
3012 {
3013 	uint8_t addr[8];
3014 	uint8_t length[4];
3015 	uint8_t status;
3016 	uint8_t reserved[3];
3017 };
3018 
3019 struct scsi_get_lba_status_data
3020 {
3021 	uint8_t length[4];
3022 	uint8_t reserved[4];
3023 	struct scsi_get_lba_status_data_descr descr[];
3024 };
3025 
3026 struct scsi_report_luns
3027 {
3028 	uint8_t opcode;
3029 	uint8_t reserved1;
3030 #define	RPL_REPORT_DEFAULT	0x00
3031 #define	RPL_REPORT_WELLKNOWN	0x01
3032 #define	RPL_REPORT_ALL		0x02
3033 #define	RPL_REPORT_ADMIN	0x10
3034 #define	RPL_REPORT_NONSUBSID	0x11
3035 #define	RPL_REPORT_CONGLOM	0x12
3036 	uint8_t select_report;
3037 	uint8_t reserved2[3];
3038 	uint8_t length[4];
3039 	uint8_t reserved3;
3040 	uint8_t control;
3041 };
3042 
3043 struct scsi_report_luns_lundata {
3044 	uint8_t lundata[8];
3045 #define	RPL_LUNDATA_PERIPH_BUS_MASK	0x3f
3046 #define	RPL_LUNDATA_FLAT_LUN_MASK	0x3f
3047 #define	RPL_LUNDATA_FLAT_LUN_BITS	0x06
3048 #define	RPL_LUNDATA_LUN_TARG_MASK	0x3f
3049 #define	RPL_LUNDATA_LUN_BUS_MASK	0xe0
3050 #define	RPL_LUNDATA_LUN_LUN_MASK	0x1f
3051 #define	RPL_LUNDATA_EXT_LEN_MASK	0x30
3052 #define	RPL_LUNDATA_EXT_EAM_MASK	0x0f
3053 #define	RPL_LUNDATA_EXT_EAM_WK		0x01
3054 #define	RPL_LUNDATA_EXT_EAM_NOT_SPEC	0x0f
3055 #define	RPL_LUNDATA_ATYP_MASK	0xc0	/* MBZ for type 0 lun */
3056 #define	RPL_LUNDATA_ATYP_PERIPH	0x00
3057 #define	RPL_LUNDATA_ATYP_FLAT	0x40
3058 #define	RPL_LUNDATA_ATYP_LUN	0x80
3059 #define	RPL_LUNDATA_ATYP_EXTLUN	0xc0
3060 };
3061 
3062 struct scsi_report_luns_data {
3063 	uint8_t length[4];	/* length of LUN inventory, in bytes */
3064 	uint8_t reserved[4];	/* unused */
3065 	/*
3066 	 * LUN inventory- we only support the type zero form for now.
3067 	 */
3068 	struct scsi_report_luns_lundata luns[0];
3069 };
3070 
3071 /*
3072  * GET PHYSICAL ELEMENT STATUS (GPES) from SBC-4 (r21 or later)
3073  * REMOVE ELEMENT AND TRUNCATE (RET) from SBC-4 (r21 or later)
3074  * RESTORE ELEMENT AND REBUILD (RER) from SBC-4 (r21 or later)
3075  *
3076  * Queries drives that support it for the status of feach of their physical
3077  * storage elements (which typically map to heads, but aren't required to).
3078  * These elements can be selective removed (at a reduced capacity) or restored
3079  * to service.
3080  */
3081 struct scsi_get_physical_element_status
3082 {
3083 	uint8_t	opcode;
3084 	uint8_t service_action;
3085 	uint8_t rsvd[4];
3086 	uint8_t starting_element[4];
3087 	uint8_t allocation_length[4];
3088 	uint8_t report_type;
3089 #define SCSI_GPES_FILTER_ALL		0x00
3090 #define SCSI_GPES_FILTER_EXEPTION	0x40
3091 #define	SCSI_GPES_REPORT_TYPE_PHYS	0x00
3092 #define	SCSI_GEPS_REPORT_TYPE_STORAGE	0x01
3093 	uint8_t control;
3094 };
3095 _Static_assert(sizeof(struct scsi_get_physical_element_status) == 16,
3096     "scsi_get_physical_element_status wrong size");
3097 
3098 struct scsi_get_physical_element_hdr
3099 {
3100 	uint8_t	num_descriptors[4];
3101 	uint8_t	num_returned[4];
3102 	uint8_t id_depop[4];
3103 	uint8_t	rsvd[20];
3104 };
3105 _Static_assert(sizeof(struct scsi_get_physical_element_hdr) == 32,
3106     "scsi_get_physical_element_hdr wrong size");
3107 
3108 struct scsi_get_physical_element_descriptor
3109 {
3110 	uint8_t	rsvd1[4];
3111 	uint8_t element_identifier[4];
3112 	uint8_t rsvd2[5];
3113 	uint8_t ralwd;
3114 	uint8_t physical_element_type;
3115 #define GPED_TYPE_STORAGE 0x1
3116 	uint8_t physical_element_health;
3117 	uint8_t capacity[8];
3118 	uint8_t rsvd3[8];
3119 };
3120 _Static_assert(sizeof(struct scsi_get_physical_element_descriptor) == 32,
3121     "scsi_get_physical_element_descriptor wrong size");
3122 
3123 struct scsi_remove_element_and_truncate
3124 {
3125 	uint8_t	opcode;
3126 	uint8_t service_action;
3127 	uint8_t requested_capacity[8];
3128 	uint8_t element_identifier[4];
3129 	uint8_t rsvd;
3130 	uint8_t control;
3131 };
3132 _Static_assert(sizeof(struct scsi_remove_element_and_truncate) == 16,
3133     "scsi_remove_element_and_truncate wrong size");
3134 
3135 struct scsi_target_group
3136 {
3137 	uint8_t opcode;
3138 	uint8_t service_action;
3139 #define	STG_PDF_MASK		0xe0
3140 #define	STG_PDF_LENGTH		0x00
3141 #define	STG_PDF_EXTENDED	0x20
3142 	uint8_t reserved1[4];
3143 	uint8_t length[4];
3144 	uint8_t reserved2;
3145 	uint8_t control;
3146 };
3147 
3148 struct scsi_timestamp
3149 {
3150 	uint8_t opcode;
3151 	uint8_t service_action;
3152 	uint8_t reserved1[4];
3153 	uint8_t length[4];
3154 	uint8_t reserved2;
3155 	uint8_t control;
3156 };
3157 
3158 struct scsi_set_timestamp_parameters
3159 {
3160 	uint8_t reserved1[4];
3161 	uint8_t timestamp[6];
3162 	uint8_t reserved2[2];
3163 };
3164 
3165 struct scsi_report_timestamp_parameter_data
3166 {
3167 	uint8_t length[2];
3168 	uint8_t reserved1[2];
3169 	uint8_t timestamp[6];
3170 	uint8_t reserved2[2];
3171 };
3172 
3173 struct scsi_target_port_descriptor {
3174 	uint8_t	reserved[2];
3175 	uint8_t	relative_target_port_identifier[2];
3176 	uint8_t desc_list[];
3177 };
3178 
3179 struct scsi_target_port_group_descriptor {
3180 	uint8_t	pref_state;
3181 #define	TPG_PRIMARY				0x80
3182 #define	TPG_ASYMMETRIC_ACCESS_STATE_MASK	0xf
3183 #define	TPG_ASYMMETRIC_ACCESS_OPTIMIZED		0x0
3184 #define	TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED	0x1
3185 #define	TPG_ASYMMETRIC_ACCESS_STANDBY		0x2
3186 #define	TPG_ASYMMETRIC_ACCESS_UNAVAILABLE	0x3
3187 #define	TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT	0x4
3188 #define	TPG_ASYMMETRIC_ACCESS_OFFLINE		0xE
3189 #define	TPG_ASYMMETRIC_ACCESS_TRANSITIONING	0xF
3190 	uint8_t support;
3191 #define	TPG_AO_SUP	0x01
3192 #define	TPG_AN_SUP	0x02
3193 #define	TPG_S_SUP	0x04
3194 #define	TPG_U_SUP	0x08
3195 #define	TPG_LBD_SUP	0x10
3196 #define	TPG_O_SUP	0x40
3197 #define	TPG_T_SUP	0x80
3198 	uint8_t target_port_group[2];
3199 	uint8_t reserved;
3200 	uint8_t status;
3201 #define TPG_UNAVLBL      0
3202 #define TPG_SET_BY_STPG  0x01
3203 #define TPG_IMPLICIT     0x02
3204 	uint8_t vendor_specific;
3205 	uint8_t	target_port_count;
3206 	struct scsi_target_port_descriptor descriptors[];
3207 };
3208 
3209 struct scsi_target_group_data {
3210 	uint8_t length[4];	/* length of returned data, in bytes */
3211 	struct scsi_target_port_group_descriptor groups[];
3212 };
3213 
3214 struct scsi_target_group_data_extended {
3215 	uint8_t length[4];	/* length of returned data, in bytes */
3216 	uint8_t format_type;	/* STG_PDF_LENGTH or STG_PDF_EXTENDED */
3217 	uint8_t	implicit_transition_time;
3218 	uint8_t reserved[2];
3219 	struct scsi_target_port_group_descriptor groups[];
3220 };
3221 
3222 struct scsi_security_protocol_in
3223 {
3224 	uint8_t opcode;
3225 	uint8_t security_protocol;
3226 #define	SPI_PROT_INFORMATION		0x00
3227 #define	SPI_PROT_CBCS			0x07
3228 #define	SPI_PROT_TAPE_DATA_ENC		0x20
3229 #define	SPI_PROT_DATA_ENC_CONFIG	0x21
3230 #define	SPI_PROT_SA_CREATE_CAP		0x40
3231 #define	SPI_PROT_IKEV2_SCSI		0x41
3232 #define	SPI_PROT_JEDEC_UFS		0xEC
3233 #define	SPI_PROT_SDCARD_TFSSS		0xED
3234 #define	SPI_PROT_AUTH_HOST_TRANSIENT	0xEE
3235 #define	SPI_PROT_ATA_DEVICE_PASSWORD	0xEF
3236 	uint8_t security_protocol_specific[2];
3237 	uint8_t byte4;
3238 #define	SPI_INC_512	0x80
3239 	uint8_t reserved1;
3240 	uint8_t length[4];
3241 	uint8_t reserved2;
3242 	uint8_t control;
3243 };
3244 
3245 struct scsi_security_protocol_out
3246 {
3247 	uint8_t opcode;
3248 	uint8_t security_protocol;
3249 	uint8_t security_protocol_specific[2];
3250 	uint8_t byte4;
3251 #define	SPO_INC_512	0x80
3252 	uint8_t reserved1;
3253 	uint8_t length[4];
3254 	uint8_t reserved2;
3255 	uint8_t control;
3256 };
3257 
3258 typedef enum {
3259 	SSD_TYPE_NONE,
3260 	SSD_TYPE_FIXED,
3261 	SSD_TYPE_DESC
3262 } scsi_sense_data_type;
3263 
3264 typedef enum {
3265 	SSD_ELEM_NONE,
3266 	SSD_ELEM_SKIP,
3267 	SSD_ELEM_DESC,
3268 	SSD_ELEM_SKS,
3269 	SSD_ELEM_COMMAND,
3270 	SSD_ELEM_INFO,
3271 	SSD_ELEM_FRU,
3272 	SSD_ELEM_STREAM,
3273 	SSD_ELEM_MAX
3274 } scsi_sense_elem_type;
3275 
3276 struct scsi_sense_data
3277 {
3278 	uint8_t error_code;
3279 	/*
3280 	 * SPC-4 says that the maximum length of sense data is 252 bytes.
3281 	 * So this structure is exactly 252 bytes log.
3282 	 */
3283 #define	SSD_FULL_SIZE 252
3284 	uint8_t sense_buf[SSD_FULL_SIZE - 1];
3285 	/*
3286 	 * XXX KDM is this still a reasonable minimum size?
3287 	 */
3288 #define	SSD_MIN_SIZE 18
3289 	/*
3290 	 * Maximum value for the extra_len field in the sense data.
3291 	 */
3292 #define	SSD_EXTRA_MAX 244
3293 };
3294 
3295 /*
3296  * Fixed format sense data.
3297  */
3298 struct scsi_sense_data_fixed
3299 {
3300 	uint8_t error_code;
3301 #define	SSD_ERRCODE			0x7F
3302 #define		SSD_CURRENT_ERROR	0x70
3303 #define		SSD_DEFERRED_ERROR	0x71
3304 #define	SSD_ERRCODE_VALID	0x80
3305 	uint8_t segment;
3306 	uint8_t flags;
3307 #define	SSD_KEY				0x0F
3308 #define		SSD_KEY_NO_SENSE	0x00
3309 #define		SSD_KEY_RECOVERED_ERROR	0x01
3310 #define		SSD_KEY_NOT_READY	0x02
3311 #define		SSD_KEY_MEDIUM_ERROR	0x03
3312 #define		SSD_KEY_HARDWARE_ERROR	0x04
3313 #define		SSD_KEY_ILLEGAL_REQUEST	0x05
3314 #define		SSD_KEY_UNIT_ATTENTION	0x06
3315 #define		SSD_KEY_DATA_PROTECT	0x07
3316 #define		SSD_KEY_BLANK_CHECK	0x08
3317 #define		SSD_KEY_Vendor_Specific	0x09
3318 #define		SSD_KEY_COPY_ABORTED	0x0a
3319 #define		SSD_KEY_ABORTED_COMMAND	0x0b
3320 #define		SSD_KEY_EQUAL		0x0c
3321 #define		SSD_KEY_VOLUME_OVERFLOW	0x0d
3322 #define		SSD_KEY_MISCOMPARE	0x0e
3323 #define		SSD_KEY_COMPLETED	0x0f
3324 #define	SSD_SDAT_OVFL	0x10
3325 #define	SSD_ILI		0x20
3326 #define	SSD_EOM		0x40
3327 #define	SSD_FILEMARK	0x80
3328 	uint8_t info[4];
3329 	uint8_t extra_len;
3330 	uint8_t cmd_spec_info[4];
3331 	uint8_t add_sense_code;
3332 	uint8_t add_sense_code_qual;
3333 	uint8_t fru;
3334 	uint8_t sense_key_spec[3];
3335 #define	SSD_SCS_VALID		0x80
3336 #define	SSD_FIELDPTR_CMD	0x40
3337 #define	SSD_BITPTR_VALID	0x08
3338 #define	SSD_BITPTR_VALUE	0x07
3339 	uint8_t extra_bytes[14];
3340 #define	SSD_FIXED_IS_PRESENT(sense, length, field) 			\
3341 	((length >= (offsetof(struct scsi_sense_data_fixed, field) +	\
3342 	sizeof(sense->field))) ? 1 :0)
3343 #define	SSD_FIXED_IS_FILLED(sense, field) 				\
3344 	((((offsetof(struct scsi_sense_data_fixed, field) +		\
3345 	sizeof(sense->field)) -						\
3346 	(offsetof(struct scsi_sense_data_fixed, extra_len) +		\
3347 	sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
3348 };
3349 
3350 /*
3351  * Descriptor format sense data definitions.
3352  * Introduced in SPC-3.
3353  */
3354 struct scsi_sense_data_desc
3355 {
3356 	uint8_t	error_code;
3357 #define	SSD_DESC_CURRENT_ERROR	0x72
3358 #define	SSD_DESC_DEFERRED_ERROR	0x73
3359 	uint8_t sense_key;
3360 	uint8_t	add_sense_code;
3361 	uint8_t	add_sense_code_qual;
3362 	uint8_t	flags;
3363 #define	SSDD_SDAT_OVFL		0x80
3364 	uint8_t	reserved[2];
3365 	/*
3366 	 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
3367 	 * must be less than or equal to 244.
3368 	 */
3369 	uint8_t	extra_len;
3370 	uint8_t	sense_desc[0];
3371 #define	SSD_DESC_IS_PRESENT(sense, length, field) 			\
3372 	((length >= (offsetof(struct scsi_sense_data_desc, field) +	\
3373 	sizeof(sense->field))) ? 1 :0)
3374 };
3375 
3376 struct scsi_sense_desc_header
3377 {
3378 	uint8_t desc_type;
3379 	uint8_t length;
3380 };
3381 /*
3382  * The information provide in the Information descriptor is device type or
3383  * command specific information, and defined in a command standard.
3384  *
3385  * Note that any changes to the field names or positions in this structure,
3386  * even reserved fields, should be accompanied by an examination of the
3387  * code in ctl_set_sense() that uses them.
3388  *
3389  * Maximum descriptors allowed: 1 (as of SPC-4)
3390  */
3391 struct scsi_sense_info
3392 {
3393 	uint8_t	desc_type;
3394 #define	SSD_DESC_INFO	0x00
3395 	uint8_t	length;
3396 	uint8_t	byte2;
3397 #define	SSD_INFO_VALID	0x80
3398 	uint8_t	reserved;
3399 	uint8_t	info[8];
3400 };
3401 
3402 /*
3403  * Command-specific information depends on the command for which the
3404  * reported condition occurred.
3405  *
3406  * Note that any changes to the field names or positions in this structure,
3407  * even reserved fields, should be accompanied by an examination of the
3408  * code in ctl_set_sense() that uses them.
3409  *
3410  * Maximum descriptors allowed: 1 (as of SPC-4)
3411  */
3412 struct scsi_sense_command
3413 {
3414 	uint8_t	desc_type;
3415 #define	SSD_DESC_COMMAND	0x01
3416 	uint8_t	length;
3417 	uint8_t	reserved[2];
3418 	uint8_t	command_info[8];
3419 };
3420 
3421 /*
3422  * Sense key specific descriptor.  The sense key specific data format
3423  * depends on the sense key in question.
3424  *
3425  * Maximum descriptors allowed: 1 (as of SPC-4)
3426  */
3427 struct scsi_sense_sks
3428 {
3429 	uint8_t	desc_type;
3430 #define	SSD_DESC_SKS		0x02
3431 	uint8_t	length;
3432 	uint8_t reserved1[2];
3433 	uint8_t	sense_key_spec[3];
3434 #define	SSD_SKS_VALID		0x80
3435 	uint8_t reserved2;
3436 };
3437 
3438 /*
3439  * This is used for the Illegal Request sense key (0x05) only.
3440  */
3441 struct scsi_sense_sks_field
3442 {
3443 	uint8_t	byte0;
3444 #define	SSD_SKS_FIELD_VALID	0x80
3445 #define	SSD_SKS_FIELD_CMD	0x40
3446 #define	SSD_SKS_BPV		0x08
3447 #define	SSD_SKS_BIT_VALUE	0x07
3448 	uint8_t	field[2];
3449 };
3450 
3451 /*
3452  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
3453  * Recovered Error (0x01) sense keys.
3454  */
3455 struct scsi_sense_sks_retry
3456 {
3457 	uint8_t byte0;
3458 #define	SSD_SKS_RETRY_VALID	0x80
3459 	uint8_t actual_retry_count[2];
3460 };
3461 
3462 /*
3463  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
3464  */
3465 struct scsi_sense_sks_progress
3466 {
3467 	uint8_t byte0;
3468 #define	SSD_SKS_PROGRESS_VALID	0x80
3469 	uint8_t progress[2];
3470 #define	SSD_SKS_PROGRESS_DENOM	0x10000
3471 };
3472 
3473 /*
3474  * Used with the Copy Aborted (0x0a) sense key.
3475  */
3476 struct scsi_sense_sks_segment
3477 {
3478 	uint8_t byte0;
3479 #define	SSD_SKS_SEGMENT_VALID	0x80
3480 #define	SSD_SKS_SEGMENT_SD	0x20
3481 #define	SSD_SKS_SEGMENT_BPV	0x08
3482 #define	SSD_SKS_SEGMENT_BITPTR	0x07
3483 	uint8_t field[2];
3484 };
3485 
3486 /*
3487  * Used with the Unit Attention (0x06) sense key.
3488  *
3489  * This is currently used to indicate that the unit attention condition
3490  * queue has overflowed (when the overflow bit is set).
3491  */
3492 struct scsi_sense_sks_overflow
3493 {
3494 	uint8_t byte0;
3495 #define	SSD_SKS_OVERFLOW_VALID	0x80
3496 #define	SSD_SKS_OVERFLOW_SET	0x01
3497 	uint8_t	reserved[2];
3498 };
3499 
3500 /*
3501  * This specifies which component is associated with the sense data.  There
3502  * is no standard meaning for the fru value.
3503  *
3504  * Maximum descriptors allowed: 1 (as of SPC-4)
3505  */
3506 struct scsi_sense_fru
3507 {
3508 	uint8_t	desc_type;
3509 #define	SSD_DESC_FRU		0x03
3510 	uint8_t	length;
3511 	uint8_t reserved;
3512 	uint8_t fru;
3513 };
3514 
3515 /*
3516  * Used for Stream commands, defined in SSC-4.
3517  *
3518  * Maximum descriptors allowed: 1 (as of SPC-4)
3519  */
3520 
3521 struct scsi_sense_stream
3522 {
3523 	uint8_t	desc_type;
3524 #define	SSD_DESC_STREAM		0x04
3525 	uint8_t	length;
3526 	uint8_t	reserved;
3527 	uint8_t	byte3;
3528 #define	SSD_DESC_STREAM_FM	0x80
3529 #define	SSD_DESC_STREAM_EOM	0x40
3530 #define	SSD_DESC_STREAM_ILI	0x20
3531 };
3532 
3533 /*
3534  * Used for Block commands, defined in SBC-3.
3535  *
3536  * This is currently (as of SBC-3) only used for the Incorrect Length
3537  * Indication (ILI) bit, which says that the data length requested in the
3538  * READ LONG or WRITE LONG command did not match the length of the logical
3539  * block.
3540  *
3541  * Maximum descriptors allowed: 1 (as of SPC-4)
3542  */
3543 struct scsi_sense_block
3544 {
3545 	uint8_t	desc_type;
3546 #define	SSD_DESC_BLOCK		0x05
3547 	uint8_t	length;
3548 	uint8_t	reserved;
3549 	uint8_t	byte3;
3550 #define	SSD_DESC_BLOCK_ILI	0x20
3551 };
3552 
3553 /*
3554  * Used for Object-Based Storage Devices (OSD-3).
3555  *
3556  * Maximum descriptors allowed: 1 (as of SPC-4)
3557  */
3558 struct scsi_sense_osd_objid
3559 {
3560 	uint8_t	desc_type;
3561 #define	SSD_DESC_OSD_OBJID	0x06
3562 	uint8_t	length;
3563 	uint8_t	reserved[6];
3564 	/*
3565 	 * XXX KDM provide the bit definitions here?  There are a lot of
3566 	 * them, and we don't have an OSD driver yet.
3567 	 */
3568 	uint8_t	not_init_cmds[4];
3569 	uint8_t	completed_cmds[4];
3570 	uint8_t	partition_id[8];
3571 	uint8_t	object_id[8];
3572 };
3573 
3574 /*
3575  * Used for Object-Based Storage Devices (OSD-3).
3576  *
3577  * Maximum descriptors allowed: 1 (as of SPC-4)
3578  */
3579 struct scsi_sense_osd_integrity
3580 {
3581 	uint8_t	desc_type;
3582 #define	SSD_DESC_OSD_INTEGRITY	0x07
3583 	uint8_t	length;
3584 	uint8_t	integ_check_val[32];
3585 };
3586 
3587 /*
3588  * Used for Object-Based Storage Devices (OSD-3).
3589  *
3590  * Maximum descriptors allowed: 1 (as of SPC-4)
3591  */
3592 struct scsi_sense_osd_attr_id
3593 {
3594 	uint8_t	desc_type;
3595 #define	SSD_DESC_OSD_ATTR_ID	0x08
3596 	uint8_t	length;
3597 	uint8_t	reserved[2];
3598 	uint8_t	attr_desc[0];
3599 };
3600 
3601 /*
3602  * ATA Return descriptor, used for the SCSI ATA PASS-THROUGH(12), (16) and
3603  * (32) commands.  Described in SAT-4r05.
3604  */
3605 struct scsi_sense_ata_ret_desc
3606 {
3607 	uint8_t desc_type;
3608 #define	SSD_DESC_ATA		0x09
3609 	uint8_t length;
3610 	uint8_t flags;
3611 #define	SSD_DESC_ATA_FLAG_EXTEND	0x01
3612 	uint8_t error;
3613 	uint8_t count_15_8;
3614 	uint8_t count_7_0;
3615 	uint8_t lba_31_24;
3616 	uint8_t lba_7_0;
3617 	uint8_t lba_39_32;
3618 	uint8_t lba_15_8;
3619 	uint8_t lba_47_40;
3620 	uint8_t lba_23_16;
3621 	uint8_t device;
3622 	uint8_t status;
3623 };
3624 /*
3625  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
3626  *
3627  * Maximum descriptors allowed: 32 (as of SPC-4)
3628  */
3629 struct scsi_sense_progress
3630 {
3631 	uint8_t	desc_type;
3632 #define	SSD_DESC_PROGRESS	0x0a
3633 	uint8_t	length;
3634 	uint8_t	sense_key;
3635 	uint8_t	add_sense_code;
3636 	uint8_t	add_sense_code_qual;
3637 	uint8_t reserved;
3638 	uint8_t	progress[2];
3639 };
3640 
3641 /*
3642  * This is typically forwarded as the result of an EXTENDED COPY command.
3643  *
3644  * Maximum descriptors allowed: 2 (as of SPC-4)
3645  */
3646 struct scsi_sense_forwarded
3647 {
3648 	uint8_t	desc_type;
3649 #define	SSD_DESC_FORWARDED	0x0c
3650 	uint8_t	length;
3651 	uint8_t	byte2;
3652 #define	SSD_FORWARDED_FSDT	0x80
3653 #define	SSD_FORWARDED_SDS_MASK	0x0f
3654 #define	SSD_FORWARDED_SDS_UNK	0x00
3655 #define	SSD_FORWARDED_SDS_EXSRC	0x01
3656 #define	SSD_FORWARDED_SDS_EXDST	0x02
3657 	uint8_t	status;
3658 	uint8_t	sense_data[];
3659 };
3660 
3661 /*
3662  * Vendor-specific sense descriptor.  The desc_type field will be in the
3663  * range between MIN and MAX inclusive.
3664  */
3665 struct scsi_sense_vendor
3666 {
3667 	uint8_t	desc_type;
3668 #define	SSD_DESC_VENDOR_MIN	0x80
3669 #define	SSD_DESC_VENDOR_MAX	0xff
3670 	uint8_t length;
3671 	uint8_t	data[0];
3672 };
3673 
3674 struct scsi_mode_header_6
3675 {
3676 	uint8_t data_length;	/* Sense data length */
3677 	uint8_t medium_type;
3678 	uint8_t dev_spec;
3679 	uint8_t blk_desc_len;
3680 };
3681 
3682 struct scsi_mode_header_10
3683 {
3684 	uint8_t data_length[2];/* Sense data length */
3685 	uint8_t medium_type;
3686 	uint8_t dev_spec;
3687 	uint8_t flags;
3688 #define	SMH_LONGLBA	0x01
3689 	uint8_t unused;
3690 	uint8_t blk_desc_len[2];
3691 };
3692 
3693 struct scsi_mode_page_header
3694 {
3695 	uint8_t page_code;
3696 #define	SMPH_PS		0x80
3697 #define	SMPH_SPF	0x40
3698 #define	SMPH_PC_MASK	0x3f
3699 	uint8_t page_length;
3700 };
3701 
3702 struct scsi_mode_page_header_sp
3703 {
3704 	uint8_t page_code;
3705 	uint8_t subpage;
3706 	uint8_t page_length[2];
3707 };
3708 
3709 struct scsi_mode_blk_desc
3710 {
3711 	uint8_t density;
3712 	uint8_t nblocks[3];
3713 	uint8_t reserved;
3714 	uint8_t blklen[3];
3715 };
3716 
3717 #define	SCSI_DEFAULT_DENSITY	0x00	/* use 'default' density */
3718 #define	SCSI_SAME_DENSITY	0x7f	/* use 'same' density- >= SCSI-2 only */
3719 
3720 /*
3721  * Status Byte
3722  */
3723 #define	SCSI_STATUS_OK			0x00
3724 #define	SCSI_STATUS_CHECK_COND		0x02
3725 #define	SCSI_STATUS_COND_MET		0x04
3726 #define	SCSI_STATUS_BUSY		0x08
3727 #define	SCSI_STATUS_INTERMED		0x10
3728 #define	SCSI_STATUS_INTERMED_COND_MET	0x14
3729 #define	SCSI_STATUS_RESERV_CONFLICT	0x18
3730 #define	SCSI_STATUS_CMD_TERMINATED	0x22	/* Obsolete in SAM-2 */
3731 #define	SCSI_STATUS_QUEUE_FULL		0x28
3732 #define	SCSI_STATUS_ACA_ACTIVE		0x30
3733 #define	SCSI_STATUS_TASK_ABORTED	0x40
3734 
3735 struct scsi_inquiry_pattern {
3736 	uint8_t   type;
3737 	uint8_t   media_type;
3738 #define	SIP_MEDIA_REMOVABLE	0x01
3739 #define	SIP_MEDIA_FIXED		0x02
3740 	const char *vendor;
3741 	const char *product;
3742 	const char *revision;
3743 };
3744 
3745 struct scsi_static_inquiry_pattern {
3746 	uint8_t   type;
3747 	uint8_t   media_type;
3748 	char       vendor[SID_VENDOR_SIZE+1];
3749 	char       product[SID_PRODUCT_SIZE+1];
3750 	char       revision[SID_REVISION_SIZE+1];
3751 };
3752 
3753 struct scsi_sense_quirk_entry {
3754 	struct scsi_inquiry_pattern	inq_pat;
3755 	int				num_sense_keys;
3756 	int				num_ascs;
3757 	struct sense_key_table_entry	*sense_key_info;
3758 	struct asc_table_entry		*asc_info;
3759 };
3760 
3761 struct sense_key_table_entry {
3762 	uint8_t    sense_key;
3763 	uint32_t   action;
3764 	const char *desc;
3765 };
3766 
3767 struct asc_table_entry {
3768 	uint8_t    asc;
3769 	uint8_t    ascq;
3770 	uint32_t   action;
3771 	const char *desc;
3772 };
3773 
3774 struct op_table_entry {
3775 	uint8_t    opcode;
3776 	uint32_t   opmask;
3777 	const char  *desc;
3778 };
3779 
3780 struct scsi_op_quirk_entry {
3781 	struct scsi_inquiry_pattern	inq_pat;
3782 	int				num_ops;
3783 	struct op_table_entry		*op_table;
3784 };
3785 
3786 typedef enum {
3787 	SSS_FLAG_NONE		= 0x00,
3788 	SSS_FLAG_PRINT_COMMAND	= 0x01
3789 } scsi_sense_string_flags;
3790 
3791 struct scsi_nv {
3792 	const char *name;
3793 	uint64_t value;
3794 };
3795 
3796 typedef enum {
3797 	SCSI_NV_FOUND,
3798 	SCSI_NV_AMBIGUOUS,
3799 	SCSI_NV_NOT_FOUND
3800 } scsi_nv_status;
3801 
3802 typedef enum {
3803 	SCSI_NV_FLAG_NONE	= 0x00,
3804 	SCSI_NV_FLAG_IG_CASE	= 0x01	/* Case insensitive comparison */
3805 } scsi_nv_flags;
3806 
3807 struct ccb_scsiio;
3808 struct cam_periph;
3809 union  ccb;
3810 #ifndef _KERNEL
3811 struct cam_device;
3812 #endif
3813 
3814 extern const char *scsi_sense_key_text[];
3815 
3816 __BEGIN_DECLS
3817 void scsi_sense_desc(int sense_key, int asc, int ascq,
3818 		     struct scsi_inquiry_data *inq_data,
3819 		     const char **sense_key_desc, const char **asc_desc);
3820 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3821 				    struct scsi_inquiry_data *inq_data,
3822 				    uint32_t sense_flags);
3823 const char *	scsi_status_string(struct ccb_scsiio *csio);
3824 
3825 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3826 		       int (*iter_func)(struct scsi_sense_data_desc *sense,
3827 					u_int, struct scsi_sense_desc_header *,
3828 					void *), void *arg);
3829 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3830 			uint8_t desc_type);
3831 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3832 			 scsi_sense_data_type sense_format, int current_error,
3833 			 int sense_key, int asc, int ascq, ...) ;
3834 void scsi_set_sense_data_len(struct scsi_sense_data *sense_data,
3835     u_int *sense_len, scsi_sense_data_type sense_format, int current_error,
3836     int sense_key, int asc, int ascq, ...) ;
3837 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3838     u_int *sense_len, scsi_sense_data_type sense_format,
3839     int current_error, int sense_key, int asc, int ascq, va_list ap);
3840 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3841 			uint8_t info_type, uint64_t *info,
3842 			int64_t *signed_info);
3843 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3844 		 uint8_t *sks);
3845 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3846 			struct scsi_inquiry_data *inq_data,
3847 			uint8_t *block_bits);
3848 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3849 			 struct scsi_inquiry_data *inq_data,
3850 			 uint8_t *stream_bits);
3851 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3852 		    struct scsi_inquiry_data *inq_data, uint64_t info);
3853 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3854 		       struct scsi_inquiry_data *inq_data, uint64_t csi);
3855 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3856 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3857 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3858 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits);
3859 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits);
3860 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3861 			  u_int sense_len, uint8_t *cdb, int cdb_len,
3862 			  struct scsi_inquiry_data *inq_data,
3863 			  struct scsi_sense_desc_header *header);
3864 
3865 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3866 			     u_int sense_len, uint8_t *cdb, int cdb_len,
3867 			     struct scsi_inquiry_data *inq_data,
3868 			     struct scsi_sense_desc_header *header);
3869 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3870 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3871 			 struct scsi_inquiry_data *inq_data,
3872 			 struct scsi_sense_desc_header *header);
3873 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3874 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3875 			 struct scsi_inquiry_data *inq_data,
3876 			 struct scsi_sense_desc_header *header);
3877 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3878 			    u_int sense_len, uint8_t *cdb, int cdb_len,
3879 			    struct scsi_inquiry_data *inq_data,
3880 			    struct scsi_sense_desc_header *header);
3881 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3882 			   u_int sense_len, uint8_t *cdb, int cdb_len,
3883 			   struct scsi_inquiry_data *inq_data,
3884 			   struct scsi_sense_desc_header *header);
3885 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3886 			      u_int sense_len, uint8_t *cdb, int cdb_len,
3887 			      struct scsi_inquiry_data *inq_data,
3888 			      struct scsi_sense_desc_header *header);
3889 void scsi_sense_ata_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3890 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3891 			 struct scsi_inquiry_data *inq_data,
3892 			 struct scsi_sense_desc_header *header);
3893 void scsi_sense_forwarded_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3894 			      u_int sense_len, uint8_t *cdb, int cdb_len,
3895 			      struct scsi_inquiry_data *inq_data,
3896 			      struct scsi_sense_desc_header *header);
3897 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3898 			     u_int sense_len, uint8_t *cdb, int cdb_len,
3899 			     struct scsi_inquiry_data *inq_data,
3900 			     struct scsi_sense_desc_header *header);
3901 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3902 			  u_int sense_len, uint8_t *cdb, int cdb_len,
3903 			  struct scsi_inquiry_data *inq_data,
3904 			  struct scsi_sense_desc_header *header);
3905 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3906 
3907 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3908 			  struct sbuf *sb, char *path_str,
3909 			  struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3910 			  int cdb_len);
3911 
3912 #ifdef _KERNEL
3913 int		scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3914 int		scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3915 				scsi_sense_string_flags flags);
3916 char *		scsi_sense_string(struct ccb_scsiio *csio,
3917 				  char *str, int str_len);
3918 void		scsi_sense_print(struct ccb_scsiio *csio);
3919 int 		scsi_vpd_supported_page(struct cam_periph *periph,
3920 					uint8_t page_id);
3921 #else /* _KERNEL */
3922 int		scsi_command_string(struct cam_device *device,
3923 				    struct ccb_scsiio *csio, struct sbuf *sb);
3924 int		scsi_sense_sbuf(struct cam_device *device,
3925 				struct ccb_scsiio *csio, struct sbuf *sb,
3926 				scsi_sense_string_flags flags);
3927 char *		scsi_sense_string(struct cam_device *device,
3928 				  struct ccb_scsiio *csio,
3929 				  char *str, int str_len);
3930 void		scsi_sense_print(struct cam_device *device,
3931 				 struct ccb_scsiio *csio, FILE *ofile);
3932 #endif /* _KERNEL */
3933 
3934 const char *	scsi_op_desc(uint16_t opcode,
3935 			     struct scsi_inquiry_data *inq_data);
3936 char *		scsi_cdb_string(uint8_t *cdb_ptr, char *cdb_string,
3937 				size_t len);
3938 void		scsi_cdb_sbuf(uint8_t *cdb_ptr, struct sbuf *sb);
3939 
3940 void		scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3941 void		scsi_print_inquiry_sbuf(struct sbuf *sb,
3942 				        struct scsi_inquiry_data *inq_data);
3943 void		scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3944 void		scsi_print_inquiry_short_sbuf(struct sbuf *sb,
3945 					      struct scsi_inquiry_data *inq_data);
3946 
3947 u_int		scsi_calc_syncsrate(u_int period_factor);
3948 u_int		scsi_calc_syncparam(u_int period);
3949 
3950 typedef int	(*scsi_devid_checkfn_t)(uint8_t *);
3951 int		scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3952 int		scsi_devid_is_sas_target(uint8_t *bufp);
3953 int		scsi_devid_is_lun_eui64(uint8_t *bufp);
3954 int		scsi_devid_is_lun_naa(uint8_t *bufp);
3955 int		scsi_devid_is_lun_name(uint8_t *bufp);
3956 int		scsi_devid_is_lun_t10(uint8_t *bufp);
3957 int		scsi_devid_is_lun_md5(uint8_t *bufp);
3958 int		scsi_devid_is_lun_uuid(uint8_t *bufp);
3959 int		scsi_devid_is_port_naa(uint8_t *bufp);
3960 struct scsi_vpd_id_descriptor *
3961 		scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3962 			       scsi_devid_checkfn_t ck_fn);
3963 struct scsi_vpd_id_descriptor *
3964 		scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3965 			       scsi_devid_checkfn_t ck_fn);
3966 
3967 int		scsi_transportid_sbuf(struct sbuf *sb,
3968 				      struct scsi_transportid_header *hdr,
3969 				      uint32_t valid_len);
3970 
3971 const char *	scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3972 			       uint64_t value);
3973 
3974 scsi_nv_status	scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3975 			    char *name, int *table_entry, scsi_nv_flags flags);
3976 
3977 int	scsi_parse_transportid_64bit(int proto_id, char *id_str,
3978 				     struct scsi_transportid_header **hdr,
3979 				     unsigned int *alloc_len,
3980 #ifdef _KERNEL
3981 				     struct malloc_type *type, int flags,
3982 #endif
3983 				     char *error_str, int error_str_len);
3984 
3985 int	scsi_parse_transportid_spi(char *id_str,
3986 				   struct scsi_transportid_header **hdr,
3987 				   unsigned int *alloc_len,
3988 #ifdef _KERNEL
3989 				   struct malloc_type *type, int flags,
3990 #endif
3991 				   char *error_str, int error_str_len);
3992 
3993 int	scsi_parse_transportid_rdma(char *id_str,
3994 				    struct scsi_transportid_header **hdr,
3995 				    unsigned int *alloc_len,
3996 #ifdef _KERNEL
3997 				    struct malloc_type *type, int flags,
3998 #endif
3999 				    char *error_str, int error_str_len);
4000 
4001 int	scsi_parse_transportid_iscsi(char *id_str,
4002 				     struct scsi_transportid_header **hdr,
4003 				     unsigned int *alloc_len,
4004 #ifdef _KERNEL
4005 				     struct malloc_type *type, int flags,
4006 #endif
4007 				     char *error_str,int error_str_len);
4008 
4009 int	scsi_parse_transportid_sop(char *id_str,
4010 				   struct scsi_transportid_header **hdr,
4011 				   unsigned int *alloc_len,
4012 #ifdef _KERNEL
4013 				   struct malloc_type *type, int flags,
4014 #endif
4015 				   char *error_str,int error_str_len);
4016 
4017 int	scsi_parse_transportid(char *transportid_str,
4018 			       struct scsi_transportid_header **hdr,
4019 			       unsigned int *alloc_len,
4020 #ifdef _KERNEL
4021 			       struct malloc_type *type, int flags,
4022 #endif
4023 			       char *error_str, int error_str_len);
4024 
4025 int scsi_attrib_volcoh_sbuf(struct sbuf *sb,
4026 			    struct scsi_mam_attribute_header *hdr,
4027 			    uint32_t valid_len, uint32_t flags,
4028 			    uint32_t output_flags, char *error_str,
4029 			    int error_str_len);
4030 
4031 int scsi_attrib_vendser_sbuf(struct sbuf *sb,
4032 			     struct scsi_mam_attribute_header *hdr,
4033 			     uint32_t valid_len, uint32_t flags,
4034 			     uint32_t output_flags, char *error_str,
4035 			     int error_str_len);
4036 
4037 int scsi_attrib_hexdump_sbuf(struct sbuf *sb,
4038 			     struct scsi_mam_attribute_header *hdr,
4039 			     uint32_t valid_len, uint32_t flags,
4040 			     uint32_t output_flags, char *error_str,
4041 			     int error_str_len);
4042 
4043 int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
4044 			 uint32_t valid_len, uint32_t flags,
4045 			 uint32_t output_flags, char *error_str,
4046 			 int error_str_len);
4047 
4048 int scsi_attrib_ascii_sbuf(struct sbuf *sb,
4049 			   struct scsi_mam_attribute_header *hdr,
4050 			   uint32_t valid_len, uint32_t flags,
4051 			   uint32_t output_flags, char *error_str,
4052 			   int error_str_len);
4053 
4054 int scsi_attrib_text_sbuf(struct sbuf *sb,
4055 			  struct scsi_mam_attribute_header *hdr,
4056 			  uint32_t valid_len, uint32_t flags,
4057 			  uint32_t output_flags, char *error_str,
4058 			  int error_str_len);
4059 
4060 struct scsi_attrib_table_entry *scsi_find_attrib_entry(
4061 			struct scsi_attrib_table_entry *table,
4062 			size_t num_table_entries, uint32_t id);
4063 
4064 struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id);
4065 
4066 int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
4067 			   struct scsi_mam_attribute_header *hdr,
4068 			   uint32_t output_flags, char *error_str,
4069 			   size_t error_str_len);
4070 
4071 void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
4072 			     struct scsi_mam_attribute_header *hdr,
4073 			     uint32_t valid_len, const char *desc);
4074 
4075 int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
4076 		     uint32_t valid_len,
4077 		     struct scsi_attrib_table_entry *user_table,
4078 		     size_t num_user_entries, int prefer_user_table,
4079 		     uint32_t output_flags, char *error_str, int error_str_len);
4080 
4081 void		scsi_test_unit_ready(struct ccb_scsiio *csio, uint32_t retries,
4082 				     void (*cbfcnp)(struct cam_periph *,
4083 						    union ccb *),
4084 				     uint8_t tag_action,
4085 				     uint8_t sense_len, uint32_t timeout);
4086 
4087 void		scsi_request_sense(struct ccb_scsiio *csio, uint32_t retries,
4088 				   void (*cbfcnp)(struct cam_periph *,
4089 						  union ccb *),
4090 				   void *data_ptr, uint8_t dxfer_len,
4091 				   uint8_t tag_action, uint8_t sense_len,
4092 				   uint32_t timeout);
4093 
4094 void		scsi_inquiry(struct ccb_scsiio *csio, uint32_t retries,
4095 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
4096 			     uint8_t tag_action, uint8_t *inq_buf,
4097 			     uint32_t inq_len, int evpd, uint8_t page_code,
4098 			     uint8_t sense_len, uint32_t timeout);
4099 
4100 void		scsi_mode_sense(struct ccb_scsiio *csio, uint32_t retries,
4101 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4102 		    uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
4103 		    uint8_t *param_buf, uint32_t param_len,
4104 		    uint8_t sense_len, uint32_t timeout);
4105 
4106 void		scsi_mode_sense_len(struct ccb_scsiio *csio, uint32_t retries,
4107 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4108 		    uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
4109 		    uint8_t *param_buf, uint32_t param_len,
4110 		    int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4111 
4112 void		scsi_mode_sense_subpage(struct ccb_scsiio *csio,
4113 		    uint32_t retries,
4114 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4115 		    uint8_t tag_action, int dbd, uint8_t pc,
4116 		    uint8_t page, uint8_t subpage,
4117 		    uint8_t *param_buf, uint32_t param_len,
4118 		    int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4119 
4120 void		scsi_mode_select(struct ccb_scsiio *csio, uint32_t retries,
4121 				 void (*cbfcnp)(struct cam_periph *,
4122 						union ccb *),
4123 				 uint8_t tag_action, int scsi_page_fmt,
4124 				 int save_pages, uint8_t *param_buf,
4125 				 uint32_t param_len, uint8_t sense_len,
4126 				 uint32_t timeout);
4127 
4128 void		scsi_mode_select_len(struct ccb_scsiio *csio, uint32_t retries,
4129 				     void (*cbfcnp)(struct cam_periph *,
4130 						    union ccb *),
4131 				     uint8_t tag_action, int scsi_page_fmt,
4132 				     int save_pages, uint8_t *param_buf,
4133 				     uint32_t param_len, int minimum_cmd_size,
4134 				     uint8_t sense_len, uint32_t timeout);
4135 
4136 void		scsi_log_sense(struct ccb_scsiio *csio, uint32_t retries,
4137 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
4138 			       uint8_t tag_action, uint8_t page_code,
4139 			       uint8_t page, int save_pages, int ppc,
4140 			       uint32_t paramptr, uint8_t *param_buf,
4141 			       uint32_t param_len, uint8_t sense_len,
4142 			       uint32_t timeout);
4143 
4144 void		scsi_log_select(struct ccb_scsiio *csio, uint32_t retries,
4145 				void (*cbfcnp)(struct cam_periph *,
4146 				union ccb *), uint8_t tag_action,
4147 				uint8_t page_code, int save_pages,
4148 				int pc_reset, uint8_t *param_buf,
4149 				uint32_t param_len, uint8_t sense_len,
4150 				uint32_t timeout);
4151 
4152 void		scsi_prevent(struct ccb_scsiio *csio, uint32_t retries,
4153 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
4154 			     uint8_t tag_action, uint8_t action,
4155 			     uint8_t sense_len, uint32_t timeout);
4156 
4157 void		scsi_read_capacity(struct ccb_scsiio *csio, uint32_t retries,
4158 				   void (*cbfcnp)(struct cam_periph *,
4159 				   union ccb *), uint8_t tag_action,
4160 				   struct scsi_read_capacity_data *,
4161 				   uint8_t sense_len, uint32_t timeout);
4162 void		scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
4163 				      void (*cbfcnp)(struct cam_periph *,
4164 				      union ccb *), uint8_t tag_action,
4165 				      uint64_t lba, int reladr, int pmi,
4166 				      uint8_t *rcap_buf, int rcap_buf_len,
4167 				      uint8_t sense_len, uint32_t timeout);
4168 
4169 void		scsi_report_luns(struct ccb_scsiio *csio, uint32_t retries,
4170 				 void (*cbfcnp)(struct cam_periph *,
4171 				 union ccb *), uint8_t tag_action,
4172 				 uint8_t select_report,
4173 				 struct scsi_report_luns_data *rpl_buf,
4174 				 uint32_t alloc_len, uint8_t sense_len,
4175 				 uint32_t timeout);
4176 
4177 void		scsi_report_target_group(struct ccb_scsiio *csio, uint32_t retries,
4178 				 void (*cbfcnp)(struct cam_periph *,
4179 				 union ccb *), uint8_t tag_action,
4180 				 uint8_t pdf,
4181 				 void *buf,
4182 				 uint32_t alloc_len, uint8_t sense_len,
4183 				 uint32_t timeout);
4184 
4185 void		scsi_report_timestamp(struct ccb_scsiio *csio, uint32_t retries,
4186 				 void (*cbfcnp)(struct cam_periph *,
4187 				 union ccb *), uint8_t tag_action,
4188 				 uint8_t pdf,
4189 				 void *buf,
4190 				 uint32_t alloc_len, uint8_t sense_len,
4191 				 uint32_t timeout);
4192 
4193 void		scsi_set_target_group(struct ccb_scsiio *csio, uint32_t retries,
4194 				 void (*cbfcnp)(struct cam_periph *,
4195 				 union ccb *), uint8_t tag_action, void *buf,
4196 				 uint32_t alloc_len, uint8_t sense_len,
4197 				 uint32_t timeout);
4198 
4199 void		scsi_create_timestamp(uint8_t *timestamp_6b_buf,
4200 				      uint64_t timestamp);
4201 
4202 void		scsi_set_timestamp(struct ccb_scsiio *csio, uint32_t retries,
4203 				   void (*cbfcnp)(struct cam_periph *,
4204 				   union ccb *), uint8_t tag_action,
4205 				   void *buf, uint32_t alloc_len,
4206 				   uint8_t sense_len, uint32_t timeout);
4207 
4208 void		scsi_synchronize_cache(struct ccb_scsiio *csio,
4209 				       uint32_t retries,
4210 				       void (*cbfcnp)(struct cam_periph *,
4211 				       union ccb *), uint8_t tag_action,
4212 				       uint32_t begin_lba, uint16_t lb_count,
4213 				       uint8_t sense_len, uint32_t timeout);
4214 
4215 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, uint32_t retries,
4216 				     void (*cbfcnp)(struct cam_periph *,
4217 						    union ccb*),
4218 				     uint8_t tag_action, int pcv,
4219 				     uint8_t page_code, uint8_t *data_ptr,
4220 				     uint16_t allocation_length,
4221 				     uint8_t sense_len, uint32_t timeout);
4222 
4223 void scsi_send_diagnostic(struct ccb_scsiio *csio, uint32_t retries,
4224 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
4225 			  uint8_t tag_action, int unit_offline,
4226 			  int device_offline, int self_test, int page_format,
4227 			  int self_test_code, uint8_t *data_ptr,
4228 			  uint16_t param_list_length, uint8_t sense_len,
4229 			  uint32_t timeout);
4230 
4231 void scsi_get_physical_element_status(struct ccb_scsiio *csio, uint32_t retries,
4232 				      void (*cbfcnp)(struct cam_periph *, union ccb *),
4233 				      uint8_t tag_action, uint8_t *data_ptr,
4234 				      uint16_t allocation_length, uint8_t report_type,
4235 				      uint32_t starting_element,
4236 				      uint8_t sense_len, uint32_t timeout);
4237 
4238 void scsi_remove_element_and_truncate(struct ccb_scsiio *csio, uint32_t retries,
4239 				      void (*cbfcnp)(struct cam_periph *, union ccb *),
4240 				      uint8_t tag_action,
4241 				      uint64_t requested_capacity, uint32_t element_id,
4242 				      uint8_t sense_len, uint32_t timeout);
4243 
4244 void scsi_restore_elements_and_rebuild(struct ccb_scsiio *csio, uint32_t retries,
4245 				       void (*cbfcnp)(struct cam_periph *, union ccb *),
4246 				       uint8_t tag_action,
4247 				       uint8_t sense_len, uint32_t timeout);
4248 
4249 void scsi_read_buffer(struct ccb_scsiio *csio, uint32_t retries,
4250 			void (*cbfcnp)(struct cam_periph *, union ccb*),
4251 			uint8_t tag_action, int mode,
4252 			uint8_t buffer_id, uint32_t offset,
4253 			uint8_t *data_ptr, uint32_t allocation_length,
4254 			uint8_t sense_len, uint32_t timeout);
4255 
4256 void scsi_write_buffer(struct ccb_scsiio *csio, uint32_t retries,
4257 			void (*cbfcnp)(struct cam_periph *, union ccb *),
4258 			uint8_t tag_action, int mode,
4259 			uint8_t buffer_id, uint32_t offset,
4260 			uint8_t *data_ptr, uint32_t param_list_length,
4261 			uint8_t sense_len, uint32_t timeout);
4262 
4263 #define	SCSI_RW_READ	0x0001
4264 #define	SCSI_RW_WRITE	0x0002
4265 #define	SCSI_RW_DIRMASK	0x0003
4266 #define	SCSI_RW_BIO	0x1000
4267 void scsi_read_write(struct ccb_scsiio *csio, uint32_t retries,
4268 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4269 		     uint8_t tag_action, int readop, uint8_t byte2,
4270 		     int minimum_cmd_size, uint64_t lba,
4271 		     uint32_t block_count, uint8_t *data_ptr,
4272 		     uint32_t dxfer_len, uint8_t sense_len,
4273 		     uint32_t timeout);
4274 
4275 void scsi_write_same(struct ccb_scsiio *csio, uint32_t retries,
4276 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4277 		     uint8_t tag_action, uint8_t byte2,
4278 		     int minimum_cmd_size, uint64_t lba,
4279 		     uint32_t block_count, uint8_t *data_ptr,
4280 		     uint32_t dxfer_len, uint8_t sense_len,
4281 		     uint32_t timeout);
4282 
4283 void scsi_ata_identify(struct ccb_scsiio *csio, uint32_t retries,
4284 		       void (*cbfcnp)(struct cam_periph *, union ccb *),
4285 		       uint8_t tag_action, uint8_t *data_ptr,
4286 		       uint16_t dxfer_len, uint8_t sense_len,
4287 		       uint32_t timeout);
4288 
4289 void scsi_ata_trim(struct ccb_scsiio *csio, uint32_t retries,
4290 	           void (*cbfcnp)(struct cam_periph *, union ccb *),
4291 	           uint8_t tag_action, uint16_t block_count,
4292 	           uint8_t *data_ptr, uint16_t dxfer_len,
4293 	           uint8_t sense_len, uint32_t timeout);
4294 
4295 int scsi_ata_read_log(struct ccb_scsiio *csio, uint32_t retries,
4296 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
4297 		      uint8_t tag_action, uint32_t log_address,
4298 		      uint32_t page_number, uint16_t block_count,
4299 		      uint8_t protocol, uint8_t *data_ptr, uint32_t dxfer_len,
4300 		      uint8_t sense_len, uint32_t timeout);
4301 
4302 int scsi_ata_setfeatures(struct ccb_scsiio *csio, uint32_t retries,
4303 			 void (*cbfcnp)(struct cam_periph *, union ccb *),
4304 			 uint8_t tag_action, uint8_t feature,
4305 			 uint64_t lba, uint32_t count,
4306 			 uint8_t sense_len, uint32_t timeout);
4307 
4308 int scsi_ata_pass(struct ccb_scsiio *csio, uint32_t retries,
4309 		  void (*cbfcnp)(struct cam_periph *, union ccb *),
4310 		  uint32_t flags, uint8_t tag_action,
4311 		  uint8_t protocol, uint8_t ata_flags, uint16_t features,
4312 		  uint16_t sector_count, uint64_t lba, uint8_t command,
4313 		  uint8_t device, uint8_t icc, uint32_t auxiliary,
4314 		  uint8_t control, uint8_t *data_ptr, uint32_t dxfer_len,
4315 		  uint8_t *cdb_storage, size_t cdb_storage_len,
4316 		  int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4317 
4318 void scsi_ata_pass_16(struct ccb_scsiio *csio, uint32_t retries,
4319 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
4320 		      uint32_t flags, uint8_t tag_action,
4321 		      uint8_t protocol, uint8_t ata_flags, uint16_t features,
4322 		      uint16_t sector_count, uint64_t lba, uint8_t command,
4323 		      uint8_t control, uint8_t *data_ptr, uint16_t dxfer_len,
4324 		      uint8_t sense_len, uint32_t timeout);
4325 
4326 void scsi_unmap(struct ccb_scsiio *csio, uint32_t retries,
4327 		void (*cbfcnp)(struct cam_periph *, union ccb *),
4328 		uint8_t tag_action, uint8_t byte2,
4329 		uint8_t *data_ptr, uint16_t dxfer_len,
4330 		uint8_t sense_len, uint32_t timeout);
4331 
4332 void scsi_start_stop(struct ccb_scsiio *csio, uint32_t retries,
4333 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4334 		     uint8_t tag_action, int start, int load_eject,
4335 		     int immediate, uint8_t sense_len, uint32_t timeout);
4336 void scsi_read_attribute(struct ccb_scsiio *csio, uint32_t retries,
4337 			 void (*cbfcnp)(struct cam_periph *, union ccb *),
4338 			 uint8_t tag_action, uint8_t service_action,
4339 			 uint32_t element, uint8_t elem_type,
4340 			 int logical_volume, int partition,
4341 			 uint32_t first_attribute, int cache, uint8_t *data_ptr,
4342 			 uint32_t length, int sense_len, uint32_t timeout);
4343 void scsi_write_attribute(struct ccb_scsiio *csio, uint32_t retries,
4344 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
4345 			  uint8_t tag_action, uint32_t element,
4346 			  int logical_volume, int partition, int wtc, uint8_t *data_ptr,
4347 			  uint32_t length, int sense_len, uint32_t timeout);
4348 
4349 void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
4350 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
4351 			       uint8_t tag_action, uint32_t security_protocol,
4352 			       uint32_t security_protocol_specific, int byte4,
4353 			       uint8_t *data_ptr, uint32_t dxfer_len,
4354 			       int sense_len, int timeout);
4355 
4356 void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
4357 				void (*cbfcnp)(struct cam_periph *,union ccb *),
4358 				uint8_t tag_action, uint32_t security_protocol,
4359 				uint32_t security_protocol_specific, int byte4,
4360 				uint8_t *data_ptr, uint32_t dxfer_len,
4361 				int sense_len, int timeout);
4362 
4363 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
4364 				void (*cbfcnp)(struct cam_periph *,union ccb *),
4365 				uint8_t tag_action, int service_action,
4366 				uint8_t *data_ptr, uint32_t dxfer_len,
4367 				int sense_len, int timeout);
4368 
4369 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
4370 				 void (*cbfcnp)(struct cam_periph *,
4371 				       union ccb *),
4372 				 uint8_t tag_action, int service_action,
4373 				 int scope, int res_type, uint8_t *data_ptr,
4374 				 uint32_t dxfer_len, int sense_len,
4375 				 int timeout);
4376 
4377 void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
4378 				   void (*cbfcnp)(struct cam_periph *,
4379 						  union ccb *),
4380 				   uint8_t tag_action, int options,
4381 				   int req_opcode, int req_service_action,
4382 				   uint8_t *data_ptr, uint32_t dxfer_len,
4383 				   int sense_len, int timeout);
4384 
4385 int		scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
4386 int		scsi_static_inquiry_match(caddr_t inqbuffer,
4387 					  caddr_t table_entry);
4388 int		scsi_devid_match(uint8_t *rhs, size_t rhs_len,
4389 				 uint8_t *lhs, size_t lhs_len);
4390 
4391 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
4392 			int *sense_key, int *asc, int *ascq);
4393 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
4394 			   int *asc, int *ascq);
4395 void scsi_extract_sense_len(struct scsi_sense_data *sense,
4396 			    u_int sense_len, int *error_code, int *sense_key,
4397 			    int *asc, int *ascq, int show_errors);
4398 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
4399 		       int show_errors);
4400 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
4401 		 int show_errors);
4402 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
4403 		  int show_errors);
4404 
4405 static __inline void
4406 scsi_ulto2b(uint32_t val, uint8_t *bytes)
4407 {
4408 
4409 	bytes[0] = (val >> 8) & 0xff;
4410 	bytes[1] = val & 0xff;
4411 }
4412 
4413 static __inline void
4414 scsi_ulto3b(uint32_t val, uint8_t *bytes)
4415 {
4416 
4417 	bytes[0] = (val >> 16) & 0xff;
4418 	bytes[1] = (val >> 8) & 0xff;
4419 	bytes[2] = val & 0xff;
4420 }
4421 
4422 static __inline void
4423 scsi_ulto4b(uint32_t val, uint8_t *bytes)
4424 {
4425 
4426 	bytes[0] = (val >> 24) & 0xff;
4427 	bytes[1] = (val >> 16) & 0xff;
4428 	bytes[2] = (val >> 8) & 0xff;
4429 	bytes[3] = val & 0xff;
4430 }
4431 
4432 static __inline void
4433 scsi_u64to8b(uint64_t val, uint8_t *bytes)
4434 {
4435 
4436 	bytes[0] = (val >> 56) & 0xff;
4437 	bytes[1] = (val >> 48) & 0xff;
4438 	bytes[2] = (val >> 40) & 0xff;
4439 	bytes[3] = (val >> 32) & 0xff;
4440 	bytes[4] = (val >> 24) & 0xff;
4441 	bytes[5] = (val >> 16) & 0xff;
4442 	bytes[6] = (val >> 8) & 0xff;
4443 	bytes[7] = val & 0xff;
4444 }
4445 
4446 static __inline uint32_t
4447 scsi_2btoul(const uint8_t *bytes)
4448 {
4449 	uint32_t rv;
4450 
4451 	rv = (bytes[0] << 8) |
4452 	     bytes[1];
4453 	return (rv);
4454 }
4455 
4456 static __inline uint32_t
4457 scsi_3btoul(const uint8_t *bytes)
4458 {
4459 	uint32_t rv;
4460 
4461 	rv = (bytes[0] << 16) |
4462 	     (bytes[1] << 8) |
4463 	     bytes[2];
4464 	return (rv);
4465 }
4466 
4467 static __inline int32_t
4468 scsi_3btol(const uint8_t *bytes)
4469 {
4470 	uint32_t rc = scsi_3btoul(bytes);
4471 
4472 	if (rc & 0x00800000)
4473 		rc |= 0xff000000;
4474 
4475 	return (int32_t) rc;
4476 }
4477 
4478 static __inline uint32_t
4479 scsi_4btoul(const uint8_t *bytes)
4480 {
4481 	uint32_t rv;
4482 
4483 	rv = (bytes[0] << 24) |
4484 	     (bytes[1] << 16) |
4485 	     (bytes[2] << 8) |
4486 	     bytes[3];
4487 	return (rv);
4488 }
4489 
4490 static __inline uint64_t
4491 scsi_8btou64(const uint8_t *bytes)
4492 {
4493         uint64_t rv;
4494 
4495 	rv = (((uint64_t)bytes[0]) << 56) |
4496 	     (((uint64_t)bytes[1]) << 48) |
4497 	     (((uint64_t)bytes[2]) << 40) |
4498 	     (((uint64_t)bytes[3]) << 32) |
4499 	     (((uint64_t)bytes[4]) << 24) |
4500 	     (((uint64_t)bytes[5]) << 16) |
4501 	     (((uint64_t)bytes[6]) << 8) |
4502 	     bytes[7];
4503 	return (rv);
4504 }
4505 
4506 /*
4507  * Given the pointer to a returned mode sense buffer, return a pointer to
4508  * the start of the first mode page.
4509  */
4510 static __inline void *
4511 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
4512 {
4513 	void *page_start;
4514 
4515 	page_start = (void *)((uint8_t *)&mode_header[1] +
4516 			      mode_header->blk_desc_len);
4517 
4518 	return(page_start);
4519 }
4520 
4521 static __inline void *
4522 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
4523 {
4524 	void *page_start;
4525 
4526 	page_start = (void *)((uint8_t *)&mode_header[1] +
4527 			       scsi_2btoul(mode_header->blk_desc_len));
4528 
4529 	return(page_start);
4530 }
4531 
4532 __END_DECLS
4533 
4534 #endif /*_SCSI_SCSI_ALL_H*/
4535