scsipi_all.h revision 1.19.2.2 1 /* $NetBSD: scsipi_all.h,v 1.19.2.2 2002/01/10 19:58:22 thorpej Exp $ */
2
3 /*
4 * SCSI and SCSI-like general interface description
5 */
6
7 /*
8 * Largely written by Julian Elischer (julian (at) tfs.com)
9 * for TRW Financial Systems.
10 *
11 * TRW Financial Systems, in accordance with their agreement with Carnegie
12 * Mellon University, makes this software available to CMU to distribute
13 * or use in any manner that they see fit as long as this message is kept with
14 * the software. For this reason TFS also grants any other persons or
15 * organisations permission to use or modify this software.
16 *
17 * TFS supplies this software to be publicly redistributed
18 * on the understanding that TFS is not responsible for the correct
19 * functioning of this software in any circumstances.
20 *
21 * Ported to run under 386BSD by Julian Elischer (julian (at) tfs.com) Sept 1992
22 */
23
24 #ifndef _DEV_SCSIPI_SCSIPI_ALL_H_
25 #define _DEV_SCSIPI_SCSIPI_ALL_H_
26
27 /*
28 * SCSI-like command format and opcode
29 */
30
31 /*
32 * Some basic, common SCSI command group definitions.
33 */
34
35 #define CDB_GROUPID(cmd) ((cmd >> 5) & 0x7)
36 #define CDB_GROUPID_0 0
37 #define CDB_GROUPID_1 1
38 #define CDB_GROUPID_2 2
39 #define CDB_GROUPID_3 3
40 #define CDB_GROUPID_4 4
41 #define CDB_GROUPID_5 5
42 #define CDB_GROUPID_6 6
43 #define CDB_GROUPID_7 7
44
45 #define CDB_GROUP0 6 /* 6-byte cdb's */
46 #define CDB_GROUP1 10 /* 10-byte cdb's */
47 #define CDB_GROUP2 10 /* 10-byte cdb's */
48 #define CDB_GROUP3 0 /* reserved */
49 #define CDB_GROUP4 16 /* 16-byte cdb's */
50 #define CDB_GROUP5 12 /* 12-byte cdb's */
51 #define CDB_GROUP6 0 /* vendor specific */
52 #define CDB_GROUP7 0 /* vendor specific */
53
54 /*
55 * Some basic, common SCSI commands
56 */
57 #define TEST_UNIT_READY 0x00
58 struct scsipi_test_unit_ready {
59 u_int8_t opcode;
60 u_int8_t byte2;
61 u_int8_t unused[3];
62 u_int8_t control;
63 };
64
65 #define REQUEST_SENSE 0x03
66 struct scsipi_sense {
67 u_int8_t opcode;
68 u_int8_t byte2;
69 u_int8_t unused[2];
70 u_int8_t length;
71 u_int8_t control;
72 };
73
74 #define MODE_SENSE 0x1a
75 struct scsipi_mode_sense {
76 u_int8_t opcode;
77 u_int8_t byte2;
78 #define SMS_DBD 0x08 /* disable block descriptors */
79 u_int8_t page;
80 #define SMS_PAGE_CODE 0x3F
81 #define SMS_PAGE_CTRL 0xC0
82 #define SMS_PAGE_CTRL_CURRENT 0x00
83 #define SMS_PAGE_CTRL_CHANGEABLE 0x40
84 #define SMS_PAGE_CTRL_DEFAULT 0x80
85 #define SMS_PAGE_CTRL_SAVED 0xC0
86 union {
87 struct {
88 u_int8_t unused;
89 u_int8_t length;
90 } scsi __attribute__((packed));
91 struct {
92 u_int8_t length[2];
93 } atapi __attribute__((packed));
94 } u_len;
95 u_int8_t control;
96 } __attribute__((packed));
97
98 #define MODE_SENSE_BIG 0x5A
99 struct scsipi_mode_sense_big {
100 u_int8_t opcode;
101 u_int8_t byte2; /* same bits as small version */
102 u_int8_t page; /* same bits as small version */
103 u_int8_t unused[4];
104 u_int8_t length[2];
105 u_int8_t control;
106 } __attribute__((packed));
107
108 #define MODE_SELECT 0x15
109 struct scsipi_mode_select {
110 u_int8_t opcode;
111 u_int8_t byte2;
112 #define SMS_SP 0x01 /* save page */
113 #define SMS_PF 0x10 /* page format (0 = SCSI-1, 1 = SCSI-2) */
114 u_int8_t unused;
115 union {
116 struct {
117 u_int8_t unused;
118 u_int8_t length;
119 } scsi __attribute__((packed));
120 struct {
121 u_int8_t length[2];
122 } atapi __attribute__((packed));
123 } u_len;
124 u_int8_t control;
125 } __attribute__((packed));
126
127 #define MODE_SELECT_BIG 0x55
128 struct scsipi_mode_select_big {
129 u_int8_t opcode;
130 u_int8_t byte2; /* same bits as small version */
131 u_int8_t unused[5];
132 u_int8_t length[2];
133 u_int8_t control;
134 } __attribute__((packed));
135
136 #define INQUIRY 0x12
137 struct scsipi_inquiry {
138 u_int8_t opcode;
139 u_int8_t byte2;
140 u_int8_t unused[2];
141 u_int8_t length;
142 u_int8_t control;
143 } __attribute__((packed));
144
145 #define START_STOP 0x1b
146 struct scsipi_start_stop {
147 u_int8_t opcode;
148 u_int8_t byte2;
149 u_int8_t unused[2];
150 u_int8_t how;
151 #define SSS_STOP 0x00
152 #define SSS_START 0x01
153 #define SSS_LOEJ 0x02
154 u_int8_t control;
155 };
156
157 #define PREVENT_ALLOW 0x1e
158 struct scsipi_prevent {
159 u_int8_t opcode;
160 u_int8_t byte2;
161 u_int8_t unused[2];
162 u_int8_t how;
163 u_int8_t control;
164 } __attribute__((packed));
165 #define PR_PREVENT 0x01
166 #define PR_ALLOW 0x00
167
168 /*
169 * inquiry and sense data format
170 */
171
172 struct scsipi_sense_data {
173 /* 1*/ u_int8_t error_code;
174 #define SSD_ERRCODE 0x7F
175 #define SSD_ERRCODE_VALID 0x80
176 /* 2*/ u_int8_t segment;
177 /* 3*/ u_int8_t flags;
178 #define SSD_KEY 0x0F
179 #define SSD_ILI 0x20
180 #define SSD_EOM 0x40
181 #define SSD_FILEMARK 0x80
182 /* 7*/ u_int8_t info[4];
183 /* 8*/ u_int8_t extra_len;
184 /*12*/ u_int8_t cmd_spec_info[4];
185 /*13*/ u_int8_t add_sense_code;
186 /*14*/ u_int8_t add_sense_code_qual;
187 /*15*/ u_int8_t fru;
188 /*16*/ u_int8_t sense_key_spec_1;
189 #define SSD_SCS_VALID 0x80
190 /*17*/ u_int8_t sense_key_spec_2;
191 /*18*/ u_int8_t sense_key_spec_3;
192 /*32*/ u_int8_t extra_bytes[14];
193 } __attribute__((packed));
194
195 #define SKEY_NO_SENSE 0x00
196 #define SKEY_RECOVERED_ERROR 0x01
197 #define SKEY_NOT_READY 0x02
198 #define SKEY_MEDIUM_ERROR 0x03
199 #define SKEY_HARDWARE_ERROR 0x04
200 #define SKEY_ILLEGAL_REQUEST 0x05
201 #define SKEY_UNIT_ATTENTION 0x06
202 #define SKEY_WRITE_PROTECT 0x07
203 #define SKEY_BLANK_CHECK 0x08
204 #define SKEY_VENDOR_UNIQUE 0x09
205 #define SKEY_COPY_ABORTED 0x0A
206 #define SKEY_ABORTED_COMMAND 0x0B
207 #define SKEY_EQUAL 0x0C
208 #define SKEY_VOLUME_OVERFLOW 0x0D
209 #define SKEY_MISCOMPARE 0x0E
210 #define SKEY_RESERVED 0x0F
211
212 /*
213 * Sense bytes described by the extra_len tag start at cmd_spec_info,
214 * and can only continue up to the end of the structure we've defined
215 * (which is too short for some cases).
216 */
217 #define ADD_BYTES_LIM(sp) \
218 ((((int)(sp)->extra_len) < (int) sizeof(struct scsipi_sense_data) - 8)? \
219 ((sp)->extra_len) : (sizeof (struct scsipi_sense_data) - 8))
220
221
222 struct scsipi_sense_data_unextended {
223 /* 1*/ u_int8_t error_code;
224 /* 4*/ u_int8_t block[3];
225 } __attribute__((packed));
226
227 #define T_REMOV 1 /* device is removable */
228 #define T_FIXED 0 /* device is not removable */
229
230 /*
231 * According to SPC-2r16, in order to know if a U3W device support PPR,
232 * Inquiry Data structure should be at least 57 Bytes
233 */
234
235 struct scsipi_inquiry_data {
236 /* 1*/ u_int8_t device;
237 #define SID_TYPE 0x1f /* device type mask */
238 #define SID_QUAL 0xe0 /* device qualifier mask */
239 #define SID_QUAL_LU_PRESENT 0x00 /* logical unit present */
240 #define SID_QUAL_LU_NOTPRESENT 0x20 /* logical unit not present */
241 #define SID_QUAL_reserved 0x40
242 #define SID_QUAL_LU_NOT_SUPP 0x60 /* logical unit not supported */
243
244 #define T_DIRECT 0x00 /* direct access device */
245 #define T_SEQUENTIAL 0x01 /* sequential access device */
246 #define T_PRINTER 0x02 /* printer device */
247 #define T_PROCESSOR 0x03 /* processor device */
248 #define T_WORM 0x04 /* write once, read many device */
249 #define T_CDROM 0x05 /* cd-rom device */
250 #define T_SCANNER 0x06 /* scanner device */
251 #define T_OPTICAL 0x07 /* optical memory device */
252 #define T_CHANGER 0x08 /* medium changer device */
253 #define T_COMM 0x09 /* communication device */
254 #define T_IT8_1 0x0a /* Defined by ASC IT8... */
255 #define T_IT8_2 0x0b /* ...(Graphic arts pre-press devices) */
256 #define T_STORARRAY 0x0c /* storage array device */
257 #define T_ENCLOSURE 0x0d /* enclosure services device */
258 #define T_SIMPLE_DIRECT 0x0E /* Simplified direct-access device */
259 #define T_OPTIC_CARD_RW 0x0F /* Optical card reader/writer device */
260 #define T_OBJECT_STORED 0x11 /* Object-based Storage Device */
261 #define T_NODEVICE 0x1f
262
263 u_int8_t dev_qual2;
264 #define SID_QUAL2 0x7F
265 #define SID_REMOVABLE 0x80
266
267 /* 3*/ u_int8_t version;
268 #define SID_ANSII 0x07
269 #define SID_ECMA 0x38
270 #define SID_ISO 0xC0
271
272 /* 4*/ u_int8_t response_format;
273 #define SID_RespDataFmt 0x0F
274 #define SID_FORMAT_SCSI1 0x00 /* SCSI-1 format */
275 #define SID_FORMAT_CCS 0x01 /* SCSI CCS format */
276 #define SID_FORMAT_ISO 0x02 /* ISO format */
277
278 /* 5*/ u_int8_t additional_length; /* n-4 */
279 /* 6*/ u_int8_t flags1;
280 #define SID_SCC 0x80
281 /* 7*/ u_int8_t flags2;
282 #define SID_Addr16 0x01
283 #define SID_MChngr 0x08
284 #define SID_MultiPort 0x10
285 #define SID_EncServ 0x40
286 #define SID_BasQue 0x80
287 /* 8*/ u_int8_t flags3;
288 #define SID_SftRe 0x01
289 #define SID_CmdQue 0x02
290 #define SID_Linked 0x08
291 #define SID_Sync 0x10
292 #define SID_WBus16 0x20
293 #define SID_WBus32 0x40
294 #define SID_RelAdr 0x80
295 /* 9*/ char vendor[8];
296 /*17*/ char product[16];
297 /*33*/ char revision[4];
298 /*37*/ u_int8_t vendor_specific[20];
299 /*57*/ u_int8_t flags4;
300 #define SID_IUS 0x01
301 #define SID_QAS 0x02
302 #define SID_Clocking 0x0C
303 #define SID_CLOCKING_ST_ONLY 0x00
304 #define SID_CLOCKING_DT_ONLY 0x04
305 #define SID_CLOCKING_SD_DT 0x0C
306 /*58*/ u_int8_t reserved;
307 /*59*/ char version_descriptor[8][2];
308 } __attribute__((packed)); /* 74 Bytes */
309
310 /* Data structures for mode select/mode sense */
311 struct scsipi_mode_header {
312 u_int8_t data_length; /* Sense data length */
313 u_int8_t medium_type;
314 u_int8_t dev_spec;
315 u_int8_t blk_desc_len; /* unused on ATAPI */
316 } __attribute__((packed));
317
318 struct scsipi_mode_header_big {
319 u_int8_t data_length[2]; /* Sense data length */
320 u_int8_t medium_type;
321 u_int8_t dev_spec;
322 u_int8_t unused[2]; /* unused on ATAPI */
323 u_int8_t blk_desc_len[2]; /* unused on ATAPI */
324 } __attribute__((packed));
325
326 /*
327 * This part is common to all mode pages.
328 */
329 struct scsipi_mode_page_header {
330 u_int8_t pg_code; /* page code */
331 #define PGCODE_MASK 0x3f /* page code mask */
332 #define PGCODE_PS 0x80 /* page is savable */
333 u_int8_t pg_length; /* page length (not including hdr) */
334 } __attribute__((__packed__));
335
336 #endif /* _DEV_SCSIPI_SCSIPI_ALL_H_ */
337