obio.c revision 1.10
1/*	$NetBSD: obio.c,v 1.10 1998/02/08 05:07:07 gwr Exp $	*/
2
3/*-
4 * Copyright (c) 1996 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Adam Glass and Gordon W. Ross.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *        This product includes software developed by the NetBSD
21 *        Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 *    contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39#include <sys/param.h>
40#include <sys/systm.h>
41#include <sys/device.h>
42
43#include <machine/autoconf.h>
44#include <machine/mon.h>
45#include <machine/pte.h>
46
47#include <sun3/sun3/machdep.h>
48#include <sun3/sun3x/obio.h>
49
50static int  obio_match __P((struct device *, struct cfdata *, void *));
51static void obio_attach __P((struct device *, struct device *, void *));
52static int  obio_print __P((void *, const char *parentname));
53static int	obio_submatch __P((struct device *, struct cfdata *, void *));
54
55struct cfattach obio_ca = {
56	sizeof(struct device), obio_match, obio_attach
57};
58
59static int
60obio_match(parent, cf, aux)
61	struct device *parent;
62	struct cfdata *cf;
63	void *aux;
64{
65	struct confargs *ca = aux;
66
67	if (ca->ca_bustype != BUS_OBIO)
68		return (0);
69	return(1);
70}
71
72/*
73 * We need control over the order of attachment on OBIO,
74 * so do "direct" style autoconfiguration with addresses
75 * from the list below.  OBIO addresses are fixed forever.
76 *
77 * Warning: This whole list is very carefully ordered!
78 * In general, anything not already shown here should
79 * be added at or near the end.
80 */
81static int obio_alist[] = {
82
83	/* This is used by the Ethernet and SCSI drivers. */
84	OBIO_IOMMU,
85
86	/* Misc. registers - needed by many things */
87	OBIO_ENABLEREG,
88	OBIO_BUSERRREG,
89	OBIO_DIAGREG,	/* leds.c */
90	OBIO_IDPROM1,	/* idprom.c (3/470) */
91	OBIO_MEMREG,	/* memerr.c */
92	OBIO_INTERREG,	/* intreg.c */
93
94	/* Zilog UARTs */
95	OBIO_ZS_KBD_MS,
96	OBIO_ZS_TTY_AB,
97
98	/* eeprom.c */
99	OBIO_EEPROM,
100
101	/* Note: This must come after OBIO_IDPROM1. */
102	OBIO_IDPROM2,	/* idprom.c (3/80) */
103
104	/* Note: Must probe for the Intersil first! */
105	OBIO_CLOCK1,	/* clock.c (3/470) */
106	OBIO_CLOCK2,	/* clock.c (3/80) */
107
108	OBIO_INTEL_ETHER,
109	OBIO_LANCE_ETHER,
110
111	OBIO_EMULEX_SCSI, /* 3/80 only */
112
113	/* Memory subsystem */
114	OBIO_PCACHE_TAGS,
115	OBIO_ECCPARREG,
116	OBIO_IOC_TAGS,
117	OBIO_IOC_FLUSH,
118
119	OBIO_FDC,	/* floppy disk (3/80) */
120	OBIO_PRINTER_PORT, /* printer port (3/80 */
121};
122#define OBIO_ALIST_LEN (sizeof(obio_alist) / \
123                        sizeof(obio_alist[0]))
124
125static void
126obio_attach(parent, self, aux)
127	struct device *parent;
128	struct device *self;
129	void *aux;
130{
131	struct confargs *ca = aux;
132	int	i;
133
134	printf("\n");
135
136	/* Configure these in the order listed above. */
137	for (i = 0; i < OBIO_ALIST_LEN; i++) {
138		/* Our parent set ca->ca_bustype already. */
139		ca->ca_paddr = obio_alist[i];
140		/* These are filled-in by obio_submatch. */
141		ca->ca_intpri = -1;
142		ca->ca_intvec = -1;
143		(void) config_found_sm(self, ca, obio_print, obio_submatch);
144	}
145}
146
147/*
148 * Print out the confargs.  The (parent) name is non-NULL
149 * when there was no match found by config_found().
150 */
151static int
152obio_print(args, name)
153	void *args;
154	const char *name;
155{
156
157	/* Be quiet about empty OBIO locations. */
158	if (name)
159		return(QUIET);
160
161	/* Otherwise do the usual. */
162	return(bus_print(args, name));
163}
164
165int
166obio_submatch(parent, cf, aux)
167	struct device *parent;
168	struct cfdata *cf;
169	void *aux;
170{
171	struct confargs *ca = aux;
172	cfmatch_t submatch;
173
174	/*
175	 * Note that a defaulted address locator can never match
176	 * the value of ca->ca_paddr set by the obio_attach loop.
177	 * Without this diagnostic, any device with a defaulted
178	 * address locator would always be silently unmatched.
179	 * Therefore, just disallow default addresses on OBIO.
180	 */
181#ifdef	DIAGNOSTIC
182	if (cf->cf_paddr == -1)
183		panic("obio_submatch: invalid address for: %s%d\n",
184			cf->cf_driver->cd_name, cf->cf_unit);
185#endif
186
187	/*
188	 * Note that obio_attach calls config_found_sm() with
189	 * this function as the "submatch" and ca->ca_paddr
190	 * set to each of the possible OBIO locations, so we
191	 * want to reject any unmatched address here.
192	 */
193	if (cf->cf_paddr != ca->ca_paddr)
194		return 0;
195
196	/*
197	 * Copy the locators into our confargs for the child.
198	 * Note: ca->ca_bustype was set by our parent driver
199	 * (mainbus) and ca->ca_paddr was set by obio_attach.
200	 */
201	ca->ca_intpri = cf->cf_intpri;
202	ca->ca_intvec = cf->cf_intvec;
203
204	/* Now call the match function of the potential child. */
205	submatch = cf->cf_attach->ca_match;
206	if (submatch == NULL)
207		panic("obio_submatch: no match function for: %s\n",
208			  cf->cf_driver->cd_name);
209
210	return ((*submatch)(parent, cf, aux));
211}
212
213
214/*****************************************************************/
215
216/*
217 * This is our record of "interesting" OBIO mappings that
218 * the PROM has left in the virtual space reserved for it.
219 * Each row of the array holds a virtual address and the
220 * physical address it maps to (if found).
221 */
222static struct prom_map {
223	vm_offset_t pa, va;
224} prom_mappings[] = {
225	{ OBIO_ENABLEREG, 0 },	/* regs: Sys ENA, Bus ERR, etc. */
226	{ OBIO_ZS_KBD_MS, 0 },	/* Keyboard and Mouse */
227	{ OBIO_ZS_TTY_AB, 0 },	/* Serial Ports */
228	{ OBIO_EEPROM,    0 },	/* EEPROM/IDPROM/clock */
229};
230#define PROM_MAP_CNT (sizeof(prom_mappings) / \
231		      sizeof(prom_mappings[0]))
232
233/*
234 * Find a virtual address for a device at physical address 'pa'.
235 * If one is found among the mappings already made by the PROM
236 * at power-up time, use it.  Otherwise return 0 as a sign that
237 * a mapping will have to be created.
238 */
239caddr_t
240obio_find_mapping(int pa, int sz)
241{
242	int i, off;
243
244	off = pa & PGOFSET;
245	pa -= off;
246	sz += off;
247
248	/* The saved mappings are all one page long. */
249	if (sz > NBPG)
250		return (caddr_t)0;
251
252	/* Linear search for it.  The list is short. */
253	for (i = 0; i < PROM_MAP_CNT; i++) {
254		if (pa == prom_mappings[i].pa) {
255			return ((caddr_t)(prom_mappings[i].va + off));
256		}
257	}
258	return (caddr_t)0;
259}
260
261/*
262 * Search the PROM page tables for OBIO mappings that
263 * we would like to borrow.
264 */
265static void
266save_prom_mappings __P((void))
267{
268	int *mon_pte;
269	vm_offset_t va, pa;
270	int i;
271
272	/* Note: mon_ctbl[0] maps SUN3X_MON_KDB_BASE */
273	mon_pte = *romVectorPtr->monptaddr;
274
275	for (va = SUN3X_MON_KDB_BASE; va < SUN3X_MONEND;
276		 va += NBPG, mon_pte++)
277	{
278		/* Is this a valid mapping to OBIO? */
279		/* XXX - Some macros would be nice... */
280		if ((*mon_pte & 0xF0000003) != 0x60000001)
281			continue;
282
283		/* Yes it is.  Is this a mapping we want? */
284		pa = *mon_pte & MMU_SHORT_PTE_BASEADDR;
285		for (i = 0; i < PROM_MAP_CNT; i++) {
286			if (pa != prom_mappings[i].pa)
287				continue;
288			/* Yes, we want it.  Save the va? */
289			if (prom_mappings[i].va == 0) {
290				prom_mappings[i].va = va;
291			}
292		}
293	}
294
295}
296
297/*
298 * These are all the OBIO address that are required early in
299 * the life of the kernel.  All are less than one page long.
300 * This function should make any required mappings that we
301 * were not able to find among the PROM monitor's mappings.
302 */
303static void
304make_required_mappings __P((void))
305{
306	int i;
307
308	for (i = 0; i < PROM_MAP_CNT; i++) {
309		if (prom_mappings[i].va == 0) {
310			/*
311			 * Actually, the PROM always has all the
312			 * "required" mappings we need, (smile)
313			 * but this makes sure that is true.
314			 */
315			mon_printf("obio: no mapping for pa=0x%x\n",
316			    prom_mappings[i].pa);
317			sunmon_abort();  /* Ancient PROM? */
318		}
319	}
320}
321
322
323/*
324 * Find mappings for devices that are needed before autoconfiguration.
325 * We first look for and record any useful PROM mappings, then call
326 * the "init" functions for drivers that we need to use before the
327 * normal autoconfiguration calls configure().  Warning: this is
328 * called before pmap_bootstrap, so no allocation allowed!
329 */
330void
331obio_init()
332{
333	save_prom_mappings();
334	make_required_mappings();
335
336	enable_init();
337
338	/*
339	 * Find the interrupt reg mapping and turn off the
340	 * interrupts, otherwise the PROM clock interrupt
341	 * would poll the zs and toggle some LEDs...
342	 */
343	intreg_init();
344}
345