if_ep_isa.c revision 54197 
1/*
2 * Copyright (c) 1994 Herb Peyerl <hpeyerl@novatel.ca>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *      This product includes software developed by Herb Peyerl.
16 * 4. The name of Herb Peyerl may not be used to endorse or promote products
17 *    derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * $FreeBSD: head/sys/dev/ep/if_ep_isa.c 54197 1999-12-06 08:40:59Z mdodd $
31 */
32
33#include <sys/param.h>
34#include <sys/systm.h>
35#include <sys/kernel.h>
36#include <sys/socket.h>
37
38#include <sys/module.h>
39#include <sys/bus.h>
40
41#include <machine/bus.h>
42#include <machine/resource.h>
43#include <sys/rman.h>
44
45#include <net/if.h>
46#include <net/if_arp.h>
47#include <net/if_media.h>
48
49#include <machine/clock.h>
50
51#include <isa/isavar.h>
52#include <isa/pnpvar.h>
53
54#include <dev/ep/if_epreg.h>
55#include <dev/ep/if_epvar.h>
56#include <i386/isa/elink.h>
57
58static int	get_eeprom_data	(int, int);
59
60static void	ep_isa_identify	(driver_t *, device_t);
61static int	ep_isa_probe	(device_t);
62static int	ep_isa_attach	(device_t);
63
64struct isa_ident {
65	u_int32_t	id;
66	char *		name;
67};
68const char * ep_isa_match_id (u_int32_t, struct isa_ident *);
69
70#define ISA_ID_3C509_TP    0x506d5090
71#define ISA_ID_3C509_BNC   0x506d5091
72#define ISA_ID_3C509_COMBO 0x506d5094
73#define ISA_ID_3C509_TPO   0x506d5095
74
75static struct isa_ident ep_isa_devs[] = {
76	{ ISA_ID_3C509_TP,	"3Com 3C509-TP EtherLink III" },
77	{ ISA_ID_3C509_BNC,	"3Com 3C509-BNC EtherLink III" },
78	{ ISA_ID_3C509_COMBO,	"3Com 3C509-Combo EtherLink III" },
79	{ ISA_ID_3C509_TPO,	"3Com 3C509-TPO EtherLink III" },
80	{ 0,			NULL },
81};
82
83static struct isa_pnp_id ep_ids[] = {
84	{ 0x90506d50,	"3Com 3C509B-TP EtherLink III (PnP)" },	/* TCM5090 */
85	{ 0x91506d50,	"3Com 3C509B-BNC EtherLink III (PnP)" },/* TCM5091 */
86	{ 0x94506d50,	"3Com 3C509B-Combo EtherLink III (PnP)" },/* TCM5094 */
87	{ 0x95506d50,	"3Com 3C509B-TPO EtherLink III (PnP)" },/* TCM5095 */
88	{ 0xf780d041,	NULL }, /* PNP80f7 */
89	{ 0,		NULL },
90};
91
92/*
93 * We get eeprom data from the id_port given an offset into the eeprom.
94 * Basically; after the ID_sequence is sent to all of the cards; they enter
95 * the ID_CMD state where they will accept command requests. 0x80-0xbf loads
96 * the eeprom data.  We then read the port 16 times and with every read; the
97 * cards check for contention (ie: if one card writes a 0 bit and another
98 * writes a 1 bit then the host sees a 0. At the end of the cycle; each card
99 * compares the data on the bus; if there is a difference then that card goes
100 * into ID_WAIT state again). In the meantime; one bit of data is returned in
101 * the AX register which is conveniently returned to us by inb().  Hence; we
102 * read 16 times getting one bit of data with each read.
103 */
104
105static int
106get_eeprom_data(id_port, offset)
107    int id_port;
108    int offset;
109{
110    int i, data = 0;
111    outb(id_port, 0x80 + offset);
112    for (i = 0; i < 16; i++) {
113	DELAY(BIT_DELAY_MULTIPLE * 1000);
114	data = (data << 1) | (inw(id_port) & 1);
115    }
116    return (data);
117}
118
119const char *
120ep_isa_match_id (id, isa_devs)
121	u_int32_t	      id;
122	struct isa_ident *      isa_devs;
123{
124	struct isa_ident *      i = isa_devs;
125	while(i->name != NULL) {
126	       if (id == i->id)
127		      return (i->name);
128	       i++;
129	}
130	return (NULL);
131}
132
133static void
134ep_isa_identify (driver_t *driver, device_t parent)
135{
136	int		tag = EP_LAST_TAG;
137	int		found = 0;
138	int		i;
139	int		j;
140	const char *	desc;
141	u_int16_t	data;
142	u_int32_t	irq;
143	u_int32_t	ioport;
144	u_int32_t	isa_id;
145	device_t	child;
146
147	outb(ELINK_ID_PORT, 0);
148	outb(ELINK_ID_PORT, 0);
149	elink_idseq(ELINK_509_POLY);
150	elink_reset();
151
152	DELAY(DELAY_MULTIPLE * 10000);
153
154	for (i = 0; i < EP_MAX_BOARDS; i++) {
155
156		outb(ELINK_ID_PORT, 0);
157		outb(ELINK_ID_PORT, 0);
158		elink_idseq(ELINK_509_POLY);
159		DELAY(400);
160
161		/* For the first probe, clear all
162		 * board's tag registers.
163		 * Otherwise kill off already-found
164		 * boards. -- linux 3c509.c
165		 */
166		if (i == 0) {
167			outb(ELINK_ID_PORT, 0xd0);
168		} else {
169			outb(ELINK_ID_PORT, 0xd8);
170		}
171
172		/* Get out of loop if we're out of cards. */
173		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
174		if (data != MFG_ID) {
175			break;
176		}
177
178		/* resolve contention using the Ethernet address */
179		for (j = 0; j < 3; j++) {
180			(void)get_eeprom_data(ELINK_ID_PORT, j);
181		}
182
183		/*
184		 * Construct an 'isa_id' in 'EISA'
185		 * format.
186		 */
187		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
188		isa_id = (htons(data) << 16);
189		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_PROD_ID);
190		isa_id |= htons(data);
191
192		/* Find known ISA boards */
193		desc = ep_isa_match_id(isa_id, ep_isa_devs);
194		if (!desc) {
195			if (bootverbose) {
196				device_printf(parent, "if_ep: unknown ID 0x%08x\n",
197						isa_id);
198			}
199			break;
200		}
201
202		/* Retreive IRQ */
203		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_RESOURCE_CFG);
204		irq = (data >> 12);
205
206		/* Retreive IOPORT */
207		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_ADDR_CFG);
208#ifdef PC98
209		ioport = (((data & 0x1f) * 0x100) + 0x40d0);
210#else
211		ioport = (((data & 0x1f) << 4) + 0x200);
212#endif
213
214		/* Test for an adapter with PnP support. */
215		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_CAP);
216		if (data == CAP_ISA) {
217			data = get_eeprom_data(ELINK_ID_PORT, EEPROM_INT_CONFIG_1);
218			if (data & ICW1_IAS_PNP) {
219				if (bootverbose) {
220					device_printf(parent, "if_ep: Adapter at 0x%03x in PnP mode!\n",
221					  	      ioport);
222				}
223				/* Set the adaptor tag so that the next card can be found. */
224				outb(ELINK_ID_PORT, tag--);
225				continue;
226			}
227		}
228
229		/* Set the adaptor tag so that the next card can be found. */
230		outb(ELINK_ID_PORT, tag--);
231
232		/* Activate the adaptor at the EEPROM location. */
233		outb(ELINK_ID_PORT, ACTIVATE_ADAPTER_TO_CONFIG);
234
235		/* Test for an adapter in TEST mode. */
236		outw(ioport + EP_COMMAND, WINDOW_SELECT | 0);
237		data = inw(ioport + EP_W0_EEPROM_COMMAND);
238		if (data & EEPROM_TST_MODE) {
239			device_printf(parent, "if_ep: Adapter at 0x%03x in TEST mode!  Erase pencil mark.\n",
240			  	      ioport);
241			continue;
242		}
243
244		child = BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, "ep", -1);
245		device_set_desc_copy(child, desc);
246		device_set_driver(child, driver);
247		bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
248		bus_set_resource(child, SYS_RES_IOPORT, 0, ioport, EP_IOSIZE);
249
250		if (bootverbose) {
251			device_printf(parent, "if_ep: <%s> at port 0x%03x-0x%03x irq %d\n",
252					desc, ioport, ioport + EP_IOSIZE, irq);
253		}
254
255		found++;
256	}
257
258	return;
259}
260
261static int
262ep_isa_probe (device_t dev)
263{
264	int	error = 0;
265
266	/* Check isapnp ids */
267	error = ISA_PNP_PROBE(device_get_parent(dev), dev, ep_ids);
268
269	/* If the card had a PnP ID that didn't match any we know about */
270	if (error == ENXIO) {
271	       return (error);
272	}
273
274	/* If we had some other problem. */
275	if (!(error == 0 || error == ENOENT)) {
276		return (error);
277	}
278
279	/* If we have the resources we need then we're good to go. */
280	if ((bus_get_resource_start(dev, SYS_RES_IOPORT, 0) != 0) &&
281	    (bus_get_resource_start(dev, SYS_RES_IRQ, 0) != 0)) {
282		return (0);
283	}
284
285	return (ENXIO);
286}
287
288static int
289ep_isa_attach (device_t dev)
290{
291	struct ep_softc *	sc = device_get_softc(dev);
292	int			error = 0;
293
294	if ((error = ep_alloc(dev))) {
295		device_printf(dev, "ep_alloc() failed! (%d)\n", error);
296		goto bad;
297	}
298
299	ep_get_media(sc);
300
301	GO_WINDOW(0);
302	SET_IRQ(BASE, rman_get_start(sc->irq));
303
304	if ((error = ep_attach(sc))) {
305		device_printf(dev, "ep_attach() failed! (%d)\n", error);
306		goto bad;
307	}
308
309	if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET, ep_intr,
310				   sc, &sc->ep_intrhand))) {
311		device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
312		goto bad;
313	}
314
315	return (0);
316bad:
317	ep_free(dev);
318	return (error);
319}
320
321static device_method_t ep_isa_methods[] = {
322	/* Device interface */
323	DEVMETHOD(device_identify,	ep_isa_identify),
324	DEVMETHOD(device_probe,		ep_isa_probe),
325	DEVMETHOD(device_attach,	ep_isa_attach),
326
327	{ 0, 0 }
328};
329
330static driver_t ep_isa_driver = {
331	"ep",
332	ep_isa_methods,
333	sizeof(struct ep_softc),
334};
335
336extern devclass_t ep_devclass;
337
338DRIVER_MODULE(ep, isa, ep_isa_driver, ep_devclass, 0, 0);
339