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