1/* $NetBSD: dptivar.h,v 1.9 2012/10/27 17:18:17 chs Exp $ */
2
3/*-
4 * Copyright (c) 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Andrew Doran.
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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/*
33 * Copyright (c) 1996-2000 Distributed Processing Technology Corporation
34 * Copyright (c) 2000 Adaptec Corporation
35 * All rights reserved.
36 *
37 * TERMS AND CONDITIONS OF USE
38 *
39 * Redistribution and use in source form, with or without modification, are
40 * permitted provided that redistributions of source code must retain the
41 * above copyright notice, this list of conditions and the following disclaimer.
42 *
43 * This software is provided `as is' by Adaptec and any express or implied
44 * warranties, including, but not limited to, the implied warranties of
45 * merchantability and fitness for a particular purpose, are disclaimed. In no
46 * event shall Adaptec be liable for any direct, indirect, incidental, special,
47 * exemplary or consequential damages (including, but not limited to,
48 * procurement of substitute goods or services; loss of use, data, or profits;
49 * or business interruptions) however caused and on any theory of liability,
50 * whether in contract, strict liability, or tort (including negligence or
51 * otherwise) arising in any way out of the use of this driver software, even
52 * if advised of the possibility of such damage.
53 */
54
55#ifndef _I2O_DPTIVAR_H_
56#define _I2O_DPTIVAR_H_
57
58#define DPTI_MAX_SEGS 17
59
60/*
61 * Runtime state.
62 */
63struct dpti_softc {
64 device_t sc_dev;
65 int sc_blinkled;
66};
67
68struct dpti_ptbuf {
69 void * db_ptr;
70 struct proc *db_proc;
71 int db_size;
72 int db_out;
73 int db_nfrag;
74 struct iovec db_frags[DPTI_MAX_SEGS];
75};
76
77/*
78 * Constants used by the `signature'.
79 */
80
81/* I2O */
82#define DPTI_VERSION 1
83#define DPTI_REVISION 0
84#define DPTI_SUBREVISION 0
85
86#define DPTI_YEAR 1
87#define DPTI_MONTH 9
88#define DPTI_DAY 12
89
90/* EATA */
91#define DPT_VERSION 1
92#define DPT_REVISION 0
93#define DPT_SUBREVISION 0
94
95#define DPT_YEAR 1
96#define DPT_MONTH 9
97#define DPT_DAY 12
98
99/*
100 * ioctls. We define only the lower 16 bits, since the DPT utilities don't
101 * seem to obey the ioctl encoding conventions of each platform - the high
102 * 16 bits are relatively meaningless.
103 */
104#define DPT_EATAUSRCMD 0x4441
105#define DPT_DEBUG 0x4442
106#define DPT_SIGNATURE 0x4443
107#define DPT_NUMCTRLS 0x4444
108#define DPT_CTRLINFO 0x4445
109#define DPT_STATINFO 0x4446
110#define DPT_CLRSTAT 0x4447
111#define DPT_SYSINFO 0x4448
112#define DPT_TIMEOUT 0x4449
113#define DPT_CONFIG 0x444a
114#define DPT_BLINKLED 0x444b
115#define DPT_I2OUSRCMD 0x444c
116#define DPT_I2ORESCANCMD 0x444d
117#define DPT_I2ORESETCMD 0x444e
118#define DPT_TARGET_BUSY 0x444f
119
120/*
121 * Controller and system info structures.
122 */
123struct dpt_ctlrinfo {
124 u_int16_t length;
125 u_int16_t drvrHBAnum;
126 u_int32_t baseAddr;
127 u_int16_t blinkState;
128 u_int8_t pciBusNum;
129 u_int8_t pciDeviceNum;
130 u_int16_t hbaFlags;
131 u_int16_t Interrupt;
132 u_int32_t reserved1;
133 u_int32_t reserved2;
134 u_int32_t reserved3;
135};
136#define FLG_OSD_PCI_VALID 0x0001
137#define FLG_OSD_DMA 0x0002
138#define FLG_OSD_I2O 0x0004
139
140struct dpt_eata_ctlrinfo {
141 u_int8_t state;
142 u_int8_t id;
143 int vect;
144 int base;
145 int njobs;
146 int qdepth;
147 int wakebase;
148 u_long sgsize;
149 u_int heads;
150 u_int sectors;
151 u_int8_t do_drive32;
152 u_int8_t busquiet;
153 u_int8_t idpal[4];
154 u_int8_t primary;
155 u_int8_t eataVersion;
156 u_long cpLength;
157 u_long spLength;
158 u_int8_t drqNum;
159 u_int8_t flag1;
160 u_int8_t flag2;
161};
162
163struct dpt_targetbusy {
164 u_long channel;
165 u_long id;
166 u_long lun;
167 u_long isbusy;
168};
169
170#if (!defined(dsDescription_size))
171# define dsDescription_size 46
172#endif
173
174struct dpt_sig {
175 char dsSignature[6]; /* ALWAYS "dPtSiG" */
176 u_int8_t dsSigVersion; /* sig version (currently 1) */
177 u_int8_t dsProcessorFamily; /* what type of processor */
178 u_int8_t dsProcessor; /* precise processor */
179 u_int8_t dsFiletype; /* type of file */
180 u_int8_t dsFiletypeFlags; /* flags to specify type, etc. */
181 u_int8_t dsOEM; /* OEM file was created for */
182 u_int32_t dsOS; /* which Operating systems */
183 u_int16_t dsCapabilities; /* RAID levels, etc. */
184 u_int16_t dsDeviceSupp; /* SCSI device types supported */
185 u_int16_t dsAdapterSupp; /* DPT HBA families supported */
186 u_int16_t dsApplication; /* applications file is for */
187 u_int8_t dsRequirements; /* Other driver dependencies */
188 u_int8_t dsVersion; /* 1 */
189 u_int8_t dsRevision; /* 'J' */
190 u_int8_t dsSubRevision; /* '9' ' ' if N/A */
191 u_int8_t dsMonth; /* creation month */
192 u_int8_t dsDay; /* creation day */
193 u_int8_t dsYear; /* creation year since 1980 (1993=13) */
194 char dsDescription[dsDescription_size];
195};
196
197struct dpt_dparam {
198 u_int16_t cylinders; /* Upto 1024 */
199 u_int8_t heads; /* Upto 255 */
200 u_int8_t sectors; /* Upto 63 */
201};
202
203struct dpt_sysinfo {
204 u_int8_t drive0CMOS; /* CMOS Drive 0 Type */
205 u_int8_t drive1CMOS; /* CMOS Drive 1 Type */
206 u_int8_t numDrives; /* 0040:0075 contents */
207 u_int8_t processorFamily; /* Same as DPTSIG's defs */
208 u_int8_t processorType; /* Same as DPTSIG's defs */
209 u_int8_t smartROMMajorVersion;
210 u_int8_t smartROMMinorVersion; /* SmartROM version */
211 u_int8_t smartROMRevision;
212 u_int16_t flags; /* See bit definitions above */
213 u_int16_t conventionalMemSize; /* in KB */
214 u_int32_t extendedMemSize; /* in KB */
215 u_int32_t osType; /* Same as DPTSIG's defs */
216 u_int8_t osMajorVersion;
217 u_int8_t osMinorVersion; /* The OS version */
218 u_int8_t osRevision;
219 u_int8_t osSubRevision;
220 u_int8_t busType; /* See defininitions above */
221 u_int8_t pad[3]; /* For alignment */
222 struct dpt_dparam drives[16]; /* SmartROM Logical Drives */
223};
224
225/*
226 * Defs pertaining to dpt_sysinfo.
227 */
228
229#define SI_CMOS_Valid 0x0001
230#define SI_NumDrivesValid 0x0002
231#define SI_ProcessorValid 0x0004
232#define SI_MemorySizeValid 0x0008
233#define SI_DriveParamsValid 0x0010
234#define SI_SmartROMverValid 0x0020
235#define SI_OSversionValid 0x0040
236#define SI_OSspecificValid 0x0080
237#define SI_BusTypeValid 0x0100
238#define SI_ALL_VALID 0x0FFF
239#define SI_NO_SmartROM 0x8000
240
241#define SI_ISA_BUS 0x00
242#define SI_MCA_BUS 0x01
243#define SI_EISA_BUS 0x02
244#define SI_PCI_BUS 0x04
245
246
247/*
248 * Defs pertaining to dpt_sig.
249 */
250
251/* Current Signature Version - u_int8_t dsSigVersion; */
252/* ------------------------------------------------------------------ */
253#define SIG_VERSION 1
254
255/* Processor Family - u_int8_t dsProcessorFamily; DISTINCT VALUES */
256/* ------------------------------------------------------------------ */
257/* What type of processor the file is meant to run on. */
258/* This will let us know whether to read u_int16_ts as high/low or low/high. */
259#define PROC_INTEL 0x00 /* Intel 80x86 */
260#define PROC_MOTOROLA 0x01 /* Motorola 68K */
261#define PROC_MIPS4000 0x02 /* MIPS RISC 4000 */
262#define PROC_MIPS 0x02 /* MIPS RISC */
263#define PROC_ALPHA 0x03 /* DEC Alpha */
264#define PROC_POWERPC 0x04 /* IBM Power PC */
265#define PROC_i960 0x05 /* Intel i960 */
266#define PROC_ULTRASPARC 0x06 /* SPARC processor */
267
268/* Specific Minimim Processor - u_int8_t dsProcessor; FLAG BITS */
269/* ------------------------------------------------------------------ */
270/* Different bit definitions dependent on processor_family */
271
272/* PROC_INTEL: */
273#define PROC_8086 0x01 /* Intel 8086 */
274#define PROC_286 0x02 /* Intel 80286 */
275#define PROC_386 0x04 /* Intel 80386 */
276#define PROC_486 0x08 /* Intel 80486 */
277#define PROC_PENTIUM 0x10 /* Intel 586 aka P5 aka Pentium */
278#define PROC_SEXIUM 0x20 /* Intel 686 aka P6 aka Pentium Pro or MMX */
279
280/* PROC_i960: */
281#define PROC_960RX 0x01 /* Intel 80960RP/RD */
282#define PROC_960HX 0x02 /* Intel 80960HA/HD/HT */
283#define PROC_960RN 0x03 /* Intel 80960RN/RM */
284#define PROC_960RS 0x04 /* Intel 80960RS */
285
286/* PROC_MOTOROLA: */
287#define PROC_68000 0x01 /* Motorola 68000 */
288#define PROC_68010 0x02 /* Motorola 68010 */
289#define PROC_68020 0x04 /* Motorola 68020 */
290#define PROC_68030 0x08 /* Motorola 68030 */
291#define PROC_68040 0x10 /* Motorola 68040 */
292
293/* PROC_POWERPC */
294#define PROC_PPC601 0x01 /* PowerPC 601 */
295#define PROC_PPC603 0x02 /* PowerPC 603 */
296#define PROC_PPC604 0x04 /* PowerPC 604 */
297
298/* PROC_MIPS */
299#define PROC_R4000 0x01 /* MIPS R4000 */
300#define PROC_RM7000 0x02 /* MIPS RM7000 */
301
302/* Filetype - u_int8_t dsFiletype; DISTINCT VALUES */
303/* ------------------------------------------------------------------ */
304#define FT_EXECUTABLE 0 /* Executable Program */
305#define FT_SCRIPT 1 /* Script/Batch File??? */
306#define FT_HBADRVR 2 /* HBA Driver */
307#define FT_OTHERDRVR 3 /* Other Driver */
308#define FT_IFS 4 /* Installable Filesystem Driver */
309#define FT_ENGINE 5 /* DPT Engine */
310#define FT_COMPDRVR 6 /* Compressed Driver Disk */
311#define FT_LANGUAGE 7 /* Foreign Language file */
312#define FT_FIRMWARE 8 /* Downloadable or actual Firmware */
313#define FT_COMMMODL 9 /* Communications Module */
314#define FT_INT13 10 /* INT 13 style HBA Driver */
315#define FT_HELPFILE 11 /* Help file */
316#define FT_LOGGER 12 /* Event Logger */
317#define FT_INSTALL 13 /* An Install Program */
318#define FT_LIBRARY 14 /* Storage Manager Real-Mode Calls */
319#define FT_RESOURCE 15 /* Storage Manager Resource File */
320#define FT_MODEM_DB 16 /* Storage Manager Modem Database */
321
322/* Filetype flags - u_int8_t dsFiletypeFlags; FLAG BITS */
323/* ------------------------------------------------------------------ */
324#define FTF_DLL 0x01 /* Dynamic Link Library */
325#define FTF_NLM 0x02 /* Netware Loadable Module */
326#define FTF_OVERLAYS 0x04 /* Uses overlays */
327#define FTF_DEBUG 0x08 /* Debug version */
328#define FTF_TSR 0x10 /* TSR */
329#define FTF_SYS 0x20 /* DOS Loadable driver */
330#define FTF_PROTECTED 0x40 /* Runs in protected mode */
331#define FTF_APP_SPEC 0x80 /* Application Specific */
332#define FTF_ROM (FTF_SYS|FTF_TSR) /* Special Case */
333
334/* OEM - u_int8_t dsOEM; DISTINCT VALUES */
335/* ------------------------------------------------------------------ */
336#define OEM_DPT 0 /* DPT */
337#define OEM_ATT 1 /* ATT */
338#define OEM_NEC 2 /* NEC */
339#define OEM_ALPHA 3 /* Alphatronix */
340#define OEM_AST 4 /* AST */
341#define OEM_OLIVETTI 5 /* Olivetti */
342#define OEM_SNI 6 /* Siemens/Nixdorf */
343#define OEM_SUN 7 /* SUN Microsystems */
344#define OEM_ADAPTEC 8 /* Adaptec */
345
346/* Operating System - u_int32_t dsOS; FLAG BITS */
347/* ------------------------------------------------------------------ */
348#define OS_DOS 0x00000001 /* PC/MS-DOS */
349#define OS_WINDOWS 0x00000002 /* Microsoft Windows 3.x */
350#define OS_WINDOWS_NT 0x00000004 /* Microsoft Windows NT */
351#define OS_OS2M 0x00000008 /* OS/2 1.2.x,MS 1.3.0,IBM 1.3.x - Monolithic */
352#define OS_OS2L 0x00000010 /* Microsoft OS/2 1.301 - LADDR */
353#define OS_OS22x 0x00000020 /* IBM OS/2 2.x */
354#define OS_NW286 0x00000040 /* Novell NetWare 286 */
355#define OS_NW386 0x00000080 /* Novell NetWare 386 */
356#define OS_GEN_UNIX 0x00000100 /* Generic Unix */
357#define OS_SCO_UNIX 0x00000200 /* SCO Unix */
358#define OS_ATT_UNIX 0x00000400 /* ATT Unix */
359#define OS_UNIXWARE 0x00000800 /* USL Unix */
360#define OS_INT_UNIX 0x00001000 /* Interactive Unix */
361#define OS_SOLARIS 0x00002000 /* SunSoft Solaris */
362#define OS_QNX 0x00004000 /* QNX for Tom Moch */
363#define OS_NEXTSTEP 0x00008000 /* NeXTSTEP/OPENSTEP/MACH */
364#define OS_BANYAN 0x00010000 /* Banyan Vines */
365#define OS_OLIVETTI_UNIX 0x00020000/* Olivetti Unix */
366#define OS_MAC_OS 0x00040000 /* Mac OS */
367#define OS_WINDOWS_95 0x00080000 /* Microsoft Windows '95 */
368#define OS_NW4x 0x00100000 /* Novell Netware 4.x */
369#define OS_BSDI_UNIX 0x00200000 /* BSDi Unix BSD/OS 2.0 and up */
370#define OS_AIX_UNIX 0x00400000 /* AIX Unix */
371#define OS_FREE_BSD 0x00800000 /* FreeBSD Unix */
372#define OS_LINUX 0x01000000 /* Linux */
373#define OS_DGUX_UNIX 0x02000000 /* Data General Unix */
374#define OS_SINIX_N 0x04000000 /* SNI SINIX-N */
375#define OS_PLAN9 0x08000000 /* ATT Plan 9 */
376#define OS_TSX 0x10000000 /* SNH TSX-32 */
377#define OS_WINDOWS_98 0x20000000 /* Microsoft Windows '98 */
378
379#define OS_OTHER 0x80000000 /* Other */
380
381/* Capabilities - u_int16_t dsCapabilities; FLAG BITS */
382/* ------------------------------------------------------------------ */
383#define CAP_RAID0 0x0001 /* RAID-0 */
384#define CAP_RAID1 0x0002 /* RAID-1 */
385#define CAP_RAID3 0x0004 /* RAID-3 */
386#define CAP_RAID5 0x0008 /* RAID-5 */
387#define CAP_SPAN 0x0010 /* Spanning */
388#define CAP_PASS 0x0020 /* Provides passthrough */
389#define CAP_OVERLAP 0x0040 /* Passthrough supports overlapped commands */
390#define CAP_ASPI 0x0080 /* Supports ASPI Command Requests */
391#define CAP_ABOVE16MB 0x0100 /* ISA Driver supports greater than 16MB */
392#define CAP_EXTEND 0x8000 /* Extended info appears after description */
393#ifdef SNI_MIPS
394#define CAP_CACHEMODE 0x1000 /* dpt_force_cache is set in driver */
395#endif
396
397/* Devices Supported - u_int16_t dsDeviceSupp; FLAG BITS */
398/* ------------------------------------------------------------------ */
399#define DEV_DASD 0x0001 /* DASD (hard drives) */
400#define DEV_TAPE 0x0002 /* Tape drives */
401#define DEV_PRINTER 0x0004 /* Printers */
402#define DEV_PROC 0x0008 /* Processors */
403#define DEV_WORM 0x0010 /* WORM drives */
404#define DEV_CDROM 0x0020 /* CD-ROM drives */
405#define DEV_SCANNER 0x0040 /* Scanners */
406#define DEV_OPTICAL 0x0080 /* Optical Drives */
407#define DEV_JUKEBOX 0x0100 /* Jukebox */
408#define DEV_COMM 0x0200 /* Communications Devices */
409#define DEV_OTHER 0x0400 /* Other Devices */
410#define DEV_ALL 0xFFFF /* All SCSI Devices */
411
412/* Adapters Families Supported - u_int16_t dsAdapterSupp; FLAG BITS */
413/* ------------------------------------------------------------------ */
414#define ADF_2001 0x0001 /* PM2001 */
415#define ADF_2012A 0x0002 /* PM2012A */
416#define ADF_PLUS_ISA 0x0004 /* PM2011,PM2021 */
417#define ADF_PLUS_EISA 0x0008 /* PM2012B,PM2022 */
418#define ADF_SC3_ISA 0x0010 /* PM2021 */
419#define ADF_SC3_EISA 0x0020 /* PM2022,PM2122, etc */
420#define ADF_SC3_PCI 0x0040 /* SmartCache III PCI */
421#define ADF_SC4_ISA 0x0080 /* SmartCache IV ISA */
422#define ADF_SC4_EISA 0x0100 /* SmartCache IV EISA */
423#define ADF_SC4_PCI 0x0200 /* SmartCache IV PCI */
424#define ADF_SC5_PCI 0x0400 /* Fifth Generation I2O products */
425/*
426 * Combinations of products
427 */
428#define ADF_ALL_2000 (ADF_2001|ADF_2012A)
429#define ADF_ALL_PLUS (ADF_PLUS_ISA|ADF_PLUS_EISA)
430#define ADF_ALL_SC3 (ADF_SC3_ISA|ADF_SC3_EISA|ADF_SC3_PCI)
431#define ADF_ALL_SC4 (ADF_SC4_ISA|ADF_SC4_EISA|ADF_SC4_PCI)
432#define ADF_ALL_SC5 (ADF_SC5_PCI)
433/* All EATA Cacheing Products */
434#define ADF_ALL_CACHE (ADF_ALL_PLUS|ADF_ALL_SC3|ADF_ALL_SC4)
435/* All EATA Bus Mastering Products */
436#define ADF_ALL_MASTER (ADF_2012A|ADF_ALL_CACHE)
437/* All EATA Adapter Products */
438#define ADF_ALL_EATA (ADF_2001|ADF_ALL_MASTER)
439#define ADF_ALL ADF_ALL_EATA
440
441/* Application - u_int16_t dsApplication; FLAG BITS */
442/* ------------------------------------------------------------------ */
443#define APP_DPTMGR 0x0001 /* DPT Storage Manager */
444#define APP_ENGINE 0x0002 /* DPT Engine */
445#define APP_SYTOS 0x0004 /* Sytron Sytos Plus */
446#define APP_CHEYENNE 0x0008 /* Cheyenne ARCServe + ARCSolo */
447#define APP_MSCDEX 0x0010 /* Microsoft CD-ROM extensions */
448#define APP_NOVABACK 0x0020 /* NovaStor Novaback */
449#define APP_AIM 0x0040 /* Archive Information Manager */
450
451/* Requirements - u_int8_t dsRequirements; FLAG BITS */
452/* ------------------------------------------------------------------ */
453#define REQ_SMARTROM 0x01 /* Requires SmartROM to be present */
454#define REQ_DPTDDL 0x02 /* Requires DPTDDL.SYS to be loaded */
455#define REQ_HBA_DRIVER 0x04 /* Requires an HBA driver to be loaded */
456#define REQ_ASPI_TRAN 0x08 /* Requires an ASPI Transport Modules */
457#define REQ_ENGINE 0x10 /* Requires a DPT Engine to be loaded */
458#define REQ_COMM_ENG 0x20 /* Requires a DPT Communications Engine */
459
460/* ------------------------------------------------------------------ */
461/* Requirements - u_int16_t dsFirmware; FLAG BITS */
462/* ------------------------------------------------------------------ */
463#define dsFirmware dsApplication
464#define FW_DNLDSIZE0 0x0000 /* 0..2 DownLoader Size - NONE */
465#define FW_DNLDSIZE16 0x0001 /* 0..2 DownLoader Size 16K */
466#define FW_DNLDSIZE32 0x0002 /* 0..2 DownLoader Size 32K */
467#define FW_DNLDSIZE64 0x0004 /* 0..2 DownLoader Size 64K */
468
469#define FW_LOAD_BTM 0x2000 /* 13 Load Offset (1=Btm, 0=Top) */
470#define FW_LOAD_TOP 0x0000 /* 13 Load Offset (1=Btm, 0=Top) */
471#define FW_SIG_VERSION1 0x0000 /* 15..14 Version Bits 0=Ver1 */
472
473#endif /* !_I2O_DPTIVAR_H_ */
474