xref: /freebsd/sys/dev/le/if_le_isa.c (revision 6e778a7efdc0e804471750157f6bacd1ef7d1580)
1 /*	$NetBSD: if_le_isa.c,v 1.41 2005/12/24 20:27:41 perry Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD AND BSD-3-Clause
5  *
6  * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
11  * Simulation Facility, NASA Ames Research Center.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 /*-
36  * Copyright (c) 1992, 1993
37  *	The Regents of the University of California.  All rights reserved.
38  *
39  * This code is derived from software contributed to Berkeley by
40  * Ralph Campbell and Rick Macklem.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  * 3. Neither the name of the University nor the names of its contributors
51  *    may be used to endorse or promote products derived from this software
52  *    without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64  * SUCH DAMAGE.
65  *
66  *	@(#)if_le.c	8.2 (Berkeley) 11/16/93
67  */
68 
69 #include <sys/cdefs.h>
70 __FBSDID("$FreeBSD$");
71 
72 #include <sys/param.h>
73 #include <sys/systm.h>
74 #include <sys/bus.h>
75 #include <sys/endian.h>
76 #include <sys/kernel.h>
77 #include <sys/lock.h>
78 #include <sys/module.h>
79 #include <sys/mutex.h>
80 #include <sys/resource.h>
81 #include <sys/rman.h>
82 #include <sys/socket.h>
83 
84 #include <net/ethernet.h>
85 #include <net/if.h>
86 #include <net/if_media.h>
87 
88 #include <machine/bus.h>
89 #include <machine/resource.h>
90 
91 #include <isa/isavar.h>
92 
93 #include <dev/le/lancereg.h>
94 #include <dev/le/lancevar.h>
95 #include <dev/le/am7990var.h>
96 
97 #define	LE_ISA_MEMSIZE	(16*1024)
98 #define	PCNET_RDP	0x10
99 #define	PCNET_RAP	0x12
100 
101 struct le_isa_softc {
102 	struct am7990_softc	sc_am7990;	/* glue to MI code */
103 
104 	bus_size_t		sc_rap;		/* offsets to LANCE... */
105 	bus_size_t		sc_rdp;		/* ...registers */
106 
107 	struct resource		*sc_rres;
108 
109 	struct resource		*sc_dres;
110 
111 	struct resource		*sc_ires;
112 	void			*sc_ih;
113 
114 	bus_dma_tag_t		sc_pdmat;
115 	bus_dma_tag_t		sc_dmat;
116 	bus_dmamap_t		sc_dmam;
117 };
118 
119 static device_probe_t le_isa_probe;
120 static device_attach_t le_isa_attach;
121 static device_detach_t le_isa_detach;
122 static device_resume_t le_isa_resume;
123 static device_suspend_t le_isa_suspend;
124 
125 static device_method_t le_isa_methods[] = {
126 	/* Device interface */
127 	DEVMETHOD(device_probe,		le_isa_probe),
128 	DEVMETHOD(device_attach,	le_isa_attach),
129 	DEVMETHOD(device_detach,	le_isa_detach),
130 	/* We can just use the suspend method here. */
131 	DEVMETHOD(device_shutdown,	le_isa_suspend),
132 	DEVMETHOD(device_suspend,	le_isa_suspend),
133 	DEVMETHOD(device_resume,	le_isa_resume),
134 
135 	{ 0, 0 }
136 };
137 
138 DEFINE_CLASS_0(le, le_isa_driver, le_isa_methods, sizeof(struct le_isa_softc));
139 DRIVER_MODULE(le, isa, le_isa_driver, le_devclass, 0, 0);
140 MODULE_DEPEND(le, ether, 1, 1, 1);
141 
142 struct le_isa_param {
143 	const char	*name;
144 	u_long		iosize;
145 	bus_size_t	rap;
146 	bus_size_t	rdp;
147 	bus_size_t	macstart;
148 	int		macstride;
149 } static const le_isa_params[] = {
150 	{ "BICC Isolan", 24, 0xe, 0xc, 0, 2 },
151 	{ "Novell NE2100", 16, 0x12, 0x10, 0, 1 }
152 };
153 
154 static struct isa_pnp_id le_isa_ids[] = {
155 	{ 0x0322690e, "Cabletron E2200 Single Chip" },	/* CSI2203 */
156 	{ 0x0110490a, "Boca LANCard Combo" },		/* BRI1001 */
157 	{ 0x0100a60a, "Melco Inc. LGY-IV" },		/* BUF0001 */
158 	{ 0xd880d041, "Novell NE2100" },		/* PNP80D8 */
159 	{ 0x0082d041, "Cabletron E2100 Series DNI" },	/* PNP8200 */
160 	{ 0x3182d041, "AMD AM1500T/AM2100" },		/* PNP8231 */
161 	{ 0x8c82d041, "AMD PCnet-ISA" },		/* PNP828C */
162 	{ 0x8d82d041, "AMD PCnet-32" },			/* PNP828D */
163 	{ 0xcefaedfe, "Racal InterLan EtherBlaster" },	/* _WMFACE */
164 	{ 0, NULL }
165 };
166 
167 static void le_isa_wrcsr(struct lance_softc *, uint16_t, uint16_t);
168 static uint16_t le_isa_rdcsr(struct lance_softc *, uint16_t);
169 static bus_dmamap_callback_t le_isa_dma_callback;
170 static int le_isa_probe_legacy(device_t, const struct le_isa_param *);
171 
172 static void
173 le_isa_wrcsr(struct lance_softc *sc, uint16_t port, uint16_t val)
174 {
175 	struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
176 
177 	bus_write_2(lesc->sc_rres, lesc->sc_rap, port);
178 	bus_barrier(lesc->sc_rres, lesc->sc_rap, 2, BUS_SPACE_BARRIER_WRITE);
179 	bus_write_2(lesc->sc_rres, lesc->sc_rdp, val);
180 }
181 
182 static uint16_t
183 le_isa_rdcsr(struct lance_softc *sc, uint16_t port)
184 {
185 	struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
186 
187 	bus_write_2(lesc->sc_rres, lesc->sc_rap, port);
188 	bus_barrier(lesc->sc_rres, lesc->sc_rap, 2, BUS_SPACE_BARRIER_WRITE);
189 	return (bus_read_2(lesc->sc_rres, lesc->sc_rdp));
190 }
191 
192 static void
193 le_isa_dma_callback(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
194 {
195 	struct lance_softc *sc = (struct lance_softc *)xsc;
196 
197 	if (error != 0)
198 		return;
199 	KASSERT(nsegs == 1, ("%s: bad DMA segment count", __func__));
200 	sc->sc_addr = segs[0].ds_addr;
201 }
202 
203 static int
204 le_isa_probe_legacy(device_t dev, const struct le_isa_param *leip)
205 {
206 	struct le_isa_softc *lesc;
207 	struct lance_softc *sc;
208 	int error, i;
209 
210 	lesc = device_get_softc(dev);
211 	sc = &lesc->sc_am7990.lsc;
212 
213 	i = 0;
214 	lesc->sc_rres = bus_alloc_resource_anywhere(dev, SYS_RES_IOPORT, &i,
215 	    leip->iosize, RF_ACTIVE);
216 	if (lesc->sc_rres == NULL)
217 		return (ENXIO);
218 	lesc->sc_rap = leip->rap;
219 	lesc->sc_rdp = leip->rdp;
220 
221 	/* Stop the chip and put it in a known state. */
222 	le_isa_wrcsr(sc, LE_CSR0, LE_C0_STOP);
223 	DELAY(100);
224 	if (le_isa_rdcsr(sc, LE_CSR0) != LE_C0_STOP) {
225 		error = ENXIO;
226 		goto fail;
227 	}
228 	le_isa_wrcsr(sc, LE_CSR3, 0);
229 	error = 0;
230 
231  fail:
232 	bus_release_resource(dev, SYS_RES_IOPORT,
233 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
234 	return (error);
235 }
236 
237 static int
238 le_isa_probe(device_t dev)
239 {
240 	int i;
241 
242 	switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
243 	case 0:
244 		return (BUS_PROBE_DEFAULT);
245 	case ENOENT:
246 		for (i = 0; i < nitems(le_isa_params); i++) {
247 			if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
248 				device_set_desc(dev, le_isa_params[i].name);
249 				return (BUS_PROBE_DEFAULT);
250 			}
251 		}
252 		/* FALLTHROUGH */
253 	case ENXIO:
254 	default:
255 		return (ENXIO);
256 	}
257 }
258 
259 static int
260 le_isa_attach(device_t dev)
261 {
262 	struct le_isa_softc *lesc;
263 	struct lance_softc *sc;
264 	bus_size_t macstart, rap, rdp;
265 	int error, i, j, macstride;
266 
267 	lesc = device_get_softc(dev);
268 	sc = &lesc->sc_am7990.lsc;
269 
270 	LE_LOCK_INIT(sc, device_get_nameunit(dev));
271 
272 	j = 0;
273 	switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
274 	case 0:
275 		lesc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
276 		    &j, RF_ACTIVE);
277 		rap = PCNET_RAP;
278 		rdp = PCNET_RDP;
279 		macstart = 0;
280 		macstride = 1;
281 		break;
282 	case ENOENT:
283 		for (i = 0; i < nitems(le_isa_params); i++) {
284 			if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
285 				lesc->sc_rres = bus_alloc_resource_anywhere(dev,
286 				    SYS_RES_IOPORT, &j,
287 				    le_isa_params[i].iosize, RF_ACTIVE);
288 				rap = le_isa_params[i].rap;
289 				rdp = le_isa_params[i].rdp;
290 				macstart = le_isa_params[i].macstart;
291 				macstride = le_isa_params[i].macstride;
292 				goto found;
293 			}
294 		}
295 		/* FALLTHROUGH */
296 	case ENXIO:
297 	default:
298 		device_printf(dev, "cannot determine chip\n");
299 		error = ENXIO;
300 		goto fail_mtx;
301 	}
302 
303  found:
304 	if (lesc->sc_rres == NULL) {
305 		device_printf(dev, "cannot allocate registers\n");
306 		error = ENXIO;
307 		goto fail_mtx;
308 	}
309 	lesc->sc_rap = rap;
310 	lesc->sc_rdp = rdp;
311 
312 	i = 0;
313 	if ((lesc->sc_dres = bus_alloc_resource_any(dev, SYS_RES_DRQ,
314 	    &i, RF_ACTIVE)) == NULL) {
315 		device_printf(dev, "cannot allocate DMA channel\n");
316 		error = ENXIO;
317 		goto fail_rres;
318 	}
319 
320 	i = 0;
321 	if ((lesc->sc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ,
322 	    &i, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
323 		device_printf(dev, "cannot allocate interrupt\n");
324 		error = ENXIO;
325 		goto fail_dres;
326 	}
327 
328 	error = bus_dma_tag_create(
329 	    bus_get_dma_tag(dev),	/* parent */
330 	    1, 0,			/* alignment, boundary */
331 	    BUS_SPACE_MAXADDR_24BIT,	/* lowaddr */
332 	    BUS_SPACE_MAXADDR,		/* highaddr */
333 	    NULL, NULL,			/* filter, filterarg */
334 	    BUS_SPACE_MAXSIZE_32BIT,	/* maxsize */
335 	    0,				/* nsegments */
336 	    BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
337 	    0,				/* flags */
338 	    NULL, NULL,			/* lockfunc, lockarg */
339 	    &lesc->sc_pdmat);
340 	if (error != 0) {
341 		device_printf(dev, "cannot allocate parent DMA tag\n");
342 		goto fail_ires;
343 	}
344 
345 	sc->sc_memsize = LE_ISA_MEMSIZE;
346 	/*
347 	 * For Am79C90, Am79C961 and Am79C961A the init block must be 2-byte
348 	 * aligned and the ring descriptors must be 8-byte aligned.
349 	 */
350 	error = bus_dma_tag_create(
351 	    lesc->sc_pdmat,		/* parent */
352 	    8, 0,			/* alignment, boundary */
353 	    BUS_SPACE_MAXADDR_24BIT,	/* lowaddr */
354 	    BUS_SPACE_MAXADDR,		/* highaddr */
355 	    NULL, NULL,			/* filter, filterarg */
356 	    sc->sc_memsize,		/* maxsize */
357 	    1,				/* nsegments */
358 	    sc->sc_memsize,		/* maxsegsize */
359 	    0,				/* flags */
360 	    NULL, NULL,			/* lockfunc, lockarg */
361 	    &lesc->sc_dmat);
362 	if (error != 0) {
363 		device_printf(dev, "cannot allocate buffer DMA tag\n");
364 		goto fail_pdtag;
365 	}
366 
367 	error = bus_dmamem_alloc(lesc->sc_dmat, (void **)&sc->sc_mem,
368 	    BUS_DMA_WAITOK | BUS_DMA_COHERENT, &lesc->sc_dmam);
369 	if (error != 0) {
370 		device_printf(dev, "cannot allocate DMA buffer memory\n");
371 		goto fail_dtag;
372 	}
373 
374 	sc->sc_addr = 0;
375 	error = bus_dmamap_load(lesc->sc_dmat, lesc->sc_dmam, sc->sc_mem,
376 	    sc->sc_memsize, le_isa_dma_callback, sc, 0);
377 	if (error != 0 || sc->sc_addr == 0) {
378 		device_printf(dev, "cannot load DMA buffer map\n");
379 		goto fail_dmem;
380 	}
381 
382 	isa_dmacascade(rman_get_start(lesc->sc_dres));
383 
384 	sc->sc_flags = 0;
385 	sc->sc_conf3 = 0;
386 
387 	/*
388 	 * Extract the physical MAC address from the ROM.
389 	 */
390 	for (i = 0; i < sizeof(sc->sc_enaddr); i++)
391 		sc->sc_enaddr[i] = bus_read_1(lesc->sc_rres,
392 		    macstart + i * macstride);
393 
394 	sc->sc_copytodesc = lance_copytobuf_contig;
395 	sc->sc_copyfromdesc = lance_copyfrombuf_contig;
396 	sc->sc_copytobuf = lance_copytobuf_contig;
397 	sc->sc_copyfrombuf = lance_copyfrombuf_contig;
398 	sc->sc_zerobuf = lance_zerobuf_contig;
399 
400 	sc->sc_rdcsr = le_isa_rdcsr;
401 	sc->sc_wrcsr = le_isa_wrcsr;
402 	sc->sc_hwreset = NULL;
403 	sc->sc_hwinit = NULL;
404 	sc->sc_hwintr = NULL;
405 	sc->sc_nocarrier = NULL;
406 	sc->sc_mediachange = NULL;
407 	sc->sc_mediastatus = NULL;
408 	sc->sc_supmedia = NULL;
409 
410 	error = am7990_config(&lesc->sc_am7990, device_get_name(dev),
411 	    device_get_unit(dev));
412 	if (error != 0) {
413 		device_printf(dev, "cannot attach Am7990\n");
414 		goto fail_dmap;
415 	}
416 
417 	error = bus_setup_intr(dev, lesc->sc_ires, INTR_TYPE_NET | INTR_MPSAFE,
418 	    NULL, am7990_intr, sc, &lesc->sc_ih);
419 	if (error != 0) {
420 		device_printf(dev, "cannot set up interrupt\n");
421 		goto fail_am7990;
422 	}
423 
424 	return (0);
425 
426  fail_am7990:
427 	am7990_detach(&lesc->sc_am7990);
428  fail_dmap:
429 	bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
430  fail_dmem:
431 	bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
432  fail_dtag:
433 	bus_dma_tag_destroy(lesc->sc_dmat);
434  fail_pdtag:
435 	bus_dma_tag_destroy(lesc->sc_pdmat);
436  fail_ires:
437 	bus_release_resource(dev, SYS_RES_IRQ,
438 	    rman_get_rid(lesc->sc_ires), lesc->sc_ires);
439  fail_dres:
440 	bus_release_resource(dev, SYS_RES_DRQ,
441 	    rman_get_rid(lesc->sc_dres), lesc->sc_dres);
442  fail_rres:
443 	bus_release_resource(dev, SYS_RES_IOPORT,
444 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
445  fail_mtx:
446 	LE_LOCK_DESTROY(sc);
447 	return (error);
448 }
449 
450 static int
451 le_isa_detach(device_t dev)
452 {
453 	struct le_isa_softc *lesc;
454 	struct lance_softc *sc;
455 
456 	lesc = device_get_softc(dev);
457 	sc = &lesc->sc_am7990.lsc;
458 
459 	bus_teardown_intr(dev, lesc->sc_ires, lesc->sc_ih);
460 	am7990_detach(&lesc->sc_am7990);
461 	bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
462 	bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
463 	bus_dma_tag_destroy(lesc->sc_dmat);
464 	bus_dma_tag_destroy(lesc->sc_pdmat);
465 	bus_release_resource(dev, SYS_RES_IRQ,
466 	    rman_get_rid(lesc->sc_ires), lesc->sc_ires);
467 	bus_release_resource(dev, SYS_RES_DRQ,
468 	    rman_get_rid(lesc->sc_dres), lesc->sc_dres);
469 	bus_release_resource(dev, SYS_RES_IOPORT,
470 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
471 	LE_LOCK_DESTROY(sc);
472 
473 	return (0);
474 }
475 
476 static int
477 le_isa_suspend(device_t dev)
478 {
479 	struct le_isa_softc *lesc;
480 
481 	lesc = device_get_softc(dev);
482 
483 	lance_suspend(&lesc->sc_am7990.lsc);
484 
485 	return (0);
486 }
487 
488 static int
489 le_isa_resume(device_t dev)
490 {
491 	struct le_isa_softc *lesc;
492 
493 	lesc = device_get_softc(dev);
494 
495 	lance_resume(&lesc->sc_am7990.lsc);
496 
497 	return (0);
498 }
499