xref: /freebsd/sys/cam/scsi/scsi_all.h (revision 3ef51c5fb9163f2aafb1c14729e06a8bf0c4d113)
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 #include <machine/stdarg.h>
29 
30 #ifdef _KERNEL
31 /*
32  * This is the number of seconds we wait for devices to settle after a SCSI
33  * bus reset.
34  */
35 extern int scsi_delay;
36 #endif /* _KERNEL */
37 
38 /*
39  * SCSI command format
40  */
41 
42 /*
43  * Define dome bits that are in ALL (or a lot of) scsi commands
44  */
45 #define	SCSI_CTL_LINK		0x01
46 #define	SCSI_CTL_FLAG		0x02
47 #define	SCSI_CTL_VENDOR		0xC0
48 #define	SCSI_CMD_LUN		0xA0	/* these two should not be needed */
49 #define	SCSI_CMD_LUN_SHIFT	5	/* LUN in the cmd is no longer SCSI */
50 
51 #define	SCSI_MAX_CDBLEN		16	/*
52 					 * 16 byte commands are in the
53 					 * SCSI-3 spec
54 					 */
55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
57 #endif
58 
59 /* 6byte CDBs special case 0 length to be 256 */
60 #define	SCSI_CDB6_LEN(len)	((len) == 0 ? 256 : len)
61 
62 /*
63  * This type defines actions to be taken when a particular sense code is
64  * received.  Right now, these flags are only defined to take up 16 bits,
65  * but can be expanded in the future if necessary.
66  */
67 typedef enum {
68 	SS_NOP      = 0x000000,	/* Do nothing */
69 	SS_RETRY    = 0x010000,	/* Retry the command */
70 	SS_FAIL     = 0x020000,	/* Bail out */
71 	SS_START    = 0x030000,	/* Send a Start Unit command to the device,
72 				 * then retry the original command.
73 				 */
74 	SS_TUR      = 0x040000,	/* Send a Test Unit Ready command to the
75 				 * device, then retry the original command.
76 				 */
77 	SS_REQSENSE = 0x050000,	/* Send a RequestSense command to the
78 				 * device, then retry the original command.
79 				 */
80 	SS_MASK     = 0xff0000
81 } scsi_sense_action;
82 
83 typedef enum {
84 	SSQ_NONE		= 0x0000,
85 	SSQ_DECREMENT_COUNT	= 0x0100,  /* Decrement the retry count */
86 	SSQ_MANY		= 0x0200,  /* send lots of recovery commands */
87 	SSQ_RANGE		= 0x0400,  /*
88 					    * This table entry represents the
89 					    * end of a range of ASCQs that
90 					    * have identical error actions
91 					    * and text.
92 					    */
93 	SSQ_PRINT_SENSE		= 0x0800,
94 	SSQ_MASK		= 0xff00
95 } scsi_sense_action_qualifier;
96 
97 /* Mask for error status values */
98 #define	SS_ERRMASK	0xff
99 
100 /* The default, retyable, error action */
101 #define	SS_RDEF		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
102 
103 /* The retyable, error action, with table specified error code */
104 #define	SS_RET		SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
105 
106 /* Fatal error action, with table specified error code */
107 #define	SS_FATAL	SS_FAIL|SSQ_PRINT_SENSE
108 
109 struct scsi_generic
110 {
111 	u_int8_t opcode;
112 	u_int8_t bytes[11];
113 };
114 
115 struct scsi_request_sense
116 {
117 	u_int8_t opcode;
118 	u_int8_t byte2;
119 #define	SRS_DESC	0x01
120 	u_int8_t unused[2];
121 	u_int8_t length;
122 	u_int8_t control;
123 };
124 
125 struct scsi_test_unit_ready
126 {
127 	u_int8_t opcode;
128 	u_int8_t byte2;
129 	u_int8_t unused[3];
130 	u_int8_t control;
131 };
132 
133 struct scsi_receive_diag {
134 	uint8_t opcode;
135 	uint8_t byte2;
136 #define SRD_PCV		0x01
137 	uint8_t page_code;
138 	uint8_t length[2];
139 	uint8_t control;
140 };
141 
142 struct scsi_send_diag {
143 	uint8_t opcode;
144 	uint8_t byte2;
145 #define SSD_UNITOFFL				0x01
146 #define SSD_DEVOFFL				0x02
147 #define SSD_SELFTEST				0x04
148 #define SSD_PF					0x10
149 #define SSD_SELF_TEST_CODE_MASK			0xE0
150 #define SSD_SELF_TEST_CODE_SHIFT		5
151 #define		SSD_SELF_TEST_CODE_NONE		0x00
152 #define		SSD_SELF_TEST_CODE_BG_SHORT	0x01
153 #define		SSD_SELF_TEST_CODE_BG_EXTENDED	0x02
154 #define		SSD_SELF_TEST_CODE_BG_ABORT	0x04
155 #define		SSD_SELF_TEST_CODE_FG_SHORT	0x05
156 #define		SSD_SELF_TEST_CODE_FG_EXTENDED	0x06
157 	uint8_t	reserved;
158 	uint8_t	length[2];
159 	uint8_t control;
160 };
161 
162 struct scsi_sense
163 {
164 	u_int8_t opcode;
165 	u_int8_t byte2;
166 	u_int8_t unused[2];
167 	u_int8_t length;
168 	u_int8_t control;
169 };
170 
171 struct scsi_inquiry
172 {
173 	u_int8_t opcode;
174 	u_int8_t byte2;
175 #define	SI_EVPD 	0x01
176 #define	SI_CMDDT	0x02
177 	u_int8_t page_code;
178 	u_int8_t length[2];
179 	u_int8_t control;
180 };
181 
182 struct scsi_mode_sense_6
183 {
184 	u_int8_t opcode;
185 	u_int8_t byte2;
186 #define	SMS_DBD				0x08
187 	u_int8_t page;
188 #define	SMS_PAGE_CODE 			0x3F
189 #define	SMS_VENDOR_SPECIFIC_PAGE	0x00
190 #define	SMS_DISCONNECT_RECONNECT_PAGE	0x02
191 #define	SMS_FORMAT_DEVICE_PAGE		0x03
192 #define	SMS_GEOMETRY_PAGE		0x04
193 #define	SMS_CACHE_PAGE			0x08
194 #define	SMS_PERIPHERAL_DEVICE_PAGE	0x09
195 #define	SMS_CONTROL_MODE_PAGE		0x0A
196 #define	SMS_PROTO_SPECIFIC_PAGE		0x19
197 #define	SMS_INFO_EXCEPTIONS_PAGE	0x1C
198 #define	SMS_ALL_PAGES_PAGE		0x3F
199 #define	SMS_PAGE_CTRL_MASK		0xC0
200 #define	SMS_PAGE_CTRL_CURRENT 		0x00
201 #define	SMS_PAGE_CTRL_CHANGEABLE 	0x40
202 #define	SMS_PAGE_CTRL_DEFAULT 		0x80
203 #define	SMS_PAGE_CTRL_SAVED 		0xC0
204 	u_int8_t subpage;
205 #define	SMS_SUBPAGE_PAGE_0		0x00
206 #define	SMS_SUBPAGE_ALL			0xff
207 	u_int8_t length;
208 	u_int8_t control;
209 };
210 
211 struct scsi_mode_sense_10
212 {
213 	u_int8_t opcode;
214 	u_int8_t byte2;		/* same bits as small version */
215 #define	SMS10_LLBAA			0x10
216 	u_int8_t page; 		/* same bits as small version */
217 	u_int8_t subpage;
218 	u_int8_t unused[3];
219 	u_int8_t length[2];
220 	u_int8_t control;
221 };
222 
223 struct scsi_mode_select_6
224 {
225 	u_int8_t opcode;
226 	u_int8_t byte2;
227 #define	SMS_SP	0x01
228 #define	SMS_PF	0x10
229 	u_int8_t unused[2];
230 	u_int8_t length;
231 	u_int8_t control;
232 };
233 
234 struct scsi_mode_select_10
235 {
236 	u_int8_t opcode;
237 	u_int8_t byte2;		/* same bits as small version */
238 	u_int8_t unused[5];
239 	u_int8_t length[2];
240 	u_int8_t control;
241 };
242 
243 /*
244  * When sending a mode select to a tape drive, the medium type must be 0.
245  */
246 struct scsi_mode_hdr_6
247 {
248 	u_int8_t datalen;
249 	u_int8_t medium_type;
250 	u_int8_t dev_specific;
251 	u_int8_t block_descr_len;
252 };
253 
254 struct scsi_mode_hdr_10
255 {
256 	u_int8_t datalen[2];
257 	u_int8_t medium_type;
258 	u_int8_t dev_specific;
259 	u_int8_t reserved[2];
260 	u_int8_t block_descr_len[2];
261 };
262 
263 struct scsi_mode_block_descr
264 {
265 	u_int8_t density_code;
266 	u_int8_t num_blocks[3];
267 	u_int8_t reserved;
268 	u_int8_t block_len[3];
269 };
270 
271 struct scsi_per_res_in
272 {
273 	u_int8_t opcode;
274 	u_int8_t action;
275 #define	SPRI_RK	0x00
276 #define	SPRI_RR	0x01
277 #define	SPRI_RC	0x02
278 #define	SPRI_RS	0x03
279 	u_int8_t reserved[5];
280 	u_int8_t length[2];
281 	u_int8_t control;
282 };
283 
284 struct scsi_per_res_in_header
285 {
286 	u_int8_t generation[4];
287 	u_int8_t length[4];
288 };
289 
290 struct scsi_per_res_key
291 {
292 	u_int8_t key[8];
293 };
294 
295 struct scsi_per_res_in_keys
296 {
297 	struct scsi_per_res_in_header header;
298 	struct scsi_per_res_key keys[0];
299 };
300 
301 struct scsi_per_res_cap
302 {
303 	uint8_t length[2];
304 	uint8_t flags1;
305 #define	SPRI_CRH	0x10
306 #define	SPRI_SIP_C	0x08
307 #define	SPRI_ATP_C	0x04
308 #define	SPRI_PTPL_C	0x01
309 	uint8_t flags2;
310 #define	SPRI_TMV	0x80
311 #define	SPRI_PTPL_A	0x01
312 	uint8_t type_mask[2];
313 #define	SPRI_TM_WR_EX_AR	0x8000
314 #define	SPRI_TM_EX_AC_RO	0x4000
315 #define	SPRI_TM_WR_EX_RO	0x2000
316 #define	SPRI_TM_EX_AC		0x0800
317 #define	SPRI_TM_WR_EX		0x0200
318 #define	SPRI_TM_EX_AC_AR	0x0001
319 	uint8_t reserved[2];
320 };
321 
322 struct scsi_per_res_in_rsrv_data
323 {
324 	uint8_t reservation[8];
325 	uint8_t obsolete1[4];
326 	uint8_t reserved;
327 	uint8_t scopetype;
328 #define	SPRT_WE    0x01
329 #define	SPRT_EA    0x03
330 #define	SPRT_WERO  0x05
331 #define	SPRT_EARO  0x06
332 #define	SPRT_WEAR  0x07
333 #define	SPRT_EAAR  0x08
334 	uint8_t obsolete2[2];
335 };
336 
337 struct scsi_per_res_in_rsrv
338 {
339 	struct scsi_per_res_in_header header;
340 	struct scsi_per_res_in_rsrv_data data;
341 };
342 
343 struct scsi_per_res_out
344 {
345 	u_int8_t opcode;
346 	u_int8_t action;
347 #define	SPRO_REGISTER		0x00
348 #define	SPRO_RESERVE		0x01
349 #define	SPRO_RELEASE		0x02
350 #define	SPRO_CLEAR		0x03
351 #define	SPRO_PREEMPT		0x04
352 #define	SPRO_PRE_ABO		0x05
353 #define	SPRO_REG_IGNO		0x06
354 #define	SPRO_REG_MOVE		0x07
355 #define	SPRO_ACTION_MASK	0x1f
356 	u_int8_t scope_type;
357 #define	SPR_SCOPE_MASK		0xf0
358 #define	SPR_LU_SCOPE		0x00
359 #define	SPR_TYPE_MASK		0x0f
360 #define	SPR_TYPE_WR_EX		0x01
361 #define	SPR_TYPE_EX_AC		0x03
362 #define	SPR_TYPE_WR_EX_RO	0x05
363 #define	SPR_TYPE_EX_AC_RO	0x06
364 #define	SPR_TYPE_WR_EX_AR	0x07
365 #define	SPR_TYPE_EX_AC_AR	0x08
366 	u_int8_t reserved[2];
367 	u_int8_t length[4];
368 	u_int8_t control;
369 };
370 
371 struct scsi_per_res_out_parms
372 {
373 	struct scsi_per_res_key res_key;
374 	u_int8_t serv_act_res_key[8];
375 	u_int8_t obsolete1[4];
376 	u_int8_t flags;
377 #define	SPR_SPEC_I_PT		0x08
378 #define	SPR_ALL_TG_PT		0x04
379 #define	SPR_APTPL		0x01
380 	u_int8_t reserved1;
381 	u_int8_t obsolete2[2];
382 };
383 
384 
385 struct scsi_log_sense
386 {
387 	u_int8_t opcode;
388 	u_int8_t byte2;
389 #define	SLS_SP				0x01
390 #define	SLS_PPC				0x02
391 	u_int8_t page;
392 #define	SLS_PAGE_CODE 			0x3F
393 #define	SLS_ALL_PAGES_PAGE		0x00
394 #define	SLS_OVERRUN_PAGE		0x01
395 #define	SLS_ERROR_WRITE_PAGE		0x02
396 #define	SLS_ERROR_READ_PAGE		0x03
397 #define	SLS_ERROR_READREVERSE_PAGE	0x04
398 #define	SLS_ERROR_VERIFY_PAGE		0x05
399 #define	SLS_ERROR_NONMEDIUM_PAGE	0x06
400 #define	SLS_ERROR_LASTN_PAGE		0x07
401 #define	SLS_SELF_TEST_PAGE		0x10
402 #define	SLS_IE_PAGE			0x2f
403 #define	SLS_PAGE_CTRL_MASK		0xC0
404 #define	SLS_PAGE_CTRL_THRESHOLD		0x00
405 #define	SLS_PAGE_CTRL_CUMULATIVE	0x40
406 #define	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80
407 #define	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0
408 	u_int8_t reserved[2];
409 	u_int8_t paramptr[2];
410 	u_int8_t length[2];
411 	u_int8_t control;
412 };
413 
414 struct scsi_log_select
415 {
416 	u_int8_t opcode;
417 	u_int8_t byte2;
418 /*	SLS_SP				0x01 */
419 #define	SLS_PCR				0x02
420 	u_int8_t page;
421 /*	SLS_PAGE_CTRL_MASK		0xC0 */
422 /*	SLS_PAGE_CTRL_THRESHOLD		0x00 */
423 /*	SLS_PAGE_CTRL_CUMULATIVE	0x40 */
424 /*	SLS_PAGE_CTRL_THRESH_DEFAULT	0x80 */
425 /*	SLS_PAGE_CTRL_CUMUL_DEFAULT	0xC0 */
426 	u_int8_t reserved[4];
427 	u_int8_t length[2];
428 	u_int8_t control;
429 };
430 
431 struct scsi_log_header
432 {
433 	u_int8_t page;
434 	u_int8_t reserved;
435 	u_int8_t datalen[2];
436 };
437 
438 struct scsi_log_param_header {
439 	u_int8_t param_code[2];
440 	u_int8_t param_control;
441 #define	SLP_LP				0x01
442 #define	SLP_LBIN			0x02
443 #define	SLP_TMC_MASK			0x0C
444 #define	SLP_TMC_ALWAYS			0x00
445 #define	SLP_TMC_EQUAL			0x04
446 #define	SLP_TMC_NOTEQUAL		0x08
447 #define	SLP_TMC_GREATER			0x0C
448 #define	SLP_ETC				0x10
449 #define	SLP_TSD				0x20
450 #define	SLP_DS				0x40
451 #define	SLP_DU				0x80
452 	u_int8_t param_len;
453 };
454 
455 struct scsi_control_page {
456 	u_int8_t page_code;
457 	u_int8_t page_length;
458 	u_int8_t rlec;
459 #define	SCP_RLEC			0x01	/*Report Log Exception Cond*/
460 #define	SCP_GLTSD			0x02	/*Global Logging target
461 						  save disable */
462 #define	SCP_DSENSE			0x04	/*Descriptor Sense */
463 #define	SCP_DPICZ			0x08	/*Disable Prot. Info Check
464 						  if Prot. Field is Zero */
465 #define	SCP_TMF_ONLY			0x10	/*TM Functions Only*/
466 #define	SCP_TST_MASK			0xE0	/*Task Set Type Mask*/
467 #define	SCP_TST_ONE			0x00	/*One Task Set*/
468 #define	SCP_TST_SEPARATE		0x20	/*Separate Task Sets*/
469 	u_int8_t queue_flags;
470 #define	SCP_QUEUE_ALG_MASK		0xF0
471 #define	SCP_QUEUE_ALG_RESTRICTED	0x00
472 #define	SCP_QUEUE_ALG_UNRESTRICTED	0x10
473 #define	SCP_QUEUE_ERR			0x02	/*Queued I/O aborted for CACs*/
474 #define	SCP_QUEUE_DQUE			0x01	/*Queued I/O disabled*/
475 	u_int8_t eca_and_aen;
476 #define	SCP_EECA			0x80	/*Enable Extended CA*/
477 #define	SCP_RAENP			0x04	/*Ready AEN Permission*/
478 #define	SCP_UAAENP			0x02	/*UA AEN Permission*/
479 #define	SCP_EAENP			0x01	/*Error AEN Permission*/
480 	u_int8_t reserved;
481 	u_int8_t aen_holdoff_period[2];
482 };
483 
484 struct scsi_cache_page {
485 	u_int8_t page_code;
486 #define	SCHP_PAGE_SAVABLE		0x80	/* Page is savable */
487 	u_int8_t page_length;
488 	u_int8_t cache_flags;
489 #define	SCHP_FLAGS_WCE			0x04	/* Write Cache Enable */
490 #define	SCHP_FLAGS_MF			0x02	/* Multiplication factor */
491 #define	SCHP_FLAGS_RCD			0x01	/* Read Cache Disable */
492 	u_int8_t rw_cache_policy;
493 	u_int8_t dis_prefetch[2];
494 	u_int8_t min_prefetch[2];
495 	u_int8_t max_prefetch[2];
496 	u_int8_t max_prefetch_ceil[2];
497 };
498 
499 /*
500  * XXX KDM
501  * Updated version of the cache page, as of SBC.  Update this to SBC-3 and
502  * rationalize the two.
503  */
504 struct scsi_caching_page {
505 	uint8_t page_code;
506 #define	SMS_CACHING_PAGE		0x08
507 	uint8_t page_length;
508 	uint8_t flags1;
509 #define	SCP_IC		0x80
510 #define	SCP_ABPF	0x40
511 #define	SCP_CAP		0x20
512 #define	SCP_DISC	0x10
513 #define	SCP_SIZE	0x08
514 #define	SCP_WCE		0x04
515 #define	SCP_MF		0x02
516 #define	SCP_RCD		0x01
517 	uint8_t ret_priority;
518 	uint8_t disable_pf_transfer_len[2];
519 	uint8_t min_prefetch[2];
520 	uint8_t max_prefetch[2];
521 	uint8_t max_pf_ceiling[2];
522 	uint8_t flags2;
523 #define	SCP_FSW		0x80
524 #define	SCP_LBCSS	0x40
525 #define	SCP_DRA		0x20
526 #define	SCP_VS1		0x10
527 #define	SCP_VS2		0x08
528 	uint8_t cache_segments;
529 	uint8_t cache_seg_size[2];
530 	uint8_t reserved;
531 	uint8_t non_cache_seg_size[3];
532 };
533 
534 /*
535  * XXX KDM move this off to a vendor shim.
536  */
537 struct copan_power_subpage {
538 	uint8_t page_code;
539 #define	PWR_PAGE_CODE		0x00
540 	uint8_t subpage;
541 #define	PWR_SUBPAGE_CODE	0x02
542 	uint8_t page_length[2];
543 	uint8_t page_version;
544 #define	PWR_VERSION		    0x01
545 	uint8_t total_luns;
546 	uint8_t max_active_luns;
547 #define	PWR_DFLT_MAX_LUNS	    0x07
548 	uint8_t reserved[25];
549 };
550 
551 /*
552  * XXX KDM move this off to a vendor shim.
553  */
554 struct copan_aps_subpage {
555 	uint8_t page_code;
556 #define	APS_PAGE_CODE		0x00
557 	uint8_t subpage;
558 #define	APS_SUBPAGE_CODE	0x03
559 	uint8_t page_length[2];
560 	uint8_t page_version;
561 #define	APS_VERSION		    0x00
562 	uint8_t lock_active;
563 #define	APS_LOCK_ACTIVE	    0x01
564 #define	APS_LOCK_INACTIVE	0x00
565 	uint8_t reserved[26];
566 };
567 
568 /*
569  * XXX KDM move this off to a vendor shim.
570  */
571 struct copan_debugconf_subpage {
572 	uint8_t page_code;
573 #define DBGCNF_PAGE_CODE		0x00
574 	uint8_t subpage;
575 #define DBGCNF_SUBPAGE_CODE	0xF0
576 	uint8_t page_length[2];
577 	uint8_t page_version;
578 #define DBGCNF_VERSION			0x00
579 	uint8_t ctl_time_io_secs[2];
580 };
581 
582 
583 struct scsi_info_exceptions_page {
584 	u_int8_t page_code;
585 #define	SIEP_PAGE_SAVABLE		0x80	/* Page is savable */
586 	u_int8_t page_length;
587 	u_int8_t info_flags;
588 #define	SIEP_FLAGS_PERF			0x80
589 #define	SIEP_FLAGS_EBF			0x20
590 #define	SIEP_FLAGS_EWASC		0x10
591 #define	SIEP_FLAGS_DEXCPT		0x08
592 #define	SIEP_FLAGS_TEST			0x04
593 #define	SIEP_FLAGS_EBACKERR		0x02
594 #define	SIEP_FLAGS_LOGERR		0x01
595 	u_int8_t mrie;
596 	u_int8_t interval_timer[4];
597 	u_int8_t report_count[4];
598 };
599 
600 struct scsi_proto_specific_page {
601 	u_int8_t page_code;
602 #define	SPSP_PAGE_SAVABLE		0x80	/* Page is savable */
603 	u_int8_t page_length;
604 	u_int8_t protocol;
605 #define	SPSP_PROTO_FC			0x00
606 #define	SPSP_PROTO_SPI			0x01
607 #define	SPSP_PROTO_SSA			0x02
608 #define	SPSP_PROTO_1394			0x03
609 #define	SPSP_PROTO_RDMA			0x04
610 #define	SPSP_PROTO_ISCSI		0x05
611 #define	SPSP_PROTO_SAS			0x06
612 #define	SPSP_PROTO_ADT			0x07
613 #define	SPSP_PROTO_ATA			0x08
614 #define	SPSP_PROTO_NONE			0x0f
615 };
616 
617 struct scsi_reserve
618 {
619 	u_int8_t opcode;
620 	u_int8_t byte2;
621 #define	SR_EXTENT	0x01
622 #define	SR_ID_MASK	0x0e
623 #define	SR_3RDPTY	0x10
624 #define	SR_LUN_MASK	0xe0
625 	u_int8_t resv_id;
626 	u_int8_t length[2];
627 	u_int8_t control;
628 };
629 
630 struct scsi_reserve_10 {
631 	uint8_t	opcode;
632 	uint8_t	byte2;
633 #define	SR10_3RDPTY	0x10
634 #define	SR10_LONGID	0x02
635 #define	SR10_EXTENT	0x01
636 	uint8_t resv_id;
637 	uint8_t thirdparty_id;
638 	uint8_t reserved[3];
639 	uint8_t length[2];
640 	uint8_t control;
641 };
642 
643 
644 struct scsi_release
645 {
646 	u_int8_t opcode;
647 	u_int8_t byte2;
648 	u_int8_t resv_id;
649 	u_int8_t unused[1];
650 	u_int8_t length;
651 	u_int8_t control;
652 };
653 
654 struct scsi_release_10 {
655 	uint8_t opcode;
656 	uint8_t byte2;
657 	uint8_t resv_id;
658 	uint8_t thirdparty_id;
659 	uint8_t reserved[3];
660 	uint8_t length[2];
661 	uint8_t control;
662 };
663 
664 struct scsi_prevent
665 {
666 	u_int8_t opcode;
667 	u_int8_t byte2;
668 	u_int8_t unused[2];
669 	u_int8_t how;
670 	u_int8_t control;
671 };
672 #define	PR_PREVENT 0x01
673 #define	PR_ALLOW   0x00
674 
675 struct scsi_sync_cache
676 {
677 	u_int8_t opcode;
678 	u_int8_t byte2;
679 #define	SSC_IMMED	0x02
680 #define	SSC_RELADR	0x01
681 	u_int8_t begin_lba[4];
682 	u_int8_t reserved;
683 	u_int8_t lb_count[2];
684 	u_int8_t control;
685 };
686 
687 struct scsi_sync_cache_16
688 {
689 	uint8_t opcode;
690 	uint8_t byte2;
691 	uint8_t begin_lba[8];
692 	uint8_t lb_count[4];
693 	uint8_t reserved;
694 	uint8_t control;
695 };
696 
697 struct scsi_format {
698 	uint8_t opcode;
699 	uint8_t byte2;
700 #define	SF_LONGLIST		0x20
701 #define	SF_FMTDATA		0x10
702 #define	SF_CMPLIST		0x08
703 #define	SF_FORMAT_MASK		0x07
704 #define	SF_FORMAT_BLOCK		0x00
705 #define	SF_FORMAT_LONG_BLOCK	0x03
706 #define	SF_FORMAT_BFI		0x04
707 #define	SF_FORMAT_PHYS		0x05
708 	uint8_t vendor;
709 	uint8_t interleave[2];
710 	uint8_t control;
711 };
712 
713 struct scsi_format_header_short {
714 	uint8_t reserved;
715 #define	SF_DATA_FOV	0x80
716 #define	SF_DATA_DPRY	0x40
717 #define	SF_DATA_DCRT	0x20
718 #define	SF_DATA_STPF	0x10
719 #define	SF_DATA_IP	0x08
720 #define	SF_DATA_DSP	0x04
721 #define	SF_DATA_IMMED	0x02
722 #define	SF_DATA_VS	0x01
723 	uint8_t byte2;
724 	uint8_t defect_list_len[2];
725 };
726 
727 struct scsi_format_header_long {
728 	uint8_t reserved;
729 	uint8_t byte2;
730 	uint8_t reserved2[2];
731 	uint8_t defect_list_len[4];
732 };
733 
734 struct scsi_changedef
735 {
736 	u_int8_t opcode;
737 	u_int8_t byte2;
738 	u_int8_t unused1;
739 	u_int8_t how;
740 	u_int8_t unused[4];
741 	u_int8_t datalen;
742 	u_int8_t control;
743 };
744 
745 struct scsi_read_buffer
746 {
747 	u_int8_t opcode;
748 	u_int8_t byte2;
749 #define	RWB_MODE		0x07
750 #define	RWB_MODE_HDR_DATA	0x00
751 #define	RWB_MODE_VENDOR		0x01
752 #define	RWB_MODE_DATA		0x02
753 #define	RWB_MODE_DOWNLOAD	0x04
754 #define	RWB_MODE_DOWNLOAD_SAVE	0x05
755         u_int8_t buffer_id;
756         u_int8_t offset[3];
757         u_int8_t length[3];
758         u_int8_t control;
759 };
760 
761 struct scsi_write_buffer
762 {
763 	u_int8_t opcode;
764 	u_int8_t byte2;
765 	u_int8_t buffer_id;
766 	u_int8_t offset[3];
767 	u_int8_t length[3];
768 	u_int8_t control;
769 };
770 
771 struct scsi_rw_6
772 {
773 	u_int8_t opcode;
774 	u_int8_t addr[3];
775 /* only 5 bits are valid in the MSB address byte */
776 #define	SRW_TOPADDR	0x1F
777 	u_int8_t length;
778 	u_int8_t control;
779 };
780 
781 struct scsi_rw_10
782 {
783 	u_int8_t opcode;
784 #define	SRW10_RELADDR	0x01
785 /* EBP defined for WRITE(10) only */
786 #define	SRW10_EBP	0x04
787 #define	SRW10_FUA	0x08
788 #define	SRW10_DPO	0x10
789 	u_int8_t byte2;
790 	u_int8_t addr[4];
791 	u_int8_t reserved;
792 	u_int8_t length[2];
793 	u_int8_t control;
794 };
795 
796 struct scsi_rw_12
797 {
798 	u_int8_t opcode;
799 #define	SRW12_RELADDR	0x01
800 #define	SRW12_FUA	0x08
801 #define	SRW12_DPO	0x10
802 	u_int8_t byte2;
803 	u_int8_t addr[4];
804 	u_int8_t length[4];
805 	u_int8_t reserved;
806 	u_int8_t control;
807 };
808 
809 struct scsi_rw_16
810 {
811 	u_int8_t opcode;
812 #define	SRW16_RELADDR	0x01
813 #define	SRW16_FUA	0x08
814 #define	SRW16_DPO	0x10
815 	u_int8_t byte2;
816 	u_int8_t addr[8];
817 	u_int8_t length[4];
818 	u_int8_t reserved;
819 	u_int8_t control;
820 };
821 
822 struct scsi_write_same_10
823 {
824 	uint8_t	opcode;
825 	uint8_t	byte2;
826 #define	SWS_LBDATA	0x02
827 #define	SWS_PBDATA	0x04
828 #define	SWS_UNMAP	0x08
829 #define	SWS_ANCHOR	0x10
830 	uint8_t	addr[4];
831 	uint8_t	group;
832 	uint8_t	length[2];
833 	uint8_t	control;
834 };
835 
836 struct scsi_write_same_16
837 {
838 	uint8_t	opcode;
839 	uint8_t	byte2;
840 	uint8_t	addr[8];
841 	uint8_t	length[4];
842 	uint8_t	group;
843 	uint8_t	control;
844 };
845 
846 struct scsi_unmap
847 {
848 	uint8_t	opcode;
849 	uint8_t	byte2;
850 #define	SU_ANCHOR	0x01
851 	uint8_t	reserved[4];
852 	uint8_t	group;
853 	uint8_t	length[2];
854 	uint8_t	control;
855 };
856 
857 struct scsi_write_verify_10
858 {
859 	uint8_t	opcode;
860 	uint8_t	byte2;
861 #define	SWV_BYTCHK		0x02
862 #define	SWV_DPO			0x10
863 #define	SWV_WRPROECT_MASK	0xe0
864 	uint8_t	addr[4];
865 	uint8_t	group;
866 	uint8_t length[2];
867 	uint8_t	control;
868 };
869 
870 struct scsi_write_verify_12
871 {
872 	uint8_t	opcode;
873 	uint8_t	byte2;
874 	uint8_t	addr[4];
875 	uint8_t	length[4];
876 	uint8_t	group;
877 	uint8_t	control;
878 };
879 
880 struct scsi_write_verify_16
881 {
882 	uint8_t	opcode;
883 	uint8_t	byte2;
884 	uint8_t	addr[8];
885 	uint8_t	length[4];
886 	uint8_t	group;
887 	uint8_t	control;
888 };
889 
890 
891 struct scsi_start_stop_unit
892 {
893 	u_int8_t opcode;
894 	u_int8_t byte2;
895 #define	SSS_IMMED		0x01
896 	u_int8_t reserved[2];
897 	u_int8_t how;
898 #define	SSS_START		0x01
899 #define	SSS_LOEJ		0x02
900 #define	SSS_PC_MASK		0xf0
901 #define	SSS_PC_START_VALID	0x00
902 #define	SSS_PC_ACTIVE		0x10
903 #define	SSS_PC_IDLE		0x20
904 #define	SSS_PC_STANDBY		0x30
905 #define	SSS_PC_LU_CONTROL	0x70
906 #define	SSS_PC_FORCE_IDLE_0	0xa0
907 #define	SSS_PC_FORCE_STANDBY_0	0xb0
908 	u_int8_t control;
909 };
910 
911 struct ata_pass_12 {
912 	u_int8_t opcode;
913 	u_int8_t protocol;
914 #define	AP_MULTI	0xe0
915 	u_int8_t flags;
916 #define	AP_T_LEN	0x03
917 #define	AP_BB		0x04
918 #define	AP_T_DIR	0x08
919 #define	AP_CK_COND	0x20
920 #define	AP_OFFLINE	0x60
921 	u_int8_t features;
922 	u_int8_t sector_count;
923 	u_int8_t lba_low;
924 	u_int8_t lba_mid;
925 	u_int8_t lba_high;
926 	u_int8_t device;
927 	u_int8_t command;
928 	u_int8_t reserved;
929 	u_int8_t control;
930 };
931 
932 struct scsi_maintenance_in
933 {
934         uint8_t  opcode;
935         uint8_t  byte2;
936 #define SERVICE_ACTION_MASK  0x1f
937 #define SA_RPRT_TRGT_GRP     0x0a
938         uint8_t  reserved[4];
939 	uint8_t  length[4];
940 	uint8_t  reserved1;
941 	uint8_t  control;
942 };
943 
944 struct ata_pass_16 {
945 	u_int8_t opcode;
946 	u_int8_t protocol;
947 #define	AP_EXTEND	0x01
948 	u_int8_t flags;
949 	u_int8_t features_ext;
950 	u_int8_t features;
951 	u_int8_t sector_count_ext;
952 	u_int8_t sector_count;
953 	u_int8_t lba_low_ext;
954 	u_int8_t lba_low;
955 	u_int8_t lba_mid_ext;
956 	u_int8_t lba_mid;
957 	u_int8_t lba_high_ext;
958 	u_int8_t lba_high;
959 	u_int8_t device;
960 	u_int8_t command;
961 	u_int8_t control;
962 };
963 
964 #define	SC_SCSI_1 0x01
965 #define	SC_SCSI_2 0x03
966 
967 /*
968  * Opcodes
969  */
970 
971 #define	TEST_UNIT_READY		0x00
972 #define	REQUEST_SENSE		0x03
973 #define	READ_6			0x08
974 #define	WRITE_6			0x0A
975 #define	INQUIRY			0x12
976 #define	MODE_SELECT_6		0x15
977 #define	MODE_SENSE_6		0x1A
978 #define	START_STOP_UNIT		0x1B
979 #define	START_STOP		0x1B
980 #define	RESERVE      		0x16
981 #define	RELEASE      		0x17
982 #define	RECEIVE_DIAGNOSTIC	0x1C
983 #define	SEND_DIAGNOSTIC		0x1D
984 #define	PREVENT_ALLOW		0x1E
985 #define	READ_CAPACITY		0x25
986 #define	READ_10			0x28
987 #define	WRITE_10		0x2A
988 #define	POSITION_TO_ELEMENT	0x2B
989 #define	WRITE_VERIFY_10		0x2E
990 #define	SYNCHRONIZE_CACHE	0x35
991 #define	READ_DEFECT_DATA_10	0x37
992 #define	WRITE_BUFFER            0x3B
993 #define	READ_BUFFER             0x3C
994 #define	CHANGE_DEFINITION	0x40
995 #define	WRITE_SAME_10		0x41
996 #define	UNMAP			0x42
997 #define	LOG_SELECT		0x4C
998 #define	LOG_SENSE		0x4D
999 #define	MODE_SELECT_10		0x55
1000 #define	RESERVE_10		0x56
1001 #define	RELEASE_10		0x57
1002 #define	MODE_SENSE_10		0x5A
1003 #define	PERSISTENT_RES_IN	0x5E
1004 #define	PERSISTENT_RES_OUT	0x5F
1005 #define	ATA_PASS_16		0x85
1006 #define	READ_16			0x88
1007 #define	WRITE_16		0x8A
1008 #define	WRITE_VERIFY_16		0x8E
1009 #define	SYNCHRONIZE_CACHE_16	0x91
1010 #define	WRITE_SAME_16		0x93
1011 #define	SERVICE_ACTION_IN	0x9E
1012 #define	REPORT_LUNS		0xA0
1013 #define	ATA_PASS_12		0xA1
1014 #define	MAINTENANCE_IN		0xA3
1015 #define	MAINTENANCE_OUT		0xA4
1016 #define	MOVE_MEDIUM     	0xA5
1017 #define	READ_12			0xA8
1018 #define	WRITE_12		0xAA
1019 #define	WRITE_VERIFY_12		0xAE
1020 #define	READ_ELEMENT_STATUS	0xB8
1021 #define	READ_CD			0xBE
1022 
1023 /* Maintenance In Service Action Codes */
1024 #define	REPORT_IDENTIFYING_INFRMATION		0x05
1025 #define	REPORT_TARGET_PORT_GROUPS		0x0A
1026 #define	REPORT_ALIASES				0x0B
1027 #define	REPORT_SUPPORTED_OPERATION_CODES	0x0C
1028 #define	REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS	0x0D
1029 #define	REPORT_PRIORITY				0x0E
1030 #define	REPORT_TIMESTAMP			0x0F
1031 #define	MANAGEMENT_PROTOCOL_IN			0x10
1032 /* Maintenance Out Service Action Codes */
1033 #define	SET_IDENTIFY_INFORMATION		0x06
1034 #define	SET_TARGET_PORT_GROUPS			0x0A
1035 #define	CHANGE_ALIASES				0x0B
1036 #define	SET_PRIORITY				0x0E
1037 #define	SET_TIMESTAMP				0x0F
1038 #define	MANGAEMENT_PROTOCOL_OUT			0x10
1039 
1040 /*
1041  * Device Types
1042  */
1043 #define	T_DIRECT	0x00
1044 #define	T_SEQUENTIAL	0x01
1045 #define	T_PRINTER	0x02
1046 #define	T_PROCESSOR	0x03
1047 #define	T_WORM		0x04
1048 #define	T_CDROM		0x05
1049 #define	T_SCANNER	0x06
1050 #define	T_OPTICAL 	0x07
1051 #define	T_CHANGER	0x08
1052 #define	T_COMM		0x09
1053 #define	T_ASC0		0x0a
1054 #define	T_ASC1		0x0b
1055 #define	T_STORARRAY	0x0c
1056 #define	T_ENCLOSURE	0x0d
1057 #define	T_RBC		0x0e
1058 #define	T_OCRW		0x0f
1059 #define	T_OSD		0x11
1060 #define	T_ADC		0x12
1061 #define	T_NODEVICE	0x1f
1062 #define	T_ANY		0xff	/* Used in Quirk table matches */
1063 
1064 #define	T_REMOV		1
1065 #define	T_FIXED		0
1066 
1067 /*
1068  * This length is the initial inquiry length used by the probe code, as
1069  * well as the legnth necessary for scsi_print_inquiry() to function
1070  * correctly.  If either use requires a different length in the future,
1071  * the two values should be de-coupled.
1072  */
1073 #define	SHORT_INQUIRY_LENGTH	36
1074 
1075 struct scsi_inquiry_data
1076 {
1077 	u_int8_t device;
1078 #define	SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
1079 #define	SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
1080 #define	SID_QUAL_LU_CONNECTED	0x00	/*
1081 					 * The specified peripheral device
1082 					 * type is currently connected to
1083 					 * logical unit.  If the target cannot
1084 					 * determine whether or not a physical
1085 					 * device is currently connected, it
1086 					 * shall also use this peripheral
1087 					 * qualifier when returning the INQUIRY
1088 					 * data.  This peripheral qualifier
1089 					 * does not mean that the device is
1090 					 * ready for access by the initiator.
1091 					 */
1092 #define	SID_QUAL_LU_OFFLINE	0x01	/*
1093 					 * The target is capable of supporting
1094 					 * the specified peripheral device type
1095 					 * on this logical unit; however, the
1096 					 * physical device is not currently
1097 					 * connected to this logical unit.
1098 					 */
1099 #define	SID_QUAL_RSVD		0x02
1100 #define	SID_QUAL_BAD_LU		0x03	/*
1101 					 * The target is not capable of
1102 					 * supporting a physical device on
1103 					 * this logical unit. For this
1104 					 * peripheral qualifier the peripheral
1105 					 * device type shall be set to 1Fh to
1106 					 * provide compatibility with previous
1107 					 * versions of SCSI. All other
1108 					 * peripheral device type values are
1109 					 * reserved for this peripheral
1110 					 * qualifier.
1111 					 */
1112 #define	SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
1113 	u_int8_t dev_qual2;
1114 #define	SID_QUAL2	0x7F
1115 #define	SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
1116 	u_int8_t version;
1117 #define	SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
1118 #define		SCSI_REV_0		0
1119 #define		SCSI_REV_CCS		1
1120 #define		SCSI_REV_2		2
1121 #define		SCSI_REV_SPC		3
1122 #define		SCSI_REV_SPC2		4
1123 #define		SCSI_REV_SPC3		5
1124 #define		SCSI_REV_SPC4		6
1125 
1126 #define	SID_ECMA	0x38
1127 #define	SID_ISO		0xC0
1128 	u_int8_t response_format;
1129 #define	SID_AENC	0x80
1130 #define	SID_TrmIOP	0x40
1131 #define	SID_NormACA	0x20
1132 #define	SID_HiSup	0x10
1133 	u_int8_t additional_length;
1134 #define	SID_ADDITIONAL_LENGTH(iqd)					\
1135 	((iqd)->additional_length +					\
1136 	__offsetof(struct scsi_inquiry_data, additional_length) + 1)
1137 	u_int8_t spc3_flags;
1138 #define	SPC3_SID_PROTECT	0x01
1139 #define	SPC3_SID_3PC		0x08
1140 #define	SPC3_SID_TPGS_MASK	0x30
1141 #define	SPC3_SID_TPGS_IMPLICIT	0x10
1142 #define	SPC3_SID_TPGS_EXPLICIT	0x20
1143 #define	SPC3_SID_ACC		0x40
1144 #define	SPC3_SID_SCCS		0x80
1145 	u_int8_t spc2_flags;
1146 #define	SPC2_SID_ADDR16		0x01
1147 #define	SPC2_SID_MChngr 	0x08
1148 #define	SPC2_SID_MultiP 	0x10
1149 #define	SPC2_SID_EncServ	0x40
1150 #define	SPC2_SID_BQueue		0x80
1151 
1152 #define	INQ_DATA_TQ_ENABLED(iqd)				\
1153     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) :	\
1154     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
1155     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
1156 
1157 	u_int8_t flags;
1158 #define	SID_SftRe	0x01
1159 #define	SID_CmdQue	0x02
1160 #define	SID_Linked	0x08
1161 #define	SID_Sync	0x10
1162 #define	SID_WBus16	0x20
1163 #define	SID_WBus32	0x40
1164 #define	SID_RelAdr	0x80
1165 #define	SID_VENDOR_SIZE   8
1166 	char	 vendor[SID_VENDOR_SIZE];
1167 #define	SID_PRODUCT_SIZE  16
1168 	char	 product[SID_PRODUCT_SIZE];
1169 #define	SID_REVISION_SIZE 4
1170 	char	 revision[SID_REVISION_SIZE];
1171 	/*
1172 	 * The following fields were taken from SCSI Primary Commands - 2
1173 	 * (SPC-2) Revision 14, Dated 11 November 1999
1174 	 */
1175 #define	SID_VENDOR_SPECIFIC_0_SIZE	20
1176 	u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
1177 	/*
1178 	 * An extension of SCSI Parallel Specific Values
1179 	 */
1180 #define	SID_SPI_IUS		0x01
1181 #define	SID_SPI_QAS		0x02
1182 #define	SID_SPI_CLOCK_ST	0x00
1183 #define	SID_SPI_CLOCK_DT	0x04
1184 #define	SID_SPI_CLOCK_DT_ST	0x0C
1185 #define	SID_SPI_MASK		0x0F
1186 	u_int8_t spi3data;
1187 	u_int8_t reserved2;
1188 	/*
1189 	 * Version Descriptors, stored 2 byte values.
1190 	 */
1191 	u_int8_t version1[2];
1192 	u_int8_t version2[2];
1193 	u_int8_t version3[2];
1194 	u_int8_t version4[2];
1195 	u_int8_t version5[2];
1196 	u_int8_t version6[2];
1197 	u_int8_t version7[2];
1198 	u_int8_t version8[2];
1199 
1200 	u_int8_t reserved3[22];
1201 
1202 #define	SID_VENDOR_SPECIFIC_1_SIZE	160
1203 	u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
1204 };
1205 
1206 /*
1207  * This structure is more suited to initiator operation, because the
1208  * maximum number of supported pages is already allocated.
1209  */
1210 struct scsi_vpd_supported_page_list
1211 {
1212 	u_int8_t device;
1213 	u_int8_t page_code;
1214 #define	SVPD_SUPPORTED_PAGE_LIST	0x00
1215 #define	SVPD_SUPPORTED_PAGES_HDR_LEN	4
1216 	u_int8_t reserved;
1217 	u_int8_t length;	/* number of VPD entries */
1218 #define	SVPD_SUPPORTED_PAGES_SIZE	251
1219 	u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
1220 };
1221 
1222 /*
1223  * This structure is more suited to target operation, because the
1224  * number of supported pages is left to the user to allocate.
1225  */
1226 struct scsi_vpd_supported_pages
1227 {
1228 	u_int8_t device;
1229 	u_int8_t page_code;
1230 	u_int8_t reserved;
1231 #define	SVPD_SUPPORTED_PAGES	0x00
1232 	u_int8_t length;
1233 	u_int8_t page_list[0];
1234 };
1235 
1236 
1237 struct scsi_vpd_unit_serial_number
1238 {
1239 	u_int8_t device;
1240 	u_int8_t page_code;
1241 #define	SVPD_UNIT_SERIAL_NUMBER	0x80
1242 	u_int8_t reserved;
1243 	u_int8_t length; /* serial number length */
1244 #define	SVPD_SERIAL_NUM_SIZE 251
1245 	u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
1246 };
1247 
1248 struct scsi_vpd_device_id
1249 {
1250 	u_int8_t device;
1251 	u_int8_t page_code;
1252 #define	SVPD_DEVICE_ID			0x83
1253 #define	SVPD_DEVICE_ID_MAX_SIZE		252
1254 #define	SVPD_DEVICE_ID_HDR_LEN \
1255     __offsetof(struct scsi_vpd_device_id, desc_list)
1256 	u_int8_t length[2];
1257 	u_int8_t desc_list[];
1258 };
1259 
1260 struct scsi_vpd_id_descriptor
1261 {
1262 	u_int8_t	proto_codeset;
1263 #define	SCSI_PROTO_FC		0x00
1264 #define	SCSI_PROTO_SPI		0x01
1265 #define	SCSI_PROTO_SSA		0x02
1266 #define	SCSI_PROTO_1394		0x03
1267 #define	SCSI_PROTO_RDMA		0x04
1268 #define SCSI_PROTO_iSCSI	0x05
1269 #define	SCSI_PROTO_SAS		0x06
1270 #define	SVPD_ID_PROTO_SHIFT	4
1271 #define	SVPD_ID_CODESET_BINARY	0x01
1272 #define	SVPD_ID_CODESET_ASCII	0x02
1273 #define	SVPD_ID_CODESET_MASK	0x0f
1274 	u_int8_t	id_type;
1275 #define	SVPD_ID_PIV		0x80
1276 #define	SVPD_ID_ASSOC_LUN	0x00
1277 #define	SVPD_ID_ASSOC_PORT	0x10
1278 #define	SVPD_ID_ASSOC_TARGET	0x20
1279 #define	SVPD_ID_ASSOC_MASK	0x30
1280 #define	SVPD_ID_TYPE_VENDOR	0x00
1281 #define	SVPD_ID_TYPE_T10	0x01
1282 #define	SVPD_ID_TYPE_EUI64	0x02
1283 #define	SVPD_ID_TYPE_NAA	0x03
1284 #define	SVPD_ID_TYPE_RELTARG	0x04
1285 #define	SVPD_ID_TYPE_TPORTGRP	0x05
1286 #define	SVPD_ID_TYPE_LUNGRP	0x06
1287 #define	SVPD_ID_TYPE_MD5_LUN_ID	0x07
1288 #define	SVPD_ID_TYPE_SCSI_NAME	0x08
1289 #define	SVPD_ID_TYPE_MASK	0x0f
1290 	u_int8_t	reserved;
1291 	u_int8_t	length;
1292 #define	SVPD_DEVICE_ID_DESC_HDR_LEN \
1293     __offsetof(struct scsi_vpd_id_descriptor, identifier)
1294 	u_int8_t	identifier[];
1295 };
1296 
1297 struct scsi_vpd_id_t10
1298 {
1299 	u_int8_t	vendor[8];
1300 	u_int8_t	vendor_spec_id[0];
1301 };
1302 
1303 struct scsi_vpd_id_eui64
1304 {
1305 	u_int8_t	ieee_company_id[3];
1306 	u_int8_t	extension_id[5];
1307 };
1308 
1309 struct scsi_vpd_id_naa_basic
1310 {
1311 	uint8_t naa;
1312 	/* big endian, packed:
1313 	uint8_t	naa : 4;
1314 	uint8_t naa_desig : 4;
1315 	*/
1316 #define	SVPD_ID_NAA_NAA_SHIFT		4
1317 #define	SVPD_ID_NAA_IEEE_EXT		0x02
1318 #define	SVPD_ID_NAA_LOCAL_REG		0x03
1319 #define	SVPD_ID_NAA_IEEE_REG		0x05
1320 #define	SVPD_ID_NAA_IEEE_REG_EXT	0x06
1321 	uint8_t	naa_data[];
1322 };
1323 
1324 struct scsi_vpd_id_naa_ieee_extended_id
1325 {
1326 	uint8_t naa;
1327 	uint8_t vendor_specific_id_a;
1328 	uint8_t ieee_company_id[3];
1329 	uint8_t vendor_specific_id_b[4];
1330 };
1331 
1332 struct scsi_vpd_id_naa_local_reg
1333 {
1334 	uint8_t naa;
1335 	uint8_t local_value[7];
1336 };
1337 
1338 struct scsi_vpd_id_naa_ieee_reg
1339 {
1340 	uint8_t naa;
1341 	uint8_t reg_value[7];
1342 	/* big endian, packed:
1343 	uint8_t naa_basic : 4;
1344 	uint8_t ieee_company_id_0 : 4;
1345 	uint8_t ieee_company_id_1[2];
1346 	uint8_t ieee_company_id_2 : 4;
1347 	uint8_t vendor_specific_id_0 : 4;
1348 	uint8_t vendor_specific_id_1[4];
1349 	*/
1350 };
1351 
1352 struct scsi_vpd_id_naa_ieee_reg_extended
1353 {
1354 	uint8_t naa;
1355 	uint8_t reg_value[15];
1356 	/* big endian, packed:
1357 	uint8_t naa_basic : 4;
1358 	uint8_t ieee_company_id_0 : 4;
1359 	uint8_t ieee_company_id_1[2];
1360 	uint8_t ieee_company_id_2 : 4;
1361 	uint8_t vendor_specific_id_0 : 4;
1362 	uint8_t vendor_specific_id_1[4];
1363 	uint8_t vendor_specific_id_ext[8];
1364 	*/
1365 };
1366 
1367 struct scsi_vpd_id_rel_trgt_port_id
1368 {
1369 	uint8_t obsolete[2];
1370 	uint8_t rel_trgt_port_id[2];
1371 };
1372 
1373 struct scsi_vpd_id_trgt_port_grp_id
1374 {
1375 	uint8_t reserved[2];
1376 	uint8_t trgt_port_grp[2];
1377 };
1378 
1379 struct scsi_vpd_id_lun_grp_id
1380 {
1381 	uint8_t reserved[2];
1382 	uint8_t log_unit_grp[2];
1383 };
1384 
1385 struct scsi_vpd_id_md5_lun_id
1386 {
1387 	uint8_t lun_id[16];
1388 };
1389 
1390 struct scsi_vpd_id_scsi_name
1391 {
1392 	uint8_t name_string[256];
1393 };
1394 
1395 struct scsi_service_action_in
1396 {
1397 	uint8_t opcode;
1398 	uint8_t service_action;
1399 	uint8_t action_dependent[13];
1400 	uint8_t control;
1401 };
1402 
1403 struct scsi_read_capacity
1404 {
1405 	u_int8_t opcode;
1406 	u_int8_t byte2;
1407 #define	SRC_RELADR	0x01
1408 	u_int8_t addr[4];
1409 	u_int8_t unused[2];
1410 	u_int8_t pmi;
1411 #define	SRC_PMI		0x01
1412 	u_int8_t control;
1413 };
1414 
1415 struct scsi_read_capacity_16
1416 {
1417 	uint8_t opcode;
1418 #define	SRC16_SERVICE_ACTION	0x10
1419 	uint8_t service_action;
1420 	uint8_t addr[8];
1421 	uint8_t alloc_len[4];
1422 #define	SRC16_PMI		0x01
1423 #define	SRC16_RELADR		0x02
1424 	uint8_t reladr;
1425 	uint8_t control;
1426 };
1427 
1428 struct scsi_read_capacity_data
1429 {
1430 	u_int8_t addr[4];
1431 	u_int8_t length[4];
1432 };
1433 
1434 struct scsi_read_capacity_data_long
1435 {
1436 	uint8_t addr[8];
1437 	uint8_t length[4];
1438 #define	SRC16_PROT_EN		0x01
1439 #define	SRC16_P_TYPE		0x0e
1440 #define	SRC16_PTYPE_1		0x00
1441 #define	SRC16_PTYPE_2		0x02
1442 #define	SRC16_PTYPE_3		0x04
1443 	uint8_t prot;
1444 #define	SRC16_LBPPBE		0x0f
1445 #define	SRC16_PI_EXPONENT	0xf0
1446 #define	SRC16_PI_EXPONENT_SHIFT	4
1447 	uint8_t prot_lbppbe;
1448 #define	SRC16_LALBA		0x3f
1449 #define	SRC16_LBPRZ		0x40
1450 #define	SRC16_LBPME		0x80
1451 /*
1452  * Alternate versions of these macros that are intended for use on a 16-bit
1453  * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
1454  */
1455 #define	SRC16_LALBA_A		0x3fff
1456 #define	SRC16_LBPRZ_A		0x4000
1457 #define	SRC16_LBPME_A		0x8000
1458 	uint8_t lalba_lbp[2];
1459 	uint8_t	reserved[16];
1460 };
1461 
1462 struct scsi_report_luns
1463 {
1464 	uint8_t opcode;
1465 	uint8_t reserved1;
1466 #define	RPL_REPORT_DEFAULT	0x00
1467 #define	RPL_REPORT_WELLKNOWN	0x01
1468 #define	RPL_REPORT_ALL		0x02
1469 	uint8_t select_report;
1470 	uint8_t reserved2[3];
1471 	uint8_t length[4];
1472 	uint8_t reserved3;
1473 	uint8_t control;
1474 };
1475 
1476 struct scsi_report_luns_lundata {
1477 	uint8_t lundata[8];
1478 #define	RPL_LUNDATA_PERIPH_BUS_MASK	0x3f
1479 #define	RPL_LUNDATA_FLAT_LUN_MASK	0x3f
1480 #define	RPL_LUNDATA_FLAT_LUN_BITS	0x06
1481 #define	RPL_LUNDATA_LUN_TARG_MASK	0x3f
1482 #define	RPL_LUNDATA_LUN_BUS_MASK	0xe0
1483 #define	RPL_LUNDATA_LUN_LUN_MASK	0x1f
1484 #define	RPL_LUNDATA_EXT_LEN_MASK	0x30
1485 #define	RPL_LUNDATA_EXT_EAM_MASK	0x0f
1486 #define	RPL_LUNDATA_EXT_EAM_WK		0x01
1487 #define	RPL_LUNDATA_EXT_EAM_NOT_SPEC	0x0f
1488 #define	RPL_LUNDATA_ATYP_MASK	0xc0	/* MBZ for type 0 lun */
1489 #define	RPL_LUNDATA_ATYP_PERIPH	0x00
1490 #define	RPL_LUNDATA_ATYP_FLAT	0x40
1491 #define	RPL_LUNDATA_ATYP_LUN	0x80
1492 #define	RPL_LUNDATA_ATYP_EXTLUN	0xc0
1493 };
1494 
1495 struct scsi_report_luns_data {
1496 	u_int8_t length[4];	/* length of LUN inventory, in bytes */
1497 	u_int8_t reserved[4];	/* unused */
1498 	/*
1499 	 * LUN inventory- we only support the type zero form for now.
1500 	 */
1501 	struct scsi_report_luns_lundata luns[0];
1502 };
1503 
1504 struct scsi_target_group
1505 {
1506 	uint8_t opcode;
1507 	uint8_t service_action;
1508 #define	STG_PDF_LENGTH		0x00
1509 #define	RPL_PDF_EXTENDED	0x20
1510 	uint8_t reserved1[4];
1511 	uint8_t length[4];
1512 	uint8_t reserved2;
1513 	uint8_t control;
1514 };
1515 
1516 struct scsi_target_port_descriptor {
1517 	uint8_t	reserved[2];
1518 	uint8_t	relative_target_port_identifier[2];
1519 	uint8_t desc_list[];
1520 };
1521 
1522 struct scsi_target_port_group_descriptor {
1523 	uint8_t	pref_state;
1524 #define	TPG_PRIMARY				0x80
1525 #define	TPG_ASYMMETRIC_ACCESS_STATE_MASK	0xf
1526 #define	TPG_ASYMMETRIC_ACCESS_OPTIMIZED		0x0
1527 #define	TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED	0x1
1528 #define	TPG_ASYMMETRIC_ACCESS_STANDBY		0x2
1529 #define	TPG_ASYMMETRIC_ACCESS_UNAVAILABLE	0x3
1530 #define	TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT	0x4
1531 #define	TPG_ASYMMETRIC_ACCESS_OFFLINE		0xE
1532 #define	TPG_ASYMMETRIC_ACCESS_TRANSITIONING	0xF
1533 	uint8_t support;
1534 #define	TPG_AO_SUP	0x01
1535 #define	TPG_AN_SUP	0x02
1536 #define	TPG_S_SUP	0x04
1537 #define	TPG_U_SUP	0x08
1538 #define	TPG_LBD_SUP	0x10
1539 #define	TPG_O_SUP	0x40
1540 #define	TPG_T_SUP	0x80
1541 	uint8_t target_port_group[2];
1542 	uint8_t reserved;
1543 	uint8_t status;
1544 #define TPG_UNAVLBL      0
1545 #define TPG_SET_BY_STPG  0x01
1546 #define TPG_IMPLICIT     0x02
1547 	uint8_t vendor_specific;
1548 	uint8_t	target_port_count;
1549 	struct scsi_target_port_descriptor descriptors[];
1550 };
1551 
1552 struct scsi_target_group_data {
1553 	uint8_t length[4];	/* length of returned data, in bytes */
1554 	struct scsi_target_port_group_descriptor groups[];
1555 };
1556 
1557 struct scsi_target_group_data_extended {
1558 	uint8_t length[4];	/* length of returned data, in bytes */
1559 	uint8_t format_type;	/* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
1560 	uint8_t	implicit_transition_time;
1561 	uint8_t reserved[2];
1562 	struct scsi_target_port_group_descriptor groups[];
1563 };
1564 
1565 
1566 typedef enum {
1567 	SSD_TYPE_NONE,
1568 	SSD_TYPE_FIXED,
1569 	SSD_TYPE_DESC
1570 } scsi_sense_data_type;
1571 
1572 typedef enum {
1573 	SSD_ELEM_NONE,
1574 	SSD_ELEM_SKIP,
1575 	SSD_ELEM_DESC,
1576 	SSD_ELEM_SKS,
1577 	SSD_ELEM_COMMAND,
1578 	SSD_ELEM_INFO,
1579 	SSD_ELEM_FRU,
1580 	SSD_ELEM_STREAM,
1581 	SSD_ELEM_MAX
1582 } scsi_sense_elem_type;
1583 
1584 
1585 struct scsi_sense_data
1586 {
1587 	uint8_t error_code;
1588 	/*
1589 	 * SPC-4 says that the maximum length of sense data is 252 bytes.
1590 	 * So this structure is exactly 252 bytes log.
1591 	 */
1592 #define	SSD_FULL_SIZE 252
1593 	uint8_t sense_buf[SSD_FULL_SIZE - 1];
1594 	/*
1595 	 * XXX KDM is this still a reasonable minimum size?
1596 	 */
1597 #define	SSD_MIN_SIZE 18
1598 	/*
1599 	 * Maximum value for the extra_len field in the sense data.
1600 	 */
1601 #define	SSD_EXTRA_MAX 244
1602 };
1603 
1604 /*
1605  * Fixed format sense data.
1606  */
1607 struct scsi_sense_data_fixed
1608 {
1609 	u_int8_t error_code;
1610 #define	SSD_ERRCODE			0x7F
1611 #define		SSD_CURRENT_ERROR	0x70
1612 #define		SSD_DEFERRED_ERROR	0x71
1613 #define	SSD_ERRCODE_VALID	0x80
1614 	u_int8_t segment;
1615 	u_int8_t flags;
1616 #define	SSD_KEY				0x0F
1617 #define		SSD_KEY_NO_SENSE	0x00
1618 #define		SSD_KEY_RECOVERED_ERROR	0x01
1619 #define		SSD_KEY_NOT_READY	0x02
1620 #define		SSD_KEY_MEDIUM_ERROR	0x03
1621 #define		SSD_KEY_HARDWARE_ERROR	0x04
1622 #define		SSD_KEY_ILLEGAL_REQUEST	0x05
1623 #define		SSD_KEY_UNIT_ATTENTION	0x06
1624 #define		SSD_KEY_DATA_PROTECT	0x07
1625 #define		SSD_KEY_BLANK_CHECK	0x08
1626 #define		SSD_KEY_Vendor_Specific	0x09
1627 #define		SSD_KEY_COPY_ABORTED	0x0a
1628 #define		SSD_KEY_ABORTED_COMMAND	0x0b
1629 #define		SSD_KEY_EQUAL		0x0c
1630 #define		SSD_KEY_VOLUME_OVERFLOW	0x0d
1631 #define		SSD_KEY_MISCOMPARE	0x0e
1632 #define		SSD_KEY_COMPLETED	0x0f
1633 #define	SSD_ILI		0x20
1634 #define	SSD_EOM		0x40
1635 #define	SSD_FILEMARK	0x80
1636 	u_int8_t info[4];
1637 	u_int8_t extra_len;
1638 	u_int8_t cmd_spec_info[4];
1639 	u_int8_t add_sense_code;
1640 	u_int8_t add_sense_code_qual;
1641 	u_int8_t fru;
1642 	u_int8_t sense_key_spec[3];
1643 #define	SSD_SCS_VALID		0x80
1644 #define	SSD_FIELDPTR_CMD	0x40
1645 #define	SSD_BITPTR_VALID	0x08
1646 #define	SSD_BITPTR_VALUE	0x07
1647 	u_int8_t extra_bytes[14];
1648 #define	SSD_FIXED_IS_PRESENT(sense, length, field) 			\
1649 	((length >= (offsetof(struct scsi_sense_data_fixed, field) +	\
1650 	sizeof(sense->field))) ? 1 :0)
1651 #define	SSD_FIXED_IS_FILLED(sense, field) 				\
1652 	((((offsetof(struct scsi_sense_data_fixed, field) +		\
1653 	sizeof(sense->field)) -						\
1654 	(offsetof(struct scsi_sense_data_fixed, extra_len) +		\
1655 	sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
1656 };
1657 
1658 /*
1659  * Descriptor format sense data definitions.
1660  * Introduced in SPC-3.
1661  */
1662 struct scsi_sense_data_desc
1663 {
1664 	uint8_t	error_code;
1665 #define	SSD_DESC_CURRENT_ERROR	0x72
1666 #define	SSD_DESC_DEFERRED_ERROR	0x73
1667 	uint8_t sense_key;
1668 	uint8_t	add_sense_code;
1669 	uint8_t	add_sense_code_qual;
1670 	uint8_t	reserved[3];
1671 	/*
1672 	 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
1673 	 * must be less than or equal to 244.
1674 	 */
1675 	uint8_t	extra_len;
1676 	uint8_t	sense_desc[0];
1677 #define	SSD_DESC_IS_PRESENT(sense, length, field) 			\
1678 	((length >= (offsetof(struct scsi_sense_data_desc, field) +	\
1679 	sizeof(sense->field))) ? 1 :0)
1680 };
1681 
1682 struct scsi_sense_desc_header
1683 {
1684 	uint8_t desc_type;
1685 	uint8_t length;
1686 };
1687 /*
1688  * The information provide in the Information descriptor is device type or
1689  * command specific information, and defined in a command standard.
1690  *
1691  * Note that any changes to the field names or positions in this structure,
1692  * even reserved fields, should be accompanied by an examination of the
1693  * code in ctl_set_sense() that uses them.
1694  *
1695  * Maximum descriptors allowed: 1 (as of SPC-4)
1696  */
1697 struct scsi_sense_info
1698 {
1699 	uint8_t	desc_type;
1700 #define	SSD_DESC_INFO	0x00
1701 	uint8_t	length;
1702 	uint8_t	byte2;
1703 #define	SSD_INFO_VALID	0x80
1704 	uint8_t	reserved;
1705 	uint8_t	info[8];
1706 };
1707 
1708 /*
1709  * Command-specific information depends on the command for which the
1710  * reported condition occured.
1711  *
1712  * Note that any changes to the field names or positions in this structure,
1713  * even reserved fields, should be accompanied by an examination of the
1714  * code in ctl_set_sense() that uses them.
1715  *
1716  * Maximum descriptors allowed: 1 (as of SPC-4)
1717  */
1718 struct scsi_sense_command
1719 {
1720 	uint8_t	desc_type;
1721 #define	SSD_DESC_COMMAND	0x01
1722 	uint8_t	length;
1723 	uint8_t	reserved[2];
1724 	uint8_t	command_info[8];
1725 };
1726 
1727 /*
1728  * Sense key specific descriptor.  The sense key specific data format
1729  * depends on the sense key in question.
1730  *
1731  * Maximum descriptors allowed: 1 (as of SPC-4)
1732  */
1733 struct scsi_sense_sks
1734 {
1735 	uint8_t	desc_type;
1736 #define	SSD_DESC_SKS		0x02
1737 	uint8_t	length;
1738 	uint8_t reserved1[2];
1739 	uint8_t	sense_key_spec[3];
1740 #define	SSD_SKS_VALID		0x80
1741 	uint8_t reserved2;
1742 };
1743 
1744 /*
1745  * This is used for the Illegal Request sense key (0x05) only.
1746  */
1747 struct scsi_sense_sks_field
1748 {
1749 	uint8_t	byte0;
1750 #define	SSD_SKS_FIELD_VALID	0x80
1751 #define	SSD_SKS_FIELD_CMD	0x40
1752 #define	SSD_SKS_BPV		0x08
1753 #define	SSD_SKS_BIT_VALUE	0x07
1754 	uint8_t	field[2];
1755 };
1756 
1757 
1758 /*
1759  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
1760  * Recovered Error (0x01) sense keys.
1761  */
1762 struct scsi_sense_sks_retry
1763 {
1764 	uint8_t byte0;
1765 #define	SSD_SKS_RETRY_VALID	0x80
1766 	uint8_t actual_retry_count[2];
1767 };
1768 
1769 /*
1770  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
1771  */
1772 struct scsi_sense_sks_progress
1773 {
1774 	uint8_t byte0;
1775 #define	SSD_SKS_PROGRESS_VALID	0x80
1776 	uint8_t progress[2];
1777 #define	SSD_SKS_PROGRESS_DENOM	0x10000
1778 };
1779 
1780 /*
1781  * Used with the Copy Aborted (0x0a) sense key.
1782  */
1783 struct scsi_sense_sks_segment
1784 {
1785 	uint8_t byte0;
1786 #define	SSD_SKS_SEGMENT_VALID	0x80
1787 #define	SSD_SKS_SEGMENT_SD	0x20
1788 #define	SSD_SKS_SEGMENT_BPV	0x08
1789 #define	SSD_SKS_SEGMENT_BITPTR	0x07
1790 	uint8_t field[2];
1791 };
1792 
1793 /*
1794  * Used with the Unit Attention (0x06) sense key.
1795  *
1796  * This is currently used to indicate that the unit attention condition
1797  * queue has overflowed (when the overflow bit is set).
1798  */
1799 struct scsi_sense_sks_overflow
1800 {
1801 	uint8_t byte0;
1802 #define	SSD_SKS_OVERFLOW_VALID	0x80
1803 #define	SSD_SKS_OVERFLOW_SET	0x01
1804 	uint8_t	reserved[2];
1805 };
1806 
1807 /*
1808  * This specifies which component is associated with the sense data.  There
1809  * is no standard meaning for the fru value.
1810  *
1811  * Maximum descriptors allowed: 1 (as of SPC-4)
1812  */
1813 struct scsi_sense_fru
1814 {
1815 	uint8_t	desc_type;
1816 #define	SSD_DESC_FRU		0x03
1817 	uint8_t	length;
1818 	uint8_t reserved;
1819 	uint8_t fru;
1820 };
1821 
1822 /*
1823  * Used for Stream commands, defined in SSC-4.
1824  *
1825  * Maximum descriptors allowed: 1 (as of SPC-4)
1826  */
1827 
1828 struct scsi_sense_stream
1829 {
1830 	uint8_t	desc_type;
1831 #define	SSD_DESC_STREAM		0x04
1832 	uint8_t	length;
1833 	uint8_t	reserved;
1834 	uint8_t	byte3;
1835 #define	SSD_DESC_STREAM_FM	0x80
1836 #define	SSD_DESC_STREAM_EOM	0x40
1837 #define	SSD_DESC_STREAM_ILI	0x20
1838 };
1839 
1840 /*
1841  * Used for Block commands, defined in SBC-3.
1842  *
1843  * This is currently (as of SBC-3) only used for the Incorrect Length
1844  * Indication (ILI) bit, which says that the data length requested in the
1845  * READ LONG or WRITE LONG command did not match the length of the logical
1846  * block.
1847  *
1848  * Maximum descriptors allowed: 1 (as of SPC-4)
1849  */
1850 struct scsi_sense_block
1851 {
1852 	uint8_t	desc_type;
1853 #define	SSD_DESC_BLOCK		0x05
1854 	uint8_t	length;
1855 	uint8_t	reserved;
1856 	uint8_t	byte3;
1857 #define	SSD_DESC_BLOCK_ILI	0x20
1858 };
1859 
1860 /*
1861  * Used for Object-Based Storage Devices (OSD-3).
1862  *
1863  * Maximum descriptors allowed: 1 (as of SPC-4)
1864  */
1865 struct scsi_sense_osd_objid
1866 {
1867 	uint8_t	desc_type;
1868 #define	SSD_DESC_OSD_OBJID	0x06
1869 	uint8_t	length;
1870 	uint8_t	reserved[6];
1871 	/*
1872 	 * XXX KDM provide the bit definitions here?  There are a lot of
1873 	 * them, and we don't have an OSD driver yet.
1874 	 */
1875 	uint8_t	not_init_cmds[4];
1876 	uint8_t	completed_cmds[4];
1877 	uint8_t	partition_id[8];
1878 	uint8_t	object_id[8];
1879 };
1880 
1881 /*
1882  * Used for Object-Based Storage Devices (OSD-3).
1883  *
1884  * Maximum descriptors allowed: 1 (as of SPC-4)
1885  */
1886 struct scsi_sense_osd_integrity
1887 {
1888 	uint8_t	desc_type;
1889 #define	SSD_DESC_OSD_INTEGRITY	0x07
1890 	uint8_t	length;
1891 	uint8_t	integ_check_val[32];
1892 };
1893 
1894 /*
1895  * Used for Object-Based Storage Devices (OSD-3).
1896  *
1897  * Maximum descriptors allowed: 1 (as of SPC-4)
1898  */
1899 struct scsi_sense_osd_attr_id
1900 {
1901 	uint8_t	desc_type;
1902 #define	SSD_DESC_OSD_ATTR_ID	0x08
1903 	uint8_t	length;
1904 	uint8_t	reserved[2];
1905 	uint8_t	attr_desc[0];
1906 };
1907 
1908 /*
1909  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
1910  *
1911  * Maximum descriptors allowed: 32 (as of SPC-4)
1912  */
1913 struct scsi_sense_progress
1914 {
1915 	uint8_t	desc_type;
1916 #define	SSD_DESC_PROGRESS	0x0a
1917 	uint8_t	length;
1918 	uint8_t	sense_key;
1919 	uint8_t	add_sense_code;
1920 	uint8_t	add_sense_code_qual;
1921 	uint8_t reserved;
1922 	uint8_t	progress[2];
1923 };
1924 
1925 /*
1926  * This is typically forwarded as the result of an EXTENDED COPY command.
1927  *
1928  * Maximum descriptors allowed: 2 (as of SPC-4)
1929  */
1930 struct scsi_sense_forwarded
1931 {
1932 	uint8_t	desc_type;
1933 #define	SSD_DESC_FORWARDED	0x0c
1934 	uint8_t	length;
1935 	uint8_t	byte2;
1936 #define	SSD_FORWARDED_FSDT	0x80
1937 #define	SSD_FORWARDED_SDS_MASK	0x0f
1938 #define	SSD_FORWARDED_SDS_UNK	0x00
1939 #define	SSD_FORWARDED_SDS_EXSRC	0x01
1940 #define	SSD_FORWARDED_SDS_EXDST	0x02
1941 };
1942 
1943 /*
1944  * Vendor-specific sense descriptor.  The desc_type field will be in the
1945  * range bewteen MIN and MAX inclusive.
1946  */
1947 struct scsi_sense_vendor
1948 {
1949 	uint8_t	desc_type;
1950 #define	SSD_DESC_VENDOR_MIN	0x80
1951 #define	SSD_DESC_VENDOR_MAX	0xff
1952 	uint8_t length;
1953 	uint8_t	data[0];
1954 };
1955 
1956 struct scsi_mode_header_6
1957 {
1958 	u_int8_t data_length;	/* Sense data length */
1959 	u_int8_t medium_type;
1960 	u_int8_t dev_spec;
1961 	u_int8_t blk_desc_len;
1962 };
1963 
1964 struct scsi_mode_header_10
1965 {
1966 	u_int8_t data_length[2];/* Sense data length */
1967 	u_int8_t medium_type;
1968 	u_int8_t dev_spec;
1969 	u_int8_t unused[2];
1970 	u_int8_t blk_desc_len[2];
1971 };
1972 
1973 struct scsi_mode_page_header
1974 {
1975 	u_int8_t page_code;
1976 #define	SMPH_PS		0x80
1977 #define	SMPH_SPF	0x40
1978 #define	SMPH_PC_MASK	0x3f
1979 	u_int8_t page_length;
1980 };
1981 
1982 struct scsi_mode_page_header_sp
1983 {
1984 	uint8_t page_code;
1985 	uint8_t subpage;
1986 	uint8_t page_length[2];
1987 };
1988 
1989 
1990 struct scsi_mode_blk_desc
1991 {
1992 	u_int8_t density;
1993 	u_int8_t nblocks[3];
1994 	u_int8_t reserved;
1995 	u_int8_t blklen[3];
1996 };
1997 
1998 #define	SCSI_DEFAULT_DENSITY	0x00	/* use 'default' density */
1999 #define	SCSI_SAME_DENSITY	0x7f	/* use 'same' density- >= SCSI-2 only */
2000 
2001 
2002 /*
2003  * Status Byte
2004  */
2005 #define	SCSI_STATUS_OK			0x00
2006 #define	SCSI_STATUS_CHECK_COND		0x02
2007 #define	SCSI_STATUS_COND_MET		0x04
2008 #define	SCSI_STATUS_BUSY		0x08
2009 #define	SCSI_STATUS_INTERMED		0x10
2010 #define	SCSI_STATUS_INTERMED_COND_MET	0x14
2011 #define	SCSI_STATUS_RESERV_CONFLICT	0x18
2012 #define	SCSI_STATUS_CMD_TERMINATED	0x22	/* Obsolete in SAM-2 */
2013 #define	SCSI_STATUS_QUEUE_FULL		0x28
2014 #define	SCSI_STATUS_ACA_ACTIVE		0x30
2015 #define	SCSI_STATUS_TASK_ABORTED	0x40
2016 
2017 struct scsi_inquiry_pattern {
2018 	u_int8_t   type;
2019 	u_int8_t   media_type;
2020 #define	SIP_MEDIA_REMOVABLE	0x01
2021 #define	SIP_MEDIA_FIXED		0x02
2022 	const char *vendor;
2023 	const char *product;
2024 	const char *revision;
2025 };
2026 
2027 struct scsi_static_inquiry_pattern {
2028 	u_int8_t   type;
2029 	u_int8_t   media_type;
2030 	char       vendor[SID_VENDOR_SIZE+1];
2031 	char       product[SID_PRODUCT_SIZE+1];
2032 	char       revision[SID_REVISION_SIZE+1];
2033 };
2034 
2035 struct scsi_sense_quirk_entry {
2036 	struct scsi_inquiry_pattern	inq_pat;
2037 	int				num_sense_keys;
2038 	int				num_ascs;
2039 	struct sense_key_table_entry	*sense_key_info;
2040 	struct asc_table_entry		*asc_info;
2041 };
2042 
2043 struct sense_key_table_entry {
2044 	u_int8_t    sense_key;
2045 	u_int32_t   action;
2046 	const char *desc;
2047 };
2048 
2049 struct asc_table_entry {
2050 	u_int8_t    asc;
2051 	u_int8_t    ascq;
2052 	u_int32_t   action;
2053 	const char *desc;
2054 };
2055 
2056 struct op_table_entry {
2057 	u_int8_t    opcode;
2058 	u_int32_t   opmask;
2059 	const char  *desc;
2060 };
2061 
2062 struct scsi_op_quirk_entry {
2063 	struct scsi_inquiry_pattern	inq_pat;
2064 	int				num_ops;
2065 	struct op_table_entry		*op_table;
2066 };
2067 
2068 typedef enum {
2069 	SSS_FLAG_NONE		= 0x00,
2070 	SSS_FLAG_PRINT_COMMAND	= 0x01
2071 } scsi_sense_string_flags;
2072 
2073 struct ccb_scsiio;
2074 struct cam_periph;
2075 union  ccb;
2076 #ifndef _KERNEL
2077 struct cam_device;
2078 #endif
2079 
2080 extern const char *scsi_sense_key_text[];
2081 
2082 struct sbuf;
2083 
2084 __BEGIN_DECLS
2085 void scsi_sense_desc(int sense_key, int asc, int ascq,
2086 		     struct scsi_inquiry_data *inq_data,
2087 		     const char **sense_key_desc, const char **asc_desc);
2088 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
2089 				    struct scsi_inquiry_data *inq_data,
2090 				    u_int32_t sense_flags);
2091 const char *	scsi_status_string(struct ccb_scsiio *csio);
2092 
2093 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
2094 		       int (*iter_func)(struct scsi_sense_data_desc *sense,
2095 					u_int, struct scsi_sense_desc_header *,
2096 					void *), void *arg);
2097 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
2098 			uint8_t desc_type);
2099 void scsi_set_sense_data(struct scsi_sense_data *sense_data,
2100 			 scsi_sense_data_type sense_format, int current_error,
2101 			 int sense_key, int asc, int ascq, ...) ;
2102 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
2103 			    scsi_sense_data_type sense_format,
2104 			    int current_error, int sense_key, int asc,
2105 			    int ascq, va_list ap);
2106 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
2107 			uint8_t info_type, uint64_t *info,
2108 			int64_t *signed_info);
2109 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
2110 		 uint8_t *sks);
2111 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
2112 			struct scsi_inquiry_data *inq_data,
2113 			uint8_t *block_bits);
2114 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
2115 			 struct scsi_inquiry_data *inq_data,
2116 			 uint8_t *stream_bits);
2117 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2118 		    struct scsi_inquiry_data *inq_data, uint64_t info);
2119 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
2120 		       struct scsi_inquiry_data *inq_data, uint64_t csi);
2121 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
2122 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
2123 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
2124 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
2125 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
2126 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2127 			  u_int sense_len, uint8_t *cdb, int cdb_len,
2128 			  struct scsi_inquiry_data *inq_data,
2129 			  struct scsi_sense_desc_header *header);
2130 
2131 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2132 			     u_int sense_len, uint8_t *cdb, int cdb_len,
2133 			     struct scsi_inquiry_data *inq_data,
2134 			     struct scsi_sense_desc_header *header);
2135 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2136 			 u_int sense_len, uint8_t *cdb, int cdb_len,
2137 			 struct scsi_inquiry_data *inq_data,
2138 			 struct scsi_sense_desc_header *header);
2139 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2140 			 u_int sense_len, uint8_t *cdb, int cdb_len,
2141 			 struct scsi_inquiry_data *inq_data,
2142 			 struct scsi_sense_desc_header *header);
2143 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2144 			    u_int sense_len, uint8_t *cdb, int cdb_len,
2145 			    struct scsi_inquiry_data *inq_data,
2146 			    struct scsi_sense_desc_header *header);
2147 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2148 			   u_int sense_len, uint8_t *cdb, int cdb_len,
2149 			   struct scsi_inquiry_data *inq_data,
2150 			   struct scsi_sense_desc_header *header);
2151 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2152 			      u_int sense_len, uint8_t *cdb, int cdb_len,
2153 			      struct scsi_inquiry_data *inq_data,
2154 			      struct scsi_sense_desc_header *header);
2155 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2156 			     u_int sense_len, uint8_t *cdb, int cdb_len,
2157 			     struct scsi_inquiry_data *inq_data,
2158 			     struct scsi_sense_desc_header *header);
2159 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
2160 			  u_int sense_len, uint8_t *cdb, int cdb_len,
2161 			  struct scsi_inquiry_data *inq_data,
2162 			  struct scsi_sense_desc_header *header);
2163 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
2164 
2165 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
2166 			  struct sbuf *sb, char *path_str,
2167 			  struct scsi_inquiry_data *inq_data, uint8_t *cdb,
2168 			  int cdb_len);
2169 
2170 #ifdef _KERNEL
2171 int		scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
2172 int		scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
2173 				scsi_sense_string_flags flags);
2174 char *		scsi_sense_string(struct ccb_scsiio *csio,
2175 				  char *str, int str_len);
2176 void		scsi_sense_print(struct ccb_scsiio *csio);
2177 int		scsi_interpret_sense(union ccb *ccb,
2178 				     u_int32_t sense_flags,
2179 				     u_int32_t *relsim_flags,
2180 				     u_int32_t *reduction,
2181 				     u_int32_t *timeout,
2182 				     scsi_sense_action error_action);
2183 #else /* _KERNEL */
2184 int		scsi_command_string(struct cam_device *device,
2185 				    struct ccb_scsiio *csio, struct sbuf *sb);
2186 int		scsi_sense_sbuf(struct cam_device *device,
2187 				struct ccb_scsiio *csio, struct sbuf *sb,
2188 				scsi_sense_string_flags flags);
2189 char *		scsi_sense_string(struct cam_device *device,
2190 				  struct ccb_scsiio *csio,
2191 				  char *str, int str_len);
2192 void		scsi_sense_print(struct cam_device *device,
2193 				 struct ccb_scsiio *csio, FILE *ofile);
2194 int		scsi_interpret_sense(struct cam_device *device,
2195 				     union ccb *ccb,
2196 				     u_int32_t sense_flags,
2197 				     u_int32_t *relsim_flags,
2198 				     u_int32_t *reduction,
2199 				     u_int32_t *timeout,
2200 				     scsi_sense_action error_action);
2201 #endif /* _KERNEL */
2202 
2203 #define	SF_RETRY_UA	0x01
2204 #define	SF_NO_PRINT	0x02
2205 #define	SF_QUIET_IR	0x04	/* Be quiet about Illegal Request reponses */
2206 #define	SF_PRINT_ALWAYS	0x08
2207 
2208 
2209 const char *	scsi_op_desc(u_int16_t opcode,
2210 			     struct scsi_inquiry_data *inq_data);
2211 char *		scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
2212 				size_t len);
2213 
2214 void		scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
2215 
2216 u_int		scsi_calc_syncsrate(u_int period_factor);
2217 u_int		scsi_calc_syncparam(u_int period);
2218 
2219 typedef int	(*scsi_devid_checkfn_t)(uint8_t *);
2220 int		scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
2221 int		scsi_devid_is_sas_target(uint8_t *bufp);
2222 uint8_t *	scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
2223 			       scsi_devid_checkfn_t ck_fn);
2224 
2225 void		scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
2226 				     void (*cbfcnp)(struct cam_periph *,
2227 						    union ccb *),
2228 				     u_int8_t tag_action,
2229 				     u_int8_t sense_len, u_int32_t timeout);
2230 
2231 void		scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
2232 				   void (*cbfcnp)(struct cam_periph *,
2233 						  union ccb *),
2234 				   void *data_ptr, u_int8_t dxfer_len,
2235 				   u_int8_t tag_action, u_int8_t sense_len,
2236 				   u_int32_t timeout);
2237 
2238 void		scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
2239 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
2240 			     u_int8_t tag_action, u_int8_t *inq_buf,
2241 			     u_int32_t inq_len, int evpd, u_int8_t page_code,
2242 			     u_int8_t sense_len, u_int32_t timeout);
2243 
2244 void		scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
2245 				void (*cbfcnp)(struct cam_periph *,
2246 					       union ccb *),
2247 				u_int8_t tag_action, int dbd,
2248 				u_int8_t page_code, u_int8_t page,
2249 				u_int8_t *param_buf, u_int32_t param_len,
2250 				u_int8_t sense_len, u_int32_t timeout);
2251 
2252 void		scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
2253 				    void (*cbfcnp)(struct cam_periph *,
2254 						   union ccb *),
2255 				    u_int8_t tag_action, int dbd,
2256 				    u_int8_t page_code, u_int8_t page,
2257 				    u_int8_t *param_buf, u_int32_t param_len,
2258 				    int minimum_cmd_size, u_int8_t sense_len,
2259 				    u_int32_t timeout);
2260 
2261 void		scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
2262 				 void (*cbfcnp)(struct cam_periph *,
2263 						union ccb *),
2264 				 u_int8_t tag_action, int scsi_page_fmt,
2265 				 int save_pages, u_int8_t *param_buf,
2266 				 u_int32_t param_len, u_int8_t sense_len,
2267 				 u_int32_t timeout);
2268 
2269 void		scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
2270 				     void (*cbfcnp)(struct cam_periph *,
2271 						    union ccb *),
2272 				     u_int8_t tag_action, int scsi_page_fmt,
2273 				     int save_pages, u_int8_t *param_buf,
2274 				     u_int32_t param_len, int minimum_cmd_size,
2275 				     u_int8_t sense_len, u_int32_t timeout);
2276 
2277 void		scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
2278 			       void (*cbfcnp)(struct cam_periph *, union ccb *),
2279 			       u_int8_t tag_action, u_int8_t page_code,
2280 			       u_int8_t page, int save_pages, int ppc,
2281 			       u_int32_t paramptr, u_int8_t *param_buf,
2282 			       u_int32_t param_len, u_int8_t sense_len,
2283 			       u_int32_t timeout);
2284 
2285 void		scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
2286 				void (*cbfcnp)(struct cam_periph *,
2287 				union ccb *), u_int8_t tag_action,
2288 				u_int8_t page_code, int save_pages,
2289 				int pc_reset, u_int8_t *param_buf,
2290 				u_int32_t param_len, u_int8_t sense_len,
2291 				u_int32_t timeout);
2292 
2293 void		scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
2294 			     void (*cbfcnp)(struct cam_periph *, union ccb *),
2295 			     u_int8_t tag_action, u_int8_t action,
2296 			     u_int8_t sense_len, u_int32_t timeout);
2297 
2298 void		scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
2299 				   void (*cbfcnp)(struct cam_periph *,
2300 				   union ccb *), u_int8_t tag_action,
2301 				   struct scsi_read_capacity_data *,
2302 				   u_int8_t sense_len, u_int32_t timeout);
2303 void		scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
2304 				      void (*cbfcnp)(struct cam_periph *,
2305 				      union ccb *), uint8_t tag_action,
2306 				      uint64_t lba, int reladr, int pmi,
2307 				      uint8_t *rcap_buf, int rcap_buf_len,
2308 				      uint8_t sense_len, uint32_t timeout);
2309 
2310 void		scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
2311 				 void (*cbfcnp)(struct cam_periph *,
2312 				 union ccb *), u_int8_t tag_action,
2313 				 u_int8_t select_report,
2314 				 struct scsi_report_luns_data *rpl_buf,
2315 				 u_int32_t alloc_len, u_int8_t sense_len,
2316 				 u_int32_t timeout);
2317 
2318 void		scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2319 				 void (*cbfcnp)(struct cam_periph *,
2320 				 union ccb *), u_int8_t tag_action,
2321 				 u_int8_t pdf,
2322 				 void *buf,
2323 				 u_int32_t alloc_len, u_int8_t sense_len,
2324 				 u_int32_t timeout);
2325 
2326 void		scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
2327 				 void (*cbfcnp)(struct cam_periph *,
2328 				 union ccb *), u_int8_t tag_action, void *buf,
2329 				 u_int32_t alloc_len, u_int8_t sense_len,
2330 				 u_int32_t timeout);
2331 
2332 void		scsi_synchronize_cache(struct ccb_scsiio *csio,
2333 				       u_int32_t retries,
2334 				       void (*cbfcnp)(struct cam_periph *,
2335 				       union ccb *), u_int8_t tag_action,
2336 				       u_int32_t begin_lba, u_int16_t lb_count,
2337 				       u_int8_t sense_len, u_int32_t timeout);
2338 
2339 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
2340 				     void (*cbfcnp)(struct cam_periph *,
2341 						    union ccb*),
2342 				     uint8_t tag_action, int pcv,
2343 				     uint8_t page_code, uint8_t *data_ptr,
2344 				     uint16_t allocation_length,
2345 				     uint8_t sense_len, uint32_t timeout);
2346 
2347 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
2348 			  void (*cbfcnp)(struct cam_periph *, union ccb *),
2349 			  uint8_t tag_action, int unit_offline,
2350 			  int device_offline, int self_test, int page_format,
2351 			  int self_test_code, uint8_t *data_ptr,
2352 			  uint16_t param_list_length, uint8_t sense_len,
2353 			  uint32_t timeout);
2354 
2355 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
2356 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
2357 		     u_int8_t tag_action, int readop, u_int8_t byte2,
2358 		     int minimum_cmd_size, u_int64_t lba,
2359 		     u_int32_t block_count, u_int8_t *data_ptr,
2360 		     u_int32_t dxfer_len, u_int8_t sense_len,
2361 		     u_int32_t timeout);
2362 
2363 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
2364 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
2365 		     u_int8_t tag_action, u_int8_t byte2,
2366 		     int minimum_cmd_size, u_int64_t lba,
2367 		     u_int32_t block_count, u_int8_t *data_ptr,
2368 		     u_int32_t dxfer_len, u_int8_t sense_len,
2369 		     u_int32_t timeout);
2370 
2371 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
2372 		void (*cbfcnp)(struct cam_periph *, union ccb *),
2373 		u_int8_t tag_action, u_int8_t byte2,
2374 		u_int8_t *data_ptr, u_int16_t dxfer_len,
2375 		u_int8_t sense_len, u_int32_t timeout);
2376 
2377 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
2378 		     void (*cbfcnp)(struct cam_periph *, union ccb *),
2379 		     u_int8_t tag_action, int start, int load_eject,
2380 		     int immediate, u_int8_t sense_len, u_int32_t timeout);
2381 
2382 int		scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
2383 int		scsi_static_inquiry_match(caddr_t inqbuffer,
2384 					  caddr_t table_entry);
2385 int		scsi_devid_match(uint8_t *rhs, size_t rhs_len,
2386 				 uint8_t *lhs, size_t lhs_len);
2387 
2388 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
2389 			int *sense_key, int *asc, int *ascq);
2390 void scsi_extract_sense_len(struct scsi_sense_data *sense,
2391 			    u_int sense_len, int *error_code, int *sense_key,
2392 			    int *asc, int *ascq, int show_errors);
2393 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
2394 		       int show_errors);
2395 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
2396 		 int show_errors);
2397 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
2398 		  int show_errors);
2399 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
2400 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
2401 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
2402 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
2403 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
2404 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
2405 static __inline int32_t scsi_3btol(const uint8_t *bytes);
2406 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
2407 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
2408 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
2409 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
2410 
2411 static __inline void
2412 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
2413 {
2414 
2415 	bytes[0] = (val >> 8) & 0xff;
2416 	bytes[1] = val & 0xff;
2417 }
2418 
2419 static __inline void
2420 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
2421 {
2422 
2423 	bytes[0] = (val >> 16) & 0xff;
2424 	bytes[1] = (val >> 8) & 0xff;
2425 	bytes[2] = val & 0xff;
2426 }
2427 
2428 static __inline void
2429 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
2430 {
2431 
2432 	bytes[0] = (val >> 24) & 0xff;
2433 	bytes[1] = (val >> 16) & 0xff;
2434 	bytes[2] = (val >> 8) & 0xff;
2435 	bytes[3] = val & 0xff;
2436 }
2437 
2438 static __inline void
2439 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
2440 {
2441 
2442 	bytes[0] = (val >> 56) & 0xff;
2443 	bytes[1] = (val >> 48) & 0xff;
2444 	bytes[2] = (val >> 40) & 0xff;
2445 	bytes[3] = (val >> 32) & 0xff;
2446 	bytes[4] = (val >> 24) & 0xff;
2447 	bytes[5] = (val >> 16) & 0xff;
2448 	bytes[6] = (val >> 8) & 0xff;
2449 	bytes[7] = val & 0xff;
2450 }
2451 
2452 static __inline uint32_t
2453 scsi_2btoul(const uint8_t *bytes)
2454 {
2455 	uint32_t rv;
2456 
2457 	rv = (bytes[0] << 8) |
2458 	     bytes[1];
2459 	return (rv);
2460 }
2461 
2462 static __inline uint32_t
2463 scsi_3btoul(const uint8_t *bytes)
2464 {
2465 	uint32_t rv;
2466 
2467 	rv = (bytes[0] << 16) |
2468 	     (bytes[1] << 8) |
2469 	     bytes[2];
2470 	return (rv);
2471 }
2472 
2473 static __inline int32_t
2474 scsi_3btol(const uint8_t *bytes)
2475 {
2476 	uint32_t rc = scsi_3btoul(bytes);
2477 
2478 	if (rc & 0x00800000)
2479 		rc |= 0xff000000;
2480 
2481 	return (int32_t) rc;
2482 }
2483 
2484 static __inline uint32_t
2485 scsi_4btoul(const uint8_t *bytes)
2486 {
2487 	uint32_t rv;
2488 
2489 	rv = (bytes[0] << 24) |
2490 	     (bytes[1] << 16) |
2491 	     (bytes[2] << 8) |
2492 	     bytes[3];
2493 	return (rv);
2494 }
2495 
2496 static __inline uint64_t
2497 scsi_8btou64(const uint8_t *bytes)
2498 {
2499         uint64_t rv;
2500 
2501 	rv = (((uint64_t)bytes[0]) << 56) |
2502 	     (((uint64_t)bytes[1]) << 48) |
2503 	     (((uint64_t)bytes[2]) << 40) |
2504 	     (((uint64_t)bytes[3]) << 32) |
2505 	     (((uint64_t)bytes[4]) << 24) |
2506 	     (((uint64_t)bytes[5]) << 16) |
2507 	     (((uint64_t)bytes[6]) << 8) |
2508 	     bytes[7];
2509 	return (rv);
2510 }
2511 
2512 /*
2513  * Given the pointer to a returned mode sense buffer, return a pointer to
2514  * the start of the first mode page.
2515  */
2516 static __inline void *
2517 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
2518 {
2519 	void *page_start;
2520 
2521 	page_start = (void *)((u_int8_t *)&mode_header[1] +
2522 			      mode_header->blk_desc_len);
2523 
2524 	return(page_start);
2525 }
2526 
2527 static __inline void *
2528 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
2529 {
2530 	void *page_start;
2531 
2532 	page_start = (void *)((u_int8_t *)&mode_header[1] +
2533 			       scsi_2btoul(mode_header->blk_desc_len));
2534 
2535 	return(page_start);
2536 }
2537 
2538 __END_DECLS
2539 
2540 #endif /*_SCSI_SCSI_ALL_H*/
2541