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