xref: /freebsd/sys/cam/scsi/scsi_all.h (revision c697fb7f)
1 /*-
2  * Largely written by Julian Elischer (julian@tfs.com)
3  * for TRW Financial Systems.
4  *
5  * TRW Financial Systems, in accordance with their agreement with Carnegie
6  * Mellon University, makes this software available to CMU to distribute
7  * or use in any manner that they see fit as long as this message is kept with
8  * the software. For this reason TFS also grants any other persons or
9  * organisations permission to use or modify this software.
10  *
11  * TFS supplies this software to be publicly redistributed
12  * on the understanding that TFS is not responsible for the correct
13  * functioning of this software in any circumstances.
14  *
15  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
16  *
17  * $FreeBSD$
18  */
19 
20 /*
21  * SCSI general  interface description
22  */
23 
24 #ifndef	_SCSI_SCSI_ALL_H
25 #define	_SCSI_SCSI_ALL_H 1
26 
27 #include <sys/cdefs.h>
28 #ifdef _KERNEL
29 #include <machine/stdarg.h>
30 #else
31 #include <stdarg.h>
32 #endif
33 
34 #ifdef _KERNEL
35 /*
36  * This is the number of seconds we wait for devices to settle after a SCSI
37  * bus reset.
38  */
39 extern int scsi_delay;
40 #endif /* _KERNEL */
41 
42 /*
43  * SCSI command format
44  */
45 
46 /*
47  * Define dome bits that are in ALL (or a lot of) scsi commands
48  */
49 #define	SCSI_CTL_LINK		0x01
50 #define	SCSI_CTL_FLAG		0x02
51 #define	SCSI_CTL_VENDOR		0xC0
52 #define	SCSI_CMD_LUN		0xA0	/* these two should not be needed */
53 #define	SCSI_CMD_LUN_SHIFT	5	/* LUN in the cmd is no longer SCSI */
54 
55 #define	SCSI_MAX_CDBLEN		16	/*
56 					 * 16 byte commands are in the
57 					 * SCSI-3 spec
58 					 */
59 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
60 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
61 #endif
62 
63 /* 6byte CDBs special case 0 length to be 256 */
64 #define	SCSI_CDB6_LEN(len)	((len) == 0 ? 256 : len)
65 
66 /*
67  * This type defines actions to be taken when a particular sense code is
68  * received.  Right now, these flags are only defined to take up 16 bits,
69  * but can be expanded in the future if necessary.
70  */
71 typedef enum {
72 	SS_NOP      = 0x000000,	/* Do nothing */
73 	SS_RETRY    = 0x010000,	/* Retry the command */
74 	SS_FAIL     = 0x020000,	/* Bail out */
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 	u_int8_t opcode;
119 	u_int8_t bytes[11];
120 };
121 
122 struct scsi_request_sense
123 {
124 	u_int8_t opcode;
125 	u_int8_t byte2;
126 #define	SRS_DESC	0x01
127 	u_int8_t unused[2];
128 	u_int8_t length;
129 	u_int8_t control;
130 };
131 
132 struct scsi_test_unit_ready
133 {
134 	u_int8_t opcode;
135 	u_int8_t byte2;
136 	u_int8_t unused[3];
137 	u_int8_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 	u_int8_t opcode;
172 	u_int8_t byte2;
173 	u_int8_t unused[2];
174 	u_int8_t length;
175 	u_int8_t control;
176 };
177 
178 struct scsi_inquiry
179 {
180 	u_int8_t opcode;
181 	u_int8_t byte2;
182 #define	SI_EVPD 	0x01
183 #define	SI_CMDDT	0x02
184 	u_int8_t page_code;
185 	u_int8_t length[2];
186 	u_int8_t control;
187 };
188 
189 struct scsi_mode_sense_6
190 {
191 	u_int8_t opcode;
192 	u_int8_t byte2;
193 #define	SMS_DBD				0x08
194 	u_int8_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 	u_int8_t subpage;
212 #define	SMS_SUBPAGE_PAGE_0		0x00
213 #define	SMS_SUBPAGE_ALL			0xff
214 	u_int8_t length;
215 	u_int8_t control;
216 };
217 
218 struct scsi_mode_sense_10
219 {
220 	u_int8_t opcode;
221 	u_int8_t byte2;		/* same bits as small version */
222 #define	SMS10_LLBAA			0x10
223 	u_int8_t page; 		/* same bits as small version */
224 	u_int8_t subpage;
225 	u_int8_t unused[3];
226 	u_int8_t length[2];
227 	u_int8_t control;
228 };
229 
230 struct scsi_mode_select_6
231 {
232 	u_int8_t opcode;
233 	u_int8_t byte2;
234 #define	SMS_SP	0x01
235 #define	SMS_RTD	0x02
236 #define	SMS_PF	0x10
237 	u_int8_t unused[2];
238 	u_int8_t length;
239 	u_int8_t control;
240 };
241 
242 struct scsi_mode_select_10
243 {
244 	u_int8_t opcode;
245 	u_int8_t byte2;		/* same bits as small version */
246 	u_int8_t unused[5];
247 	u_int8_t length[2];
248 	u_int8_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 	u_int8_t datalen;
257 	u_int8_t medium_type;
258 	u_int8_t dev_specific;
259 	u_int8_t block_descr_len;
260 };
261 
262 struct scsi_mode_hdr_10
263 {
264 	u_int8_t datalen[2];
265 	u_int8_t medium_type;
266 	u_int8_t dev_specific;
267 	u_int8_t flags;
268 #define	SMH_LONGLBA	0x01
269 	u_int8_t reserved;
270 	u_int8_t block_descr_len[2];
271 };
272 
273 struct scsi_mode_block_descr
274 {
275 	u_int8_t density_code;
276 	u_int8_t num_blocks[3];
277 	u_int8_t reserved;
278 	u_int8_t block_len[3];
279 };
280 
281 struct scsi_mode_block_descr_dshort
282 {
283 	u_int8_t num_blocks[4];
284 	u_int8_t reserved;
285 	u_int8_t block_len[3];
286 };
287 
288 struct scsi_mode_block_descr_dlong
289 {
290 	u_int8_t num_blocks[8];
291 	u_int8_t reserved[4];
292 	u_int8_t block_len[4];
293 };
294 
295 struct scsi_per_res_in
296 {
297 	u_int8_t opcode;
298 	u_int8_t action;
299 #define	SPRI_RK	0x00
300 #define	SPRI_RR	0x01
301 #define	SPRI_RC	0x02
302 #define	SPRI_RS	0x03
303 	u_int8_t reserved[5];
304 	u_int8_t length[2];
305 #define	SPRI_MAX_LEN		0xffff
306 	u_int8_t control;
307 };
308 
309 struct scsi_per_res_in_header
310 {
311 	u_int8_t generation[4];
312 	u_int8_t length[4];
313 };
314 
315 struct scsi_per_res_key
316 {
317 	u_int8_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 	u_int8_t opcode;
400 	u_int8_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 	u_int8_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 	u_int8_t reserved[2];
428 	u_int8_t length[4];
429 	u_int8_t control;
430 };
431 
432 struct scsi_per_res_out_parms
433 {
434 	struct scsi_per_res_key res_key;
435 	u_int8_t serv_act_res_key[8];
436 	u_int8_t scope_spec_address[4];
437 	u_int8_t flags;
438 #define	SPR_SPEC_I_PT		0x08
439 #define	SPR_ALL_TG_PT		0x04
440 #define	SPR_APTPL		0x01
441 	u_int8_t reserved1;
442 	u_int8_t extent_length[2];
443 	u_int8_t transport_id_list[];
444 };
445 
446 struct scsi_per_res_out_trans_ids {
447 	u_int8_t additional_length[4];
448 	u_int8_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 	u_int8_t serv_act_res_key[8];
459 	u_int8_t reserved;
460 	u_int8_t flags;
461 #define	SPR_REG_MOVE_UNREG	0x02
462 #define	SPR_REG_MOVE_APTPL	0x01
463 	u_int8_t rel_trgt_port_id[2];
464 	u_int8_t transport_id_length[4];
465 	u_int8_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 	u_int8_t opcode;
573 	u_int8_t byte2;
574 #define	SLS_SP				0x01
575 #define	SLS_PPC				0x02
576 	u_int8_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 	u_int8_t subpage;
598 #define	SLS_SUPPORTED_SUBPAGES_SUBPAGE	0xff
599 	u_int8_t reserved;
600 	u_int8_t paramptr[2];
601 	u_int8_t length[2];
602 	u_int8_t control;
603 };
604 
605 struct scsi_log_select
606 {
607 	u_int8_t opcode;
608 	u_int8_t byte2;
609 /*	SLS_SP				0x01 */
610 #define	SLS_PCR				0x02
611 	u_int8_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 	u_int8_t reserved[4];
618 	u_int8_t length[2];
619 	u_int8_t control;
620 };
621 
622 struct scsi_log_header
623 {
624 	u_int8_t page;
625 #define	SL_PAGE_CODE			0x3F
626 #define	SL_SPF				0x40
627 #define	SL_DS				0x80
628 	u_int8_t subpage;
629 	u_int8_t datalen[2];
630 };
631 
632 struct scsi_log_param_header {
633 	u_int8_t param_code[2];
634 	u_int8_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 	u_int8_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 	u_int8_t page_code;
713 	u_int8_t page_length;
714 	u_int8_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 	u_int8_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 	u_int8_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 	u_int8_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 	u_int8_t aen_holdoff_period[2];
745 	u_int8_t busy_timeout_period[2];
746 	u_int8_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 	u_int8_t page_code;
766 #define	SCHP_PAGE_SAVABLE		0x80	/* Page is savable */
767 	u_int8_t page_length;
768 	u_int8_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 	u_int8_t rw_cache_policy;
773 	u_int8_t dis_prefetch[2];
774 	u_int8_t min_prefetch[2];
775 	u_int8_t max_prefetch[2];
776 	u_int8_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 	u_int8_t page_code;
816 #define	SIEP_PAGE_SAVABLE		0x80	/* Page is savable */
817 	u_int8_t page_length;
818 	u_int8_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 	u_int8_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 	u_int8_t interval_timer[4];
834 	u_int8_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 	u_int8_t page_code;
879 #define	SPSP_PAGE_SAVABLE		0x80	/* Page is savable */
880 	u_int8_t page_length;
881 	u_int8_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 	u_int8_t opcode;
899 	u_int8_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 	u_int8_t resv_id;
905 	u_int8_t length[2];
906 	u_int8_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 
923 struct scsi_release
924 {
925 	u_int8_t opcode;
926 	u_int8_t byte2;
927 	u_int8_t resv_id;
928 	u_int8_t unused[1];
929 	u_int8_t length;
930 	u_int8_t control;
931 };
932 
933 struct scsi_release_10 {
934 	uint8_t opcode;
935 	uint8_t byte2;
936 	uint8_t resv_id;
937 	uint8_t thirdparty_id;
938 	uint8_t reserved[3];
939 	uint8_t length[2];
940 	uint8_t control;
941 };
942 
943 struct scsi_prevent
944 {
945 	u_int8_t opcode;
946 	u_int8_t byte2;
947 	u_int8_t unused[2];
948 	u_int8_t how;
949 	u_int8_t control;
950 };
951 #define	PR_PREVENT 0x01
952 #define	PR_ALLOW   0x00
953 
954 struct scsi_sync_cache
955 {
956 	u_int8_t opcode;
957 	u_int8_t byte2;
958 #define	SSC_IMMED	0x02
959 #define	SSC_RELADR	0x01
960 	u_int8_t begin_lba[4];
961 	u_int8_t reserved;
962 	u_int8_t lb_count[2];
963 	u_int8_t control;
964 };
965 
966 struct scsi_sync_cache_16
967 {
968 	uint8_t opcode;
969 	uint8_t byte2;
970 	uint8_t begin_lba[8];
971 	uint8_t lb_count[4];
972 	uint8_t reserved;
973 	uint8_t control;
974 };
975 
976 struct scsi_format {
977 	uint8_t opcode;
978 	uint8_t byte2;
979 #define	SF_LONGLIST		0x20
980 #define	SF_FMTDATA		0x10
981 #define	SF_CMPLIST		0x08
982 #define	SF_FORMAT_MASK		0x07
983 #define	SF_FORMAT_BLOCK		0x00
984 #define	SF_FORMAT_LONG_BLOCK	0x03
985 #define	SF_FORMAT_BFI		0x04
986 #define	SF_FORMAT_PHYS		0x05
987 	uint8_t vendor;
988 	uint8_t interleave[2];
989 	uint8_t control;
990 };
991 
992 struct scsi_format_header_short {
993 	uint8_t reserved;
994 #define	SF_DATA_FOV	0x80
995 #define	SF_DATA_DPRY	0x40
996 #define	SF_DATA_DCRT	0x20
997 #define	SF_DATA_STPF	0x10
998 #define	SF_DATA_IP	0x08
999 #define	SF_DATA_DSP	0x04
1000 #define	SF_DATA_IMMED	0x02
1001 #define	SF_DATA_VS	0x01
1002 	uint8_t byte2;
1003 	uint8_t defect_list_len[2];
1004 };
1005 
1006 struct scsi_format_header_long {
1007 	uint8_t reserved;
1008 	uint8_t byte2;
1009 	uint8_t reserved2[2];
1010 	uint8_t defect_list_len[4];
1011 };
1012 
1013 struct scsi_changedef
1014 {
1015 	u_int8_t opcode;
1016 	u_int8_t byte2;
1017 	u_int8_t unused1;
1018 	u_int8_t how;
1019 	u_int8_t unused[4];
1020 	u_int8_t datalen;
1021 	u_int8_t control;
1022 };
1023 
1024 struct scsi_read_buffer
1025 {
1026 	u_int8_t opcode;
1027 	u_int8_t byte2;
1028 #define	RWB_MODE		0x1F
1029 #define	RWB_MODE_HDR_DATA	0x00
1030 #define	RWB_MODE_VENDOR		0x01
1031 #define	RWB_MODE_DATA		0x02
1032 #define	RWB_MODE_DESCR		0x03
1033 #define	RWB_MODE_DOWNLOAD	0x04
1034 #define	RWB_MODE_DOWNLOAD_SAVE	0x05
1035 #define	RWB_MODE_ECHO		0x0A
1036 #define	RWB_MODE_ECHO_DESCR	0x0B
1037 #define	RWB_MODE_ERROR_HISTORY	0x1C
1038         u_int8_t buffer_id;
1039         u_int8_t offset[3];
1040         u_int8_t length[3];
1041         u_int8_t control;
1042 };
1043 
1044 struct scsi_read_buffer_16
1045 {
1046 	uint8_t opcode;
1047 	uint8_t byte2;
1048 	uint8_t offset[8];
1049 	uint8_t length[4];
1050 	uint8_t buffer_id;
1051 	uint8_t control;
1052 };
1053 
1054 struct scsi_write_buffer
1055 {
1056 	u_int8_t opcode;
1057 	u_int8_t byte2;
1058 	u_int8_t buffer_id;
1059 	u_int8_t offset[3];
1060 	u_int8_t length[3];
1061 	u_int8_t control;
1062 };
1063 
1064 struct scsi_read_attribute
1065 {
1066 	u_int8_t opcode;
1067 	u_int8_t service_action;
1068 #define	SRA_SA_ATTR_VALUES		0x00
1069 #define	SRA_SA_ATTR_LIST		0x01
1070 #define	SRA_SA_LOG_VOL_LIST		0x02
1071 #define	SRA_SA_PART_LIST		0x03
1072 #define	SRA_SA_RESTRICTED		0x04
1073 #define	SRA_SA_SUPPORTED_ATTRS		0x05
1074 #define	SRA_SA_MASK			0x1f
1075 	u_int8_t element[2];
1076 	u_int8_t elem_type;
1077 	u_int8_t logical_volume;
1078 	u_int8_t reserved1;
1079 	u_int8_t partition;
1080 	u_int8_t first_attribute[2];
1081 	u_int8_t length[4];
1082 	u_int8_t cache;
1083 #define	SRA_CACHE			0x01
1084 	u_int8_t control;
1085 };
1086 
1087 struct scsi_write_attribute
1088 {
1089 	u_int8_t opcode;
1090 	u_int8_t byte2;
1091 #define	SWA_WTC				0x01
1092 	u_int8_t element[3];
1093 	u_int8_t logical_volume;
1094 	u_int8_t reserved1;
1095 	u_int8_t partition;
1096 	u_int8_t reserved2[2];
1097 	u_int8_t length[4];
1098 	u_int8_t reserved3;
1099 	u_int8_t control;
1100 };
1101 
1102 
1103 struct scsi_read_attribute_values
1104 {
1105 	u_int8_t length[4];
1106 	u_int8_t attribute_0[0];
1107 };
1108 
1109 struct scsi_mam_attribute_header
1110 {
1111 	u_int8_t id[2];
1112 	/*
1113 	 * Attributes obtained from SPC-4r36g (section 7.4.2.2) and
1114 	 * SSC-4r03 (section 4.2.21).
1115 	 */
1116 #define	SMA_ATTR_ID_DEVICE_MIN		0x0000
1117 
1118 #define	SMA_ATTR_REM_CAP_PARTITION	0x0000
1119 #define	SMA_ATTR_MAX_CAP_PARTITION	0x0001
1120 #define	SMA_ATTR_TAPEALERT_FLAGS	0x0002
1121 #define	SMA_ATTR_LOAD_COUNT		0x0003
1122 #define	SMA_ATTR_MAM_SPACE_REMAINING	0x0004
1123 
1124 #define	SMA_ATTR_DEV_ASSIGNING_ORG	0x0005
1125 #define	SMA_ATTR_FORMAT_DENSITY_CODE	0x0006
1126 #define	SMA_ATTR_INITIALIZATION_COUNT	0x0007
1127 #define	SMA_ATTR_VOLUME_ID		0x0008
1128 #define	SMA_ATTR_VOLUME_CHANGE_REF	0x0009
1129 
1130 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD	0x020a
1131 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_1	0x020b
1132 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_2	0x020c
1133 #define	SMA_ATTR_DEV_SERIAL_LAST_LOAD_3	0x020d
1134 
1135 #define	SMA_ATTR_TOTAL_MB_WRITTEN_LT	0x0220
1136 #define	SMA_ATTR_TOTAL_MB_READ_LT	0x0221
1137 #define	SMA_ATTR_TOTAL_MB_WRITTEN_CUR	0x0222
1138 #define	SMA_ATTR_TOTAL_MB_READ_CUR	0x0223
1139 #define	SMA_ATTR_FIRST_ENC_BLOCK	0x0224
1140 #define	SMA_ATTR_NEXT_UNENC_BLOCK	0x0225
1141 
1142 #define	SMA_ATTR_MEDIUM_USAGE_HIST	0x0340
1143 #define	SMA_ATTR_PART_USAGE_HIST	0x0341
1144 
1145 #define	SMA_ATTR_ID_DEVICE_MAX		0x03ff
1146 
1147 #define	SMA_ATTR_ID_MEDIUM_MIN		0x0400
1148 
1149 #define	SMA_ATTR_MED_MANUF		0x0400
1150 #define	SMA_ATTR_MED_SERIAL		0x0401
1151 
1152 #define	SMA_ATTR_MED_LENGTH		0x0402
1153 #define	SMA_ATTR_MED_WIDTH		0x0403
1154 #define	SMA_ATTR_MED_ASSIGNING_ORG	0x0404
1155 #define	SMA_ATTR_MED_DENSITY_CODE	0x0405
1156 
1157 #define	SMA_ATTR_MED_MANUF_DATE		0x0406
1158 #define	SMA_ATTR_MAM_CAPACITY		0x0407
1159 #define	SMA_ATTR_MED_TYPE		0x0408
1160 #define	SMA_ATTR_MED_TYPE_INFO		0x0409
1161 #define	SMA_ATTR_MED_SERIAL_NUM		0x040a
1162 
1163 #define	SMA_ATTR_ID_MEDIUM_MAX		0x07ff
1164 
1165 #define	SMA_ATTR_ID_HOST_MIN		0x0800
1166 
1167 #define	SMA_ATTR_APP_VENDOR		0x0800
1168 #define	SMA_ATTR_APP_NAME		0x0801
1169 #define	SMA_ATTR_APP_VERSION		0x0802
1170 #define	SMA_ATTR_USER_MED_TEXT_LABEL	0x0803
1171 #define	SMA_ATTR_LAST_WRITTEN_TIME	0x0804
1172 #define	SMA_ATTR_TEXT_LOCAL_ID		0x0805
1173 #define	SMA_ATTR_BARCODE		0x0806
1174 #define	SMA_ATTR_HOST_OWNER_NAME	0x0807
1175 #define	SMA_ATTR_MEDIA_POOL		0x0808
1176 #define	SMA_ATTR_PART_USER_LABEL	0x0809
1177 #define	SMA_ATTR_LOAD_UNLOAD_AT_PART	0x080a
1178 #define	SMA_ATTR_APP_FORMAT_VERSION	0x080b
1179 #define	SMA_ATTR_VOL_COHERENCY_INFO	0x080c
1180 
1181 #define	SMA_ATTR_ID_HOST_MAX		0x0bff
1182 
1183 #define	SMA_ATTR_VENDOR_DEVICE_MIN	0x0c00
1184 #define	SMA_ATTR_VENDOR_DEVICE_MAX	0x0fff
1185 #define	SMA_ATTR_VENDOR_MEDIUM_MIN	0x1000
1186 #define	SMA_ATTR_VENDOR_MEDIUM_MAX	0x13ff
1187 #define	SMA_ATTR_VENDOR_HOST_MIN	0x1400
1188 #define	SMA_ATTR_VENDOR_HOST_MAX	0x17ff
1189 	u_int8_t byte2;
1190 #define	SMA_FORMAT_BINARY	0x00
1191 #define	SMA_FORMAT_ASCII	0x01
1192 #define	SMA_FORMAT_TEXT		0x02
1193 #define	SMA_FORMAT_MASK		0x03
1194 #define	SMA_READ_ONLY		0x80
1195 	u_int8_t length[2];
1196 	u_int8_t attribute[0];
1197 };
1198 
1199 struct scsi_attrib_list_header {
1200 	u_int8_t length[4];
1201 	u_int8_t first_attr_0[0];
1202 };
1203 
1204 struct scsi_attrib_lv_list {
1205 	u_int8_t length[2];
1206 	u_int8_t first_lv_number;
1207 	u_int8_t num_logical_volumes;
1208 };
1209 
1210 struct scsi_attrib_vendser {
1211 	uint8_t vendor[8];
1212 	uint8_t serial_num[32];
1213 };
1214 
1215 /*
1216  * These values are used to decode the Volume Coherency Information
1217  * Attribute (0x080c) for LTFS-format coherency information.
1218  * Although the Application Client Specific lengths are different for
1219  * Version 0 and Version 1, the data is in fact the same.  The length
1220  * difference was due to a code bug.
1221  */
1222 #define	SCSI_LTFS_VER0_LEN	42
1223 #define	SCSI_LTFS_VER1_LEN	43
1224 #define	SCSI_LTFS_UUID_LEN	36
1225 #define	SCSI_LTFS_STR_NAME	"LTFS"
1226 #define	SCSI_LTFS_STR_LEN	4
1227 
1228 typedef enum {
1229 	SCSI_ATTR_FLAG_NONE		= 0x00,
1230 	SCSI_ATTR_FLAG_HEX		= 0x01,
1231 	SCSI_ATTR_FLAG_FP		= 0x02,
1232 	SCSI_ATTR_FLAG_DIV_10		= 0x04,
1233 	SCSI_ATTR_FLAG_FP_1DIGIT	= 0x08
1234 } scsi_attrib_flags;
1235 
1236 typedef enum {
1237 	SCSI_ATTR_OUTPUT_NONE		= 0x00,
1238 	SCSI_ATTR_OUTPUT_TEXT_MASK	= 0x03,
1239 	SCSI_ATTR_OUTPUT_TEXT_RAW	= 0x00,
1240 	SCSI_ATTR_OUTPUT_TEXT_ESC	= 0x01,
1241 	SCSI_ATTR_OUTPUT_TEXT_RSV1	= 0x02,
1242 	SCSI_ATTR_OUTPUT_TEXT_RSV2	= 0x03,
1243 	SCSI_ATTR_OUTPUT_NONASCII_MASK	= 0x0c,
1244 	SCSI_ATTR_OUTPUT_NONASCII_TRIM	= 0x00,
1245 	SCSI_ATTR_OUTPUT_NONASCII_ESC	= 0x04,
1246 	SCSI_ATTR_OUTPUT_NONASCII_RAW	= 0x08,
1247 	SCSI_ATTR_OUTPUT_NONASCII_RSV1	= 0x0c,
1248 	SCSI_ATTR_OUTPUT_FIELD_MASK	= 0xf0,
1249 	SCSI_ATTR_OUTPUT_FIELD_ALL	= 0xf0,
1250 	SCSI_ATTR_OUTPUT_FIELD_NONE	= 0x00,
1251 	SCSI_ATTR_OUTPUT_FIELD_DESC	= 0x10,
1252 	SCSI_ATTR_OUTPUT_FIELD_NUM	= 0x20,
1253 	SCSI_ATTR_OUTPUT_FIELD_SIZE	= 0x40,
1254 	SCSI_ATTR_OUTPUT_FIELD_RW	= 0x80
1255 } scsi_attrib_output_flags;
1256 
1257 struct sbuf;
1258 
1259 struct scsi_attrib_table_entry
1260 {
1261 	u_int32_t id;
1262 	u_int32_t flags;
1263 	const char *desc;
1264 	const char *suffix;
1265 	int (*to_str)(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
1266 		      uint32_t valid_len, uint32_t flags,
1267 		      uint32_t output_flags, char *error_str,
1268 		      int error_str_len);
1269 	int (*parse_str)(char *str, struct scsi_mam_attribute_header *hdr,
1270 			 uint32_t alloc_len, uint32_t flags, char *error_str,
1271 			 int error_str_len);
1272 };
1273 
1274 struct scsi_rw_6
1275 {
1276 	u_int8_t opcode;
1277 	u_int8_t addr[3];
1278 /* only 5 bits are valid in the MSB address byte */
1279 #define	SRW_TOPADDR	0x1F
1280 	u_int8_t length;
1281 	u_int8_t control;
1282 };
1283 
1284 struct scsi_rw_10
1285 {
1286 	u_int8_t opcode;
1287 #define	SRW10_RELADDR	0x01
1288 /* EBP defined for WRITE(10) only */
1289 #define	SRW10_EBP	0x04
1290 #define	SRW10_FUA	0x08
1291 #define	SRW10_DPO	0x10
1292 	u_int8_t byte2;
1293 	u_int8_t addr[4];
1294 	u_int8_t reserved;
1295 	u_int8_t length[2];
1296 	u_int8_t control;
1297 };
1298 
1299 struct scsi_rw_12
1300 {
1301 	u_int8_t opcode;
1302 #define	SRW12_RELADDR	0x01
1303 #define	SRW12_FUA	0x08
1304 #define	SRW12_DPO	0x10
1305 	u_int8_t byte2;
1306 	u_int8_t addr[4];
1307 	u_int8_t length[4];
1308 	u_int8_t reserved;
1309 	u_int8_t control;
1310 };
1311 
1312 struct scsi_rw_16
1313 {
1314 	u_int8_t opcode;
1315 #define	SRW16_RELADDR	0x01
1316 #define	SRW16_FUA	0x08
1317 #define	SRW16_DPO	0x10
1318 	u_int8_t byte2;
1319 	u_int8_t addr[8];
1320 	u_int8_t length[4];
1321 	u_int8_t reserved;
1322 	u_int8_t control;
1323 };
1324 
1325 struct scsi_write_atomic_16
1326 {
1327 	uint8_t	opcode;
1328 	uint8_t	byte2;
1329 	uint8_t	addr[8];
1330 	uint8_t	boundary[2];
1331 	uint8_t	length[2];
1332 	uint8_t	group;
1333 	uint8_t	control;
1334 };
1335 
1336 struct scsi_write_same_10
1337 {
1338 	uint8_t	opcode;
1339 	uint8_t	byte2;
1340 #define	SWS_LBDATA	0x02
1341 #define	SWS_PBDATA	0x04
1342 #define	SWS_UNMAP	0x08
1343 #define	SWS_ANCHOR	0x10
1344 	uint8_t	addr[4];
1345 	uint8_t	group;
1346 	uint8_t	length[2];
1347 	uint8_t	control;
1348 };
1349 
1350 struct scsi_write_same_16
1351 {
1352 	uint8_t	opcode;
1353 	uint8_t	byte2;
1354 #define	SWS_NDOB	0x01
1355 	uint8_t	addr[8];
1356 	uint8_t	length[4];
1357 	uint8_t	group;
1358 	uint8_t	control;
1359 };
1360 
1361 struct scsi_unmap
1362 {
1363 	uint8_t	opcode;
1364 	uint8_t	byte2;
1365 #define	SU_ANCHOR	0x01
1366 	uint8_t	reserved[4];
1367 	uint8_t	group;
1368 	uint8_t	length[2];
1369 	uint8_t	control;
1370 };
1371 
1372 struct scsi_unmap_header
1373 {
1374 	uint8_t	length[2];
1375 	uint8_t	desc_length[2];
1376 	uint8_t	reserved[4];
1377 };
1378 
1379 struct scsi_unmap_desc
1380 {
1381 	uint8_t	lba[8];
1382 	uint8_t	length[4];
1383 	uint8_t	reserved[4];
1384 };
1385 
1386 struct scsi_write_verify_10
1387 {
1388 	uint8_t	opcode;
1389 	uint8_t	byte2;
1390 #define	SWV_BYTCHK		0x02
1391 #define	SWV_DPO			0x10
1392 #define	SWV_WRPROECT_MASK	0xe0
1393 	uint8_t	addr[4];
1394 	uint8_t	group;
1395 	uint8_t length[2];
1396 	uint8_t	control;
1397 };
1398 
1399 struct scsi_write_verify_12
1400 {
1401 	uint8_t	opcode;
1402 	uint8_t	byte2;
1403 	uint8_t	addr[4];
1404 	uint8_t	length[4];
1405 	uint8_t	group;
1406 	uint8_t	control;
1407 };
1408 
1409 struct scsi_write_verify_16
1410 {
1411 	uint8_t	opcode;
1412 	uint8_t	byte2;
1413 	uint8_t	addr[8];
1414 	uint8_t	length[4];
1415 	uint8_t	group;
1416 	uint8_t	control;
1417 };
1418 
1419 
1420 struct scsi_start_stop_unit
1421 {
1422 	u_int8_t opcode;
1423 	u_int8_t byte2;
1424 #define	SSS_IMMED		0x01
1425 	u_int8_t reserved[2];
1426 	u_int8_t how;
1427 #define	SSS_START		0x01
1428 #define	SSS_LOEJ		0x02
1429 #define	SSS_PC_MASK		0xf0
1430 #define	SSS_PC_START_VALID	0x00
1431 #define	SSS_PC_ACTIVE		0x10
1432 #define	SSS_PC_IDLE		0x20
1433 #define	SSS_PC_STANDBY		0x30
1434 #define	SSS_PC_LU_CONTROL	0x70
1435 #define	SSS_PC_FORCE_IDLE_0	0xa0
1436 #define	SSS_PC_FORCE_STANDBY_0	0xb0
1437 	u_int8_t control;
1438 };
1439 
1440 struct ata_pass_12 {
1441 	u_int8_t opcode;
1442 	u_int8_t protocol;
1443 #define	AP_PROTO_HARD_RESET	(0x00 << 1)
1444 #define	AP_PROTO_SRST		(0x01 << 1)
1445 #define	AP_PROTO_NON_DATA	(0x03 << 1)
1446 #define	AP_PROTO_PIO_IN		(0x04 << 1)
1447 #define	AP_PROTO_PIO_OUT	(0x05 << 1)
1448 #define	AP_PROTO_DMA		(0x06 << 1)
1449 #define	AP_PROTO_DMA_QUEUED	(0x07 << 1)
1450 #define	AP_PROTO_DEVICE_DIAG	(0x08 << 1)
1451 #define	AP_PROTO_DEVICE_RESET	(0x09 << 1)
1452 #define	AP_PROTO_UDMA_IN	(0x0a << 1)
1453 #define	AP_PROTO_UDMA_OUT	(0x0b << 1)
1454 #define	AP_PROTO_FPDMA		(0x0c << 1)
1455 #define	AP_PROTO_RESP_INFO	(0x0f << 1)
1456 #define AP_PROTO_MASK		0x1e
1457 #define	AP_MULTI	0xe0
1458 	u_int8_t flags;
1459 #define	AP_T_LEN	0x03
1460 #define	AP_BB		0x04
1461 #define	AP_T_DIR	0x08
1462 #define	AP_CK_COND	0x20
1463 #define	AP_OFFLINE	0x60
1464 	u_int8_t features;
1465 	u_int8_t sector_count;
1466 	u_int8_t lba_low;
1467 	u_int8_t lba_mid;
1468 	u_int8_t lba_high;
1469 	u_int8_t device;
1470 	u_int8_t command;
1471 	u_int8_t reserved;
1472 	u_int8_t control;
1473 };
1474 
1475 struct scsi_maintenance_in
1476 {
1477         uint8_t  opcode;
1478         uint8_t  byte2;
1479 #define SERVICE_ACTION_MASK  0x1f
1480 #define SA_RPRT_TRGT_GRP     0x0a
1481         uint8_t  reserved[4];
1482 	uint8_t  length[4];
1483 	uint8_t  reserved1;
1484 	uint8_t  control;
1485 };
1486 
1487 struct scsi_report_supported_opcodes
1488 {
1489         uint8_t  opcode;
1490         uint8_t  service_action;
1491         uint8_t  options;
1492 #define RSO_RCTD		0x80
1493 #define RSO_OPTIONS_MASK	0x07
1494 #define RSO_OPTIONS_ALL		0x00
1495 #define RSO_OPTIONS_OC		0x01
1496 #define RSO_OPTIONS_OC_SA	0x02
1497 #define RSO_OPTIONS_OC_ASA	0x03
1498         uint8_t  requested_opcode;
1499         uint8_t  requested_service_action[2];
1500 	uint8_t  length[4];
1501 	uint8_t  reserved1;
1502 	uint8_t  control;
1503 };
1504 
1505 struct scsi_report_supported_opcodes_timeout
1506 {
1507 	uint8_t  length[2];
1508 	uint8_t  reserved;
1509 	uint8_t  cmd_specific;
1510 	uint8_t  nominal_time[4];
1511 	uint8_t  recommended_time[4];
1512 };
1513 
1514 struct scsi_report_supported_opcodes_descr
1515 {
1516 	uint8_t  opcode;
1517 	uint8_t  reserved;
1518 	uint8_t  service_action[2];
1519 	uint8_t  reserved2;
1520 	uint8_t  flags;
1521 #define RSO_SERVACTV		0x01
1522 #define RSO_CTDP		0x02
1523 #define RSO_CDLP_MASK		0x0c
1524 #define RSO_CDLP_NO		0x00
1525 #define RSO_CDLP_A		0x04
1526 #define RSO_CDLP_B		0x08
1527 	uint8_t  cdb_length[2];
1528 	struct scsi_report_supported_opcodes_timeout timeout[0];
1529 };
1530 
1531 struct scsi_report_supported_opcodes_all
1532 {
1533 	uint8_t  length[4];
1534 	struct scsi_report_supported_opcodes_descr descr[0];
1535 };
1536 
1537 struct scsi_report_supported_opcodes_one
1538 {
1539 	uint8_t  reserved;
1540 	uint8_t  support;
1541 #define RSO_ONE_CTDP		0x80
1542 #define RSO_ONE_CDLP_MASK	0x18
1543 #define RSO_ONE_CDLP_NO		0x00
1544 #define RSO_ONE_CDLP_A		0x08
1545 #define RSO_ONE_CDLP_B		0x10
1546 #define RSO_ONE_SUP_MASK	0x07
1547 #define RSO_ONE_SUP_UNAVAIL	0x00
1548 #define RSO_ONE_SUP_NOT_SUP	0x01
1549 #define RSO_ONE_SUP_AVAIL	0x03
1550 #define RSO_ONE_SUP_VENDOR	0x05
1551 	uint8_t  cdb_length[2];
1552 	uint8_t  cdb_usage[];
1553 };
1554 
1555 struct scsi_report_supported_tmf
1556 {
1557 	uint8_t  opcode;
1558 	uint8_t  service_action;
1559 	uint8_t  options;
1560 #define RST_REPD		0x80
1561 	uint8_t  reserved[3];
1562 	uint8_t  length[4];
1563 	uint8_t  reserved1;
1564 	uint8_t  control;
1565 };
1566 
1567 struct scsi_report_supported_tmf_data
1568 {
1569 	uint8_t  byte1;
1570 #define RST_WAKES		0x01
1571 #define RST_TRS			0x02
1572 #define RST_QTS			0x04
1573 #define RST_LURS		0x08
1574 #define RST_CTSS		0x10
1575 #define RST_CACAS		0x20
1576 #define RST_ATSS		0x40
1577 #define RST_ATS			0x80
1578 	uint8_t  byte2;
1579 #define RST_ITNRS		0x01
1580 #define RST_QTSS		0x02
1581 #define RST_QAES		0x04
1582 	uint8_t  reserved;
1583 	uint8_t  length;
1584 };
1585 
1586 struct scsi_report_supported_tmf_ext_data
1587 {
1588 	uint8_t  byte1;
1589 	uint8_t  byte2;
1590 	uint8_t  reserved;
1591 	uint8_t  length;
1592 	uint8_t  byte5;
1593 #define RST_TMFTMOV		0x01
1594 	uint8_t  reserved2;
1595 	uint8_t  byte7;
1596 #define RST_WAKETS		0x01
1597 #define RST_TRTS		0x02
1598 #define RST_QTTS		0x04
1599 #define RST_LURTS		0x08
1600 #define RST_CTSTS		0x10
1601 #define RST_CACATS		0x20
1602 #define RST_ATSTS		0x40
1603 #define RST_ATTS		0x80
1604 	uint8_t  byte8;
1605 #define RST_ITNRTS		0x01
1606 #define RST_QTSTS		0x02
1607 #define RST_QAETS		0x04
1608 	uint8_t  long_timeout[4];
1609 	uint8_t  short_timeout[4];
1610 };
1611 
1612 struct scsi_report_timestamp
1613 {
1614 	uint8_t  opcode;
1615 	uint8_t  service_action;
1616 	uint8_t  reserved[4];
1617 	uint8_t  length[4];
1618 	uint8_t  reserved1;
1619 	uint8_t  control;
1620 };
1621 
1622 struct scsi_report_timestamp_data
1623 {
1624 	uint8_t  length[2];
1625 	uint8_t  origin;
1626 #define RTS_ORIG_MASK		0x00
1627 #define RTS_ORIG_ZERO		0x00
1628 #define RTS_ORIG_SET		0x02
1629 #define RTS_ORIG_OUTSIDE	0x03
1630 	uint8_t  reserved;
1631 	uint8_t  timestamp[6];
1632 	uint8_t  reserve2[2];
1633 };
1634 
1635 struct scsi_receive_copy_status_lid1
1636 {
1637 	uint8_t  opcode;
1638 	uint8_t  service_action;
1639 #define RCS_RCS_LID1		0x00
1640 	uint8_t  list_identifier;
1641 	uint8_t  reserved[7];
1642 	uint8_t  length[4];
1643 	uint8_t  reserved1;
1644 	uint8_t  control;
1645 };
1646 
1647 struct scsi_receive_copy_status_lid1_data
1648 {
1649 	uint8_t  available_data[4];
1650 	uint8_t  copy_command_status;
1651 #define RCS_CCS_INPROG		0x00
1652 #define RCS_CCS_COMPLETED	0x01
1653 #define RCS_CCS_ERROR		0x02
1654 	uint8_t  segments_processed[2];
1655 	uint8_t  transfer_count_units;
1656 #define RCS_TC_BYTES		0x00
1657 #define RCS_TC_KBYTES		0x01
1658 #define RCS_TC_MBYTES		0x02
1659 #define RCS_TC_GBYTES		0x03
1660 #define RCS_TC_TBYTES		0x04
1661 #define RCS_TC_PBYTES		0x05
1662 #define RCS_TC_EBYTES		0x06
1663 #define RCS_TC_LBAS		0xf1
1664 	uint8_t  transfer_count[4];
1665 };
1666 
1667 struct scsi_receive_copy_failure_details
1668 {
1669 	uint8_t  opcode;
1670 	uint8_t  service_action;
1671 #define RCS_RCFD		0x04
1672 	uint8_t  list_identifier;
1673 	uint8_t  reserved[7];
1674 	uint8_t  length[4];
1675 	uint8_t  reserved1;
1676 	uint8_t  control;
1677 };
1678 
1679 struct scsi_receive_copy_failure_details_data
1680 {
1681 	uint8_t  available_data[4];
1682 	uint8_t  reserved[52];
1683 	uint8_t  copy_command_status;
1684 	uint8_t  reserved2;
1685 	uint8_t  sense_data_length[2];
1686 	uint8_t  sense_data[];
1687 };
1688 
1689 struct scsi_receive_copy_status_lid4
1690 {
1691 	uint8_t  opcode;
1692 	uint8_t  service_action;
1693 #define RCS_RCS_LID4		0x05
1694 	uint8_t  list_identifier[4];
1695 	uint8_t  reserved[4];
1696 	uint8_t  length[4];
1697 	uint8_t  reserved1;
1698 	uint8_t  control;
1699 };
1700 
1701 struct scsi_receive_copy_status_lid4_data
1702 {
1703 	uint8_t  available_data[4];
1704 	uint8_t  response_to_service_action;
1705 	uint8_t  copy_command_status;
1706 #define RCS_CCS_COMPLETED_PROD	0x03
1707 #define RCS_CCS_COMPLETED_RESID	0x04
1708 #define RCS_CCS_INPROG_FGBG	0x10
1709 #define RCS_CCS_INPROG_FG	0x11
1710 #define RCS_CCS_INPROG_BG	0x12
1711 #define RCS_CCS_ABORTED		0x60
1712 	uint8_t  operation_counter[2];
1713 	uint8_t  estimated_status_update_delay[4];
1714 	uint8_t  extended_copy_completion_status;
1715 	uint8_t  length_of_the_sense_data_field;
1716 	uint8_t  sense_data_length;
1717 	uint8_t  transfer_count_units;
1718 	uint8_t  transfer_count[8];
1719 	uint8_t  segments_processed[2];
1720 	uint8_t  reserved[6];
1721 	uint8_t  sense_data[];
1722 };
1723 
1724 struct scsi_receive_copy_operating_parameters
1725 {
1726 	uint8_t  opcode;
1727 	uint8_t  service_action;
1728 #define RCS_RCOP		0x03
1729 	uint8_t  reserved[8];
1730 	uint8_t  length[4];
1731 	uint8_t  reserved1;
1732 	uint8_t  control;
1733 };
1734 
1735 struct scsi_receive_copy_operating_parameters_data
1736 {
1737 	uint8_t  length[4];
1738 	uint8_t  snlid;
1739 #define RCOP_SNLID		0x01
1740 	uint8_t  reserved[3];
1741 	uint8_t  maximum_cscd_descriptor_count[2];
1742 	uint8_t  maximum_segment_descriptor_count[2];
1743 	uint8_t  maximum_descriptor_list_length[4];
1744 	uint8_t  maximum_segment_length[4];
1745 	uint8_t  maximum_inline_data_length[4];
1746 	uint8_t  held_data_limit[4];
1747 	uint8_t  maximum_stream_device_transfer_size[4];
1748 	uint8_t  reserved2[2];
1749 	uint8_t  total_concurrent_copies[2];
1750 	uint8_t  maximum_concurrent_copies;
1751 	uint8_t  data_segment_granularity;
1752 	uint8_t  inline_data_granularity;
1753 	uint8_t  held_data_granularity;
1754 	uint8_t  reserved3[3];
1755 	uint8_t  implemented_descriptor_list_length;
1756 	uint8_t  list_of_implemented_descriptor_type_codes[0];
1757 };
1758 
1759 struct scsi_extended_copy
1760 {
1761 	uint8_t  opcode;
1762 	uint8_t  service_action;
1763 #define EC_EC_LID1		0x00
1764 #define EC_EC_LID4		0x01
1765 	uint8_t  reserved[8];
1766 	uint8_t  length[4];
1767 	uint8_t  reserved1;
1768 	uint8_t  control;
1769 };
1770 
1771 struct scsi_ec_cscd_dtsp
1772 {
1773 	uint8_t  flags;
1774 #define EC_CSCD_FIXED		0x01
1775 #define EC_CSCD_PAD		0x04
1776 	uint8_t  block_length[3];
1777 };
1778 
1779 struct scsi_ec_cscd
1780 {
1781 	uint8_t  type_code;
1782 #define EC_CSCD_EXT		0xff
1783 	uint8_t  luidt_pdt;
1784 #define EC_NUL			0x20
1785 #define EC_LUIDT_MASK		0xc0
1786 #define EC_LUIDT_LUN		0x00
1787 #define EC_LUIDT_PROXY_TOKEN	0x40
1788 	uint8_t  relative_initiator_port[2];
1789 	uint8_t  cscd_params[24];
1790 	struct scsi_ec_cscd_dtsp dtsp;
1791 };
1792 
1793 struct scsi_ec_cscd_id
1794 {
1795 	uint8_t  type_code;
1796 #define EC_CSCD_ID		0xe4
1797 	uint8_t  luidt_pdt;
1798 	uint8_t  relative_initiator_port[2];
1799 	uint8_t  codeset;
1800 	uint8_t  id_type;
1801 	uint8_t  reserved;
1802 	uint8_t  length;
1803 	uint8_t  designator[20];
1804 	struct scsi_ec_cscd_dtsp dtsp;
1805 };
1806 
1807 struct scsi_ec_segment
1808 {
1809 	uint8_t  type_code;
1810 	uint8_t  flags;
1811 #define EC_SEG_DC		0x02
1812 #define EC_SEG_CAT		0x01
1813 	uint8_t  descr_length[2];
1814 	uint8_t  params[];
1815 };
1816 
1817 struct scsi_ec_segment_b2b
1818 {
1819 	uint8_t  type_code;
1820 #define EC_SEG_B2B		0x02
1821 	uint8_t  flags;
1822 	uint8_t  descr_length[2];
1823 	uint8_t  src_cscd[2];
1824 	uint8_t  dst_cscd[2];
1825 	uint8_t  reserved[2];
1826 	uint8_t  number_of_blocks[2];
1827 	uint8_t  src_lba[8];
1828 	uint8_t  dst_lba[8];
1829 };
1830 
1831 struct scsi_ec_segment_verify
1832 {
1833 	uint8_t  type_code;
1834 #define EC_SEG_VERIFY		0x07
1835 	uint8_t  reserved;
1836 	uint8_t  descr_length[2];
1837 	uint8_t  src_cscd[2];
1838 	uint8_t  reserved2[2];
1839 	uint8_t  tur;
1840 	uint8_t  reserved3[3];
1841 };
1842 
1843 struct scsi_ec_segment_register_key
1844 {
1845 	uint8_t  type_code;
1846 #define EC_SEG_REGISTER_KEY	0x14
1847 	uint8_t  reserved;
1848 	uint8_t  descr_length[2];
1849 	uint8_t  reserved2[2];
1850 	uint8_t  dst_cscd[2];
1851 	uint8_t  res_key[8];
1852 	uint8_t  sa_res_key[8];
1853 	uint8_t  reserved3[4];
1854 };
1855 
1856 struct scsi_extended_copy_lid1_data
1857 {
1858 	uint8_t  list_identifier;
1859 	uint8_t  flags;
1860 #define EC_PRIORITY		0x07
1861 #define EC_LIST_ID_USAGE_MASK	0x18
1862 #define EC_LIST_ID_USAGE_FULL	0x08
1863 #define EC_LIST_ID_USAGE_NOHOLD	0x10
1864 #define EC_LIST_ID_USAGE_NONE	0x18
1865 #define EC_STR			0x20
1866 	uint8_t  cscd_list_length[2];
1867 	uint8_t  reserved[4];
1868 	uint8_t  segment_list_length[4];
1869 	uint8_t  inline_data_length[4];
1870 	uint8_t  data[];
1871 };
1872 
1873 struct scsi_extended_copy_lid4_data
1874 {
1875 	uint8_t  list_format;
1876 #define EC_LIST_FORMAT		0x01
1877 	uint8_t  flags;
1878 	uint8_t  header_cscd_list_length[2];
1879 	uint8_t  reserved[11];
1880 	uint8_t  flags2;
1881 #define EC_IMMED		0x01
1882 #define EC_G_SENSE		0x02
1883 	uint8_t  header_cscd_type_code;
1884 	uint8_t  reserved2[3];
1885 	uint8_t  list_identifier[4];
1886 	uint8_t  reserved3[18];
1887 	uint8_t  cscd_list_length[2];
1888 	uint8_t  segment_list_length[2];
1889 	uint8_t  inline_data_length[2];
1890 	uint8_t  data[];
1891 };
1892 
1893 struct scsi_copy_operation_abort
1894 {
1895 	uint8_t  opcode;
1896 	uint8_t  service_action;
1897 #define EC_COA			0x1c
1898 	uint8_t  list_identifier[4];
1899 	uint8_t  reserved[9];
1900 	uint8_t  control;
1901 };
1902 
1903 struct scsi_populate_token
1904 {
1905 	uint8_t  opcode;
1906 	uint8_t  service_action;
1907 #define EC_PT			0x10
1908 	uint8_t  reserved[4];
1909 	uint8_t  list_identifier[4];
1910 	uint8_t  length[4];
1911 	uint8_t  group_number;
1912 	uint8_t  control;
1913 };
1914 
1915 struct scsi_range_desc
1916 {
1917 	uint8_t	lba[8];
1918 	uint8_t	length[4];
1919 	uint8_t	reserved[4];
1920 };
1921 
1922 struct scsi_populate_token_data
1923 {
1924 	uint8_t  length[2];
1925 	uint8_t  flags;
1926 #define EC_PT_IMMED			0x01
1927 #define EC_PT_RTV			0x02
1928 	uint8_t  reserved;
1929 	uint8_t  inactivity_timeout[4];
1930 	uint8_t  rod_type[4];
1931 	uint8_t  reserved2[2];
1932 	uint8_t  range_descriptor_length[2];
1933 	struct scsi_range_desc desc[];
1934 };
1935 
1936 struct scsi_write_using_token
1937 {
1938 	uint8_t  opcode;
1939 	uint8_t  service_action;
1940 #define EC_WUT			0x11
1941 	uint8_t  reserved[4];
1942 	uint8_t  list_identifier[4];
1943 	uint8_t  length[4];
1944 	uint8_t  group_number;
1945 	uint8_t  control;
1946 };
1947 
1948 struct scsi_write_using_token_data
1949 {
1950 	uint8_t  length[2];
1951 	uint8_t  flags;
1952 #define EC_WUT_IMMED			0x01
1953 #define EC_WUT_DEL_TKN			0x02
1954 	uint8_t  reserved[5];
1955 	uint8_t  offset_into_rod[8];
1956 	uint8_t  rod_token[512];
1957 	uint8_t  reserved2[6];
1958 	uint8_t  range_descriptor_length[2];
1959 	struct scsi_range_desc desc[];
1960 };
1961 
1962 struct scsi_receive_rod_token_information
1963 {
1964 	uint8_t  opcode;
1965 	uint8_t  service_action;
1966 #define RCS_RRTI		0x07
1967 	uint8_t  list_identifier[4];
1968 	uint8_t  reserved[4];
1969 	uint8_t  length[4];
1970 	uint8_t  reserved2;
1971 	uint8_t  control;
1972 };
1973 
1974 struct scsi_token
1975 {
1976 	uint8_t  type[4];
1977 #define ROD_TYPE_INTERNAL	0x00000000
1978 #define ROD_TYPE_AUR		0x00010000
1979 #define ROD_TYPE_PIT_DEF	0x00800000
1980 #define ROD_TYPE_PIT_VULN	0x00800001
1981 #define ROD_TYPE_PIT_PERS	0x00800002
1982 #define ROD_TYPE_PIT_ANY	0x0080FFFF
1983 #define ROD_TYPE_BLOCK_ZERO	0xFFFF0001
1984 	uint8_t  reserved[2];
1985 	uint8_t  length[2];
1986 	uint8_t  body[0];
1987 };
1988 
1989 struct scsi_report_all_rod_tokens
1990 {
1991 	uint8_t  opcode;
1992 	uint8_t  service_action;
1993 #define RCS_RART		0x08
1994 	uint8_t  reserved[8];
1995 	uint8_t  length[4];
1996 	uint8_t  reserved2;
1997 	uint8_t  control;
1998 };
1999 
2000 struct scsi_report_all_rod_tokens_data
2001 {
2002 	uint8_t  available_data[4];
2003 	uint8_t  reserved[4];
2004 	uint8_t  rod_management_token_list[];
2005 };
2006 
2007 struct ata_pass_16 {
2008 	u_int8_t opcode;
2009 	u_int8_t protocol;
2010 #define	AP_EXTEND	0x01
2011 	u_int8_t flags;
2012 #define	AP_FLAG_TLEN_NO_DATA	(0 << 0)
2013 #define	AP_FLAG_TLEN_FEAT	(1 << 0)
2014 #define	AP_FLAG_TLEN_SECT_CNT	(2 << 0)
2015 #define	AP_FLAG_TLEN_STPSIU	(3 << 0)
2016 #define	AP_FLAG_BYT_BLOK_BYTES	(0 << 2)
2017 #define	AP_FLAG_BYT_BLOK_BLOCKS	(1 << 2)
2018 #define	AP_FLAG_TDIR_TO_DEV	(0 << 3)
2019 #define	AP_FLAG_TDIR_FROM_DEV	(1 << 3)
2020 #define	AP_FLAG_CHK_COND	(1 << 5)
2021 	u_int8_t features_ext;
2022 	u_int8_t features;
2023 	u_int8_t sector_count_ext;
2024 	u_int8_t sector_count;
2025 	u_int8_t lba_low_ext;
2026 	u_int8_t lba_low;
2027 	u_int8_t lba_mid_ext;
2028 	u_int8_t lba_mid;
2029 	u_int8_t lba_high_ext;
2030 	u_int8_t lba_high;
2031 	u_int8_t device;
2032 	u_int8_t command;
2033 	u_int8_t control;
2034 };
2035 
2036 struct ata_pass_32 {
2037 	uint8_t opcode;
2038 	uint8_t control;
2039 	uint8_t reserved1[5];
2040 	uint8_t length;
2041 	uint8_t service_action[2];
2042 #define	ATA_PASS_32_SA		0x1ff0
2043 	uint8_t protocol;
2044 	uint8_t flags;
2045 	uint8_t reserved2[2];
2046 	uint8_t lba[6];
2047 	uint8_t features[2];
2048 	uint8_t count[2];
2049 	uint8_t device;
2050 	uint8_t command;
2051 	uint8_t reserved3;
2052 	uint8_t icc;
2053 	uint8_t auxiliary[4];
2054 };
2055 
2056 
2057 #define	SC_SCSI_1 0x01
2058 #define	SC_SCSI_2 0x03
2059 
2060 /*
2061  * Opcodes
2062  */
2063 
2064 #define	TEST_UNIT_READY		0x00
2065 #define	REQUEST_SENSE		0x03
2066 #define	READ_6			0x08
2067 #define	WRITE_6			0x0A
2068 #define	INQUIRY			0x12
2069 #define	MODE_SELECT_6		0x15
2070 #define	MODE_SENSE_6		0x1A
2071 #define	START_STOP_UNIT		0x1B
2072 #define	START_STOP		0x1B
2073 #define	RESERVE      		0x16
2074 #define	RELEASE      		0x17
2075 #define	RECEIVE_DIAGNOSTIC	0x1C
2076 #define	SEND_DIAGNOSTIC		0x1D
2077 #define	PREVENT_ALLOW		0x1E
2078 #define	READ_CAPACITY		0x25
2079 #define	READ_10			0x28
2080 #define	WRITE_10		0x2A
2081 #define	POSITION_TO_ELEMENT	0x2B
2082 #define	WRITE_VERIFY_10		0x2E
2083 #define	VERIFY_10		0x2F
2084 #define	SYNCHRONIZE_CACHE	0x35
2085 #define	READ_DEFECT_DATA_10	0x37
2086 #define	WRITE_BUFFER            0x3B
2087 #define	READ_BUFFER             0x3C
2088 #define	CHANGE_DEFINITION	0x40
2089 #define	WRITE_SAME_10		0x41
2090 #define	UNMAP			0x42
2091 #define	LOG_SELECT		0x4C
2092 #define	LOG_SENSE		0x4D
2093 #define	MODE_SELECT_10		0x55
2094 #define	RESERVE_10		0x56
2095 #define	RELEASE_10		0x57
2096 #define	MODE_SENSE_10		0x5A
2097 #define	PERSISTENT_RES_IN	0x5E
2098 #define	PERSISTENT_RES_OUT	0x5F
2099 #define	EXTENDED_CDB		0x7E
2100 #define	VARIABLE_LEN_CDB	0x7F
2101 #define	EXTENDED_COPY		0x83
2102 #define	RECEIVE_COPY_STATUS	0x84
2103 #define	ATA_PASS_16		0x85
2104 #define	READ_16			0x88
2105 #define	COMPARE_AND_WRITE	0x89
2106 #define	WRITE_16		0x8A
2107 #define	READ_ATTRIBUTE		0x8C
2108 #define	WRITE_ATTRIBUTE		0x8D
2109 #define	WRITE_VERIFY_16		0x8E
2110 #define	VERIFY_16		0x8F
2111 #define	SYNCHRONIZE_CACHE_16	0x91
2112 #define	WRITE_SAME_16		0x93
2113 #define	READ_BUFFER_16		0x9B
2114 #define	WRITE_ATOMIC_16		0x9C
2115 #define	SERVICE_ACTION_IN	0x9E
2116 #define	REPORT_LUNS		0xA0
2117 #define	ATA_PASS_12		0xA1
2118 #define	SECURITY_PROTOCOL_IN	0xA2
2119 #define	MAINTENANCE_IN		0xA3
2120 #define	MAINTENANCE_OUT		0xA4
2121 #define	MOVE_MEDIUM     	0xA5
2122 #define	READ_12			0xA8
2123 #define	WRITE_12		0xAA
2124 #define	WRITE_VERIFY_12		0xAE
2125 #define	VERIFY_12		0xAF
2126 #define	SECURITY_PROTOCOL_OUT	0xB5
2127 #define	READ_ELEMENT_STATUS	0xB8
2128 #define	READ_CD			0xBE
2129 
2130 /* Maintenance In Service Action Codes */
2131 #define	REPORT_IDENTIFYING_INFRMATION		0x05
2132 #define	REPORT_TARGET_PORT_GROUPS		0x0A
2133 #define	REPORT_ALIASES				0x0B
2134 #define	REPORT_SUPPORTED_OPERATION_CODES	0x0C
2135 #define	REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS	0x0D
2136 #define	REPORT_PRIORITY				0x0E
2137 #define	REPORT_TIMESTAMP			0x0F
2138 #define	MANAGEMENT_PROTOCOL_IN			0x10
2139 /* Maintenance Out Service Action Codes */
2140 #define	SET_IDENTIFY_INFORMATION		0x06
2141 #define	SET_TARGET_PORT_GROUPS			0x0A
2142 #define	CHANGE_ALIASES				0x0B
2143 #define	SET_PRIORITY				0x0E
2144 #define	SET_TIMESTAMP				0x0F
2145 #define	MANAGEMENT_PROTOCOL_OUT			0x10
2146 
2147 /*
2148  * Device Types
2149  */
2150 #define	T_DIRECT	0x00
2151 #define	T_SEQUENTIAL	0x01
2152 #define	T_PRINTER	0x02
2153 #define	T_PROCESSOR	0x03
2154 #define	T_WORM		0x04
2155 #define	T_CDROM		0x05
2156 #define	T_SCANNER	0x06
2157 #define	T_OPTICAL 	0x07
2158 #define	T_CHANGER	0x08
2159 #define	T_COMM		0x09
2160 #define	T_ASC0		0x0a
2161 #define	T_ASC1		0x0b
2162 #define	T_STORARRAY	0x0c
2163 #define	T_ENCLOSURE	0x0d
2164 #define	T_RBC		0x0e
2165 #define	T_OCRW		0x0f
2166 #define	T_OSD		0x11
2167 #define	T_ADC		0x12
2168 #define	T_ZBC_HM	0x14
2169 #define	T_NODEVICE	0x1f
2170 #define	T_ANY		0xff	/* Used in Quirk table matches */
2171 
2172 #define	T_REMOV		1
2173 #define	T_FIXED		0
2174 
2175 /*
2176  * This length is the initial inquiry length used by the probe code, as
2177  * well as the length necessary for scsi_print_inquiry() to function
2178  * correctly.  If either use requires a different length in the future,
2179  * the two values should be de-coupled.
2180  */
2181 #define	SHORT_INQUIRY_LENGTH	36
2182 
2183 struct scsi_inquiry_data
2184 {
2185 	u_int8_t device;
2186 #define	SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
2187 #define	SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
2188 #define	SID_QUAL_LU_CONNECTED	0x00	/*
2189 					 * The specified peripheral device
2190 					 * type is currently connected to
2191 					 * logical unit.  If the target cannot
2192 					 * determine whether or not a physical
2193 					 * device is currently connected, it
2194 					 * shall also use this peripheral
2195 					 * qualifier when returning the INQUIRY
2196 					 * data.  This peripheral qualifier
2197 					 * does not mean that the device is
2198 					 * ready for access by the initiator.
2199 					 */
2200 #define	SID_QUAL_LU_OFFLINE	0x01	/*
2201 					 * The target is capable of supporting
2202 					 * the specified peripheral device type
2203 					 * on this logical unit; however, the
2204 					 * physical device is not currently
2205 					 * connected to this logical unit.
2206 					 */
2207 #define	SID_QUAL_RSVD		0x02
2208 #define	SID_QUAL_BAD_LU		0x03	/*
2209 					 * The target is not capable of
2210 					 * supporting a physical device on
2211 					 * this logical unit. For this
2212 					 * peripheral qualifier the peripheral
2213 					 * device type shall be set to 1Fh to
2214 					 * provide compatibility with previous
2215 					 * versions of SCSI. All other
2216 					 * peripheral device type values are
2217 					 * reserved for this peripheral
2218 					 * qualifier.
2219 					 */
2220 #define	SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x04) != 0)
2221 	u_int8_t dev_qual2;
2222 #define	SID_QUAL2	0x7F
2223 #define	SID_LU_CONG	0x40
2224 #define	SID_RMB		0x80
2225 #define	SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
2226 	u_int8_t version;
2227 #define	SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
2228 #define		SCSI_REV_0		0
2229 #define		SCSI_REV_CCS		1
2230 #define		SCSI_REV_2		2
2231 #define		SCSI_REV_SPC		3
2232 #define		SCSI_REV_SPC2		4
2233 #define		SCSI_REV_SPC3		5
2234 #define		SCSI_REV_SPC4		6
2235 #define		SCSI_REV_SPC5		7
2236 
2237 #define	SID_ECMA	0x38
2238 #define	SID_ISO		0xC0
2239 	u_int8_t response_format;
2240 #define	SID_AENC	0x80
2241 #define	SID_TrmIOP	0x40
2242 #define	SID_NormACA	0x20
2243 #define	SID_HiSup	0x10
2244 	u_int8_t additional_length;
2245 #define	SID_ADDITIONAL_LENGTH(iqd)					\
2246 	((iqd)->additional_length +					\
2247 	__offsetof(struct scsi_inquiry_data, additional_length) + 1)
2248 	u_int8_t spc3_flags;
2249 #define	SPC3_SID_PROTECT	0x01
2250 #define	SPC3_SID_3PC		0x08
2251 #define	SPC3_SID_TPGS_MASK	0x30
2252 #define	SPC3_SID_TPGS_IMPLICIT	0x10
2253 #define	SPC3_SID_TPGS_EXPLICIT	0x20
2254 #define	SPC3_SID_ACC		0x40
2255 #define	SPC3_SID_SCCS		0x80
2256 	u_int8_t spc2_flags;
2257 #define	SPC2_SID_ADDR16		0x01
2258 #define	SPC2_SID_MChngr 	0x08
2259 #define	SPC2_SID_MultiP 	0x10
2260 #define	SPC2_SID_EncServ	0x40
2261 #define	SPC2_SID_BQueue		0x80
2262 
2263 #define	INQ_DATA_TQ_ENABLED(iqd)				\
2264     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) :	\
2265     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
2266     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
2267 
2268 	u_int8_t flags;
2269 #define	SID_SftRe	0x01
2270 #define	SID_CmdQue	0x02
2271 #define	SID_Linked	0x08
2272 #define	SID_Sync	0x10
2273 #define	SID_WBus16	0x20
2274 #define	SID_WBus32	0x40
2275 #define	SID_RelAdr	0x80
2276 #define	SID_VENDOR_SIZE   8
2277 	char	 vendor[SID_VENDOR_SIZE];
2278 #define	SID_PRODUCT_SIZE  16
2279 	char	 product[SID_PRODUCT_SIZE];
2280 #define	SID_REVISION_SIZE 4
2281 	char	 revision[SID_REVISION_SIZE];
2282 	/*
2283 	 * The following fields were taken from SCSI Primary Commands - 2
2284 	 * (SPC-2) Revision 14, Dated 11 November 1999
2285 	 */
2286 #define	SID_VENDOR_SPECIFIC_0_SIZE	20
2287 	u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
2288 	/*
2289 	 * An extension of SCSI Parallel Specific Values
2290 	 */
2291 #define	SID_SPI_IUS		0x01
2292 #define	SID_SPI_QAS		0x02
2293 #define	SID_SPI_CLOCK_ST	0x00
2294 #define	SID_SPI_CLOCK_DT	0x04
2295 #define	SID_SPI_CLOCK_DT_ST	0x0C
2296 #define	SID_SPI_MASK		0x0F
2297 	u_int8_t spi3data;
2298 	u_int8_t reserved2;
2299 	/*
2300 	 * Version Descriptors, stored 2 byte values.
2301 	 */
2302 	u_int8_t version1[2];
2303 	u_int8_t version2[2];
2304 	u_int8_t version3[2];
2305 	u_int8_t version4[2];
2306 	u_int8_t version5[2];
2307 	u_int8_t version6[2];
2308 	u_int8_t version7[2];
2309 	u_int8_t version8[2];
2310 
2311 	u_int8_t reserved3[22];
2312 
2313 #define	SID_VENDOR_SPECIFIC_1_SIZE	160
2314 	u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
2315 };
2316 
2317 /*
2318  * This structure is more suited to initiator operation, because the
2319  * maximum number of supported pages is already allocated.
2320  */
2321 struct scsi_vpd_supported_page_list
2322 {
2323 	u_int8_t device;
2324 	u_int8_t page_code;
2325 #define	SVPD_SUPPORTED_PAGE_LIST	0x00
2326 #define	SVPD_SUPPORTED_PAGES_HDR_LEN	4
2327 	u_int8_t reserved;
2328 	u_int8_t length;	/* number of VPD entries */
2329 #define	SVPD_SUPPORTED_PAGES_SIZE	251
2330 	u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
2331 };
2332 
2333 /*
2334  * This structure is more suited to target operation, because the
2335  * number of supported pages is left to the user to allocate.
2336  */
2337 struct scsi_vpd_supported_pages
2338 {
2339 	u_int8_t device;
2340 	u_int8_t page_code;
2341 	u_int8_t reserved;
2342 #define	SVPD_SUPPORTED_PAGES	0x00
2343 	u_int8_t length;
2344 	u_int8_t page_list[0];
2345 };
2346 
2347 
2348 struct scsi_vpd_unit_serial_number
2349 {
2350 	u_int8_t device;
2351 	u_int8_t page_code;
2352 #define	SVPD_UNIT_SERIAL_NUMBER	0x80
2353 	u_int8_t reserved;
2354 	u_int8_t length; /* serial number length */
2355 #define	SVPD_SERIAL_NUM_SIZE 251
2356 	u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
2357 };
2358 
2359 struct scsi_vpd_device_id
2360 {
2361 	u_int8_t device;
2362 	u_int8_t page_code;
2363 #define	SVPD_DEVICE_ID			0x83
2364 #define	SVPD_DEVICE_ID_MAX_SIZE		252
2365 #define	SVPD_DEVICE_ID_HDR_LEN \
2366     __offsetof(struct scsi_vpd_device_id, desc_list)
2367 	u_int8_t length[2];
2368 	u_int8_t desc_list[];
2369 };
2370 
2371 struct scsi_vpd_id_descriptor
2372 {
2373 	u_int8_t	proto_codeset;
2374 	/*
2375 	 * See the SCSI_PROTO definitions above for the protocols.
2376 	 */
2377 #define	SVPD_ID_PROTO_SHIFT	4
2378 #define	SVPD_ID_CODESET_BINARY	0x01
2379 #define	SVPD_ID_CODESET_ASCII	0x02
2380 #define	SVPD_ID_CODESET_UTF8	0x03
2381 #define	SVPD_ID_CODESET_MASK	0x0f
2382 	u_int8_t	id_type;
2383 #define	SVPD_ID_PIV		0x80
2384 #define	SVPD_ID_ASSOC_LUN	0x00
2385 #define	SVPD_ID_ASSOC_PORT	0x10
2386 #define	SVPD_ID_ASSOC_TARGET	0x20
2387 #define	SVPD_ID_ASSOC_MASK	0x30
2388 #define	SVPD_ID_TYPE_VENDOR	0x00
2389 #define	SVPD_ID_TYPE_T10	0x01
2390 #define	SVPD_ID_TYPE_EUI64	0x02
2391 #define	SVPD_ID_TYPE_NAA	0x03
2392 #define	SVPD_ID_TYPE_RELTARG	0x04
2393 #define	SVPD_ID_TYPE_TPORTGRP	0x05
2394 #define	SVPD_ID_TYPE_LUNGRP	0x06
2395 #define	SVPD_ID_TYPE_MD5_LUN_ID	0x07
2396 #define	SVPD_ID_TYPE_SCSI_NAME	0x08
2397 #define	SVPD_ID_TYPE_PROTO	0x09
2398 #define	SVPD_ID_TYPE_UUID	0x0a
2399 #define	SVPD_ID_TYPE_MASK	0x0f
2400 	u_int8_t	reserved;
2401 	u_int8_t	length;
2402 #define	SVPD_DEVICE_ID_DESC_HDR_LEN \
2403     __offsetof(struct scsi_vpd_id_descriptor, identifier)
2404 	u_int8_t	identifier[];
2405 };
2406 
2407 struct scsi_vpd_id_t10
2408 {
2409 	u_int8_t	vendor[8];
2410 	u_int8_t	vendor_spec_id[0];
2411 };
2412 
2413 struct scsi_vpd_id_eui64
2414 {
2415 	u_int8_t	ieee_company_id[3];
2416 	u_int8_t	extension_id[5];
2417 };
2418 
2419 struct scsi_vpd_id_naa_basic
2420 {
2421 	uint8_t naa;
2422 	/* big endian, packed:
2423 	uint8_t	naa : 4;
2424 	uint8_t naa_desig : 4;
2425 	*/
2426 #define	SVPD_ID_NAA_NAA_SHIFT		4
2427 #define	SVPD_ID_NAA_IEEE_EXT		0x02
2428 #define	SVPD_ID_NAA_LOCAL_REG		0x03
2429 #define	SVPD_ID_NAA_IEEE_REG		0x05
2430 #define	SVPD_ID_NAA_IEEE_REG_EXT	0x06
2431 	uint8_t	naa_data[];
2432 };
2433 
2434 struct scsi_vpd_id_naa_ieee_extended_id
2435 {
2436 	uint8_t naa;
2437 	uint8_t vendor_specific_id_a;
2438 	uint8_t ieee_company_id[3];
2439 	uint8_t vendor_specific_id_b[4];
2440 };
2441 
2442 struct scsi_vpd_id_naa_local_reg
2443 {
2444 	uint8_t naa;
2445 	uint8_t local_value[7];
2446 };
2447 
2448 struct scsi_vpd_id_naa_ieee_reg
2449 {
2450 	uint8_t naa;
2451 	uint8_t reg_value[7];
2452 	/* big endian, packed:
2453 	uint8_t naa_basic : 4;
2454 	uint8_t ieee_company_id_0 : 4;
2455 	uint8_t ieee_company_id_1[2];
2456 	uint8_t ieee_company_id_2 : 4;
2457 	uint8_t vendor_specific_id_0 : 4;
2458 	uint8_t vendor_specific_id_1[4];
2459 	*/
2460 };
2461 
2462 struct scsi_vpd_id_naa_ieee_reg_extended
2463 {
2464 	uint8_t naa;
2465 	uint8_t reg_value[15];
2466 	/* big endian, packed:
2467 	uint8_t naa_basic : 4;
2468 	uint8_t ieee_company_id_0 : 4;
2469 	uint8_t ieee_company_id_1[2];
2470 	uint8_t ieee_company_id_2 : 4;
2471 	uint8_t vendor_specific_id_0 : 4;
2472 	uint8_t vendor_specific_id_1[4];
2473 	uint8_t vendor_specific_id_ext[8];
2474 	*/
2475 };
2476 
2477 struct scsi_vpd_id_rel_trgt_port_id
2478 {
2479 	uint8_t obsolete[2];
2480 	uint8_t rel_trgt_port_id[2];
2481 };
2482 
2483 struct scsi_vpd_id_trgt_port_grp_id
2484 {
2485 	uint8_t reserved[2];
2486 	uint8_t trgt_port_grp[2];
2487 };
2488 
2489 struct scsi_vpd_id_lun_grp_id
2490 {
2491 	uint8_t reserved[2];
2492 	uint8_t log_unit_grp[2];
2493 };
2494 
2495 struct scsi_vpd_id_md5_lun_id
2496 {
2497 	uint8_t lun_id[16];
2498 };
2499 
2500 struct scsi_vpd_id_scsi_name
2501 {
2502 	uint8_t name_string[256];
2503 };
2504 
2505 struct scsi_service_action_in
2506 {
2507 	uint8_t opcode;
2508 	uint8_t service_action;
2509 	uint8_t action_dependent[13];
2510 	uint8_t control;
2511 };
2512 
2513 struct scsi_vpd_extended_inquiry_data
2514 {
2515 	uint8_t device;
2516 	uint8_t page_code;
2517 #define	SVPD_EXTENDED_INQUIRY_DATA	0x86
2518 	uint8_t page_length[2];
2519 	uint8_t flags1;
2520 
2521 	/* These values are for direct access devices */
2522 #define	SVPD_EID_AM_MASK	0xC0
2523 #define	SVPD_EID_AM_DEFER	0x80
2524 #define	SVPD_EID_AM_IMMED	0x40
2525 #define	SVPD_EID_AM_UNDEFINED	0x00
2526 #define	SVPD_EID_AM_RESERVED	0xc0
2527 #define	SVPD_EID_SPT		0x38
2528 #define	SVPD_EID_SPT_1		0x00
2529 #define	SVPD_EID_SPT_12		0x08
2530 #define	SVPD_EID_SPT_2		0x10
2531 #define	SVPD_EID_SPT_13		0x18
2532 #define	SVPD_EID_SPT_3		0x20
2533 #define	SVPD_EID_SPT_23		0x28
2534 #define	SVPD_EID_SPT_123	0x38
2535 
2536 	/* These values are for sequential access devices */
2537 #define	SVPD_EID_SA_SPT_LBP	0x08
2538 
2539 #define	SVPD_EID_GRD_CHK	0x04
2540 #define	SVPD_EID_APP_CHK	0x02
2541 #define	SVPD_EID_REF_CHK	0x01
2542 
2543 	uint8_t flags2;
2544 #define	SVPD_EID_UASK_SUP	0x20
2545 #define	SVPD_EID_GROUP_SUP	0x10
2546 #define	SVPD_EID_PRIOR_SUP	0x08
2547 #define	SVPD_EID_HEADSUP	0x04
2548 #define	SVPD_EID_ORDSUP		0x02
2549 #define	SVPD_EID_SIMPSUP	0x01
2550 	uint8_t flags3;
2551 #define	SVPD_EID_WU_SUP		0x08
2552 #define	SVPD_EID_CRD_SUP	0x04
2553 #define	SVPD_EID_NV_SUP		0x02
2554 #define	SVPD_EID_V_SUP		0x01
2555 	uint8_t flags4;
2556 #define	SVPD_EID_NO_PI_CHK	0x20
2557 #define	SVPD_EID_P_I_I_SUP	0x10
2558 #define	SVPD_EID_LUICLR		0x01
2559 	uint8_t flags5;
2560 #define	SVPD_EID_LUCT_MASK	0xe0
2561 #define	SVPD_EID_LUCT_NOT_REP	0x00
2562 #define	SVPD_EID_LUCT_CONGL	0x20
2563 #define	SVPD_EID_LUCT_GROUP	0x40
2564 #define	SVPD_EID_R_SUP		0x10
2565 #define	SVPD_EID_RTD_SUP	0x08
2566 #define	SVPD_EID_HSSRELEF	0x02
2567 #define	SVPD_EID_CBCS		0x01
2568 	uint8_t flags6;
2569 #define	SVPD_EID_MULTI_I_T_FW	0x0F
2570 #define	SVPD_EID_MC_VENDOR_SPEC	0x00
2571 #define	SVPD_EID_MC_MODE_1	0x01
2572 #define	SVPD_EID_MC_MODE_2	0x02
2573 #define	SVPD_EID_MC_MODE_3	0x03
2574 	uint8_t est[2];
2575 	uint8_t flags7;
2576 #define	SVPD_EID_POA_SUP	0x80
2577 #define	SVPD_EID_HRA_SUP	0x40
2578 #define	SVPD_EID_VSA_SUP	0x20
2579 	uint8_t max_sense_length;
2580 	uint8_t bind_flags;
2581 #define	SVPD_EID_IBS		0x80
2582 #define	SVPD_EID_IAS		0x40
2583 #define	SVPD_EID_SAC		0x04
2584 #define	SVPD_EID_NRD1		0x02
2585 #define	SVPD_EID_NRD0		0x01
2586 	uint8_t reserved2[49];
2587 };
2588 
2589 struct scsi_vpd_mode_page_policy_descr
2590 {
2591 	uint8_t page_code;
2592 	uint8_t subpage_code;
2593 	uint8_t policy;
2594 #define	SVPD_MPP_SHARED		0x00
2595 #define	SVPD_MPP_PORT		0x01
2596 #define	SVPD_MPP_I_T		0x03
2597 #define	SVPD_MPP_MLUS		0x80
2598 	uint8_t reserved;
2599 };
2600 
2601 struct scsi_vpd_mode_page_policy
2602 {
2603 	uint8_t device;
2604 	uint8_t page_code;
2605 #define	SVPD_MODE_PAGE_POLICY	0x87
2606 	uint8_t page_length[2];
2607 	struct scsi_vpd_mode_page_policy_descr descr[0];
2608 };
2609 
2610 struct scsi_diag_page {
2611 	uint8_t page_code;
2612 	uint8_t page_specific_flags;
2613 	uint8_t length[2];
2614 	uint8_t params[0];
2615 };
2616 
2617 struct scsi_vpd_port_designation
2618 {
2619 	uint8_t reserved[2];
2620 	uint8_t relative_port_id[2];
2621 	uint8_t reserved2[2];
2622 	uint8_t initiator_transportid_length[2];
2623 	uint8_t initiator_transportid[0];
2624 };
2625 
2626 struct scsi_vpd_port_designation_cont
2627 {
2628 	uint8_t reserved[2];
2629 	uint8_t target_port_descriptors_length[2];
2630 	struct scsi_vpd_id_descriptor target_port_descriptors[0];
2631 };
2632 
2633 struct scsi_vpd_scsi_ports
2634 {
2635 	u_int8_t device;
2636 	u_int8_t page_code;
2637 #define	SVPD_SCSI_PORTS		0x88
2638 	u_int8_t page_length[2];
2639 	struct scsi_vpd_port_designation design[];
2640 };
2641 
2642 /*
2643  * ATA Information VPD Page based on
2644  * T10/2126-D Revision 04
2645  */
2646 #define SVPD_ATA_INFORMATION		0x89
2647 
2648 
2649 struct scsi_vpd_tpc_descriptor
2650 {
2651 	uint8_t desc_type[2];
2652 	uint8_t desc_length[2];
2653 	uint8_t parameters[];
2654 };
2655 
2656 struct scsi_vpd_tpc_descriptor_bdrl
2657 {
2658 	uint8_t desc_type[2];
2659 #define	SVPD_TPC_BDRL			0x0000
2660 	uint8_t desc_length[2];
2661 	uint8_t vendor_specific[6];
2662 	uint8_t maximum_ranges[2];
2663 	uint8_t maximum_inactivity_timeout[4];
2664 	uint8_t default_inactivity_timeout[4];
2665 	uint8_t maximum_token_transfer_size[8];
2666 	uint8_t optimal_transfer_count[8];
2667 };
2668 
2669 struct scsi_vpd_tpc_descriptor_sc_descr
2670 {
2671 	uint8_t opcode;
2672 	uint8_t sa_length;
2673 	uint8_t supported_service_actions[0];
2674 };
2675 
2676 struct scsi_vpd_tpc_descriptor_sc
2677 {
2678 	uint8_t desc_type[2];
2679 #define	SVPD_TPC_SC			0x0001
2680 	uint8_t desc_length[2];
2681 	uint8_t list_length;
2682 	struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2683 };
2684 
2685 struct scsi_vpd_tpc_descriptor_pd
2686 {
2687 	uint8_t desc_type[2];
2688 #define	SVPD_TPC_PD			0x0004
2689 	uint8_t desc_length[2];
2690 	uint8_t reserved[4];
2691 	uint8_t maximum_cscd_descriptor_count[2];
2692 	uint8_t maximum_segment_descriptor_count[2];
2693 	uint8_t maximum_descriptor_list_length[4];
2694 	uint8_t maximum_inline_data_length[4];
2695 	uint8_t reserved2[12];
2696 };
2697 
2698 struct scsi_vpd_tpc_descriptor_sd
2699 {
2700 	uint8_t desc_type[2];
2701 #define	SVPD_TPC_SD			0x0008
2702 	uint8_t desc_length[2];
2703 	uint8_t list_length;
2704 	uint8_t supported_descriptor_codes[];
2705 };
2706 
2707 struct scsi_vpd_tpc_descriptor_sdid
2708 {
2709 	uint8_t desc_type[2];
2710 #define	SVPD_TPC_SDID			0x000C
2711 	uint8_t desc_length[2];
2712 	uint8_t list_length[2];
2713 	uint8_t supported_descriptor_ids[];
2714 };
2715 
2716 struct scsi_vpd_tpc_descriptor_rtf_block
2717 {
2718 	uint8_t type_format;
2719 #define	SVPD_TPC_RTF_BLOCK			0x00
2720 	uint8_t reserved;
2721 	uint8_t desc_length[2];
2722 	uint8_t reserved2[2];
2723 	uint8_t optimal_length_granularity[2];
2724 	uint8_t maximum_bytes[8];
2725 	uint8_t optimal_bytes[8];
2726 	uint8_t optimal_bytes_to_token_per_segment[8];
2727 	uint8_t optimal_bytes_from_token_per_segment[8];
2728 	uint8_t reserved3[8];
2729 };
2730 
2731 struct scsi_vpd_tpc_descriptor_rtf
2732 {
2733 	uint8_t desc_type[2];
2734 #define	SVPD_TPC_RTF			0x0106
2735 	uint8_t desc_length[2];
2736 	uint8_t remote_tokens;
2737 	uint8_t reserved[11];
2738 	uint8_t minimum_token_lifetime[4];
2739 	uint8_t maximum_token_lifetime[4];
2740 	uint8_t maximum_token_inactivity_timeout[4];
2741 	uint8_t reserved2[18];
2742 	uint8_t type_specific_features_length[2];
2743 	uint8_t type_specific_features[0];
2744 };
2745 
2746 struct scsi_vpd_tpc_descriptor_srtd
2747 {
2748 	uint8_t rod_type[4];
2749 	uint8_t flags;
2750 #define	SVPD_TPC_SRTD_TOUT		0x01
2751 #define	SVPD_TPC_SRTD_TIN		0x02
2752 #define	SVPD_TPC_SRTD_ECPY		0x80
2753 	uint8_t reserved;
2754 	uint8_t preference_indicator[2];
2755 	uint8_t reserved2[56];
2756 };
2757 
2758 struct scsi_vpd_tpc_descriptor_srt
2759 {
2760 	uint8_t desc_type[2];
2761 #define	SVPD_TPC_SRT			0x0108
2762 	uint8_t desc_length[2];
2763 	uint8_t reserved[2];
2764 	uint8_t rod_type_descriptors_length[2];
2765 	uint8_t rod_type_descriptors[0];
2766 };
2767 
2768 struct scsi_vpd_tpc_descriptor_gco
2769 {
2770 	uint8_t desc_type[2];
2771 #define	SVPD_TPC_GCO			0x8001
2772 	uint8_t desc_length[2];
2773 	uint8_t total_concurrent_copies[4];
2774 	uint8_t maximum_identified_concurrent_copies[4];
2775 	uint8_t maximum_segment_length[4];
2776 	uint8_t data_segment_granularity;
2777 	uint8_t inline_data_granularity;
2778 	uint8_t reserved[18];
2779 };
2780 
2781 struct scsi_vpd_tpc
2782 {
2783 	uint8_t device;
2784 	uint8_t page_code;
2785 #define	SVPD_SCSI_TPC			0x8F
2786 	uint8_t page_length[2];
2787 	struct scsi_vpd_tpc_descriptor descr[];
2788 };
2789 
2790 /*
2791  * SCSI Feature Sets VPD Page
2792  */
2793 struct scsi_vpd_sfs
2794 {
2795 	uint8_t device;
2796 	uint8_t page_code;
2797 #define	SVPD_SCSI_SFS			0x92
2798 	uint8_t page_length[2];
2799 	uint8_t reserved[4];
2800 	uint8_t codes[];
2801 };
2802 
2803 /*
2804  * Block Device Characteristics VPD Page based on
2805  * T10/1799-D Revision 31
2806  */
2807 struct scsi_vpd_block_characteristics
2808 {
2809 	u_int8_t device;
2810 	u_int8_t page_code;
2811 #define SVPD_BDC			0xB1
2812 	u_int8_t page_length[2];
2813 	u_int8_t medium_rotation_rate[2];
2814 #define SVPD_BDC_RATE_NOT_REPORTED	0x00
2815 #define SVPD_BDC_RATE_NON_ROTATING	0x01
2816 	u_int8_t reserved1;
2817 	u_int8_t nominal_form_factor;
2818 #define SVPD_BDC_FORM_NOT_REPORTED	0x00
2819 #define SVPD_BDC_FORM_5_25INCH		0x01
2820 #define SVPD_BDC_FORM_3_5INCH		0x02
2821 #define SVPD_BDC_FORM_2_5INCH		0x03
2822 #define SVPD_BDC_FORM_1_5INCH		0x04
2823 #define SVPD_BDC_FORM_LESSTHAN_1_5INCH	0x05
2824 	u_int8_t reserved2[56];
2825 };
2826 
2827 /*
2828  * Block Device Characteristics VPD Page
2829  */
2830 struct scsi_vpd_block_device_characteristics
2831 {
2832 	uint8_t device;
2833 	uint8_t page_code;
2834 #define	SVPD_BDC		0xB1
2835 	uint8_t page_length[2];
2836 	uint8_t medium_rotation_rate[2];
2837 #define	SVPD_NOT_REPORTED	0x0000
2838 #define	SVPD_NON_ROTATING	0x0001
2839 	uint8_t product_type;
2840 	uint8_t wab_wac_ff;
2841 	uint8_t flags;
2842 #define	SVPD_VBULS		0x01
2843 #define	SVPD_FUAB		0x02
2844 #define	SVPD_BOCS		0x04
2845 #define	SVPD_RBWZ		0x08
2846 #define	SVPD_ZBC_NR		0x00	/* Not Reported */
2847 #define	SVPD_HAW_ZBC		0x10	/* Host Aware */
2848 #define	SVPD_DM_ZBC		0x20	/* Drive Managed */
2849 #define	SVPD_ZBC_MASK		0x30	/* Zoned mask */
2850 	uint8_t reserved[3];
2851 	uint8_t depopulation_time[4];
2852 	uint8_t reserved2[48];
2853 };
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 	u_int8_t device;
2866 	u_int8_t page_code;
2867 #define	SVPD_LBP		0xB2
2868 	u_int8_t page_length[2];
2869 #define SVPD_LBP_PL_BASIC	0x04
2870 	u_int8_t threshold_exponent;
2871 	u_int8_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 	u_int8_t prov_type;
2879 #define SVPD_LBP_RESOURCE	0x01
2880 #define SVPD_LBP_THIN		0x02
2881 	u_int8_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 	u_int8_t device;
2894 	u_int8_t page_code;
2895 #define	SVPD_BLOCK_LIMITS	0xB0
2896 	u_int8_t page_length[2];
2897 #define SVPD_BL_PL_BASIC	0x10
2898 #define SVPD_BL_PL_TP		0x3C
2899 	u_int8_t flags;
2900 #define	SVPD_BL_WSNZ		0x01
2901 	u_int8_t max_cmp_write_len;
2902 	u_int8_t opt_txfer_len_grain[2];
2903 	u_int8_t max_txfer_len[4];
2904 	u_int8_t opt_txfer_len[4];
2905 	u_int8_t max_prefetch[4];
2906 	u_int8_t max_unmap_lba_cnt[4];
2907 	u_int8_t max_unmap_blk_cnt[4];
2908 	u_int8_t opt_unmap_grain[4];
2909 	u_int8_t unmap_grain_align[4];
2910 	u_int8_t max_write_same_length[8];
2911 	u_int8_t max_atomic_transfer_length[4];
2912 	u_int8_t atomic_alignment[4];
2913 	u_int8_t atomic_transfer_length_granularity[4];
2914 	u_int8_t max_atomic_transfer_length_with_atomic_boundary[4];
2915 	u_int8_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 	u_int8_t opcode;
2943 	u_int8_t byte2;
2944 #define	SRC_RELADR	0x01
2945 	u_int8_t addr[4];
2946 	u_int8_t unused[2];
2947 	u_int8_t pmi;
2948 #define	SRC_PMI		0x01
2949 	u_int8_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 	u_int8_t addr[4];
2968 	u_int8_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 	u_int8_t length[4];	/* length of LUN inventory, in bytes */
3064 	u_int8_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 struct scsi_target_group
3072 {
3073 	uint8_t opcode;
3074 	uint8_t service_action;
3075 #define	STG_PDF_MASK		0xe0
3076 #define	STG_PDF_LENGTH		0x00
3077 #define	STG_PDF_EXTENDED	0x20
3078 	uint8_t reserved1[4];
3079 	uint8_t length[4];
3080 	uint8_t reserved2;
3081 	uint8_t control;
3082 };
3083 
3084 struct scsi_timestamp
3085 {
3086 	uint8_t opcode;
3087 	uint8_t service_action;
3088 	uint8_t reserved1[4];
3089 	uint8_t length[4];
3090 	uint8_t reserved2;
3091 	uint8_t control;
3092 };
3093 
3094 struct scsi_set_timestamp_parameters
3095 {
3096 	uint8_t reserved1[4];
3097 	uint8_t timestamp[6];
3098 	uint8_t reserved2[2];
3099 };
3100 
3101 struct scsi_report_timestamp_parameter_data
3102 {
3103 	uint8_t length[2];
3104 	uint8_t reserved1[2];
3105 	uint8_t timestamp[6];
3106 	uint8_t reserved2[2];
3107 };
3108 
3109 struct scsi_target_port_descriptor {
3110 	uint8_t	reserved[2];
3111 	uint8_t	relative_target_port_identifier[2];
3112 	uint8_t desc_list[];
3113 };
3114 
3115 struct scsi_target_port_group_descriptor {
3116 	uint8_t	pref_state;
3117 #define	TPG_PRIMARY				0x80
3118 #define	TPG_ASYMMETRIC_ACCESS_STATE_MASK	0xf
3119 #define	TPG_ASYMMETRIC_ACCESS_OPTIMIZED		0x0
3120 #define	TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED	0x1
3121 #define	TPG_ASYMMETRIC_ACCESS_STANDBY		0x2
3122 #define	TPG_ASYMMETRIC_ACCESS_UNAVAILABLE	0x3
3123 #define	TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT	0x4
3124 #define	TPG_ASYMMETRIC_ACCESS_OFFLINE		0xE
3125 #define	TPG_ASYMMETRIC_ACCESS_TRANSITIONING	0xF
3126 	uint8_t support;
3127 #define	TPG_AO_SUP	0x01
3128 #define	TPG_AN_SUP	0x02
3129 #define	TPG_S_SUP	0x04
3130 #define	TPG_U_SUP	0x08
3131 #define	TPG_LBD_SUP	0x10
3132 #define	TPG_O_SUP	0x40
3133 #define	TPG_T_SUP	0x80
3134 	uint8_t target_port_group[2];
3135 	uint8_t reserved;
3136 	uint8_t status;
3137 #define TPG_UNAVLBL      0
3138 #define TPG_SET_BY_STPG  0x01
3139 #define TPG_IMPLICIT     0x02
3140 	uint8_t vendor_specific;
3141 	uint8_t	target_port_count;
3142 	struct scsi_target_port_descriptor descriptors[];
3143 };
3144 
3145 struct scsi_target_group_data {
3146 	uint8_t length[4];	/* length of returned data, in bytes */
3147 	struct scsi_target_port_group_descriptor groups[];
3148 };
3149 
3150 struct scsi_target_group_data_extended {
3151 	uint8_t length[4];	/* length of returned data, in bytes */
3152 	uint8_t format_type;	/* STG_PDF_LENGTH or STG_PDF_EXTENDED */
3153 	uint8_t	implicit_transition_time;
3154 	uint8_t reserved[2];
3155 	struct scsi_target_port_group_descriptor groups[];
3156 };
3157 
3158 struct scsi_security_protocol_in
3159 {
3160 	uint8_t opcode;
3161 	uint8_t security_protocol;
3162 #define	SPI_PROT_INFORMATION		0x00
3163 #define	SPI_PROT_CBCS			0x07
3164 #define	SPI_PROT_TAPE_DATA_ENC		0x20
3165 #define	SPI_PROT_DATA_ENC_CONFIG	0x21
3166 #define	SPI_PROT_SA_CREATE_CAP		0x40
3167 #define	SPI_PROT_IKEV2_SCSI		0x41
3168 #define	SPI_PROT_JEDEC_UFS		0xEC
3169 #define	SPI_PROT_SDCARD_TFSSS		0xED
3170 #define	SPI_PROT_AUTH_HOST_TRANSIENT	0xEE
3171 #define	SPI_PROT_ATA_DEVICE_PASSWORD	0xEF
3172 	uint8_t security_protocol_specific[2];
3173 	uint8_t byte4;
3174 #define	SPI_INC_512	0x80
3175 	uint8_t reserved1;
3176 	uint8_t length[4];
3177 	uint8_t reserved2;
3178 	uint8_t control;
3179 };
3180 
3181 struct scsi_security_protocol_out
3182 {
3183 	uint8_t opcode;
3184 	uint8_t security_protocol;
3185 	uint8_t security_protocol_specific[2];
3186 	uint8_t byte4;
3187 #define	SPO_INC_512	0x80
3188 	uint8_t reserved1;
3189 	uint8_t length[4];
3190 	uint8_t reserved2;
3191 	uint8_t control;
3192 };
3193 
3194 typedef enum {
3195 	SSD_TYPE_NONE,
3196 	SSD_TYPE_FIXED,
3197 	SSD_TYPE_DESC
3198 } scsi_sense_data_type;
3199 
3200 typedef enum {
3201 	SSD_ELEM_NONE,
3202 	SSD_ELEM_SKIP,
3203 	SSD_ELEM_DESC,
3204 	SSD_ELEM_SKS,
3205 	SSD_ELEM_COMMAND,
3206 	SSD_ELEM_INFO,
3207 	SSD_ELEM_FRU,
3208 	SSD_ELEM_STREAM,
3209 	SSD_ELEM_MAX
3210 } scsi_sense_elem_type;
3211 
3212 
3213 struct scsi_sense_data
3214 {
3215 	uint8_t error_code;
3216 	/*
3217 	 * SPC-4 says that the maximum length of sense data is 252 bytes.
3218 	 * So this structure is exactly 252 bytes log.
3219 	 */
3220 #define	SSD_FULL_SIZE 252
3221 	uint8_t sense_buf[SSD_FULL_SIZE - 1];
3222 	/*
3223 	 * XXX KDM is this still a reasonable minimum size?
3224 	 */
3225 #define	SSD_MIN_SIZE 18
3226 	/*
3227 	 * Maximum value for the extra_len field in the sense data.
3228 	 */
3229 #define	SSD_EXTRA_MAX 244
3230 };
3231 
3232 /*
3233  * Fixed format sense data.
3234  */
3235 struct scsi_sense_data_fixed
3236 {
3237 	u_int8_t error_code;
3238 #define	SSD_ERRCODE			0x7F
3239 #define		SSD_CURRENT_ERROR	0x70
3240 #define		SSD_DEFERRED_ERROR	0x71
3241 #define	SSD_ERRCODE_VALID	0x80
3242 	u_int8_t segment;
3243 	u_int8_t flags;
3244 #define	SSD_KEY				0x0F
3245 #define		SSD_KEY_NO_SENSE	0x00
3246 #define		SSD_KEY_RECOVERED_ERROR	0x01
3247 #define		SSD_KEY_NOT_READY	0x02
3248 #define		SSD_KEY_MEDIUM_ERROR	0x03
3249 #define		SSD_KEY_HARDWARE_ERROR	0x04
3250 #define		SSD_KEY_ILLEGAL_REQUEST	0x05
3251 #define		SSD_KEY_UNIT_ATTENTION	0x06
3252 #define		SSD_KEY_DATA_PROTECT	0x07
3253 #define		SSD_KEY_BLANK_CHECK	0x08
3254 #define		SSD_KEY_Vendor_Specific	0x09
3255 #define		SSD_KEY_COPY_ABORTED	0x0a
3256 #define		SSD_KEY_ABORTED_COMMAND	0x0b
3257 #define		SSD_KEY_EQUAL		0x0c
3258 #define		SSD_KEY_VOLUME_OVERFLOW	0x0d
3259 #define		SSD_KEY_MISCOMPARE	0x0e
3260 #define		SSD_KEY_COMPLETED	0x0f
3261 #define	SSD_SDAT_OVFL	0x10
3262 #define	SSD_ILI		0x20
3263 #define	SSD_EOM		0x40
3264 #define	SSD_FILEMARK	0x80
3265 	u_int8_t info[4];
3266 	u_int8_t extra_len;
3267 	u_int8_t cmd_spec_info[4];
3268 	u_int8_t add_sense_code;
3269 	u_int8_t add_sense_code_qual;
3270 	u_int8_t fru;
3271 	u_int8_t sense_key_spec[3];
3272 #define	SSD_SCS_VALID		0x80
3273 #define	SSD_FIELDPTR_CMD	0x40
3274 #define	SSD_BITPTR_VALID	0x08
3275 #define	SSD_BITPTR_VALUE	0x07
3276 	u_int8_t extra_bytes[14];
3277 #define	SSD_FIXED_IS_PRESENT(sense, length, field) 			\
3278 	((length >= (offsetof(struct scsi_sense_data_fixed, field) +	\
3279 	sizeof(sense->field))) ? 1 :0)
3280 #define	SSD_FIXED_IS_FILLED(sense, field) 				\
3281 	((((offsetof(struct scsi_sense_data_fixed, field) +		\
3282 	sizeof(sense->field)) -						\
3283 	(offsetof(struct scsi_sense_data_fixed, extra_len) +		\
3284 	sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
3285 };
3286 
3287 /*
3288  * Descriptor format sense data definitions.
3289  * Introduced in SPC-3.
3290  */
3291 struct scsi_sense_data_desc
3292 {
3293 	uint8_t	error_code;
3294 #define	SSD_DESC_CURRENT_ERROR	0x72
3295 #define	SSD_DESC_DEFERRED_ERROR	0x73
3296 	uint8_t sense_key;
3297 	uint8_t	add_sense_code;
3298 	uint8_t	add_sense_code_qual;
3299 	uint8_t	flags;
3300 #define	SSDD_SDAT_OVFL		0x80
3301 	uint8_t	reserved[2];
3302 	/*
3303 	 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
3304 	 * must be less than or equal to 244.
3305 	 */
3306 	uint8_t	extra_len;
3307 	uint8_t	sense_desc[0];
3308 #define	SSD_DESC_IS_PRESENT(sense, length, field) 			\
3309 	((length >= (offsetof(struct scsi_sense_data_desc, field) +	\
3310 	sizeof(sense->field))) ? 1 :0)
3311 };
3312 
3313 struct scsi_sense_desc_header
3314 {
3315 	uint8_t desc_type;
3316 	uint8_t length;
3317 };
3318 /*
3319  * The information provide in the Information descriptor is device type or
3320  * command specific information, and defined in a command standard.
3321  *
3322  * Note that any changes to the field names or positions in this structure,
3323  * even reserved fields, should be accompanied by an examination of the
3324  * code in ctl_set_sense() that uses them.
3325  *
3326  * Maximum descriptors allowed: 1 (as of SPC-4)
3327  */
3328 struct scsi_sense_info
3329 {
3330 	uint8_t	desc_type;
3331 #define	SSD_DESC_INFO	0x00
3332 	uint8_t	length;
3333 	uint8_t	byte2;
3334 #define	SSD_INFO_VALID	0x80
3335 	uint8_t	reserved;
3336 	uint8_t	info[8];
3337 };
3338 
3339 /*
3340  * Command-specific information depends on the command for which the
3341  * reported condition occurred.
3342  *
3343  * Note that any changes to the field names or positions in this structure,
3344  * even reserved fields, should be accompanied by an examination of the
3345  * code in ctl_set_sense() that uses them.
3346  *
3347  * Maximum descriptors allowed: 1 (as of SPC-4)
3348  */
3349 struct scsi_sense_command
3350 {
3351 	uint8_t	desc_type;
3352 #define	SSD_DESC_COMMAND	0x01
3353 	uint8_t	length;
3354 	uint8_t	reserved[2];
3355 	uint8_t	command_info[8];
3356 };
3357 
3358 /*
3359  * Sense key specific descriptor.  The sense key specific data format
3360  * depends on the sense key in question.
3361  *
3362  * Maximum descriptors allowed: 1 (as of SPC-4)
3363  */
3364 struct scsi_sense_sks
3365 {
3366 	uint8_t	desc_type;
3367 #define	SSD_DESC_SKS		0x02
3368 	uint8_t	length;
3369 	uint8_t reserved1[2];
3370 	uint8_t	sense_key_spec[3];
3371 #define	SSD_SKS_VALID		0x80
3372 	uint8_t reserved2;
3373 };
3374 
3375 /*
3376  * This is used for the Illegal Request sense key (0x05) only.
3377  */
3378 struct scsi_sense_sks_field
3379 {
3380 	uint8_t	byte0;
3381 #define	SSD_SKS_FIELD_VALID	0x80
3382 #define	SSD_SKS_FIELD_CMD	0x40
3383 #define	SSD_SKS_BPV		0x08
3384 #define	SSD_SKS_BIT_VALUE	0x07
3385 	uint8_t	field[2];
3386 };
3387 
3388 
3389 /*
3390  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
3391  * Recovered Error (0x01) sense keys.
3392  */
3393 struct scsi_sense_sks_retry
3394 {
3395 	uint8_t byte0;
3396 #define	SSD_SKS_RETRY_VALID	0x80
3397 	uint8_t actual_retry_count[2];
3398 };
3399 
3400 /*
3401  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
3402  */
3403 struct scsi_sense_sks_progress
3404 {
3405 	uint8_t byte0;
3406 #define	SSD_SKS_PROGRESS_VALID	0x80
3407 	uint8_t progress[2];
3408 #define	SSD_SKS_PROGRESS_DENOM	0x10000
3409 };
3410 
3411 /*
3412  * Used with the Copy Aborted (0x0a) sense key.
3413  */
3414 struct scsi_sense_sks_segment
3415 {
3416 	uint8_t byte0;
3417 #define	SSD_SKS_SEGMENT_VALID	0x80
3418 #define	SSD_SKS_SEGMENT_SD	0x20
3419 #define	SSD_SKS_SEGMENT_BPV	0x08
3420 #define	SSD_SKS_SEGMENT_BITPTR	0x07
3421 	uint8_t field[2];
3422 };
3423 
3424 /*
3425  * Used with the Unit Attention (0x06) sense key.
3426  *
3427  * This is currently used to indicate that the unit attention condition
3428  * queue has overflowed (when the overflow bit is set).
3429  */
3430 struct scsi_sense_sks_overflow
3431 {
3432 	uint8_t byte0;
3433 #define	SSD_SKS_OVERFLOW_VALID	0x80
3434 #define	SSD_SKS_OVERFLOW_SET	0x01
3435 	uint8_t	reserved[2];
3436 };
3437 
3438 /*
3439  * This specifies which component is associated with the sense data.  There
3440  * is no standard meaning for the fru value.
3441  *
3442  * Maximum descriptors allowed: 1 (as of SPC-4)
3443  */
3444 struct scsi_sense_fru
3445 {
3446 	uint8_t	desc_type;
3447 #define	SSD_DESC_FRU		0x03
3448 	uint8_t	length;
3449 	uint8_t reserved;
3450 	uint8_t fru;
3451 };
3452 
3453 /*
3454  * Used for Stream commands, defined in SSC-4.
3455  *
3456  * Maximum descriptors allowed: 1 (as of SPC-4)
3457  */
3458 
3459 struct scsi_sense_stream
3460 {
3461 	uint8_t	desc_type;
3462 #define	SSD_DESC_STREAM		0x04
3463 	uint8_t	length;
3464 	uint8_t	reserved;
3465 	uint8_t	byte3;
3466 #define	SSD_DESC_STREAM_FM	0x80
3467 #define	SSD_DESC_STREAM_EOM	0x40
3468 #define	SSD_DESC_STREAM_ILI	0x20
3469 };
3470 
3471 /*
3472  * Used for Block commands, defined in SBC-3.
3473  *
3474  * This is currently (as of SBC-3) only used for the Incorrect Length
3475  * Indication (ILI) bit, which says that the data length requested in the
3476  * READ LONG or WRITE LONG command did not match the length of the logical
3477  * block.
3478  *
3479  * Maximum descriptors allowed: 1 (as of SPC-4)
3480  */
3481 struct scsi_sense_block
3482 {
3483 	uint8_t	desc_type;
3484 #define	SSD_DESC_BLOCK		0x05
3485 	uint8_t	length;
3486 	uint8_t	reserved;
3487 	uint8_t	byte3;
3488 #define	SSD_DESC_BLOCK_ILI	0x20
3489 };
3490 
3491 /*
3492  * Used for Object-Based Storage Devices (OSD-3).
3493  *
3494  * Maximum descriptors allowed: 1 (as of SPC-4)
3495  */
3496 struct scsi_sense_osd_objid
3497 {
3498 	uint8_t	desc_type;
3499 #define	SSD_DESC_OSD_OBJID	0x06
3500 	uint8_t	length;
3501 	uint8_t	reserved[6];
3502 	/*
3503 	 * XXX KDM provide the bit definitions here?  There are a lot of
3504 	 * them, and we don't have an OSD driver yet.
3505 	 */
3506 	uint8_t	not_init_cmds[4];
3507 	uint8_t	completed_cmds[4];
3508 	uint8_t	partition_id[8];
3509 	uint8_t	object_id[8];
3510 };
3511 
3512 /*
3513  * Used for Object-Based Storage Devices (OSD-3).
3514  *
3515  * Maximum descriptors allowed: 1 (as of SPC-4)
3516  */
3517 struct scsi_sense_osd_integrity
3518 {
3519 	uint8_t	desc_type;
3520 #define	SSD_DESC_OSD_INTEGRITY	0x07
3521 	uint8_t	length;
3522 	uint8_t	integ_check_val[32];
3523 };
3524 
3525 /*
3526  * Used for Object-Based Storage Devices (OSD-3).
3527  *
3528  * Maximum descriptors allowed: 1 (as of SPC-4)
3529  */
3530 struct scsi_sense_osd_attr_id
3531 {
3532 	uint8_t	desc_type;
3533 #define	SSD_DESC_OSD_ATTR_ID	0x08
3534 	uint8_t	length;
3535 	uint8_t	reserved[2];
3536 	uint8_t	attr_desc[0];
3537 };
3538 
3539 /*
3540  * ATA Return descriptor, used for the SCSI ATA PASS-THROUGH(12), (16) and
3541  * (32) commands.  Described in SAT-4r05.
3542  */
3543 struct scsi_sense_ata_ret_desc
3544 {
3545 	uint8_t desc_type;
3546 #define	SSD_DESC_ATA		0x09
3547 	uint8_t length;
3548 	uint8_t flags;
3549 #define	SSD_DESC_ATA_FLAG_EXTEND	0x01
3550 	uint8_t error;
3551 	uint8_t count_15_8;
3552 	uint8_t count_7_0;
3553 	uint8_t lba_31_24;
3554 	uint8_t lba_7_0;
3555 	uint8_t lba_39_32;
3556 	uint8_t lba_15_8;
3557 	uint8_t lba_47_40;
3558 	uint8_t lba_23_16;
3559 	uint8_t device;
3560 	uint8_t status;
3561 };
3562 /*
3563  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
3564  *
3565  * Maximum descriptors allowed: 32 (as of SPC-4)
3566  */
3567 struct scsi_sense_progress
3568 {
3569 	uint8_t	desc_type;
3570 #define	SSD_DESC_PROGRESS	0x0a
3571 	uint8_t	length;
3572 	uint8_t	sense_key;
3573 	uint8_t	add_sense_code;
3574 	uint8_t	add_sense_code_qual;
3575 	uint8_t reserved;
3576 	uint8_t	progress[2];
3577 };
3578 
3579 /*
3580  * This is typically forwarded as the result of an EXTENDED COPY command.
3581  *
3582  * Maximum descriptors allowed: 2 (as of SPC-4)
3583  */
3584 struct scsi_sense_forwarded
3585 {
3586 	uint8_t	desc_type;
3587 #define	SSD_DESC_FORWARDED	0x0c
3588 	uint8_t	length;
3589 	uint8_t	byte2;
3590 #define	SSD_FORWARDED_FSDT	0x80
3591 #define	SSD_FORWARDED_SDS_MASK	0x0f
3592 #define	SSD_FORWARDED_SDS_UNK	0x00
3593 #define	SSD_FORWARDED_SDS_EXSRC	0x01
3594 #define	SSD_FORWARDED_SDS_EXDST	0x02
3595 	uint8_t	status;
3596 	uint8_t	sense_data[];
3597 };
3598 
3599 /*
3600  * Vendor-specific sense descriptor.  The desc_type field will be in the
3601  * range between MIN and MAX inclusive.
3602  */
3603 struct scsi_sense_vendor
3604 {
3605 	uint8_t	desc_type;
3606 #define	SSD_DESC_VENDOR_MIN	0x80
3607 #define	SSD_DESC_VENDOR_MAX	0xff
3608 	uint8_t length;
3609 	uint8_t	data[0];
3610 };
3611 
3612 struct scsi_mode_header_6
3613 {
3614 	u_int8_t data_length;	/* Sense data length */
3615 	u_int8_t medium_type;
3616 	u_int8_t dev_spec;
3617 	u_int8_t blk_desc_len;
3618 };
3619 
3620 struct scsi_mode_header_10
3621 {
3622 	u_int8_t data_length[2];/* Sense data length */
3623 	u_int8_t medium_type;
3624 	u_int8_t dev_spec;
3625 	u_int8_t flags;
3626 #define	SMH_LONGLBA	0x01
3627 	u_int8_t unused;
3628 	u_int8_t blk_desc_len[2];
3629 };
3630 
3631 struct scsi_mode_page_header
3632 {
3633 	u_int8_t page_code;
3634 #define	SMPH_PS		0x80
3635 #define	SMPH_SPF	0x40
3636 #define	SMPH_PC_MASK	0x3f
3637 	u_int8_t page_length;
3638 };
3639 
3640 struct scsi_mode_page_header_sp
3641 {
3642 	uint8_t page_code;
3643 	uint8_t subpage;
3644 	uint8_t page_length[2];
3645 };
3646 
3647 
3648 struct scsi_mode_blk_desc
3649 {
3650 	u_int8_t density;
3651 	u_int8_t nblocks[3];
3652 	u_int8_t reserved;
3653 	u_int8_t blklen[3];
3654 };
3655 
3656 #define	SCSI_DEFAULT_DENSITY	0x00	/* use 'default' density */
3657 #define	SCSI_SAME_DENSITY	0x7f	/* use 'same' density- >= SCSI-2 only */
3658 
3659 
3660 /*
3661  * Status Byte
3662  */
3663 #define	SCSI_STATUS_OK			0x00
3664 #define	SCSI_STATUS_CHECK_COND		0x02
3665 #define	SCSI_STATUS_COND_MET		0x04
3666 #define	SCSI_STATUS_BUSY		0x08
3667 #define	SCSI_STATUS_INTERMED		0x10
3668 #define	SCSI_STATUS_INTERMED_COND_MET	0x14
3669 #define	SCSI_STATUS_RESERV_CONFLICT	0x18
3670 #define	SCSI_STATUS_CMD_TERMINATED	0x22	/* Obsolete in SAM-2 */
3671 #define	SCSI_STATUS_QUEUE_FULL		0x28
3672 #define	SCSI_STATUS_ACA_ACTIVE		0x30
3673 #define	SCSI_STATUS_TASK_ABORTED	0x40
3674 
3675 struct scsi_inquiry_pattern {
3676 	u_int8_t   type;
3677 	u_int8_t   media_type;
3678 #define	SIP_MEDIA_REMOVABLE	0x01
3679 #define	SIP_MEDIA_FIXED		0x02
3680 	const char *vendor;
3681 	const char *product;
3682 	const char *revision;
3683 };
3684 
3685 struct scsi_static_inquiry_pattern {
3686 	u_int8_t   type;
3687 	u_int8_t   media_type;
3688 	char       vendor[SID_VENDOR_SIZE+1];
3689 	char       product[SID_PRODUCT_SIZE+1];
3690 	char       revision[SID_REVISION_SIZE+1];
3691 };
3692 
3693 struct scsi_sense_quirk_entry {
3694 	struct scsi_inquiry_pattern	inq_pat;
3695 	int				num_sense_keys;
3696 	int				num_ascs;
3697 	struct sense_key_table_entry	*sense_key_info;
3698 	struct asc_table_entry		*asc_info;
3699 };
3700 
3701 struct sense_key_table_entry {
3702 	u_int8_t    sense_key;
3703 	u_int32_t   action;
3704 	const char *desc;
3705 };
3706 
3707 struct asc_table_entry {
3708 	u_int8_t    asc;
3709 	u_int8_t    ascq;
3710 	u_int32_t   action;
3711 	const char *desc;
3712 };
3713 
3714 struct op_table_entry {
3715 	u_int8_t    opcode;
3716 	u_int32_t   opmask;
3717 	const char  *desc;
3718 };
3719 
3720 struct scsi_op_quirk_entry {
3721 	struct scsi_inquiry_pattern	inq_pat;
3722 	int				num_ops;
3723 	struct op_table_entry		*op_table;
3724 };
3725 
3726 typedef enum {
3727 	SSS_FLAG_NONE		= 0x00,
3728 	SSS_FLAG_PRINT_COMMAND	= 0x01
3729 } scsi_sense_string_flags;
3730 
3731 struct scsi_nv {
3732 	const char *name;
3733 	uint64_t value;
3734 };
3735 
3736 typedef enum {
3737 	SCSI_NV_FOUND,
3738 	SCSI_NV_AMBIGUOUS,
3739 	SCSI_NV_NOT_FOUND
3740 } scsi_nv_status;
3741 
3742 typedef enum {
3743 	SCSI_NV_FLAG_NONE	= 0x00,
3744 	SCSI_NV_FLAG_IG_CASE	= 0x01	/* Case insensitive comparison */
3745 } scsi_nv_flags;
3746 
3747 struct ccb_scsiio;
3748 struct cam_periph;
3749 union  ccb;
3750 #ifndef _KERNEL
3751 struct cam_device;
3752 #endif
3753 
3754 extern const char *scsi_sense_key_text[];
3755 
3756 __BEGIN_DECLS
3757 void scsi_sense_desc(int sense_key, int asc, int ascq,
3758 		     struct scsi_inquiry_data *inq_data,
3759 		     const char **sense_key_desc, const char **asc_desc);
3760 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3761 				    struct scsi_inquiry_data *inq_data,
3762 				    u_int32_t sense_flags);
3763 const char *	scsi_status_string(struct ccb_scsiio *csio);
3764 
3765 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3766 		       int (*iter_func)(struct scsi_sense_data_desc *sense,
3767 					u_int, struct scsi_sense_desc_header *,
3768 					void *), void *arg);
3769 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3770 			uint8_t desc_type);
3771 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3772 			 scsi_sense_data_type sense_format, int current_error,
3773 			 int sense_key, int asc, int ascq, ...) ;
3774 void scsi_set_sense_data_len(struct scsi_sense_data *sense_data,
3775     u_int *sense_len, scsi_sense_data_type sense_format, int current_error,
3776     int sense_key, int asc, int ascq, ...) ;
3777 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3778     u_int *sense_len, scsi_sense_data_type sense_format,
3779     int current_error, int sense_key, int asc, int ascq, va_list ap);
3780 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3781 			uint8_t info_type, uint64_t *info,
3782 			int64_t *signed_info);
3783 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3784 		 uint8_t *sks);
3785 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3786 			struct scsi_inquiry_data *inq_data,
3787 			uint8_t *block_bits);
3788 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3789 			 struct scsi_inquiry_data *inq_data,
3790 			 uint8_t *stream_bits);
3791 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3792 		    struct scsi_inquiry_data *inq_data, uint64_t info);
3793 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3794 		       struct scsi_inquiry_data *inq_data, uint64_t csi);
3795 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3796 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3797 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3798 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits);
3799 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits);
3800 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3801 			  u_int sense_len, uint8_t *cdb, int cdb_len,
3802 			  struct scsi_inquiry_data *inq_data,
3803 			  struct scsi_sense_desc_header *header);
3804 
3805 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3806 			     u_int sense_len, uint8_t *cdb, int cdb_len,
3807 			     struct scsi_inquiry_data *inq_data,
3808 			     struct scsi_sense_desc_header *header);
3809 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3810 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3811 			 struct scsi_inquiry_data *inq_data,
3812 			 struct scsi_sense_desc_header *header);
3813 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3814 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3815 			 struct scsi_inquiry_data *inq_data,
3816 			 struct scsi_sense_desc_header *header);
3817 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3818 			    u_int sense_len, uint8_t *cdb, int cdb_len,
3819 			    struct scsi_inquiry_data *inq_data,
3820 			    struct scsi_sense_desc_header *header);
3821 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3822 			   u_int sense_len, uint8_t *cdb, int cdb_len,
3823 			   struct scsi_inquiry_data *inq_data,
3824 			   struct scsi_sense_desc_header *header);
3825 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3826 			      u_int sense_len, uint8_t *cdb, int cdb_len,
3827 			      struct scsi_inquiry_data *inq_data,
3828 			      struct scsi_sense_desc_header *header);
3829 void scsi_sense_ata_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3830 			 u_int sense_len, uint8_t *cdb, int cdb_len,
3831 			 struct scsi_inquiry_data *inq_data,
3832 			 struct scsi_sense_desc_header *header);
3833 void scsi_sense_forwarded_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3834 			      u_int sense_len, uint8_t *cdb, int cdb_len,
3835 			      struct scsi_inquiry_data *inq_data,
3836 			      struct scsi_sense_desc_header *header);
3837 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3838 			     u_int sense_len, uint8_t *cdb, int cdb_len,
3839 			     struct scsi_inquiry_data *inq_data,
3840 			     struct scsi_sense_desc_header *header);
3841 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3842 			  u_int sense_len, uint8_t *cdb, int cdb_len,
3843 			  struct scsi_inquiry_data *inq_data,
3844 			  struct scsi_sense_desc_header *header);
3845 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3846 
3847 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3848 			  struct sbuf *sb, char *path_str,
3849 			  struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3850 			  int cdb_len);
3851 
3852 #ifdef _KERNEL
3853 int		scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3854 int		scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3855 				scsi_sense_string_flags flags);
3856 char *		scsi_sense_string(struct ccb_scsiio *csio,
3857 				  char *str, int str_len);
3858 void		scsi_sense_print(struct ccb_scsiio *csio);
3859 int 		scsi_vpd_supported_page(struct cam_periph *periph,
3860 					uint8_t page_id);
3861 #else /* _KERNEL */
3862 int		scsi_command_string(struct cam_device *device,
3863 				    struct ccb_scsiio *csio, struct sbuf *sb);
3864 int		scsi_sense_sbuf(struct cam_device *device,
3865 				struct ccb_scsiio *csio, struct sbuf *sb,
3866 				scsi_sense_string_flags flags);
3867 char *		scsi_sense_string(struct cam_device *device,
3868 				  struct ccb_scsiio *csio,
3869 				  char *str, int str_len);
3870 void		scsi_sense_print(struct cam_device *device,
3871 				 struct ccb_scsiio *csio, FILE *ofile);
3872 #endif /* _KERNEL */
3873 
3874 const char *	scsi_op_desc(u_int16_t opcode,
3875 			     struct scsi_inquiry_data *inq_data);
3876 char *		scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
3877 				size_t len);
3878 void		scsi_cdb_sbuf(u_int8_t *cdb_ptr, struct sbuf *sb);
3879 
3880 void		scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3881 void		scsi_print_inquiry_sbuf(struct sbuf *sb,
3882 				        struct scsi_inquiry_data *inq_data);
3883 void		scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3884 void		scsi_print_inquiry_short_sbuf(struct sbuf *sb,
3885 					      struct scsi_inquiry_data *inq_data);
3886 
3887 u_int		scsi_calc_syncsrate(u_int period_factor);
3888 u_int		scsi_calc_syncparam(u_int period);
3889 
3890 typedef int	(*scsi_devid_checkfn_t)(uint8_t *);
3891 int		scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3892 int		scsi_devid_is_sas_target(uint8_t *bufp);
3893 int		scsi_devid_is_lun_eui64(uint8_t *bufp);
3894 int		scsi_devid_is_lun_naa(uint8_t *bufp);
3895 int		scsi_devid_is_lun_name(uint8_t *bufp);
3896 int		scsi_devid_is_lun_t10(uint8_t *bufp);
3897 int		scsi_devid_is_lun_md5(uint8_t *bufp);
3898 int		scsi_devid_is_lun_uuid(uint8_t *bufp);
3899 int		scsi_devid_is_port_naa(uint8_t *bufp);
3900 struct scsi_vpd_id_descriptor *
3901 		scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3902 			       scsi_devid_checkfn_t ck_fn);
3903 struct scsi_vpd_id_descriptor *
3904 		scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3905 			       scsi_devid_checkfn_t ck_fn);
3906 
3907 int		scsi_transportid_sbuf(struct sbuf *sb,
3908 				      struct scsi_transportid_header *hdr,
3909 				      uint32_t valid_len);
3910 
3911 const char *	scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3912 			       uint64_t value);
3913 
3914 scsi_nv_status	scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3915 			    char *name, int *table_entry, scsi_nv_flags flags);
3916 
3917 int	scsi_parse_transportid_64bit(int proto_id, char *id_str,
3918 				     struct scsi_transportid_header **hdr,
3919 				     unsigned int *alloc_len,
3920 #ifdef _KERNEL
3921 				     struct malloc_type *type, int flags,
3922 #endif
3923 				     char *error_str, int error_str_len);
3924 
3925 int	scsi_parse_transportid_spi(char *id_str,
3926 				   struct scsi_transportid_header **hdr,
3927 				   unsigned int *alloc_len,
3928 #ifdef _KERNEL
3929 				   struct malloc_type *type, int flags,
3930 #endif
3931 				   char *error_str, int error_str_len);
3932 
3933 int	scsi_parse_transportid_rdma(char *id_str,
3934 				    struct scsi_transportid_header **hdr,
3935 				    unsigned int *alloc_len,
3936 #ifdef _KERNEL
3937 				    struct malloc_type *type, int flags,
3938 #endif
3939 				    char *error_str, int error_str_len);
3940 
3941 int	scsi_parse_transportid_iscsi(char *id_str,
3942 				     struct scsi_transportid_header **hdr,
3943 				     unsigned int *alloc_len,
3944 #ifdef _KERNEL
3945 				     struct malloc_type *type, int flags,
3946 #endif
3947 				     char *error_str,int error_str_len);
3948 
3949 int	scsi_parse_transportid_sop(char *id_str,
3950 				   struct scsi_transportid_header **hdr,
3951 				   unsigned int *alloc_len,
3952 #ifdef _KERNEL
3953 				   struct malloc_type *type, int flags,
3954 #endif
3955 				   char *error_str,int error_str_len);
3956 
3957 int	scsi_parse_transportid(char *transportid_str,
3958 			       struct scsi_transportid_header **hdr,
3959 			       unsigned int *alloc_len,
3960 #ifdef _KERNEL
3961 			       struct malloc_type *type, int flags,
3962 #endif
3963 			       char *error_str, int error_str_len);
3964 
3965 
3966 int scsi_attrib_volcoh_sbuf(struct sbuf *sb,
3967 			    struct scsi_mam_attribute_header *hdr,
3968 			    uint32_t valid_len, uint32_t flags,
3969 			    uint32_t output_flags, char *error_str,
3970 			    int error_str_len);
3971 
3972 int scsi_attrib_vendser_sbuf(struct sbuf *sb,
3973 			     struct scsi_mam_attribute_header *hdr,
3974 			     uint32_t valid_len, uint32_t flags,
3975 			     uint32_t output_flags, char *error_str,
3976 			     int error_str_len);
3977 
3978 int scsi_attrib_hexdump_sbuf(struct sbuf *sb,
3979 			     struct scsi_mam_attribute_header *hdr,
3980 			     uint32_t valid_len, uint32_t flags,
3981 			     uint32_t output_flags, char *error_str,
3982 			     int error_str_len);
3983 
3984 int scsi_attrib_int_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
3985 			 uint32_t valid_len, uint32_t flags,
3986 			 uint32_t output_flags, char *error_str,
3987 			 int error_str_len);
3988 
3989 int scsi_attrib_ascii_sbuf(struct sbuf *sb,
3990 			   struct scsi_mam_attribute_header *hdr,
3991 			   uint32_t valid_len, uint32_t flags,
3992 			   uint32_t output_flags, char *error_str,
3993 			   int error_str_len);
3994 
3995 int scsi_attrib_text_sbuf(struct sbuf *sb,
3996 			  struct scsi_mam_attribute_header *hdr,
3997 			  uint32_t valid_len, uint32_t flags,
3998 			  uint32_t output_flags, char *error_str,
3999 			  int error_str_len);
4000 
4001 struct scsi_attrib_table_entry *scsi_find_attrib_entry(
4002 			struct scsi_attrib_table_entry *table,
4003 			size_t num_table_entries, uint32_t id);
4004 
4005 struct scsi_attrib_table_entry *scsi_get_attrib_entry(uint32_t id);
4006 
4007 int scsi_attrib_value_sbuf(struct sbuf *sb, uint32_t valid_len,
4008 			   struct scsi_mam_attribute_header *hdr,
4009 			   uint32_t output_flags, char *error_str,
4010 			   size_t error_str_len);
4011 
4012 void scsi_attrib_prefix_sbuf(struct sbuf *sb, uint32_t output_flags,
4013 			     struct scsi_mam_attribute_header *hdr,
4014 			     uint32_t valid_len, const char *desc);
4015 
4016 int scsi_attrib_sbuf(struct sbuf *sb, struct scsi_mam_attribute_header *hdr,
4017 		     uint32_t valid_len,
4018 		     struct scsi_attrib_table_entry *user_table,
4019 		     size_t num_user_entries, int prefer_user_table,
4020 		     uint32_t output_flags, char *error_str, int error_str_len);
4021 
4022 void		scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
4023 				     void (*cbfcnp)(struct cam_periph *,
4024 						    union ccb *),
4025 				     u_int8_t tag_action,
4026 				     u_int8_t sense_len, u_int32_t timeout);
4027 
4028 void		scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
4029 				   void (*cbfcnp)(struct cam_periph *,
4030 						  union ccb *),
4031 				   void *data_ptr, u_int8_t dxfer_len,
4032 				   u_int8_t tag_action, u_int8_t sense_len,
4033 				   u_int32_t timeout);
4034 
4035 void		scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
4036 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
4037 			     u_int8_t tag_action, u_int8_t *inq_buf,
4038 			     u_int32_t inq_len, int evpd, u_int8_t page_code,
4039 			     u_int8_t sense_len, u_int32_t timeout);
4040 
4041 void		scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
4042 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4043 		    uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
4044 		    uint8_t *param_buf, uint32_t param_len,
4045 		    uint8_t sense_len, uint32_t timeout);
4046 
4047 void		scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
4048 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4049 		    uint8_t tag_action, int dbd, uint8_t pc, uint8_t page,
4050 		    uint8_t *param_buf, uint32_t param_len,
4051 		    int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4052 
4053 void		scsi_mode_sense_subpage(struct ccb_scsiio *csio,
4054 		    uint32_t retries,
4055 		    void (*cbfcnp)(struct cam_periph *, union ccb *),
4056 		    uint8_t tag_action, int dbd, uint8_t pc,
4057 		    uint8_t page, uint8_t subpage,
4058 		    uint8_t *param_buf, uint32_t param_len,
4059 		    int minimum_cmd_size, uint8_t sense_len, uint32_t timeout);
4060 
4061 void		scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
4062 				 void (*cbfcnp)(struct cam_periph *,
4063 						union ccb *),
4064 				 u_int8_t tag_action, int scsi_page_fmt,
4065 				 int save_pages, u_int8_t *param_buf,
4066 				 u_int32_t param_len, u_int8_t sense_len,
4067 				 u_int32_t timeout);
4068 
4069 void		scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
4070 				     void (*cbfcnp)(struct cam_periph *,
4071 						    union ccb *),
4072 				     u_int8_t tag_action, int scsi_page_fmt,
4073 				     int save_pages, u_int8_t *param_buf,
4074 				     u_int32_t param_len, int minimum_cmd_size,
4075 				     u_int8_t sense_len, u_int32_t timeout);
4076 
4077 void		scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
4078 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
4079 			       u_int8_t tag_action, u_int8_t page_code,
4080 			       u_int8_t page, int save_pages, int ppc,
4081 			       u_int32_t paramptr, u_int8_t *param_buf,
4082 			       u_int32_t param_len, u_int8_t sense_len,
4083 			       u_int32_t timeout);
4084 
4085 void		scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
4086 				void (*cbfcnp)(struct cam_periph *,
4087 				union ccb *), u_int8_t tag_action,
4088 				u_int8_t page_code, int save_pages,
4089 				int pc_reset, u_int8_t *param_buf,
4090 				u_int32_t param_len, u_int8_t sense_len,
4091 				u_int32_t timeout);
4092 
4093 void		scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
4094 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
4095 			     u_int8_t tag_action, u_int8_t action,
4096 			     u_int8_t sense_len, u_int32_t timeout);
4097 
4098 void		scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
4099 				   void (*cbfcnp)(struct cam_periph *,
4100 				   union ccb *), u_int8_t tag_action,
4101 				   struct scsi_read_capacity_data *,
4102 				   u_int8_t sense_len, u_int32_t timeout);
4103 void		scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
4104 				      void (*cbfcnp)(struct cam_periph *,
4105 				      union ccb *), uint8_t tag_action,
4106 				      uint64_t lba, int reladr, int pmi,
4107 				      uint8_t *rcap_buf, int rcap_buf_len,
4108 				      uint8_t sense_len, uint32_t timeout);
4109 
4110 void		scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
4111 				 void (*cbfcnp)(struct cam_periph *,
4112 				 union ccb *), u_int8_t tag_action,
4113 				 u_int8_t select_report,
4114 				 struct scsi_report_luns_data *rpl_buf,
4115 				 u_int32_t alloc_len, u_int8_t sense_len,
4116 				 u_int32_t timeout);
4117 
4118 void		scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
4119 				 void (*cbfcnp)(struct cam_periph *,
4120 				 union ccb *), u_int8_t tag_action,
4121 				 u_int8_t pdf,
4122 				 void *buf,
4123 				 u_int32_t alloc_len, u_int8_t sense_len,
4124 				 u_int32_t timeout);
4125 
4126 void		scsi_report_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
4127 				 void (*cbfcnp)(struct cam_periph *,
4128 				 union ccb *), u_int8_t tag_action,
4129 				 u_int8_t pdf,
4130 				 void *buf,
4131 				 u_int32_t alloc_len, u_int8_t sense_len,
4132 				 u_int32_t timeout);
4133 
4134 void		scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
4135 				 void (*cbfcnp)(struct cam_periph *,
4136 				 union ccb *), u_int8_t tag_action, void *buf,
4137 				 u_int32_t alloc_len, u_int8_t sense_len,
4138 				 u_int32_t timeout);
4139 
4140 void		scsi_create_timestamp(uint8_t *timestamp_6b_buf,
4141 				      uint64_t timestamp);
4142 
4143 void		scsi_set_timestamp(struct ccb_scsiio *csio, u_int32_t retries,
4144 				   void (*cbfcnp)(struct cam_periph *,
4145 				   union ccb *), u_int8_t tag_action,
4146 				   void *buf, u_int32_t alloc_len,
4147 				   u_int8_t sense_len, u_int32_t timeout);
4148 
4149 void		scsi_synchronize_cache(struct ccb_scsiio *csio,
4150 				       u_int32_t retries,
4151 				       void (*cbfcnp)(struct cam_periph *,
4152 				       union ccb *), u_int8_t tag_action,
4153 				       u_int32_t begin_lba, u_int16_t lb_count,
4154 				       u_int8_t sense_len, u_int32_t timeout);
4155 
4156 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
4157 				     void (*cbfcnp)(struct cam_periph *,
4158 						    union ccb*),
4159 				     uint8_t tag_action, int pcv,
4160 				     uint8_t page_code, uint8_t *data_ptr,
4161 				     uint16_t allocation_length,
4162 				     uint8_t sense_len, uint32_t timeout);
4163 
4164 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
4165 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
4166 			  uint8_t tag_action, int unit_offline,
4167 			  int device_offline, int self_test, int page_format,
4168 			  int self_test_code, uint8_t *data_ptr,
4169 			  uint16_t param_list_length, uint8_t sense_len,
4170 			  uint32_t timeout);
4171 
4172 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
4173 			void (*cbfcnp)(struct cam_periph *, union ccb*),
4174 			uint8_t tag_action, int mode,
4175 			uint8_t buffer_id, u_int32_t offset,
4176 			uint8_t *data_ptr, uint32_t allocation_length,
4177 			uint8_t sense_len, uint32_t timeout);
4178 
4179 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
4180 			void (*cbfcnp)(struct cam_periph *, union ccb *),
4181 			uint8_t tag_action, int mode,
4182 			uint8_t buffer_id, u_int32_t offset,
4183 			uint8_t *data_ptr, uint32_t param_list_length,
4184 			uint8_t sense_len, uint32_t timeout);
4185 
4186 #define	SCSI_RW_READ	0x0001
4187 #define	SCSI_RW_WRITE	0x0002
4188 #define	SCSI_RW_DIRMASK	0x0003
4189 #define	SCSI_RW_BIO	0x1000
4190 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
4191 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4192 		     u_int8_t tag_action, int readop, u_int8_t byte2,
4193 		     int minimum_cmd_size, u_int64_t lba,
4194 		     u_int32_t block_count, u_int8_t *data_ptr,
4195 		     u_int32_t dxfer_len, u_int8_t sense_len,
4196 		     u_int32_t timeout);
4197 
4198 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
4199 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4200 		     u_int8_t tag_action, u_int8_t byte2,
4201 		     int minimum_cmd_size, u_int64_t lba,
4202 		     u_int32_t block_count, u_int8_t *data_ptr,
4203 		     u_int32_t dxfer_len, u_int8_t sense_len,
4204 		     u_int32_t timeout);
4205 
4206 void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
4207 		       void (*cbfcnp)(struct cam_periph *, union ccb *),
4208 		       u_int8_t tag_action, u_int8_t *data_ptr,
4209 		       u_int16_t dxfer_len, u_int8_t sense_len,
4210 		       u_int32_t timeout);
4211 
4212 void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
4213 	           void (*cbfcnp)(struct cam_periph *, union ccb *),
4214 	           u_int8_t tag_action, u_int16_t block_count,
4215 	           u_int8_t *data_ptr, u_int16_t dxfer_len,
4216 	           u_int8_t sense_len, u_int32_t timeout);
4217 
4218 int scsi_ata_read_log(struct ccb_scsiio *csio, uint32_t retries,
4219 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
4220 		      uint8_t tag_action, uint32_t log_address,
4221 		      uint32_t page_number, uint16_t block_count,
4222 		      uint8_t protocol, uint8_t *data_ptr, uint32_t dxfer_len,
4223 		      uint8_t sense_len, uint32_t timeout);
4224 
4225 int scsi_ata_setfeatures(struct ccb_scsiio *csio, uint32_t retries,
4226 			 void (*cbfcnp)(struct cam_periph *, union ccb *),
4227 			 uint8_t tag_action, uint8_t feature,
4228 			 uint64_t lba, uint32_t count,
4229 			 uint8_t sense_len, uint32_t timeout);
4230 
4231 int scsi_ata_pass(struct ccb_scsiio *csio, uint32_t retries,
4232 		  void (*cbfcnp)(struct cam_periph *, union ccb *),
4233 		  uint32_t flags, uint8_t tag_action,
4234 		  uint8_t protocol, uint8_t ata_flags, uint16_t features,
4235 		  uint16_t sector_count, uint64_t lba, uint8_t command,
4236 		  uint8_t device, uint8_t icc, uint32_t auxiliary,
4237 		  uint8_t control, u_int8_t *data_ptr, uint32_t dxfer_len,
4238 		  uint8_t *cdb_storage, size_t cdb_storage_len,
4239 		  int minimum_cmd_size, u_int8_t sense_len, u_int32_t timeout);
4240 
4241 void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
4242 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
4243 		      u_int32_t flags, u_int8_t tag_action,
4244 		      u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
4245 		      u_int16_t sector_count, uint64_t lba, u_int8_t command,
4246 		      u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
4247 		      u_int8_t sense_len, u_int32_t timeout);
4248 
4249 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
4250 		void (*cbfcnp)(struct cam_periph *, union ccb *),
4251 		u_int8_t tag_action, u_int8_t byte2,
4252 		u_int8_t *data_ptr, u_int16_t dxfer_len,
4253 		u_int8_t sense_len, u_int32_t timeout);
4254 
4255 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
4256 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
4257 		     u_int8_t tag_action, int start, int load_eject,
4258 		     int immediate, u_int8_t sense_len, u_int32_t timeout);
4259 void scsi_read_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4260 			 void (*cbfcnp)(struct cam_periph *, union ccb *),
4261 			 u_int8_t tag_action, u_int8_t service_action,
4262 			 uint32_t element, u_int8_t elem_type,
4263 			 int logical_volume, int partition,
4264 			 u_int32_t first_attribute, int cache, u_int8_t *data_ptr,
4265 			 u_int32_t length, int sense_len, u_int32_t timeout);
4266 void scsi_write_attribute(struct ccb_scsiio *csio, u_int32_t retries,
4267 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
4268 			  u_int8_t tag_action, uint32_t element,
4269 			  int logical_volume, int partition, int wtc, u_int8_t *data_ptr,
4270 			  u_int32_t length, int sense_len, u_int32_t timeout);
4271 
4272 void scsi_security_protocol_in(struct ccb_scsiio *csio, uint32_t retries,
4273 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
4274 			       uint8_t tag_action, uint32_t security_protocol,
4275 			       uint32_t security_protocol_specific, int byte4,
4276 			       uint8_t *data_ptr, uint32_t dxfer_len,
4277 			       int sense_len, int timeout);
4278 
4279 void scsi_security_protocol_out(struct ccb_scsiio *csio, uint32_t retries,
4280 				void (*cbfcnp)(struct cam_periph *,union ccb *),
4281 				uint8_t tag_action, uint32_t security_protocol,
4282 				uint32_t security_protocol_specific, int byte4,
4283 				uint8_t *data_ptr, uint32_t dxfer_len,
4284 				int sense_len, int timeout);
4285 
4286 void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
4287 				void (*cbfcnp)(struct cam_periph *,union ccb *),
4288 				uint8_t tag_action, int service_action,
4289 				uint8_t *data_ptr, uint32_t dxfer_len,
4290 				int sense_len, int timeout);
4291 
4292 void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
4293 				 void (*cbfcnp)(struct cam_periph *,
4294 				       union ccb *),
4295 				 uint8_t tag_action, int service_action,
4296 				 int scope, int res_type, uint8_t *data_ptr,
4297 				 uint32_t dxfer_len, int sense_len,
4298 				 int timeout);
4299 
4300 void scsi_report_supported_opcodes(struct ccb_scsiio *csio, uint32_t retries,
4301 				   void (*cbfcnp)(struct cam_periph *,
4302 						  union ccb *),
4303 				   uint8_t tag_action, int options,
4304 				   int req_opcode, int req_service_action,
4305 				   uint8_t *data_ptr, uint32_t dxfer_len,
4306 				   int sense_len, int timeout);
4307 
4308 int		scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
4309 int		scsi_static_inquiry_match(caddr_t inqbuffer,
4310 					  caddr_t table_entry);
4311 int		scsi_devid_match(uint8_t *rhs, size_t rhs_len,
4312 				 uint8_t *lhs, size_t lhs_len);
4313 
4314 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
4315 			int *sense_key, int *asc, int *ascq);
4316 int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
4317 			   int *asc, int *ascq);
4318 void scsi_extract_sense_len(struct scsi_sense_data *sense,
4319 			    u_int sense_len, int *error_code, int *sense_key,
4320 			    int *asc, int *ascq, int show_errors);
4321 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
4322 		       int show_errors);
4323 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
4324 		 int show_errors);
4325 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
4326 		  int show_errors);
4327 
4328 static __inline void
4329 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
4330 {
4331 
4332 	bytes[0] = (val >> 8) & 0xff;
4333 	bytes[1] = val & 0xff;
4334 }
4335 
4336 static __inline void
4337 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
4338 {
4339 
4340 	bytes[0] = (val >> 16) & 0xff;
4341 	bytes[1] = (val >> 8) & 0xff;
4342 	bytes[2] = val & 0xff;
4343 }
4344 
4345 static __inline void
4346 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
4347 {
4348 
4349 	bytes[0] = (val >> 24) & 0xff;
4350 	bytes[1] = (val >> 16) & 0xff;
4351 	bytes[2] = (val >> 8) & 0xff;
4352 	bytes[3] = val & 0xff;
4353 }
4354 
4355 static __inline void
4356 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
4357 {
4358 
4359 	bytes[0] = (val >> 56) & 0xff;
4360 	bytes[1] = (val >> 48) & 0xff;
4361 	bytes[2] = (val >> 40) & 0xff;
4362 	bytes[3] = (val >> 32) & 0xff;
4363 	bytes[4] = (val >> 24) & 0xff;
4364 	bytes[5] = (val >> 16) & 0xff;
4365 	bytes[6] = (val >> 8) & 0xff;
4366 	bytes[7] = val & 0xff;
4367 }
4368 
4369 static __inline uint32_t
4370 scsi_2btoul(const uint8_t *bytes)
4371 {
4372 	uint32_t rv;
4373 
4374 	rv = (bytes[0] << 8) |
4375 	     bytes[1];
4376 	return (rv);
4377 }
4378 
4379 static __inline uint32_t
4380 scsi_3btoul(const uint8_t *bytes)
4381 {
4382 	uint32_t rv;
4383 
4384 	rv = (bytes[0] << 16) |
4385 	     (bytes[1] << 8) |
4386 	     bytes[2];
4387 	return (rv);
4388 }
4389 
4390 static __inline int32_t
4391 scsi_3btol(const uint8_t *bytes)
4392 {
4393 	uint32_t rc = scsi_3btoul(bytes);
4394 
4395 	if (rc & 0x00800000)
4396 		rc |= 0xff000000;
4397 
4398 	return (int32_t) rc;
4399 }
4400 
4401 static __inline uint32_t
4402 scsi_4btoul(const uint8_t *bytes)
4403 {
4404 	uint32_t rv;
4405 
4406 	rv = (bytes[0] << 24) |
4407 	     (bytes[1] << 16) |
4408 	     (bytes[2] << 8) |
4409 	     bytes[3];
4410 	return (rv);
4411 }
4412 
4413 static __inline uint64_t
4414 scsi_8btou64(const uint8_t *bytes)
4415 {
4416         uint64_t rv;
4417 
4418 	rv = (((uint64_t)bytes[0]) << 56) |
4419 	     (((uint64_t)bytes[1]) << 48) |
4420 	     (((uint64_t)bytes[2]) << 40) |
4421 	     (((uint64_t)bytes[3]) << 32) |
4422 	     (((uint64_t)bytes[4]) << 24) |
4423 	     (((uint64_t)bytes[5]) << 16) |
4424 	     (((uint64_t)bytes[6]) << 8) |
4425 	     bytes[7];
4426 	return (rv);
4427 }
4428 
4429 /*
4430  * Given the pointer to a returned mode sense buffer, return a pointer to
4431  * the start of the first mode page.
4432  */
4433 static __inline void *
4434 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
4435 {
4436 	void *page_start;
4437 
4438 	page_start = (void *)((u_int8_t *)&mode_header[1] +
4439 			      mode_header->blk_desc_len);
4440 
4441 	return(page_start);
4442 }
4443 
4444 static __inline void *
4445 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
4446 {
4447 	void *page_start;
4448 
4449 	page_start = (void *)((u_int8_t *)&mode_header[1] +
4450 			       scsi_2btoul(mode_header->blk_desc_len));
4451 
4452 	return(page_start);
4453 }
4454 
4455 __END_DECLS
4456 
4457 #endif /*_SCSI_SCSI_ALL_H*/
4458