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