xref: /netbsd-src/sys/dev/isa/isa.c (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /*	$NetBSD: isa.c,v 1.139 2021/04/24 23:36:55 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 2001, 2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum; by Jason R. Thorpe of Wasabi Systems, Inc.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: isa.c,v 1.139 2021/04/24 23:36:55 thorpej Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
39 #include <sys/device.h>
40 
41 #include <sys/intr.h>
42 
43 #include <dev/isa/isareg.h>
44 #include <dev/isa/isavar.h>
45 #include <dev/isa/isadmareg.h>
46 
47 #include "isadma.h"
48 
49 #include "isapnp.h"
50 #if NISAPNP > 0
51 #include <dev/isapnp/isapnpreg.h>
52 #include <dev/isapnp/isapnpvar.h>
53 #endif
54 
55 #include "locators.h"
56 
57 int	isamatch(device_t, cfdata_t, void *);
58 void	isaattach(device_t, device_t, void *);
59 int	isadetach(device_t, int);
60 int	isarescan(device_t, const char *, const int *);
61 void	isachilddetached(device_t, device_t);
62 int	isaprint(void *, const char *);
63 
64 CFATTACH_DECL2_NEW(isa, sizeof(struct isa_softc),
65     isamatch, isaattach, isadetach, NULL, isarescan, isachilddetached);
66 
67 void	isa_attach_knowndevs(struct isa_softc *);
68 void	isa_free_knowndevs(struct isa_softc *);
69 
70 int	isasubmatch(device_t, cfdata_t, const int *, void *);
71 int	isasearch(device_t, cfdata_t, const int *, void *);
72 
73 static int	isa_slotcount = -1;	/* -1 == don't know how many */
74 
75 int
76 isamatch(device_t parent, cfdata_t cf, void *aux)
77 {
78 	/* XXX check other indicators */
79 
80 	return (1);
81 }
82 
83 void
84 isaattach(device_t parent, device_t self, void *aux)
85 {
86 	struct isa_softc *sc = device_private(self);
87 	struct isabus_attach_args *iba = aux;
88 	static const int wildcard[ISACF_NLOCS] = {
89 		[ISACF_PORT]  = ISACF_PORT_DEFAULT,
90 		[ISACF_SIZE]  = ISACF_SIZE_DEFAULT,
91 		[ISACF_IOMEM] = ISACF_IOMEM_DEFAULT,
92 		[ISACF_IOSIZ] = ISACF_IOSIZ_DEFAULT,
93 		[ISACF_IRQ]   = ISACF_IRQ_DEFAULT,
94 		[ISACF_DRQ]   = ISACF_DRQ_DEFAULT,
95 		[ISACF_DRQ2]  = ISACF_DRQ2_DEFAULT,
96 	};
97 
98 	TAILQ_INIT(&sc->sc_knowndevs);
99 	sc->sc_dynamicdevs = 0;
100 
101 	sc->sc_dev = self;
102 
103 	isa_attach_hook(parent, self, iba);
104 	aprint_naive("\n");
105 	aprint_normal("\n");
106 
107 	/* XXX Add code to fetch known-devices. */
108 
109 	sc->sc_iot = iba->iba_iot;
110 	sc->sc_memt = iba->iba_memt;
111 	sc->sc_dmat = iba->iba_dmat;
112 	sc->sc_ic = iba->iba_ic;
113 
114 #if NISAPNP > 0
115 	/*
116 	 * Reset isapnp cards that the bios configured for us
117 	 */
118 	isapnp_isa_attach_hook(sc);
119 #endif
120 
121 #if NISADMA > 0
122 	/*
123 	 * Initialize our DMA state.
124 	 */
125 	isa_dmainit(sc->sc_ic, sc->sc_iot, sc->sc_dmat, self);
126 #endif
127 
128 	/* Attach all direct-config children. */
129 	isa_attach_knowndevs(sc);
130 
131 	/*
132 	 * If we don't support dynamic hello/goodbye of devices,
133 	 * then free the knowndevs info now.
134 	 */
135 	if (sc->sc_dynamicdevs == 0)
136 		isa_free_knowndevs(sc);
137 
138 	/* Attach all indirect-config children. */
139 	isarescan(self, NULL, wildcard);
140 
141 	if (!pmf_device_register(self, NULL, NULL))
142 		aprint_error_dev(self, "couldn't establish power handler\n");
143 }
144 
145 int
146 isadetach(device_t self, int flags)
147 {
148 	struct isa_softc *sc = device_private(self);
149 	int rc;
150 
151 	if ((rc = config_detach_children(self, flags)) != 0)
152 		return rc;
153 
154 	pmf_device_deregister(self);
155 
156 	isa_free_knowndevs(sc);
157 
158 #if NISADMA > 0
159 	isa_dmadestroy(sc->sc_ic);
160 #endif
161 	isa_detach_hook(sc->sc_ic, self);
162 
163 	return 0;
164 }
165 
166 int
167 isarescan(device_t self, const char *ifattr, const int *locators)
168 {
169 	prop_dictionary_t dict;
170 	int locs[ISACF_NLOCS];
171 	bool no_legacy_devices = false;
172 
173 	dict = device_properties(self);
174 	if (prop_dictionary_get_bool(dict, "no-legacy-devices",
175 	    &no_legacy_devices) == true) {
176 		aprint_debug_dev(self, "platform reports no legacy devices\n");
177 		return 0;
178 	}
179 
180 	memcpy(locs, locators, sizeof(locs));
181 
182 	/*
183 	 * XXX Bus independent code calling this function does not
184 	 * know the locator default values. It assumes "-1" for now.
185 	 * (should be made available by "config" one day)
186 	 * So fixup where the "-1" is not correct.
187 	 */
188 	if (locs[ISACF_SIZE] == -1)
189 		locs[ISACF_SIZE] = ISACF_SIZE_DEFAULT;
190 	if (locs[ISACF_IOSIZ] == -1)
191 		locs[ISACF_IOSIZ] = ISACF_IOSIZ_DEFAULT;
192 
193 	config_search(self, NULL,
194 	    CFARG_SEARCH, isasearch,
195 	    CFARG_LOCATORS, locs,
196 	    CFARG_EOL);
197 	return (0);
198 }
199 
200 void
201 isachilddetached(device_t self, device_t child)
202 {
203 	struct isa_knowndev *ik;
204 	struct isa_softc *sc = device_private(self);
205 
206 	TAILQ_FOREACH(ik, &sc->sc_knowndevs, ik_list) {
207 		if (ik->ik_claimed == child)
208 			ik->ik_claimed = NULL;
209 	}
210 }
211 
212 void
213 isa_attach_knowndevs(struct isa_softc *sc)
214 {
215 	struct isa_attach_args ia;
216 	struct isa_knowndev *ik;
217 
218 	if (TAILQ_EMPTY(&sc->sc_knowndevs))
219 		return;
220 
221 	TAILQ_FOREACH(ik, &sc->sc_knowndevs, ik_list) {
222 		if (ik->ik_claimed != NULL)
223 			continue;
224 
225 		ia.ia_iot = sc->sc_iot;
226 		ia.ia_memt = sc->sc_memt;
227 		ia.ia_dmat = sc->sc_dmat;
228 		ia.ia_ic = sc->sc_ic;
229 
230 		ia.ia_pnpname = ik->ik_pnpname;
231 		ia.ia_pnpcompatnames = ik->ik_pnpcompatnames;
232 
233 		ia.ia_io = ik->ik_io;
234 		ia.ia_nio = ik->ik_nio;
235 
236 		ia.ia_iomem = ik->ik_iomem;
237 		ia.ia_niomem = ik->ik_niomem;
238 
239 		ia.ia_irq = ik->ik_irq;
240 		ia.ia_nirq = ik->ik_nirq;
241 
242 		ia.ia_drq = ik->ik_drq;
243 		ia.ia_ndrq = ik->ik_ndrq;
244 
245 		ia.ia_aux = NULL;
246 
247 		/* XXX should setup locator array */
248 
249 		ik->ik_claimed = config_found(sc->sc_dev, &ia, isaprint,
250 		    CFARG_SUBMATCH, isasubmatch,
251 		    CFARG_EOL);
252 	}
253 }
254 
255 void
256 isa_free_knowndevs(struct isa_softc *sc)
257 {
258 	struct isa_knowndev *ik;
259 	struct isa_pnpname *ipn;
260 
261 #define	FREEIT(x)	if (x != NULL) free(x, M_DEVBUF)
262 
263 	while ((ik = TAILQ_FIRST(&sc->sc_knowndevs)) != NULL) {
264 		TAILQ_REMOVE(&sc->sc_knowndevs, ik, ik_list);
265 		FREEIT(ik->ik_pnpname);
266 		while ((ipn = ik->ik_pnpcompatnames) != NULL) {
267 			ik->ik_pnpcompatnames = ipn->ipn_next;
268 			free(ipn->ipn_name, M_DEVBUF);
269 			free(ipn, M_DEVBUF);
270 		}
271 		FREEIT(ik->ik_io);
272 		FREEIT(ik->ik_iomem);
273 		FREEIT(ik->ik_irq);
274 		FREEIT(ik->ik_drq);
275 		free(ik, M_DEVBUF);
276 	}
277 
278 #undef FREEIT
279 }
280 
281 static int
282 checkattachargs(struct isa_attach_args *ia, const int *loc)
283 {
284 	int i;
285 
286 	if (ia->ia_nio == 0) {
287 		if (loc[ISACF_PORT] != ISACF_PORT_DEFAULT)
288 			return (0);
289 	} else {
290 		if (loc[ISACF_PORT] != ISACF_PORT_DEFAULT &&
291 		    loc[ISACF_PORT] != ia->ia_io[0].ir_addr)
292 			return (0);
293 	}
294 
295 	if (ia->ia_niomem == 0) {
296 		if (loc[ISACF_IOMEM] != ISACF_IOMEM_DEFAULT)
297 			return (0);
298 	} else {
299 		if (loc[ISACF_IOMEM] != ISACF_IOMEM_DEFAULT &&
300 		    loc[ISACF_IOMEM] != ia->ia_iomem[0].ir_addr)
301 			return (0);
302 	}
303 
304 	if (ia->ia_nirq == 0) {
305 		if (loc[ISACF_IRQ] != ISACF_IRQ_DEFAULT)
306 			return (0);
307 	} else {
308 		if (loc[ISACF_IRQ] != ISACF_IRQ_DEFAULT &&
309 		    loc[ISACF_IRQ] != ia->ia_irq[0].ir_irq)
310 			return (0);
311 	}
312 
313 	if (ia->ia_ndrq == 0) {
314 		if (loc[ISACF_DRQ] != ISACF_DRQ_DEFAULT)
315 			return (0);
316 		if (loc[ISACF_DRQ2] != ISACF_DRQ2_DEFAULT)
317 			return (0);
318 	} else {
319 		for (i = 0; i < 2; i++) {
320 			if (i == ia->ia_ndrq)
321 				break;
322 			if (loc[ISACF_DRQ + i] != ISACF_DRQ_DEFAULT &&
323 			    loc[ISACF_DRQ + i] != ia->ia_drq[i].ir_drq)
324 				return (0);
325 		}
326 		for (; i < 2; i++) {
327 			if (loc[ISACF_DRQ + i] != ISACF_DRQ_DEFAULT)
328 				return (0);
329 		}
330 	}
331 
332 	return (1);
333 }
334 
335 int
336 isasubmatch(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
337 {
338 	struct isa_attach_args *ia = aux;
339 
340 	if (!checkattachargs(ia, cf->cf_loc))
341 		return (0);
342 
343 	return (config_match(parent, cf, aux));
344 }
345 
346 int
347 isaprint(void *aux, const char *isa)
348 {
349 	struct isa_attach_args *ia = aux;
350 	const char *sep;
351 	int i;
352 
353 	/*
354 	 * This block of code only fires if we have a direct-config'd
355 	 * device for which there is no driver match.
356 	 */
357 	if (isa != NULL) {
358 		struct isa_pnpname *ipn;
359 
360 		if (ia->ia_pnpname != NULL)
361 			aprint_normal("%s", ia->ia_pnpname);
362 		if ((ipn = ia->ia_pnpcompatnames) != NULL) {
363 			aprint_normal(" (");	/* ) */
364 			for (sep = ""; ipn != NULL;
365 			     ipn = ipn->ipn_next, sep = " ") {
366 				aprint_normal("%s%s", sep, ipn->ipn_name);
367 			}
368 	/* ( */		aprint_normal(")");
369 		}
370 		aprint_normal(" at %s", isa);
371 	}
372 
373 	if (ia->ia_nio) {
374 		sep = "";
375 		aprint_normal(" port ");
376 		for (i = 0; i < ia->ia_nio; i++) {
377 			if (ia->ia_io[i].ir_size == 0)
378 				continue;
379 			aprint_normal("%s0x%x", sep, ia->ia_io[i].ir_addr);
380 			if (ia->ia_io[i].ir_size > 1)
381 				aprint_normal("-0x%x", ia->ia_io[i].ir_addr +
382 				    ia->ia_io[i].ir_size - 1);
383 			sep = ",";
384 		}
385 	}
386 
387 	if (ia->ia_niomem) {
388 		sep = "";
389 		aprint_normal(" iomem ");
390 		for (i = 0; i < ia->ia_niomem; i++) {
391 			if (ia->ia_iomem[i].ir_size == 0)
392 				continue;
393 			aprint_normal("%s0x%x", sep, ia->ia_iomem[i].ir_addr);
394 			if (ia->ia_iomem[i].ir_size > 1)
395 				aprint_normal("-0x%x", ia->ia_iomem[i].ir_addr +
396 				    ia->ia_iomem[i].ir_size - 1);
397 			sep = ",";
398 		}
399 	}
400 
401 	if (ia->ia_nirq) {
402 		sep = "";
403 		aprint_normal(" irq ");
404 		for (i = 0; i < ia->ia_nirq; i++) {
405 			if (ia->ia_irq[i].ir_irq == ISACF_IRQ_DEFAULT)
406 				continue;
407 			aprint_normal("%s%d", sep, ia->ia_irq[i].ir_irq);
408 			sep = ",";
409 		}
410 	}
411 
412 	if (ia->ia_ndrq) {
413 		sep = "";
414 		aprint_normal(" drq ");
415 		for (i = 0; i < ia->ia_ndrq; i++) {
416 			if (ia->ia_drq[i].ir_drq == ISACF_DRQ_DEFAULT)
417 				continue;
418 			aprint_normal("%s%d", sep, ia->ia_drq[i].ir_drq);
419 			sep = ",";
420 		}
421 	}
422 
423 	return (UNCONF);
424 }
425 
426 int
427 isasearch(device_t parent, cfdata_t cf, const int *slocs, void *aux)
428 {
429 	struct isa_io res_io[1];
430 	struct isa_iomem res_mem[1];
431 	struct isa_irq res_irq[1];
432 	struct isa_drq res_drq[2];
433 	struct isa_softc *sc = device_private(parent);
434 	struct isa_attach_args ia;
435 	int flocs[ISACF_NLOCS];
436 	int tryagain;
437 
438 	do {
439 		ia.ia_pnpname = NULL;
440 		ia.ia_pnpcompatnames = NULL;
441 
442 		res_io[0].ir_addr = cf->cf_loc[ISACF_PORT];
443 		res_io[0].ir_size = 0;
444 
445 		res_mem[0].ir_addr = cf->cf_loc[ISACF_IOMEM];
446 		res_mem[0].ir_size = cf->cf_loc[ISACF_IOSIZ];
447 
448 		res_irq[0].ir_irq =
449 		    cf->cf_loc[ISACF_IRQ] == 2 ? 9 : cf->cf_loc[ISACF_IRQ];
450 
451 		res_drq[0].ir_drq = cf->cf_loc[ISACF_DRQ];
452 		res_drq[1].ir_drq = cf->cf_loc[ISACF_DRQ2];
453 
454 		ia.ia_iot = sc->sc_iot;
455 		ia.ia_memt = sc->sc_memt;
456 		ia.ia_dmat = sc->sc_dmat;
457 		ia.ia_ic = sc->sc_ic;
458 
459 		ia.ia_io = res_io;
460 		ia.ia_nio = 1;
461 
462 		ia.ia_iomem = res_mem;
463 		ia.ia_niomem = 1;
464 
465 		ia.ia_irq = res_irq;
466 		ia.ia_nirq = 1;
467 
468 		ia.ia_drq = res_drq;
469 		ia.ia_ndrq = 2;
470 
471 		if (!checkattachargs(&ia, slocs))
472 			return (0);
473 
474 		tryagain = 0;
475 		if (config_probe(parent, cf, &ia)) {
476 			/*
477 			 * This is not necessary for detach, but might
478 			 * still be useful to collect device information.
479 			 */
480 			flocs[ISACF_PORT] = ia.ia_io[0].ir_addr;
481 			flocs[ISACF_SIZE] = ia.ia_io[0].ir_size;
482 			flocs[ISACF_IOMEM] = ia.ia_iomem[0].ir_addr;
483 			flocs[ISACF_IOSIZ] = ia.ia_iomem[0].ir_size;
484 			flocs[ISACF_IRQ] = ia.ia_irq[0].ir_irq;
485 			flocs[ISACF_DRQ] = ia.ia_drq[0].ir_drq;
486 			flocs[ISACF_DRQ2] = ia.ia_drq[1].ir_drq;
487 			config_attach(parent, cf, &ia, isaprint,
488 			    CFARG_LOCATORS, flocs,
489 			    CFARG_EOL);
490 			tryagain = (cf->cf_fstate == FSTATE_STAR);
491 		}
492 	} while (tryagain);
493 
494 	return (0);
495 }
496 
497 const char *
498 isa_intr_typename(int type)
499 {
500 
501 	switch (type) {
502 	case IST_NONE:
503 		return ("none");
504 	case IST_PULSE:
505 		return ("pulsed");
506 	case IST_EDGE:
507 		return ("edge-triggered");
508 	case IST_LEVEL:
509 		return ("level-triggered");
510 	default:
511 		panic("isa_intr_typename: invalid type %d", type);
512 	}
513 }
514 
515 int
516 isa_get_slotcount(void)
517 {
518 
519 	return isa_slotcount;
520 }
521 
522 void
523 isa_set_slotcount(int arg)
524 {
525 
526 	isa_slotcount = arg;
527 }
528