xref: /openbsd-src/sys/scsi/scsi_all.h (revision e471ee1c3dc2f7a641cea4a943d9faa30deaf24b)
1*e471ee1cSjsg /*	$OpenBSD: scsi_all.h,v 1.65 2022/01/11 23:10:11 jsg Exp $	*/
2cb3ad6e3Sdownsj /*	$NetBSD: scsi_all.h,v 1.10 1996/09/12 01:57:17 thorpej Exp $	*/
3df930be7Sderaadt 
4df930be7Sderaadt /*
5df930be7Sderaadt  * SCSI general  interface description
6df930be7Sderaadt  */
7df930be7Sderaadt 
8df930be7Sderaadt /*
9df930be7Sderaadt  * Largely written by Julian Elischer (julian@tfs.com)
10df930be7Sderaadt  * for TRW Financial Systems.
11df930be7Sderaadt  *
12df930be7Sderaadt  * TRW Financial Systems, in accordance with their agreement with Carnegie
13df930be7Sderaadt  * Mellon University, makes this software available to CMU to distribute
14df930be7Sderaadt  * or use in any manner that they see fit as long as this message is kept with
15df930be7Sderaadt  * the software. For this reason TFS also grants any other persons or
16df930be7Sderaadt  * organisations permission to use or modify this software.
17df930be7Sderaadt  *
18df930be7Sderaadt  * TFS supplies this software to be publicly redistributed
19df930be7Sderaadt  * on the understanding that TFS is not responsible for the correct
20df930be7Sderaadt  * functioning of this software in any circumstances.
21df930be7Sderaadt  *
22df930be7Sderaadt  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
23df930be7Sderaadt  */
24df930be7Sderaadt 
25df930be7Sderaadt #ifndef	_SCSI_SCSI_ALL_H
26dd0887e4Skrw #define _SCSI_SCSI_ALL_H
27df930be7Sderaadt 
28df930be7Sderaadt /*
29df930be7Sderaadt  * SCSI command format
30df930be7Sderaadt  */
31df930be7Sderaadt 
32df930be7Sderaadt /*
33d5d18b89Skrw  * Define some bits that are in ALL (or a lot of) scsi commands
34df930be7Sderaadt  */
35df930be7Sderaadt #define SCSI_CTL_LINK		0x01
36df930be7Sderaadt #define SCSI_CTL_FLAG		0x02
37df930be7Sderaadt #define SCSI_CTL_VENDOR		0xC0
38cb3ad6e3Sdownsj 
39cb3ad6e3Sdownsj 
40cb3ad6e3Sdownsj /*
41cb3ad6e3Sdownsj  * Some old SCSI devices need the LUN to be set in the top 3 bits of the
42cb3ad6e3Sdownsj  * second byte of the CDB.
43cb3ad6e3Sdownsj  */
44cb3ad6e3Sdownsj #define	SCSI_CMD_LUN_MASK	0xe0
45cb3ad6e3Sdownsj #define	SCSI_CMD_LUN_SHIFT	5
46df930be7Sderaadt 
47df930be7Sderaadt 
48df930be7Sderaadt struct scsi_generic {
49df930be7Sderaadt 	u_int8_t opcode;
5034365fb8Sweingart 	u_int8_t bytes[15];
51df930be7Sderaadt };
52df930be7Sderaadt 
53df930be7Sderaadt struct scsi_test_unit_ready {
54df930be7Sderaadt 	u_int8_t opcode;
55df930be7Sderaadt 	u_int8_t byte2;
56df930be7Sderaadt 	u_int8_t unused[3];
57df930be7Sderaadt 	u_int8_t control;
58df930be7Sderaadt };
59df930be7Sderaadt 
60df930be7Sderaadt struct scsi_send_diag {
61df930be7Sderaadt 	u_int8_t opcode;
62df930be7Sderaadt 	u_int8_t byte2;
63df930be7Sderaadt #define	SSD_UOL		0x01
64df930be7Sderaadt #define	SSD_DOL		0x02
65df930be7Sderaadt #define	SSD_SELFTEST	0x04
66df930be7Sderaadt #define	SSD_PF		0x10
67df930be7Sderaadt 	u_int8_t unused[1];
68df930be7Sderaadt 	u_int8_t paramlen[2];
69df930be7Sderaadt 	u_int8_t control;
70df930be7Sderaadt };
71df930be7Sderaadt 
72df930be7Sderaadt struct scsi_sense {
73df930be7Sderaadt 	u_int8_t opcode;
74df930be7Sderaadt 	u_int8_t byte2;
75df930be7Sderaadt 	u_int8_t unused[2];
76df930be7Sderaadt 	u_int8_t length;
77df930be7Sderaadt 	u_int8_t control;
78df930be7Sderaadt };
79df930be7Sderaadt 
80df930be7Sderaadt struct scsi_inquiry {
81df930be7Sderaadt 	u_int8_t opcode;
821e0da027Sdlg 	u_int8_t flags;
830c051c5eSmarco #define SI_EVPD		0x01
841e0da027Sdlg 	u_int8_t pagecode;
85e82775ceSdlg #define SI_PG_SUPPORTED	0x00
8688c242beSdlg #define SI_PG_SERIAL	0x80
87e82775ceSdlg #define SI_PG_DEVID	0x83
88f0e1c144Sdlg #define SI_PG_ATA	0x89
891e0da027Sdlg 	u_int8_t length[2];
90df930be7Sderaadt 	u_int8_t control;
91df930be7Sderaadt };
92df930be7Sderaadt 
93df930be7Sderaadt struct scsi_mode_sense {
94df930be7Sderaadt 	u_int8_t opcode;
95df930be7Sderaadt 	u_int8_t byte2;
967d360fa7Skrw #define	SMS_DBD				0x08	/* Disable Block Descriptors */
97df930be7Sderaadt 	u_int8_t page;
98df930be7Sderaadt #define	SMS_PAGE_CODE			0x3F
99df930be7Sderaadt #define	SMS_PAGE_CTRL			0xC0
100df930be7Sderaadt #define	SMS_PAGE_CTRL_CURRENT		0x00
101df930be7Sderaadt #define	SMS_PAGE_CTRL_CHANGEABLE	0x40
102df930be7Sderaadt #define	SMS_PAGE_CTRL_DEFAULT		0x80
103df930be7Sderaadt #define	SMS_PAGE_CTRL_SAVED		0xC0
104df930be7Sderaadt 	u_int8_t unused;
105df930be7Sderaadt 	u_int8_t length;
106df930be7Sderaadt 	u_int8_t control;
107df930be7Sderaadt };
108df930be7Sderaadt 
109df930be7Sderaadt struct scsi_mode_sense_big {
110df930be7Sderaadt 	u_int8_t opcode;
111df930be7Sderaadt 	u_int8_t byte2;				/* same bits as small version */
1127d360fa7Skrw #define SMS_LLBAA			0x10	/*    plus: Long LBA Accepted */
113df930be7Sderaadt 	u_int8_t page;				/* same bits as small version */
114df930be7Sderaadt 	u_int8_t unused[4];
115df930be7Sderaadt 	u_int8_t length[2];
116df930be7Sderaadt 	u_int8_t control;
117df930be7Sderaadt };
118df930be7Sderaadt 
119df930be7Sderaadt struct scsi_mode_select {
120df930be7Sderaadt 	u_int8_t opcode;
121df930be7Sderaadt 	u_int8_t byte2;
122df930be7Sderaadt #define	SMS_SP	0x01
123df930be7Sderaadt #define	SMS_PF	0x10
124df930be7Sderaadt 	u_int8_t unused[2];
125df930be7Sderaadt 	u_int8_t length;
126df930be7Sderaadt 	u_int8_t control;
127df930be7Sderaadt };
128df930be7Sderaadt 
129df930be7Sderaadt struct scsi_mode_select_big {
130df930be7Sderaadt 	u_int8_t opcode;
131df930be7Sderaadt 	u_int8_t byte2;		/* same bits as small version */
132df930be7Sderaadt 	u_int8_t unused[5];
133df930be7Sderaadt 	u_int8_t length[2];
134df930be7Sderaadt 	u_int8_t control;
135df930be7Sderaadt };
136df930be7Sderaadt 
137df930be7Sderaadt struct scsi_reserve {
138df930be7Sderaadt 	u_int8_t opcode;
139df930be7Sderaadt 	u_int8_t byte2;
140df930be7Sderaadt 	u_int8_t unused[2];
141df930be7Sderaadt 	u_int8_t length;
142df930be7Sderaadt 	u_int8_t control;
143df930be7Sderaadt };
144df930be7Sderaadt 
145df930be7Sderaadt struct scsi_release {
146df930be7Sderaadt 	u_int8_t opcode;
147df930be7Sderaadt 	u_int8_t byte2;
148df930be7Sderaadt 	u_int8_t unused[2];
149df930be7Sderaadt 	u_int8_t length;
150df930be7Sderaadt 	u_int8_t control;
151df930be7Sderaadt };
152df930be7Sderaadt 
153df930be7Sderaadt struct scsi_prevent {
154df930be7Sderaadt 	u_int8_t opcode;
155df930be7Sderaadt 	u_int8_t byte2;
156df930be7Sderaadt 	u_int8_t unused[2];
157df930be7Sderaadt 	u_int8_t how;
158df930be7Sderaadt 	u_int8_t control;
159df930be7Sderaadt };
160df930be7Sderaadt #define	PR_PREVENT 0x01
161df930be7Sderaadt #define PR_ALLOW   0x00
162df930be7Sderaadt 
163a022b481Skrw struct scsi_report_luns {
164a022b481Skrw 	u_int8_t opcode;
165a022b481Skrw 	u_int8_t unused;
166a022b481Skrw 	u_int8_t selectreport;
167a022b481Skrw #define	REPORT_NORMAL		0x00
168a022b481Skrw #define	REPORT_WELLKNOWN	0x01
169a022b481Skrw #define	REPORT_ALL		0x02
170a022b481Skrw 	u_int8_t unused2[3];
171a022b481Skrw 	u_int8_t length[4];
172a022b481Skrw 	u_int8_t unused4;
173a022b481Skrw 	u_int8_t control;
174a022b481Skrw };
175a022b481Skrw 
176df930be7Sderaadt /*
177df930be7Sderaadt  * Opcodes
178df930be7Sderaadt  */
179df930be7Sderaadt #define	TEST_UNIT_READY		0x00
180df930be7Sderaadt #define REQUEST_SENSE		0x03
181df930be7Sderaadt #define INQUIRY			0x12
182df930be7Sderaadt #define MODE_SELECT		0x15
183df930be7Sderaadt #define RESERVE			0x16
184df930be7Sderaadt #define RELEASE			0x17
185088be111Smarco #define MODE_SENSE		0x1a
186088be111Smarco #define START_STOP		0x1b
187088be111Smarco #define RECEIVE_DIAGNOSTIC	0x1c
188088be111Smarco #define SEND_DIAGNOSTIC		0x1d
189df930be7Sderaadt #define PREVENT_ALLOW		0x1e
190df930be7Sderaadt #define POSITION_TO_ELEMENT	0x2b
19115925805Sdlg #define WRITE_BUFFER		0x3b
192cbeac206Sdlg #define READ_BUFFER		0x3c
193df930be7Sderaadt #define	CHANGE_DEFINITION	0x40
194df930be7Sderaadt #define	MODE_SELECT_BIG		0x55
19500d447a7Skrw #define	MODE_SENSE_BIG		0x5a
196a022b481Skrw #define	REPORT_LUNS		0xa0
197df930be7Sderaadt 
198df930be7Sderaadt /*
19973c26637Sdownsj  * Sort of an extra one, for SCSI_RESET.
20073c26637Sdownsj  */
20173c26637Sdownsj #define GENRETRY		1
20273c26637Sdownsj 
20373c26637Sdownsj /*
204173a6623Skrw  * Device Types
205df930be7Sderaadt  */
206173a6623Skrw #define T_DIRECT	0x00	/* Direct access block device (SBC-4) */
207173a6623Skrw #define T_SEQUENTIAL	0x01	/* Sequential access device (SSC-3) */
208173a6623Skrw #define T_PRINTER	0x02	/* Printer device (SSC) */
209173a6623Skrw #define T_PROCESSOR	0x03	/* Processor device (SPC-2) */
210173a6623Skrw #define T_WORM		0x04	/* Write once device (SBC) */
211173a6623Skrw #define T_CDROM		0x05	/* CD/DVD device (MMC-5) */
212173a6623Skrw #define T_SCANNER	0x06	/* Scanner device (Obsolete) */
213173a6623Skrw #define T_OPTICAL	0x07	/* Optical memory device (SBC) */
214173a6623Skrw #define T_CHANGER	0x08	/* Media changer device (SMC-3) */
215173a6623Skrw #define T_COMM		0x09	/* Communications device (Obsolete) */
216173a6623Skrw #define T_ASC0		0x0a	/* Obsolete */
217173a6623Skrw #define T_ASC1		0x0b	/* Obsolete */
218173a6623Skrw #define T_STORARRAY	0x0c	/* Storage Array controller device (RAID) */
219173a6623Skrw #define T_ENCLOSURE	0x0d	/* Enclosure services device (SES) */
220173a6623Skrw #define T_RDIRECT	0x0e	/* Simplified direct access device (RBC) */
221173a6623Skrw #define T_OCRW		0x0f	/* Optical card reader/writer (OCRW) */
222173a6623Skrw #define T_BCC		0x10	/* Bridge Controller Commands (BCC) */
223173a6623Skrw #define T_OSD		0x11	/* Object-based Storage device (OSD) */
224173a6623Skrw #define T_ADC		0x12	/* Automation/Drive Interface (ADC-2) */
225173a6623Skrw /* 0x13 - 0x1d RESERVED */
226*e471ee1cSjsg #define T_WELL_KNOWN_LU	0x1e	/* Well known logical unit */
227173a6623Skrw #define T_NODEVICE	0x1F	/* Unknown or no device type */
228df930be7Sderaadt 
229df930be7Sderaadt #define T_REMOV		1
230df930be7Sderaadt #define	T_FIXED		0
231df930be7Sderaadt 
232df930be7Sderaadt struct scsi_inquiry_data {
233df930be7Sderaadt 	u_int8_t device;
2342acb7c00Skrw #define	SID_TYPE		0x1f
2352acb7c00Skrw #define	SID_QUAL		0xe0
236df930be7Sderaadt #define		SID_QUAL_LU_OK		0x00
237df930be7Sderaadt #define		SID_QUAL_LU_OFFLINE	0x20
238df930be7Sderaadt #define		SID_QUAL_RSVD		0x40
239df930be7Sderaadt #define		SID_QUAL_BAD_LU		0x60
240df930be7Sderaadt 	u_int8_t dev_qual2;
2412acb7c00Skrw #define	SID_QUAL2		0x7f
242df930be7Sderaadt #define	SID_REMOVABLE		0x80
243df930be7Sderaadt 	u_int8_t version;
244df930be7Sderaadt #define SID_ANSII		0x07
245df930be7Sderaadt #define SID_ECMA		0x38
2462acb7c00Skrw #define SID_ISO			0xc0
247df930be7Sderaadt 	u_int8_t response_format;
2482acb7c00Skrw #define SID_RESPONSE_DATA_FMT	0x0f	/* < 2 == obsolete, > 2 reserved! */
249ed09ea98Skrw #define		SID_SCSI2_RESPONSE	0x02
2502acb7c00Skrw #define SID_HiSup		0x10	/* Hierarchical LUNs */
2512acb7c00Skrw #define SID_NormACA		0x20	/* Normal ACA bit in CCB supported */
2522acb7c00Skrw #define SID_TrmIOP		0x40	/* obsolete */
2532acb7c00Skrw #define SID_AENC		0x80	/* obsolete */
254df930be7Sderaadt 	u_int8_t additional_length;
25565e0582eSkrw #define SID_SCSI2_HDRLEN	5	/* Bytes up to & including additional_length */
256f0e7a9c7Skrw #define SID_SCSI2_ALEN		31	/* Additional bytes of basic SCSI2 info */
2572acb7c00Skrw 	u_int8_t spc3_flags;
2582acb7c00Skrw #define SPC3_SID_PROTECT	0x01	/* 0 == Type 0, 1 == Type 1, 2 or 3 */
2592acb7c00Skrw #define SPC3_SID_RESERVED	0x06
2602acb7c00Skrw #define SPC3_SID_3PC		0x08	/* 3rd party copy */
2612acb7c00Skrw #define SPC3_SID_TPGS_IMPLICIT	0x10	/* Implicit asymmetric LU access */
2622acb7c00Skrw #define SPC3_SID_TPGS_EXPLICIT	0x20	/* Explicit asymmetric LU access */
2632acb7c00Skrw #define SPC3_SID_ACC		0x40	/* Access controls controller */
2642acb7c00Skrw #define SPC3_SID_SCCS		0x80	/* Embedded storage array controller */
2652acb7c00Skrw 	u_int8_t spc2_flags;
2662acb7c00Skrw #define SPC2_SID_ADDR16		0x01	/* obsolete */
2672acb7c00Skrw #define SPC2_RESERVED		0x06
2682acb7c00Skrw #define SPC2_SID_NChngr		0x08	/* obsolete */
2692acb7c00Skrw #define SPC2_SID_MultiP		0x10	/* multi-port target */
2702acb7c00Skrw #define SPC2_VS			0x20	/* ??? */
2712acb7c00Skrw #define SPC2_SID_EncServ	0x40	/* Embedded enclosure services */
2722acb7c00Skrw #define SPC2_SID_BQueue		0x80	/* obsolete */
273df930be7Sderaadt 	u_int8_t flags;
2742acb7c00Skrw #define	SID_VS			0x01	/* ??? */
275*e471ee1cSjsg #define	SID_CmdQue		0x02	/* Task management mode supported */
2762acb7c00Skrw #define	SID_Linked		0x08	/* obsolete */
2772acb7c00Skrw #define	SID_Sync		0x10	/* obsolete */
2782acb7c00Skrw #define	SID_WBus16		0x20	/* obsolete */
2792acb7c00Skrw #define	SID_WBus32		0x40	/* obsolete */
2802acb7c00Skrw #define	SID_RelAdr		0x80	/* obsolete */
281df930be7Sderaadt 	char	vendor[8];
282df930be7Sderaadt 	char	product[16];
283df930be7Sderaadt 	char	revision[4];
284693b9db0Skrw 	u_int8_t extra[20];
2852acb7c00Skrw 	u_int8_t reserved[2];
286f2840357Skrw 	u_int8_t version_descriptor0[2];
287f2840357Skrw 	u_int8_t version_descriptor1[2];
288f2840357Skrw 	u_int8_t version_descriptor2[2];
289f2840357Skrw 	u_int8_t version_descriptor3[2];
290f2840357Skrw 	u_int8_t version_descriptor4[2];
291f2840357Skrw 	u_int8_t version_descriptor5[2];
292f2840357Skrw 	u_int8_t version_descriptor6[2];
293f2840357Skrw 	u_int8_t version_descriptor7[2];
294f2840357Skrw 	u_int8_t reserved2[22];
295df930be7Sderaadt };
296df930be7Sderaadt 
297e82775ceSdlg struct scsi_vpd_hdr {
2980c051c5eSmarco 	u_int8_t device;
2990c051c5eSmarco 	u_int8_t page_code;
300c6c609d5Sdlg 	u_int8_t page_length[2];
301e82775ceSdlg };
302e82775ceSdlg 
303e82775ceSdlg struct scsi_vpd_serial {
304e82775ceSdlg 	struct scsi_vpd_hdr hdr;
3050c051c5eSmarco 	char serial[32];
3060c051c5eSmarco };
3070c051c5eSmarco 
308e82775ceSdlg #define VPD_PROTO_ID_FC		0x0 /* Fibre Channel */
309e82775ceSdlg #define VPD_PROTO_ID_SPI	0x1 /* Parallel SCSI */
310e82775ceSdlg #define VPD_PROTO_ID_SSA	0x2
311e82775ceSdlg #define VPD_PROTO_ID_IEEE1394	0x3
312e82775ceSdlg #define VPD_PROTO_ID_SRP	0x4 /* SCSI RDMA Protocol */
313e82775ceSdlg #define VPD_PROTO_ID_ISCSI	0x5 /* Internet SCSI (iSCSI) */
314e82775ceSdlg #define VPD_PROTO_ID_SAS	0x6 /* Serial Attached SCSI */
315e82775ceSdlg #define VPD_PROTO_ID_ADT	0x7 /* Automation/Drive Interface Transport */
316e82775ceSdlg #define VPD_PROTO_ID_ATA	0x7 /* ATA/ATAPI */
317e82775ceSdlg #define VPD_PROTO_ID_NONE	0xf
318e82775ceSdlg 
319e82775ceSdlg struct scsi_vpd_devid_hdr {
320e82775ceSdlg 	u_int8_t pi_code;
32126d2dbbdSdlg #define VPD_DEVID_PI(_f)	(((_f) >> 4) & 0x0f)
322e82775ceSdlg #define VPD_DEVID_CODE(_f)	(((_f) >> 0) & 0x0f)
323e82775ceSdlg #define VPD_DEVID_CODE_BINARY		0x1
324e82775ceSdlg #define VPD_DEVID_CODE_ASCII		0x2
325e82775ceSdlg #define VPD_DEVID_CODE_UTF8		0x3
326e82775ceSdlg 	u_int8_t flags;
327e82775ceSdlg #define VPD_DEVID_PIV		0x80
32895acbd04Sdlg #define VPD_DEVID_ASSOC(_f)	((_f) & 0x30)
329e82775ceSdlg #define VPD_DEVID_ASSOC_LU		0x00
330e82775ceSdlg #define VPD_DEVID_ASSOC_PORT		0x10
331e82775ceSdlg #define VPD_DEVID_ASSOC_TARG		0x20
33295acbd04Sdlg #define VPD_DEVID_TYPE(_f)	((_f) & 0x0f)
333e82775ceSdlg #define VPD_DEVID_TYPE_VENDOR		0x0
334e82775ceSdlg #define VPD_DEVID_TYPE_T10		0x1
335e82775ceSdlg #define VPD_DEVID_TYPE_EUI64		0x2
336e82775ceSdlg #define VPD_DEVID_TYPE_NAA		0x3
337e82775ceSdlg #define VPD_DEVID_TYPE_RELATIVE		0x4
338e82775ceSdlg #define VPD_DEVID_TYPE_PORT		0x5
339e82775ceSdlg #define VPD_DEVID_TYPE_LU		0x6
340e82775ceSdlg #define VPD_DEVID_TYPE_MD5		0x7
341e82775ceSdlg #define VPD_DEVID_TYPE_NAME		0x8
342e82775ceSdlg 	u_int8_t reserved;
343e82775ceSdlg 	u_int8_t len;
344e82775ceSdlg };
345e82775ceSdlg 
3463449afb2Sdlg struct scsi_vpd_ata {
3473449afb2Sdlg 	struct scsi_vpd_hdr hdr;
3483449afb2Sdlg 
3493449afb2Sdlg 	u_int8_t _reserved1[4];
3503449afb2Sdlg 	u_int8_t sat_vendor[8];
3513449afb2Sdlg 	u_int8_t sat_product[16];
3523449afb2Sdlg 	u_int8_t sat_revision[4];
3533449afb2Sdlg 	u_int8_t device_signature[20];
3543449afb2Sdlg 	u_int8_t command_code;
3553449afb2Sdlg #define VPD_ATA_COMMAND_CODE_ATA	0xec
3563449afb2Sdlg #define VPD_ATA_COMMAND_CODE_ATAPI	0xa1
3573449afb2Sdlg 	u_int8_t _reserved2[3];
3583449afb2Sdlg 	u_int8_t identify[512];
3593449afb2Sdlg };
3603449afb2Sdlg 
36185680492Skrw struct scsi_read_cap_data {
36285680492Skrw 	u_int8_t addr[4];
36385680492Skrw 	u_int8_t length[4];
36485680492Skrw };
36585680492Skrw 
36685680492Skrw struct scsi_read_cap_data_16 {
36785680492Skrw 	u_int8_t addr[8];
36885680492Skrw 	u_int8_t length[4];
36985680492Skrw 	u_int8_t p_type_prot;
37085680492Skrw #define RC16_PROT_EN		0x01	/* Protection type is 0 when 0 */
37185680492Skrw #define RC16_PROT_P_TYPE	0x0e
37285680492Skrw #define		RC16_P_TYPE_1		0x00	/* Protection type 1 */
37385680492Skrw #define		RC16_P_TYPE_2		0x02	/* Protection type 2 */
37485680492Skrw #define		RC16_P_TYPE_3		0x04	/* Protection type 3 */
37585680492Skrw #define RC16_BASIS		0x30	/* Meaning of addr */
37685680492Skrw #define		RC16_BASIS_HIGH		0x00	/* highest LBA of zone */
37785680492Skrw #define		RC16_BASIS_LAST		0x10	/* last LBA on unit */
37885680492Skrw 	u_int8_t logical_per_phys;	/* Logical Blks Per Physical Blk Exp */
37985680492Skrw #define RC16_LBPPB_EXPONENT	0x0f	/* 2**N LB per PB, 0 means unknown */
38085680492Skrw #define RC16_PIIPLB_EXPONENT	0xf0	/* 2**N Prot info intervals per LB */
38185680492Skrw 	u_int8_t lowest_aligned[2];
38285680492Skrw #define RC16_LALBA		0x3fff	/* lowest aligned LBA */
38385680492Skrw #define RC16_LBPRZ		0x4000	/* unmapped LBA returns all zeros */
38485680492Skrw #define READ_CAP_16_TPRZ	0x4000	/* XXX old name used in driver(s) */
38585680492Skrw #define RC16_LBPME		0x8000	/* LB provisioning management enabled */
38685680492Skrw #define READ_CAP_16_TPE		0x8000	/* XXX old name used in driver(s) */
38785680492Skrw 	u_int8_t reserved[16];
38885680492Skrw };
38985680492Skrw 
390d724e01aSderaadt struct scsi_sense_data_unextended {
391d724e01aSderaadt /* 1*/	u_int8_t error_code;
392d724e01aSderaadt /* 4*/	u_int8_t block[3];
393d724e01aSderaadt };
394df930be7Sderaadt 
395d724e01aSderaadt struct scsi_sense_data {
396df930be7Sderaadt /* 1*/	u_int8_t error_code;
3971d951d12Sbeck #define	SSD_ERRCODE_CURRENT	0x70
3981d951d12Sbeck #define	SSD_ERRCODE_DEFERRED	0x71
399df930be7Sderaadt #define	SSD_ERRCODE		0x7F
400df930be7Sderaadt #define	SSD_ERRCODE_VALID	0x80
401df930be7Sderaadt /* 2*/	u_int8_t segment;
402df930be7Sderaadt /* 3*/	u_int8_t flags;
403df930be7Sderaadt #define	SSD_KEY		0x0F
404df930be7Sderaadt #define	SSD_ILI		0x20
405df930be7Sderaadt #define	SSD_EOM		0x40
406df930be7Sderaadt #define	SSD_FILEMARK	0x80
407df930be7Sderaadt /* 7*/	u_int8_t info[4];
408df930be7Sderaadt /* 8*/	u_int8_t extra_len;
409df930be7Sderaadt /*12*/	u_int8_t cmd_spec_info[4];
410df930be7Sderaadt /*13*/	u_int8_t add_sense_code;
411df930be7Sderaadt /*14*/	u_int8_t add_sense_code_qual;
412df930be7Sderaadt /*15*/	u_int8_t fru;
413df930be7Sderaadt /*16*/	u_int8_t sense_key_spec_1;
414df930be7Sderaadt #define	SSD_SCS_VALID		0x80
4157f34ac81Skrw #define SSD_SCS_CDB_ERROR	0x40
4167f34ac81Skrw #define SSD_SCS_SEGMENT_DESC	0x20
4177f34ac81Skrw #define SSD_SCS_VALID_BIT_INDEX	0x08
4187f34ac81Skrw #define SSD_SCS_BIT_INDEX	0x07
419df930be7Sderaadt /*17*/	u_int8_t sense_key_spec_2;
420df930be7Sderaadt /*18*/	u_int8_t sense_key_spec_3;
421d724e01aSderaadt };
422df930be7Sderaadt 
423aca6abd4Scsapuntz #define SKEY_NO_SENSE		0x00
424aca6abd4Scsapuntz #define SKEY_RECOVERED_ERROR	0x01
425aca6abd4Scsapuntz #define SKEY_NOT_READY		0x02
426aca6abd4Scsapuntz #define SKEY_MEDIUM_ERROR	0x03
427aca6abd4Scsapuntz #define SKEY_HARDWARE_ERROR	0x04
428aca6abd4Scsapuntz #define SKEY_ILLEGAL_REQUEST	0x05
429aca6abd4Scsapuntz #define SKEY_UNIT_ATTENTION	0x06
430aca6abd4Scsapuntz #define SKEY_WRITE_PROTECT	0x07
431aca6abd4Scsapuntz #define SKEY_BLANK_CHECK	0x08
432aca6abd4Scsapuntz #define SKEY_VENDOR_UNIQUE	0x09
433aca6abd4Scsapuntz #define SKEY_COPY_ABORTED	0x0A
434aca6abd4Scsapuntz #define SKEY_ABORTED_COMMAND	0x0B
435aca6abd4Scsapuntz #define SKEY_EQUAL		0x0C
436aca6abd4Scsapuntz #define SKEY_VOLUME_OVERFLOW	0x0D
437aca6abd4Scsapuntz #define SKEY_MISCOMPARE		0x0E
438aca6abd4Scsapuntz #define SKEY_RESERVED		0x0F
439aca6abd4Scsapuntz 
440bca89e64Sbeck 
441bca89e64Sbeck /* Additional sense code info */
442bca89e64Sbeck #define ASC_ASCQ(ssd)	((ssd->add_sense_code << 8) | ssd->add_sense_code_qual)
443bca89e64Sbeck 
4449e1b31bbSkrw #define SENSE_FILEMARK_DETECTED			0x0001
4459e1b31bbSkrw #define SENSE_END_OF_MEDIUM_DETECTED		0x0002
4469e1b31bbSkrw #define SENSE_SETMARK_DETECTED			0x0003
4479e1b31bbSkrw #define SENSE_BEGINNING_OF_MEDIUM_DETECTED	0x0004
4489e1b31bbSkrw #define SENSE_END_OF_DATA_DETECTED		0x0005
449bca89e64Sbeck #define SENSE_NOT_READY_BECOMING_READY		0x0401
4500d8e1065Sbeck #define SENSE_NOT_READY_INIT_REQUIRED		0x0402
451bca89e64Sbeck #define SENSE_NOT_READY_FORMAT			0x0404
452bca89e64Sbeck #define SENSE_NOT_READY_REBUILD			0x0405
453bca89e64Sbeck #define SENSE_NOT_READY_RECALC			0x0406
454bca89e64Sbeck #define SENSE_NOT_READY_INPROGRESS		0x0407
455bca89e64Sbeck #define SENSE_NOT_READY_LONGWRITE		0x0408
456bca89e64Sbeck #define SENSE_NOT_READY_SELFTEST		0x0409
457bca89e64Sbeck #define SENSE_POWER_RESET_OR_BUS		0x2900
458bca89e64Sbeck #define SENSE_POWER_ON				0x2901
459bca89e64Sbeck #define SENSE_BUS_RESET				0x2902
460bca89e64Sbeck #define SENSE_BUS_DEVICE_RESET			0x2903
461bca89e64Sbeck #define SENSE_DEVICE_INTERNAL_RESET		0x2904
462bca89e64Sbeck #define SENSE_TSC_CHANGE_SE			0x2905
463bca89e64Sbeck #define SENSE_TSC_CHANGE_LVD			0x2906
464bca89e64Sbeck #define SENSE_IT_NEXUS_LOSS			0x2907
465bca89e64Sbeck #define SENSE_BAD_MEDIUM			0x3000
466bca89e64Sbeck #define SENSE_NR_MEDIUM_UNKNOWN_FORMAT		0x3001
467bca89e64Sbeck #define SENSE_NR_MEDIUM_INCOMPATIBLE_FORMAT	0x3002
468bca89e64Sbeck #define SENSE_NW_MEDIUM_UNKNOWN_FORMAT		0x3004
469bca89e64Sbeck #define SENSE_NW_MEDIUM_INCOMPATIBLE_FORMAT	0x3005
470bca89e64Sbeck #define SENSE_NF_MEDIUM_INCOMPATIBLE_FORMAT	0x3006
471bca89e64Sbeck #define SENSE_NW_MEDIUM_AC_MISMATCH		0x3008
472bca89e64Sbeck #define SENSE_NOMEDIUM				0x3A00
473bca89e64Sbeck #define SENSE_NOMEDIUM_TCLOSED			0x3A01
474bca89e64Sbeck #define SENSE_NOMEDIUM_TOPEN			0x3A02
475bca89e64Sbeck #define SENSE_NOMEDIUM_LOADABLE			0x3A03
476bca89e64Sbeck #define SENSE_NOMEDIUM_AUXMEM			0x3A04
477bca89e64Sbeck #define SENSE_CARTRIDGE_FAULT			0x5200
478bca89e64Sbeck #define SENSE_MEDIUM_REMOVAL_PREVENTED		0x5302
479bca89e64Sbeck 
480df930be7Sderaadt struct scsi_blk_desc {
481df930be7Sderaadt 	u_int8_t density;
482df930be7Sderaadt 	u_int8_t nblocks[3];
483df930be7Sderaadt 	u_int8_t reserved;
484df930be7Sderaadt 	u_int8_t blklen[3];
485df930be7Sderaadt };
486df930be7Sderaadt 
4876b69da10Skrw struct scsi_direct_blk_desc {
4887e28b265Skrw 	u_int8_t nblocks[4];
4897e28b265Skrw 	u_int8_t density;
4907e28b265Skrw 	u_int8_t blklen[3];
4917e28b265Skrw };
4927e28b265Skrw 
4936b69da10Skrw struct scsi_blk_desc_big {
4947e28b265Skrw 	u_int8_t nblocks[8];
4957e28b265Skrw 	u_int8_t density;
4967e28b265Skrw 	u_int8_t reserved[3];
4977e28b265Skrw 	u_int8_t blklen[4];
4987e28b265Skrw };
4997e28b265Skrw 
500df930be7Sderaadt struct scsi_mode_header {
501df930be7Sderaadt 	u_int8_t data_length;		/* Sense data length */
502df930be7Sderaadt 	u_int8_t medium_type;
503df930be7Sderaadt 	u_int8_t dev_spec;
504df930be7Sderaadt 	u_int8_t blk_desc_len;
505df930be7Sderaadt };
506ac22ea16Skrw #define VALID_MODE_HDR(_x)	((_x)->data_length >= 3)
507df930be7Sderaadt 
508df930be7Sderaadt struct scsi_mode_header_big {
509df930be7Sderaadt 	u_int8_t data_length[2];	/* Sense data length */
510df930be7Sderaadt 	u_int8_t medium_type;
511df930be7Sderaadt 	u_int8_t dev_spec;
5127e28b265Skrw 	u_int8_t reserved;
5137e28b265Skrw #define LONGLBA	0x01
5147e28b265Skrw 	u_int8_t reserved2;
515df930be7Sderaadt 	u_int8_t blk_desc_len[2];
516df930be7Sderaadt };
517ac22ea16Skrw #define VALID_MODE_HDR_BIG(_x)	(_2btol((_x)->data_length) >= 6)
518df930be7Sderaadt 
519427418b6Skrw /* Both disks and tapes use dev_spec to report READONLY status. */
520427418b6Skrw #define	SMH_DSP_WRITE_PROT	0x80
521427418b6Skrw 
52224b6d99aSkrw union scsi_mode_sense_buf {
5237e28b265Skrw 	struct scsi_mode_header hdr;
5247e28b265Skrw 	struct scsi_mode_header_big hdr_big;
52531a2fbc4Skrw 	u_char buf[254];	/* 255 & 256 bytes breaks some devices. */
52631a2fbc4Skrw 				/* ahci doesn't like 255, various don't like */
52731a2fbc4Skrw 				/* 256 because length must fit in 8 bits. */
52831a2fbc4Skrw } __packed;			/* Ensure sizeof() is 254! */
5297e28b265Skrw 
530a022b481Skrw struct scsi_report_luns_data {
531a022b481Skrw 	u_int8_t length[4];	/* length of LUN inventory, in bytes */
532a022b481Skrw 	u_int8_t reserved[4];	/* unused */
533a022b481Skrw 	/*
534a022b481Skrw 	 * LUN inventory- we only support the type zero form for now.
535a022b481Skrw 	 */
536a022b481Skrw #define RPL_LUNDATA_SIZE 8	/* Bytes per lun */
537a022b481Skrw 	struct {
538a022b481Skrw 		u_int8_t lundata[RPL_LUNDATA_SIZE];
539a022b481Skrw 	} luns[256];		/* scsi_link->luns is u_int8_t. */
540a022b481Skrw };
541a022b481Skrw #define	RPL_LUNDATA_T0LUN	1	/* Type 0 LUN is in lundata[1] */
542a022b481Skrw 
543bc9adaf2Skrw struct scsi_lun_array {
544bc9adaf2Skrw 	uint8_t	luns[256];
545bc9adaf2Skrw 	int	count;
546bc9adaf2Skrw 	int	dumbscan;
547bc9adaf2Skrw };
548bc9adaf2Skrw 
54930adbba5Skrw /*
550a3ef7ce1Sdlg  * ATA PASS-THROUGH as per SAT2
551a3ef7ce1Sdlg  */
552a3ef7ce1Sdlg 
553a3ef7ce1Sdlg #define ATA_PASSTHRU_12		0xa1
554a3ef7ce1Sdlg #define ATA_PASSTHRU_16		0x85
555a3ef7ce1Sdlg 
556a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_MASK		0x1e
557a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_HW_RESET	0x00
558a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_SW_RESET	0x02
559a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_NON_DATA	0x06
560a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_PIO_DATAIN	0x08
561a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_PIO_DATAOUT	0x0a
562a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_DMA		0x0c
563a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_DMA_QUEUED	0x0e
564a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_EXEC_DIAG	0x10
565a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_NON_DATA_RST	0x12
566a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_UDMA_DATAIN	0x14
567a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_UDMA_DATAOUT	0x16
568a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_FPDMA	0x18
569a3ef7ce1Sdlg #define ATA_PASSTHRU_PROTO_RESPONSE	0x1e
570a3ef7ce1Sdlg 
571a3ef7ce1Sdlg #define ATA_PASSTHRU_T_DIR_MASK		0x08
572a3ef7ce1Sdlg #define ATA_PASSTHRU_T_DIR_READ		0x08
573a3ef7ce1Sdlg #define ATA_PASSTHRU_T_DIR_WRITE	0x00
574a3ef7ce1Sdlg 
575a3ef7ce1Sdlg #define ATA_PASSTHRU_T_LEN_MASK		0x03
576a3ef7ce1Sdlg #define ATA_PASSTHRU_T_LEN_NONE		0x00
577a3ef7ce1Sdlg #define ATA_PASSTHRU_T_LEN_FEATURES	0x01
578a3ef7ce1Sdlg #define ATA_PASSTHRU_T_LEN_SECTOR_COUNT	0x02
579a3ef7ce1Sdlg #define ATA_PASSTHRU_T_LEN_TPSIU	0x03
580a3ef7ce1Sdlg 
581a3ef7ce1Sdlg struct scsi_ata_passthru_12 {
582a3ef7ce1Sdlg 	u_int8_t opcode;
583a3ef7ce1Sdlg 	u_int8_t count_proto;
584a3ef7ce1Sdlg 	u_int8_t flags;
585a3ef7ce1Sdlg 	u_int8_t features;
586a3ef7ce1Sdlg 	u_int8_t sector_count;
587a3ef7ce1Sdlg 	u_int8_t lba_low;
588a3ef7ce1Sdlg 	u_int8_t lba_mid;
589a3ef7ce1Sdlg 	u_int8_t lba_high;
590a3ef7ce1Sdlg 	u_int8_t device;
591a3ef7ce1Sdlg 	u_int8_t command;
592a3ef7ce1Sdlg 	u_int8_t _reserved;
593a3ef7ce1Sdlg 	u_int8_t control;
594a3ef7ce1Sdlg };
595a3ef7ce1Sdlg 
596a3ef7ce1Sdlg struct scsi_ata_passthru_16 {
597a3ef7ce1Sdlg 	u_int8_t opcode;
598a3ef7ce1Sdlg 	u_int8_t count_proto;
599a3ef7ce1Sdlg 	u_int8_t flags;
600a3ef7ce1Sdlg 	u_int8_t features[2];
601a3ef7ce1Sdlg 	u_int8_t sector_count[2];
602a3ef7ce1Sdlg 	u_int8_t lba_low[2];
603a3ef7ce1Sdlg 	u_int8_t lba_mid[2];
604a3ef7ce1Sdlg 	u_int8_t lba_high[2];
605a3ef7ce1Sdlg 	u_int8_t device;
606a3ef7ce1Sdlg 	u_int8_t command;
607a3ef7ce1Sdlg 	u_int8_t control;
608a3ef7ce1Sdlg };
609a3ef7ce1Sdlg 
610a3ef7ce1Sdlg /*
61130adbba5Skrw  * SPI status information unit. See section 14.3.5 of SPI-3.
61230adbba5Skrw  */
61330adbba5Skrw struct scsi_status_iu_header {
61430adbba5Skrw /* 2*/	u_int8_t reserved[2];
61530adbba5Skrw /* 3*/	u_int8_t flags;
61630adbba5Skrw #define	SIU_SNSVALID 0x2
61730adbba5Skrw #define	SIU_RSPVALID 0x1
61830adbba5Skrw /* 4*/	u_int8_t status;
61930adbba5Skrw /* 8*/	u_int8_t sense_length[4];
62030adbba5Skrw /*12*/	u_int8_t pkt_failures_length[4];
62130adbba5Skrw 	u_int8_t data[1]; /* <pkt failure list><sense data> OR <sense_data> */
62230adbba5Skrw };
62330adbba5Skrw 
62430adbba5Skrw #define SIU_PKTFAIL_CODE(siu)	((siu)->data[3])
62530adbba5Skrw #define		SIU_PFC_NONE			0x00
62630adbba5Skrw #define		SIU_PFC_CIU_FIELDS_INVALID	0x02
62730adbba5Skrw #define		SIU_PFC_TMF_NOT_SUPPORTED	0x04
62830adbba5Skrw #define		SIU_PFC_TMF_FAILED		0x05
62930adbba5Skrw #define		SIU_PFC_INVALID_TYPE_CODE	0x06
63030adbba5Skrw #define		SIU_PFC_ILLEGAL_REQUEST		0x07
63130adbba5Skrw 
63230adbba5Skrw #define SIU_SENSE_LENGTH(siu)	(_4btol((siu)->sense_length))
63330adbba5Skrw #define SIU_SENSE_DATA(siu)	(((siu)->flags & SIU_RSPVALID) ?	\
63430adbba5Skrw    &(siu)->data[_4btol((siu)->pkt_failures_length)] : &(siu)->data[0])
63530adbba5Skrw 
63630adbba5Skrw /*
63730adbba5Skrw  * Values for 'Task Management Flags' field of SPI command information unit.
63830adbba5Skrw  * See section 14.3.1 of SPI-3.
63930adbba5Skrw  */
64030adbba5Skrw #define	SIU_TASKMGMT_NONE		0x00
64130adbba5Skrw #define	SIU_TASKMGMT_ABORT_TASK		0x01
64230adbba5Skrw #define	SIU_TASKMGMT_ABORT_TASK_SET	0x02
64330adbba5Skrw #define	SIU_TASKMGMT_CLEAR_TASK_SET	0x04
64430adbba5Skrw #define	SIU_TASKMGMT_LUN_RESET		0x08
64530adbba5Skrw #define	SIU_TASKMGMT_TARGET_RESET	0x20
64630adbba5Skrw #define	SIU_TASKMGMT_CLEAR_ACA		0x40
647df930be7Sderaadt 
648df930be7Sderaadt /*
649df930be7Sderaadt  * Status Byte
650df930be7Sderaadt  */
651df930be7Sderaadt #define SCSI_OK			0x00
652df930be7Sderaadt #define SCSI_CHECK		0x02
653c269d5dcSkrw #define SCSI_COND_MET		0x04
654df930be7Sderaadt #define SCSI_BUSY		0x08
655df930be7Sderaadt #define SCSI_INTERM		0x10
656c269d5dcSkrw #define SCSI_INTERM_COND_MET	0x14
657c269d5dcSkrw #define SCSI_RESV_CONFLICT	0x18
658c269d5dcSkrw #define SCSI_TERMINATED		0x22
659c269d5dcSkrw #define SCSI_QUEUE_FULL		0x28	/* Old (Pre SCSI-3) name */
660c269d5dcSkrw #define SCSI_TASKSET_FULL	0x28	/* New (SCSI-3)     name */
661c269d5dcSkrw #define SCSI_ACA_ACTIVE		0x30
662df930be7Sderaadt 
663df930be7Sderaadt #endif /* _SCSI_SCSI_ALL_H */
664