xref: /freebsd/sys/dev/le/if_le_isa.c (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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 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 
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/bus.h>
70 #include <sys/endian.h>
71 #include <sys/kernel.h>
72 #include <sys/lock.h>
73 #include <sys/module.h>
74 #include <sys/mutex.h>
75 #include <sys/resource.h>
76 #include <sys/rman.h>
77 #include <sys/socket.h>
78 
79 #include <net/ethernet.h>
80 #include <net/if.h>
81 #include <net/if_media.h>
82 
83 #include <machine/bus.h>
84 #include <machine/resource.h>
85 
86 #include <isa/isavar.h>
87 
88 #include <dev/le/lancereg.h>
89 #include <dev/le/lancevar.h>
90 #include <dev/le/am7990var.h>
91 
92 #define	LE_ISA_MEMSIZE	(16*1024)
93 #define	PCNET_RDP	0x10
94 #define	PCNET_RAP	0x12
95 
96 struct le_isa_softc {
97 	struct am7990_softc	sc_am7990;	/* glue to MI code */
98 
99 	bus_size_t		sc_rap;		/* offsets to LANCE... */
100 	bus_size_t		sc_rdp;		/* ...registers */
101 
102 	struct resource		*sc_rres;
103 
104 	struct resource		*sc_dres;
105 
106 	struct resource		*sc_ires;
107 	void			*sc_ih;
108 
109 	bus_dma_tag_t		sc_pdmat;
110 	bus_dma_tag_t		sc_dmat;
111 	bus_dmamap_t		sc_dmam;
112 };
113 
114 static device_probe_t le_isa_probe;
115 static device_attach_t le_isa_attach;
116 static device_detach_t le_isa_detach;
117 static device_resume_t le_isa_resume;
118 static device_suspend_t le_isa_suspend;
119 
120 static device_method_t le_isa_methods[] = {
121 	/* Device interface */
122 	DEVMETHOD(device_probe,		le_isa_probe),
123 	DEVMETHOD(device_attach,	le_isa_attach),
124 	DEVMETHOD(device_detach,	le_isa_detach),
125 	/* We can just use the suspend method here. */
126 	DEVMETHOD(device_shutdown,	le_isa_suspend),
127 	DEVMETHOD(device_suspend,	le_isa_suspend),
128 	DEVMETHOD(device_resume,	le_isa_resume),
129 
130 	{ 0, 0 }
131 };
132 
133 struct le_isa_param {
134 	const char	*name;
135 	u_long		iosize;
136 	bus_size_t	rap;
137 	bus_size_t	rdp;
138 	bus_size_t	macstart;
139 	int		macstride;
140 } static const le_isa_params[] = {
141 	{ "BICC Isolan", 24, 0xe, 0xc, 0, 2 },
142 	{ "Novell NE2100", 16, 0x12, 0x10, 0, 1 }
143 };
144 
145 static struct isa_pnp_id le_isa_ids[] = {
146 	{ 0x0322690e, "Cabletron E2200 Single Chip" },	/* CSI2203 */
147 	{ 0x0110490a, "Boca LANCard Combo" },		/* BRI1001 */
148 	{ 0x0100a60a, "Melco Inc. LGY-IV" },		/* BUF0001 */
149 	{ 0xd880d041, "Novell NE2100" },		/* PNP80D8 */
150 	{ 0x0082d041, "Cabletron E2100 Series DNI" },	/* PNP8200 */
151 	{ 0x3182d041, "AMD AM1500T/AM2100" },		/* PNP8231 */
152 	{ 0x8c82d041, "AMD PCnet-ISA" },		/* PNP828C */
153 	{ 0x8d82d041, "AMD PCnet-32" },			/* PNP828D */
154 	{ 0xcefaedfe, "Racal InterLan EtherBlaster" },	/* _WMFACE */
155 	{ 0, NULL }
156 };
157 
158 static void le_isa_wrcsr(struct lance_softc *, uint16_t, uint16_t);
159 static uint16_t le_isa_rdcsr(struct lance_softc *, uint16_t);
160 static bus_dmamap_callback_t le_isa_dma_callback;
161 static int le_isa_probe_legacy(device_t, const struct le_isa_param *);
162 
163 static void
164 le_isa_wrcsr(struct lance_softc *sc, uint16_t port, uint16_t val)
165 {
166 	struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
167 
168 	bus_write_2(lesc->sc_rres, lesc->sc_rap, port);
169 	bus_barrier(lesc->sc_rres, lesc->sc_rap, 2, BUS_SPACE_BARRIER_WRITE);
170 	bus_write_2(lesc->sc_rres, lesc->sc_rdp, val);
171 }
172 
173 static uint16_t
174 le_isa_rdcsr(struct lance_softc *sc, uint16_t port)
175 {
176 	struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
177 
178 	bus_write_2(lesc->sc_rres, lesc->sc_rap, port);
179 	bus_barrier(lesc->sc_rres, lesc->sc_rap, 2, BUS_SPACE_BARRIER_WRITE);
180 	return (bus_read_2(lesc->sc_rres, lesc->sc_rdp));
181 }
182 
183 static void
184 le_isa_dma_callback(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
185 {
186 	struct lance_softc *sc = (struct lance_softc *)xsc;
187 
188 	if (error != 0)
189 		return;
190 	KASSERT(nsegs == 1, ("%s: bad DMA segment count", __func__));
191 	sc->sc_addr = segs[0].ds_addr;
192 }
193 
194 static int
195 le_isa_probe_legacy(device_t dev, const struct le_isa_param *leip)
196 {
197 	struct le_isa_softc *lesc;
198 	struct lance_softc *sc;
199 	int error, i;
200 
201 	lesc = device_get_softc(dev);
202 	sc = &lesc->sc_am7990.lsc;
203 
204 	i = 0;
205 	lesc->sc_rres = bus_alloc_resource_anywhere(dev, SYS_RES_IOPORT, &i,
206 	    leip->iosize, RF_ACTIVE);
207 	if (lesc->sc_rres == NULL)
208 		return (ENXIO);
209 	lesc->sc_rap = leip->rap;
210 	lesc->sc_rdp = leip->rdp;
211 
212 	/* Stop the chip and put it in a known state. */
213 	le_isa_wrcsr(sc, LE_CSR0, LE_C0_STOP);
214 	DELAY(100);
215 	if (le_isa_rdcsr(sc, LE_CSR0) != LE_C0_STOP) {
216 		error = ENXIO;
217 		goto fail;
218 	}
219 	le_isa_wrcsr(sc, LE_CSR3, 0);
220 	error = 0;
221 
222  fail:
223 	bus_release_resource(dev, SYS_RES_IOPORT,
224 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
225 	return (error);
226 }
227 
228 static int
229 le_isa_probe(device_t dev)
230 {
231 	int i;
232 
233 	switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
234 	case 0:
235 		return (BUS_PROBE_DEFAULT);
236 	case ENOENT:
237 		for (i = 0; i < nitems(le_isa_params); i++) {
238 			if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
239 				device_set_desc(dev, le_isa_params[i].name);
240 				return (BUS_PROBE_DEFAULT);
241 			}
242 		}
243 		/* FALLTHROUGH */
244 	case ENXIO:
245 	default:
246 		return (ENXIO);
247 	}
248 }
249 
250 static int
251 le_isa_attach(device_t dev)
252 {
253 	struct le_isa_softc *lesc;
254 	struct lance_softc *sc;
255 	bus_size_t macstart, rap, rdp;
256 	int error, i, j, macstride;
257 
258 	lesc = device_get_softc(dev);
259 	sc = &lesc->sc_am7990.lsc;
260 
261 	LE_LOCK_INIT(sc, device_get_nameunit(dev));
262 
263 	j = 0;
264 	switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
265 	case 0:
266 		lesc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
267 		    &j, RF_ACTIVE);
268 		rap = PCNET_RAP;
269 		rdp = PCNET_RDP;
270 		macstart = 0;
271 		macstride = 1;
272 		break;
273 	case ENOENT:
274 		for (i = 0; i < nitems(le_isa_params); i++) {
275 			if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
276 				lesc->sc_rres = bus_alloc_resource_anywhere(dev,
277 				    SYS_RES_IOPORT, &j,
278 				    le_isa_params[i].iosize, RF_ACTIVE);
279 				rap = le_isa_params[i].rap;
280 				rdp = le_isa_params[i].rdp;
281 				macstart = le_isa_params[i].macstart;
282 				macstride = le_isa_params[i].macstride;
283 				goto found;
284 			}
285 		}
286 		/* FALLTHROUGH */
287 	case ENXIO:
288 	default:
289 		device_printf(dev, "cannot determine chip\n");
290 		error = ENXIO;
291 		goto fail_mtx;
292 	}
293 
294  found:
295 	if (lesc->sc_rres == NULL) {
296 		device_printf(dev, "cannot allocate registers\n");
297 		error = ENXIO;
298 		goto fail_mtx;
299 	}
300 	lesc->sc_rap = rap;
301 	lesc->sc_rdp = rdp;
302 
303 	i = 0;
304 	if ((lesc->sc_dres = bus_alloc_resource_any(dev, SYS_RES_DRQ,
305 	    &i, RF_ACTIVE)) == NULL) {
306 		device_printf(dev, "cannot allocate DMA channel\n");
307 		error = ENXIO;
308 		goto fail_rres;
309 	}
310 
311 	i = 0;
312 	if ((lesc->sc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ,
313 	    &i, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
314 		device_printf(dev, "cannot allocate interrupt\n");
315 		error = ENXIO;
316 		goto fail_dres;
317 	}
318 
319 	error = bus_dma_tag_create(
320 	    bus_get_dma_tag(dev),	/* parent */
321 	    1, 0,			/* alignment, boundary */
322 	    BUS_SPACE_MAXADDR_24BIT,	/* lowaddr */
323 	    BUS_SPACE_MAXADDR,		/* highaddr */
324 	    NULL, NULL,			/* filter, filterarg */
325 	    BUS_SPACE_MAXSIZE_32BIT,	/* maxsize */
326 	    0,				/* nsegments */
327 	    BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
328 	    0,				/* flags */
329 	    NULL, NULL,			/* lockfunc, lockarg */
330 	    &lesc->sc_pdmat);
331 	if (error != 0) {
332 		device_printf(dev, "cannot allocate parent DMA tag\n");
333 		goto fail_ires;
334 	}
335 
336 	sc->sc_memsize = LE_ISA_MEMSIZE;
337 	/*
338 	 * For Am79C90, Am79C961 and Am79C961A the init block must be 2-byte
339 	 * aligned and the ring descriptors must be 8-byte aligned.
340 	 */
341 	error = bus_dma_tag_create(
342 	    lesc->sc_pdmat,		/* parent */
343 	    8, 0,			/* alignment, boundary */
344 	    BUS_SPACE_MAXADDR_24BIT,	/* lowaddr */
345 	    BUS_SPACE_MAXADDR,		/* highaddr */
346 	    NULL, NULL,			/* filter, filterarg */
347 	    sc->sc_memsize,		/* maxsize */
348 	    1,				/* nsegments */
349 	    sc->sc_memsize,		/* maxsegsize */
350 	    0,				/* flags */
351 	    NULL, NULL,			/* lockfunc, lockarg */
352 	    &lesc->sc_dmat);
353 	if (error != 0) {
354 		device_printf(dev, "cannot allocate buffer DMA tag\n");
355 		goto fail_pdtag;
356 	}
357 
358 	error = bus_dmamem_alloc(lesc->sc_dmat, (void **)&sc->sc_mem,
359 	    BUS_DMA_WAITOK | BUS_DMA_COHERENT, &lesc->sc_dmam);
360 	if (error != 0) {
361 		device_printf(dev, "cannot allocate DMA buffer memory\n");
362 		goto fail_dtag;
363 	}
364 
365 	sc->sc_addr = 0;
366 	error = bus_dmamap_load(lesc->sc_dmat, lesc->sc_dmam, sc->sc_mem,
367 	    sc->sc_memsize, le_isa_dma_callback, sc, 0);
368 	if (error != 0 || sc->sc_addr == 0) {
369 		device_printf(dev, "cannot load DMA buffer map\n");
370 		goto fail_dmem;
371 	}
372 
373 	isa_dmacascade(rman_get_start(lesc->sc_dres));
374 
375 	sc->sc_flags = 0;
376 	sc->sc_conf3 = 0;
377 
378 	/*
379 	 * Extract the physical MAC address from the ROM.
380 	 */
381 	for (i = 0; i < sizeof(sc->sc_enaddr); i++)
382 		sc->sc_enaddr[i] = bus_read_1(lesc->sc_rres,
383 		    macstart + i * macstride);
384 
385 	sc->sc_copytodesc = lance_copytobuf_contig;
386 	sc->sc_copyfromdesc = lance_copyfrombuf_contig;
387 	sc->sc_copytobuf = lance_copytobuf_contig;
388 	sc->sc_copyfrombuf = lance_copyfrombuf_contig;
389 	sc->sc_zerobuf = lance_zerobuf_contig;
390 
391 	sc->sc_rdcsr = le_isa_rdcsr;
392 	sc->sc_wrcsr = le_isa_wrcsr;
393 	sc->sc_hwreset = NULL;
394 	sc->sc_hwinit = NULL;
395 	sc->sc_hwintr = NULL;
396 	sc->sc_nocarrier = NULL;
397 	sc->sc_mediachange = NULL;
398 	sc->sc_mediastatus = NULL;
399 	sc->sc_supmedia = NULL;
400 
401 	error = am7990_config(&lesc->sc_am7990, device_get_name(dev),
402 	    device_get_unit(dev));
403 	if (error != 0) {
404 		device_printf(dev, "cannot attach Am7990\n");
405 		goto fail_dmap;
406 	}
407 
408 	error = bus_setup_intr(dev, lesc->sc_ires, INTR_TYPE_NET | INTR_MPSAFE,
409 	    NULL, am7990_intr, sc, &lesc->sc_ih);
410 	if (error != 0) {
411 		device_printf(dev, "cannot set up interrupt\n");
412 		goto fail_am7990;
413 	}
414 
415 	return (0);
416 
417  fail_am7990:
418 	am7990_detach(&lesc->sc_am7990);
419  fail_dmap:
420 	bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
421  fail_dmem:
422 	bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
423  fail_dtag:
424 	bus_dma_tag_destroy(lesc->sc_dmat);
425  fail_pdtag:
426 	bus_dma_tag_destroy(lesc->sc_pdmat);
427  fail_ires:
428 	bus_release_resource(dev, SYS_RES_IRQ,
429 	    rman_get_rid(lesc->sc_ires), lesc->sc_ires);
430  fail_dres:
431 	bus_release_resource(dev, SYS_RES_DRQ,
432 	    rman_get_rid(lesc->sc_dres), lesc->sc_dres);
433  fail_rres:
434 	bus_release_resource(dev, SYS_RES_IOPORT,
435 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
436  fail_mtx:
437 	LE_LOCK_DESTROY(sc);
438 	return (error);
439 }
440 
441 static int
442 le_isa_detach(device_t dev)
443 {
444 	struct le_isa_softc *lesc;
445 	struct lance_softc *sc;
446 
447 	lesc = device_get_softc(dev);
448 	sc = &lesc->sc_am7990.lsc;
449 
450 	bus_teardown_intr(dev, lesc->sc_ires, lesc->sc_ih);
451 	am7990_detach(&lesc->sc_am7990);
452 	bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
453 	bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
454 	bus_dma_tag_destroy(lesc->sc_dmat);
455 	bus_dma_tag_destroy(lesc->sc_pdmat);
456 	bus_release_resource(dev, SYS_RES_IRQ,
457 	    rman_get_rid(lesc->sc_ires), lesc->sc_ires);
458 	bus_release_resource(dev, SYS_RES_DRQ,
459 	    rman_get_rid(lesc->sc_dres), lesc->sc_dres);
460 	bus_release_resource(dev, SYS_RES_IOPORT,
461 	    rman_get_rid(lesc->sc_rres), lesc->sc_rres);
462 	LE_LOCK_DESTROY(sc);
463 
464 	return (0);
465 }
466 
467 static int
468 le_isa_suspend(device_t dev)
469 {
470 	struct le_isa_softc *lesc;
471 
472 	lesc = device_get_softc(dev);
473 
474 	lance_suspend(&lesc->sc_am7990.lsc);
475 
476 	return (0);
477 }
478 
479 static int
480 le_isa_resume(device_t dev)
481 {
482 	struct le_isa_softc *lesc;
483 
484 	lesc = device_get_softc(dev);
485 
486 	lance_resume(&lesc->sc_am7990.lsc);
487 
488 	return (0);
489 }
490 
491 DEFINE_CLASS_0(le, le_isa_driver, le_isa_methods, sizeof(struct le_isa_softc));
492 DRIVER_MODULE(le, isa, le_isa_driver, 0, 0);
493 MODULE_DEPEND(le, ether, 1, 1, 1);
494 ISA_PNP_INFO(le_isa_ids);
495