sys/dev/netif/fe/if_fe_pccard.c

   1 /*
   2  * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
   3  *
   4  * This software may be used, modified, copied, distributed, and sold, in
   5  * both source and binary form provided that the above copyright, these
   6  * terms and the following disclaimer are retained.  The name of the author
   7  * and/or the contributor may not be used to endorse or promote products
   8  * derived from this software without specific prior written permission.
   9  *
  10  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
  11  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  12  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  13  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
  14  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  15  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  16  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION.
  17  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  18  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  19  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  20  * SUCH DAMAGE.
  21  *
  22  * $FreeBSD: src/sys/dev/fe/if_fe_pccard.c,v 1.2.2.1 2000/09/22 10:01:47 nyan Exp $
  23  */
  24
  25 #include "opt_fe.h"
  26 #include "opt_inet.h"
  27
  28 #include <sys/param.h>
  29 #include <sys/kernel.h>
  30 #include <sys/socket.h>
  31 #include <sys/module.h>
  32 #include <sys/bus.h>
  33 #include <machine/clock.h>
  34
  35 #include <net/ethernet.h>
  36 #include <net/if.h>
  37 #include <net/if_mib.h>
  38 #include <net/if_media.h>
  39
  40 #include <netinet/in.h>
  41 #include <netinet/if_ether.h>
  42
  43 #include "mb86960.h"
  44 #include "if_fereg.h"
  45 #include "if_fevar.h"
  46
  47 #include <bus/pccard/pccardvar.h>
  48
  49 #include "card_if.h"
  50 #include "pccarddevs.h"
  51
  52 /*
  53  *      PC-Card (PCMCIA) specific code.
  54  */
  55 static int fe_pccard_probe(device_t);
  56 static int fe_pccard_attach(device_t);
  57 static int fe_pccard_detach(device_t);
  58 static int fe_pccard_match(device_t);
  59
  60 static const struct fe_pccard_product {
  61         struct pccard_product mpp_product;
  62         u_int32_t mpp_ioalign;                  /* required alignment */
  63         int mpp_enet_maddr;
  64 } fe_pccard_products[] = {
  65         { PCMCIA_CARD(TDK, LAK_CD021BX, 0), 0, -1 },
  66         { PCMCIA_CARD(TDK, LAK_CF010, 0), 0, -1 },
  67 #if 0 /* XXX 86960-based? */
  68         { PCMCIA_CARD(TDK, LAK_DFL9610, 1), 0, -1 },
  69 #endif
  70         { PCMCIA_CARD(CONTEC, CNETPC, 0), 0, -1 },
  71         { PCMCIA_CARD(FUJITSU, LA501, 0), 0x20, -1 },
  72         { PCMCIA_CARD(FUJITSU, LA10S, 0), 0, -1 },
  73         { PCMCIA_CARD(RATOC, REX_R280, 0), 0, 0x1fc },
  74         { { NULL } }
  75 };
  76
  77 static int
  78 fe_pccard_match(device_t dev)
  79 {
  80         const struct pccard_product *pp;
  81
  82         if ((pp = pccard_product_lookup(dev,
  83             (const struct pccard_product *)fe_pccard_products,
  84             sizeof(fe_pccard_products[0]), NULL)) != NULL) {
  85                 if (pp->pp_name != NULL)
  86                         device_set_desc(dev, pp->pp_name);
  87                 return 0;
  88         }
  89         return ENXIO;
  90 }
  91
  92 static device_method_t fe_pccard_methods[] = {
  93         /* Device interface */
  94         DEVMETHOD(device_probe,         pccard_compat_probe),
  95         DEVMETHOD(device_attach,        pccard_compat_attach),
  96         DEVMETHOD(device_detach,        fe_pccard_detach),
  97
  98         /* Card interface */
  99         DEVMETHOD(card_compat_match,    fe_pccard_match),
 100         DEVMETHOD(card_compat_probe,    fe_pccard_probe),
 101         DEVMETHOD(card_compat_attach,   fe_pccard_attach),
 102
 103         DEVMETHOD_END
 104 };
 105
 106 static driver_t fe_pccard_driver = {
 107         "fe",
 108         fe_pccard_methods,
 109         sizeof (struct fe_softc)
 110 };
 111
 112 DRIVER_MODULE(if_fe, pccard, fe_pccard_driver, fe_devclass, NULL, NULL);
 113
 114
 115 static int fe_probe_mbh(device_t);
 116 static int fe_probe_tdk(device_t);
 117
 118 /*
 119  *      Initialize the device - called from Slot manager.
 120  */
 121 static int
 122 fe_pccard_probe(device_t dev)
 123 {
 124         struct fe_softc *sc;
 125         int i, error;
 126         uint8_t sum;
 127         const uint8_t *ether_addr;
 128
 129         /* Prepare for the device probe process.  */
 130         sc = device_get_softc(dev);
 131         sc->sc_unit = device_get_unit(dev);
 132
 133         ether_addr = pccard_get_ether(dev);
 134         for (i = 0, sum = 0; i < ETHER_ADDR_LEN; i++)
 135                 sum |= ether_addr[i];
 136         if (sum)
 137                 bcopy(ether_addr, sc->sc_enaddr, ETHER_ADDR_LEN);
 138
 139         /* Probe for supported cards.  */
 140         if ((error = fe_probe_mbh(dev)) == 0)
 141                 goto end;
 142         fe_release_resource(dev);
 143
 144         if ((error = fe_probe_tdk(dev)) == 0)
 145                 goto end;
 146         fe_release_resource(dev);
 147
 148 end:
 149         if (error == 0)
 150                 error = fe_alloc_irq(dev, 0);
 151
 152         fe_release_resource(dev);
 153         return (error);
 154 }
 155
 156 static int
 157 fe_pccard_attach(device_t dev)
 158 {
 159         struct fe_softc *sc = device_get_softc(dev);
 160
 161         if (sc->port_used)
 162                 fe_alloc_port(dev, sc->port_used);
 163         fe_alloc_irq(dev, 0);
 164
 165         return fe_attach(dev);
 166 }
 167
 168 /*
 169  *      feunload - unload the driver and clear the table.
 170  *      XXX TODO:
 171  *      This is usually called when the card is ejected, but
 172  *      can be caused by a modunload of a controller driver.
 173  *      The idea is to reset the driver's view of the device
 174  *      and ensure that any driver entry points such as
 175  *      read and write do not hang.
 176  */
 177 static int
 178 fe_pccard_detach(device_t dev)
 179 {
 180         struct fe_softc *sc = device_get_softc(dev);
 181         struct ifnet *ifp = &sc->arpcom.ac_if;
 182
 183         lwkt_serialize_enter(ifp->if_serializer);
 184         fe_stop(sc);
 185         bus_teardown_intr(dev, sc->irq_res, sc->irq_handle);
 186         lwkt_serialize_exit(ifp->if_serializer);
 187
 188         ether_ifdetach(ifp);
 189         fe_release_resource(dev);
 190
 191         return 0;
 192 }
 193
 194
 195 /*
 196  * Probe and initialization for Fujitsu MBH10302 PCMCIA Ethernet interface.
 197  * Note that this is for 10302 only; MBH10304 is handled by fe_probe_tdk().
 198  */
 199 static void
 200 fe_init_mbh(struct fe_softc *sc)
 201 {
 202         /* Minimal initialization of 86960.  */
 203         DELAY(200);
 204         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
 205         DELAY(200);
 206
 207         /* Disable all interrupts.  */
 208         fe_outb(sc, FE_DLCR2, 0);
 209         fe_outb(sc, FE_DLCR3, 0);
 210
 211         /* Enable master interrupt flag.  */
 212         fe_outb(sc, FE_MBH0, FE_MBH0_MAGIC | FE_MBH0_INTR_ENABLE);
 213 }
 214
 215 static int
 216 fe_probe_mbh(device_t dev)
 217 {
 218         struct fe_softc *sc = device_get_softc(dev);
 219
 220         static struct fe_simple_probe_struct probe_table [] = {
 221                 { FE_DLCR2, 0x58, 0x00 },
 222                 { FE_DLCR4, 0x08, 0x00 },
 223                 { FE_DLCR6, 0xFF, 0xB6 },
 224                 { 0 }
 225         };
 226
 227         /* MBH10302 occupies 32 I/O addresses. */
 228         if (fe_alloc_port(dev, 32))
 229                 return ENXIO;
 230
 231         /* Ethernet MAC address should *NOT* have been given by pccardd,
 232            if this is a true MBH10302; i.e., Ethernet address must be
 233            "all-zero" upon entry.  */
 234         if (sc->sc_enaddr[0] || sc->sc_enaddr[1] || sc->sc_enaddr[2] ||
 235             sc->sc_enaddr[3] || sc->sc_enaddr[4] || sc->sc_enaddr[5])
 236                 return ENXIO;
 237
 238         /* Fill the softc struct with default values.  */
 239         fe_softc_defaults(sc);
 240
 241         /*
 242          * See if MBH10302 is on its address.
 243          * I'm not sure the following probe code works.  FIXME.
 244          */
 245         if (!fe_simple_probe(sc, probe_table))
 246                 return ENXIO;
 247
 248         /* Get our station address from EEPROM.  */
 249         fe_inblk(sc, FE_MBH10, sc->sc_enaddr, ETHER_ADDR_LEN);
 250
 251         /* Make sure we got a valid station address.  */
 252         if (!valid_Ether_p(sc->sc_enaddr, 0))
 253                 return ENXIO;
 254
 255         /* Determine the card type.  */
 256         sc->type = FE_TYPE_MBH;
 257         sc->typestr = "MBH10302 (PCMCIA)";
 258
 259         /* We seems to need our own IDENT bits...  FIXME.  */
 260         sc->proto_dlcr7 = FE_D7_BYTSWP_LH | FE_D7_IDENT_NICE;
 261
 262         /* Setup hooks.  We need a special initialization procedure.  */
 263         sc->init = fe_init_mbh;
 264
 265         return 0;
 266 }
 267
 268 /*
 269  * Probe and initialization for TDK/CONTEC PCMCIA Ethernet interface.
 270  * by MASUI Kenji <masui@cs.titech.ac.jp>
 271  *
 272  * (Contec uses TDK Ethenet chip -- hosokawa)
 273  *
 274  * This version of fe_probe_tdk has been rewrote to handle
 275  * *generic* PC card implementation of Fujitsu MB8696x family.  The
 276  * name _tdk is just for a historical reason. :-)
 277  */
 278 static int
 279 fe_probe_tdk (device_t dev)
 280 {
 281         struct fe_softc *sc = device_get_softc(dev);
 282
 283         static struct fe_simple_probe_struct probe_table [] = {
 284                 { FE_DLCR2, 0x50, 0x00 },
 285                 { FE_DLCR4, 0x08, 0x00 },
 286             /*  { FE_DLCR5, 0x80, 0x00 },       Does not work well.  */
 287                 { 0 }
 288         };
 289
 290         /* C-NET(PC)C occupies 16 I/O addresses. */
 291         if (fe_alloc_port(dev, 16))
 292                 return ENXIO;
 293
 294         /* Fill the softc struct with default values.  */
 295         fe_softc_defaults(sc);
 296
 297         /*
 298          * See if C-NET(PC)C is on its address.
 299          */
 300         if (!fe_simple_probe(sc, probe_table))
 301                 return ENXIO;
 302
 303         /* Determine the card type.  */
 304         sc->type = FE_TYPE_TDK;
 305         sc->typestr = "Generic MB8696x/78Q837x Ethernet (PCMCIA)";
 306
 307         /* Make sure we got a valid station address.  */
 308         if (!valid_Ether_p(sc->sc_enaddr, 0))
 309                 return ENXIO;
 310
 311         return 0;
 312 }