xref: /netbsd-src/sys/dev/isa/if_ep_isa.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: if_ep_isa.c,v 1.43 2008/08/27 05:33:47 christos 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.43 2008/08/27 05:33:47 christos 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(device_t , cfdata_t , void *);
96 void ep_isa_attach(device_t , device_t , void *);
97 
98 CFATTACH_DECL_NEW(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(device_t parent, cfdata_t match, void *aux)
153 {
154 	struct isa_attach_args *ia = aux;
155 	bus_space_tag_t iot = ia->ia_iot;
156 	bus_space_handle_t ioh;
157 	int slot, iobase, irq, i;
158 	u_int16_t vendor, model, eeprom_addr_cfg;
159 	struct ep_isa_done_probe *er;
160 	int bus = device_unit(parent);
161 
162 	if (ISA_DIRECT_CONFIG(ia))
163 		return (0);
164 
165 	if (ep_isa_probes_initialized == 0) {
166 		LIST_INIT(&ep_isa_all_probes);
167 		ep_isa_probes_initialized = 1;
168 	}
169 
170 	/*
171 	 * Probe this bus if we haven't done so already.
172 	 */
173 	for (er = ep_isa_all_probes.lh_first; er != NULL;
174 	    er = er->er_link.le_next)
175 		if (er->er_bus == device_unit(parent))
176 			goto bus_probed;
177 
178 	/*
179 	 * Mark this bus so we don't probe it again.
180 	 */
181 	er = (struct ep_isa_done_probe *)
182 	    malloc(sizeof(struct ep_isa_done_probe), M_DEVBUF, M_NOWAIT);
183 	if (er == NULL)
184 		panic("ep_isa_probe: can't allocate state storage");
185 
186 	er->er_bus = bus;
187 	LIST_INSERT_HEAD(&ep_isa_all_probes, er, er_link);
188 
189 	/*
190 	 * Map the Etherlink ID port for the probe sequence.
191 	 */
192 	if (bus_space_map(iot, ELINK_ID_PORT, 1, 0, &ioh)) {
193 		printf("ep_isa_probe: can't map Etherlink ID port\n");
194 		return 0;
195 	}
196 
197 	for (slot = 0; slot < MAXEPCARDS; slot++) {
198 		elink_reset(iot, ioh, device_unit(parent));
199 		elink_idseq(iot, ioh, ELINK_509_POLY);
200 
201 		/* Untag all the adapters so they will talk to us. */
202 		if (slot == 0)
203 			bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 0);
204 
205 		vendor = bswap16(epreadeeprom(iot, ioh, EEPROM_MFG_ID));
206 		if (vendor != MFG_ID)
207 			continue;
208 
209 		model = bswap16(epreadeeprom(iot, ioh, EEPROM_PROD_ID));
210 		/*
211 		 * XXX: Add a new product id to check for other cards
212 		 * (3c515?) and fix the check in ep_isa_attach.
213 		 */
214 		if ((model & 0xfff0) != PROD_ID_3C509) {
215 #ifndef trusted
216 			printf(
217 			 "ep_isa_probe: ignoring model %04x\n", model);
218 #endif
219 			continue;
220 			}
221 
222 		eeprom_addr_cfg = epreadeeprom(iot, ioh, EEPROM_ADDR_CFG);
223 		iobase = (eeprom_addr_cfg & 0x1f) * 0x10 + 0x200;
224 
225 		irq = epreadeeprom(iot, ioh, EEPROM_RESOURCE_CFG);
226 		irq >>= 12;
227 
228 		/* XXX Should ignore card if non-ISA(EISA) io address? -chb */
229 
230 		/*
231 		 * Don't attach a 3c509 in PnP mode.
232 		 * PnP mode was added with the 3C509B.
233 		 * Check some EEPROM registers to make sure this is really
234 		 * a 3C509B and test whether it is in PnP mode.
235 		 */
236 		if ((model & 0xfff0) == PROD_ID_3C509) {
237 			u_int16_t cksum, eepromrev, eeprom_cap, eeprom_hi;
238 
239 
240 			/*
241 			 * Fetch all the info we need to ascertain whether
242 			 * the card is  PnP capable and in PnP mode.
243 			 * Skip over PnP cards.
244 			 */
245 
246 			/* secondary configurable data checksum */
247 			cksum = epreadeeprom(iot, ioh, EEPROM_CHECKSUM_EL3)
248 			    & 0xFF;
249 			for (i = EEPROM_CONFIG_HIGH;
250 			    i < EEPROM_CHECKSUM_EL3; i++) {
251 				cksum ^= epreadeeprom(iot, ioh, i);
252 			}
253 			cksum = (cksum & 0xFF) ^ ((cksum >> 8) & 0xFF);
254 
255 			eepromrev = epreadeeprom(iot, ioh, EEPROM_SSI);
256 			eeprom_hi = epreadeeprom(iot, ioh, EEPROM_CONFIG_HIGH);
257 			eeprom_cap = epreadeeprom(iot, ioh, EEPROM_CAP);
258 
259 			/*
260 			 * Stop card responding to contention in future.
261 			 * (NB: stops rsponse to all reads from ID port.)
262 			 */
263 			bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 1);
264 
265 			if (cksum != 0) {
266 #if 0
267 				printf("ep_isa_probe: cksum mismatch 0x%02x\n",
268 				    (int)cksum);
269 #endif
270 			}
271 			else if ((eepromrev & 0xF) < 1) {
272 				/* 3C509B is adapter revision level 1. */
273 #if 0
274 				printf("ep_isa_probe: revision level 0\n");
275 #endif
276 			}
277 			else if (eeprom_cap != 0x2083) {
278 #if 0
279 				printf("ep_isa_probe: capabilities word mismatch0x%03x\n",
280 				    (int)epreadeeprom(iot, ioh, EEPROM_CAP));
281 #endif
282 			}
283 			else
284 			  /*
285 			   * we have a 3c509B with PnP capabilities.
286 			   * Test partly documented bits which toggle when
287 			   * in PnP mode.
288 			   */
289 			if ((eeprom_hi & 0x8) != 0 || ((eeprom_hi & 0xc) == 0 &&
290 			    (eeprom_addr_cfg & 0x80) != 0)) {
291 				printf("3COM 3C509B Ethernet card in PnP mode\n");
292 				continue;
293 			}
294 		}
295 
296 		/*
297 		 * XXX: this should probably not be done here
298 		 * because it enables the drq/irq lines from
299 		 * the board. Perhaps it should be done after
300 		 * we have checked for irq/drq collisions?
301 		 *
302 		 * According to the 3COM docs, this does not enable
303 		 * the irq lines. -chb
304 		 */
305 		bus_space_write_1(iot, ioh, 0, ACTIVATE_ADAPTER_TO_CONFIG);
306 
307 		epaddcard(bus, iobase, irq, model);
308 	}
309 	/* XXX should we sort by ethernet address? */
310 
311 	bus_space_unmap(iot, ioh, 1);
312 
313 bus_probed:
314 
315 	if (ia->ia_nio < 1)
316 		return (0);
317 	if (ia->ia_nirq < 1)
318 		return (0);
319 
320 	for (i = 0; i < nepcards; i++) {
321 		if (epcards[i].bus != bus)
322 			continue;
323 		if (epcards[i].available == 0)
324 			continue;
325 
326 		if (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
327 		    ia->ia_io[0].ir_addr != epcards[i].iobase)
328 			continue;
329 
330 		if (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ &&
331 		    ia->ia_irq[0].ir_irq != epcards[i].irq)
332 			continue;
333 
334 		goto good;
335 	}
336 	return 0;
337 
338 good:
339 	epcards[i].available = 0;
340 
341 	ia->ia_nio = 1;
342 	ia->ia_io[0].ir_addr = epcards[i].iobase;
343 	ia->ia_io[0].ir_size = 0x10;
344 
345 	ia->ia_nirq = 1;
346 	ia->ia_irq[0].ir_irq = epcards[i].irq;
347 
348 	ia->ia_niomem = 0;
349 	ia->ia_ndrq = 0;
350 
351 	ia->ia_aux = (void *)epcards[i].model;
352 	return 1;
353 }
354 
355 void
356 ep_isa_attach(device_t parent, device_t self, void *aux)
357 {
358 	struct ep_softc *sc = device_private(self);
359 	struct isa_attach_args *ia = aux;
360 	bus_space_tag_t iot = ia->ia_iot;
361 	bus_space_handle_t ioh;
362 	int chipset;
363 
364 	/* Map i/o space. */
365 	if (bus_space_map(iot, ia->ia_io[0].ir_addr, 0x10, 0, &ioh)) {
366 		printf(": can't map i/o space\n");
367 		return;
368 	}
369 
370 	sc->sc_dev = self;
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