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