xref: /netbsd-src/sys/dev/isa/if_ep_isa.c (revision 2980e352a13e8f0b545a366830c411e7a542ada8)
1 /*	$NetBSD: if_ep_isa.c,v 1.42 2008/04/28 20:23:52 martin Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * 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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Jonathan Stone <jonathan@NetBSD.org>
35  * Copyright (c) 1994 Herb Peyerl <hpeyerl@beer.org>
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  * 1. Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  * 2. Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in the
45  *    documentation and/or other materials provided with the distribution.
46  * 3. All advertising materials mentioning features or use of this software
47  *    must display the following acknowledgement:
48  *      This product includes software developed by Herb Peyerl.
49  * 4. The name of Herb Peyerl may not be used to endorse or promote products
50  *    derived from this software without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  */
63 
64 #include <sys/cdefs.h>
65 __KERNEL_RCSID(0, "$NetBSD: if_ep_isa.c,v 1.42 2008/04/28 20:23:52 martin Exp $");
66 
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/mbuf.h>
70 #include <sys/socket.h>
71 #include <sys/ioctl.h>
72 #include <sys/errno.h>
73 #include <sys/syslog.h>
74 #include <sys/select.h>
75 #include <sys/device.h>
76 #include <sys/queue.h>
77 
78 #include <net/if.h>
79 #include <net/if_dl.h>
80 #include <net/if_ether.h>
81 #include <net/if_media.h>
82 
83 #include <sys/cpu.h>
84 #include <sys/bus.h>
85 #include <sys/intr.h>
86 
87 #include <dev/mii/miivar.h>
88 
89 #include <dev/ic/elink3var.h>
90 #include <dev/ic/elink3reg.h>
91 
92 #include <dev/isa/isavar.h>
93 #include <dev/isa/elink.h>
94 
95 int ep_isa_probe(struct device *, struct cfdata *, void *);
96 void ep_isa_attach(struct device *, struct device *, void *);
97 
98 CFATTACH_DECL(ep_isa, sizeof(struct ep_softc),
99     ep_isa_probe, ep_isa_attach, NULL, NULL);
100 
101 static	void epaddcard(int, int, int, int);
102 
103 /*
104  * This keeps track of which ISAs have been through an ep probe sequence.
105  * A simple static variable isn't enough, since it's conceivable that
106  * a system might have more than one ISA bus.
107  *
108  * The "er_bus" member is the unit number of the parent ISA bus, e.g. "0"
109  * for "isa0".
110  */
111 struct ep_isa_done_probe {
112 	LIST_ENTRY(ep_isa_done_probe)	er_link;
113 	int				er_bus;
114 };
115 static LIST_HEAD(, ep_isa_done_probe) ep_isa_all_probes;
116 static int ep_isa_probes_initialized;
117 
118 #define MAXEPCARDS	20	/* if you have more than 20, you lose */
119 
120 static struct epcard {
121 	int	bus;
122 	int	iobase;
123 	int	irq;
124 	char	available;
125 	long	model;
126 } epcards[MAXEPCARDS];
127 static int nepcards;
128 
129 static void
130 epaddcard(bus, iobase, irq, model)
131 	int bus, iobase, irq, model;
132 {
133 
134 	if (nepcards >= MAXEPCARDS)
135 		return;
136 	epcards[nepcards].bus = bus;
137 	epcards[nepcards].iobase = iobase;
138 	epcards[nepcards].irq = (irq == 2) ? 9 : irq;
139 	epcards[nepcards].model = model;
140 	epcards[nepcards].available = 1;
141 	nepcards++;
142 }
143 
144 /*
145  * 3c509 cards on the ISA bus are probed in ethernet address order.
146  * The probe sequence requires careful orchestration, and we'd like
147  * like to allow the irq and base address to be wildcarded. So, we
148  * probe all the cards the first time epprobe() is called. On subsequent
149  * calls we look for matching cards.
150  */
151 int
152 ep_isa_probe(struct device *parent, struct cfdata *match,
153     void *aux)
154 {
155 	struct isa_attach_args *ia = aux;
156 	bus_space_tag_t iot = ia->ia_iot;
157 	bus_space_handle_t ioh;
158 	int slot, iobase, irq, i;
159 	u_int16_t vendor, model, eeprom_addr_cfg;
160 	struct ep_isa_done_probe *er;
161 	int bus = device_unit(parent);
162 
163 	if (ISA_DIRECT_CONFIG(ia))
164 		return (0);
165 
166 	if (ep_isa_probes_initialized == 0) {
167 		LIST_INIT(&ep_isa_all_probes);
168 		ep_isa_probes_initialized = 1;
169 	}
170 
171 	/*
172 	 * Probe this bus if we haven't done so already.
173 	 */
174 	for (er = ep_isa_all_probes.lh_first; er != NULL;
175 	    er = er->er_link.le_next)
176 		if (er->er_bus == device_unit(parent))
177 			goto bus_probed;
178 
179 	/*
180 	 * Mark this bus so we don't probe it again.
181 	 */
182 	er = (struct ep_isa_done_probe *)
183 	    malloc(sizeof(struct ep_isa_done_probe), M_DEVBUF, M_NOWAIT);
184 	if (er == NULL)
185 		panic("ep_isa_probe: can't allocate state storage");
186 
187 	er->er_bus = bus;
188 	LIST_INSERT_HEAD(&ep_isa_all_probes, er, er_link);
189 
190 	/*
191 	 * Map the Etherlink ID port for the probe sequence.
192 	 */
193 	if (bus_space_map(iot, ELINK_ID_PORT, 1, 0, &ioh)) {
194 		printf("ep_isa_probe: can't map Etherlink ID port\n");
195 		return 0;
196 	}
197 
198 	for (slot = 0; slot < MAXEPCARDS; slot++) {
199 		elink_reset(iot, ioh, device_unit(parent));
200 		elink_idseq(iot, ioh, ELINK_509_POLY);
201 
202 		/* Untag all the adapters so they will talk to us. */
203 		if (slot == 0)
204 			bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 0);
205 
206 		vendor = bswap16(epreadeeprom(iot, ioh, EEPROM_MFG_ID));
207 		if (vendor != MFG_ID)
208 			continue;
209 
210 		model = bswap16(epreadeeprom(iot, ioh, EEPROM_PROD_ID));
211 		/*
212 		 * XXX: Add a new product id to check for other cards
213 		 * (3c515?) and fix the check in ep_isa_attach.
214 		 */
215 		if ((model & 0xfff0) != PROD_ID_3C509) {
216 #ifndef trusted
217 			printf(
218 			 "ep_isa_probe: ignoring model %04x\n", model);
219 #endif
220 			continue;
221 			}
222 
223 		eeprom_addr_cfg = epreadeeprom(iot, ioh, EEPROM_ADDR_CFG);
224 		iobase = (eeprom_addr_cfg & 0x1f) * 0x10 + 0x200;
225 
226 		irq = epreadeeprom(iot, ioh, EEPROM_RESOURCE_CFG);
227 		irq >>= 12;
228 
229 		/* XXX Should ignore card if non-ISA(EISA) io address? -chb */
230 
231 		/*
232 		 * Don't attach a 3c509 in PnP mode.
233 		 * PnP mode was added with the 3C509B.
234 		 * Check some EEPROM registers to make sure this is really
235 		 * a 3C509B and test whether it is in PnP mode.
236 		 */
237 		if ((model & 0xfff0) == PROD_ID_3C509) {
238 			u_int16_t cksum, eepromrev, eeprom_cap, eeprom_hi;
239 
240 
241 			/*
242 			 * Fetch all the info we need to ascertain whether
243 			 * the card is  PnP capable and in PnP mode.
244 			 * Skip over PnP cards.
245 			 */
246 
247 			/* secondary configurable data checksum */
248 			cksum = epreadeeprom(iot, ioh, EEPROM_CHECKSUM_EL3)
249 			    & 0xFF;
250 			for (i = EEPROM_CONFIG_HIGH;
251 			    i < EEPROM_CHECKSUM_EL3; i++) {
252 				cksum ^= epreadeeprom(iot, ioh, i);
253 			}
254 			cksum = (cksum & 0xFF) ^ ((cksum >> 8) & 0xFF);
255 
256 			eepromrev = epreadeeprom(iot, ioh, EEPROM_SSI);
257 			eeprom_hi = epreadeeprom(iot, ioh, EEPROM_CONFIG_HIGH);
258 			eeprom_cap = epreadeeprom(iot, ioh, EEPROM_CAP);
259 
260 			/*
261 			 * Stop card responding to contention in future.
262 			 * (NB: stops rsponse to all reads from ID port.)
263 			 */
264 			bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 1);
265 
266 			if (cksum != 0) {
267 #if 0
268 				printf("ep_isa_probe: cksum mismatch 0x%02x\n",
269 				    (int)cksum);
270 #endif
271 			}
272 			else if ((eepromrev & 0xF) < 1) {
273 				/* 3C509B is adapter revision level 1. */
274 #if 0
275 				printf("ep_isa_probe: revision level 0\n");
276 #endif
277 			}
278 			else if (eeprom_cap != 0x2083) {
279 #if 0
280 				printf("ep_isa_probe: capabilities word mismatch0x%03x\n",
281 				    (int)epreadeeprom(iot, ioh, EEPROM_CAP));
282 #endif
283 			}
284 			else
285 			  /*
286 			   * we have a 3c509B with PnP capabilities.
287 			   * Test partly documented bits which toggle when
288 			   * in PnP mode.
289 			   */
290 			if ((eeprom_hi & 0x8) != 0 || ((eeprom_hi & 0xc) == 0 &&
291 			    (eeprom_addr_cfg & 0x80) != 0)) {
292 				printf("3COM 3C509B Ethernet card in PnP mode\n");
293 				continue;
294 			}
295 		}
296 
297 		/*
298 		 * XXX: this should probably not be done here
299 		 * because it enables the drq/irq lines from
300 		 * the board. Perhaps it should be done after
301 		 * we have checked for irq/drq collisions?
302 		 *
303 		 * According to the 3COM docs, this does not enable
304 		 * the irq lines. -chb
305 		 */
306 		bus_space_write_1(iot, ioh, 0, ACTIVATE_ADAPTER_TO_CONFIG);
307 
308 		epaddcard(bus, iobase, irq, model);
309 	}
310 	/* XXX should we sort by ethernet address? */
311 
312 	bus_space_unmap(iot, ioh, 1);
313 
314 bus_probed:
315 
316 	if (ia->ia_nio < 1)
317 		return (0);
318 	if (ia->ia_nirq < 1)
319 		return (0);
320 
321 	for (i = 0; i < nepcards; i++) {
322 		if (epcards[i].bus != bus)
323 			continue;
324 		if (epcards[i].available == 0)
325 			continue;
326 
327 		if (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
328 		    ia->ia_io[0].ir_addr != epcards[i].iobase)
329 			continue;
330 
331 		if (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ &&
332 		    ia->ia_irq[0].ir_irq != epcards[i].irq)
333 			continue;
334 
335 		goto good;
336 	}
337 	return 0;
338 
339 good:
340 	epcards[i].available = 0;
341 
342 	ia->ia_nio = 1;
343 	ia->ia_io[0].ir_addr = epcards[i].iobase;
344 	ia->ia_io[0].ir_size = 0x10;
345 
346 	ia->ia_nirq = 1;
347 	ia->ia_irq[0].ir_irq = epcards[i].irq;
348 
349 	ia->ia_niomem = 0;
350 	ia->ia_ndrq = 0;
351 
352 	ia->ia_aux = (void *)epcards[i].model;
353 	return 1;
354 }
355 
356 void
357 ep_isa_attach(struct device *parent, struct device *self, void *aux)
358 {
359 	struct ep_softc *sc = (void *)self;
360 	struct isa_attach_args *ia = aux;
361 	bus_space_tag_t iot = ia->ia_iot;
362 	bus_space_handle_t ioh;
363 	int chipset;
364 
365 	/* Map i/o space. */
366 	if (bus_space_map(iot, ia->ia_io[0].ir_addr, 0x10, 0, &ioh)) {
367 		printf(": can't map i/o space\n");
368 		return;
369 	}
370 
371 	sc->sc_iot = iot;
372 	sc->sc_ioh = ioh;
373 	sc->bustype = ELINK_BUS_ISA;
374 
375 	sc->enable = NULL;
376 	sc->disable = NULL;
377 	sc->enabled = 1;
378 
379 	chipset = (int)(long)ia->ia_aux;
380 	if ((chipset & 0xfff0) == PROD_ID_3C509) {
381 		printf(": 3Com 3C509 Ethernet\n");
382 		epconfig(sc, ELINK_CHIPSET_3C509, NULL);
383 	} else {
384 		/*
385 		 * XXX: Maybe a 3c515, but the check in ep_isa_probe looks
386 		 * at the moment only for a 3c509.
387 		 */
388 		printf(": unknown 3Com Ethernet card: %04x\n", chipset);
389 		return;
390 	}
391 
392 	sc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
393 	    IST_EDGE, IPL_NET, epintr, sc);
394 }
395