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