1 /* $FreeBSD: src/sys/dev/asr/dptsig.h,v 1.1.2.2 2001/08/23 05:21:29 scottl Exp $ */
3 * Copyright (c) 1996-2000 Distributed Processing Technology Corporation
4 * Copyright (c) 2000-2001 Adaptec Corporation.
7 * Redistribution and use in source form, with or without modification, are
8 * permitted provided that redistributions of source code must retain the
9 * above copyright notice, this list of conditions and the following disclaimer.
11 * This software is provided `as is' by Distributed Processing Technology and
12 * any express or implied warranties, including, but not limited to, the
13 * implied warranties of merchantability and fitness for a particular purpose,
14 * are disclaimed. In no event shall Distributed Processing Technology be
15 * liable for any direct, indirect, incidental, special, exemplary or
16 * consequential damages (including, but not limited to, procurement of
17 * substitute goods or services; loss of use, data, or profits; or business
18 * interruptions) however caused and on any theory of liability, whether in
19 * contract, strict liability, or tort (including negligence or otherwise)
20 * arising in any way out of the use of this driver software, even if advised
21 * of the possibility of such damage.
28 /* DPT SIGNATURE SPEC AND HEADER FILE */
29 /* Signature Version 1 (sorry no 'A') */
31 /* to make sure we are talking the same size under all OS's */
32 typedef unsigned char sigBYTE;
33 typedef unsigned short sigWORD;
34 #if (defined(_MULTI_DATAMODEL) && defined(sun) && !defined(_ILP32))
35 typedef uint32_t sigLONG;
37 typedef unsigned long sigLONG;
41 * use sigWORDLittleEndian for:
46 * use sigLONGLittleEndian for:
48 * so that the sig can be standardised to Little Endian
50 #if (defined(_DPT_BIG_ENDIAN))
51 # define sigWORDLittleEndian(x) ((((x)&0xFF)<<8)|(((x)>>8)&0xFF))
52 # define sigLONGLittleEndian(x) \
55 (((x)&0xFF0000L)>>8) | \
56 (((x)&0xFF000000L)>>24))
58 # define sigWORDLittleEndian(x) (x)
59 # define sigLONGLittleEndian(x) (x)
62 /* must make sure the structure is not word or double-word aligned */
63 /* --------------------------------------------------------------- */
64 /* Borland will ignore the following pragma: */
65 /* Word alignment is OFF by default. If in the, IDE make */
66 /* sure that Options | Compiler | Code Generation | Word Alignment */
67 /* is not checked. If using BCC, do not use the -a option. */
70 #if defined (_DPT_AIX)
71 #pragma options align=packed
76 /* For the Macintosh */
77 #if STRUCTALIGNMENTSUPPORTED
78 #pragma options align=mac68k
82 /* Current Signature Version - sigBYTE dsSigVersion; */
83 /* ------------------------------------------------------------------ */
86 /* Processor Family - sigBYTE dsProcessorFamily; DISTINCT VALUES */
87 /* ------------------------------------------------------------------ */
88 /* What type of processor the file is meant to run on. */
89 /* This will let us know whether to read sigWORDs as high/low or low/high. */
90 #define PROC_INTEL 0x00 /* Intel 80x86 */
91 #define PROC_MOTOROLA 0x01 /* Motorola 68K */
92 #define PROC_MIPS4000 0x02 /* MIPS RISC 4000 */
93 #define PROC_MIPS PROC_MIPS4000 /* MIPS RISC */
94 #define PROC_ALPHA 0x03 /* DEC Alpha */
95 #define PROC_POWERPC 0x04 /* IBM Power PC */
96 #define PROC_i960 0x05 /* Intel i960 */
97 #define PROC_ULTRASPARC 0x06 /* SPARC processor */
99 /* Specific Minimim Processor - sigBYTE dsProcessor; FLAG BITS */
100 /* ------------------------------------------------------------------ */
101 /* Different bit definitions dependent on processor_family */
104 #define PROC_8086 0x01 /* Intel 8086 */
105 #define PROC_286 0x02 /* Intel 80286 */
106 #define PROC_386 0x04 /* Intel 80386 */
107 #define PROC_486 0x08 /* Intel 80486 */
108 #define PROC_PENTIUM 0x10 /* Intel 586 aka P5 aka Pentium */
109 #define PROC_SEXIUM 0x20 /* Intel 686 aka P6 aka Pentium Pro or MMX */
110 #define PROC_ITANIUM 0x40 /* Intel Itanium 64 bit */
113 #define PROC_960RX 0x01 /* Intel 80960RP/RD */
114 #define PROC_960HX 0x02 /* Intel 80960HA/HD/HT */
115 #define PROC_960RN 0x03 /* Intel 80960RN/RM */
116 #define PROC_960RS 0x04 /* Intel 80960RS */
117 #define PROC_80303 0x05 /* Intel 80303 (ZION) */
120 #define PROC_68000 0x01 /* Motorola 68000 */
121 #define PROC_68010 0x02 /* Motorola 68010 */
122 #define PROC_68020 0x04 /* Motorola 68020 */
123 #define PROC_68030 0x08 /* Motorola 68030 */
124 #define PROC_68040 0x10 /* Motorola 68040 */
127 #define PROC_PPC601 0x01 /* PowerPC 601 */
128 #define PROC_PPC603 0x02 /* PowerPC 603 */
129 #define PROC_PPC604 0x04 /* PowerPC 604 */
132 #define PROC_R4000 0x01 /* MIPS R4000 */
133 #define PROC_RM7000 0x02 /* MIPS RM7000 */
135 /* Filetype - sigBYTE dsFiletype; DISTINCT VALUES */
136 /* ------------------------------------------------------------------ */
137 #define FT_EXECUTABLE 0 /* Executable Program */
138 #define FT_SCRIPT 1 /* Script/Batch File??? */
139 #define FT_HBADRVR 2 /* HBA Driver */
140 #define FT_OTHERDRVR 3 /* Other Driver */
141 #define FT_IFS 4 /* Installable Filesystem Driver */
142 #define FT_ENGINE 5 /* DPT Engine */
143 #define FT_COMPDRVR 6 /* Compressed Driver Disk */
144 #define FT_LANGUAGE 7 /* Foreign Language file */
145 #define FT_FIRMWARE 8 /* Downloadable or actual Firmware */
146 #define FT_COMMMODL 9 /* Communications Module */
147 #define FT_INT13 10 /* INT 13 style HBA Driver */
148 #define FT_HELPFILE 11 /* Help file */
149 #define FT_LOGGER 12 /* Event Logger */
150 #define FT_INSTALL 13 /* An Install Program */
151 #define FT_LIBRARY 14 /* Storage Manager Real-Mode Calls */
152 #define FT_RESOURCE 15 /* Storage Manager Resource File */
153 #define FT_MODEM_DB 16 /* Storage Manager Modem Database */
154 #define FT_DMI 17 /* DMI component interface */
156 /* Filetype flags - sigBYTE dsFiletypeFlags; FLAG BITS */
157 /* ------------------------------------------------------------------ */
158 #define FTF_DLL 0x01 /* Dynamic Link Library */
159 #define FTF_NLM 0x02 /* Netware Loadable Module */
160 #define FTF_OVERLAYS 0x04 /* Uses overlays */
161 #define FTF_DEBUG 0x08 /* Debug version */
162 #define FTF_TSR 0x10 /* TSR */
163 #define FTF_SYS 0x20 /* DOS Loadable driver */
164 #define FTF_PROTECTED 0x40 /* Runs in protected mode */
165 #define FTF_APP_SPEC 0x80 /* Application Specific */
166 #define FTF_ROM (FTF_SYS|FTF_TSR) /* Special Case */
168 /* OEM - sigBYTE dsOEM; DISTINCT VALUES */
169 /* ------------------------------------------------------------------ */
170 #define OEM_DPT 0 /* DPT */
171 #define OEM_ATT 1 /* ATT */
172 #define OEM_NEC 2 /* NEC */
173 #define OEM_ALPHA 3 /* Alphatronix */
174 #define OEM_AST 4 /* AST */
175 #define OEM_OLIVETTI 5 /* Olivetti */
176 #define OEM_SNI 6 /* Siemens/Nixdorf */
177 #define OEM_SUN 7 /* SUN Microsystems */
178 #define OEM_ADAPTEC 8 /* Adaptec */
180 /* Operating System - sigLONG dsOS; FLAG BITS */
181 /* ------------------------------------------------------------------ */
182 #define OS_DOS 0x00000001 /* PC/MS-DOS */
183 #define OS_WINDOWS 0x00000002 /* Microsoft Windows 3.x */
184 #define OS_WINDOWS_NT 0x00000004 /* Microsoft Windows NT */
185 #define OS_OS2M 0x00000008 /* OS/2 1.2.x,MS 1.3.0,IBM 1.3.x - Monolithic */
186 #define OS_OS2L 0x00000010 /* Microsoft OS/2 1.301 - LADDR */
187 #define OS_OS22x 0x00000020 /* IBM OS/2 2.x */
188 #define OS_NW286 0x00000040 /* Novell NetWare 286 */
189 #define OS_NW386 0x00000080 /* Novell NetWare 386 */
190 #define OS_GEN_UNIX 0x00000100 /* Generic Unix */
191 #define OS_SCO_UNIX 0x00000200 /* SCO Unix */
192 #define OS_ATT_UNIX 0x00000400 /* ATT Unix */
193 #define OS_UNIXWARE 0x00000800 /* USL Unix */
194 #define OS_INT_UNIX 0x00001000 /* Interactive Unix */
195 #define OS_SOLARIS 0x00002000 /* SunSoft Solaris */
196 #define OS_QNX 0x00004000 /* QNX for Tom Moch */
197 #define OS_NEXTSTEP 0x00008000 /* NeXTSTEP/OPENSTEP/MACH */
198 #define OS_BANYAN 0x00010000 /* Banyan Vines */
199 #define OS_OLIVETTI_UNIX 0x00020000/* Olivetti Unix */
200 #define OS_MAC_OS 0x00040000 /* Mac OS */
201 #define OS_WINDOWS_95 0x00080000 /* Microsoft Windows '95 */
202 #define OS_NW4x 0x00100000 /* Novell Netware 4.x */
203 #define OS_BSDI_UNIX 0x00200000 /* BSDi Unix BSD/OS 2.0 and up */
204 #define OS_AIX_UNIX 0x00400000 /* AIX Unix */
205 #define OS_FREE_BSD 0x00800000 /* FreeBSD Unix */
206 #define OS_LINUX 0x01000000 /* Linux */
207 #define OS_DGUX_UNIX 0x02000000 /* Data General Unix */
208 #define OS_SINIX_N 0x04000000 /* SNI SINIX-N */
209 #define OS_PLAN9 0x08000000 /* ATT Plan 9 */
210 #define OS_TSX 0x10000000 /* SNH TSX-32 */
211 #define OS_WINDOWS_98 0x20000000 /* Microsoft Windows '98 */
212 #define OS_NW5x 0x40000000 /* Novell Netware 5x */
214 #define OS_OTHER 0x80000000 /* Other */
216 /* Capabilities - sigWORD dsCapabilities; FLAG BITS */
217 /* ------------------------------------------------------------------ */
218 #define CAP_RAID0 0x0001 /* RAID-0 */
219 #define CAP_RAID1 0x0002 /* RAID-1 */
220 #define CAP_RAID3 0x0004 /* RAID-3 */
221 #define CAP_RAID5 0x0008 /* RAID-5 */
222 #define CAP_SPAN 0x0010 /* Spanning */
223 #define CAP_PASS 0x0020 /* Provides passthrough */
224 #define CAP_OVERLAP 0x0040 /* Passthrough supports overlapped commands */
225 #define CAP_ASPI 0x0080 /* Supports ASPI Command Requests */
226 #define CAP_ABOVE16MB 0x0100 /* ISA Driver supports greater than 16MB */
227 #define CAP_EXTEND 0x8000 /* Extended info appears after description */
229 #define CAP_CACHEMODE 0x1000 /* dpt_force_cache is set in driver */
232 /* Devices Supported - sigWORD dsDeviceSupp; FLAG BITS */
233 /* ------------------------------------------------------------------ */
234 #define DEV_DASD 0x0001 /* DASD (hard drives) */
235 #define DEV_TAPE 0x0002 /* Tape drives */
236 #define DEV_PRINTER 0x0004 /* Printers */
237 #define DEV_PROC 0x0008 /* Processors */
238 #define DEV_WORM 0x0010 /* WORM drives */
239 #define DEV_CDROM 0x0020 /* CD-ROM drives */
240 #define DEV_SCANNER 0x0040 /* Scanners */
241 #define DEV_OPTICAL 0x0080 /* Optical Drives */
242 #define DEV_JUKEBOX 0x0100 /* Jukebox */
243 #define DEV_COMM 0x0200 /* Communications Devices */
244 #define DEV_OTHER 0x0400 /* Other Devices */
245 #define DEV_ALL 0xFFFF /* All SCSI Devices */
247 /* Adapters Families Supported - sigWORD dsAdapterSupp; FLAG BITS */
248 /* ------------------------------------------------------------------ */
249 #define ADF_2001 0x0001 /* PM2001 */
250 #define ADF_2012A 0x0002 /* PM2012A */
251 #define ADF_PLUS_ISA 0x0004 /* PM2011,PM2021 */
252 #define ADF_PLUS_EISA 0x0008 /* PM2012B,PM2022 */
253 #define ADF_SC3_ISA 0x0010 /* PM2021 */
254 #define ADF_SC3_EISA 0x0020 /* PM2022,PM2122, etc */
255 #define ADF_SC3_PCI 0x0040 /* SmartCache III PCI */
256 #define ADF_SC4_ISA 0x0080 /* SmartCache IV ISA */
257 #define ADF_SC4_EISA 0x0100 /* SmartCache IV EISA */
258 #define ADF_SC4_PCI 0x0200 /* SmartCache IV PCI */
259 #define ADF_SC5_PCI 0x0400 /* Fifth Generation I2O products */
261 * Combinations of products
263 #define ADF_ALL_2000 (ADF_2001|ADF_2012A)
264 #define ADF_ALL_PLUS (ADF_PLUS_ISA|ADF_PLUS_EISA)
265 #define ADF_ALL_SC3 (ADF_SC3_ISA|ADF_SC3_EISA|ADF_SC3_PCI)
266 #define ADF_ALL_SC4 (ADF_SC4_ISA|ADF_SC4_EISA|ADF_SC4_PCI)
267 #define ADF_ALL_SC5 (ADF_SC5_PCI)
268 /* All EATA Cacheing Products */
269 #define ADF_ALL_CACHE (ADF_ALL_PLUS|ADF_ALL_SC3|ADF_ALL_SC4)
270 /* All EATA Bus Mastering Products */
271 #define ADF_ALL_MASTER (ADF_2012A|ADF_ALL_CACHE)
272 /* All EATA Adapter Products */
273 #define ADF_ALL_EATA (ADF_2001|ADF_ALL_MASTER)
274 #define ADF_ALL ADF_ALL_EATA
276 /* Application - sigWORD dsApplication; FLAG BITS */
277 /* ------------------------------------------------------------------ */
278 #define APP_DPTMGR 0x0001 /* DPT Storage Manager */
279 #define APP_ENGINE 0x0002 /* DPT Engine */
280 #define APP_SYTOS 0x0004 /* Sytron Sytos Plus */
281 #define APP_CHEYENNE 0x0008 /* Cheyenne ARCServe + ARCSolo */
282 #define APP_MSCDEX 0x0010 /* Microsoft CD-ROM extensions */
283 #define APP_NOVABACK 0x0020 /* NovaStor Novaback */
284 #define APP_AIM 0x0040 /* Archive Information Manager */
286 /* Requirements - sigBYTE dsRequirements; FLAG BITS */
287 /* ------------------------------------------------------------------ */
288 #define REQ_SMARTROM 0x01 /* Requires SmartROM to be present */
289 #define REQ_DPTDDL 0x02 /* Requires DPTDDL.SYS to be loaded */
290 #define REQ_HBA_DRIVER 0x04 /* Requires an HBA driver to be loaded */
291 #define REQ_ASPI_TRAN 0x08 /* Requires an ASPI Transport Modules */
292 #define REQ_ENGINE 0x10 /* Requires a DPT Engine to be loaded */
293 #define REQ_COMM_ENG 0x20 /* Requires a DPT Communications Engine */
295 /* ------------------------------------------------------------------ */
296 /* Requirements - sigWORD dsFirmware; FLAG BITS */
297 /* ------------------------------------------------------------------ */
298 #define dsFirmware dsApplication
299 #define FW_DNLDSIZE16_OLD 0x0000 /* 0..3 DownLoader Size 16K - TO SUPPORT OLD IMAGES */
300 #define FW_DNLDSIZE16k 0x0000 /* 0..3 DownLoader Size 16k */
301 #define FW_DNLDSIZE16 0x0001 /* 0..3 DownLoader Size 16K */
302 #define FW_DNLDSIZE32 0x0002 /* 0..3 DownLoader Size 32K */
303 #define FW_DNLDSIZE64 0x0004 /* 0..3 DownLoader Size 64K */
304 #define FW_DNLDSIZE0 0x000f /* 0..3 DownLoader Size 0K - NONE */
305 #define FW_DNLDSIZE_NONE 0x000F /* 0..3 DownLoader Size - NONE */
307 /* Code Offset is position of the code within the ROM CODE Segment */
308 #define FW_DNLDR_TOP 0x0000 /* 12 DownLoader Position (0=Top, 1=Bottom) */
309 #define FW_DNLDR_BTM 0x1000 /* 12 DownLoader Position (0=Top, 1=Bottom) Dominator */
311 #define FW_LOAD_BTM 0x0000 /* 13 Code Offset (0=Btm, 1=Top) MIPS */
312 #define FW_LOAD_TOP 0x2000 /* 13 Code Offset (0=Btm, 1=Top) i960 */
314 #define FW_SIG_VERSION1 0x0000 /* 15..14 Version Bits 0=Ver1 */
315 #define FW_SIG_VERSION2 0x4000 /* 15..14 Version Bits 1=Ver2 */
318 0..3 Downloader Size (Value * 16K)
330 12 Downloader Position (0=Top of Image 1= Bottom of Image (Dominator) )
331 13 Load Offset (0=BTM (MIPS) -- 1=TOP (960) )
332 14..15 F/W Sig Version (0=Ver1)
335 /* ------------------------------------------------------------------ */
336 /* Sub System Vendor IDs - The PCI Sub system and vendor IDs for each */
337 /* Adaptec Raid controller */
338 /* ------------------------------------------------------------------ */
339 #define PM1554U2_SUB_ID 0xC0011044
340 #define PM1654U2_SUB_ID 0xC0021044
341 #define PM1564U3_1_SUB_ID 0xC0031044
342 #define PM1564U3_2_SUB_ID 0xC0041044
343 #define PM1554U2_NOACPI_SUB_ID 0xC0051044
344 #define PM2554U2_SUB_ID 0xC00A1044
345 #define PM2654U2_SUB_ID 0xC00B1044
346 #define PM2664U3_1_SUB_ID 0xC00C1044
347 #define PM2664U3_2_SUB_ID 0xC00D1044
348 #define PM2554U2_NOACPI_SUB_ID 0xC00E1044
349 #define PM2654U2_NOACPI_SUB_ID 0xC00F1044
350 #define PM3754U2_SUB_ID 0xC0141044
351 #define PM3755U2B_SUB_ID 0xC0151044
352 #define PM3755F_SUB_ID 0xC0161044
353 #define PM3757U2_1_SUB_ID 0xC01E1044
354 #define PM3757U2_2_SUB_ID 0xC01F1044
355 #define PM3767U3_2_SUB_ID 0xC0201044
356 #define PM3767U3_4_SUB_ID 0xC0211044
357 #define PM2865U3_1_SUB_ID 0xC0281044
358 #define PM2865U3_2_SUB_ID 0xC0291044
359 #define PM2865F_SUB_ID 0xC02A1044
360 #define ADPT2000S_1_SUB_ID 0xC03C1044
361 #define ADPT2000S_2_SUB_ID 0xC03D1044
362 #define ADPT2000F_SUB_ID 0xC03E1044
363 #define ADPT3000S_1_SUB_ID 0xC0461044
364 #define ADPT3000S_2_SUB_ID 0xC0471044
365 #define ADPT3000F_SUB_ID 0xC0481044
366 #define ADPT5000S_1_SUB_ID 0xC0501044
367 #define ADPT5000S_2_SUB_ID 0xC0511044
368 #define ADPT5000F_SUB_ID 0xC0521044
369 #define ADPT1000UDMA_SUB_ID 0xC05A1044
370 #define ADPT1000UDMA_DAC_SUB_ID 0xC05B1044
371 #define ADPTI2O_DEVICE_ID 0xa501
372 #define ADPTDOMINATOR_DEVICE_ID 0xa511
373 #define ADPTDOMINATOR_SUB_ID_START 0xC0321044
374 #define ADPTDOMINATOR_SUB_ID_END 0xC03b1044
378 /* ------------------------------------------------------------------ */
379 /* ------------------------------------------------------------------ */
380 /* ------------------------------------------------------------------ */
383 * You may adjust dsDescription_size with an override to a value less than
384 * 50 so that the structure allocates less real space.
386 #if (!defined(dsDescription_size))
387 # define dsDescription_size 50
390 typedef struct dpt_sig {
391 char dsSignature[6]; /* ALWAYS "dPtSiG" */
392 sigBYTE dsSigVersion; /* signature version (currently 1) */
393 sigBYTE dsProcessorFamily; /* what type of processor */
394 sigBYTE dsProcessor; /* precise processor */
395 sigBYTE dsFiletype; /* type of file */
396 sigBYTE dsFiletypeFlags; /* flags to specify load type, etc. */
397 sigBYTE dsOEM; /* OEM file was created for */
398 sigLONG dsOS; /* which Operating systems */
399 sigWORD dsCapabilities; /* RAID levels, etc. */
400 sigWORD dsDeviceSupp; /* Types of SCSI devices supported */
401 sigWORD dsAdapterSupp; /* DPT adapter families supported */
402 sigWORD dsApplication; /* applications file is for */
403 sigBYTE dsRequirements; /* Other driver dependencies */
404 sigBYTE dsVersion; /* 1 */
405 sigBYTE dsRevision; /* 'J' */
406 sigBYTE dsSubRevision; /* '9' ' ' if N/A */
407 sigBYTE dsMonth; /* creation month */
408 sigBYTE dsDay; /* creation day */
409 sigBYTE dsYear; /* creation year since 1980 (1993=13) */
410 /* description (NULL terminated) */
411 char dsDescription[dsDescription_size];
413 /* 32 bytes minimum - with no description. Put NULL at description[0] */
414 /* 81 bytes maximum - with 49 character description plus NULL. */
418 #define PACK __attribute__ ((packed))
420 typedef struct dpt_sig_Packed {
421 char dsSignature[6] PACK; /* ALWAYS "dPtSiG" */
422 sigBYTE dsSigVersion PACK; /* signature version (currently 1) */
423 sigBYTE dsProcessorFamily PACK; /* what type of processor */
424 sigBYTE dsProcessor PACK; /* precise processor */
425 sigBYTE dsFiletype PACK; /* type of file */
426 sigBYTE dsFiletypeFlags PACK; /* flags to specify load type, etc. */
427 sigBYTE dsOEM PACK; /* OEM file was created for */
428 sigLONG dsOS PACK; /* which Operating systems */
429 sigWORD dsCapabilities PACK; /* RAID levels, etc. */
430 sigWORD dsDeviceSupp PACK; /* Types of SCSI devices supported */
431 sigWORD dsAdapterSupp PACK; /* DPT adapter families supported */
432 sigWORD dsApplication PACK; /* applications file is for */
433 sigBYTE dsRequirements PACK; /* Other driver dependencies */
434 sigBYTE dsVersion PACK; /* 1 */
435 sigBYTE dsRevision PACK; /* 'J' */
436 sigBYTE dsSubRevision PACK; /* '9' ' ' if N/A */
437 sigBYTE dsMonth PACK; /* creation month */
438 sigBYTE dsDay PACK; /* creation day */
439 sigBYTE dsYear PACK; /* creation year since 1980 (1993=13) */
440 /* description (NULL terminated) */
441 char dsDescription[dsDescription_size] PACK;
443 #define PACKED_SIG_SIZE sizeof(dpt_sig_S_Packed)
445 /* This line added at Roycroft's request */
446 /* Microsoft's NT compiler gets confused if you do a pack and don't */
450 #if defined (_DPT_AIX)
451 #pragma options align=reset
452 #elif defined (UNPACK_FOUR)
458 /* For the Macintosh */
459 #if STRUCTALIGNMENTSUPPORTED
460 #pragma options align=reset