scsi_all.h revision 272632 
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 272632 2014-10-06 13:21:13Z 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#define	SWS_NDOB	0x01
1034	uint8_t	addr[8];
1035	uint8_t	length[4];
1036	uint8_t	group;
1037	uint8_t	control;
1038};
1039
1040struct scsi_unmap
1041{
1042	uint8_t	opcode;
1043	uint8_t	byte2;
1044#define	SU_ANCHOR	0x01
1045	uint8_t	reserved[4];
1046	uint8_t	group;
1047	uint8_t	length[2];
1048	uint8_t	control;
1049};
1050
1051struct scsi_unmap_header
1052{
1053	uint8_t	length[2];
1054	uint8_t	desc_length[2];
1055	uint8_t	reserved[4];
1056};
1057
1058struct scsi_unmap_desc
1059{
1060	uint8_t	lba[8];
1061	uint8_t	length[4];
1062	uint8_t	reserved[4];
1063};
1064
1065struct scsi_write_verify_10
1066{
1067	uint8_t	opcode;
1068	uint8_t	byte2;
1069#define	SWV_BYTCHK		0x02
1070#define	SWV_DPO			0x10
1071#define	SWV_WRPROECT_MASK	0xe0
1072	uint8_t	addr[4];
1073	uint8_t	group;
1074	uint8_t length[2];
1075	uint8_t	control;
1076};
1077
1078struct scsi_write_verify_12
1079{
1080	uint8_t	opcode;
1081	uint8_t	byte2;
1082	uint8_t	addr[4];
1083	uint8_t	length[4];
1084	uint8_t	group;
1085	uint8_t	control;
1086};
1087
1088struct scsi_write_verify_16
1089{
1090	uint8_t	opcode;
1091	uint8_t	byte2;
1092	uint8_t	addr[8];
1093	uint8_t	length[4];
1094	uint8_t	group;
1095	uint8_t	control;
1096};
1097
1098
1099struct scsi_start_stop_unit
1100{
1101	u_int8_t opcode;
1102	u_int8_t byte2;
1103#define	SSS_IMMED		0x01
1104	u_int8_t reserved[2];
1105	u_int8_t how;
1106#define	SSS_START		0x01
1107#define	SSS_LOEJ		0x02
1108#define	SSS_PC_MASK		0xf0
1109#define	SSS_PC_START_VALID	0x00
1110#define	SSS_PC_ACTIVE		0x10
1111#define	SSS_PC_IDLE		0x20
1112#define	SSS_PC_STANDBY		0x30
1113#define	SSS_PC_LU_CONTROL	0x70
1114#define	SSS_PC_FORCE_IDLE_0	0xa0
1115#define	SSS_PC_FORCE_STANDBY_0	0xb0
1116	u_int8_t control;
1117};
1118
1119struct ata_pass_12 {
1120	u_int8_t opcode;
1121	u_int8_t protocol;
1122#define	AP_PROTO_HARD_RESET	(0x00 << 1)
1123#define	AP_PROTO_SRST		(0x01 << 1)
1124#define	AP_PROTO_NON_DATA	(0x03 << 1)
1125#define	AP_PROTO_PIO_IN		(0x04 << 1)
1126#define	AP_PROTO_PIO_OUT	(0x05 << 1)
1127#define	AP_PROTO_DMA		(0x06 << 1)
1128#define	AP_PROTO_DMA_QUEUED	(0x07 << 1)
1129#define	AP_PROTO_DEVICE_DIAG	(0x08 << 1)
1130#define	AP_PROTO_DEVICE_RESET	(0x09 << 1)
1131#define	AP_PROTO_UDMA_IN	(0x0a << 1)
1132#define	AP_PROTO_UDMA_OUT	(0x0b << 1)
1133#define	AP_PROTO_FPDMA		(0x0c << 1)
1134#define	AP_PROTO_RESP_INFO	(0x0f << 1)
1135#define	AP_MULTI	0xe0
1136	u_int8_t flags;
1137#define	AP_T_LEN	0x03
1138#define	AP_BB		0x04
1139#define	AP_T_DIR	0x08
1140#define	AP_CK_COND	0x20
1141#define	AP_OFFLINE	0x60
1142	u_int8_t features;
1143	u_int8_t sector_count;
1144	u_int8_t lba_low;
1145	u_int8_t lba_mid;
1146	u_int8_t lba_high;
1147	u_int8_t device;
1148	u_int8_t command;
1149	u_int8_t reserved;
1150	u_int8_t control;
1151};
1152
1153struct scsi_maintenance_in
1154{
1155        uint8_t  opcode;
1156        uint8_t  byte2;
1157#define SERVICE_ACTION_MASK  0x1f
1158#define SA_RPRT_TRGT_GRP     0x0a
1159        uint8_t  reserved[4];
1160	uint8_t  length[4];
1161	uint8_t  reserved1;
1162	uint8_t  control;
1163};
1164
1165struct scsi_report_supported_opcodes
1166{
1167        uint8_t  opcode;
1168        uint8_t  service_action;
1169        uint8_t  options;
1170#define RSO_RCTD		0x80
1171#define RSO_OPTIONS_MASK	0x07
1172#define RSO_OPTIONS_ALL		0x00
1173#define RSO_OPTIONS_OC		0x01
1174#define RSO_OPTIONS_OC_SA	0x02
1175        uint8_t  requested_opcode;
1176        uint8_t  requested_service_action[2];
1177	uint8_t  length[4];
1178	uint8_t  reserved1;
1179	uint8_t  control;
1180};
1181
1182struct scsi_report_supported_opcodes_timeout
1183{
1184	uint8_t  length[2];
1185	uint8_t  reserved;
1186	uint8_t  cmd_specific;
1187	uint8_t  nominal_time[4];
1188	uint8_t  recommended_time[4];
1189};
1190
1191struct scsi_report_supported_opcodes_descr
1192{
1193	uint8_t  opcode;
1194	uint8_t  reserved;
1195	uint8_t  service_action[2];
1196	uint8_t  reserved2;
1197	uint8_t  flags;
1198#define RSO_SERVACTV		0x01
1199#define RSO_CTDP		0x02
1200	uint8_t  cdb_length[2];
1201	struct scsi_report_supported_opcodes_timeout timeout[0];
1202};
1203
1204struct scsi_report_supported_opcodes_all
1205{
1206	uint8_t  length[4];
1207	struct scsi_report_supported_opcodes_descr descr[0];
1208};
1209
1210struct scsi_report_supported_opcodes_one
1211{
1212	uint8_t  reserved;
1213	uint8_t  support;
1214#define RSO_ONE_CTDP		0x80
1215	uint8_t  cdb_length[2];
1216	uint8_t  cdb_usage[];
1217};
1218
1219struct scsi_report_supported_tmf
1220{
1221	uint8_t  opcode;
1222	uint8_t  service_action;
1223	uint8_t  reserved[4];
1224	uint8_t  length[4];
1225	uint8_t  reserved1;
1226	uint8_t  control;
1227};
1228
1229struct scsi_report_supported_tmf_data
1230{
1231	uint8_t  byte1;
1232#define RST_WAKES		0x01
1233#define RST_TRS			0x02
1234#define RST_QTS			0x04
1235#define RST_LURS		0x08
1236#define RST_CTSS		0x10
1237#define RST_CACAS		0x20
1238#define RST_ATSS		0x40
1239#define RST_ATS			0x80
1240	uint8_t  byte2;
1241#define RST_ITNRS		0x01
1242#define RST_QTSS		0x02
1243#define RST_QAES		0x04
1244	uint8_t  reserved[2];
1245};
1246
1247struct scsi_report_timestamp
1248{
1249	uint8_t  opcode;
1250	uint8_t  service_action;
1251	uint8_t  reserved[4];
1252	uint8_t  length[4];
1253	uint8_t  reserved1;
1254	uint8_t  control;
1255};
1256
1257struct scsi_report_timestamp_data
1258{
1259	uint8_t  length[2];
1260	uint8_t  origin;
1261#define RTS_ORIG_MASK		0x00
1262#define RTS_ORIG_ZERO		0x00
1263#define RTS_ORIG_SET		0x02
1264#define RTS_ORIG_OUTSIDE	0x03
1265	uint8_t  reserved;
1266	uint8_t  timestamp[6];
1267	uint8_t  reserve2[2];
1268};
1269
1270struct scsi_receive_copy_status_lid1
1271{
1272	uint8_t  opcode;
1273	uint8_t  service_action;
1274#define RCS_RCS_LID1		0x00
1275	uint8_t  list_identifier;
1276	uint8_t  reserved[7];
1277	uint8_t  length[4];
1278	uint8_t  reserved1;
1279	uint8_t  control;
1280};
1281
1282struct scsi_receive_copy_status_lid1_data
1283{
1284	uint8_t  available_data[4];
1285	uint8_t  copy_command_status;
1286#define RCS_CCS_INPROG		0x00
1287#define RCS_CCS_COMPLETED	0x01
1288#define RCS_CCS_ERROR		0x02
1289	uint8_t  segments_processed[2];
1290	uint8_t  transfer_count_units;
1291#define RCS_TC_BYTES		0x00
1292#define RCS_TC_KBYTES		0x01
1293#define RCS_TC_MBYTES		0x02
1294#define RCS_TC_GBYTES		0x03
1295#define RCS_TC_TBYTES		0x04
1296#define RCS_TC_PBYTES		0x05
1297#define RCS_TC_EBYTES		0x06
1298#define RCS_TC_LBAS		0xf1
1299	uint8_t  transfer_count[4];
1300};
1301
1302struct scsi_receive_copy_failure_details
1303{
1304	uint8_t  opcode;
1305	uint8_t  service_action;
1306#define RCS_RCFD		0x04
1307	uint8_t  list_identifier;
1308	uint8_t  reserved[7];
1309	uint8_t  length[4];
1310	uint8_t  reserved1;
1311	uint8_t  control;
1312};
1313
1314struct scsi_receive_copy_failure_details_data
1315{
1316	uint8_t  available_data[4];
1317	uint8_t  reserved[52];
1318	uint8_t  copy_command_status;
1319	uint8_t  reserved2;
1320	uint8_t  sense_data_length[2];
1321	uint8_t  sense_data[];
1322};
1323
1324struct scsi_receive_copy_status_lid4
1325{
1326	uint8_t  opcode;
1327	uint8_t  service_action;
1328#define RCS_RCS_LID4		0x05
1329	uint8_t  list_identifier[4];
1330	uint8_t  reserved[4];
1331	uint8_t  length[4];
1332	uint8_t  reserved1;
1333	uint8_t  control;
1334};
1335
1336struct scsi_receive_copy_status_lid4_data
1337{
1338	uint8_t  available_data[4];
1339	uint8_t  response_to_service_action;
1340	uint8_t  copy_command_status;
1341#define RCS_CCS_COMPLETED_PROD	0x03
1342#define RCS_CCS_COMPLETED_RESID	0x04
1343#define RCS_CCS_INPROG_FGBG	0x10
1344#define RCS_CCS_INPROG_FG	0x11
1345#define RCS_CCS_INPROG_BG	0x12
1346#define RCS_CCS_ABORTED		0x60
1347	uint8_t  operation_counter[2];
1348	uint8_t  estimated_status_update_delay[4];
1349	uint8_t  extended_copy_completion_status;
1350	uint8_t  length_of_the_sense_data_field;
1351	uint8_t  sense_data_length;
1352	uint8_t  transfer_count_units;
1353	uint8_t  transfer_count[8];
1354	uint8_t  segments_processed[2];
1355	uint8_t  reserved[6];
1356	uint8_t  sense_data[];
1357};
1358
1359struct scsi_receive_copy_operating_parameters
1360{
1361	uint8_t  opcode;
1362	uint8_t  service_action;
1363#define RCS_RCOP		0x03
1364	uint8_t  reserved[8];
1365	uint8_t  length[4];
1366	uint8_t  reserved1;
1367	uint8_t  control;
1368};
1369
1370struct scsi_receive_copy_operating_parameters_data
1371{
1372	uint8_t  length[4];
1373	uint8_t  snlid;
1374#define RCOP_SNLID		0x01
1375	uint8_t  reserved[3];
1376	uint8_t  maximum_cscd_descriptor_count[2];
1377	uint8_t  maximum_segment_descriptor_count[2];
1378	uint8_t  maximum_descriptor_list_length[4];
1379	uint8_t  maximum_segment_length[4];
1380	uint8_t  maximum_inline_data_length[4];
1381	uint8_t  held_data_limit[4];
1382	uint8_t  maximum_stream_device_transfer_size[4];
1383	uint8_t  reserved2[2];
1384	uint8_t  total_concurrent_copies[2];
1385	uint8_t  maximum_concurrent_copies;
1386	uint8_t  data_segment_granularity;
1387	uint8_t  inline_data_granularity;
1388	uint8_t  held_data_granularity;
1389	uint8_t  reserved3[3];
1390	uint8_t  implemented_descriptor_list_length;
1391	uint8_t  list_of_implemented_descriptor_type_codes[0];
1392};
1393
1394struct scsi_extended_copy
1395{
1396	uint8_t  opcode;
1397	uint8_t  service_action;
1398#define EC_EC_LID1		0x00
1399#define EC_EC_LID4		0x01
1400	uint8_t  reserved[8];
1401	uint8_t  length[4];
1402	uint8_t  reserved1;
1403	uint8_t  control;
1404};
1405
1406struct scsi_ec_cscd_dtsp
1407{
1408	uint8_t  flags;
1409#define EC_CSCD_FIXED		0x01
1410#define EC_CSCD_PAD		0x04
1411	uint8_t  block_length[3];
1412};
1413
1414struct scsi_ec_cscd
1415{
1416	uint8_t  type_code;
1417#define EC_CSCD_EXT		0xff
1418	uint8_t  luidt_pdt;
1419#define EC_LUIDT_MASK		0xc0
1420#define EC_LUIDT_LUN		0x00
1421#define EC_LUIDT_PROXY_TOKEN	0x40
1422	uint8_t  relative_initiator_port[2];
1423	uint8_t  cscd_params[24];
1424	struct scsi_ec_cscd_dtsp dtsp;
1425};
1426
1427struct scsi_ec_cscd_id
1428{
1429	uint8_t  type_code;
1430#define EC_CSCD_ID		0xe4
1431	uint8_t  luidt_pdt;
1432	uint8_t  relative_initiator_port[2];
1433	uint8_t  codeset;
1434	uint8_t  id_type;
1435	uint8_t  reserved;
1436	uint8_t  length;
1437	uint8_t  designator[20];
1438	struct scsi_ec_cscd_dtsp dtsp;
1439};
1440
1441struct scsi_ec_segment
1442{
1443	uint8_t  type_code;
1444	uint8_t  flags;
1445#define EC_SEG_DC		0x02
1446#define EC_SEG_CAT		0x01
1447	uint8_t  descr_length[2];
1448	uint8_t  params[];
1449};
1450
1451struct scsi_ec_segment_b2b
1452{
1453	uint8_t  type_code;
1454#define EC_SEG_B2B		0x02
1455	uint8_t  flags;
1456	uint8_t  descr_length[2];
1457	uint8_t  src_cscd[2];
1458	uint8_t  dst_cscd[2];
1459	uint8_t  reserved[2];
1460	uint8_t  number_of_blocks[2];
1461	uint8_t  src_lba[8];
1462	uint8_t  dst_lba[8];
1463};
1464
1465struct scsi_ec_segment_verify
1466{
1467	uint8_t  type_code;
1468#define EC_SEG_VERIFY		0x07
1469	uint8_t  reserved;
1470	uint8_t  descr_length[2];
1471	uint8_t  src_cscd[2];
1472	uint8_t  reserved2[2];
1473	uint8_t  tur;
1474	uint8_t  reserved3[3];
1475};
1476
1477struct scsi_ec_segment_register_key
1478{
1479	uint8_t  type_code;
1480#define EC_SEG_REGISTER_KEY	0x14
1481	uint8_t  reserved;
1482	uint8_t  descr_length[2];
1483	uint8_t  reserved2[2];
1484	uint8_t  dst_cscd[2];
1485	uint8_t  res_key[8];
1486	uint8_t  sa_res_key[8];
1487	uint8_t  reserved3[4];
1488};
1489
1490struct scsi_extended_copy_lid1_data
1491{
1492	uint8_t  list_identifier;
1493	uint8_t  flags;
1494#define EC_PRIORITY		0x07
1495#define EC_LIST_ID_USAGE_MASK	0x18
1496#define EC_LIST_ID_USAGE_FULL	0x08
1497#define EC_LIST_ID_USAGE_NOHOLD	0x10
1498#define EC_LIST_ID_USAGE_NONE	0x18
1499#define EC_STR			0x20
1500	uint8_t  cscd_list_length[2];
1501	uint8_t  reserved[4];
1502	uint8_t  segment_list_length[4];
1503	uint8_t  inline_data_length[4];
1504	uint8_t  data[];
1505};
1506
1507struct scsi_extended_copy_lid4_data
1508{
1509	uint8_t  list_format;
1510#define EC_LIST_FORMAT		0x01
1511	uint8_t  flags;
1512	uint8_t  header_cscd_list_length[2];
1513	uint8_t  reserved[11];
1514	uint8_t  flags2;
1515#define EC_IMMED		0x01
1516#define EC_G_SENSE		0x02
1517	uint8_t  header_cscd_type_code;
1518	uint8_t  reserved2[3];
1519	uint8_t  list_identifier[4];
1520	uint8_t  reserved3[18];
1521	uint8_t  cscd_list_length[2];
1522	uint8_t  segment_list_length[2];
1523	uint8_t  inline_data_length[2];
1524	uint8_t  data[];
1525};
1526
1527struct scsi_copy_operation_abort
1528{
1529	uint8_t  opcode;
1530	uint8_t  service_action;
1531#define EC_COA			0x1c
1532	uint8_t  list_identifier[4];
1533	uint8_t  reserved[9];
1534	uint8_t  control;
1535};
1536
1537struct scsi_populate_token
1538{
1539	uint8_t  opcode;
1540	uint8_t  service_action;
1541#define EC_PT			0x10
1542	uint8_t  reserved[4];
1543	uint8_t  list_identifier[4];
1544	uint8_t  length[4];
1545	uint8_t  group_number;
1546	uint8_t  control;
1547};
1548
1549struct scsi_range_desc
1550{
1551	uint8_t	lba[8];
1552	uint8_t	length[4];
1553	uint8_t	reserved[4];
1554};
1555
1556struct scsi_populate_token_data
1557{
1558	uint8_t  length[2];
1559	uint8_t  flags;
1560#define EC_PT_IMMED			0x01
1561#define EC_PT_RTV			0x02
1562	uint8_t  reserved;
1563	uint8_t  inactivity_timeout[4];
1564	uint8_t  rod_type[4];
1565	uint8_t  reserved2[2];
1566	uint8_t  range_descriptor_length[2];
1567	struct scsi_range_desc desc[];
1568};
1569
1570struct scsi_write_using_token
1571{
1572	uint8_t  opcode;
1573	uint8_t  service_action;
1574#define EC_WUT			0x11
1575	uint8_t  reserved[4];
1576	uint8_t  list_identifier[4];
1577	uint8_t  length[4];
1578	uint8_t  group_number;
1579	uint8_t  control;
1580};
1581
1582struct scsi_write_using_token_data
1583{
1584	uint8_t  length[2];
1585	uint8_t  flags;
1586#define EC_WUT_IMMED			0x01
1587#define EC_WUT_DEL_TKN			0x02
1588	uint8_t  reserved[5];
1589	uint8_t  offset_into_rod[8];
1590	uint8_t  rod_token[512];
1591	uint8_t  reserved2[6];
1592	uint8_t  range_descriptor_length[2];
1593	struct scsi_range_desc desc[];
1594};
1595
1596struct scsi_receive_rod_token_information
1597{
1598	uint8_t  opcode;
1599	uint8_t  service_action;
1600#define RCS_RRTI		0x07
1601	uint8_t  list_identifier[4];
1602	uint8_t  reserved[4];
1603	uint8_t  length[4];
1604	uint8_t  reserved2;
1605	uint8_t  control;
1606};
1607
1608struct scsi_token
1609{
1610	uint8_t  type[4];
1611#define ROD_TYPE_INTERNAL	0x00000000
1612#define ROD_TYPE_AUR		0x00010000
1613#define ROD_TYPE_PIT_DEF	0x00800000
1614#define ROD_TYPE_PIT_VULN	0x00800001
1615#define ROD_TYPE_PIT_PERS	0x00800002
1616#define ROD_TYPE_PIT_ANY	0x0080FFFF
1617#define ROD_TYPE_BLOCK_ZERO	0xFFFF0001
1618	uint8_t  reserved[2];
1619	uint8_t  length[2];
1620	uint8_t  body[0];
1621};
1622
1623struct scsi_report_all_rod_tokens
1624{
1625	uint8_t  opcode;
1626	uint8_t  service_action;
1627#define RCS_RART		0x08
1628	uint8_t  reserved[8];
1629	uint8_t  length[4];
1630	uint8_t  reserved2;
1631	uint8_t  control;
1632};
1633
1634struct scsi_report_all_rod_tokens_data
1635{
1636	uint8_t  available_data[4];
1637	uint8_t  reserved[4];
1638	uint8_t  rod_management_token_list[];
1639};
1640
1641struct ata_pass_16 {
1642	u_int8_t opcode;
1643	u_int8_t protocol;
1644#define	AP_EXTEND	0x01
1645	u_int8_t flags;
1646#define	AP_FLAG_TLEN_NO_DATA	(0 << 0)
1647#define	AP_FLAG_TLEN_FEAT	(1 << 0)
1648#define	AP_FLAG_TLEN_SECT_CNT	(2 << 0)
1649#define	AP_FLAG_TLEN_STPSIU	(3 << 0)
1650#define	AP_FLAG_BYT_BLOK_BYTES	(0 << 2)
1651#define	AP_FLAG_BYT_BLOK_BLOCKS	(1 << 2)
1652#define	AP_FLAG_TDIR_TO_DEV	(0 << 3)
1653#define	AP_FLAG_TDIR_FROM_DEV	(1 << 3)
1654#define	AP_FLAG_CHK_COND	(1 << 5)
1655	u_int8_t features_ext;
1656	u_int8_t features;
1657	u_int8_t sector_count_ext;
1658	u_int8_t sector_count;
1659	u_int8_t lba_low_ext;
1660	u_int8_t lba_low;
1661	u_int8_t lba_mid_ext;
1662	u_int8_t lba_mid;
1663	u_int8_t lba_high_ext;
1664	u_int8_t lba_high;
1665	u_int8_t device;
1666	u_int8_t command;
1667	u_int8_t control;
1668};
1669
1670#define	SC_SCSI_1 0x01
1671#define	SC_SCSI_2 0x03
1672
1673/*
1674 * Opcodes
1675 */
1676
1677#define	TEST_UNIT_READY		0x00
1678#define	REQUEST_SENSE		0x03
1679#define	READ_6			0x08
1680#define	WRITE_6			0x0A
1681#define	INQUIRY			0x12
1682#define	MODE_SELECT_6		0x15
1683#define	MODE_SENSE_6		0x1A
1684#define	START_STOP_UNIT		0x1B
1685#define	START_STOP		0x1B
1686#define	RESERVE      		0x16
1687#define	RELEASE      		0x17
1688#define	RECEIVE_DIAGNOSTIC	0x1C
1689#define	SEND_DIAGNOSTIC		0x1D
1690#define	PREVENT_ALLOW		0x1E
1691#define	READ_CAPACITY		0x25
1692#define	READ_10			0x28
1693#define	WRITE_10		0x2A
1694#define	POSITION_TO_ELEMENT	0x2B
1695#define	WRITE_VERIFY_10		0x2E
1696#define	VERIFY_10		0x2F
1697#define	SYNCHRONIZE_CACHE	0x35
1698#define	READ_DEFECT_DATA_10	0x37
1699#define	WRITE_BUFFER            0x3B
1700#define	READ_BUFFER             0x3C
1701#define	CHANGE_DEFINITION	0x40
1702#define	WRITE_SAME_10		0x41
1703#define	UNMAP			0x42
1704#define	LOG_SELECT		0x4C
1705#define	LOG_SENSE		0x4D
1706#define	MODE_SELECT_10		0x55
1707#define	RESERVE_10		0x56
1708#define	RELEASE_10		0x57
1709#define	MODE_SENSE_10		0x5A
1710#define	PERSISTENT_RES_IN	0x5E
1711#define	PERSISTENT_RES_OUT	0x5F
1712#define	EXTENDED_COPY		0x83
1713#define	RECEIVE_COPY_STATUS	0x84
1714#define	ATA_PASS_16		0x85
1715#define	READ_16			0x88
1716#define	COMPARE_AND_WRITE	0x89
1717#define	WRITE_16		0x8A
1718#define	WRITE_VERIFY_16		0x8E
1719#define	VERIFY_16		0x8F
1720#define	SYNCHRONIZE_CACHE_16	0x91
1721#define	WRITE_SAME_16		0x93
1722#define	SERVICE_ACTION_IN	0x9E
1723#define	REPORT_LUNS		0xA0
1724#define	ATA_PASS_12		0xA1
1725#define	MAINTENANCE_IN		0xA3
1726#define	MAINTENANCE_OUT		0xA4
1727#define	MOVE_MEDIUM     	0xA5
1728#define	READ_12			0xA8
1729#define	WRITE_12		0xAA
1730#define	WRITE_VERIFY_12		0xAE
1731#define	VERIFY_12		0xAF
1732#define	READ_ELEMENT_STATUS	0xB8
1733#define	READ_CD			0xBE
1734
1735/* Maintenance In Service Action Codes */
1736#define	REPORT_IDENTIFYING_INFRMATION		0x05
1737#define	REPORT_TARGET_PORT_GROUPS		0x0A
1738#define	REPORT_ALIASES				0x0B
1739#define	REPORT_SUPPORTED_OPERATION_CODES	0x0C
1740#define	REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS	0x0D
1741#define	REPORT_PRIORITY				0x0E
1742#define	REPORT_TIMESTAMP			0x0F
1743#define	MANAGEMENT_PROTOCOL_IN			0x10
1744/* Maintenance Out Service Action Codes */
1745#define	SET_IDENTIFY_INFORMATION		0x06
1746#define	SET_TARGET_PORT_GROUPS			0x0A
1747#define	CHANGE_ALIASES				0x0B
1748#define	SET_PRIORITY				0x0E
1749#define	SET_TIMESTAMP				0x0F
1750#define	MANGAEMENT_PROTOCOL_OUT			0x10
1751
1752/*
1753 * Device Types
1754 */
1755#define	T_DIRECT	0x00
1756#define	T_SEQUENTIAL	0x01
1757#define	T_PRINTER	0x02
1758#define	T_PROCESSOR	0x03
1759#define	T_WORM		0x04
1760#define	T_CDROM		0x05
1761#define	T_SCANNER	0x06
1762#define	T_OPTICAL 	0x07
1763#define	T_CHANGER	0x08
1764#define	T_COMM		0x09
1765#define	T_ASC0		0x0a
1766#define	T_ASC1		0x0b
1767#define	T_STORARRAY	0x0c
1768#define	T_ENCLOSURE	0x0d
1769#define	T_RBC		0x0e
1770#define	T_OCRW		0x0f
1771#define	T_OSD		0x11
1772#define	T_ADC		0x12
1773#define	T_NODEVICE	0x1f
1774#define	T_ANY		0xff	/* Used in Quirk table matches */
1775
1776#define	T_REMOV		1
1777#define	T_FIXED		0
1778
1779/*
1780 * This length is the initial inquiry length used by the probe code, as
1781 * well as the length necessary for scsi_print_inquiry() to function
1782 * correctly.  If either use requires a different length in the future,
1783 * the two values should be de-coupled.
1784 */
1785#define	SHORT_INQUIRY_LENGTH	36
1786
1787struct scsi_inquiry_data
1788{
1789	u_int8_t device;
1790#define	SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
1791#define	SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
1792#define	SID_QUAL_LU_CONNECTED	0x00	/*
1793					 * The specified peripheral device
1794					 * type is currently connected to
1795					 * logical unit.  If the target cannot
1796					 * determine whether or not a physical
1797					 * device is currently connected, it
1798					 * shall also use this peripheral
1799					 * qualifier when returning the INQUIRY
1800					 * data.  This peripheral qualifier
1801					 * does not mean that the device is
1802					 * ready for access by the initiator.
1803					 */
1804#define	SID_QUAL_LU_OFFLINE	0x01	/*
1805					 * The target is capable of supporting
1806					 * the specified peripheral device type
1807					 * on this logical unit; however, the
1808					 * physical device is not currently
1809					 * connected to this logical unit.
1810					 */
1811#define	SID_QUAL_RSVD		0x02
1812#define	SID_QUAL_BAD_LU		0x03	/*
1813					 * The target is not capable of
1814					 * supporting a physical device on
1815					 * this logical unit. For this
1816					 * peripheral qualifier the peripheral
1817					 * device type shall be set to 1Fh to
1818					 * provide compatibility with previous
1819					 * versions of SCSI. All other
1820					 * peripheral device type values are
1821					 * reserved for this peripheral
1822					 * qualifier.
1823					 */
1824#define	SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
1825	u_int8_t dev_qual2;
1826#define	SID_QUAL2	0x7F
1827#define	SID_LU_CONG	0x40
1828#define	SID_RMB		0x80
1829#define	SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & SID_RMB) != 0)
1830	u_int8_t version;
1831#define	SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
1832#define		SCSI_REV_0		0
1833#define		SCSI_REV_CCS		1
1834#define		SCSI_REV_2		2
1835#define		SCSI_REV_SPC		3
1836#define		SCSI_REV_SPC2		4
1837#define		SCSI_REV_SPC3		5
1838#define		SCSI_REV_SPC4		6
1839
1840#define	SID_ECMA	0x38
1841#define	SID_ISO		0xC0
1842	u_int8_t response_format;
1843#define	SID_AENC	0x80
1844#define	SID_TrmIOP	0x40
1845#define	SID_NormACA	0x20
1846#define	SID_HiSup	0x10
1847	u_int8_t additional_length;
1848#define	SID_ADDITIONAL_LENGTH(iqd)					\
1849	((iqd)->additional_length +					\
1850	__offsetof(struct scsi_inquiry_data, additional_length) + 1)
1851	u_int8_t spc3_flags;
1852#define	SPC3_SID_PROTECT	0x01
1853#define	SPC3_SID_3PC		0x08
1854#define	SPC3_SID_TPGS_MASK	0x30
1855#define	SPC3_SID_TPGS_IMPLICIT	0x10
1856#define	SPC3_SID_TPGS_EXPLICIT	0x20
1857#define	SPC3_SID_ACC		0x40
1858#define	SPC3_SID_SCCS		0x80
1859	u_int8_t spc2_flags;
1860#define	SPC2_SID_ADDR16		0x01
1861#define	SPC2_SID_MChngr 	0x08
1862#define	SPC2_SID_MultiP 	0x10
1863#define	SPC2_SID_EncServ	0x40
1864#define	SPC2_SID_BQueue		0x80
1865
1866#define	INQ_DATA_TQ_ENABLED(iqd)				\
1867    ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) :	\
1868    (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
1869    (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
1870
1871	u_int8_t flags;
1872#define	SID_SftRe	0x01
1873#define	SID_CmdQue	0x02
1874#define	SID_Linked	0x08
1875#define	SID_Sync	0x10
1876#define	SID_WBus16	0x20
1877#define	SID_WBus32	0x40
1878#define	SID_RelAdr	0x80
1879#define	SID_VENDOR_SIZE   8
1880	char	 vendor[SID_VENDOR_SIZE];
1881#define	SID_PRODUCT_SIZE  16
1882	char	 product[SID_PRODUCT_SIZE];
1883#define	SID_REVISION_SIZE 4
1884	char	 revision[SID_REVISION_SIZE];
1885	/*
1886	 * The following fields were taken from SCSI Primary Commands - 2
1887	 * (SPC-2) Revision 14, Dated 11 November 1999
1888	 */
1889#define	SID_VENDOR_SPECIFIC_0_SIZE	20
1890	u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
1891	/*
1892	 * An extension of SCSI Parallel Specific Values
1893	 */
1894#define	SID_SPI_IUS		0x01
1895#define	SID_SPI_QAS		0x02
1896#define	SID_SPI_CLOCK_ST	0x00
1897#define	SID_SPI_CLOCK_DT	0x04
1898#define	SID_SPI_CLOCK_DT_ST	0x0C
1899#define	SID_SPI_MASK		0x0F
1900	u_int8_t spi3data;
1901	u_int8_t reserved2;
1902	/*
1903	 * Version Descriptors, stored 2 byte values.
1904	 */
1905	u_int8_t version1[2];
1906	u_int8_t version2[2];
1907	u_int8_t version3[2];
1908	u_int8_t version4[2];
1909	u_int8_t version5[2];
1910	u_int8_t version6[2];
1911	u_int8_t version7[2];
1912	u_int8_t version8[2];
1913
1914	u_int8_t reserved3[22];
1915
1916#define	SID_VENDOR_SPECIFIC_1_SIZE	160
1917	u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
1918};
1919
1920/*
1921 * This structure is more suited to initiator operation, because the
1922 * maximum number of supported pages is already allocated.
1923 */
1924struct scsi_vpd_supported_page_list
1925{
1926	u_int8_t device;
1927	u_int8_t page_code;
1928#define	SVPD_SUPPORTED_PAGE_LIST	0x00
1929#define	SVPD_SUPPORTED_PAGES_HDR_LEN	4
1930	u_int8_t reserved;
1931	u_int8_t length;	/* number of VPD entries */
1932#define	SVPD_SUPPORTED_PAGES_SIZE	251
1933	u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
1934};
1935
1936/*
1937 * This structure is more suited to target operation, because the
1938 * number of supported pages is left to the user to allocate.
1939 */
1940struct scsi_vpd_supported_pages
1941{
1942	u_int8_t device;
1943	u_int8_t page_code;
1944	u_int8_t reserved;
1945#define	SVPD_SUPPORTED_PAGES	0x00
1946	u_int8_t length;
1947	u_int8_t page_list[0];
1948};
1949
1950
1951struct scsi_vpd_unit_serial_number
1952{
1953	u_int8_t device;
1954	u_int8_t page_code;
1955#define	SVPD_UNIT_SERIAL_NUMBER	0x80
1956	u_int8_t reserved;
1957	u_int8_t length; /* serial number length */
1958#define	SVPD_SERIAL_NUM_SIZE 251
1959	u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
1960};
1961
1962struct scsi_vpd_device_id
1963{
1964	u_int8_t device;
1965	u_int8_t page_code;
1966#define	SVPD_DEVICE_ID			0x83
1967#define	SVPD_DEVICE_ID_MAX_SIZE		252
1968#define	SVPD_DEVICE_ID_HDR_LEN \
1969    __offsetof(struct scsi_vpd_device_id, desc_list)
1970	u_int8_t length[2];
1971	u_int8_t desc_list[];
1972};
1973
1974struct scsi_vpd_id_descriptor
1975{
1976	u_int8_t	proto_codeset;
1977	/*
1978	 * See the SCSI_PROTO definitions above for the protocols.
1979	 */
1980#define	SVPD_ID_PROTO_SHIFT	4
1981#define	SVPD_ID_CODESET_BINARY	0x01
1982#define	SVPD_ID_CODESET_ASCII	0x02
1983#define	SVPD_ID_CODESET_UTF8	0x03
1984#define	SVPD_ID_CODESET_MASK	0x0f
1985	u_int8_t	id_type;
1986#define	SVPD_ID_PIV		0x80
1987#define	SVPD_ID_ASSOC_LUN	0x00
1988#define	SVPD_ID_ASSOC_PORT	0x10
1989#define	SVPD_ID_ASSOC_TARGET	0x20
1990#define	SVPD_ID_ASSOC_MASK	0x30
1991#define	SVPD_ID_TYPE_VENDOR	0x00
1992#define	SVPD_ID_TYPE_T10	0x01
1993#define	SVPD_ID_TYPE_EUI64	0x02
1994#define	SVPD_ID_TYPE_NAA	0x03
1995#define	SVPD_ID_TYPE_RELTARG	0x04
1996#define	SVPD_ID_TYPE_TPORTGRP	0x05
1997#define	SVPD_ID_TYPE_LUNGRP	0x06
1998#define	SVPD_ID_TYPE_MD5_LUN_ID	0x07
1999#define	SVPD_ID_TYPE_SCSI_NAME	0x08
2000#define	SVPD_ID_TYPE_MASK	0x0f
2001	u_int8_t	reserved;
2002	u_int8_t	length;
2003#define	SVPD_DEVICE_ID_DESC_HDR_LEN \
2004    __offsetof(struct scsi_vpd_id_descriptor, identifier)
2005	u_int8_t	identifier[];
2006};
2007
2008struct scsi_vpd_id_t10
2009{
2010	u_int8_t	vendor[8];
2011	u_int8_t	vendor_spec_id[0];
2012};
2013
2014struct scsi_vpd_id_eui64
2015{
2016	u_int8_t	ieee_company_id[3];
2017	u_int8_t	extension_id[5];
2018};
2019
2020struct scsi_vpd_id_naa_basic
2021{
2022	uint8_t naa;
2023	/* big endian, packed:
2024	uint8_t	naa : 4;
2025	uint8_t naa_desig : 4;
2026	*/
2027#define	SVPD_ID_NAA_NAA_SHIFT		4
2028#define	SVPD_ID_NAA_IEEE_EXT		0x02
2029#define	SVPD_ID_NAA_LOCAL_REG		0x03
2030#define	SVPD_ID_NAA_IEEE_REG		0x05
2031#define	SVPD_ID_NAA_IEEE_REG_EXT	0x06
2032	uint8_t	naa_data[];
2033};
2034
2035struct scsi_vpd_id_naa_ieee_extended_id
2036{
2037	uint8_t naa;
2038	uint8_t vendor_specific_id_a;
2039	uint8_t ieee_company_id[3];
2040	uint8_t vendor_specific_id_b[4];
2041};
2042
2043struct scsi_vpd_id_naa_local_reg
2044{
2045	uint8_t naa;
2046	uint8_t local_value[7];
2047};
2048
2049struct scsi_vpd_id_naa_ieee_reg
2050{
2051	uint8_t naa;
2052	uint8_t reg_value[7];
2053	/* big endian, packed:
2054	uint8_t naa_basic : 4;
2055	uint8_t ieee_company_id_0 : 4;
2056	uint8_t ieee_company_id_1[2];
2057	uint8_t ieee_company_id_2 : 4;
2058	uint8_t vendor_specific_id_0 : 4;
2059	uint8_t vendor_specific_id_1[4];
2060	*/
2061};
2062
2063struct scsi_vpd_id_naa_ieee_reg_extended
2064{
2065	uint8_t naa;
2066	uint8_t reg_value[15];
2067	/* big endian, packed:
2068	uint8_t naa_basic : 4;
2069	uint8_t ieee_company_id_0 : 4;
2070	uint8_t ieee_company_id_1[2];
2071	uint8_t ieee_company_id_2 : 4;
2072	uint8_t vendor_specific_id_0 : 4;
2073	uint8_t vendor_specific_id_1[4];
2074	uint8_t vendor_specific_id_ext[8];
2075	*/
2076};
2077
2078struct scsi_vpd_id_rel_trgt_port_id
2079{
2080	uint8_t obsolete[2];
2081	uint8_t rel_trgt_port_id[2];
2082};
2083
2084struct scsi_vpd_id_trgt_port_grp_id
2085{
2086	uint8_t reserved[2];
2087	uint8_t trgt_port_grp[2];
2088};
2089
2090struct scsi_vpd_id_lun_grp_id
2091{
2092	uint8_t reserved[2];
2093	uint8_t log_unit_grp[2];
2094};
2095
2096struct scsi_vpd_id_md5_lun_id
2097{
2098	uint8_t lun_id[16];
2099};
2100
2101struct scsi_vpd_id_scsi_name
2102{
2103	uint8_t name_string[256];
2104};
2105
2106struct scsi_service_action_in
2107{
2108	uint8_t opcode;
2109	uint8_t service_action;
2110	uint8_t action_dependent[13];
2111	uint8_t control;
2112};
2113
2114struct scsi_vpd_extended_inquiry_data
2115{
2116	uint8_t device;
2117	uint8_t page_code;
2118#define	SVPD_EXTENDED_INQUIRY_DATA	0x86
2119	uint8_t reserved;
2120	uint8_t page_length;
2121	uint8_t flags1;
2122#define	SVPD_EID_AM		0xC0
2123#define	SVPD_EID_SPT		0x38
2124#define	SVPD_EID_SPT_1		0x00
2125#define	SVPD_EID_SPT_12		0x08
2126#define	SVPD_EID_SPT_2		0x10
2127#define	SVPD_EID_SPT_13		0x18
2128#define	SVPD_EID_SPT_3		0x20
2129#define	SVPD_EID_SPT_23		0x28
2130#define	SVPD_EID_SPT_123	0x38
2131#define	SVPD_EID_GRD_CHK	0x04
2132#define	SVPD_EID_APP_CHK	0x02
2133#define	SVPD_EID_REF_CHK	0x01
2134	uint8_t flags2;
2135#define	SVPD_EID_UASK_SUP	0x20
2136#define	SVPD_EID_GROUP_SUP	0x10
2137#define	SVPD_EID_PRIOR_SUP	0x08
2138#define	SVPD_EID_HEADSUP	0x04
2139#define	SVPD_EID_ORDSUP		0x02
2140#define	SVPD_EID_SIMPSUP	0x01
2141	uint8_t flags3;
2142#define	SVPD_EID_WU_SUP		0x08
2143#define	SVPD_EID_CRD_SUP	0x04
2144#define	SVPD_EID_NV_SUP		0x02
2145#define	SVPD_EID_V_SUP		0x01
2146	uint8_t flags4;
2147#define	SVPD_EID_P_I_I_SUP	0x10
2148#define	SVPD_EID_LUICLT		0x01
2149	uint8_t flags5;
2150#define	SVPD_EID_R_SUP		0x10
2151#define	SVPD_EID_CBCS		0x01
2152	uint8_t flags6;
2153#define	SVPD_EID_MULTI_I_T_FW	0x0F
2154	uint8_t est[2];
2155	uint8_t flags7;
2156#define	SVPD_EID_POA_SUP	0x80
2157#define	SVPD_EID_HRA_SUP	0x80
2158#define	SVPD_EID_VSA_SUP	0x80
2159	uint8_t max_sense_length;
2160	uint8_t reserved2[50];
2161};
2162
2163struct scsi_vpd_mode_page_policy_descr
2164{
2165	uint8_t page_code;
2166	uint8_t subpage_code;
2167	uint8_t policy;
2168#define	SVPD_MPP_SHARED		0x00
2169#define	SVPD_MPP_PORT		0x01
2170#define	SVPD_MPP_I_T		0x03
2171#define	SVPD_MPP_MLUS		0x80
2172	uint8_t reserved;
2173};
2174
2175struct scsi_vpd_mode_page_policy
2176{
2177	uint8_t device;
2178	uint8_t page_code;
2179#define	SVPD_MODE_PAGE_POLICY	0x87
2180	uint8_t page_length[2];
2181	struct scsi_vpd_mode_page_policy_descr descr[0];
2182};
2183
2184struct scsi_diag_page {
2185	uint8_t page_code;
2186	uint8_t page_specific_flags;
2187	uint8_t length[2];
2188	uint8_t params[0];
2189};
2190
2191struct scsi_vpd_port_designation
2192{
2193	uint8_t reserved[2];
2194	uint8_t relative_port_id[2];
2195	uint8_t reserved2[2];
2196	uint8_t initiator_transportid_length[2];
2197	uint8_t initiator_transportid[0];
2198};
2199
2200struct scsi_vpd_port_designation_cont
2201{
2202	uint8_t reserved[2];
2203	uint8_t target_port_descriptors_length[2];
2204	struct scsi_vpd_id_descriptor target_port_descriptors[0];
2205};
2206
2207struct scsi_vpd_scsi_ports
2208{
2209	u_int8_t device;
2210	u_int8_t page_code;
2211#define	SVPD_SCSI_PORTS		0x88
2212	u_int8_t page_length[2];
2213	struct scsi_vpd_port_designation design[];
2214};
2215
2216/*
2217 * ATA Information VPD Page based on
2218 * T10/2126-D Revision 04
2219 */
2220#define SVPD_ATA_INFORMATION		0x89
2221
2222
2223struct scsi_vpd_tpc_descriptor
2224{
2225	uint8_t desc_type[2];
2226	uint8_t desc_length[2];
2227	uint8_t parameters[];
2228};
2229
2230struct scsi_vpd_tpc_descriptor_bdrl
2231{
2232	uint8_t desc_type[2];
2233#define	SVPD_TPC_BDRL			0x0000
2234	uint8_t desc_length[2];
2235	uint8_t vendor_specific[6];
2236	uint8_t maximum_ranges[2];
2237	uint8_t maximum_inactivity_timeout[4];
2238	uint8_t default_inactivity_timeout[4];
2239	uint8_t maximum_token_transfer_size[8];
2240	uint8_t optimal_transfer_count[8];
2241};
2242
2243struct scsi_vpd_tpc_descriptor_sc_descr
2244{
2245	uint8_t opcode;
2246	uint8_t sa_length;
2247	uint8_t supported_service_actions[0];
2248};
2249
2250struct scsi_vpd_tpc_descriptor_sc
2251{
2252	uint8_t desc_type[2];
2253#define	SVPD_TPC_SC			0x0001
2254	uint8_t desc_length[2];
2255	uint8_t list_length;
2256	struct scsi_vpd_tpc_descriptor_sc_descr descr[];
2257};
2258
2259struct scsi_vpd_tpc_descriptor_pd
2260{
2261	uint8_t desc_type[2];
2262#define	SVPD_TPC_PD			0x0004
2263	uint8_t desc_length[2];
2264	uint8_t reserved[4];
2265	uint8_t maximum_cscd_descriptor_count[2];
2266	uint8_t maximum_segment_descriptor_count[2];
2267	uint8_t maximum_descriptor_list_length[4];
2268	uint8_t maximum_inline_data_length[4];
2269	uint8_t reserved2[12];
2270};
2271
2272struct scsi_vpd_tpc_descriptor_sd
2273{
2274	uint8_t desc_type[2];
2275#define	SVPD_TPC_SD			0x0008
2276	uint8_t desc_length[2];
2277	uint8_t list_length;
2278	uint8_t supported_descriptor_codes[];
2279};
2280
2281struct scsi_vpd_tpc_descriptor_sdid
2282{
2283	uint8_t desc_type[2];
2284#define	SVPD_TPC_SDID			0x000C
2285	uint8_t desc_length[2];
2286	uint8_t list_length[2];
2287	uint8_t supported_descriptor_ids[];
2288};
2289
2290struct scsi_vpd_tpc_descriptor_rtf_block
2291{
2292	uint8_t type_format;
2293#define	SVPD_TPC_RTF_BLOCK			0x00
2294	uint8_t reserved;
2295	uint8_t desc_length[2];
2296	uint8_t reserved2[2];
2297	uint8_t optimal_length_granularity[2];
2298	uint8_t maximum_bytes[8];
2299	uint8_t optimal_bytes[8];
2300	uint8_t optimal_bytes_to_token_per_segment[8];
2301	uint8_t optimal_bytes_from_token_per_segment[8];
2302	uint8_t reserved3[8];
2303};
2304
2305struct scsi_vpd_tpc_descriptor_rtf
2306{
2307	uint8_t desc_type[2];
2308#define	SVPD_TPC_RTF			0x0106
2309	uint8_t desc_length[2];
2310	uint8_t remote_tokens;
2311	uint8_t reserved[11];
2312	uint8_t minimum_token_lifetime[4];
2313	uint8_t maximum_token_lifetime[4];
2314	uint8_t maximum_token_inactivity_timeout[4];
2315	uint8_t reserved2[18];
2316	uint8_t type_specific_features_length[2];
2317	uint8_t type_specific_features[0];
2318};
2319
2320struct scsi_vpd_tpc_descriptor_srtd
2321{
2322	uint8_t rod_type[4];
2323	uint8_t flags;
2324#define	SVPD_TPC_SRTD_TOUT		0x01
2325#define	SVPD_TPC_SRTD_TIN		0x02
2326#define	SVPD_TPC_SRTD_ECPY		0x80
2327	uint8_t reserved;
2328	uint8_t preference_indicator[2];
2329	uint8_t reserved2[56];
2330};
2331
2332struct scsi_vpd_tpc_descriptor_srt
2333{
2334	uint8_t desc_type[2];
2335#define	SVPD_TPC_SRT			0x0108
2336	uint8_t desc_length[2];
2337	uint8_t reserved[2];
2338	uint8_t rod_type_descriptors_length[2];
2339	uint8_t rod_type_descriptors[0];
2340};
2341
2342struct scsi_vpd_tpc_descriptor_gco
2343{
2344	uint8_t desc_type[2];
2345#define	SVPD_TPC_GCO			0x8001
2346	uint8_t desc_length[2];
2347	uint8_t total_concurrent_copies[4];
2348	uint8_t maximum_identified_concurrent_copies[4];
2349	uint8_t maximum_segment_length[4];
2350	uint8_t data_segment_granularity;
2351	uint8_t inline_data_granularity;
2352	uint8_t reserved[18];
2353};
2354
2355struct scsi_vpd_tpc
2356{
2357	uint8_t device;
2358	uint8_t page_code;
2359#define	SVPD_SCSI_TPC			0x8F
2360	uint8_t page_length[2];
2361	struct scsi_vpd_tpc_descriptor descr[];
2362};
2363
2364/*
2365 * Block Device Characteristics VPD Page based on
2366 * T10/1799-D Revision 31
2367 */
2368struct scsi_vpd_block_characteristics
2369{
2370	u_int8_t device;
2371	u_int8_t page_code;
2372#define SVPD_BDC			0xB1
2373	u_int8_t page_length[2];
2374	u_int8_t medium_rotation_rate[2];
2375#define SVPD_BDC_RATE_NOT_REPORTED	0x00
2376#define SVPD_BDC_RATE_NON_ROTATING	0x01
2377	u_int8_t reserved1;
2378	u_int8_t nominal_form_factor;
2379#define SVPD_BDC_FORM_NOT_REPORTED	0x00
2380#define SVPD_BDC_FORM_5_25INCH		0x01
2381#define SVPD_BDC_FORM_3_5INCH		0x02
2382#define SVPD_BDC_FORM_2_5INCH		0x03
2383#define SVPD_BDC_FORM_1_5INCH		0x04
2384#define SVPD_BDC_FORM_LESSTHAN_1_5INCH	0x05
2385	u_int8_t reserved2[56];
2386};
2387
2388/*
2389 * Block Device Characteristics VPD Page
2390 */
2391struct scsi_vpd_block_device_characteristics
2392{
2393	uint8_t device;
2394	uint8_t page_code;
2395#define	SVPD_BDC		0xB1
2396	uint8_t page_length[2];
2397	uint8_t medium_rotation_rate[2];
2398#define	SVPD_NOT_REPORTED	0x0000
2399#define	SVPD_NON_ROTATING	0x0001
2400	uint8_t product_type;
2401	uint8_t wab_wac_ff;
2402	uint8_t flags;
2403#define	SVPD_VBULS		0x01
2404#define	SVPD_FUAB		0x02
2405#define	SVPD_HAW_ZBC		0x10
2406	uint8_t reserved[55];
2407};
2408
2409/*
2410 * Logical Block Provisioning VPD Page based on
2411 * T10/1799-D Revision 31
2412 */
2413struct scsi_vpd_logical_block_prov
2414{
2415	u_int8_t device;
2416	u_int8_t page_code;
2417#define	SVPD_LBP		0xB2
2418	u_int8_t page_length[2];
2419#define SVPD_LBP_PL_BASIC	0x04
2420	u_int8_t threshold_exponent;
2421	u_int8_t flags;
2422#define SVPD_LBP_UNMAP		0x80
2423#define SVPD_LBP_WS16		0x40
2424#define SVPD_LBP_WS10		0x20
2425#define SVPD_LBP_RZ		0x04
2426#define SVPD_LBP_ANC_SUP	0x02
2427#define SVPD_LBP_DP		0x01
2428	u_int8_t prov_type;
2429#define SVPD_LBP_RESOURCE	0x01
2430#define SVPD_LBP_THIN		0x02
2431	u_int8_t reserved;
2432	/*
2433	 * Provisioning Group Descriptor can be here if SVPD_LBP_DP is set
2434	 * Its size can be determined from page_length - 4
2435	 */
2436};
2437
2438/*
2439 * Block Limits VDP Page based on
2440 * T10/1799-D Revision 31
2441 */
2442struct scsi_vpd_block_limits
2443{
2444	u_int8_t device;
2445	u_int8_t page_code;
2446#define	SVPD_BLOCK_LIMITS	0xB0
2447	u_int8_t page_length[2];
2448#define SVPD_BL_PL_BASIC	0x10
2449#define SVPD_BL_PL_TP		0x3C
2450	u_int8_t reserved1;
2451	u_int8_t max_cmp_write_len;
2452	u_int8_t opt_txfer_len_grain[2];
2453	u_int8_t max_txfer_len[4];
2454	u_int8_t opt_txfer_len[4];
2455	u_int8_t max_prefetch[4];
2456	u_int8_t max_unmap_lba_cnt[4];
2457	u_int8_t max_unmap_blk_cnt[4];
2458	u_int8_t opt_unmap_grain[4];
2459	u_int8_t unmap_grain_align[4];
2460	u_int8_t max_write_same_length[8];
2461	u_int8_t reserved2[20];
2462};
2463
2464struct scsi_read_capacity
2465{
2466	u_int8_t opcode;
2467	u_int8_t byte2;
2468#define	SRC_RELADR	0x01
2469	u_int8_t addr[4];
2470	u_int8_t unused[2];
2471	u_int8_t pmi;
2472#define	SRC_PMI		0x01
2473	u_int8_t control;
2474};
2475
2476struct scsi_read_capacity_16
2477{
2478	uint8_t opcode;
2479#define	SRC16_SERVICE_ACTION	0x10
2480	uint8_t service_action;
2481	uint8_t addr[8];
2482	uint8_t alloc_len[4];
2483#define	SRC16_PMI		0x01
2484#define	SRC16_RELADR		0x02
2485	uint8_t reladr;
2486	uint8_t control;
2487};
2488
2489struct scsi_read_capacity_data
2490{
2491	u_int8_t addr[4];
2492	u_int8_t length[4];
2493};
2494
2495struct scsi_read_capacity_data_long
2496{
2497	uint8_t addr[8];
2498	uint8_t length[4];
2499#define	SRC16_PROT_EN		0x01
2500#define	SRC16_P_TYPE		0x0e
2501#define	SRC16_PTYPE_1		0x00
2502#define	SRC16_PTYPE_2		0x02
2503#define	SRC16_PTYPE_3		0x04
2504	uint8_t prot;
2505#define	SRC16_LBPPBE		0x0f
2506#define	SRC16_PI_EXPONENT	0xf0
2507#define	SRC16_PI_EXPONENT_SHIFT	4
2508	uint8_t prot_lbppbe;
2509#define	SRC16_LALBA		0x3f
2510#define	SRC16_LBPRZ		0x40
2511#define	SRC16_LBPME		0x80
2512/*
2513 * Alternate versions of these macros that are intended for use on a 16-bit
2514 * version of the lalba_lbp field instead of the array of 2 8 bit numbers.
2515 */
2516#define	SRC16_LALBA_A		0x3fff
2517#define	SRC16_LBPRZ_A		0x4000
2518#define	SRC16_LBPME_A		0x8000
2519	uint8_t lalba_lbp[2];
2520	uint8_t	reserved[16];
2521};
2522
2523struct scsi_report_luns
2524{
2525	uint8_t opcode;
2526	uint8_t reserved1;
2527#define	RPL_REPORT_DEFAULT	0x00
2528#define	RPL_REPORT_WELLKNOWN	0x01
2529#define	RPL_REPORT_ALL		0x02
2530	uint8_t select_report;
2531	uint8_t reserved2[3];
2532	uint8_t length[4];
2533	uint8_t reserved3;
2534	uint8_t control;
2535};
2536
2537struct scsi_report_luns_lundata {
2538	uint8_t lundata[8];
2539#define	RPL_LUNDATA_PERIPH_BUS_MASK	0x3f
2540#define	RPL_LUNDATA_FLAT_LUN_MASK	0x3f
2541#define	RPL_LUNDATA_FLAT_LUN_BITS	0x06
2542#define	RPL_LUNDATA_LUN_TARG_MASK	0x3f
2543#define	RPL_LUNDATA_LUN_BUS_MASK	0xe0
2544#define	RPL_LUNDATA_LUN_LUN_MASK	0x1f
2545#define	RPL_LUNDATA_EXT_LEN_MASK	0x30
2546#define	RPL_LUNDATA_EXT_EAM_MASK	0x0f
2547#define	RPL_LUNDATA_EXT_EAM_WK		0x01
2548#define	RPL_LUNDATA_EXT_EAM_NOT_SPEC	0x0f
2549#define	RPL_LUNDATA_ATYP_MASK	0xc0	/* MBZ for type 0 lun */
2550#define	RPL_LUNDATA_ATYP_PERIPH	0x00
2551#define	RPL_LUNDATA_ATYP_FLAT	0x40
2552#define	RPL_LUNDATA_ATYP_LUN	0x80
2553#define	RPL_LUNDATA_ATYP_EXTLUN	0xc0
2554};
2555
2556struct scsi_report_luns_data {
2557	u_int8_t length[4];	/* length of LUN inventory, in bytes */
2558	u_int8_t reserved[4];	/* unused */
2559	/*
2560	 * LUN inventory- we only support the type zero form for now.
2561	 */
2562	struct scsi_report_luns_lundata luns[0];
2563};
2564
2565struct scsi_target_group
2566{
2567	uint8_t opcode;
2568	uint8_t service_action;
2569#define	STG_PDF_MASK		0xe0
2570#define	STG_PDF_LENGTH		0x00
2571#define	STG_PDF_EXTENDED	0x20
2572	uint8_t reserved1[4];
2573	uint8_t length[4];
2574	uint8_t reserved2;
2575	uint8_t control;
2576};
2577
2578struct scsi_target_port_descriptor {
2579	uint8_t	reserved[2];
2580	uint8_t	relative_target_port_identifier[2];
2581	uint8_t desc_list[];
2582};
2583
2584struct scsi_target_port_group_descriptor {
2585	uint8_t	pref_state;
2586#define	TPG_PRIMARY				0x80
2587#define	TPG_ASYMMETRIC_ACCESS_STATE_MASK	0xf
2588#define	TPG_ASYMMETRIC_ACCESS_OPTIMIZED		0x0
2589#define	TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED	0x1
2590#define	TPG_ASYMMETRIC_ACCESS_STANDBY		0x2
2591#define	TPG_ASYMMETRIC_ACCESS_UNAVAILABLE	0x3
2592#define	TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT	0x4
2593#define	TPG_ASYMMETRIC_ACCESS_OFFLINE		0xE
2594#define	TPG_ASYMMETRIC_ACCESS_TRANSITIONING	0xF
2595	uint8_t support;
2596#define	TPG_AO_SUP	0x01
2597#define	TPG_AN_SUP	0x02
2598#define	TPG_S_SUP	0x04
2599#define	TPG_U_SUP	0x08
2600#define	TPG_LBD_SUP	0x10
2601#define	TPG_O_SUP	0x40
2602#define	TPG_T_SUP	0x80
2603	uint8_t target_port_group[2];
2604	uint8_t reserved;
2605	uint8_t status;
2606#define TPG_UNAVLBL      0
2607#define TPG_SET_BY_STPG  0x01
2608#define TPG_IMPLICIT     0x02
2609	uint8_t vendor_specific;
2610	uint8_t	target_port_count;
2611	struct scsi_target_port_descriptor descriptors[];
2612};
2613
2614struct scsi_target_group_data {
2615	uint8_t length[4];	/* length of returned data, in bytes */
2616	struct scsi_target_port_group_descriptor groups[];
2617};
2618
2619struct scsi_target_group_data_extended {
2620	uint8_t length[4];	/* length of returned data, in bytes */
2621	uint8_t format_type;	/* STG_PDF_LENGTH or STG_PDF_EXTENDED */
2622	uint8_t	implicit_transition_time;
2623	uint8_t reserved[2];
2624	struct scsi_target_port_group_descriptor groups[];
2625};
2626
2627
2628typedef enum {
2629	SSD_TYPE_NONE,
2630	SSD_TYPE_FIXED,
2631	SSD_TYPE_DESC
2632} scsi_sense_data_type;
2633
2634typedef enum {
2635	SSD_ELEM_NONE,
2636	SSD_ELEM_SKIP,
2637	SSD_ELEM_DESC,
2638	SSD_ELEM_SKS,
2639	SSD_ELEM_COMMAND,
2640	SSD_ELEM_INFO,
2641	SSD_ELEM_FRU,
2642	SSD_ELEM_STREAM,
2643	SSD_ELEM_MAX
2644} scsi_sense_elem_type;
2645
2646
2647struct scsi_sense_data
2648{
2649	uint8_t error_code;
2650	/*
2651	 * SPC-4 says that the maximum length of sense data is 252 bytes.
2652	 * So this structure is exactly 252 bytes log.
2653	 */
2654#define	SSD_FULL_SIZE 252
2655	uint8_t sense_buf[SSD_FULL_SIZE - 1];
2656	/*
2657	 * XXX KDM is this still a reasonable minimum size?
2658	 */
2659#define	SSD_MIN_SIZE 18
2660	/*
2661	 * Maximum value for the extra_len field in the sense data.
2662	 */
2663#define	SSD_EXTRA_MAX 244
2664};
2665
2666/*
2667 * Fixed format sense data.
2668 */
2669struct scsi_sense_data_fixed
2670{
2671	u_int8_t error_code;
2672#define	SSD_ERRCODE			0x7F
2673#define		SSD_CURRENT_ERROR	0x70
2674#define		SSD_DEFERRED_ERROR	0x71
2675#define	SSD_ERRCODE_VALID	0x80
2676	u_int8_t segment;
2677	u_int8_t flags;
2678#define	SSD_KEY				0x0F
2679#define		SSD_KEY_NO_SENSE	0x00
2680#define		SSD_KEY_RECOVERED_ERROR	0x01
2681#define		SSD_KEY_NOT_READY	0x02
2682#define		SSD_KEY_MEDIUM_ERROR	0x03
2683#define		SSD_KEY_HARDWARE_ERROR	0x04
2684#define		SSD_KEY_ILLEGAL_REQUEST	0x05
2685#define		SSD_KEY_UNIT_ATTENTION	0x06
2686#define		SSD_KEY_DATA_PROTECT	0x07
2687#define		SSD_KEY_BLANK_CHECK	0x08
2688#define		SSD_KEY_Vendor_Specific	0x09
2689#define		SSD_KEY_COPY_ABORTED	0x0a
2690#define		SSD_KEY_ABORTED_COMMAND	0x0b
2691#define		SSD_KEY_EQUAL		0x0c
2692#define		SSD_KEY_VOLUME_OVERFLOW	0x0d
2693#define		SSD_KEY_MISCOMPARE	0x0e
2694#define		SSD_KEY_COMPLETED	0x0f
2695#define	SSD_ILI		0x20
2696#define	SSD_EOM		0x40
2697#define	SSD_FILEMARK	0x80
2698	u_int8_t info[4];
2699	u_int8_t extra_len;
2700	u_int8_t cmd_spec_info[4];
2701	u_int8_t add_sense_code;
2702	u_int8_t add_sense_code_qual;
2703	u_int8_t fru;
2704	u_int8_t sense_key_spec[3];
2705#define	SSD_SCS_VALID		0x80
2706#define	SSD_FIELDPTR_CMD	0x40
2707#define	SSD_BITPTR_VALID	0x08
2708#define	SSD_BITPTR_VALUE	0x07
2709	u_int8_t extra_bytes[14];
2710#define	SSD_FIXED_IS_PRESENT(sense, length, field) 			\
2711	((length >= (offsetof(struct scsi_sense_data_fixed, field) +	\
2712	sizeof(sense->field))) ? 1 :0)
2713#define	SSD_FIXED_IS_FILLED(sense, field) 				\
2714	((((offsetof(struct scsi_sense_data_fixed, field) +		\
2715	sizeof(sense->field)) -						\
2716	(offsetof(struct scsi_sense_data_fixed, extra_len) +		\
2717	sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
2718};
2719
2720/*
2721 * Descriptor format sense data definitions.
2722 * Introduced in SPC-3.
2723 */
2724struct scsi_sense_data_desc
2725{
2726	uint8_t	error_code;
2727#define	SSD_DESC_CURRENT_ERROR	0x72
2728#define	SSD_DESC_DEFERRED_ERROR	0x73
2729	uint8_t sense_key;
2730	uint8_t	add_sense_code;
2731	uint8_t	add_sense_code_qual;
2732	uint8_t	reserved[3];
2733	/*
2734	 * Note that SPC-4, section 4.5.2.1 says that the extra_len field
2735	 * must be less than or equal to 244.
2736	 */
2737	uint8_t	extra_len;
2738	uint8_t	sense_desc[0];
2739#define	SSD_DESC_IS_PRESENT(sense, length, field) 			\
2740	((length >= (offsetof(struct scsi_sense_data_desc, field) +	\
2741	sizeof(sense->field))) ? 1 :0)
2742};
2743
2744struct scsi_sense_desc_header
2745{
2746	uint8_t desc_type;
2747	uint8_t length;
2748};
2749/*
2750 * The information provide in the Information descriptor is device type or
2751 * command specific information, and defined in a command standard.
2752 *
2753 * Note that any changes to the field names or positions in this structure,
2754 * even reserved fields, should be accompanied by an examination of the
2755 * code in ctl_set_sense() that uses them.
2756 *
2757 * Maximum descriptors allowed: 1 (as of SPC-4)
2758 */
2759struct scsi_sense_info
2760{
2761	uint8_t	desc_type;
2762#define	SSD_DESC_INFO	0x00
2763	uint8_t	length;
2764	uint8_t	byte2;
2765#define	SSD_INFO_VALID	0x80
2766	uint8_t	reserved;
2767	uint8_t	info[8];
2768};
2769
2770/*
2771 * Command-specific information depends on the command for which the
2772 * reported condition occured.
2773 *
2774 * Note that any changes to the field names or positions in this structure,
2775 * even reserved fields, should be accompanied by an examination of the
2776 * code in ctl_set_sense() that uses them.
2777 *
2778 * Maximum descriptors allowed: 1 (as of SPC-4)
2779 */
2780struct scsi_sense_command
2781{
2782	uint8_t	desc_type;
2783#define	SSD_DESC_COMMAND	0x01
2784	uint8_t	length;
2785	uint8_t	reserved[2];
2786	uint8_t	command_info[8];
2787};
2788
2789/*
2790 * Sense key specific descriptor.  The sense key specific data format
2791 * depends on the sense key in question.
2792 *
2793 * Maximum descriptors allowed: 1 (as of SPC-4)
2794 */
2795struct scsi_sense_sks
2796{
2797	uint8_t	desc_type;
2798#define	SSD_DESC_SKS		0x02
2799	uint8_t	length;
2800	uint8_t reserved1[2];
2801	uint8_t	sense_key_spec[3];
2802#define	SSD_SKS_VALID		0x80
2803	uint8_t reserved2;
2804};
2805
2806/*
2807 * This is used for the Illegal Request sense key (0x05) only.
2808 */
2809struct scsi_sense_sks_field
2810{
2811	uint8_t	byte0;
2812#define	SSD_SKS_FIELD_VALID	0x80
2813#define	SSD_SKS_FIELD_CMD	0x40
2814#define	SSD_SKS_BPV		0x08
2815#define	SSD_SKS_BIT_VALUE	0x07
2816	uint8_t	field[2];
2817};
2818
2819
2820/*
2821 * This is used for the Hardware Error (0x04), Medium Error (0x03) and
2822 * Recovered Error (0x01) sense keys.
2823 */
2824struct scsi_sense_sks_retry
2825{
2826	uint8_t byte0;
2827#define	SSD_SKS_RETRY_VALID	0x80
2828	uint8_t actual_retry_count[2];
2829};
2830
2831/*
2832 * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
2833 */
2834struct scsi_sense_sks_progress
2835{
2836	uint8_t byte0;
2837#define	SSD_SKS_PROGRESS_VALID	0x80
2838	uint8_t progress[2];
2839#define	SSD_SKS_PROGRESS_DENOM	0x10000
2840};
2841
2842/*
2843 * Used with the Copy Aborted (0x0a) sense key.
2844 */
2845struct scsi_sense_sks_segment
2846{
2847	uint8_t byte0;
2848#define	SSD_SKS_SEGMENT_VALID	0x80
2849#define	SSD_SKS_SEGMENT_SD	0x20
2850#define	SSD_SKS_SEGMENT_BPV	0x08
2851#define	SSD_SKS_SEGMENT_BITPTR	0x07
2852	uint8_t field[2];
2853};
2854
2855/*
2856 * Used with the Unit Attention (0x06) sense key.
2857 *
2858 * This is currently used to indicate that the unit attention condition
2859 * queue has overflowed (when the overflow bit is set).
2860 */
2861struct scsi_sense_sks_overflow
2862{
2863	uint8_t byte0;
2864#define	SSD_SKS_OVERFLOW_VALID	0x80
2865#define	SSD_SKS_OVERFLOW_SET	0x01
2866	uint8_t	reserved[2];
2867};
2868
2869/*
2870 * This specifies which component is associated with the sense data.  There
2871 * is no standard meaning for the fru value.
2872 *
2873 * Maximum descriptors allowed: 1 (as of SPC-4)
2874 */
2875struct scsi_sense_fru
2876{
2877	uint8_t	desc_type;
2878#define	SSD_DESC_FRU		0x03
2879	uint8_t	length;
2880	uint8_t reserved;
2881	uint8_t fru;
2882};
2883
2884/*
2885 * Used for Stream commands, defined in SSC-4.
2886 *
2887 * Maximum descriptors allowed: 1 (as of SPC-4)
2888 */
2889
2890struct scsi_sense_stream
2891{
2892	uint8_t	desc_type;
2893#define	SSD_DESC_STREAM		0x04
2894	uint8_t	length;
2895	uint8_t	reserved;
2896	uint8_t	byte3;
2897#define	SSD_DESC_STREAM_FM	0x80
2898#define	SSD_DESC_STREAM_EOM	0x40
2899#define	SSD_DESC_STREAM_ILI	0x20
2900};
2901
2902/*
2903 * Used for Block commands, defined in SBC-3.
2904 *
2905 * This is currently (as of SBC-3) only used for the Incorrect Length
2906 * Indication (ILI) bit, which says that the data length requested in the
2907 * READ LONG or WRITE LONG command did not match the length of the logical
2908 * block.
2909 *
2910 * Maximum descriptors allowed: 1 (as of SPC-4)
2911 */
2912struct scsi_sense_block
2913{
2914	uint8_t	desc_type;
2915#define	SSD_DESC_BLOCK		0x05
2916	uint8_t	length;
2917	uint8_t	reserved;
2918	uint8_t	byte3;
2919#define	SSD_DESC_BLOCK_ILI	0x20
2920};
2921
2922/*
2923 * Used for Object-Based Storage Devices (OSD-3).
2924 *
2925 * Maximum descriptors allowed: 1 (as of SPC-4)
2926 */
2927struct scsi_sense_osd_objid
2928{
2929	uint8_t	desc_type;
2930#define	SSD_DESC_OSD_OBJID	0x06
2931	uint8_t	length;
2932	uint8_t	reserved[6];
2933	/*
2934	 * XXX KDM provide the bit definitions here?  There are a lot of
2935	 * them, and we don't have an OSD driver yet.
2936	 */
2937	uint8_t	not_init_cmds[4];
2938	uint8_t	completed_cmds[4];
2939	uint8_t	partition_id[8];
2940	uint8_t	object_id[8];
2941};
2942
2943/*
2944 * Used for Object-Based Storage Devices (OSD-3).
2945 *
2946 * Maximum descriptors allowed: 1 (as of SPC-4)
2947 */
2948struct scsi_sense_osd_integrity
2949{
2950	uint8_t	desc_type;
2951#define	SSD_DESC_OSD_INTEGRITY	0x07
2952	uint8_t	length;
2953	uint8_t	integ_check_val[32];
2954};
2955
2956/*
2957 * Used for Object-Based Storage Devices (OSD-3).
2958 *
2959 * Maximum descriptors allowed: 1 (as of SPC-4)
2960 */
2961struct scsi_sense_osd_attr_id
2962{
2963	uint8_t	desc_type;
2964#define	SSD_DESC_OSD_ATTR_ID	0x08
2965	uint8_t	length;
2966	uint8_t	reserved[2];
2967	uint8_t	attr_desc[0];
2968};
2969
2970/*
2971 * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
2972 *
2973 * Maximum descriptors allowed: 32 (as of SPC-4)
2974 */
2975struct scsi_sense_progress
2976{
2977	uint8_t	desc_type;
2978#define	SSD_DESC_PROGRESS	0x0a
2979	uint8_t	length;
2980	uint8_t	sense_key;
2981	uint8_t	add_sense_code;
2982	uint8_t	add_sense_code_qual;
2983	uint8_t reserved;
2984	uint8_t	progress[2];
2985};
2986
2987/*
2988 * This is typically forwarded as the result of an EXTENDED COPY command.
2989 *
2990 * Maximum descriptors allowed: 2 (as of SPC-4)
2991 */
2992struct scsi_sense_forwarded
2993{
2994	uint8_t	desc_type;
2995#define	SSD_DESC_FORWARDED	0x0c
2996	uint8_t	length;
2997	uint8_t	byte2;
2998#define	SSD_FORWARDED_FSDT	0x80
2999#define	SSD_FORWARDED_SDS_MASK	0x0f
3000#define	SSD_FORWARDED_SDS_UNK	0x00
3001#define	SSD_FORWARDED_SDS_EXSRC	0x01
3002#define	SSD_FORWARDED_SDS_EXDST	0x02
3003};
3004
3005/*
3006 * Vendor-specific sense descriptor.  The desc_type field will be in the
3007 * range bewteen MIN and MAX inclusive.
3008 */
3009struct scsi_sense_vendor
3010{
3011	uint8_t	desc_type;
3012#define	SSD_DESC_VENDOR_MIN	0x80
3013#define	SSD_DESC_VENDOR_MAX	0xff
3014	uint8_t length;
3015	uint8_t	data[0];
3016};
3017
3018struct scsi_mode_header_6
3019{
3020	u_int8_t data_length;	/* Sense data length */
3021	u_int8_t medium_type;
3022	u_int8_t dev_spec;
3023	u_int8_t blk_desc_len;
3024};
3025
3026struct scsi_mode_header_10
3027{
3028	u_int8_t data_length[2];/* Sense data length */
3029	u_int8_t medium_type;
3030	u_int8_t dev_spec;
3031	u_int8_t unused[2];
3032	u_int8_t blk_desc_len[2];
3033};
3034
3035struct scsi_mode_page_header
3036{
3037	u_int8_t page_code;
3038#define	SMPH_PS		0x80
3039#define	SMPH_SPF	0x40
3040#define	SMPH_PC_MASK	0x3f
3041	u_int8_t page_length;
3042};
3043
3044struct scsi_mode_page_header_sp
3045{
3046	uint8_t page_code;
3047	uint8_t subpage;
3048	uint8_t page_length[2];
3049};
3050
3051
3052struct scsi_mode_blk_desc
3053{
3054	u_int8_t density;
3055	u_int8_t nblocks[3];
3056	u_int8_t reserved;
3057	u_int8_t blklen[3];
3058};
3059
3060#define	SCSI_DEFAULT_DENSITY	0x00	/* use 'default' density */
3061#define	SCSI_SAME_DENSITY	0x7f	/* use 'same' density- >= SCSI-2 only */
3062
3063
3064/*
3065 * Status Byte
3066 */
3067#define	SCSI_STATUS_OK			0x00
3068#define	SCSI_STATUS_CHECK_COND		0x02
3069#define	SCSI_STATUS_COND_MET		0x04
3070#define	SCSI_STATUS_BUSY		0x08
3071#define	SCSI_STATUS_INTERMED		0x10
3072#define	SCSI_STATUS_INTERMED_COND_MET	0x14
3073#define	SCSI_STATUS_RESERV_CONFLICT	0x18
3074#define	SCSI_STATUS_CMD_TERMINATED	0x22	/* Obsolete in SAM-2 */
3075#define	SCSI_STATUS_QUEUE_FULL		0x28
3076#define	SCSI_STATUS_ACA_ACTIVE		0x30
3077#define	SCSI_STATUS_TASK_ABORTED	0x40
3078
3079struct scsi_inquiry_pattern {
3080	u_int8_t   type;
3081	u_int8_t   media_type;
3082#define	SIP_MEDIA_REMOVABLE	0x01
3083#define	SIP_MEDIA_FIXED		0x02
3084	const char *vendor;
3085	const char *product;
3086	const char *revision;
3087};
3088
3089struct scsi_static_inquiry_pattern {
3090	u_int8_t   type;
3091	u_int8_t   media_type;
3092	char       vendor[SID_VENDOR_SIZE+1];
3093	char       product[SID_PRODUCT_SIZE+1];
3094	char       revision[SID_REVISION_SIZE+1];
3095};
3096
3097struct scsi_sense_quirk_entry {
3098	struct scsi_inquiry_pattern	inq_pat;
3099	int				num_sense_keys;
3100	int				num_ascs;
3101	struct sense_key_table_entry	*sense_key_info;
3102	struct asc_table_entry		*asc_info;
3103};
3104
3105struct sense_key_table_entry {
3106	u_int8_t    sense_key;
3107	u_int32_t   action;
3108	const char *desc;
3109};
3110
3111struct asc_table_entry {
3112	u_int8_t    asc;
3113	u_int8_t    ascq;
3114	u_int32_t   action;
3115	const char *desc;
3116};
3117
3118struct op_table_entry {
3119	u_int8_t    opcode;
3120	u_int32_t   opmask;
3121	const char  *desc;
3122};
3123
3124struct scsi_op_quirk_entry {
3125	struct scsi_inquiry_pattern	inq_pat;
3126	int				num_ops;
3127	struct op_table_entry		*op_table;
3128};
3129
3130typedef enum {
3131	SSS_FLAG_NONE		= 0x00,
3132	SSS_FLAG_PRINT_COMMAND	= 0x01
3133} scsi_sense_string_flags;
3134
3135struct scsi_nv {
3136	const char *name;
3137	uint64_t value;
3138};
3139
3140typedef enum {
3141	SCSI_NV_FOUND,
3142	SCSI_NV_AMBIGUOUS,
3143	SCSI_NV_NOT_FOUND
3144} scsi_nv_status;
3145
3146typedef enum {
3147	SCSI_NV_FLAG_NONE	= 0x00,
3148	SCSI_NV_FLAG_IG_CASE	= 0x01	/* Case insensitive comparison */
3149} scsi_nv_flags;
3150
3151struct ccb_scsiio;
3152struct cam_periph;
3153union  ccb;
3154#ifndef _KERNEL
3155struct cam_device;
3156#endif
3157
3158extern const char *scsi_sense_key_text[];
3159
3160struct sbuf;
3161
3162__BEGIN_DECLS
3163void scsi_sense_desc(int sense_key, int asc, int ascq,
3164		     struct scsi_inquiry_data *inq_data,
3165		     const char **sense_key_desc, const char **asc_desc);
3166scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
3167				    struct scsi_inquiry_data *inq_data,
3168				    u_int32_t sense_flags);
3169const char *	scsi_status_string(struct ccb_scsiio *csio);
3170
3171void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
3172		       int (*iter_func)(struct scsi_sense_data_desc *sense,
3173					u_int, struct scsi_sense_desc_header *,
3174					void *), void *arg);
3175uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
3176			uint8_t desc_type);
3177void scsi_set_sense_data(struct scsi_sense_data *sense_data,
3178			 scsi_sense_data_type sense_format, int current_error,
3179			 int sense_key, int asc, int ascq, ...) ;
3180void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
3181			    scsi_sense_data_type sense_format,
3182			    int current_error, int sense_key, int asc,
3183			    int ascq, va_list ap);
3184int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
3185			uint8_t info_type, uint64_t *info,
3186			int64_t *signed_info);
3187int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
3188		 uint8_t *sks);
3189int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
3190			struct scsi_inquiry_data *inq_data,
3191			uint8_t *block_bits);
3192int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
3193			 struct scsi_inquiry_data *inq_data,
3194			 uint8_t *stream_bits);
3195void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3196		    struct scsi_inquiry_data *inq_data, uint64_t info);
3197void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
3198		       struct scsi_inquiry_data *inq_data, uint64_t csi);
3199void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
3200int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
3201void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
3202void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
3203void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
3204void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3205			  u_int sense_len, uint8_t *cdb, int cdb_len,
3206			  struct scsi_inquiry_data *inq_data,
3207			  struct scsi_sense_desc_header *header);
3208
3209void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3210			     u_int sense_len, uint8_t *cdb, int cdb_len,
3211			     struct scsi_inquiry_data *inq_data,
3212			     struct scsi_sense_desc_header *header);
3213void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3214			 u_int sense_len, uint8_t *cdb, int cdb_len,
3215			 struct scsi_inquiry_data *inq_data,
3216			 struct scsi_sense_desc_header *header);
3217void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3218			 u_int sense_len, uint8_t *cdb, int cdb_len,
3219			 struct scsi_inquiry_data *inq_data,
3220			 struct scsi_sense_desc_header *header);
3221void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3222			    u_int sense_len, uint8_t *cdb, int cdb_len,
3223			    struct scsi_inquiry_data *inq_data,
3224			    struct scsi_sense_desc_header *header);
3225void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3226			   u_int sense_len, uint8_t *cdb, int cdb_len,
3227			   struct scsi_inquiry_data *inq_data,
3228			   struct scsi_sense_desc_header *header);
3229void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3230			      u_int sense_len, uint8_t *cdb, int cdb_len,
3231			      struct scsi_inquiry_data *inq_data,
3232			      struct scsi_sense_desc_header *header);
3233void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3234			     u_int sense_len, uint8_t *cdb, int cdb_len,
3235			     struct scsi_inquiry_data *inq_data,
3236			     struct scsi_sense_desc_header *header);
3237void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
3238			  u_int sense_len, uint8_t *cdb, int cdb_len,
3239			  struct scsi_inquiry_data *inq_data,
3240			  struct scsi_sense_desc_header *header);
3241scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
3242
3243void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
3244			  struct sbuf *sb, char *path_str,
3245			  struct scsi_inquiry_data *inq_data, uint8_t *cdb,
3246			  int cdb_len);
3247
3248#ifdef _KERNEL
3249int		scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
3250int		scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
3251				scsi_sense_string_flags flags);
3252char *		scsi_sense_string(struct ccb_scsiio *csio,
3253				  char *str, int str_len);
3254void		scsi_sense_print(struct ccb_scsiio *csio);
3255int 		scsi_vpd_supported_page(struct cam_periph *periph,
3256					uint8_t page_id);
3257#else /* _KERNEL */
3258int		scsi_command_string(struct cam_device *device,
3259				    struct ccb_scsiio *csio, struct sbuf *sb);
3260int		scsi_sense_sbuf(struct cam_device *device,
3261				struct ccb_scsiio *csio, struct sbuf *sb,
3262				scsi_sense_string_flags flags);
3263char *		scsi_sense_string(struct cam_device *device,
3264				  struct ccb_scsiio *csio,
3265				  char *str, int str_len);
3266void		scsi_sense_print(struct cam_device *device,
3267				 struct ccb_scsiio *csio, FILE *ofile);
3268#endif /* _KERNEL */
3269
3270const char *	scsi_op_desc(u_int16_t opcode,
3271			     struct scsi_inquiry_data *inq_data);
3272char *		scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
3273				size_t len);
3274
3275void		scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
3276void		scsi_print_inquiry_short(struct scsi_inquiry_data *inq_data);
3277
3278u_int		scsi_calc_syncsrate(u_int period_factor);
3279u_int		scsi_calc_syncparam(u_int period);
3280
3281typedef int	(*scsi_devid_checkfn_t)(uint8_t *);
3282int		scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
3283int		scsi_devid_is_sas_target(uint8_t *bufp);
3284int		scsi_devid_is_lun_eui64(uint8_t *bufp);
3285int		scsi_devid_is_lun_naa(uint8_t *bufp);
3286int		scsi_devid_is_lun_name(uint8_t *bufp);
3287int		scsi_devid_is_lun_t10(uint8_t *bufp);
3288struct scsi_vpd_id_descriptor *
3289		scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
3290			       scsi_devid_checkfn_t ck_fn);
3291struct scsi_vpd_id_descriptor *
3292		scsi_get_devid_desc(struct scsi_vpd_id_descriptor *desc, uint32_t len,
3293			       scsi_devid_checkfn_t ck_fn);
3294
3295int		scsi_transportid_sbuf(struct sbuf *sb,
3296				      struct scsi_transportid_header *hdr,
3297				      uint32_t valid_len);
3298
3299const char *	scsi_nv_to_str(struct scsi_nv *table, int num_table_entries,
3300			       uint64_t value);
3301
3302scsi_nv_status	scsi_get_nv(struct scsi_nv *table, int num_table_entries,
3303			    char *name, int *table_entry, scsi_nv_flags flags);
3304
3305int	scsi_parse_transportid_64bit(int proto_id, char *id_str,
3306				     struct scsi_transportid_header **hdr,
3307				     unsigned int *alloc_len,
3308#ifdef _KERNEL
3309				     struct malloc_type *type, int flags,
3310#endif
3311				     char *error_str, int error_str_len);
3312
3313int	scsi_parse_transportid_spi(char *id_str,
3314				   struct scsi_transportid_header **hdr,
3315				   unsigned int *alloc_len,
3316#ifdef _KERNEL
3317				   struct malloc_type *type, int flags,
3318#endif
3319				   char *error_str, int error_str_len);
3320
3321int	scsi_parse_transportid_rdma(char *id_str,
3322				    struct scsi_transportid_header **hdr,
3323				    unsigned int *alloc_len,
3324#ifdef _KERNEL
3325				    struct malloc_type *type, int flags,
3326#endif
3327				    char *error_str, int error_str_len);
3328
3329int	scsi_parse_transportid_iscsi(char *id_str,
3330				     struct scsi_transportid_header **hdr,
3331				     unsigned int *alloc_len,
3332#ifdef _KERNEL
3333				     struct malloc_type *type, int flags,
3334#endif
3335				     char *error_str,int error_str_len);
3336
3337int	scsi_parse_transportid_sop(char *id_str,
3338				   struct scsi_transportid_header **hdr,
3339				   unsigned int *alloc_len,
3340#ifdef _KERNEL
3341				   struct malloc_type *type, int flags,
3342#endif
3343				   char *error_str,int error_str_len);
3344
3345int	scsi_parse_transportid(char *transportid_str,
3346			       struct scsi_transportid_header **hdr,
3347			       unsigned int *alloc_len,
3348#ifdef _KERNEL
3349			       struct malloc_type *type, int flags,
3350#endif
3351			       char *error_str, int error_str_len);
3352
3353void		scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
3354				     void (*cbfcnp)(struct cam_periph *,
3355						    union ccb *),
3356				     u_int8_t tag_action,
3357				     u_int8_t sense_len, u_int32_t timeout);
3358
3359void		scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
3360				   void (*cbfcnp)(struct cam_periph *,
3361						  union ccb *),
3362				   void *data_ptr, u_int8_t dxfer_len,
3363				   u_int8_t tag_action, u_int8_t sense_len,
3364				   u_int32_t timeout);
3365
3366void		scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
3367			     void (*cbfcnp)(struct cam_periph *, union ccb *),
3368			     u_int8_t tag_action, u_int8_t *inq_buf,
3369			     u_int32_t inq_len, int evpd, u_int8_t page_code,
3370			     u_int8_t sense_len, u_int32_t timeout);
3371
3372void		scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
3373				void (*cbfcnp)(struct cam_periph *,
3374					       union ccb *),
3375				u_int8_t tag_action, int dbd,
3376				u_int8_t page_code, u_int8_t page,
3377				u_int8_t *param_buf, u_int32_t param_len,
3378				u_int8_t sense_len, u_int32_t timeout);
3379
3380void		scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
3381				    void (*cbfcnp)(struct cam_periph *,
3382						   union ccb *),
3383				    u_int8_t tag_action, int dbd,
3384				    u_int8_t page_code, u_int8_t page,
3385				    u_int8_t *param_buf, u_int32_t param_len,
3386				    int minimum_cmd_size, u_int8_t sense_len,
3387				    u_int32_t timeout);
3388
3389void		scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
3390				 void (*cbfcnp)(struct cam_periph *,
3391						union ccb *),
3392				 u_int8_t tag_action, int scsi_page_fmt,
3393				 int save_pages, u_int8_t *param_buf,
3394				 u_int32_t param_len, u_int8_t sense_len,
3395				 u_int32_t timeout);
3396
3397void		scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
3398				     void (*cbfcnp)(struct cam_periph *,
3399						    union ccb *),
3400				     u_int8_t tag_action, int scsi_page_fmt,
3401				     int save_pages, u_int8_t *param_buf,
3402				     u_int32_t param_len, int minimum_cmd_size,
3403				     u_int8_t sense_len, u_int32_t timeout);
3404
3405void		scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
3406			       void (*cbfcnp)(struct cam_periph *, union ccb *),
3407			       u_int8_t tag_action, u_int8_t page_code,
3408			       u_int8_t page, int save_pages, int ppc,
3409			       u_int32_t paramptr, u_int8_t *param_buf,
3410			       u_int32_t param_len, u_int8_t sense_len,
3411			       u_int32_t timeout);
3412
3413void		scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
3414				void (*cbfcnp)(struct cam_periph *,
3415				union ccb *), u_int8_t tag_action,
3416				u_int8_t page_code, int save_pages,
3417				int pc_reset, u_int8_t *param_buf,
3418				u_int32_t param_len, u_int8_t sense_len,
3419				u_int32_t timeout);
3420
3421void		scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
3422			     void (*cbfcnp)(struct cam_periph *, union ccb *),
3423			     u_int8_t tag_action, u_int8_t action,
3424			     u_int8_t sense_len, u_int32_t timeout);
3425
3426void		scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
3427				   void (*cbfcnp)(struct cam_periph *,
3428				   union ccb *), u_int8_t tag_action,
3429				   struct scsi_read_capacity_data *,
3430				   u_int8_t sense_len, u_int32_t timeout);
3431void		scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
3432				      void (*cbfcnp)(struct cam_periph *,
3433				      union ccb *), uint8_t tag_action,
3434				      uint64_t lba, int reladr, int pmi,
3435				      uint8_t *rcap_buf, int rcap_buf_len,
3436				      uint8_t sense_len, uint32_t timeout);
3437
3438void		scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
3439				 void (*cbfcnp)(struct cam_periph *,
3440				 union ccb *), u_int8_t tag_action,
3441				 u_int8_t select_report,
3442				 struct scsi_report_luns_data *rpl_buf,
3443				 u_int32_t alloc_len, u_int8_t sense_len,
3444				 u_int32_t timeout);
3445
3446void		scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3447				 void (*cbfcnp)(struct cam_periph *,
3448				 union ccb *), u_int8_t tag_action,
3449				 u_int8_t pdf,
3450				 void *buf,
3451				 u_int32_t alloc_len, u_int8_t sense_len,
3452				 u_int32_t timeout);
3453
3454void		scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
3455				 void (*cbfcnp)(struct cam_periph *,
3456				 union ccb *), u_int8_t tag_action, void *buf,
3457				 u_int32_t alloc_len, u_int8_t sense_len,
3458				 u_int32_t timeout);
3459
3460void		scsi_synchronize_cache(struct ccb_scsiio *csio,
3461				       u_int32_t retries,
3462				       void (*cbfcnp)(struct cam_periph *,
3463				       union ccb *), u_int8_t tag_action,
3464				       u_int32_t begin_lba, u_int16_t lb_count,
3465				       u_int8_t sense_len, u_int32_t timeout);
3466
3467void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
3468				     void (*cbfcnp)(struct cam_periph *,
3469						    union ccb*),
3470				     uint8_t tag_action, int pcv,
3471				     uint8_t page_code, uint8_t *data_ptr,
3472				     uint16_t allocation_length,
3473				     uint8_t sense_len, uint32_t timeout);
3474
3475void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
3476			  void (*cbfcnp)(struct cam_periph *, union ccb *),
3477			  uint8_t tag_action, int unit_offline,
3478			  int device_offline, int self_test, int page_format,
3479			  int self_test_code, uint8_t *data_ptr,
3480			  uint16_t param_list_length, uint8_t sense_len,
3481			  uint32_t timeout);
3482
3483void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
3484			void (*cbfcnp)(struct cam_periph *, union ccb*),
3485			uint8_t tag_action, int mode,
3486			uint8_t buffer_id, u_int32_t offset,
3487			uint8_t *data_ptr, uint32_t allocation_length,
3488			uint8_t sense_len, uint32_t timeout);
3489
3490void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
3491			void (*cbfcnp)(struct cam_periph *, union ccb *),
3492			uint8_t tag_action, int mode,
3493			uint8_t buffer_id, u_int32_t offset,
3494			uint8_t *data_ptr, uint32_t param_list_length,
3495			uint8_t sense_len, uint32_t timeout);
3496
3497#define	SCSI_RW_READ	0x0001
3498#define	SCSI_RW_WRITE	0x0002
3499#define	SCSI_RW_DIRMASK	0x0003
3500#define	SCSI_RW_BIO	0x1000
3501void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
3502		     void (*cbfcnp)(struct cam_periph *, union ccb *),
3503		     u_int8_t tag_action, int readop, u_int8_t byte2,
3504		     int minimum_cmd_size, u_int64_t lba,
3505		     u_int32_t block_count, u_int8_t *data_ptr,
3506		     u_int32_t dxfer_len, u_int8_t sense_len,
3507		     u_int32_t timeout);
3508
3509void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
3510		     void (*cbfcnp)(struct cam_periph *, union ccb *),
3511		     u_int8_t tag_action, u_int8_t byte2,
3512		     int minimum_cmd_size, u_int64_t lba,
3513		     u_int32_t block_count, u_int8_t *data_ptr,
3514		     u_int32_t dxfer_len, u_int8_t sense_len,
3515		     u_int32_t timeout);
3516
3517void scsi_ata_identify(struct ccb_scsiio *csio, u_int32_t retries,
3518		       void (*cbfcnp)(struct cam_periph *, union ccb *),
3519		       u_int8_t tag_action, u_int8_t *data_ptr,
3520		       u_int16_t dxfer_len, u_int8_t sense_len,
3521		       u_int32_t timeout);
3522
3523void scsi_ata_trim(struct ccb_scsiio *csio, u_int32_t retries,
3524	           void (*cbfcnp)(struct cam_periph *, union ccb *),
3525	           u_int8_t tag_action, u_int16_t block_count,
3526	           u_int8_t *data_ptr, u_int16_t dxfer_len,
3527	           u_int8_t sense_len, u_int32_t timeout);
3528
3529void scsi_ata_pass_16(struct ccb_scsiio *csio, u_int32_t retries,
3530		      void (*cbfcnp)(struct cam_periph *, union ccb *),
3531		      u_int32_t flags, u_int8_t tag_action,
3532		      u_int8_t protocol, u_int8_t ata_flags, u_int16_t features,
3533		      u_int16_t sector_count, uint64_t lba, u_int8_t command,
3534		      u_int8_t control, u_int8_t *data_ptr, u_int16_t dxfer_len,
3535		      u_int8_t sense_len, u_int32_t timeout);
3536
3537void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
3538		void (*cbfcnp)(struct cam_periph *, union ccb *),
3539		u_int8_t tag_action, u_int8_t byte2,
3540		u_int8_t *data_ptr, u_int16_t dxfer_len,
3541		u_int8_t sense_len, u_int32_t timeout);
3542
3543void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
3544		     void (*cbfcnp)(struct cam_periph *, union ccb *),
3545		     u_int8_t tag_action, int start, int load_eject,
3546		     int immediate, u_int8_t sense_len, u_int32_t timeout);
3547
3548void scsi_persistent_reserve_in(struct ccb_scsiio *csio, uint32_t retries,
3549				void (*cbfcnp)(struct cam_periph *,union ccb *),
3550				uint8_t tag_action, int service_action,
3551				uint8_t *data_ptr, uint32_t dxfer_len,
3552				int sense_len, int timeout);
3553
3554void scsi_persistent_reserve_out(struct ccb_scsiio *csio, uint32_t retries,
3555				 void (*cbfcnp)(struct cam_periph *,
3556				       union ccb *),
3557				 uint8_t tag_action, int service_action,
3558				 int scope, int res_type, uint8_t *data_ptr,
3559				 uint32_t dxfer_len, int sense_len,
3560				 int timeout);
3561
3562int		scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
3563int		scsi_static_inquiry_match(caddr_t inqbuffer,
3564					  caddr_t table_entry);
3565int		scsi_devid_match(uint8_t *rhs, size_t rhs_len,
3566				 uint8_t *lhs, size_t lhs_len);
3567
3568void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
3569			int *sense_key, int *asc, int *ascq);
3570int scsi_extract_sense_ccb(union ccb *ccb, int *error_code, int *sense_key,
3571			   int *asc, int *ascq);
3572void scsi_extract_sense_len(struct scsi_sense_data *sense,
3573			    u_int sense_len, int *error_code, int *sense_key,
3574			    int *asc, int *ascq, int show_errors);
3575int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
3576		       int show_errors);
3577int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
3578		 int show_errors);
3579int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
3580		  int show_errors);
3581static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
3582static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
3583static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
3584static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
3585static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
3586static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
3587static __inline int32_t scsi_3btol(const uint8_t *bytes);
3588static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
3589static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
3590static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
3591static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
3592
3593static __inline void
3594scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
3595{
3596
3597	bytes[0] = (val >> 8) & 0xff;
3598	bytes[1] = val & 0xff;
3599}
3600
3601static __inline void
3602scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
3603{
3604
3605	bytes[0] = (val >> 16) & 0xff;
3606	bytes[1] = (val >> 8) & 0xff;
3607	bytes[2] = val & 0xff;
3608}
3609
3610static __inline void
3611scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
3612{
3613
3614	bytes[0] = (val >> 24) & 0xff;
3615	bytes[1] = (val >> 16) & 0xff;
3616	bytes[2] = (val >> 8) & 0xff;
3617	bytes[3] = val & 0xff;
3618}
3619
3620static __inline void
3621scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
3622{
3623
3624	bytes[0] = (val >> 56) & 0xff;
3625	bytes[1] = (val >> 48) & 0xff;
3626	bytes[2] = (val >> 40) & 0xff;
3627	bytes[3] = (val >> 32) & 0xff;
3628	bytes[4] = (val >> 24) & 0xff;
3629	bytes[5] = (val >> 16) & 0xff;
3630	bytes[6] = (val >> 8) & 0xff;
3631	bytes[7] = val & 0xff;
3632}
3633
3634static __inline uint32_t
3635scsi_2btoul(const uint8_t *bytes)
3636{
3637	uint32_t rv;
3638
3639	rv = (bytes[0] << 8) |
3640	     bytes[1];
3641	return (rv);
3642}
3643
3644static __inline uint32_t
3645scsi_3btoul(const uint8_t *bytes)
3646{
3647	uint32_t rv;
3648
3649	rv = (bytes[0] << 16) |
3650	     (bytes[1] << 8) |
3651	     bytes[2];
3652	return (rv);
3653}
3654
3655static __inline int32_t
3656scsi_3btol(const uint8_t *bytes)
3657{
3658	uint32_t rc = scsi_3btoul(bytes);
3659
3660	if (rc & 0x00800000)
3661		rc |= 0xff000000;
3662
3663	return (int32_t) rc;
3664}
3665
3666static __inline uint32_t
3667scsi_4btoul(const uint8_t *bytes)
3668{
3669	uint32_t rv;
3670
3671	rv = (bytes[0] << 24) |
3672	     (bytes[1] << 16) |
3673	     (bytes[2] << 8) |
3674	     bytes[3];
3675	return (rv);
3676}
3677
3678static __inline uint64_t
3679scsi_8btou64(const uint8_t *bytes)
3680{
3681        uint64_t rv;
3682
3683	rv = (((uint64_t)bytes[0]) << 56) |
3684	     (((uint64_t)bytes[1]) << 48) |
3685	     (((uint64_t)bytes[2]) << 40) |
3686	     (((uint64_t)bytes[3]) << 32) |
3687	     (((uint64_t)bytes[4]) << 24) |
3688	     (((uint64_t)bytes[5]) << 16) |
3689	     (((uint64_t)bytes[6]) << 8) |
3690	     bytes[7];
3691	return (rv);
3692}
3693
3694/*
3695 * Given the pointer to a returned mode sense buffer, return a pointer to
3696 * the start of the first mode page.
3697 */
3698static __inline void *
3699find_mode_page_6(struct scsi_mode_header_6 *mode_header)
3700{
3701	void *page_start;
3702
3703	page_start = (void *)((u_int8_t *)&mode_header[1] +
3704			      mode_header->blk_desc_len);
3705
3706	return(page_start);
3707}
3708
3709static __inline void *
3710find_mode_page_10(struct scsi_mode_header_10 *mode_header)
3711{
3712	void *page_start;
3713
3714	page_start = (void *)((u_int8_t *)&mode_header[1] +
3715			       scsi_2btoul(mode_header->blk_desc_len));
3716
3717	return(page_start);
3718}
3719
3720__END_DECLS
3721
3722#endif /*_SCSI_SCSI_ALL_H*/
3723