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