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