scsireg.h revision 1.3 1 /* $NetBSD: scsireg.h,v 1.3 2011/02/08 20:20:14 rmind Exp $ */
2
3 /*
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Van Jacobson of Lawrence Berkeley Laboratory.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)scsireg.h 8.1 (Berkeley) 6/10/93
35 */
36
37 /*
38 * HP 98265A SCSI Interface Hardware Description.
39 */
40
41 struct scsidevice {
42 u_char p0, scsi_id;
43 #define ID_MASK 0x1f
44 #define SCSI_ID 0x07
45 #define ID_WORD_DMA 0x20
46 u_char p2, scsi_csr;
47 #define CSR_IE 0x80
48 #define CSR_IR 0x40
49 #define SCSI_IPL(csr) ((((csr)>>4)&3)+3)
50 #define CSR_DMA32 0x08
51 #define CSR_DMAIN 0x04
52 #define CSR_DE1 0x02
53 #define CSR_DE0 0x01
54 u_char p4, scsi_wrap;
55 #define WRAP_REQ 0x80
56 #define WRAP_ACK 0x40
57 #define WRAP_BSY 0x08
58 #define WRAP_MSG 0x04
59 #define WRAP_CD 0x02
60 #define WRAP_IO 0x01
61 u_char p6, scsi_hconf;
62 #define HCONF_TP 0x80
63 #define SCSI_SYNC_XFER(hconf) (((hconf)>>5)&3)
64 #define HCONF_SD 0x10
65 #define HCONF_PARITY 0x08
66 u_char p8[24];
67 u_char p32, scsi_bdid;
68 u_char p34, scsi_sctl;
69 #define SCTL_DISABLE 0x80
70 #define SCTL_CTRLRST 0x40
71 #define SCTL_DIAG 0x20
72 #define SCTL_ABRT_ENAB 0x10
73 #define SCTL_PARITY_ENAB 0x08
74 #define SCTL_SEL_ENAB 0x04
75 #define SCTL_RESEL_ENAB 0x02
76 #define SCTL_INTR_ENAB 0x01
77 u_char p36, scsi_scmd;
78 #define SCMD_RST 0x10
79 #define SCMD_ICPT_XFR 0x08
80 #define SCMD_PROG_XFR 0x04
81 #define SCMD_PAD 0x01 /* if initiator */
82 #define SCMD_PERR_STOP 0x01 /* if target */
83 /* command codes */
84 #define SCMD_BUS_REL 0x00
85 #define SCMD_SELECT 0x20
86 #define SCMD_RST_ATN 0x40
87 #define SCMD_SET_ATN 0x60
88 #define SCMD_XFR 0x80
89 #define SCMD_XFR_PAUSE 0xa0
90 #define SCMD_RST_ACK 0xc0
91 #define SCMD_SET_ACK 0xe0
92 u_char p38, scsi_tmod;
93 #define TMOD_SYNC 0x80
94 u_char p40, scsi_ints;
95 #define INTS_SEL 0x80
96 #define INTS_RESEL 0x40
97 #define INTS_DISCON 0x20
98 #define INTS_CMD_DONE 0x10
99 #define INTS_SRV_REQ 0x08
100 #define INTS_TIMEOUT 0x04
101 #define INTS_HARD_ERR 0x02
102 #define INTS_RST 0x01
103 u_char p42, scsi_psns;
104 #define PSNS_REQ 0x80
105 #define PSNS_ACK 0x40
106 #define PSNS_ATN 0x20
107 #define PSNS_SEL 0x10
108 #define PSNS_BSY 0x08
109 u_char p44, scsi_ssts;
110 #define SSTS_INITIATOR 0x80
111 #define SSTS_TARGET 0x40
112 #define SSTS_BUSY 0x20
113 #define SSTS_XFR 0x10
114 #define SSTS_ACTIVE (SSTS_INITIATOR|SSTS_XFR)
115 #define SSTS_RST 0x08
116 #define SSTS_TCZERO 0x04
117 #define SSTS_DREG_FULL 0x02
118 #define SSTS_DREG_EMPTY 0x01
119 u_char p46, scsi_serr;
120 #define SERR_SCSI_PAR 0x80
121 #define SERR_SPC_PAR 0x40
122 #define SERR_TC_PAR 0x08
123 #define SERR_PHASE_ERR 0x04
124 #define SERR_SHORT_XFR 0x02
125 #define SERR_OFFSET 0x01
126 u_char p48, scsi_pctl;
127 #define PCTL_BFINT_ENAB 0x80
128 u_char p50, scsi_mbc;
129 u_char p52, scsi_dreg;
130 u_char p54, scsi_temp;
131 u_char p56, scsi_tch;
132 u_char p58, scsi_tcm;
133 u_char p60, scsi_tcl;
134 u_char p62, scsi_exbf;
135 };
136
137 /* psns/pctl phase lines as bits */
138 #define PHASE_MSG 0x04
139 #define PHASE_CD 0x02 /* =1 if 'command' */
140 #define PHASE_IO 0x01 /* =1 if data inbound */
141 /* Phase lines as values */
142 #define PHASE 0x07 /* mask for psns/pctl phase */
143 #define DATA_OUT_PHASE 0x00
144 #define DATA_IN_PHASE 0x01
145 #define CMD_PHASE 0x02
146 #define STATUS_PHASE 0x03
147 #define BUS_FREE_PHASE 0x04
148 #define ARB_SEL_PHASE 0x05 /* Fuji chip combines arbitration with sel. */
149 #define MESG_OUT_PHASE 0x06
150 #define MESG_IN_PHASE 0x07
151
152 /* SCSI Messages */
153
154 #define MSG_CMD_COMPLETE 0x00
155 #define MSG_EXT_MESSAGE 0x01
156 #define MSG_SAVE_DATA_PTR 0x02
157 #define MSG_RESTORE_PTR 0x03
158 #define MSG_DISCONNECT 0x04
159 #define MSG_INIT_DETECT_ERROR 0x05
160 #define MSG_ABORT 0x06
161 #define MSG_REJECT 0x07
162 #define MSG_NOOP 0x08
163 #define MSG_PARITY_ERROR 0x09
164 #define MSG_BUS_DEVICE_RESET 0x0C
165 #define MSG_IDENTIFY 0x80
166 #define MSG_IDENTIFY_DR 0xc0 /* (disconnect/reconnect allowed) */
167 #define MSG_SYNC_REQ 0x01
168
169 /* SCSI Commands */
170
171 #define CMD_TEST_UNIT_READY 0x00
172 #define CMD_REQUEST_SENSE 0x03
173 #define CMD_INQUIRY 0x12
174 #define CMD_SEND_DIAGNOSTIC 0x1D
175
176 #define CMD_REWIND 0x01
177 #define CMD_REZERO 0x01
178 #define CMD_FORMAT_UNIT 0x04
179 #define CMD_READ_BLOCK_LIMITS 0x05
180 #define CMD_REASSIGN_BLOCKS 0x07
181 #define CMD_READ 0x08
182 #define CMD_WRITE 0x0A
183 #define CMD_WRITE_FILEMARK 0x10
184 #define CMD_SPACE 0x11
185 #define CMD_MODE_SELECT 0x15
186 #define CMD_RELEASE_UNIT 0x17
187 #define CMD_ERASE 0x19
188 #define CMD_MODE_SENSE 0x1A
189 #define CMD_LOADUNLOAD 0x1B
190 #define CMD_RECEIVE_DIAG 0x1C
191 #define CMD_SEND_DIAG 0x1D
192 #define CMD_P_A_MEDIA_REMOVAL 0x1E
193 #define CMD_READ_CAPACITY 0x25
194 #define CMD_READ_EXT 0x28
195 #define CMD_WRITE_EXT 0x2A
196 #define CMD_READ_DEFECT_DATA 0x37
197 #define SD_MANUFAC_DEFECTS 0x14000000
198 #define SD_GROWN_DEFECTS 0x0c000000
199 #define CMD_READ_BUFFER 0x3B
200 #define CMD_WRITE_BUFFER 0x3C
201 #define CMD_READ_FULL 0xF0
202 #define CMD_MEDIA_TEST 0xF1
203 #define CMD_ACCESS_LOG 0xF2
204 #define CMD_WRITE_FULL 0xFC
205 #define CMD_MANAGE_PRIMARY 0xFD
206 #define CMD_EXECUTE_DATA 0xFE
207
208 /* SCSI status bits */
209
210 #define STS_CHECKCOND 0x02 /* Check Condition (ie., read sense) */
211 #define STS_CONDMET 0x04 /* Condition Met (ie., search worked) */
212 #define STS_BUSY 0x08
213 #define STS_INTERMED 0x10 /* Intermediate status sent */
214 #define STS_EXT 0x80 /* Extended status valid */
215
216 /* command descriptor blocks */
217
218 struct scsi_cdb6 {
219 u_char cmd; /* command code */
220 u_char lun: 3, /* logical unit on ctlr */
221 lbah: 5; /* msb of read/write logical block addr */
222 u_char lbam; /* middle byte of l.b.a. */
223 u_char lbal; /* lsb of l.b.a. */
224 u_char len; /* transfer length */
225 u_char xtra;
226 };
227
228 struct scsi_cdb10 {
229 u_char cmd; /* command code */
230 u_char lun: 3, /* logical unit on ctlr */
231 : 4,
232 rel: 1; /* l.b.a. is relative addr if =1 */
233 u_char lbah; /* msb of read/write logical block addr */
234 u_char lbahm; /* high middle byte of l.b.a. */
235 u_char lbalm; /* low middle byte of l.b.a. */
236 u_char lbal; /* lsb of l.b.a. */
237 u_char reserved;
238 u_char lenh; /* msb transfer length */
239 u_char lenl; /* lsb transfer length */
240 u_char xtra;
241 };
242
243 /* basic sense data */
244
245 struct scsi_sense {
246 u_char valid: 1, /* l.b.a. is valid */
247 class: 3,
248 code: 4;
249 u_char vu: 4, /* vendor unique */
250 lbah: 4;
251 u_char lbam;
252 u_char lbal;
253 };
254
255 struct scsi_xsense {
256 u_char valid: 1, /* l.b.a. is valid */
257 class: 3,
258 code: 4;
259 u_char segment;
260 u_char filemark: 1,
261 eom: 1,
262 ili: 1, /* illegal length indicator */
263 rsvd: 1,
264 key: 4;
265 u_char info1;
266 u_char info2;
267 u_char info3;
268 u_char info4;
269 u_char len; /* additional sense length */
270 };
271
272 /* inquiry data */
273 struct scsi_inquiry {
274 u_char type;
275 u_char qual;
276 u_char version;
277 u_char rsvd;
278 u_char len;
279 char class[3];
280 char vendor_id[8];
281 char product_id[16];
282 char rev[4];
283 };
284
285 struct scsi_format_parms { /* physical BFI format */
286 u_short reserved;
287 u_short list_len;
288 struct defect {
289 unsigned cyl : 24;
290 unsigned head : 8;
291 long bytes_from_index;
292 } defect[127];
293 };
294
295 #ifdef _KERNEL
296 extern struct scsi_format_parms format_parms;
297 #endif
298
299 struct scsi_reassign_parms {
300 u_short reserved;
301 u_short list_len; /* length in bytes of defects only */
302 struct new_defect {
303 unsigned lba; /* logical block address */
304 } new_defect[2];
305 };
306
307 #ifdef _KERNEL
308 extern struct scsi_reassign_parms reassign_parms;
309 #endif
310
311 struct scsi_modesel_hdr {
312 u_char rsvd1;
313 u_char media_type;
314 u_char rsvd2;
315 u_char block_desc_len;
316 u_int density : 8;
317 u_int number_blocks :24;
318 u_int rsvd3 : 8;
319 u_int block_length :24;
320 };
321
322 struct scsi_modesense_hdr {
323 u_char len;
324 u_char media_type;
325 u_char wp : 1;
326 u_char rsvd1 : 7;
327 u_char block_desc_len;
328 u_int density : 8;
329 u_int number_blocks :24;
330 u_int rsvd2 : 8;
331 u_int block_length :24;
332 };
333
334 /*
335 * Mode Select / Mode sense "pages"
336 */
337
338 /*
339 * Page One - Error Recovery Parameters
340 */
341 struct scsi_err_recovery {
342 u_char page_savable : 1; /* save parameters */
343 u_char reserved : 1;
344 u_char page_code : 6; /* = 0x01 */
345 u_char page_length; /* = 6 */
346 u_char awre : 1; /* auto write realloc enabled */
347 u_char arre : 1; /* auto read realloc enabled */
348 u_char tb : 1; /* transfer block */
349 u_char rc : 1; /* read continuous */
350 u_char eec : 1; /* enable early correction */
351 u_char per : 1; /* post error */
352 u_char dte : 1; /* disable transfer on error */
353 u_char dcr : 1; /* disable correction */
354 u_char retry_count;
355 u_char correction_span;
356 u_char head_offset_count;
357 u_char strobe_offset_count;
358 u_char recovery_time_limit;
359 };
360
361 /*
362 * Page Two - Disconnect / Reconnect Control Parameters
363 */
364 struct scsi_disco_reco {
365 u_char page_savable : 1; /* save parameters */
366 u_char rsvd : 1;
367 u_char page_code : 6; /* = 0x02 */
368 u_char page_length; /* = 10 */
369 u_char buffer_full_ratio; /* write, how full before reconnect? */
370 u_char buffer_empty_ratio; /* read, how full before reconnect? */
371
372 u_short bus_inactivity_limit; /* how much bus time for busy */
373 u_short disconnect_time_limit; /* min to remain disconnected */
374 u_short connect_time_limit; /* min to remain connected */
375 u_short reserved_1;
376 };
377
378 /*
379 * Page Three - Direct Access Device Format Parameters
380 */
381 struct scsi_format {
382 u_char page_savable : 1; /* save parameters */
383 u_char rsvd : 1;
384 u_char page_code : 6; /* = 0x03 */
385 u_char page_length; /* = 22 */
386 u_short tracks_per_zone; /* Handling of Defects Fields */
387 u_short alt_sect_zone;
388 u_short alt_tracks_zone;
389 u_short alt_tracks_vol;
390 u_short sect_track; /* Track Format Field */
391 u_short data_sect; /* Sector Format Fields */
392 u_short interleave;
393 u_short track_skew_factor;
394 u_short cyl_skew_factor;
395 u_char ssec : 1; /* Drive Type Field */
396 u_char hsec : 1;
397 u_char rmb : 1;
398 u_char surf : 1;
399 u_char ins : 1;
400 u_char reserved_1 : 3;
401 u_char reserved_2;
402 u_char reserved_3;
403 u_char reserved_4;
404 };
405
406 /*
407 * Page Four - Rigid Disk Drive Geometry Parameters
408 */
409 struct scsi_geometry {
410 u_char page_savable : 1; /* save parameters */
411 u_char rsvd : 1;
412 u_char page_code : 6; /* = 0x04 */
413 u_char page_length; /* = 18 */
414 u_char cyl_ub; /* number of cylinders */
415 u_char cyl_mb;
416 u_char cyl_lb;
417 u_char heads; /* number of heads */
418 u_char precomp_cyl_ub; /* cylinder to start precomp */
419 u_char precomp_cyl_mb;
420 u_char precomp_cyl_lb;
421 u_char current_cyl_ub; /* cyl to start reduced current */
422 u_char current_cyl_mb;
423 u_char current_cyl_lb;
424 u_short step_rate; /* drive step rate */
425 u_char landing_cyl_ub; /* landing zone cylinder */
426 u_char landing_cyl_mb;
427 u_char landing_cyl_lb;
428 u_char reserved_1;
429 u_char reserved_2;
430 u_char reserved_3;
431 };
432
433 /*
434 * Page 0x38 - Cache Control Parameters
435 */
436 struct scsi_cache {
437 u_char page_savable : 1; /* save parameters */
438 u_char rsvd : 1;
439 u_char page_code : 6; /* = 0x38 */
440 u_char page_length; /* = 14 */
441 u_char rsvd_1 : 1;
442 u_char wie : 1; /* write index enable */
443 u_char rsvd_2 : 1;
444 u_char ce : 1; /* cache enable */
445 u_char table_size : 4;
446 u_char prefetch_threshold;
447 u_char maximum_threshold;
448 u_char maximumprefetch_multiplier;
449 u_char minimum_threshold;
450 u_char minimum_prefetch_multiplier;
451 u_char reserved[8];
452 };
453
454 /*
455 * Control for SCSI "format" mode.
456 *
457 * "Format" mode allows a privileged process to issue direct SCSI
458 * commands to a drive (it is intended primarily to allow on-line
459 * formatting). SDIOCSFORMAT with a non-zero arg will put the drive
460 * into format mode; a zero arg will take it out. When in format
461 * mode, only the process that issued the SDIOCFORMAT can read or
462 * write the drive.
463 *
464 * In format mode, process is expected to
465 * - do SDIOCSCSICOMMAND to supply cdb for next SCSI op
466 * - do read or write as appropriate for cdb
467 * - if i/o error, optionally do SDIOCSENSE to get completion
468 * status and sense data from last scsi operation.
469 */
470
471 struct scsi_fmt_cdb {
472 int len; /* cdb length (in bytes) */
473 u_char cdb[28]; /* cdb to use on next read/write */
474 };
475
476 struct scsi_fmt_sense {
477 u_int status; /* completion status of last op */
478 u_char sense[28]; /* sense data (if any) from last op */
479 };
480
481 #define SDIOCSFORMAT _IOW('S', 0x1, int)
482 #define SDIOCGFORMAT _IOR('S', 0x2, int)
483 #define SDIOCSCSICOMMAND _IOW('S', 0x3, struct scsi_fmt_cdb)
484 #define SDIOCSENSE _IOR('S', 0x4, struct scsi_fmt_sense)
485