2 * Copyright (c) 1994 Herb Peyerl <hpeyerl@novatel.ca>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/socket.h>
38 #include <sys/module.h>
41 #include <machine/bus.h>
42 #include <machine/resource.h>
46 #include <net/if_arp.h>
47 #include <net/if_media.h>
49 #include <isa/isavar.h>
51 #include <dev/ep/if_epreg.h>
52 #include <dev/ep/if_epvar.h>
55 #include <i386/isa/elink.h>
59 static uint16_t get_eeprom_data(int, int);
60 static void ep_isa_identify(driver_t *, device_t);
63 static int ep_isa_probe(device_t);
64 static int ep_isa_attach(device_t);
65 static int ep_eeprom_cksum(struct ep_softc *);
71 const char *ep_isa_match_id(uint32_t, struct isa_ident *);
73 #define ISA_ID_3C509_XXX 0x0506d509
74 #define ISA_ID_3C509_TP 0x506d5090
75 #define ISA_ID_3C509_BNC 0x506d5091
76 #define ISA_ID_3C509_COMBO 0x506d5094
77 #define ISA_ID_3C509_TPO 0x506d5095
78 #define ISA_ID_3C509_TPC 0x506d5098
81 static struct isa_ident ep_isa_devs[] = {
82 {ISA_ID_3C509_TP, "3Com 3C509-TP EtherLink III"},
83 {ISA_ID_3C509_BNC, "3Com 3C509-BNC EtherLink III"},
84 {ISA_ID_3C509_COMBO, "3Com 3C509-Combo EtherLink III"},
85 {ISA_ID_3C509_TPO, "3Com 3C509-TPO EtherLink III"},
86 {ISA_ID_3C509_TPC, "3Com 3C509-TPC EtherLink III"},
91 static struct isa_pnp_id ep_ids[] = {
92 {0x90506d50, "3Com 3C509B-TP EtherLink III (PnP)"}, /* TCM5090 */
93 {0x91506d50, "3Com 3C509B-BNC EtherLink III (PnP)"}, /* TCM5091 */
94 {0x94506d50, "3Com 3C509B-Combo EtherLink III (PnP)"}, /* TCM5094 */
95 {0x95506d50, "3Com 3C509B-TPO EtherLink III (PnP)"}, /* TCM5095 */
96 {0x98506d50, "3Com 3C509B-TPC EtherLink III (PnP)"}, /* TCM5098 */
97 {0xf780d041, NULL}, /* PNP80f7 */
102 * We get eeprom data from the id_port given an offset into the eeprom.
103 * Basically; after the ID_sequence is sent to all of the cards; they enter
104 * the ID_CMD state where they will accept command requests. 0x80-0xbf loads
105 * the eeprom data. We then read the port 16 times and with every read; the
106 * cards check for contention (ie: if one card writes a 0 bit and another
107 * writes a 1 bit then the host sees a 0. At the end of the cycle; each card
108 * compares the data on the bus; if there is a difference then that card goes
109 * into ID_WAIT state again). In the meantime; one bit of data is returned in
110 * the AX register which is conveniently returned to us by inb(). Hence; we
111 * read 16 times getting one bit of data with each read.
115 get_eeprom_data(int id_port, int offset)
120 outb(id_port, EEPROM_CMD_RD | offset);
121 DELAY(BIT_DELAY_MULTIPLE * 1000);
122 for (i = 0; i < 16; i++) {
124 data = (data << 1) | (inw(id_port) & 1);
131 ep_isa_match_id(uint32_t id, struct isa_ident *isa_devs)
133 struct isa_ident *i = isa_devs;
135 while (i->name != NULL) {
141 * If we see a card that is likely to be a 3c509
142 * return something so that it will work; be annoying
143 * so that the user will tell us about it though.
145 if ((id >> 4) == ISA_ID_3C509_XXX)
146 return ("Unknown 3c509; notify maintainer!");
152 ep_isa_identify(driver_t * driver, device_t parent)
154 int tag = EP_LAST_TAG;
165 outb(ELINK_ID_PORT, 0);
166 outb(ELINK_ID_PORT, 0);
167 elink_idseq(ELINK_509_POLY);
170 DELAY(DELAY_MULTIPLE * 10000);
172 for (i = 0; i < EP_MAX_BOARDS; i++) {
174 outb(ELINK_ID_PORT, 0);
175 outb(ELINK_ID_PORT, 0);
176 elink_idseq(ELINK_509_POLY);
180 * For the first probe, clear all board's tag registers.
181 * Otherwise kill off already-found boards. -- linux 3c509.c
184 outb(ELINK_ID_PORT, 0xd0);
186 outb(ELINK_ID_PORT, 0xd8);
188 /* Get out of loop if we're out of cards. */
189 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
192 /* resolve contention using the Ethernet address */
193 for (j = 0; j < 3; j++)
194 (void)get_eeprom_data(ELINK_ID_PORT, j);
197 * Construct an 'isa_id' in 'EISA' format.
199 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
200 isa_id = (htons(data) << 16);
201 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_PROD_ID);
202 isa_id |= htons(data);
204 /* Find known ISA boards */
205 desc = ep_isa_match_id(isa_id, ep_isa_devs);
208 device_printf(parent,
209 "unknown ID 0x%08x\n", isa_id);
213 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_RESOURCE_CFG);
216 /* Retreive IOPORT */
217 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_ADDR_CFG);
218 ioport = (((data & ADDR_CFG_MASK) << 4) + 0x200);
220 if ((data & ADDR_CFG_MASK) == ADDR_CFG_EISA) {
221 device_printf(parent,
222 "<%s> at port 0x%03x in EISA mode, ignoring!\n",
225 * Set the adaptor tag so that the next card can be
228 outb(ELINK_ID_PORT, tag--);
231 /* Test for an adapter with PnP support. */
232 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_CAP);
233 if (data == CAP_ISA) {
234 data = get_eeprom_data(ELINK_ID_PORT,
235 EEPROM_INT_CONFIG_1);
236 if (data & ICW1_IAS_PNP) {
238 device_printf(parent,
243 * Set the adaptor tag so that the next card
246 outb(ELINK_ID_PORT, tag--);
250 /* Set the adaptor tag so that the next card can be found. */
251 outb(ELINK_ID_PORT, tag--);
253 /* Activate the adaptor at the EEPROM location. */
254 outb(ELINK_ID_PORT, ACTIVATE_ADAPTER_TO_CONFIG);
256 /* Test for an adapter in TEST mode. */
257 outw(ioport + EP_COMMAND, WINDOW_SELECT | 0);
258 data = inw(ioport + EP_W0_EEPROM_COMMAND);
259 if (data & EEPROM_TST_MODE) {
260 device_printf(parent,
261 "<%s> at port 0x%03x in TEST mode!"
262 " Erase pencil mark.\n",
266 child = BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, "ep", -1);
267 device_set_desc_copy(child, desc);
268 device_set_driver(child, driver);
269 bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
270 bus_set_resource(child, SYS_RES_IOPORT, 0, ioport, EP_IOSIZE);
273 device_printf(parent,
275 " at port 0x%03x-0x%03x irq %d\n",
276 desc, ioport, ioport + EP_IOSIZE, irq);
283 ep_isa_probe(device_t dev)
287 /* Check isapnp ids */
288 error = ISA_PNP_PROBE(device_get_parent(dev), dev, ep_ids);
290 /* If the card had a PnP ID that didn't match any we know about */
294 /* If we had some other problem. */
295 if (!(error == 0 || error == ENOENT))
298 /* If we have the resources we need then we're good to go. */
299 if ((bus_get_resource_start(dev, SYS_RES_IOPORT, 0) != 0) &&
300 (bus_get_resource_start(dev, SYS_RES_IRQ, 0) != 0))
307 ep_isa_attach(device_t dev)
309 struct ep_softc *sc = device_get_softc(dev);
312 if ((error = ep_alloc(dev)))
317 SET_IRQ(sc, rman_get_start(sc->irq));
319 if ((error = ep_attach(sc)))
321 error = ep_eeprom_cksum(sc);
323 device_printf(sc->dev, "Invalid EEPROM checksum!\n");
326 if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET | INTR_MPSAFE,
327 NULL, ep_intr, sc, &sc->ep_intrhand))) {
328 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
338 ep_eeprom_cksum(struct ep_softc *sc)
344 uint8_t cksum_high = 0;
345 uint8_t cksum_low = 0;
347 error = ep_get_e(sc, 0x0f, &val);
352 for (i = 0; i < 0x0f; i++) {
353 error = ep_get_e(sc, i, &val);
360 cksum_low ^= (uint8_t) (val & 0x00ff) ^
361 (uint8_t)((val & 0xff00) >> 8);
364 cksum_high ^= (uint8_t) (val & 0x00ff) ^
365 (uint8_t)((val & 0xff00) >> 8);
369 return (cksum != ((uint16_t)cksum_low | (uint16_t)(cksum_high << 8)));
372 static device_method_t ep_isa_methods[] = {
373 /* Device interface */
375 DEVMETHOD(device_identify, ep_isa_identify),
377 DEVMETHOD(device_probe, ep_isa_probe),
378 DEVMETHOD(device_attach, ep_isa_attach),
379 DEVMETHOD(device_detach, ep_detach),
384 static driver_t ep_isa_driver = {
387 sizeof(struct ep_softc),
390 extern devclass_t ep_devclass;
392 DRIVER_MODULE(ep, isa, ep_isa_driver, ep_devclass, 0, 0);
394 MODULE_DEPEND(ep, elink, 1, 1, 1);