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