xref: /netbsd-src/sys/arch/sun3/sun3x/obio.c (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: obio.c,v 1.21 2003/04/01 15:28:41 thorpej 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 <uvm/uvm_extern.h>
44 
45 #include <machine/autoconf.h>
46 #include <machine/mon.h>
47 #include <machine/pte.h>
48 
49 #include <sun3/sun3/machdep.h>
50 #include <sun3/sun3x/obio.h>
51 
52 static int  obio_match __P((struct device *, struct cfdata *, void *));
53 static void obio_attach __P((struct device *, struct device *, void *));
54 static int  obio_print __P((void *, const char *parentname));
55 static int	obio_submatch __P((struct device *, struct cfdata *, void *));
56 
57 CFATTACH_DECL(obio, sizeof(struct device),
58     obio_match, obio_attach, NULL, NULL);
59 
60 static int
61 obio_match(parent, cf, aux)
62 	struct device *parent;
63 	struct cfdata *cf;
64 	void *aux;
65 {
66 	struct confargs *ca = aux;
67 
68 	if (ca->ca_bustype != BUS_OBIO)
69 		return (0);
70 	return(1);
71 }
72 
73 /*
74  * We need control over the order of attachment on OBIO,
75  * so do "direct" style autoconfiguration with addresses
76  * from the list below.  OBIO addresses are fixed forever.
77  *
78  * Warning: This whole list is very carefully ordered!
79  * In general, anything not already shown here should
80  * be added at or near the end.
81  */
82 static int obio_alist[] = {
83 
84 	/* This is used by the Ethernet and SCSI drivers. */
85 	OBIO_IOMMU,
86 
87 	/* Misc. registers - needed by many things */
88 	OBIO_ENABLEREG,
89 	OBIO_BUSERRREG,
90 	OBIO_DIAGREG,	/* leds.c */
91 	OBIO_IDPROM1,	/* idprom.c (3/470) */
92 	OBIO_MEMREG,	/* memerr.c */
93 	OBIO_INTERREG,	/* intreg.c */
94 
95 	/* Zilog UARTs */
96 	OBIO_ZS_KBD_MS,
97 	OBIO_ZS_TTY_AB,
98 
99 	/* eeprom.c */
100 	OBIO_EEPROM,
101 
102 	/* Note: This must come after OBIO_IDPROM1. */
103 	OBIO_IDPROM2,	/* idprom.c (3/80) */
104 
105 	/* Note: Must probe for the Intersil first! */
106 	OBIO_CLOCK1,	/* clock.c (3/470) */
107 	OBIO_CLOCK2,	/* clock.c (3/80) */
108 
109 	OBIO_INTEL_ETHER,
110 	OBIO_LANCE_ETHER,
111 
112 	/* Need esp DMA before SCSI. */
113 	OBIO_EMULEX_DMA,  /* 3/80 only */
114 	OBIO_EMULEX_SCSI, /* 3/80 only */
115 
116 	/* Memory subsystem */
117 	OBIO_PCACHE_TAGS,
118 	OBIO_ECCPARREG,
119 	OBIO_IOC_TAGS,
120 	OBIO_IOC_FLUSH,
121 
122 	OBIO_FDC,	/* floppy disk (3/80) */
123 	OBIO_PRINTER_PORT, /* printer port (3/80) */
124 };
125 #define OBIO_ALIST_LEN (sizeof(obio_alist) / \
126                         sizeof(obio_alist[0]))
127 
128 static void
129 obio_attach(parent, self, aux)
130 	struct device *parent;
131 	struct device *self;
132 	void *aux;
133 {
134 	struct confargs *ca = aux;
135 	int	i;
136 
137 	printf("\n");
138 
139 	/* Configure these in the order listed above. */
140 	for (i = 0; i < OBIO_ALIST_LEN; i++) {
141 		/* Our parent set ca->ca_bustype already. */
142 		ca->ca_paddr = obio_alist[i];
143 		/* These are filled-in by obio_submatch. */
144 		ca->ca_intpri = -1;
145 		ca->ca_intvec = -1;
146 		(void) config_found_sm(self, ca, obio_print, obio_submatch);
147 	}
148 }
149 
150 /*
151  * Print out the confargs.  The (parent) name is non-NULL
152  * when there was no match found by config_found().
153  */
154 static int
155 obio_print(args, name)
156 	void *args;
157 	const char *name;
158 {
159 
160 	/* Be quiet about empty OBIO locations. */
161 	if (name)
162 		return(QUIET);
163 
164 	/* Otherwise do the usual. */
165 	return(bus_print(args, name));
166 }
167 
168 int
169 obio_submatch(parent, cf, aux)
170 	struct device *parent;
171 	struct cfdata *cf;
172 	void *aux;
173 {
174 	struct confargs *ca = aux;
175 
176 	/*
177 	 * Note that a defaulted address locator can never match
178 	 * the value of ca->ca_paddr set by the obio_attach loop.
179 	 * Without this diagnostic, any device with a defaulted
180 	 * address locator would always be silently unmatched.
181 	 * Therefore, just disallow default addresses on OBIO.
182 	 */
183 #ifdef	DIAGNOSTIC
184 	if (cf->cf_paddr == -1)
185 		panic("obio_submatch: invalid address for: %s%d",
186 			cf->cf_name, cf->cf_unit);
187 #endif
188 
189 	/*
190 	 * Note that obio_attach calls config_found_sm() with
191 	 * this function as the "submatch" and ca->ca_paddr
192 	 * set to each of the possible OBIO locations, so we
193 	 * want to reject any unmatched address here.
194 	 */
195 	if (cf->cf_paddr != ca->ca_paddr)
196 		return 0;
197 
198 	/*
199 	 * Copy the locators into our confargs for the child.
200 	 * Note: ca->ca_bustype was set by our parent driver
201 	 * (mainbus) and ca->ca_paddr was set by obio_attach.
202 	 */
203 	ca->ca_intpri = cf->cf_intpri;
204 	ca->ca_intvec = cf->cf_intvec;
205 
206 	/* Now call the match function of the potential child. */
207 	return (config_match(parent, cf, aux));
208 }
209 
210 
211 /*****************************************************************/
212 
213 /*
214  * This is our record of "interesting" OBIO mappings that
215  * the PROM has left in the virtual space reserved for it.
216  * Each row of the array holds a virtual address and the
217  * physical address it maps to (if found).
218  */
219 static struct prom_map {
220 	paddr_t pa;
221 	vaddr_t va;
222 } prom_mappings[] = {
223 	{ OBIO_ENABLEREG, 0 },	/* regs: Sys ENA, Bus ERR, etc. */
224 	{ OBIO_ZS_KBD_MS, 0 },	/* Keyboard and Mouse */
225 	{ OBIO_ZS_TTY_AB, 0 },	/* Serial Ports */
226 	{ OBIO_EEPROM,    0 },	/* EEPROM/IDPROM/clock */
227 };
228 #define PROM_MAP_CNT (sizeof(prom_mappings) / \
229 		      sizeof(prom_mappings[0]))
230 
231 /*
232  * Find a virtual address for a device at physical address 'pa'.
233  * If one is found among the mappings already made by the PROM
234  * at power-up time, use it.  Otherwise return 0 as a sign that
235  * a mapping will have to be created.
236  */
237 caddr_t
238 obio_find_mapping(paddr_t pa, psize_t sz)
239 {
240 	int i;
241 	vsize_t off;
242 
243 	off = pa & PGOFSET;
244 	pa -= off;
245 	sz += off;
246 
247 	/* The saved mappings are all one page long. */
248 	if (sz > PAGE_SIZE)
249 		return (caddr_t)0;
250 
251 	/* Linear search for it.  The list is short. */
252 	for (i = 0; i < PROM_MAP_CNT; i++) {
253 		if (pa == prom_mappings[i].pa) {
254 			return ((caddr_t)(prom_mappings[i].va + off));
255 		}
256 	}
257 	return (caddr_t)0;
258 }
259 
260 /*
261  * Search the PROM page tables for OBIO mappings that
262  * we would like to borrow.
263  */
264 static void
265 save_prom_mappings __P((void))
266 {
267 	int *mon_pte;
268 	vaddr_t va;
269 	paddr_t 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 += PAGE_SIZE, 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  */
303 static void
304 make_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  */
330 void
331 obio_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