1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3   nubus.h: various definitions and prototypes for NuBus drivers to use.
4 
5   Originally written by Alan Cox.
6 
7   Hacked to death by C. Scott Ananian and David Huggins-Daines.
8 
9   Some of the constants in here are from the corresponding
10   NetBSD/OpenBSD header file, by Allen Briggs.  We figured out the
11   rest of them on our own. */
12 
13 #ifndef _UAPILINUX_NUBUS_H
14 #define _UAPILINUX_NUBUS_H
15 
16 #include <linux/types.h>
17 
18 enum nubus_category {
19 	NUBUS_CAT_BOARD          = 0x0001,
20 	NUBUS_CAT_DISPLAY        = 0x0003,
21 	NUBUS_CAT_NETWORK        = 0x0004,
22 	NUBUS_CAT_COMMUNICATIONS = 0x0006,
23 	NUBUS_CAT_FONT           = 0x0009,
24 	NUBUS_CAT_CPU            = 0x000A,
25 	/* For lack of a better name */
26 	NUBUS_CAT_DUODOCK        = 0x0020
27 };
28 
29 enum nubus_type_network {
30 	NUBUS_TYPE_ETHERNET      = 0x0001,
31 	NUBUS_TYPE_RS232         = 0x0002
32 };
33 
34 enum nubus_type_display {
35 	NUBUS_TYPE_VIDEO         = 0x0001
36 };
37 
38 enum nubus_type_cpu {
39 	NUBUS_TYPE_68020         = 0x0003,
40 	NUBUS_TYPE_68030         = 0x0004,
41 	NUBUS_TYPE_68040         = 0x0005
42 };
43 
44 /* Known <Cat,Type,SW,HW> tuples: (according to TattleTech and Slots)
45  *  68030 motherboards: <10,4,0,24>
46  *  68040 motherboards: <10,5,0,24>
47  *  DuoDock Plus: <32,1,1,2>
48  *
49  *  Toby Frame Buffer card: <3,1,1,1>
50  *  RBV built-in video (IIci): <3,1,1,24>
51  *  Valkyrie built-in video (Q630): <3,1,1,46>
52  *  Macintosh Display Card: <3,1,1,25>
53  *  Sonora built-in video (P460): <3,1,1,34>
54  *  Jet framebuffer (DuoDock Plus): <3,1,1,41>
55  *
56  *  SONIC comm-slot/on-board and DuoDock Ethernet: <4,1,1,272>
57  *  SONIC LC-PDS Ethernet (Dayna, but like Apple 16-bit, sort of): <4,1,1,271>
58  *  Apple SONIC LC-PDS Ethernet ("Apple Ethernet LC Twisted-Pair Card"): <4,1,0,281>
59  *  Sonic Systems Ethernet A-Series Card: <4,1,268,256>
60  *  Asante MacCon NuBus-A: <4,1,260,256> (alpha-1.0,1.1 revision)
61  *   ROM on the above card: <2,1,0,0>
62  *  Cabletron ethernet card: <4,1,1,265>
63  *  Farallon ethernet card: <4,1,268,256> (identical to Sonic Systems card)
64  *  Kinetics EtherPort IIN: <4,1,259,262>
65  *  API Engineering EtherRun_LCa PDS enet card: <4,1,282,256>
66  *
67  *  Add your devices to the list!  You can obtain the "Slots" utility
68  *  from Apple's FTP site at:
69  *  ftp://dev.apple.com/devworld/Tool_Chest/Devices_-_Hardware/NuBus_Slot_Manager/
70  *
71  *  Alternately, TattleTech can be found at any Info-Mac mirror site.
72  *  or from its distribution site: ftp://ftp.decismkr.com/dms
73  */
74 
75 /* DrSW: Uniquely identifies the software interface to a board.  This
76    is usually the one you want to look at when writing a driver.  It's
77    not as useful as you think, though, because as we should know by
78    now (duh), "Apple Compatible" can mean a lot of things... */
79 
80 /* Add known DrSW values here */
81 enum nubus_drsw {
82 	/* NUBUS_CAT_DISPLAY */
83 	NUBUS_DRSW_APPLE        = 0x0001,
84 	NUBUS_DRSW_APPLE_HIRES  = 0x0013, /* MacII HiRes card driver */
85 
86 	/* NUBUS_CAT_NETWORK */
87 	NUBUS_DRSW_3COM         = 0x0000,
88 	NUBUS_DRSW_CABLETRON    = 0x0001,
89 	NUBUS_DRSW_SONIC_LC     = 0x0001,
90 	NUBUS_DRSW_KINETICS     = 0x0103,
91 	NUBUS_DRSW_ASANTE       = 0x0104,
92 	NUBUS_DRSW_TECHWORKS    = 0x0109,
93 	NUBUS_DRSW_DAYNA        = 0x010b,
94 	NUBUS_DRSW_FARALLON     = 0x010c,
95 	NUBUS_DRSW_APPLE_SN     = 0x010f,
96 	NUBUS_DRSW_DAYNA2       = 0x0115,
97 	NUBUS_DRSW_FOCUS        = 0x011a,
98 	NUBUS_DRSW_ASANTE_CS    = 0x011d, /* use asante SMC9194 driver */
99 	NUBUS_DRSW_DAYNA_LC     = 0x011e,
100 
101 	/* NUBUS_CAT_CPU */
102 	NUBUS_DRSW_NONE         = 0x0000,
103 };
104 
105 /* DrHW: Uniquely identifies the hardware interface to a board (or at
106    least, it should...  some video cards are known to incorrectly
107    identify themselves as Toby cards) */
108 
109 /* Add known DrHW values here */
110 enum nubus_drhw {
111 	/* NUBUS_CAT_DISPLAY */
112 	NUBUS_DRHW_APPLE_TFB      = 0x0001, /* Toby frame buffer card */
113 	NUBUS_DRHW_APPLE_WVC      = 0x0006, /* Apple Workstation Video Card */
114 	NUBUS_DRHW_SIGMA_CLRMAX   = 0x0007, /* Sigma Design ColorMax */
115 	NUBUS_DRHW_APPLE_SE30     = 0x0009, /* Apple SE/30 video */
116 	NUBUS_DRHW_APPLE_HRVC     = 0x0013, /* Mac II High-Res Video Card */
117 	NUBUS_DRHW_APPLE_MVC      = 0x0014, /* Mac II Monochrome Video Card */
118 	NUBUS_DRHW_APPLE_PVC      = 0x0017, /* Mac II Portrait Video Card */
119 	NUBUS_DRHW_APPLE_RBV1     = 0x0018, /* IIci RBV video */
120 	NUBUS_DRHW_APPLE_MDC      = 0x0019, /* Macintosh Display Card */
121 	NUBUS_DRHW_APPLE_VSC      = 0x0020, /* Duo MiniDock ViSC framebuffer */
122 	NUBUS_DRHW_APPLE_SONORA   = 0x0022, /* Sonora built-in video */
123 	NUBUS_DRHW_APPLE_JET      = 0x0029, /* Jet framebuffer (DuoDock) */
124 	NUBUS_DRHW_APPLE_24AC     = 0x002b, /* Mac 24AC Video Card */
125 	NUBUS_DRHW_APPLE_VALKYRIE = 0x002e,
126 	NUBUS_DRHW_SMAC_GFX       = 0x0105, /* SuperMac GFX */
127 	NUBUS_DRHW_RASTER_CB264   = 0x013B, /* RasterOps ColorBoard 264 */
128 	NUBUS_DRHW_MICRON_XCEED   = 0x0146, /* Micron Exceed color */
129 	NUBUS_DRHW_RDIUS_GSC      = 0x0153, /* Radius GS/C */
130 	NUBUS_DRHW_SMAC_SPEC8     = 0x017B, /* SuperMac Spectrum/8 */
131 	NUBUS_DRHW_SMAC_SPEC24    = 0x017C, /* SuperMac Spectrum/24 */
132 	NUBUS_DRHW_RASTER_CB364   = 0x026F, /* RasterOps ColorBoard 364 */
133 	NUBUS_DRHW_RDIUS_DCGX     = 0x027C, /* Radius DirectColor/GX */
134 	NUBUS_DRHW_RDIUS_PC8      = 0x0291, /* Radius PrecisionColor 8 */
135 	NUBUS_DRHW_LAPIS_PCS8     = 0x0292, /* Lapis ProColorServer 8 */
136 	NUBUS_DRHW_RASTER_24XLI   = 0x02A0, /* RasterOps 8/24 XLi */
137 	NUBUS_DRHW_RASTER_PBPGT   = 0x02A5, /* RasterOps PaintBoard Prism GT */
138 	NUBUS_DRHW_EMACH_FSX      = 0x02AE, /* E-Machines Futura SX */
139 	NUBUS_DRHW_RASTER_24XLTV  = 0x02B7, /* RasterOps 24XLTV */
140 	NUBUS_DRHW_SMAC_THUND24   = 0x02CB, /* SuperMac Thunder/24 */
141 	NUBUS_DRHW_SMAC_THUNDLGHT = 0x03D9, /* SuperMac ThunderLight */
142 	NUBUS_DRHW_RDIUS_PC24XP   = 0x0406, /* Radius PrecisionColor 24Xp */
143 	NUBUS_DRHW_RDIUS_PC24X    = 0x040A, /* Radius PrecisionColor 24X */
144 	NUBUS_DRHW_RDIUS_PC8XJ    = 0x040B, /* Radius PrecisionColor 8XJ */
145 
146 	/* NUBUS_CAT_NETWORK */
147 	NUBUS_DRHW_INTERLAN       = 0x0100,
148 	NUBUS_DRHW_SMC9194        = 0x0101,
149 	NUBUS_DRHW_KINETICS       = 0x0106,
150 	NUBUS_DRHW_CABLETRON      = 0x0109,
151 	NUBUS_DRHW_ASANTE_LC      = 0x010f,
152 	NUBUS_DRHW_SONIC          = 0x0110,
153 	NUBUS_DRHW_TECHWORKS      = 0x0112,
154 	NUBUS_DRHW_APPLE_SONIC_NB = 0x0118,
155 	NUBUS_DRHW_APPLE_SONIC_LC = 0x0119,
156 	NUBUS_DRHW_FOCUS          = 0x011c,
157 	NUBUS_DRHW_SONNET         = 0x011d,
158 };
159 
160 /* Resource IDs: These are the identifiers for the various weird and
161    wonderful tidbits of information that may or may not reside in the
162    NuBus ROM directory. */
163 enum nubus_res_id {
164 	NUBUS_RESID_TYPE         = 0x0001,
165 	NUBUS_RESID_NAME         = 0x0002,
166 	NUBUS_RESID_ICON         = 0x0003,
167 	NUBUS_RESID_DRVRDIR      = 0x0004,
168 	NUBUS_RESID_LOADREC      = 0x0005,
169 	NUBUS_RESID_BOOTREC      = 0x0006,
170 	NUBUS_RESID_FLAGS        = 0x0007,
171 	NUBUS_RESID_HWDEVID      = 0x0008,
172 	NUBUS_RESID_MINOR_BASEOS = 0x000a,
173 	NUBUS_RESID_MINOR_LENGTH = 0x000b,
174 	NUBUS_RESID_MAJOR_BASEOS = 0x000c,
175 	NUBUS_RESID_MAJOR_LENGTH = 0x000d,
176 	NUBUS_RESID_CICN         = 0x000f,
177 	NUBUS_RESID_ICL8         = 0x0010,
178 	NUBUS_RESID_ICL4         = 0x0011,
179 };
180 
181 /* Category-specific resources. */
182 enum nubus_board_res_id {
183 	NUBUS_RESID_BOARDID      = 0x0020,
184 	NUBUS_RESID_PRAMINITDATA = 0x0021,
185 	NUBUS_RESID_PRIMARYINIT  = 0x0022,
186 	NUBUS_RESID_TIMEOUTCONST = 0x0023,
187 	NUBUS_RESID_VENDORINFO   = 0x0024,
188 	NUBUS_RESID_BOARDFLAGS   = 0x0025,
189 	NUBUS_RESID_SECONDINIT   = 0x0026,
190 
191 	/* Not sure why Apple put these next two in here */
192 	NUBUS_RESID_VIDNAMES     = 0x0041,
193 	NUBUS_RESID_VIDMODES     = 0x007e
194 };
195 
196 /* Fields within the vendor info directory */
197 enum nubus_vendor_res_id {
198 	NUBUS_RESID_VEND_ID     = 0x0001,
199 	NUBUS_RESID_VEND_SERIAL = 0x0002,
200 	NUBUS_RESID_VEND_REV    = 0x0003,
201 	NUBUS_RESID_VEND_PART   = 0x0004,
202 	NUBUS_RESID_VEND_DATE   = 0x0005
203 };
204 
205 enum nubus_net_res_id {
206 	NUBUS_RESID_MAC_ADDRESS  = 0x0080
207 };
208 
209 enum nubus_cpu_res_id {
210 	NUBUS_RESID_MEMINFO      = 0x0081,
211 	NUBUS_RESID_ROMINFO      = 0x0082
212 };
213 
214 enum nubus_display_res_id {
215 	NUBUS_RESID_GAMMADIR    = 0x0040,
216 	NUBUS_RESID_FIRSTMODE   = 0x0080,
217 	NUBUS_RESID_SECONDMODE  = 0x0081,
218 	NUBUS_RESID_THIRDMODE   = 0x0082,
219 	NUBUS_RESID_FOURTHMODE  = 0x0083,
220 	NUBUS_RESID_FIFTHMODE   = 0x0084,
221 	NUBUS_RESID_SIXTHMODE   = 0x0085
222 };
223 
224 #endif /* _UAPILINUX_NUBUS_H */
225