xref: /netbsd/sys/dev/qbus/uba.c (revision 6550d01e)
1 /*	$NetBSD: uba.c,v 1.79 2010/11/13 13:52:10 uebayasi Exp $	   */
2 /*
3  * Copyright (c) 1982, 1986 The Regents of the University of California.
4  * 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. Neither the name of the University nor the names of its contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  *	@(#)uba.c	7.10 (Berkeley) 12/16/90
31  *	@(#)autoconf.c	7.20 (Berkeley) 5/9/91
32  */
33 
34 /*
35  * Copyright (c) 1996 Jonathan Stone.
36  * Copyright (c) 1994, 1996 Ludd, University of Lule}, Sweden.
37  * All rights reserved.
38  *
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  * 1. Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  * 2. Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in the
46  *    documentation and/or other materials provided with the distribution.
47  * 3. All advertising materials mentioning features or use of this software
48  *    must display the following acknowledgement:
49  *	This product includes software developed by the University of
50  *	California, Berkeley and its contributors.
51  * 4. Neither the name of the University nor the names of its contributors
52  *    may be used to endorse or promote products derived from this software
53  *    without specific prior written permission.
54  *
55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65  * SUCH DAMAGE.
66  *
67  *	@(#)uba.c	7.10 (Berkeley) 12/16/90
68  *	@(#)autoconf.c	7.20 (Berkeley) 5/9/91
69  */
70 
71 #include <sys/cdefs.h>
72 __KERNEL_RCSID(0, "$NetBSD: uba.c,v 1.79 2010/11/13 13:52:10 uebayasi Exp $");
73 
74 #include <sys/param.h>
75 #include <sys/time.h>
76 #include <sys/systm.h>
77 #include <sys/buf.h>
78 #include <sys/proc.h>
79 #include <sys/conf.h>
80 #include <sys/kernel.h>
81 #include <sys/malloc.h>
82 #include <sys/device.h>
83 
84 #include <sys/bus.h>
85 #include <machine/scb.h>
86 #include <sys/cpu.h>
87 
88 #include <dev/qbus/ubareg.h>
89 #include <dev/qbus/ubavar.h>
90 
91 #include "ioconf.h"
92 #include "locators.h"
93 
94 static int ubasearch (device_t, cfdata_t,
95 		      const int *, void *);
96 static int ubaprint (void *, const char *);
97 
98 /*
99  * If we failed to allocate uba resources, put us on a queue to wait
100  * until there is available resources. Resources to compete about
101  * are map registers and BDPs. This is normally only a problem on
102  * Unibus systems, Qbus systems have more map registers than usable.
103  */
104 void
105 uba_enqueue(struct uba_unit *uu)
106 {
107 	struct uba_softc *uh;
108 	int s;
109 
110 	uh = device_private(device_parent(uu->uu_dev));
111 
112 	s = spluba();
113 	SIMPLEQ_INSERT_TAIL(&uh->uh_resq, uu, uu_resq);
114 	splx(s);
115 }
116 
117 /*
118  * When a routine that uses resources is finished, the next device
119  * in queue for map registers etc is called. If it succeeds to get
120  * resources, call next, and next, and next...
121  * This routine must be called at spluba.
122  */
123 void
124 uba_done(struct uba_softc *uh)
125 {
126 	struct uba_unit *uu;
127 
128 	while ((uu = SIMPLEQ_FIRST(&uh->uh_resq))) {
129 		SIMPLEQ_REMOVE_HEAD(&uh->uh_resq, uu_resq);
130 		if ((*uu->uu_ready)(uu) == 0) {
131 			SIMPLEQ_INSERT_HEAD(&uh->uh_resq, uu, uu_resq);
132 			break;
133 		}
134 	}
135 }
136 
137 /*
138  * Each device that needs some handling if an ubareset occurs must
139  * register for reset first through this routine.
140  */
141 void
142 uba_reset_establish(void (*reset)(device_t), device_t dev)
143 {
144 	struct uba_softc *uh = device_private(device_parent(dev));
145 	struct uba_reset *ur;
146 
147 	ur = malloc(sizeof(struct uba_reset), M_DEVBUF, M_NOWAIT|M_ZERO);
148 	if (ur == NULL)
149 		panic("uba_reset_establish");
150 	ur->ur_dev = dev;
151 	ur->ur_reset = reset;
152 
153 	SIMPLEQ_INSERT_TAIL(&uh->uh_resetq, ur, ur_resetq);
154 }
155 
156 /*
157  * Allocate a bunch of map registers and map them to the given address.
158  */
159 int
160 uballoc(struct uba_softc *uh, struct ubinfo *ui, int flags)
161 {
162 	int waitok = (flags & UBA_CANTWAIT) == 0;
163 	int error;
164 
165 	if ((error = bus_dmamap_create(uh->uh_dmat, ui->ui_size, 1,
166 	    ui->ui_size, 0, (waitok ? BUS_DMA_WAITOK : BUS_DMA_NOWAIT),
167 	    &ui->ui_dmam)))
168 		return error;
169 
170 	if ((error = bus_dmamap_load(uh->uh_dmat, ui->ui_dmam, ui->ui_vaddr,
171 	    ui->ui_size, NULL, (waitok ? BUS_DMA_WAITOK : BUS_DMA_NOWAIT)))) {
172 		bus_dmamap_destroy(uh->uh_dmat, ui->ui_dmam);
173 		return error;
174 	}
175 	ui->ui_baddr = ui->ui_dmam->dm_segs[0].ds_addr;
176 	return 0;
177 }
178 
179 /*
180  * Allocate DMA-able memory and map it on the unibus.
181  */
182 int
183 ubmemalloc(struct uba_softc *uh, struct ubinfo *ui, int flags)
184 {
185 	int waitok = (flags & UBA_CANTWAIT ? BUS_DMA_NOWAIT : BUS_DMA_WAITOK);
186 	int error;
187 
188 	if ((error = bus_dmamem_alloc(uh->uh_dmat, ui->ui_size, PAGE_SIZE, 0,
189 	    &ui->ui_seg, 1, &ui->ui_rseg, waitok)))
190 		return error;
191 	if ((error = bus_dmamem_map(uh->uh_dmat, &ui->ui_seg, ui->ui_rseg,
192 	    ui->ui_size, &ui->ui_vaddr, waitok|BUS_DMA_COHERENT))) {
193 		bus_dmamem_free(uh->uh_dmat, &ui->ui_seg, ui->ui_rseg);
194 		return error;
195 	}
196 	if ((error = uballoc(uh, ui, flags))) {
197 		bus_dmamem_unmap(uh->uh_dmat, ui->ui_vaddr, ui->ui_size);
198 		bus_dmamem_free(uh->uh_dmat, &ui->ui_seg, ui->ui_rseg);
199 	}
200 	return error;
201 }
202 
203 void
204 ubfree(struct uba_softc *uh, struct ubinfo *ui)
205 {
206 	bus_dmamap_unload(uh->uh_dmat, ui->ui_dmam);
207 	bus_dmamap_destroy(uh->uh_dmat, ui->ui_dmam);
208 }
209 
210 void
211 ubmemfree(struct uba_softc *uh, struct ubinfo *ui)
212 {
213 	bus_dmamem_unmap(uh->uh_dmat, ui->ui_vaddr, ui->ui_size);
214 	bus_dmamem_free(uh->uh_dmat, &ui->ui_seg, ui->ui_rseg);
215 	ubfree(uh, ui);
216 }
217 
218 /*
219  * Generate a reset on uba number uban.	 Then
220  * call each device that asked to be called during attach,
221  * giving it a chance to clean up so as to be able to continue.
222  */
223 void
224 ubareset(struct uba_softc *uh)
225 {
226 	struct uba_reset *ur;
227 	int s;
228 
229 	s = spluba();
230 	SIMPLEQ_INIT(&uh->uh_resq);
231 	printf("%s: reset", device_xname(uh->uh_dev));
232 	(*uh->uh_ubainit)(uh);
233 
234 	ur = SIMPLEQ_FIRST(&uh->uh_resetq);
235 	if (ur) do {
236 		printf(" %s", device_xname(ur->ur_dev));
237 		(*ur->ur_reset)(ur->ur_dev);
238 	} while ((ur = SIMPLEQ_NEXT(ur, ur_resetq)));
239 
240 	printf("\n");
241 	splx(s);
242 }
243 
244 /*
245  * The common attach routine:
246  *   Calls the scan routine to search for uba devices.
247  */
248 void
249 uba_attach(struct uba_softc *sc, paddr_t iopagephys)
250 {
251 
252 	/*
253 	 * Set last free interrupt vector for devices with
254 	 * programmable interrupt vectors.  Use is to decrement
255 	 * this number and use result as interrupt vector.
256 	 */
257 	sc->uh_lastiv = 0x200;
258 	SIMPLEQ_INIT(&sc->uh_resq);
259 	SIMPLEQ_INIT(&sc->uh_resetq);
260 
261 	/*
262 	 * Allocate place for unibus I/O space in virtual space.
263 	 */
264 	if (bus_space_map(sc->uh_iot, iopagephys, UBAIOSIZE, 0, &sc->uh_ioh))
265 		return;
266 
267 	/*
268 	 * Keep track of which addressed devices are found.
269 	 */
270 	sc->uh_used = malloc(UBAIOSIZE, M_TEMP, M_WAITOK);
271 	memset(sc->uh_used, 0, UBAIOSIZE);
272 
273 	if (sc->uh_beforescan)
274 		(*sc->uh_beforescan)(sc);
275 	/*
276 	 * Now start searching for devices.
277 	 */
278 	config_search_ia(ubasearch, sc->uh_dev, "uba", NULL);
279 
280 	if (sc->uh_afterscan)
281 		(*sc->uh_afterscan)(sc);
282 
283 	free(sc->uh_used, M_TEMP);
284 }
285 
286 int
287 ubasearch(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
288 {
289 	struct	uba_softc *sc = device_private(parent);
290 	struct	uba_attach_args ua;
291 	int	i, csr, vec, br;
292 
293 	csr = cf->cf_loc[UBACF_CSR];
294 	if (sc->uh_used[ubdevreg(csr)])
295 		return 0; /* something are already at this address */
296 
297 	ua.ua_ioh = ubdevreg(csr) + sc->uh_ioh;
298 	ua.ua_iot = sc->uh_iot;
299 	ua.ua_dmat = sc->uh_dmat;
300 
301 	if (badaddr((void *)ua.ua_ioh, 2) ||
302 	    (sc->uh_errchk ? (*sc->uh_errchk)(sc):0))
303 		goto forgetit;
304 
305 	scb_vecref(0, 0); /* Clear vector ref */
306 	i = config_match(parent, cf, &ua);
307 
308 	if (sc->uh_errchk)
309 		if ((*sc->uh_errchk)(sc))
310 			goto forgetit;
311 	if (i == 0)
312 		goto forgetit;
313 
314 	i = scb_vecref(&vec, &br);
315 	if (i == 0)
316 		goto fail;
317 	if (vec == 0)
318 		goto fail;
319 
320 	ua.ua_br = br;
321 	ua.ua_cvec = vec;
322 	ua.ua_iaddr = csr;
323 	ua.ua_evcnt = NULL;
324 
325 	sc->uh_used[ubdevreg(csr)] = 1;
326 
327 	config_attach(parent, cf, &ua, ubaprint);
328 	return 0;
329 
330 fail:
331 	printf("%s%d at %s csr %o %s\n",
332 	    cf->cf_name, cf->cf_unit, device_xname(parent),
333 	    csr, (i ? "zero vector" : "didn't interrupt"));
334 
335 forgetit:
336 	return 0;
337 }
338 
339 /*
340  * Print out some interesting info common to all unibus devices.
341  */
342 int
343 ubaprint(void *aux, const char *uba)
344 {
345 	struct uba_attach_args *ua = aux;
346 
347 	aprint_normal(" csr %o vec %o ipl %x", ua->ua_iaddr,
348 	    ua->ua_cvec & 511, ua->ua_br);
349 	return UNCONF;
350 }
351 
352 /*
353  * Move to machdep eventually
354  */
355 void
356 uba_intr_establish(void *icookie, int vec, void (*ifunc)(void *iarg),
357 	void *iarg, struct evcnt *ev)
358 {
359 	scb_vecalloc(vec, ifunc, iarg, SCB_ISTACK, ev);
360 }
361