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