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.12 2006/08/06 12:49:05 swildner 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(int id_port, int offset)
 112 {
 113         int             i;
 114         u_int16_t       data = 0;
 115
 116         outb(id_port, EEPROM_CMD_RD|offset);
 117         DELAY(BIT_DELAY_MULTIPLE * 1000);
 118         for (i = 0; i < 16; i++) {
 119                 DELAY(50);
 120                 data = (data << 1) | (inw(id_port) & 1);
 121         }
 122         return (data);
 123 }
 124
 125 const char *
 126 ep_isa_match_id(u_int32_t id, struct isa_ident *isa_devs)
 127 {
 128         struct isa_ident *      i = isa_devs;
 129         while(i->name != NULL) {
 130                if (id == i->id)
 131                       return (i->name);
 132                i++;
 133         }
 134         /*
 135          * If we see a card that is likely to be a 3c509
 136          * return something so that it will work; be annoying
 137          * so that the user will tell us about it though.
 138          */
 139         if ((id >> 4) == ISA_ID_3C509_XXX) {
 140                 return ("Unknown 3c509; notify maintainer!");
 141         }
 142         return (NULL);
 143 }
 144
 145 static int
 146 ep_isa_identify(driver_t *driver, device_t parent)
 147 {
 148         int             tag = EP_LAST_TAG;
 149         int             found = 0;
 150         int             i;
 151         int             j;
 152         const char *    desc;
 153         u_int16_t       data;
 154         u_int32_t       irq;
 155         u_int32_t       ioport;
 156         u_int32_t       isa_id;
 157         device_t        child;
 158
 159         /*
 160          * Rescans not currently supported.
 161          */
 162         if (device_get_state(parent) == DS_ATTACHED)
 163                 return (0);
 164
 165         /*
 166          * Check for the existance of the EISA bus.
 167          */
 168         outb(ELINK_ID_PORT, 0);
 169         outb(ELINK_ID_PORT, 0);
 170         elink_idseq(ELINK_509_POLY);
 171         elink_reset();
 172
 173         DELAY(DELAY_MULTIPLE * 10000);
 174
 175         for (i = 0; i < EP_MAX_BOARDS; i++) {
 176
 177                 outb(ELINK_ID_PORT, 0);
 178                 outb(ELINK_ID_PORT, 0);
 179                 elink_idseq(ELINK_509_POLY);
 180                 DELAY(400);
 181
 182                 /* For the first probe, clear all
 183                  * board's tag registers.
 184                  * Otherwise kill off already-found
 185                  * boards. -- linux 3c509.c
 186                  */
 187                 if (i == 0) {
 188                         outb(ELINK_ID_PORT, 0xd0);
 189                 } else {
 190                         outb(ELINK_ID_PORT, 0xd8);
 191                 }
 192
 193                 /* Get out of loop if we're out of cards. */
 194                 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
 195                 if (data != MFG_ID) {
 196                         break;
 197                 }
 198
 199                 /* resolve contention using the Ethernet address */
 200                 for (j = 0; j < 3; j++) {
 201                         get_eeprom_data(ELINK_ID_PORT, j);
 202                 }
 203
 204                 /*
 205                  * Construct an 'isa_id' in 'EISA'
 206                  * format.
 207                  */
 208                 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_MFG_ID);
 209                 isa_id = (htons(data) << 16);
 210                 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_PROD_ID);
 211                 isa_id |= htons(data);
 212
 213                 /* Find known ISA boards */
 214                 desc = ep_isa_match_id(isa_id, ep_isa_devs);
 215                 if (!desc) {
 216                         if (bootverbose) {
 217                                 device_printf(parent, "if_ep: unknown ID 0x%08x\n",
 218                                                 isa_id);
 219                         }
 220                         continue;
 221                 }
 222
 223                 /* Retreive IRQ */
 224                 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_RESOURCE_CFG);
 225                 irq = (data >> 12);
 226
 227                 /* Retreive IOPORT */
 228                 data = get_eeprom_data(ELINK_ID_PORT, EEPROM_ADDR_CFG);
 229                 ioport = (((data & 0x1f) << 4) + 0x200);
 230
 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, EEPROM_INT_CONFIG_1);
 235                         if (data & ICW1_IAS_PNP) {
 236                                 if (bootverbose) {
 237                                         device_printf(parent, "if_ep: <%s> at 0x%03x in PnP mode!\n",
 238                                                       desc, ioport);
 239                                 }
 240                                 /* Set the adaptor tag so that the next card can be found. */
 241                                 outb(ELINK_ID_PORT, tag--);
 242                                 continue;
 243                         }
 244                 }
 245
 246                 /* Set the adaptor tag so that the next card can be found. */
 247                 outb(ELINK_ID_PORT, tag--);
 248
 249                 /* Activate the adaptor at the EEPROM location. */
 250                 outb(ELINK_ID_PORT, ACTIVATE_ADAPTER_TO_CONFIG);
 251
 252                 /* Test for an adapter in TEST mode. */
 253                 outw(ioport + EP_COMMAND, WINDOW_SELECT | 0);
 254                 data = inw(ioport + EP_W0_EEPROM_COMMAND);
 255                 if (data & EEPROM_TST_MODE) {
 256                         device_printf(parent, "if_ep: <%s> at port 0x%03x in TEST mode!  Erase pencil mark.\n",
 257                                         desc, ioport);
 258                         continue;
 259                 }
 260
 261                 child = BUS_ADD_CHILD(parent, parent,
 262                                       ISA_ORDER_SPECULATIVE, "ep", -1);
 263                 device_set_desc_copy(child, desc);
 264                 device_set_driver(child, driver);
 265                 bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
 266                 bus_set_resource(child, SYS_RES_IOPORT, 0, ioport, EP_IOSIZE);
 267
 268                 if (bootverbose) {
 269                         device_printf(parent, "if_ep: <%s> at port 0x%03x-0x%03x irq %d\n",
 270                                         desc, ioport, ioport + EP_IOSIZE, irq);
 271                 }
 272
 273                 found++;
 274         }
 275         return (found ? 0 : ENXIO);
 276 }
 277
 278 static int
 279 ep_isa_probe(device_t dev)
 280 {
 281         int     error = 0;
 282
 283         /* Check isapnp ids */
 284         error = ISA_PNP_PROBE(device_get_parent(dev), dev, ep_ids);
 285
 286         /* If the card had a PnP ID that didn't match any we know about */
 287         if (error == ENXIO) {
 288                return (error);
 289         }
 290
 291         /* If we had some other problem. */
 292         if (!(error == 0 || error == ENOENT)) {
 293                 return (error);
 294         }
 295
 296         /* If we have the resources we need then we're good to go. */
 297         if ((bus_get_resource_start(dev, SYS_RES_IOPORT, 0) != 0) &&
 298             (bus_get_resource_start(dev, SYS_RES_IRQ, 0) != 0)) {
 299                 return (0);
 300         }
 301
 302         return (ENXIO);
 303 }
 304
 305 static int
 306 ep_isa_attach(device_t dev)
 307 {
 308         struct ep_softc *       sc = device_get_softc(dev);
 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_NETSAFE, ep_intr,
 327                                sc, &sc->ep_intrhand,
 328                                sc->arpcom.ac_if.if_serializer);
 329         if (error) {
 330                 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
 331                 goto bad;
 332         }
 333
 334         return (0);
 335 bad:
 336         ep_free(dev);
 337         return (error);
 338 }
 339
 340 static device_method_t ep_isa_methods[] = {
 341         /* Device interface */
 342         DEVMETHOD(device_identify,      ep_isa_identify),
 343         DEVMETHOD(device_probe,         ep_isa_probe),
 344         DEVMETHOD(device_attach,        ep_isa_attach),
 345
 346         { 0, 0 }
 347 };
 348
 349 static driver_t ep_isa_driver = {
 350         "ep",
 351         ep_isa_methods,
 352         sizeof(struct ep_softc),
 353 };
 354
 355 extern devclass_t ep_devclass;
 356
 357 DRIVER_MODULE(if_ep, isa, ep_isa_driver, ep_devclass, 0, 0);