if_ep_isa.c revision 56428 
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 56428 2000-01-23 08:23:38Z 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 u_int16_t	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_XXX   0x0506d509
71#define ISA_ID_3C509_TP    0x506d5090
72#define ISA_ID_3C509_BNC   0x506d5091
73#define ISA_ID_3C509_COMBO 0x506d5094
74#define ISA_ID_3C509_TPO   0x506d5095
75#define ISA_ID_3C509_TPC   0x506d5098
76
77static struct isa_ident ep_isa_devs[] = {
78	{ ISA_ID_3C509_TP,	"3Com 3C509-TP EtherLink III" },
79	{ ISA_ID_3C509_BNC,	"3Com 3C509-BNC EtherLink III" },
80	{ ISA_ID_3C509_COMBO,	"3Com 3C509-Combo EtherLink III" },
81	{ ISA_ID_3C509_TPO,	"3Com 3C509-TPO EtherLink III" },
82	{ ISA_ID_3C509_TPC,	"3Com 3C509-TPC EtherLink III" },
83	{ 0,			NULL },
84};
85
86static struct isa_pnp_id ep_ids[] = {
87	{ 0x90506d50,	"3Com 3C509B-TP EtherLink III (PnP)" },	/* TCM5090 */
88	{ 0x91506d50,	"3Com 3C509B-BNC EtherLink III (PnP)" },/* TCM5091 */
89	{ 0x94506d50,	"3Com 3C509B-Combo EtherLink III (PnP)" },/* TCM5094 */
90	{ 0x95506d50,	"3Com 3C509B-TPO EtherLink III (PnP)" },/* TCM5095 */
91	{ 0x98506d50,	"3Com 3C509B-TPC EtherLink III (PnP)" },/* TCM5098 */
92	{ 0xf780d041,	NULL }, /* PNP80f7 */
93	{ 0,		NULL },
94};
95
96/*
97 * We get eeprom data from the id_port given an offset into the eeprom.
98 * Basically; after the ID_sequence is sent to all of the cards; they enter
99 * the ID_CMD state where they will accept command requests. 0x80-0xbf loads
100 * the eeprom data.  We then read the port 16 times and with every read; the
101 * cards check for contention (ie: if one card writes a 0 bit and another
102 * writes a 1 bit then the host sees a 0. At the end of the cycle; each card
103 * compares the data on the bus; if there is a difference then that card goes
104 * into ID_WAIT state again). In the meantime; one bit of data is returned in
105 * the AX register which is conveniently returned to us by inb().  Hence; we
106 * read 16 times getting one bit of data with each read.
107 */
108
109static u_int16_t
110get_eeprom_data(id_port, offset)
111	int	id_port;
112	int	offset;
113{
114	int		i;
115	u_int16_t	data = 0;
116
117	outb(id_port, EEPROM_CMD_RD|offset);
118	DELAY(BIT_DELAY_MULTIPLE * 1000);
119	for (i = 0; i < 16; i++) {
120		DELAY(50);
121		data = (data << 1) | (inw(id_port) & 1);
122	}
123	return (data);
124}
125
126const char *
127ep_isa_match_id (id, isa_devs)
128	u_int32_t	      id;
129	struct isa_ident *      isa_devs;
130{
131	struct isa_ident *      i = isa_devs;
132	while(i->name != NULL) {
133	       if (id == i->id)
134		      return (i->name);
135	       i++;
136	}
137	/*
138	 * If we see a card that is likely to be a 3c509
139	 * return something so that it will work; be annoying
140	 * so that the user will tell us about it though.
141	 */
142	if ((id >> 8) == ISA_ID_3C509_XXX) {
143		return ("Unknown 3c509; notify maintainer!");
144	}
145	return (NULL);
146}
147
148static void
149ep_isa_identify (driver_t *driver, device_t parent)
150{
151	int		tag = EP_LAST_TAG;
152	int		found = 0;
153	int		i;
154	int		j;
155	const char *	desc;
156	u_int16_t	data;
157	u_int32_t	irq;
158	u_int32_t	ioport;
159	u_int32_t	isa_id;
160	device_t	child;
161
162	outb(ELINK_ID_PORT, 0);
163	outb(ELINK_ID_PORT, 0);
164	elink_idseq(ELINK_509_POLY);
165	elink_reset();
166
167	DELAY(DELAY_MULTIPLE * 10000);
168
169	for (i = 0; i < EP_MAX_BOARDS; i++) {
170
171		outb(ELINK_ID_PORT, 0);
172		outb(ELINK_ID_PORT, 0);
173		elink_idseq(ELINK_509_POLY);
174		DELAY(400);
175
176		/* For the first probe, clear all
177		 * board's tag registers.
178		 * Otherwise kill off already-found
179		 * boards. -- linux 3c509.c
180		 */
181		if (i == 0) {
182			outb(ELINK_ID_PORT, 0xd0);
183		} else {
184			outb(ELINK_ID_PORT, 0xd8);
185		}
186
187		/* Get out of loop if we're out of cards. */
188		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
189		if (data != MFG_ID) {
190			break;
191		}
192
193		/* resolve contention using the Ethernet address */
194		for (j = 0; j < 3; j++) {
195			(void)get_eeprom_data(ELINK_ID_PORT, j);
196		}
197
198		/*
199		 * Construct an 'isa_id' in 'EISA'
200		 * format.
201		 */
202		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
203		isa_id = (htons(data) << 16);
204		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_PROD_ID);
205		isa_id |= htons(data);
206
207		/* Find known ISA boards */
208		desc = ep_isa_match_id(isa_id, ep_isa_devs);
209		if (!desc) {
210			if (bootverbose) {
211				device_printf(parent, "if_ep: unknown ID 0x%08x\n",
212						isa_id);
213			}
214			break;
215		}
216
217		/* Retreive IRQ */
218		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_RESOURCE_CFG);
219		irq = (data >> 12);
220
221		/* Retreive IOPORT */
222		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_ADDR_CFG);
223#ifdef PC98
224		ioport = (((data & 0x1f) * 0x100) + 0x40d0);
225#else
226		ioport = (((data & 0x1f) << 4) + 0x200);
227#endif
228
229		/* Test for an adapter with PnP support. */
230		data = get_eeprom_data(ELINK_ID_PORT, EEPROM_CAP);
231		if (data == CAP_ISA) {
232			data = get_eeprom_data(ELINK_ID_PORT, EEPROM_INT_CONFIG_1);
233			if (data & ICW1_IAS_PNP) {
234				if (bootverbose) {
235					device_printf(parent, "if_ep: Adapter at 0x%03x in PnP mode!\n",
236					  	      ioport);
237				}
238				/* Set the adaptor tag so that the next card can be found. */
239				outb(ELINK_ID_PORT, tag--);
240				continue;
241			}
242		}
243
244		/* Set the adaptor tag so that the next card can be found. */
245		outb(ELINK_ID_PORT, tag--);
246
247		/* Activate the adaptor at the EEPROM location. */
248		outb(ELINK_ID_PORT, ACTIVATE_ADAPTER_TO_CONFIG);
249
250		/* Test for an adapter in TEST mode. */
251		outw(ioport + EP_COMMAND, WINDOW_SELECT | 0);
252		data = inw(ioport + EP_W0_EEPROM_COMMAND);
253		if (data & EEPROM_TST_MODE) {
254			device_printf(parent, "if_ep: Adapter at 0x%03x in TEST mode!  Erase pencil mark.\n",
255			  	      ioport);
256			continue;
257		}
258
259		child = BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, "ep", -1);
260		device_set_desc_copy(child, desc);
261		device_set_driver(child, driver);
262		bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
263		bus_set_resource(child, SYS_RES_IOPORT, 0, ioport, EP_IOSIZE);
264
265		if (bootverbose) {
266			device_printf(parent, "if_ep: <%s> at port 0x%03x-0x%03x irq %d\n",
267					desc, ioport, ioport + EP_IOSIZE, irq);
268		}
269
270		found++;
271	}
272
273	return;
274}
275
276static int
277ep_isa_probe (device_t dev)
278{
279	int	error = 0;
280
281	/* Check isapnp ids */
282	error = ISA_PNP_PROBE(device_get_parent(dev), dev, ep_ids);
283
284	/* If the card had a PnP ID that didn't match any we know about */
285	if (error == ENXIO) {
286	       return (error);
287	}
288
289	/* If we had some other problem. */
290	if (!(error == 0 || error == ENOENT)) {
291		return (error);
292	}
293
294	/* If we have the resources we need then we're good to go. */
295	if ((bus_get_resource_start(dev, SYS_RES_IOPORT, 0) != 0) &&
296	    (bus_get_resource_start(dev, SYS_RES_IRQ, 0) != 0)) {
297		return (0);
298	}
299
300	return (ENXIO);
301}
302
303static int
304ep_isa_attach (device_t dev)
305{
306	struct ep_softc *	sc = device_get_softc(dev);
307	int			error = 0;
308
309	if ((error = ep_alloc(dev))) {
310		device_printf(dev, "ep_alloc() failed! (%d)\n", error);
311		goto bad;
312	}
313
314	ep_get_media(sc);
315
316	GO_WINDOW(0);
317	SET_IRQ(BASE, rman_get_start(sc->irq));
318
319	if ((error = ep_attach(sc))) {
320		device_printf(dev, "ep_attach() failed! (%d)\n", error);
321		goto bad;
322	}
323
324	if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET, ep_intr,
325				   sc, &sc->ep_intrhand))) {
326		device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
327		goto bad;
328	}
329
330	return (0);
331bad:
332	ep_free(dev);
333	return (error);
334}
335
336static device_method_t ep_isa_methods[] = {
337	/* Device interface */
338	DEVMETHOD(device_identify,	ep_isa_identify),
339	DEVMETHOD(device_probe,		ep_isa_probe),
340	DEVMETHOD(device_attach,	ep_isa_attach),
341
342	{ 0, 0 }
343};
344
345static driver_t ep_isa_driver = {
346	"ep",
347	ep_isa_methods,
348	sizeof(struct ep_softc),
349};
350
351extern devclass_t ep_devclass;
352
353DRIVER_MODULE(ep, isa, ep_isa_driver, ep_devclass, 0, 0);
354