1 /*	BSDI dptsig.h,v 1.7 1998/06/03 19:15:00 karels Exp	*/
2 
3 /*
4  * Copyright (c) 1996-1999 Distributed Processing Technology Corporation
5  * All rights reserved.
6  *
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.
10  *
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.
22  *
23  */
24 
25 #ifndef __DPTSIG_H_
26 #define __DPTSIG_H_
27 #ifdef _SINIX_ADDON
28 #include "dpt.h"
29 #endif
30 /* DPT SIGNATURE SPEC AND HEADER FILE                           */
31 /* Signature Version 1 (sorry no 'A')                           */
32 
33 /* to make sure we are talking the same size under all OS's     */
34 typedef unsigned char sigBYTE;
35 typedef unsigned short sigWORD;
36 typedef unsigned int sigINT;
37 
38 /*
39  * use sigWORDLittleEndian for:
40  *  dsCapabilities
41  *  dsDeviceSupp
42  *  dsAdapterSupp
43  *  dsApplication
44  * use sigLONGLittleEndian for:
45  *      dsOS
46  * so that the sig can be standardised to Little Endian
47  */
48 #if (defined(_DPT_BIG_ENDIAN))
49 # define sigWORDLittleEndian(x) ((((x)&0xFF)<<8)|(((x)>>8)&0xFF))
50 # define sigLONGLittleEndian(x) \
51         ((((x)&0xFF)<<24) |             \
52          (((x)&0xFF00)<<8) |    \
53          (((x)&0xFF0000L)>>8) | \
54          (((x)&0xFF000000L)>>24))
55 #else
56 # define sigWORDLittleEndian(x) (x)
57 # define sigLONGLittleEndian(x) (x)
58 #endif
59 
60 /* must make sure the structure is not word or double-word aligned      */
61 /* ---------------------------------------------------------------      */
62 /* Borland will ignore the following pragma:                            */
63 /* Word alignment is OFF by default.  If in the, IDE make               */
64 /* sure that Options | Compiler | Code Generation | Word Alignment      */
65 /* is not checked.  If using BCC, do not use the -a option.             */
66 
67 #ifndef NO_PACK
68 #if defined (_DPT_AIX)
69 #pragma options align=packed
70 #else
71 #pragma pack(1)
72 #endif  /* aix */
73 #endif
74 /* For the Macintosh */
75 #ifdef STRUCTALIGNMENTSUPPORTED
76 #pragma options align=mac68k
77 #endif
78 
79 
80 /* Current Signature Version - sigBYTE dsSigVersion; */
81 /* ------------------------------------------------------------------ */
82 #define SIG_VERSION 1
83 
84 /* Processor Family - sigBYTE dsProcessorFamily;  DISTINCT VALUES */
85 /* ------------------------------------------------------------------ */
86 /* What type of processor the file is meant to run on. */
87 /* This will let us know whether to read sigWORDs as high/low or low/high. */
88 #define PROC_INTEL      0x00    /* Intel 80x86/ia64 */
89 #define PROC_MOTOROLA   0x01    /* Motorola 68K */
90 #define PROC_MIPS4000   0x02    /* MIPS RISC 4000 */
91 #define PROC_ALPHA      0x03    /* DEC Alpha */
92 #define PROC_POWERPC    0x04    /* IBM Power PC */
93 #define PROC_i960       0x05    /* Intel i960 */
94 #define PROC_ULTRASPARC 0x06    /* SPARC processor */
95 
96 /* Specific Minimim Processor - sigBYTE dsProcessor;    FLAG BITS */
97 /* ------------------------------------------------------------------ */
98 /* Different bit definitions dependent on processor_family */
99 
100 /* PROC_INTEL: */
101 #define PROC_8086       0x01    /* Intel 8086 */
102 #define PROC_286        0x02    /* Intel 80286 */
103 #define PROC_386        0x04    /* Intel 80386 */
104 #define PROC_486        0x08    /* Intel 80486 */
105 #define PROC_PENTIUM    0x10    /* Intel 586 aka P5 aka Pentium */
106 #define PROC_SEXIUM	0x20	/* Intel 686 aka P6 aka Pentium Pro or MMX */
107 #define PROC_IA64	0x40	/* Intel IA64 processor */
108 
109 /* PROC_i960: */
110 #define PROC_960RX      0x01    /* Intel 80960RC/RD */
111 #define PROC_960HX      0x02    /* Intel 80960HA/HD/HT */
112 
113 /* PROC_MOTOROLA: */
114 #define PROC_68000      0x01    /* Motorola 68000 */
115 #define PROC_68010	0x02	/* Motorola 68010 */
116 #define PROC_68020      0x04    /* Motorola 68020 */
117 #define PROC_68030      0x08    /* Motorola 68030 */
118 #define PROC_68040      0x10    /* Motorola 68040 */
119 
120 /* PROC_POWERPC */
121 #define PROC_PPC601		0x01	/* PowerPC 601 */
122 #define PROC_PPC603		0x02	/* PowerPC 603 */
123 #define PROC_PPC604		0x04	/* PowerPC 604 */
124 
125 /* PROC_MIPS4000: */
126 #define PROC_R4000      0x01    /* MIPS R4000 */
127 
128 /* Filetype - sigBYTE dsFiletype;       DISTINCT VALUES */
129 /* ------------------------------------------------------------------ */
130 #define FT_EXECUTABLE   0       /* Executable Program */
131 #define FT_SCRIPT       1       /* Script/Batch File??? */
132 #define FT_HBADRVR      2       /* HBA Driver */
133 #define FT_OTHERDRVR    3       /* Other Driver */
134 #define FT_IFS          4       /* Installable Filesystem Driver */
135 #define FT_ENGINE       5       /* DPT Engine */
136 #define FT_COMPDRVR     6       /* Compressed Driver Disk */
137 #define FT_LANGUAGE     7       /* Foreign Language file */
138 #define FT_FIRMWARE     8       /* Downloadable or actual Firmware */
139 #define FT_COMMMODL     9       /* Communications Module */
140 #define FT_INT13        10      /* INT 13 style HBA Driver */
141 #define FT_HELPFILE     11      /* Help file */
142 #define FT_LOGGER       12      /* Event Logger */
143 #define FT_INSTALL      13      /* An Install Program */
144 #define FT_LIBRARY      14      /* Storage Manager Real-Mode Calls */
145 #define FT_RESOURCE	15	/* Storage Manager Resource File */
146 #define FT_MODEM_DB	16	/* Storage Manager Modem Database */
147 
148 /* Filetype flags - sigBYTE dsFiletypeFlags;    FLAG BITS */
149 /* ------------------------------------------------------------------ */
150 #define FTF_DLL         0x01    /* Dynamic Link Library */
151 #define FTF_NLM         0x02    /* Netware Loadable Module */
152 #define FTF_OVERLAYS    0x04    /* Uses overlays */
153 #define FTF_DEBUG       0x08    /* Debug version */
154 #define FTF_TSR         0x10    /* TSR */
155 #define FTF_SYS         0x20    /* DOS Loadable driver */
156 #define FTF_PROTECTED   0x40    /* Runs in protected mode */
157 #define FTF_APP_SPEC    0x80    /* Application Specific */
158 #define FTF_ROM		(FTF_SYS|FTF_TSR)	/* Special Case */
159 
160 /* OEM - sigBYTE dsOEM;         DISTINCT VALUES */
161 /* ------------------------------------------------------------------ */
162 #define OEM_DPT         0       /* DPT */
163 #define OEM_ATT         1       /* ATT */
164 #define OEM_NEC         2       /* NEC */
165 #define OEM_ALPHA       3       /* Alphatronix */
166 #define OEM_AST         4       /* AST */
167 #define OEM_OLIVETTI    5       /* Olivetti */
168 #define OEM_SNI         6       /* Siemens/Nixdorf */
169 #define OEM_SUN         7       /* SUN Microsystems */
170 
171 /* Operating System  - sigLONG dsOS;    FLAG BITS */
172 /* ------------------------------------------------------------------ */
173 #define OS_DOS          0x00000001 /* PC/MS-DOS				*/
174 #define OS_WINDOWS      0x00000002 /* Microsoft Windows 3.x		*/
175 #define OS_WINDOWS_NT   0x00000004 /* Microsoft Windows NT		*/
176 #define OS_OS2M         0x00000008 /* OS/2 1.2.x,MS 1.3.0,IBM 1.3.x - Monolithic */
177 #define OS_OS2L         0x00000010 /* Microsoft OS/2 1.301 - LADDR	*/
178 #define OS_OS22x        0x00000020 /* IBM OS/2 2.x			*/
179 #define OS_NW286        0x00000040 /* Novell NetWare 286		*/
180 #define OS_NW386        0x00000080 /* Novell NetWare 386		*/
181 #define OS_GEN_UNIX     0x00000100 /* Generic Unix			*/
182 #define OS_SCO_UNIX     0x00000200 /* SCO Unix				*/
183 #define OS_ATT_UNIX     0x00000400 /* ATT Unix				*/
184 #define OS_UNIXWARE     0x00000800 /* USL Unix				*/
185 #define OS_INT_UNIX     0x00001000 /* Interactive Unix			*/
186 #define OS_SOLARIS      0x00002000 /* SunSoft Solaris			*/
187 #define OS_QNX          0x00004000 /* QNX for Tom Moch			*/
188 #define OS_NEXTSTEP     0x00008000 /* NeXTSTEP/OPENSTEP/MACH		*/
189 #define OS_BANYAN       0x00010000 /* Banyan Vines			*/
190 #define OS_OLIVETTI_UNIX 0x00020000/* Olivetti Unix			*/
191 #define OS_MAC_OS	0x00040000 /* Mac OS				*/
192 #define OS_WINDOWS_95	0x00080000 /* Microsoft Windows '95		*/
193 #define OS_NW4x		0x00100000 /* Novell Netware 4.x		*/
194 #define OS_BSDI_UNIX	0x00200000 /* BSDi Unix BSD/OS 2.0 and up	*/
195 #define OS_AIX_UNIX     0x00400000 /* AIX Unix				*/
196 #define OS_FREE_BSD	0x00800000 /* FreeBSD Unix			*/
197 #define OS_LINUX	0x01000000 /* Linux				*/
198 #define OS_DGUX_UNIX	0x02000000 /* Data General Unix			*/
199 #define OS_SINIX_N      0x04000000 /* SNI SINIX-N			*/
200 #define OS_PLAN9	0x08000000 /* ATT Plan 9			*/
201 #define OS_TSX		0x10000000 /* SNH TSX-32			*/
202 
203 #define OS_OTHER        0x80000000 /* Other				*/
204 
205 /* Capabilities - sigWORD dsCapabilities;        FLAG BITS */
206 /* ------------------------------------------------------------------ */
207 #define CAP_RAID0       0x0001  /* RAID-0 */
208 #define CAP_RAID1       0x0002  /* RAID-1 */
209 #define CAP_RAID3       0x0004  /* RAID-3 */
210 #define CAP_RAID5       0x0008  /* RAID-5 */
211 #define CAP_SPAN        0x0010  /* Spanning */
212 #define CAP_PASS        0x0020  /* Provides passthrough */
213 #define CAP_OVERLAP     0x0040  /* Passthrough supports overlapped commands */
214 #define CAP_ASPI        0x0080  /* Supports ASPI Command Requests */
215 #define CAP_ABOVE16MB   0x0100  /* ISA Driver supports greater than 16MB */
216 #define CAP_EXTEND      0x8000  /* Extended info appears after description */
217 #ifdef SNI_MIPS
218 #define CAP_CACHEMODE   0x1000  /* dpt_force_cache is set in driver */
219 #endif
220 
221 /* Devices Supported - sigWORD dsDeviceSupp;    FLAG BITS */
222 /* ------------------------------------------------------------------ */
223 #define DEV_DASD        0x0001  /* DASD (hard drives) */
224 #define DEV_TAPE        0x0002  /* Tape drives */
225 #define DEV_PRINTER     0x0004  /* Printers */
226 #define DEV_PROC        0x0008  /* Processors */
227 #define DEV_WORM        0x0010  /* WORM drives */
228 #define DEV_CDROM       0x0020  /* CD-ROM drives */
229 #define DEV_SCANNER     0x0040  /* Scanners */
230 #define DEV_OPTICAL     0x0080  /* Optical Drives */
231 #define DEV_JUKEBOX     0x0100  /* Jukebox */
232 #define DEV_COMM        0x0200  /* Communications Devices */
233 #define DEV_OTHER       0x0400  /* Other Devices */
234 #define DEV_ALL         0xFFFF  /* All SCSI Devices */
235 
236 /* Adapters Families Supported - sigWORD dsAdapterSupp; FLAG BITS */
237 /* ------------------------------------------------------------------ */
238 #define ADF_2001        0x0001  /* PM2001           */
239 #define ADF_2012A       0x0002  /* PM2012A          */
240 #define ADF_PLUS_ISA    0x0004  /* PM2011,PM2021    */
241 #define ADF_PLUS_EISA   0x0008  /* PM2012B,PM2022   */
242 #define ADF_SC3_ISA	0x0010  /* PM2021           */
243 #define ADF_SC3_EISA	0x0020  /* PM2022,PM2122, etc */
244 #define ADF_SC3_PCI	0x0040  /* SmartCache III PCI */
245 #define ADF_SC4_ISA	0x0080  /* SmartCache IV ISA */
246 #define ADF_SC4_EISA	0x0100  /* SmartCache IV EISA */
247 #define ADF_SC4_PCI	0x0200	/* SmartCache IV PCI */
248 #define ADF_SC5_PCI	0x0400	/* Fifth Generation I2O products */
249 /*
250  *	Combinations of products
251  */
252 #define ADF_ALL_2000	(ADF_2001|ADF_2012A)
253 #define ADF_ALL_PLUS	(ADF_PLUS_ISA|ADF_PLUS_EISA)
254 #define ADF_ALL_SC3	(ADF_SC3_ISA|ADF_SC3_EISA|ADF_SC3_PCI)
255 #define ADF_ALL_SC4	(ADF_SC4_ISA|ADF_SC4_EISA|ADF_SC4_PCI)
256 #define ADF_ALL_SC5	(ADF_SC5_PCI)
257 /* All EATA Cacheing Products */
258 #define ADF_ALL_CACHE	(ADF_ALL_PLUS|ADF_ALL_SC3|ADF_ALL_SC4)
259 /* All EATA Bus Mastering Products */
260 #define ADF_ALL_MASTER	(ADF_2012A|ADF_ALL_CACHE)
261 /* All EATA Adapter Products */
262 #define ADF_ALL_EATA	(ADF_2001|ADF_ALL_MASTER)
263 #define ADF_ALL		ADF_ALL_EATA
264 
265 /* Application - sigWORD dsApplication;         FLAG BITS */
266 /* ------------------------------------------------------------------ */
267 #define APP_DPTMGR      0x0001  /* DPT Storage Manager */
268 #define APP_ENGINE      0x0002  /* DPT Engine */
269 #define APP_SYTOS       0x0004  /* Sytron Sytos Plus */
270 #define APP_CHEYENNE    0x0008  /* Cheyenne ARCServe + ARCSolo */
271 #define APP_MSCDEX      0x0010  /* Microsoft CD-ROM extensions */
272 #define APP_NOVABACK    0x0020  /* NovaStor Novaback */
273 #define APP_AIM         0x0040  /* Archive Information Manager */
274 
275 /* Requirements - sigBYTE dsRequirements;         FLAG BITS             */
276 /* ------------------------------------------------------------------   */
277 #define REQ_SMARTROM    0x01    /* Requires SmartROM to be present      */
278 #define REQ_DPTDDL      0x02    /* Requires DPTDDL.SYS to be loaded     */
279 #define REQ_HBA_DRIVER  0x04    /* Requires an HBA driver to be loaded  */
280 #define REQ_ASPI_TRAN   0x08    /* Requires an ASPI Transport Modules   */
281 #define REQ_ENGINE      0x10    /* Requires a DPT Engine to be loaded   */
282 #define REQ_COMM_ENG    0x20    /* Requires a DPT Communications Engine */
283 
284 /*
285  * You may adjust dsDescription_size with an override to a value less than
286  * 50 so that the structure allocates less real space.
287  */
288 #if (!defined(dsDescription_size))
289 # define dsDescription_size 50
290 #endif
291 
292 typedef struct dpt_sig {
293     char    dsSignature[6];      /* ALWAYS "dPtSiG" */
294     sigBYTE dsSigVersion;        /* signature version (currently 1) */
295     sigBYTE dsProcessorFamily;   /* what type of processor */
296     sigBYTE dsProcessor;         /* precise processor */
297     sigBYTE dsFiletype;          /* type of file */
298     sigBYTE dsFiletypeFlags;     /* flags to specify load type, etc. */
299     sigBYTE dsOEM;               /* OEM file was created for */
300     sigINT  dsOS;                /* which Operating systems */
301     sigWORD dsCapabilities;      /* RAID levels, etc. */
302     sigWORD dsDeviceSupp;        /* Types of SCSI devices supported */
303     sigWORD dsAdapterSupp;       /* DPT adapter families supported */
304     sigWORD dsApplication;       /* applications file is for */
305     sigBYTE dsRequirements;      /* Other driver dependencies */
306     sigBYTE dsVersion;           /* 1 */
307     sigBYTE dsRevision;          /* 'J' */
308     sigBYTE dsSubRevision;       /* '9'   ' ' if N/A */
309     sigBYTE dsMonth;             /* creation month */
310     sigBYTE dsDay;               /* creation day */
311     sigBYTE dsYear;              /* creation year since 1980 (1993=13) */
312     /* description (NULL terminated) */
313     char  dsDescription[dsDescription_size];
314 } dpt_sig_S;
315 /* 32 bytes minimum - with no description.  Put NULL at description[0] */
316 /* 81 bytes maximum - with 49 character description plus NULL. */
317 
318 /* This line added at Roycroft's request */
319 /* Microsoft's NT compiler gets confused if you do a pack and don't */
320 /* restore it. */
321 
322 #ifndef NO_UNPACK
323 #if defined (_DPT_AIX)
324 #pragma options align=reset
325 #elif defined (UNPACK_FOUR)
326 #pragma pack(4)
327 #else
328 #pragma pack()
329 #endif  /* aix */
330 #endif
331 /* For the Macintosh */
332 #ifdef STRUCTALIGNMENTSUPPORTED
333 #pragma options align=reset
334 #endif
335 
336 #endif
337