sys/dev/netif/lnc/if_lnc_isa.c

   1 /*      $NetBSD: if_le_isa.c,v 1.41 2005/12/24 20:27:41 perry Exp $     */
   2 /*      $FreeBSD: src/sys/dev/le/if_le_isa.c,v 1.1 2006/05/17 21:25:22 marius Exp $     */
   3
   4 /*-
   5  * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to The NetBSD Foundation
   9  * by Charles M. Hannum and by Jason R. Thorpe of the Numerical Aerospace
  10  * Simulation Facility, NASA Ames Research Center.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the NetBSD
  23  *      Foundation, Inc. and its contributors.
  24  * 4. Neither the name of The NetBSD Foundation nor the names of its
  25  *    contributors may be used to endorse or promote products derived
  26  *    from this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 /*-
  42  * Copyright (c) 1992, 1993
  43  *      The Regents of the University of California.  All rights reserved.
  44  *
  45  * This code is derived from software contributed to Berkeley by
  46  * Ralph Campbell and Rick Macklem.
  47  *
  48  * Redistribution and use in source and binary forms, with or without
  49  * modification, are permitted provided that the following conditions
  50  * are met:
  51  * 1. Redistributions of source code must retain the above copyright
  52  *    notice, this list of conditions and the following disclaimer.
  53  * 2. Redistributions in binary form must reproduce the above copyright
  54  *    notice, this list of conditions and the following disclaimer in the
  55  *    documentation and/or other materials provided with the distribution.
  56  * 3. Neither the name of the University nor the names of its contributors
  57  *    may be used to endorse or promote products derived from this software
  58  *    without specific prior written permission.
  59  *
  60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  70  * SUCH DAMAGE.
  71  *
  72  *      @(#)if_le.c     8.2 (Berkeley) 11/16/93
  73  */
  74
  75 #include <sys/param.h>
  76 #include <sys/systm.h>
  77 #include <sys/bus.h>
  78 #include <sys/endian.h>
  79 #include <sys/kernel.h>
  80 #include <sys/interrupt.h>
  81 #include <sys/lock.h>
  82 #include <sys/module.h>
  83 #include <sys/resource.h>
  84 #include <sys/rman.h>
  85 #include <sys/socket.h>
  86
  87 #include <net/ethernet.h>
  88 #include <net/if.h>
  89 #include <net/if_media.h>
  90 #include <net/if_arp.h>
  91 #include <net/ifq_var.h>
  92
  93 #include <bus/isa/isavar.h>
  94
  95 #include <dev/netif/lnc/lancereg.h>
  96 #include <dev/netif/lnc/lancevar.h>
  97 #include <dev/netif/lnc/am7990var.h>
  98
  99 #define LE_ISA_MEMSIZE  (16*1024)
 100 #define PCNET_RDP       0x10
 101 #define PCNET_RAP       0x12
 102
 103 struct le_isa_softc {
 104         struct am7990_softc     sc_am7990;      /* glue to MI code */
 105
 106         bus_size_t              sc_rap;         /* offsets to LANCE... */
 107         bus_size_t              sc_rdp;         /* ...registers */
 108
 109         int                     sc_rrid;
 110         struct resource         *sc_rres;
 111         bus_space_tag_t         sc_regt;
 112         bus_space_handle_t      sc_regh;
 113
 114         int                     sc_drid;
 115         struct resource         *sc_dres;
 116
 117         int                     sc_irid;
 118         struct resource         *sc_ires;
 119         void                    *sc_ih;
 120
 121         bus_dma_tag_t           sc_pdmat;
 122         bus_dma_tag_t           sc_dmat;
 123         bus_dmamap_t            sc_dmam;
 124 };
 125
 126 static device_probe_t le_isa_probe;
 127 static device_attach_t le_isa_attach;
 128 static device_detach_t le_isa_detach;
 129 static device_resume_t le_isa_resume;
 130 static device_suspend_t le_isa_suspend;
 131
 132 static device_method_t le_isa_methods[] = {
 133         /* Device interface */
 134         DEVMETHOD(device_probe,         le_isa_probe),
 135         DEVMETHOD(device_attach,        le_isa_attach),
 136         DEVMETHOD(device_detach,        le_isa_detach),
 137         /* We can just use the suspend method here. */
 138         DEVMETHOD(device_shutdown,      le_isa_suspend),
 139         DEVMETHOD(device_suspend,       le_isa_suspend),
 140         DEVMETHOD(device_resume,        le_isa_resume),
 141
 142         DEVMETHOD_END
 143 };
 144
 145 DEFINE_CLASS_0(lnc, le_isa_driver, le_isa_methods, sizeof(struct le_isa_softc));
 146 DRIVER_MODULE(lnc, isa, le_isa_driver, le_devclass, NULL, NULL);
 147 MODULE_DEPEND(lnc, ether, 1, 1, 1);
 148
 149 static const struct le_isa_param {
 150         const char      *name;
 151         u_long          iosize;
 152         bus_size_t      rap;
 153         bus_size_t      rdp;
 154         bus_size_t      macstart;
 155         int             macstride;
 156 } le_isa_params[] = {
 157         { "BICC Isolan", 24, 0xe, 0xc, 0, 2 },
 158         { "Novell NE2100", 16, 0x12, 0x10, 0, 1 }
 159 };
 160
 161 static struct isa_pnp_id le_isa_ids[] = {
 162         { 0x0322690e, "Cabletron E2200 Single Chip" },  /* CSI2203 */
 163         { 0x0110490a, "Boca LANCard Combo" },           /* BRI1001 */
 164         { 0x0100a60a, "Melco Inc. LGY-IV" },            /* BUF0001 */
 165         { 0xd880d041, "Novell NE2100" },                /* PNP80D8 */
 166         { 0x0082d041, "Cabletron E2100 Series DNI" },   /* PNP8200 */
 167         { 0x3182d041, "AMD AM1500T/AM2100" },           /* PNP8231 */
 168         { 0x8c82d041, "AMD PCnet-ISA" },                /* PNP828C */
 169         { 0x8d82d041, "AMD PCnet-32" },                 /* PNP828D */
 170         { 0xcefaedfe, "Racal InterLan EtherBlaster" },  /* _WMFACE */
 171         { 0, NULL }
 172 };
 173
 174 static void le_isa_wrcsr(struct lance_softc *, uint16_t, uint16_t);
 175 static uint16_t le_isa_rdcsr(struct lance_softc *, uint16_t);
 176 static bus_dmamap_callback_t le_isa_dma_callback;
 177 static int le_isa_probe_legacy(device_t, const struct le_isa_param *);
 178
 179 static void
 180 le_isa_wrcsr(struct lance_softc *sc, uint16_t port, uint16_t val)
 181 {
 182         struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
 183
 184         bus_space_write_2(lesc->sc_regt, lesc->sc_regh, lesc->sc_rap, port);
 185         bus_space_barrier(lesc->sc_regt, lesc->sc_regh, lesc->sc_rap, 2,
 186             BUS_SPACE_BARRIER_WRITE);
 187         bus_space_write_2(lesc->sc_regt, lesc->sc_regh, lesc->sc_rdp, val);
 188 }
 189
 190 static uint16_t
 191 le_isa_rdcsr(struct lance_softc *sc, uint16_t port)
 192 {
 193         struct le_isa_softc *lesc = (struct le_isa_softc *)sc;
 194
 195         bus_space_write_2(lesc->sc_regt, lesc->sc_regh, lesc->sc_rap, port);
 196         bus_space_barrier(lesc->sc_regt, lesc->sc_regh, lesc->sc_rap, 2,
 197             BUS_SPACE_BARRIER_WRITE);
 198         return (bus_space_read_2(lesc->sc_regt, lesc->sc_regh, lesc->sc_rdp));
 199 }
 200
 201 static void
 202 le_isa_dma_callback(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
 203 {
 204         struct lance_softc *sc = (struct lance_softc *)xsc;
 205
 206         if (error != 0)
 207                 return;
 208         KASSERT(nsegs == 1, ("%s: bad DMA segment count", __func__));
 209         sc->sc_addr = segs[0].ds_addr;
 210 }
 211
 212 static int
 213 le_isa_probe_legacy(device_t dev, const struct le_isa_param *leip)
 214 {
 215         struct le_isa_softc *lesc;
 216         struct lance_softc *sc;
 217         int error;
 218
 219         lesc = device_get_softc(dev);
 220         sc = &lesc->sc_am7990.lsc;
 221
 222         lesc->sc_rrid = 0;
 223         lesc->sc_rres = bus_alloc_resource(dev, SYS_RES_IOPORT, &lesc->sc_rrid,
 224             0, ~0, leip->iosize, RF_ACTIVE);
 225         if (lesc->sc_rres == NULL)
 226                 return (ENXIO);
 227         lesc->sc_regt = rman_get_bustag(lesc->sc_rres);
 228         lesc->sc_regh = rman_get_bushandle(lesc->sc_rres);
 229         lesc->sc_rap = leip->rap;
 230         lesc->sc_rdp = leip->rdp;
 231
 232         /* Stop the chip and put it in a known state. */
 233         le_isa_wrcsr(sc, LE_CSR0, LE_C0_STOP);
 234         DELAY(100);
 235         if (le_isa_rdcsr(sc, LE_CSR0) != LE_C0_STOP) {
 236                 error = ENXIO;
 237                 goto fail;
 238         }
 239         le_isa_wrcsr(sc, LE_CSR3, 0);
 240         error = 0;
 241
 242  fail:
 243         bus_release_resource(dev, SYS_RES_IOPORT, lesc->sc_rrid, lesc->sc_rres);
 244         return (error);
 245 }
 246
 247 static int
 248 le_isa_probe(device_t dev)
 249 {
 250         int i;
 251
 252         switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
 253         case 0:
 254                 return (-20);
 255         case ENOENT:
 256                 for (i = 0; i < NELEM(le_isa_params); i++) {
 257                         if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
 258                                 device_set_desc(dev, le_isa_params[i].name);
 259                                 return (-20);
 260                         }
 261                 }
 262                 /* FALLTHROUGH */
 263         case ENXIO:
 264         default:
 265                 return (ENXIO);
 266         }
 267 }
 268
 269 static int
 270 le_isa_attach(device_t dev)
 271 {
 272         struct le_isa_softc *lesc;
 273         struct lance_softc *sc;
 274         bus_size_t macstart, rap, rdp;
 275         int error, i, macstride;
 276
 277         lesc = device_get_softc(dev);
 278         sc = &lesc->sc_am7990.lsc;
 279
 280         lesc->sc_rrid = 0;
 281         switch (ISA_PNP_PROBE(device_get_parent(dev), dev, le_isa_ids)) {
 282         case 0:
 283                 lesc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
 284                     &lesc->sc_rrid, RF_ACTIVE);
 285                 rap = PCNET_RAP;
 286                 rdp = PCNET_RDP;
 287                 macstart = 0;
 288                 macstride = 1;
 289                 break;
 290         case ENOENT:
 291                 for (i = 0; i < NELEM(le_isa_params); i++) {
 292                         if (le_isa_probe_legacy(dev, &le_isa_params[i]) == 0) {
 293                                 lesc->sc_rres = bus_alloc_resource(dev,
 294                                     SYS_RES_IOPORT, &lesc->sc_rrid, 0, ~0,
 295                                     le_isa_params[i].iosize, RF_ACTIVE);
 296                                 rap = le_isa_params[i].rap;
 297                                 rdp = le_isa_params[i].rdp;
 298                                 macstart = le_isa_params[i].macstart;
 299                                 macstride = le_isa_params[i].macstride;
 300                                 goto found;
 301                         }
 302                 }
 303                 /* FALLTHROUGH */
 304         case ENXIO:
 305         default:
 306                 device_printf(dev, "cannot determine chip\n");
 307                 error = ENXIO;
 308                 goto fail_mtx;
 309         }
 310
 311  found:
 312         if (lesc->sc_rres == NULL) {
 313                 device_printf(dev, "cannot allocate registers\n");
 314                 error = ENXIO;
 315                 goto fail_mtx;
 316         }
 317         lesc->sc_regt = rman_get_bustag(lesc->sc_rres);
 318         lesc->sc_regh = rman_get_bushandle(lesc->sc_rres);
 319         lesc->sc_rap = rap;
 320         lesc->sc_rdp = rdp;
 321
 322         lesc->sc_drid = 0;
 323         if ((lesc->sc_dres = bus_alloc_resource_any(dev, SYS_RES_DRQ,
 324             &lesc->sc_drid, RF_ACTIVE)) == NULL) {
 325                 device_printf(dev, "cannot allocate DMA channel\n");
 326                 error = ENXIO;
 327                 goto fail_rres;
 328         }
 329
 330         lesc->sc_irid = 0;
 331         if ((lesc->sc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ,
 332             &lesc->sc_irid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
 333                 device_printf(dev, "cannot allocate interrupt\n");
 334                 error = ENXIO;
 335                 goto fail_dres;
 336         }
 337
 338         error = bus_dma_tag_create(
 339             NULL,                       /* parent */
 340             1, 0,                       /* alignment, boundary */
 341             BUS_SPACE_MAXADDR_24BIT,    /* lowaddr */
 342             BUS_SPACE_MAXADDR,          /* highaddr */
 343             NULL, NULL,                 /* filter, filterarg */
 344             BUS_SPACE_MAXSIZE_32BIT,    /* maxsize */
 345             0,                          /* nsegments */
 346             BUS_SPACE_MAXSIZE_32BIT,    /* maxsegsize */
 347             BUS_DMA_WAITOK,             /* flags */
 348             &lesc->sc_pdmat);
 349         if (error != 0) {
 350                 device_printf(dev, "cannot allocate parent DMA tag\n");
 351                 goto fail_ires;
 352         }
 353
 354         sc->sc_memsize = LE_ISA_MEMSIZE;
 355         /*
 356          * For Am79C90, Am79C961 and Am79C961A the init block must be 2-byte
 357          * aligned and the ring descriptors must be 8-byte aligned.
 358          */
 359         error = bus_dma_tag_create(
 360             lesc->sc_pdmat,             /* parent */
 361             8, 0,                       /* alignment, boundary */
 362             BUS_SPACE_MAXADDR_24BIT,    /* lowaddr */
 363             BUS_SPACE_MAXADDR,          /* highaddr */
 364             NULL, NULL,                 /* filter, filterarg */
 365             sc->sc_memsize,             /* maxsize */
 366             1,                          /* nsegments */
 367             sc->sc_memsize,             /* maxsegsize */
 368             BUS_DMA_WAITOK,             /* flags */
 369             &lesc->sc_dmat);
 370         if (error != 0) {
 371                 device_printf(dev, "cannot allocate buffer DMA tag\n");
 372                 goto fail_pdtag;
 373         }
 374
 375         error = bus_dmamem_alloc(lesc->sc_dmat, (void **)&sc->sc_mem,
 376             BUS_DMA_WAITOK | BUS_DMA_COHERENT, &lesc->sc_dmam);
 377         if (error != 0) {
 378                 device_printf(dev, "cannot allocate DMA buffer memory\n");
 379                 goto fail_dtag;
 380         }
 381
 382         sc->sc_addr = 0;
 383         error = bus_dmamap_load(lesc->sc_dmat, lesc->sc_dmam, sc->sc_mem,
 384             sc->sc_memsize, le_isa_dma_callback, sc, 0);
 385         if (error != 0 || sc->sc_addr == 0) {
 386                 device_printf(dev, "cannot load DMA buffer map\n");
 387                 goto fail_dmem;
 388         }
 389
 390         isa_dmacascade(rman_get_start(lesc->sc_dres));
 391
 392         sc->sc_flags = 0;
 393         sc->sc_conf3 = 0;
 394
 395         /*
 396          * Extract the physical MAC address from the ROM.
 397          */
 398         for (i = 0; i < sizeof(sc->sc_enaddr); i++)
 399                 sc->sc_enaddr[i] =  bus_space_read_1(lesc->sc_regt,
 400                     lesc->sc_regh, macstart + i * macstride);
 401
 402         sc->sc_copytodesc = lance_copytobuf_contig;
 403         sc->sc_copyfromdesc = lance_copyfrombuf_contig;
 404         sc->sc_copytobuf = lance_copytobuf_contig;
 405         sc->sc_copyfrombuf = lance_copyfrombuf_contig;
 406         sc->sc_zerobuf = lance_zerobuf_contig;
 407
 408         sc->sc_rdcsr = le_isa_rdcsr;
 409         sc->sc_wrcsr = le_isa_wrcsr;
 410         sc->sc_hwreset = NULL;
 411         sc->sc_hwinit = NULL;
 412         sc->sc_hwintr = NULL;
 413         sc->sc_nocarrier = NULL;
 414         sc->sc_mediachange = NULL;
 415         sc->sc_mediastatus = NULL;
 416         sc->sc_supmedia = NULL;
 417
 418         error = am7990_config(&lesc->sc_am7990, device_get_name(dev),
 419             device_get_unit(dev));
 420         if (error != 0) {
 421                 device_printf(dev, "cannot attach Am7990\n");
 422                 goto fail_dmap;
 423         }
 424
 425         ifq_set_cpuid(&sc->ifp->if_snd, rman_get_cpuid(lesc->sc_ires));
 426
 427         error = bus_setup_intr(dev, lesc->sc_ires, INTR_MPSAFE,
 428             am7990_intr, sc, &lesc->sc_ih, sc->ifp->if_serializer);
 429         if (error != 0) {
 430                 device_printf(dev, "cannot set up interrupt\n");
 431                 goto fail_am7990;
 432         }
 433
 434         return (0);
 435
 436  fail_am7990:
 437         am7990_detach(&lesc->sc_am7990);
 438  fail_dmap:
 439         bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
 440  fail_dmem:
 441         bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
 442  fail_dtag:
 443         bus_dma_tag_destroy(lesc->sc_dmat);
 444  fail_pdtag:
 445         bus_dma_tag_destroy(lesc->sc_pdmat);
 446  fail_ires:
 447         bus_release_resource(dev, SYS_RES_IRQ, lesc->sc_irid, lesc->sc_ires);
 448  fail_dres:
 449         bus_release_resource(dev, SYS_RES_DRQ, lesc->sc_drid, lesc->sc_dres);
 450  fail_rres:
 451         bus_release_resource(dev, SYS_RES_IOPORT, lesc->sc_rrid, lesc->sc_rres);
 452  fail_mtx:
 453         return (error);
 454 }
 455
 456 static int
 457 le_isa_detach(device_t dev)
 458 {
 459         struct le_isa_softc *lesc;
 460         struct lance_softc *sc;
 461
 462         lesc = device_get_softc(dev);
 463         sc = &lesc->sc_am7990.lsc;
 464
 465         if (device_is_attached(dev)) {
 466                 lwkt_serialize_enter(sc->ifp->if_serializer);
 467                 lance_stop(sc);
 468                 bus_teardown_intr(dev, lesc->sc_ires, lesc->sc_ih);
 469                 lwkt_serialize_exit(sc->ifp->if_serializer);
 470
 471                 am7990_detach(&lesc->sc_am7990);
 472         }
 473
 474         if (lesc->sc_ires)
 475                 bus_release_resource(dev, SYS_RES_IRQ, lesc->sc_irid, lesc->sc_ires);
 476         if (lesc->sc_dres)
 477                 bus_release_resource(dev, SYS_RES_DRQ, lesc->sc_drid, lesc->sc_dres);
 478         if (lesc->sc_rres)
 479                 bus_release_resource(dev, SYS_RES_IOPORT, lesc->sc_rrid, lesc->sc_rres);
 480         if (lesc->sc_dmam) {
 481                 bus_dmamap_unload(lesc->sc_dmat, lesc->sc_dmam);
 482                 bus_dmamem_free(lesc->sc_dmat, sc->sc_mem, lesc->sc_dmam);
 483         }
 484         if (lesc->sc_dmat)
 485                 bus_dma_tag_destroy(lesc->sc_dmat);
 486         if (lesc->sc_pdmat)
 487                 bus_dma_tag_destroy(lesc->sc_pdmat);
 488
 489         return (0);
 490 }
 491
 492 static int
 493 le_isa_suspend(device_t dev)
 494 {
 495         struct le_isa_softc *lesc;
 496
 497         lesc = device_get_softc(dev);
 498
 499         lance_suspend(&lesc->sc_am7990.lsc);
 500
 501         return (0);
 502 }
 503
 504 static int
 505 le_isa_resume(device_t dev)
 506 {
 507         struct le_isa_softc *lesc;
 508
 509         lesc = device_get_softc(dev);
 510
 511         lance_resume(&lesc->sc_am7990.lsc);
 512
 513         return (0);
 514 }