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