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