1 /*
2 nubus.h: various definitions and prototypes for NuBus drivers to use.
3
4 Originally written by Alan Cox.
5
6 Hacked to death by C. Scott Ananian and David Huggins-Daines.
7
8 Some of the constants in here are from the corresponding
9 NetBSD/OpenBSD header file, by Allen Briggs. We figured out the
10 rest of them on our own. */
11
12 #ifndef LINUX_NUBUS_H
13 #define LINUX_NUBUS_H
14
15
16 enum nubus_category {
17 NUBUS_CAT_BOARD = 0x0001,
18 NUBUS_CAT_DISPLAY = 0x0003,
19 NUBUS_CAT_NETWORK = 0x0004,
20 NUBUS_CAT_COMMUNICATIONS = 0x0006,
21 NUBUS_CAT_FONT = 0x0009,
22 NUBUS_CAT_CPU = 0x000A,
23 /* For lack of a better name */
24 NUBUS_CAT_DUODOCK = 0x0020
25 };
26
27 enum nubus_type_network {
28 NUBUS_TYPE_ETHERNET = 0x0001,
29 NUBUS_TYPE_RS232 = 0x0002
30 };
31
32 enum nubus_type_display {
33 NUBUS_TYPE_VIDEO = 0x0001
34 };
35
36 enum nubus_type_cpu {
37 NUBUS_TYPE_68020 = 0x0003,
38 NUBUS_TYPE_68030 = 0x0004,
39 NUBUS_TYPE_68040 = 0x0005
40 };
41
42 /* Known <Cat,Type,SW,HW> tuples: (according to TattleTech and Slots)
43 * 68030 motherboards: <10,4,0,24>
44 * 68040 motherboards: <10,5,0,24>
45 * DuoDock Plus: <32,1,1,2>
46 *
47 * Toby Frame Buffer card: <3,1,1,1>
48 * RBV built-in video (IIci): <3,1,1,24>
49 * Valkyrie built-in video (Q630): <3,1,1,46>
50 * Macintosh Display Card: <3,1,1,25>
51 * Sonora built-in video (P460): <3,1,1,34>
52 * Jet framebuffer (DuoDock Plus): <3,1,1,41>
53 *
54 * SONIC comm-slot/on-board and DuoDock Ethernet: <4,1,1,272>
55 * SONIC LC-PDS Ethernet (Dayna, but like Apple 16-bit, sort of): <4,1,1,271>
56 * Apple SONIC LC-PDS Ethernet ("Apple Ethernet LC Twisted-Pair Card"): <4,1,0,281>
57 * Sonic Systems Ethernet A-Series Card: <4,1,268,256>
58 * Asante MacCon NuBus-A: <4,1,260,256> (alpha-1.0,1.1 revision)
59 * ROM on the above card: <2,1,0,0>
60 * Cabletron ethernet card: <4,1,1,265>
61 * Farallon ethernet card: <4,1,268,256> (identical to Sonic Systems card)
62 * Kinetics EtherPort IIN: <4,1,259,262>
63 * API Engineering EtherRun_LCa PDS enet card: <4,1,282,256>
64 *
65 * Add your devices to the list! You can obtain the "Slots" utility
66 * from Apple's FTP site at:
67 * ftp://dev.apple.com/devworld/Tool_Chest/Devices_-_Hardware/NuBus_Slot_Manager/
68 *
69 * Alternately, TattleTech can be found at any Info-Mac mirror site.
70 * or from its distribution site: ftp://ftp.decismkr.com/dms
71 */
72
73 /* DrSW: Uniquely identifies the software interface to a board. This
74 is usually the one you want to look at when writing a driver. It's
75 not as useful as you think, though, because as we should know by
76 now (duh), "Apple Compatible" can mean a lot of things... */
77
78 /* Add known DrSW values here */
79 enum nubus_drsw {
80 /* NUBUS_CAT_DISPLAY */
81 NUBUS_DRSW_APPLE = 0x0001,
82 NUBUS_DRSW_APPLE_HIRES = 0x0013, /* MacII HiRes card driver */
83
84 /* NUBUS_CAT_NETWORK */
85 NUBUS_DRSW_3COM = 0x0000,
86 NUBUS_DRSW_CABLETRON = 0x0001,
87 NUBUS_DRSW_SONIC_LC = 0x0001,
88 NUBUS_DRSW_KINETICS = 0x0103,
89 NUBUS_DRSW_ASANTE = 0x0104,
90 NUBUS_DRSW_TECHWORKS = 0x0109,
91 NUBUS_DRSW_DAYNA = 0x010b,
92 NUBUS_DRSW_FARALLON = 0x010c,
93 NUBUS_DRSW_APPLE_SN = 0x010f,
94 NUBUS_DRSW_DAYNA2 = 0x0115,
95 NUBUS_DRSW_FOCUS = 0x011a,
96 NUBUS_DRSW_ASANTE_CS = 0x011d, /* use asante SMC9194 driver */
97 NUBUS_DRSW_DAYNA_LC = 0x011e,
98
99 /* NUBUS_CAT_CPU */
100 NUBUS_DRSW_NONE = 0x0000,
101 };
102
103 /* DrHW: Uniquely identifies the hardware interface to a board (or at
104 least, it should... some video cards are known to incorrectly
105 identify themselves as Toby cards) */
106
107 /* Add known DrHW values here */
108 enum nubus_drhw {
109 /* NUBUS_CAT_DISPLAY */
110 NUBUS_DRHW_APPLE_TFB = 0x0001, /* Toby frame buffer card */
111 NUBUS_DRHW_APPLE_WVC = 0x0006, /* Apple Workstation Video Card */
112 NUBUS_DRHW_SIGMA_CLRMAX = 0x0007, /* Sigma Design ColorMax */
113 NUBUS_DRHW_APPLE_SE30 = 0x0009, /* Apple SE/30 video */
114 NUBUS_DRHW_APPLE_HRVC = 0x0013, /* Mac II High-Res Video Card */
115 NUBUS_DRHW_APPLE_PVC = 0x0017, /* Mac II Portrait Video Card */
116 NUBUS_DRHW_APPLE_RBV1 = 0x0018, /* IIci RBV video */
117 NUBUS_DRHW_APPLE_MDC = 0x0019, /* Macintosh Display Card */
118 NUBUS_DRHW_APPLE_SONORA = 0x0022, /* Sonora built-in video */
119 NUBUS_DRHW_APPLE_24AC = 0x002b, /* Mac 24AC Video Card */
120 NUBUS_DRHW_APPLE_VALKYRIE = 0x002e,
121 NUBUS_DRHW_APPLE_JET = 0x0029, /* Jet framebuffer (DuoDock) */
122 NUBUS_DRHW_SMAC_GFX = 0x0105, /* SuperMac GFX */
123 NUBUS_DRHW_RASTER_CB264 = 0x013B, /* RasterOps ColorBoard 264 */
124 NUBUS_DRHW_MICRON_XCEED = 0x0146, /* Micron Exceed color */
125 NUBUS_DRHW_RDIUS_GSC = 0x0153, /* Radius GS/C */
126 NUBUS_DRHW_SMAC_SPEC8 = 0x017B, /* SuperMac Spectrum/8 */
127 NUBUS_DRHW_SMAC_SPEC24 = 0x017C, /* SuperMac Spectrum/24 */
128 NUBUS_DRHW_RASTER_CB364 = 0x026F, /* RasterOps ColorBoard 364 */
129 NUBUS_DRHW_RDIUS_DCGX = 0x027C, /* Radius DirectColor/GX */
130 NUBUS_DRHW_RDIUS_PC8 = 0x0291, /* Radius PrecisionColor 8 */
131 NUBUS_DRHW_LAPIS_PCS8 = 0x0292, /* Lapis ProColorServer 8 */
132 NUBUS_DRHW_RASTER_24XLI = 0x02A0, /* RasterOps 8/24 XLi */
133 NUBUS_DRHW_RASTER_PBPGT = 0x02A5, /* RasterOps PaintBoard Prism GT */
134 NUBUS_DRHW_EMACH_FSX = 0x02AE, /* E-Machines Futura SX */
135 NUBUS_DRHW_RASTER_24XLTV = 0x02B7, /* RasterOps 24XLTV */
136 NUBUS_DRHW_SMAC_THUND24 = 0x02CB, /* SuperMac Thunder/24 */
137 NUBUS_DRHW_SMAC_THUNDLGHT = 0x03D9, /* SuperMac ThunderLight */
138 NUBUS_DRHW_RDIUS_PC24XP = 0x0406, /* Radius PrecisionColor 24Xp */
139 NUBUS_DRHW_RDIUS_PC24X = 0x040A, /* Radius PrecisionColor 24X */
140 NUBUS_DRHW_RDIUS_PC8XJ = 0x040B, /* Radius PrecisionColor 8XJ */
141
142 /* NUBUS_CAT_NETWORK */
143 NUBUS_DRHW_INTERLAN = 0x0100,
144 NUBUS_DRHW_SMC9194 = 0x0101,
145 NUBUS_DRHW_KINETICS = 0x0106,
146 NUBUS_DRHW_CABLETRON = 0x0109,
147 NUBUS_DRHW_ASANTE_LC = 0x010f,
148 NUBUS_DRHW_SONIC = 0x0110,
149 NUBUS_DRHW_TECHWORKS = 0x0112,
150 NUBUS_DRHW_APPLE_SONIC_NB = 0x0118,
151 NUBUS_DRHW_APPLE_SONIC_LC = 0x0119,
152 NUBUS_DRHW_FOCUS = 0x011c,
153 NUBUS_DRHW_SONNET = 0x011d,
154 };
155
156 /* Resource IDs: These are the identifiers for the various weird and
157 wonderful tidbits of information that may or may not reside in the
158 NuBus ROM directory. */
159 enum nubus_res_id {
160 NUBUS_RESID_TYPE = 0x0001,
161 NUBUS_RESID_NAME = 0x0002,
162 NUBUS_RESID_ICON = 0x0003,
163 NUBUS_RESID_DRVRDIR = 0x0004,
164 NUBUS_RESID_LOADREC = 0x0005,
165 NUBUS_RESID_BOOTREC = 0x0006,
166 NUBUS_RESID_FLAGS = 0x0007,
167 NUBUS_RESID_HWDEVID = 0x0008,
168 NUBUS_RESID_MINOR_BASEOS = 0x000a,
169 NUBUS_RESID_MINOR_LENGTH = 0x000b,
170 NUBUS_RESID_MAJOR_BASEOS = 0x000c,
171 NUBUS_RESID_MAJOR_LENGTH = 0x000d,
172 NUBUS_RESID_CICN = 0x000f,
173 NUBUS_RESID_ICL8 = 0x0010,
174 NUBUS_RESID_ICL4 = 0x0011,
175 };
176
177 /* Category-specific resources. */
178 enum nubus_board_res_id {
179 NUBUS_RESID_BOARDID = 0x0020,
180 NUBUS_RESID_PRAMINITDATA = 0x0021,
181 NUBUS_RESID_PRIMARYINIT = 0x0022,
182 NUBUS_RESID_TIMEOUTCONST = 0x0023,
183 NUBUS_RESID_VENDORINFO = 0x0024,
184 NUBUS_RESID_BOARDFLAGS = 0x0025,
185 NUBUS_RESID_SECONDINIT = 0x0026,
186
187 /* Not sure why Apple put these next two in here */
188 NUBUS_RESID_VIDNAMES = 0x0041,
189 NUBUS_RESID_VIDMODES = 0x007e
190 };
191
192 /* Fields within the vendor info directory */
193 enum nubus_vendor_res_id {
194 NUBUS_RESID_VEND_ID = 0x0001,
195 NUBUS_RESID_VEND_SERIAL = 0x0002,
196 NUBUS_RESID_VEND_REV = 0x0003,
197 NUBUS_RESID_VEND_PART = 0x0004,
198 NUBUS_RESID_VEND_DATE = 0x0005
199 };
200
201 enum nubus_net_res_id {
202 NUBUS_RESID_MAC_ADDRESS = 0x0080
203 };
204
205 enum nubus_cpu_res_id {
206 NUBUS_RESID_MEMINFO = 0x0081,
207 NUBUS_RESID_ROMINFO = 0x0082
208 };
209
210 enum nubus_display_res_id {
211 NUBUS_RESID_GAMMADIR = 0x0040,
212 NUBUS_RESID_FIRSTMODE = 0x0080,
213 NUBUS_RESID_SECONDMODE = 0x0081,
214 NUBUS_RESID_THIRDMODE = 0x0082,
215 NUBUS_RESID_FOURTHMODE = 0x0083,
216 NUBUS_RESID_FIFTHMODE = 0x0084,
217 NUBUS_RESID_SIXTHMODE = 0x0085
218 };
219
220 struct nubus_dir
221 {
222 unsigned char *base;
223 unsigned char *ptr;
224 int done;
225 int mask;
226 };
227
228 struct nubus_dirent
229 {
230 unsigned char *base;
231 unsigned char type;
232 __u32 data; /* Actually 24bits used */
233 int mask;
234 };
235
236 struct nubus_board {
237 struct nubus_board* next;
238 struct nubus_dev* first_dev;
239
240 /* Only 9-E actually exist, though 0-8 are also theoretically
241 possible, and 0 is a special case which represents the
242 motherboard and onboard peripherals (Ethernet, video) */
243 int slot;
244 /* For slot 0, this is bogus. */
245 char name[64];
246
247 /* Format block */
248 unsigned char* fblock;
249 /* Root directory (does *not* always equal fblock + doffset!) */
250 unsigned char* directory;
251
252 unsigned long slot_addr;
253 /* Offset to root directory (sometimes) */
254 unsigned long doffset;
255 /* Length over which to compute the crc */
256 unsigned long rom_length;
257 /* Completely useless most of the time */
258 unsigned long crc;
259 unsigned char rev;
260 unsigned char format;
261 unsigned char lanes;
262 };
263
264 struct nubus_dev {
265 /* Next link in device list */
266 struct nubus_dev* next;
267 /* Directory entry in /proc/bus/nubus */
268 struct proc_dir_entry* procdir;
269
270 /* The functional resource ID of this device */
271 unsigned char resid;
272 /* These are mostly here for convenience; we could always read
273 them from the ROMs if we wanted to */
274 unsigned short category;
275 unsigned short type;
276 unsigned short dr_sw;
277 unsigned short dr_hw;
278 /* This is the device's name rather than the board's.
279 Sometimes they are different. Usually the board name is
280 more correct. */
281 char name[64];
282 /* MacOS driver (I kid you not) */
283 unsigned char* driver;
284 /* Actually this is an offset */
285 unsigned long iobase;
286 unsigned long iosize;
287 unsigned char flags, hwdevid;
288
289 /* Functional directory */
290 unsigned char* directory;
291 /* Much of our info comes from here */
292 struct nubus_board* board;
293 };
294
295 /* This is all NuBus devices (used to find devices later on) */
296 extern struct nubus_dev* nubus_devices;
297 /* This is all NuBus cards */
298 extern struct nubus_board* nubus_boards;
299
300 /* Generic NuBus interface functions, modelled after the PCI interface */
301 void nubus_scan_bus(void);
302 extern void nubus_proc_init(void);
303 int get_nubus_list(char *buf);
304 int nubus_proc_attach_device(struct nubus_dev *dev);
305 int nubus_proc_detach_device(struct nubus_dev *dev);
306 /* If we need more precision we can add some more of these */
307 struct nubus_dev* nubus_find_device(unsigned short category,
308 unsigned short type,
309 unsigned short dr_hw,
310 unsigned short dr_sw,
311 const struct nubus_dev* from);
312 struct nubus_dev* nubus_find_type(unsigned short category,
313 unsigned short type,
314 const struct nubus_dev* from);
315 /* Might have more than one device in a slot, you know... */
316 struct nubus_dev* nubus_find_slot(unsigned int slot,
317 const struct nubus_dev* from);
318
319 /* These are somewhat more NuBus-specific. They all return 0 for
320 success and -1 for failure, as you'd expect. */
321
322 /* The root directory which contains the board and functional
323 directories */
324 int nubus_get_root_dir(const struct nubus_board* board,
325 struct nubus_dir* dir);
326 /* The board directory */
327 int nubus_get_board_dir(const struct nubus_board* board,
328 struct nubus_dir* dir);
329 /* The functional directory */
330 int nubus_get_func_dir(const struct nubus_dev* dev,
331 struct nubus_dir* dir);
332
333 /* These work on any directory gotten via the above */
334 int nubus_readdir(struct nubus_dir* dir,
335 struct nubus_dirent* ent);
336 int nubus_find_rsrc(struct nubus_dir* dir,
337 unsigned char rsrc_type,
338 struct nubus_dirent* ent);
339 int nubus_rewinddir(struct nubus_dir* dir);
340
341 /* Things to do with directory entries */
342 int nubus_get_subdir(const struct nubus_dirent* ent,
343 struct nubus_dir* dir);
344 void nubus_get_rsrc_mem(void* dest,
345 const struct nubus_dirent *dirent,
346 int len);
347 void nubus_get_rsrc_str(void* dest,
348 const struct nubus_dirent *dirent,
349 int maxlen);
350
351 /* We'd like to get rid of this eventually. Only daynaport.c uses it now. */
nubus_slot_addr(int slot)352 static __inline__ void *nubus_slot_addr(int slot)
353 {
354 return (void *)(0xF0000000|(slot<<24));
355 }
356
357 #endif /* LINUX_NUBUS_H */
358