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