?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
No empty .Rs/.Re
[netbsd-mini2440.git] / sys / arch / mac68k / nubus / nubus.h
blobced412becb3bc7b4ff2cd85c3447b9380f0a1767
1 /* $NetBSD: nubus.h,v 1.64 2007/03/07 13:54:50 tsutsui Exp $ */
2
3 /*
4 * Copyright (c) 1995 Allen Briggs. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Allen Briggs.
17 * 4. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*
33 * Nubus cards in Macintoshes are identified by 4 16-bit numbers:
34 * Category: What is the main purpose of this card?
35 * Type: Within this overall category, what kind of card?
36 * DrSW: What software interface does it use?
37 * DrHW: What specific hardware is it?
38 *
39 * For example, the "Toby Frame Buffer" display card is
40 * Category 3 (display)
41 * Type 1 (video)
42 * DrSW 1 (Apple)
43 * and DrHW 1 (TFB).
44 */
45
46 #include <machine/cpu.h>
47
48 #define NUBUS_CATEGORY_BOARD 0x0001
49 #define NUBUS_TYPE_BOARD 0x0000 /* We want these for minimal board */
50 #define NUBUS_DRSW_BOARD 0x0000 /* ROMs that come with nothing but */
51 #define NUBUS_DRHW_BOARD 0x0000 /* a board resource (old NI_GPIB) */
52
53 #define NUBUS_CATEGORY_DISPLAY 0x0003
54 #define NUBUS_TYPE_VIDEO 0x0001
55 #define NUBUS_TYPE_LCD 0x0002
56 #define NUBUS_DRSW_APPLE 0x0001
57 #define NUBUS_DRHW_TFB 0x0001 /* Apple Toby Frame Buffer */
58 #define NUBUS_DRHW_BAER 0x0002 /* Formac ProNitron 80.IVb */
59 #define NUBUS_DRHW_WVC 0x0006 /* Apple Workstation Video Card */
60 #define NUBUS_DRHW_COLORMAX 0x0007 /* Sigma Designs ColorMax */
61 #define NUBUS_DRHW_SE30 0x0009 /* Apple SE/30 pseudo-slot video */
62 #define NUBUS_DRHW_M2HRVC 0x0013 /* Apple Mac II High-Res Video Card */
63 #define NUBUS_DRHW_MVC 0x0014 /* Apple Mac II Monochrome Video Card */
64 #define NUBUS_DRHW_PVC 0x0017 /* Apple Mac II Portrait Video Card */
65 #define NUBUS_DRHW_MDC 0x0019 /* Apple Macintosh Display Card */
66 #define NUBUS_DRHW_VSC 0x0020 /* Apple Macintosh Duo MiniDock */
67 #define NUBUS_DRHW_JET 0x0029 /* Apple Macintosh DuoDock II */
68 #define NUBUS_DRHW_BOOGIE 0x002b /* Apple Macintosh 24AC Video Card */
69 #define NUBUS_DRHW_VILTRO340 0x0102 /* VillageTronic Mac Picasso 340 */
70 #define NUBUS_DRHW_SUPRGFX 0x0105 /* SuperMac GFX */
71 #define NUBUS_DRHW_RELAX200 0x0131 /* Relax 19" Model 200 */
72 #define NUBUS_DRHW_FORMAC 0x013A /* Formac color card II */
73 #define NUBUS_DRHW_CB264 0x013B /* RasterOps ColorBoard 264 */
74 #define NUBUS_DRHW_MICRON 0x0146 /* Micron Exceed color */
75 #define NUBUS_DRHW_RADGSC 0x0153 /* Radius GS/C */
76 #define NUBUS_DRHW_SPECTRM8 0x017b /* SuperMac Spectrum/8 Series III */
77 #define NUBUS_DRHW_SPECTRUM 0x017c /* SuperMac Spectrum/24 Series III */
78 #define NUBUS_DRHW_VIMAGE 0x026E /* Interware Co., Ltd. Vimage */
79 #define NUBUS_DRHW_CB364 0x026F /* RasterOps ColorBoard 364 */
80 #define NUBUS_DRHW_LVIEW 0x0278 /* Sigma Designs L-View */
81 #define NUBUS_DRHW_RDCGX 0x027C /* Radius DirectColor/GX */
82 #define NUBUS_DRHW_RPC8 0x0291 /* Radius PrecisionColor 8 */
83 #define NUBUS_DRHW_LAPIS 0x0292 /* SE/30 Lapis ProColorServer 8 PDS */
84 #define NUBUS_DRHW_ROPS24LXI 0x02A0 /* RasterOps 8/24 XLi */
85 #define NUBUS_DRHW_ROPSPPGT 0x02A5 /* RasterOps PaintBoard Prism GT 1.0 */
86 #define NUBUS_DRHW_FUTURASX 0x02AE /* E-Machines Futura-SX */
87 #define NUBUS_DRHW_ROPS24XLTV 0x02B7 /* RasterOps 24XlTV */
88 #define NUBUS_DRHW_THUNDER24 0x02CB /* SuperMac Thunder/24 */
89 #define NUBUS_DRHW_ROPS24MXTV 0x03DF /* RasterOps 24MxTV */
90 #define NUBUS_DRHW_GVIMAGE 0x03FB /* Interware Co., Ltd. Grand Vimage */
91 #define NUBUS_DRHW_RPC24XP 0x0406 /* Radius PrecisionColor 24Xp */
92 #define NUBUS_DRHW_RPC24X 0x040A /* Radius PrecisionColor 24X */
93 #define NUBUS_DRHW_RPC8XJ 0x040B /* Radius PrecisionColor 8xj */
94 #define NUBUS_DRHW_FIILX 0x0417 /* Futura II LX */
95 #define NUBUS_DRHW_FIISXDSP 0x042F /* Futura II SX/DSP */
96 #define NUBUS_DRHW_MC2124NB 0x0462 /* MicroConversions 2124NB II */
97
98 /* False DrHW values for video cards masquerading as other cards */
99 #define NUBUS_DRHW_SAM768 0x10000 /* Cornerstone/Samsung 768x1006 */
100
101 #define NUBUS_CATEGORY_NETWORK 0x0004
102 #define NUBUS_TYPE_ETHERNET 0x0001
103 #define NUBUS_DRSW_3COM 0x0000
104 #define NUBUS_DRSW_CABLETRON 0x0001
105 #define NUBUS_DRSW_GATOR 0x0103
106 #define NUBUS_DRSW_ASANTE 0x0104
107 #define NUBUS_DRSW_TECHWORKS 0x0109
108 #define NUBUS_DRSW_DAYNA 0x010B
109 #define NUBUS_DRSW_FARALLON 0x010C
110 #define NUBUS_DRSW_DAYNA2 0x0115
111 #define NUBUS_DRSW_FOCUS 0x011A
112 #define NUBUS_DRSW_ASANTEF 0x011D
113 #define NUBUS_DRSW_TFLLAN 0x011E
114 #define NUBUS_DRHW_INTERLAN 0x0100
115 #define NUBUS_DRHW_ASANTEF 0x0101
116 #define NUBUS_DRHW_KINETICS 0x0106
117 #define NUBUS_DRHW_CABLETRON 0x0109
118 #define NUBUS_DRHW_NUVOLINK 0x010B
119 #define NUBUS_DRHW_ASANTE_LC 0x010F
120 #define NUBUS_DRHW_SONIC 0x0110
121 #define NUBUS_DRHW_TECHWORKS 0x0112
122 #define NUBUS_DRHW_APPLE_SNT 0x0118
123 #define NUBUS_DRHW_APPLE_SN 0x0119
124
125 #define NUBUS_CATEGORY_COMMUNICATIONS 0x0006
126 #define NUBUS_TYPE_RS232 0x0002
127 #define NUBUS_TYPE_IEEE488 0x0004
128 #define NUBUS_TYPE_CENTRONICS 0x000B
129 #define NUBUS_TYPE_BECTDIC 0x002E
130 #define NUBUS_DRSW_BECTDIC 0x0100
131 #define NUBUS_DRSW_CPI 0x0100
132 #define NUBUS_DRSW_HDS 0x0102
133 #define NUBUS_DRSW_NI488 0x0104
134 #define NUBUS_DRHW_BECTDIC 0x0100 /* Becton Dickinson Acquisition Card */
135 #define NUBUS_DRHW_CPI 0x0100 /* Creative Solutions parallel */
136 #define NUBUS_DRHW_HDS 0x0102 /* Creative Solutions 2x serial */
137 #define NUBUS_DRHW_NBGPIBTNT 0x0102 /* National Instruments NB-GPIB/TNT */
138
139 #define NUBUS_CATEGORY_MEMORY 0x0009 /* Also KanjiTalk Font Card? */
140 #define NUBUS_TYPE_RAMCACHE 0x010C /* From Apple PDS card */
141 #define NUBUS_DRSW_AWGSPDS 0x0100
142 #define NUBUS_DRHW_AWGSPDS 0x0100
143
144 #define NUBUS_CATEGORY_CPU 0x000A
145 #define NUBUS_TYPE_68000 0x0002
146 #define NUBUS_TYPE_68020 0x0003
147 #define NUBUS_TYPE_68030 0x0004
148 #define NUBUS_TYPE_68040 0x0005
149 #define NUBUS_TYPE_MX 0x0009 /* TI microExplorer */
150
151 #define NUBUS_CATEGORY_INTBUS 0x000C
152 #define NUBUS_TYPE_SCSI 0x0008
153 #define NUBUS_DRSW_AWGSPDS_SCSI 0x0006
154 #define NUBUS_DRHW_AWGSPDS_SCSI 0x0100
155 #define NUBUS_DRSW_PLI 0x0108
156 #define NUBUS_DRHW_PLI 0x0100
157 #define NUBUS_TYPE_SCSIW 0x000B /* FWB JackHammer Fast/Wide */
158 #define NUBUS_DRSW_FWB 0x0001
159 #define NUBUS_DRHW_FWB 0x0100
160 #define NUBUS_TYPE_SCSIAW 0x0106 /* Atto SiliconExpress IV f/w */
161 #define NUBUS_DRSW_ATTOSE 0x0101
162 #define NUBUS_DRHW_ATTOSE 0x0100
163
164 #define NUBUS_CATEGORY_DOCK 0x0020
165 #define NUBUS_TYPE_STATION 0x0001
166 #define NUBUS_TYPE_DESK 0x0002
167 #define NUBUS_TYPE_TRAVEL 0x0003
168 /* #define NUBUS_DRSW_APPLE 0x0001 */
169 #define NUBUS_DRSW_NEWERTECH 0x0101
170
171 /* Station */
172 #define NUBUS_DRHW_DUODOCK 0x0001 /* Apple DuoDock */
173 #define NUBUS_DRHW_DUODOCKII 0x0002 /* Apple DuoDock II */
174
175 /* Desk */
176 #define NUBUS_DRHW_DUOMINIDOCK 0x0001 /* Apple Duo MiniDock */
177
178 /* Travel */
179 #define NUBUS_DRHW_MICROSCSI 0x0100 /* Newer Technology SCSI MicroDock */
180
181
182 /*
183 * This is the same as Apple's Format Block for a card, with the
184 * addition of a pointer to the base of the NuBUS slot.
185 *
186 * This basically describes a nubus card--this structure is held in the last
187 * N bytes of each valid card's declaration ROM.
188 */
189 typedef struct _nubus_slot {
190 u_long top;
191 u_int8_t slot;
192 u_int8_t bytelanes;
193 u_int8_t step;
194 u_int32_t test_pattern;
195 u_int8_t format;
196 u_int8_t revision_level;
197 u_int32_t crc;
198 u_int32_t length;
199 u_int32_t directory_offset;
200 } nubus_slot;
201
202 /*
203 * Just a structure to ease comparison of type for drivers, etc.
204 */
205 typedef struct _nubus_type {
206 u_int16_t category;
207 u_int16_t type;
208 u_int16_t drsw;
209 u_int16_t drhw;
210 } nubus_type;
211
212 /*
213 * nubus_dir is a structure that describes a nubus directory.
214 * The nubus*dir() functions should be used to traverse this.
215 */
216 typedef struct _nubus_dir {
217 u_int32_t dirbase;
218 u_int32_t curr_ent;
219 } nubus_dir;
220
221 /*
222 * This is the equivalent of an Apple sResource directory entry
223 * with the addition of a pointer to itself (essentially) for easy
224 * calculation of jump to indirect data.
225 */
226 typedef struct _nubus_dirent {
227 u_int32_t myloc;
228 u_int8_t rsrc_id;
229 u_int32_t offset;
230 } nubus_dirent;
231
232 /*
233 * This is the equivalent of an Apple sResource with the addition of
234 * a pointer back to the sResource directory from whence we came.
235 *
236 * According to the Apple documentation, each sResource is of one of the
237 * following forms:
238 * all: bits 31-24 Identification number
239 *
240 * offset: bits 23-0 Offset to long data, cString, sBlock, etc.
241 * word: bits 23-16 0x00
242 * bits 15-0 word data
243 * byte: bits 23-8 0x0000
244 * bits 7-0 byte data
245 *
246 * The last resource has id = 0xff and data = 0x000000.
247 */
248 typedef struct _nubus_rsrc {
249 u_int32_t myloc;
250 u_int8_t id;
251 u_int32_t data;
252 } nubus_rsrc;
253
254 /*
255 * On a NuBus master, an sMemory resource (this is a second-level
256 * resource list) holds a list of address ranges for onboard
257 * RAM, ROM and IO resources.
258 */
259 typedef struct _nubus_smem_range {
260 u_int32_t length;
261 u_int32_t offset;
262 } nubus_smem_range;
263
264 /*
265 * XXX This is mapped on the range list we get back out of the sMemory
266 * resources. I would have liked the range[] array to be of undefined
267 * size but the compiler does not let me.
268 * Maybe it's just too much grief, and we should work with an array
269 * of u_int32_t.
270 */
271 typedef struct _nubus_smem_rangelist {
272 u_int32_t length;
273 nubus_smem_range range[1];
274 } nubus_smem_rangelist;
275
276
277 /* Resource IDs for NUBUS_CATEGORY_* (All) */
278 #define NUBUS_RSRC_TYPE 0x01 /* Type (required) */
279 #define NUBUS_RSRC_NAME 0x02 /* Name (required) */
280 #define NUBUS_RSRC_ICON 0x03 /* Icon */
281 #define NUBUS_RSRC_DRVRDIR 0x04 /* Driver directory */
282 #define NUBUS_RSRC_LOADREC 0x05 /* Load record for resource */
283 #define NUBUS_RSRC_BOOTREC 0x06 /* Boot record */
284 #define NUBUS_RSRC_FLAGS 0x07 /* sResource Flags */
285 #define NUBUS_RSRC_HWDEVID 0x08 /* Hardware device ID */
286 #define NUBUS_RSRC_MINOR_BASEOS 0x0A /* Offset to hw in std space */
287 #define NUBUS_RSRC_MINOR_LENGTH 0x0B /* Length of std space */
288 #define NUBUS_RSRC_MAJOR_BASEOS 0x0C /* Offset to hw in super space */
289 #define NUBUS_RSRC_MAJOR_LENGTH 0x0D /* Length of super space */
290 #define NUBUS_RSRC_CICN 0x0F /* Color icon */
291 #define NUBUS_RSRC_ICL8 0x10 /* 8-bit icon data */
292 #define NUBUS_RSRC_ICL4 0x11 /* 4-bit icon data */
293 #define NUBUS_RSRC_SMEMORY 0x6C /* Resource list for master */
294
295 /* Resource IDs for NUBUS_CATEGORY_DISPLAY */
296 #define NUBUS_RSRC_GAMMADIR 0x40 /* ID for gamma directory */
297 #define NUBUS_RSRC_VIDNAMES 0x41 /* ID for video name directory */
298 #define NUBUS_RSRC_FIRSTMODE 0x80 /* ID for first mode (1-bit) */
299 #define NUBUS_RSRC_SECONDMODE 0x81 /* ID for 2nd mode (2-bit) */
300 #define NUBUS_RSRC_THIRDMODE 0x82 /* ID for 3rd mode (4-bit) */
301 #define NUBUS_RSRC_FOURTHMODE 0x83 /* ID for 4th mode (8-bit) */
302 #define NUBUS_RSRC_FIFTHMODE 0x84 /* ID for 5th mode (16-bit) */
303 #define NUBUS_RSRC_SIXTHMODE 0x85 /* ID for 6th mode (32-bit) */
304
305 /* Resource IDs for NUBUS_CATEGORY_BOARD */
306 #define NUBUS_RSRC_BOARDID 0x20 /* Board ID */
307 #define NUBUS_RSRC_PRAMINITDATA 0x21 /* Private board data for PRAM */
308 #define NUBUS_RSRC_PRIMARYINIT 0x22 /* Primary init record */
309 #define NUBUS_RSRC_TIMEOUTCONST 0x23 /* Timeout constant */
310 #define NUBUS_RSRC_VENDORINFO 0x24 /* Vendor info list */
311 #define NUBUS_RSRC_BOARDFLAGS 0x25 /* Board flags */
312 #define NUBUS_RSRC_SECONDINIT 0x26 /* Secondary init record */
313
314 #define NUBUS_RSRC_VEND_ID 0x01 /* Card vendor's design ID */
315 #define NUBUS_RSRC_VEND_SERIAL 0x02 /* Card's serial number */
316 #define NUBUS_RSRC_VEND_REV 0x03 /* Card design's revision level */
317 #define NUBUS_RSRC_VEND_PART 0x04 /* Card part number */
318 #define NUBUS_RSRC_VEND_DATE 0x05 /* Card revision date */
319
320 /* Resource IDs for NUBUS_RSRC_SMEMORY master sMemory resource list */
321 #define NUBUS_RSRC_SMEM_MINOR_RAMADDR 0x80 /* Minor RAM address ranges */
322 #define NUBUS_RSRC_SMEM_MAJOR_RAMADDR 0x81 /* Major RAM address ranges */
323 #define NUBUS_RSRC_SMEM_MINOR_ROMADDR 0x82 /* Minor ROM address ranges */
324 #define NUBUS_RSRC_SMEM_MAJOR_ROMADDR 0x83 /* Major ROM address ranges */
325 #define NUBUS_RSRC_SMEM_MINOR_DEVADDR 0x84 /* Minor device address ranges */
326 #define NUBUS_RSRC_SMEM_MAJOR_DEVADDR 0x85 /* Major device address ranges */
327
328
329 typedef struct _NUBUS_DRIVER {
330 u_int8_t drvr_id;
331 u_int32_t offset;
332 } NUBUS_DRIVER;
333
334 typedef struct _NUBUS_BLOCK {
335 u_int32_t size; /* Size of block of data */
336 void * data; /* Pointer to data */
337 } NUBUS_BLOCK;
338
339 typedef struct _NUBUS_EXEC_BLOCK {
340 u_int32_t size; /* Size of total block - 4 */
341 u_int8_t revision; /* Always 0x2 */
342 u_int8_t cpu; /* Which processor? */
343 u_int32_t code_offset; /* Offset base to start of code */
344 void * code; /* pointer to base of code. */
345 } NUBUS_EXEC_BLOCK;
346
347 #define NUBUS_EXEC_CPU_68000 1
348 #define NUBUS_EXEC_CPU_68020 2
349 #define NUBUS_EXEC_CPU_68030 3
350 #define NUBUS_EXEC_CPU_68040 4
351
352 #define NUBUS_MIN_SLOT 0x9
353 #define NUBUS_MAX_SLOT 0xE
354 #define NUBUS_ROM_TEST_PATTERN 0x5A932BC7
355
356 #define NUBUS_SLOT2PA(x) (0xf9000000 + \
357 ((((x) - NUBUS_MIN_SLOT) & 0xf) << 24))
358
359 struct nubus_attach_args {
360 bus_space_tag_t na_tag;
361 bus_dma_tag_t na_dmat;
362 int slot;
363 int rsrcid;
364 u_int16_t category;
365 u_int16_t type;
366 u_int16_t drsw;
367 u_int16_t drhw;
368 nubus_slot *fmt;
369 };
370
371 struct nubus_softc {
372 struct device sc_dev;
373 };
374
375
376 void nubus_get_main_dir(nubus_slot *, nubus_dir *);
377 void nubus_get_dir_from_rsrc(nubus_slot *, nubus_dirent *, nubus_dir *);
378
379 int nubus_find_rsrc(bus_space_tag_t, bus_space_handle_t, nubus_slot *,
380 nubus_dir *, u_int8_t, nubus_dirent *);
381 int nubus_get_ind_data(bus_space_tag_t, bus_space_handle_t, nubus_slot *,
382 nubus_dirent *, char *, int);
383 int nubus_get_c_string(bus_space_tag_t, bus_space_handle_t, nubus_slot *,
384 nubus_dirent *, char *, int);
385 int nubus_get_smem_addr_rangelist(bus_space_tag_t, bus_space_handle_t,
386 nubus_slot *, nubus_dirent *, void *);
387
388 const char *nubus_get_vendor(bus_space_tag_t, bus_space_handle_t, nubus_slot *,
389 int);
390 const char *nubus_get_card_name(bus_space_tag_t, bus_space_handle_t, nubus_slot *);
391 #ifdef DEBUG
392 void nubus_scan_slot(bus_space_tag_t, int);
393 #endif
NetBSD on the FriendlyARM MINI2440