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