sys/dev/isa/if_ep_isa.c

   1 /*      $NetBSD: if_ep_isa.c,v 1.43 2008/08/27 05:33:47 christos Exp $  */
   2
   3 /*-
   4  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
   9  * NASA Ames Research Center.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * Copyright (c) 1997 Jonathan Stone <jonathan@NetBSD.org>
  35  * Copyright (c) 1994 Herb Peyerl <hpeyerl@beer.org>
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by Herb Peyerl.
  49  * 4. The name of Herb Peyerl may not be used to endorse or promote products
  50  *    derived from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  55  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  56  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  57  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  61  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62  */
  63
  64 #include <sys/cdefs.h>
  65 __KERNEL_RCSID(0, "$NetBSD: if_ep_isa.c,v 1.43 2008/08/27 05:33:47 christos Exp $");
  66
  67 #include <sys/param.h>
  68 #include <sys/systm.h>
  69 #include <sys/mbuf.h>
  70 #include <sys/socket.h>
  71 #include <sys/ioctl.h>
  72 #include <sys/errno.h>
  73 #include <sys/syslog.h>
  74 #include <sys/select.h>
  75 #include <sys/device.h>
  76 #include <sys/queue.h>
  77
  78 #include <net/if.h>
  79 #include <net/if_dl.h>
  80 #include <net/if_ether.h>
  81 #include <net/if_media.h>
  82
  83 #include <sys/cpu.h>
  84 #include <sys/bus.h>
  85 #include <sys/intr.h>
  86
  87 #include <dev/mii/miivar.h>
  88
  89 #include <dev/ic/elink3var.h>
  90 #include <dev/ic/elink3reg.h>
  91
  92 #include <dev/isa/isavar.h>
  93 #include <dev/isa/elink.h>
  94
  95 int ep_isa_probe(device_t , cfdata_t , void *);
  96 void ep_isa_attach(device_t , device_t , void *);
  97
  98 CFATTACH_DECL_NEW(ep_isa, sizeof(struct ep_softc),
  99     ep_isa_probe, ep_isa_attach, NULL, NULL);
 100
 101 static  void epaddcard(int, int, int, int);
 102
 103 /*
 104  * This keeps track of which ISAs have been through an ep probe sequence.
 105  * A simple static variable isn't enough, since it's conceivable that
 106  * a system might have more than one ISA bus.
 107  *
 108  * The "er_bus" member is the unit number of the parent ISA bus, e.g. "0"
 109  * for "isa0".
 110  */
 111 struct ep_isa_done_probe {
 112         LIST_ENTRY(ep_isa_done_probe)   er_link;
 113         int                             er_bus;
 114 };
 115 static LIST_HEAD(, ep_isa_done_probe) ep_isa_all_probes;
 116 static int ep_isa_probes_initialized;
 117
 118 #define MAXEPCARDS      20      /* if you have more than 20, you lose */
 119
 120 static struct epcard {
 121         int     bus;
 122         int     iobase;
 123         int     irq;
 124         char    available;
 125         long    model;
 126 } epcards[MAXEPCARDS];
 127 static int nepcards;
 128
 129 static void
 130 epaddcard(int bus, int iobase, int irq, int model)
 131 {
 132
 133         if (nepcards >= MAXEPCARDS)
 134                 return;
 135         epcards[nepcards].bus = bus;
 136         epcards[nepcards].iobase = iobase;
 137         epcards[nepcards].irq = (irq == 2) ? 9 : irq;
 138         epcards[nepcards].model = model;
 139         epcards[nepcards].available = 1;
 140         nepcards++;
 141 }
 142
 143 /*
 144  * 3c509 cards on the ISA bus are probed in ethernet address order.
 145  * The probe sequence requires careful orchestration, and we'd like
 146  * like to allow the irq and base address to be wildcarded. So, we
 147  * probe all the cards the first time epprobe() is called. On subsequent
 148  * calls we look for matching cards.
 149  */
 150 int
 151 ep_isa_probe(device_t parent, cfdata_t match, void *aux)
 152 {
 153         struct isa_attach_args *ia = aux;
 154         bus_space_tag_t iot = ia->ia_iot;
 155         bus_space_handle_t ioh;
 156         int slot, iobase, irq, i;
 157         u_int16_t vendor, model, eeprom_addr_cfg;
 158         struct ep_isa_done_probe *er;
 159         int bus = device_unit(parent);
 160
 161         if (ISA_DIRECT_CONFIG(ia))
 162                 return (0);
 163
 164         if (ep_isa_probes_initialized == 0) {
 165                 LIST_INIT(&ep_isa_all_probes);
 166                 ep_isa_probes_initialized = 1;
 167         }
 168
 169         /*
 170          * Probe this bus if we haven't done so already.
 171          */
 172         for (er = ep_isa_all_probes.lh_first; er != NULL;
 173             er = er->er_link.le_next)
 174                 if (er->er_bus == device_unit(parent))
 175                         goto bus_probed;
 176
 177         /*
 178          * Mark this bus so we don't probe it again.
 179          */
 180         er = (struct ep_isa_done_probe *)
 181             malloc(sizeof(struct ep_isa_done_probe), M_DEVBUF, M_NOWAIT);
 182         if (er == NULL)
 183                 panic("ep_isa_probe: can't allocate state storage");
 184
 185         er->er_bus = bus;
 186         LIST_INSERT_HEAD(&ep_isa_all_probes, er, er_link);
 187
 188         /*
 189          * Map the Etherlink ID port for the probe sequence.
 190          */
 191         if (bus_space_map(iot, ELINK_ID_PORT, 1, 0, &ioh)) {
 192                 printf("ep_isa_probe: can't map Etherlink ID port\n");
 193                 return 0;
 194         }
 195
 196         for (slot = 0; slot < MAXEPCARDS; slot++) {
 197                 elink_reset(iot, ioh, device_unit(parent));
 198                 elink_idseq(iot, ioh, ELINK_509_POLY);
 199
 200                 /* Untag all the adapters so they will talk to us. */
 201                 if (slot == 0)
 202                         bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 0);
 203
 204                 vendor = bswap16(epreadeeprom(iot, ioh, EEPROM_MFG_ID));
 205                 if (vendor != MFG_ID)
 206                         continue;
 207
 208                 model = bswap16(epreadeeprom(iot, ioh, EEPROM_PROD_ID));
 209                 /*
 210                  * XXX: Add a new product id to check for other cards
 211                  * (3c515?) and fix the check in ep_isa_attach.
 212                  */
 213                 if ((model & 0xfff0) != PROD_ID_3C509) {
 214 #ifndef trusted
 215                         printf(
 216                          "ep_isa_probe: ignoring model %04x\n", model);
 217 #endif
 218                         continue;
 219                         }
 220
 221                 eeprom_addr_cfg = epreadeeprom(iot, ioh, EEPROM_ADDR_CFG);
 222                 iobase = (eeprom_addr_cfg & 0x1f) * 0x10 + 0x200;
 223
 224                 irq = epreadeeprom(iot, ioh, EEPROM_RESOURCE_CFG);
 225                 irq >>= 12;
 226
 227                 /* XXX Should ignore card if non-ISA(EISA) io address? -chb */
 228
 229                 /*
 230                  * Don't attach a 3c509 in PnP mode.
 231                  * PnP mode was added with the 3C509B.
 232                  * Check some EEPROM registers to make sure this is really
 233                  * a 3C509B and test whether it is in PnP mode.
 234                  */
 235                 if ((model & 0xfff0) == PROD_ID_3C509) {
 236                         u_int16_t cksum, eepromrev, eeprom_cap, eeprom_hi;
 237
 238
 239                         /*
 240                          * Fetch all the info we need to ascertain whether
 241                          * the card is  PnP capable and in PnP mode.
 242                          * Skip over PnP cards.
 243                          */
 244
 245                         /* secondary configurable data checksum */
 246                         cksum = epreadeeprom(iot, ioh, EEPROM_CHECKSUM_EL3)
 247                             & 0xFF;
 248                         for (i = EEPROM_CONFIG_HIGH;
 249                             i < EEPROM_CHECKSUM_EL3; i++) {
 250                                 cksum ^= epreadeeprom(iot, ioh, i);
 251                         }
 252                         cksum = (cksum & 0xFF) ^ ((cksum >> 8) & 0xFF);
 253
 254                         eepromrev = epreadeeprom(iot, ioh, EEPROM_SSI);
 255                         eeprom_hi = epreadeeprom(iot, ioh, EEPROM_CONFIG_HIGH);
 256                         eeprom_cap = epreadeeprom(iot, ioh, EEPROM_CAP);
 257
 258                         /*
 259                          * Stop card responding to contention in future.
 260                          * (NB: stops rsponse to all reads from ID port.)
 261                          */
 262                         bus_space_write_1(iot, ioh, 0, TAG_ADAPTER + 1);
 263
 264                         if (cksum != 0) {
 265 #if 0
 266                                 printf("ep_isa_probe: cksum mismatch 0x%02x\n",
 267                                     (int)cksum);
 268 #endif
 269                         }
 270                         else if ((eepromrev & 0xF) < 1) {
 271                                 /* 3C509B is adapter revision level 1. */
 272 #if 0
 273                                 printf("ep_isa_probe: revision level 0\n");
 274 #endif
 275                         }
 276                         else if (eeprom_cap != 0x2083) {
 277 #if 0
 278                                 printf("ep_isa_probe: capabilities word mismatch0x%03x\n",
 279                                     (int)epreadeeprom(iot, ioh, EEPROM_CAP));
 280 #endif
 281                         }
 282                         else
 283                           /*
 284                            * we have a 3c509B with PnP capabilities.
 285                            * Test partly documented bits which toggle when
 286                            * in PnP mode.
 287                            */
 288                         if ((eeprom_hi & 0x8) != 0 || ((eeprom_hi & 0xc) == 0 &&
 289                             (eeprom_addr_cfg & 0x80) != 0)) {
 290                                 printf("3COM 3C509B Ethernet card in PnP mode\n");
 291                                 continue;
 292                         }
 293                 }
 294
 295                 /*
 296                  * XXX: this should probably not be done here
 297                  * because it enables the drq/irq lines from
 298                  * the board. Perhaps it should be done after
 299                  * we have checked for irq/drq collisions?
 300                  *
 301                  * According to the 3COM docs, this does not enable
 302                  * the irq lines. -chb
 303                  */
 304                 bus_space_write_1(iot, ioh, 0, ACTIVATE_ADAPTER_TO_CONFIG);
 305
 306                 epaddcard(bus, iobase, irq, model);
 307         }
 308         /* XXX should we sort by ethernet address? */
 309
 310         bus_space_unmap(iot, ioh, 1);
 311
 312 bus_probed:
 313
 314         if (ia->ia_nio < 1)
 315                 return (0);
 316         if (ia->ia_nirq < 1)
 317                 return (0);
 318
 319         for (i = 0; i < nepcards; i++) {
 320                 if (epcards[i].bus != bus)
 321                         continue;
 322                 if (epcards[i].available == 0)
 323                         continue;
 324
 325                 if (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
 326                     ia->ia_io[0].ir_addr != epcards[i].iobase)
 327                         continue;
 328
 329                 if (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ &&
 330                     ia->ia_irq[0].ir_irq != epcards[i].irq)
 331                         continue;
 332
 333                 goto good;
 334         }
 335         return 0;
 336
 337 good:
 338         epcards[i].available = 0;
 339
 340         ia->ia_nio = 1;
 341         ia->ia_io[0].ir_addr = epcards[i].iobase;
 342         ia->ia_io[0].ir_size = 0x10;
 343
 344         ia->ia_nirq = 1;
 345         ia->ia_irq[0].ir_irq = epcards[i].irq;
 346
 347         ia->ia_niomem = 0;
 348         ia->ia_ndrq = 0;
 349
 350         ia->ia_aux = (void *)epcards[i].model;
 351         return 1;
 352 }
 353
 354 void
 355 ep_isa_attach(device_t parent, device_t self, void *aux)
 356 {
 357         struct ep_softc *sc = device_private(self);
 358         struct isa_attach_args *ia = aux;
 359         bus_space_tag_t iot = ia->ia_iot;
 360         bus_space_handle_t ioh;
 361         int chipset;
 362
 363         /* Map i/o space. */
 364         if (bus_space_map(iot, ia->ia_io[0].ir_addr, 0x10, 0, &ioh)) {
 365                 printf(": can't map i/o space\n");
 366                 return;
 367         }
 368
 369         sc->sc_dev = self;
 370         sc->sc_iot = iot;
 371         sc->sc_ioh = ioh;
 372         sc->bustype = ELINK_BUS_ISA;
 373
 374         sc->enable = NULL;
 375         sc->disable = NULL;
 376         sc->enabled = 1;
 377
 378         chipset = (int)(long)ia->ia_aux;
 379         if ((chipset & 0xfff0) == PROD_ID_3C509) {
 380                 printf(": 3Com 3C509 Ethernet\n");
 381                 epconfig(sc, ELINK_CHIPSET_3C509, NULL);
 382         } else {
 383                 /*
 384                  * XXX: Maybe a 3c515, but the check in ep_isa_probe looks
 385                  * at the moment only for a 3c509.
 386                  */
 387                 printf(": unknown 3Com Ethernet card: %04x\n", chipset);
 388                 return;
 389         }
 390
 391         sc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
 392             IST_EDGE, IPL_NET, epintr, sc);
 393 }