sys/dev/netif/ep/if_ep_pccard.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_pccard.c,v 1.12.2.2 2000/08/08 23:55:02 peter Exp $
  31  */
  32
  33 /*
  34  * Pccard support for 3C589 by:
  35  *              HAMADA Naoki
  36  *              nao@tom-yam.or.jp
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/kernel.h>
  42 #include <sys/socket.h>
  43
  44 #include <sys/module.h>
  45 #include <sys/bus.h>
  46
  47 #include <machine/bus.h>
  48 #include <machine/resource.h>
  49 #include <sys/rman.h>
  50
  51 #include <net/ethernet.h>
  52 #include <net/if.h>
  53 #include <net/if_arp.h>
  54 #include <net/if_media.h>
  55
  56 #include <machine/clock.h>
  57
  58 #include <dev/ep/if_epreg.h>
  59 #include <dev/ep/if_epvar.h>
  60
  61 static const char *ep_pccard_identify(u_short id);
  62
  63 /*
  64  * Initialize the device - called from Slot manager.
  65  */
  66 static int
  67 ep_pccard_probe(device_t dev)
  68 {
  69         struct ep_softc *       sc = device_get_softc(dev);
  70         struct ep_board *       epb = &sc->epb;
  71         const char *            desc;
  72         int                     error;
  73
  74         error = ep_alloc(dev);
  75         if (error)
  76                 return error;
  77
  78         /*
  79          * XXX - Certain (newer?) 3Com cards need epb->cmd_off ==
  80          * 2. Sadly, you need to have a correct cmd_off in order to
  81          * identify the card.  So we have to hit it with both and
  82          * cross our virtual fingers.  There's got to be a better way
  83          * to do this.  jyoung@accessus.net 09/11/1999
  84          */
  85
  86         epb->cmd_off = 0;
  87         epb->prod_id = get_e(sc, EEPROM_PROD_ID);
  88         if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) {
  89                 if (bootverbose)
  90                         device_printf(dev, "Pass 1 of 2 detection "
  91                             "failed (nonfatal)\n");
  92                 epb->cmd_off = 2;
  93                 epb->prod_id = get_e(sc, EEPROM_PROD_ID);
  94                 if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) {
  95                         device_printf(dev, "Unit failed to come ready or "
  96                             "product ID unknown! (id 0x%x)\n", epb->prod_id);
  97                         ep_free(dev);
  98                         return (ENXIO);
  99                 }
 100         }
 101         device_set_desc(dev, desc);
 102
 103         /*
 104          * For some reason the 3c574 needs this.
 105          */
 106         ep_get_macaddr(sc, (u_char *)&sc->arpcom.ac_enaddr);
 107
 108         ep_free(dev);
 109         return (0);
 110 }
 111
 112 static const char *
 113 ep_pccard_identify(u_short id)
 114 {
 115         /* Determine device type and associated MII capabilities  */
 116         switch (id) {
 117         case 0x6055: /* 3C556 */
 118                 return ("3Com 3C556");
 119         case 0x4057: /* 3C574 */
 120                 return ("3Com 3C574");
 121         case 0x4b57: /* 3C574B */
 122                 return ("3Com 3C574B, Megahertz 3CCFE574BT or "
 123                     "Fast Etherlink 3C574-TX");
 124         case 0x2b57: /* 3CXSH572BT */
 125                 return ("3Com OfficeConnect 572BT");
 126         case 0x9058: /* 3C589 */
 127                 return ("3Com Etherlink III 3C589");
 128         case 0x2056: /* 3C562/3C563 */
 129                 return ("3Com 3C562D/3C563D");
 130         }
 131         return (NULL);
 132 }
 133
 134 static int
 135 ep_pccard_card_attach(struct ep_board *epb)
 136 {
 137         /* Determine device type and associated MII capabilities  */
 138         switch (epb->prod_id) {
 139         case 0x6055: /* 3C556 */
 140         case 0x2b57: /* 3C572BT */
 141         case 0x4057: /* 3C574 */
 142         case 0x4b57: /* 3C574B */
 143                 epb->mii_trans = 1;
 144                 return (1);
 145         case 0x2056: /* 3C562D/3C563D */
 146         case 0x9058: /* 3C589 */
 147                 epb->mii_trans = 0;
 148                 return (1);
 149         }
 150         return (0);
 151 }
 152
 153 static int
 154 ep_pccard_attach(device_t dev)
 155 {
 156         struct ep_softc *       sc = device_get_softc(dev);
 157         int                     error = 0;
 158
 159         if ((error = ep_alloc(dev))) {
 160                 device_printf(dev, "ep_alloc() failed! (%d)\n", error);
 161                 goto bad;
 162         }
 163
 164         sc->epb.cmd_off = 0;
 165         sc->epb.prod_id = get_e(sc, EEPROM_PROD_ID);
 166         if (!ep_pccard_card_attach(&sc->epb)) {
 167                 sc->epb.cmd_off = 2;
 168                 sc->epb.prod_id = get_e(sc, EEPROM_PROD_ID);
 169                 sc->epb.res_cfg = get_e(sc, EEPROM_RESOURCE_CFG);
 170                 if (!ep_pccard_card_attach(&sc->epb)) {
 171                         device_printf(dev,
 172                             "Probe found ID, attach failed so ignore card!\n");
 173                         error = ENXIO;
 174                         goto bad;
 175                 }
 176         }
 177
 178         /* ROM size = 0, ROM base = 0 */
 179         /* For now, ignore AUTO SELECT feature of 3C589B and later. */
 180         outw(BASE + EP_W0_ADDRESS_CFG, get_e(sc, EEPROM_ADDR_CFG) & 0xc000);
 181
 182         /* Fake IRQ must be 3 */
 183         outw(BASE + EP_W0_RESOURCE_CFG, (sc->epb.res_cfg & 0x0fff) | 0x3000);
 184
 185         outw(BASE + EP_W0_PRODUCT_ID, sc->epb.prod_id);
 186
 187         if (sc->epb.mii_trans) {
 188                 /*
 189                  * turn on the MII transciever
 190                  */
 191                 GO_WINDOW(3);
 192                 outw(BASE + EP_W3_OPTIONS, 0x8040);
 193                 DELAY(1000);
 194                 outw(BASE + EP_W3_OPTIONS, 0xc040);
 195                 outw(BASE + EP_COMMAND, RX_RESET);
 196                 outw(BASE + EP_COMMAND, TX_RESET);
 197                 while (inw(BASE + EP_STATUS) & S_COMMAND_IN_PROGRESS);
 198                 DELAY(1000);
 199                 outw(BASE + EP_W3_OPTIONS, 0x8040);
 200         } else {
 201                 ep_get_media(sc);
 202         }
 203
 204         if ((error = ep_attach(sc))) {
 205                 device_printf(dev, "ep_attach() failed! (%d)\n", error);
 206                 goto bad;
 207         }
 208
 209         if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET, ep_intr,
 210                                     sc, &sc->ep_intrhand))) {
 211                 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
 212                 goto bad;
 213         }
 214
 215         return (0);
 216 bad:
 217         ep_free(dev);
 218         return (error);
 219 }
 220
 221 static int
 222 ep_pccard_detach(device_t dev)
 223 {
 224         struct ep_softc *sc = device_get_softc(dev);
 225
 226         if (sc->gone) {
 227                 device_printf(dev, "already unloaded\n");
 228                 return (0);
 229         }
 230         sc->arpcom.ac_if.if_flags &= ~IFF_RUNNING;
 231         ether_ifdetach(&sc->arpcom.ac_if, ETHER_BPF_SUPPORTED);
 232         sc->gone = 1;
 233         bus_teardown_intr(dev, sc->irq, sc->ep_intrhand);
 234         ep_free(dev);
 235         return (0);
 236 }
 237
 238 static device_method_t ep_pccard_methods[] = {
 239         /* Device interface */
 240         DEVMETHOD(device_probe,         ep_pccard_probe),
 241         DEVMETHOD(device_attach,        ep_pccard_attach),
 242         DEVMETHOD(device_detach,        ep_pccard_detach),
 243
 244         { 0, 0 }
 245 };
 246
 247 static driver_t ep_pccard_driver = {
 248         "ep",
 249         ep_pccard_methods,
 250         sizeof(struct ep_softc),
 251 };
 252
 253 extern devclass_t ep_devclass;
 254
 255 DRIVER_MODULE(ep, pccard, ep_pccard_driver, ep_devclass, 0, 0);