sys/dev/netif/xe/if_xe.c

   1 /*-
   2  * Copyright (c) 1998, 1999 Scott Mitchell
   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  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $Id: if_xe.c,v 1.20 1999/06/13 19:17:40 scott Exp $
  27  * $FreeBSD: src/sys/dev/xe/if_xe.c,v 1.13.2.6 2003/02/05 22:03:57 mbr Exp $
  28  * $DragonFly: src/sys/dev/netif/xe/if_xe.c,v 1.24 2005/07/13 17:10:25 joerg Exp $
  29  */
  30
  31 /*
  32  * XXX TODO XXX
  33  *
  34  * I've pushed this fairly far, but there are some things that need to be
  35  * done here.  I'm documenting them here in case I get destracted. -- imp
  36  *
  37  * xe_cem56fix -- need to figure out how to map the extra stuff.
  38  */
  39
  40 /*
  41  * Portions of this software were derived from Werner Koch's xirc2ps driver
  42  * for Linux under the terms of the following license (from v1.30 of the
  43  * xirc2ps driver):
  44  *
  45  * Copyright (c) 1997 by Werner Koch (dd9jn)
  46  *
  47  * Redistribution and use in source and binary forms, with or without
  48  * modification, are permitted provided that the following conditions
  49  * are met:
  50  * 1. Redistributions of source code must retain the above copyright
  51  *    notice, and the entire permission notice in its entirety,
  52  *    including the disclaimer of warranties.
  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. The name of the author may not be used to endorse or promote
  57  *    products derived from this software without specific prior
  58  *    written permission.
  59  *
  60  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  61  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  62  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  63  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  64  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  65  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  66  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  68  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  69  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  70  * OF THE POSSIBILITY OF SUCH DAMAGE.
  71  */
  72
  73 /*
  74  * FreeBSD device driver for Xircom CreditCard PCMCIA Ethernet adapters.  The
  75  * following cards are currently known to work with the driver:
  76  *   Xircom CreditCard 10/100 (CE3)
  77  *   Xircom CreditCard Ethernet + Modem 28 (CEM28)
  78  *   Xircom CreditCard Ethernet 10/100 + Modem 56 (CEM56)
  79  *   Xircom RealPort Ethernet 10
  80  *   Xircom RealPort Ethernet 10/100
  81  *   Xircom RealPort Ethernet 10/100 + Modem 56 (REM56, REM56G)
  82  *   Intel EtherExpress Pro/100 PC Card Mobile Adapter 16 (Pro/100 M16A)
  83  *   Compaq Netelligent 10/100 PC Card (CPQ-10/100)
  84  *
  85  * Some other cards *should* work, but support for them is either broken or in
  86  * an unknown state at the moment.  I'm always interested in hearing from
  87  * people who own any of these cards:
  88  *   Xircom CreditCard 10Base-T (PS-CE2-10)
  89  *   Xircom CreditCard Ethernet + ModemII (CEM2)
  90  *   Xircom CEM28 and CEM33 Ethernet/Modem cards (may be variants of CEM2?)
  91  *
  92  * Thanks to all who assisted with the development and testing of the driver,
  93  * especially: Werner Koch, Duke Kamstra, Duncan Barclay, Jason George, Dru
  94  * Nelson, Mike Kephart, Bill Rainey and Douglas Rand.  Apologies if I've left
  95  * out anyone who deserves a mention here.
  96  *
  97  * Special thanks to Ade Lovett for both hosting the mailing list and doing
  98  * the CEM56/REM56 support code; and the FreeBSD UK Users' Group for hosting
  99  * the web pages.
 100  *
 101  * Contact points:
 102  *
 103  * Driver web page: http://ukug.uk.freebsd.org/~scott/xe_drv/
 104  *
 105  * Mailing list: http://www.lovett.com/lists/freebsd-xircom/
 106  * or send "subscribe freebsd-xircom" to <majordomo@lovett.com>
 107  *
 108  * Author email: <scott@uk.freebsd.org>
 109  */
 110
 111
 112 #include <sys/param.h>
 113 #include <sys/cdefs.h>
 114 #include <sys/errno.h>
 115 #include <sys/kernel.h>
 116 #include <sys/mbuf.h>
 117 #include <sys/select.h>
 118 #include <sys/socket.h>
 119 #include <sys/sockio.h>
 120 #include <sys/systm.h>
 121 #include <sys/uio.h>
 122 #include <sys/thread2.h>
 123
 124 #include <sys/module.h>
 125 #include <sys/bus.h>
 126
 127 #include <machine/bus.h>
 128 #include <machine/resource.h>
 129 #include <sys/rman.h>
 130
 131 #include <net/ethernet.h>
 132 #include <net/if.h>
 133 #include <net/ifq_var.h>
 134 #include <net/if_arp.h>
 135 #include <net/if_dl.h>
 136 #include <net/if_media.h>
 137 #include <net/if_mib.h>
 138 #include <net/bpf.h>
 139
 140 #include <bus/pccard/pccardvar.h>
 141 #include "card_if.h"
 142
 143 #include "if_xereg.h"
 144 #include "if_xevar.h"
 145
 146 /*
 147  * MII command structure
 148  */
 149 struct xe_mii_frame {
 150   u_int8_t  mii_stdelim;
 151   u_int8_t  mii_opcode;
 152   u_int8_t  mii_phyaddr;
 153   u_int8_t  mii_regaddr;
 154   u_int8_t  mii_turnaround;
 155   u_int16_t mii_data;
 156 };
 157
 158 /*
 159  * Media autonegotiation progress constants
 160  */
 161 #define XE_AUTONEG_NONE         0       /* No autonegotiation in progress */
 162 #define XE_AUTONEG_WAITING      1       /* Waiting for transmitter to go idle */
 163 #define XE_AUTONEG_STARTED      2       /* Waiting for autonegotiation to complete */
 164 #define XE_AUTONEG_100TX        3       /* Trying to force 100baseTX link */
 165 #define XE_AUTONEG_FAIL         4       /* Autonegotiation failed */
 166
 167
 168 /*
 169  * Prototypes start here
 170  */
 171 static int       xe_probe               (device_t dev);
 172 static int       xe_attach              (device_t dev);
 173 static int       xe_detach              (device_t dev);
 174 static int       xe_activate            (device_t dev);
 175 static void      xe_deactivate          (device_t dev);
 176 static void      xe_init                (void *xscp);
 177 static void      xe_start               (struct ifnet *ifp);
 178 static int       xe_ioctl               (struct ifnet *ifp, u_long command, caddr_t data, struct ucred *);
 179 static void      xe_watchdog            (struct ifnet *ifp);
 180 static int       xe_media_change        (struct ifnet *ifp);
 181 static void      xe_media_status        (struct ifnet *ifp, struct ifmediareq *mrp);
 182 static timeout_t xe_setmedia;
 183 static void      xe_hard_reset          (struct xe_softc *scp);
 184 static void      xe_soft_reset          (struct xe_softc *scp);
 185 static void      xe_stop                (struct xe_softc *scp);
 186 static void      xe_enable_intr         (struct xe_softc *scp);
 187 static void      xe_disable_intr        (struct xe_softc *scp);
 188 static void      xe_setmulti            (struct xe_softc *scp);
 189 static void      xe_setaddrs            (struct xe_softc *scp);
 190 static int       xe_pio_write_packet    (struct xe_softc *scp, struct mbuf *mbp);
 191 #if 0
 192 static u_int32_t xe_compute_crc         (u_int8_t *data, int len);
 193 static int       xe_compute_hashbit     (u_int32_t crc);
 194 #endif
 195
 196 /*
 197  * MII functions
 198  */
 199 static void      xe_mii_sync            (struct xe_softc *scp);
 200 static int       xe_mii_init            (struct xe_softc *scp);
 201 static void      xe_mii_send            (struct xe_softc *scp, u_int32_t bits, int cnt);
 202 static int       xe_mii_readreg         (struct xe_softc *scp, struct xe_mii_frame *frame);
 203 static int       xe_mii_writereg        (struct xe_softc *scp, struct xe_mii_frame *frame);
 204 static u_int16_t xe_phy_readreg         (struct xe_softc *scp, u_int16_t reg);
 205 static void      xe_phy_writereg        (struct xe_softc *scp, u_int16_t reg, u_int16_t data);
 206
 207 /*
 208  * Debug functions -- uncomment for VERY verbose dignostic information.
 209  * Set to 1 for less verbose information
 210  */
 211 /* #define XE_DEBUG 2 */
 212 #ifdef XE_DEBUG
 213 #define XE_REG_DUMP(scp)                xe_reg_dump((scp))
 214 #define XE_MII_DUMP(scp)                xe_mii_dump((scp))
 215 static void      xe_reg_dump            (struct xe_softc *scp);
 216 static void      xe_mii_dump            (struct xe_softc *scp);
 217 #else
 218 #define XE_REG_DUMP(scp)
 219 #define XE_MII_DUMP(scp)
 220 #endif
 221
 222 /*
 223  * Fixing for RealPort cards - they need a little furtling to get the
 224  * ethernet working
 225  */
 226 static int
 227 xe_cem56fix(device_t dev)
 228 {
 229   struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev);
 230   bus_space_tag_t bst;
 231   bus_space_handle_t bsh;
 232   struct resource *r;
 233   int rid;
 234   int ioport;
 235
 236 #ifdef XE_DEBUG
 237   device_printf(dev, "Hacking your Realport, master\n");
 238 #endif
 239
 240 #if XE_DEBUG > 1
 241   device_printf(dev, "Realport port 0x%0lx, size 0x%0lx\n",
 242       bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid),
 243       bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid));
 244 #endif
 245
 246   rid = 0;
 247   r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
 248   if (!r) {
 249 #if XE_DEBUG > 0
 250     device_printf(dev, "Can't map in attribute memory\n");
 251 #endif
 252     return -1;
 253   }
 254
 255   bsh = rman_get_bushandle(r);
 256   bst = rman_get_bustag(r);
 257
 258   CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
 259       PCCARD_A_MEM_ATTR);
 260
 261   bus_space_write_1(bst, bsh, DINGO_ECOR, DINGO_ECOR_IRQ_LEVEL |
 262                                           DINGO_ECOR_INT_ENABLE |
 263                                           DINGO_ECOR_IOB_ENABLE |
 264                                           DINGO_ECOR_ETH_ENABLE);
 265   ioport = bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid);
 266   bus_space_write_1(bst, bsh, DINGO_EBAR0, ioport & 0xff);
 267   bus_space_write_1(bst, bsh, DINGO_EBAR1, (ioport >> 8) & 0xff);
 268
 269   bus_space_write_1(bst, bsh, DINGO_DCOR0, DINGO_DCOR0_SF_INT);
 270   bus_space_write_1(bst, bsh, DINGO_DCOR1, DINGO_DCOR1_INT_LEVEL |
 271                                            DINGO_DCOR1_EEDIO);
 272   bus_space_write_1(bst, bsh, DINGO_DCOR2, 0x00);
 273   bus_space_write_1(bst, bsh, DINGO_DCOR3, 0x00);
 274   bus_space_write_1(bst, bsh, DINGO_DCOR4, 0x00);
 275
 276   bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
 277
 278   /* success! */
 279   return 0;
 280 }
 281
 282 /*
 283  * PCMCIA probe routine.
 284  * Probe and identify the device.  Called by the slot manager when the card is
 285  * inserted or the machine wakes up from suspend mode.  Assmes that the slot
 286  * structure has been initialised already.
 287  */
 288 static int
 289 xe_probe(device_t dev)
 290 {
 291   struct xe_softc *scp = (struct xe_softc *) device_get_softc(dev);
 292   bus_space_tag_t bst;
 293   bus_space_handle_t bsh;
 294   int buf;
 295   u_char ver_str[CISTPL_BUFSIZE>>1];
 296   off_t offs;
 297   int success, rc, i;
 298   int rid;
 299   struct resource *r;
 300
 301   success = 0;
 302
 303 #ifdef XE_DEBUG
 304   device_printf(dev, "Probing\n");
 305 #endif
 306
 307   /* Map in the CIS */
 308   rid = 0;
 309   r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 4 << 10, RF_ACTIVE);
 310   if (!r) {
 311 #ifdef XE_DEBUG
 312     device_printf(dev, "Can't map in cis\n");
 313 #endif
 314     return ENOMEM;
 315   }
 316   bsh = rman_get_bushandle(r);
 317   bst = rman_get_bustag(r);
 318   buf = 0;
 319
 320   CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid,
 321       PCCARD_A_MEM_ATTR);
 322
 323   /* Grep through CIS looking for relevant tuples */
 324   rc = 0;
 325   offs = 0;
 326   do {
 327     u_int16_t vendor;
 328     u_int8_t rev, media, prod;
 329
 330     switch (CISTPL_TYPE(buf)) {
 331
 332     case 0x15:  /* Grab version string (needed to ID some weird CE2's) */
 333 #if XE_DEBUG > 1
 334       device_printf(dev, "Got version string (0x15)\n");
 335 #endif
 336       for (i = 0; i < CISTPL_LEN(buf); ver_str[i] = CISTPL_DATA(buf, i++));
 337       ver_str[i] = '\0';
 338       ver_str[(CISTPL_BUFSIZE>>1) - 1] = CISTPL_LEN(buf);
 339       success++;
 340       break;
 341
 342     case 0x20:  /* Figure out what type of card we have */
 343 #if XE_DEBUG > 1
 344       device_printf(dev, "Got card ID (0x20)\n");
 345 #endif
 346       vendor = CISTPL_DATA(buf, 0) + (CISTPL_DATA(buf, 1) << 8);
 347       rev = CISTPL_DATA(buf, 2);
 348       media = CISTPL_DATA(buf, 3);
 349       prod = CISTPL_DATA(buf, 4);
 350
 351       switch (vendor) { /* Get vendor ID */
 352       case 0x0105:
 353         scp->vendor = "Xircom"; break;
 354       case 0x0138:
 355       case 0x0183:
 356         scp->vendor = "Compaq"; break;
 357       case 0x0089:
 358         scp->vendor = "Intel"; break;
 359       default:
 360         scp->vendor = "Unknown";
 361       }
 362
 363       if (!((prod & 0x40) && (media & 0x01))) {
 364 #if XE_DEBUG > 1
 365         device_printf(dev, "Not a PCMCIA Ethernet card!\n");
 366 #endif
 367         rc = ENODEV;            /* Not a PCMCIA Ethernet device */
 368       } else {
 369         if (media & 0x10) {     /* Ethernet/modem cards */
 370 #if XE_DEBUG > 1
 371           device_printf(dev, "Card is Ethernet/modem combo\n");
 372 #endif
 373           scp->modem = 1;
 374           switch (prod & 0x0f) {
 375           case 1:
 376             scp->card_type = "CEM"; break;
 377           case 2:
 378             scp->ce2 = 1;
 379             scp->card_type = "CEM2"; break;
 380           case 3:
 381             scp->ce2 = 1;
 382             scp->card_type = "CEM3"; break;
 383           case 4:
 384             scp->ce2 = 1;
 385             scp->card_type = "CEM33"; break;
 386           case 5:
 387             scp->mohawk = 1;
 388             scp->card_type = "CEM56M"; break;
 389           case 6:
 390           case 7:               /* Some kind of RealPort card */
 391             scp->mohawk = 1;
 392             scp->dingo = 1;
 393             scp->card_type = "CEM56"; break;
 394           default:
 395             rc = ENODEV;
 396           }
 397         } else {                /* Ethernet-only cards */
 398 #if XE_DEBUG > 1
 399           device_printf(dev, "Card is Ethernet only\n");
 400 #endif
 401           switch (prod & 0x0f) {
 402           case 1:
 403             scp->card_type = "CE"; break;
 404           case 2:
 405             scp->ce2 = 1;
 406             scp->card_type = "CE2"; break;
 407           case 3:
 408             scp->mohawk = 1;
 409             scp->card_type = "CE3"; break;
 410           default:
 411             rc = ENODEV;
 412           }
 413         }
 414       }
 415       success++;
 416       break;
 417
 418     case 0x22:  /* Get MAC address */
 419       if ((CISTPL_LEN(buf) == 8) &&
 420           (CISTPL_DATA(buf, 0) == 0x04) &&
 421           (CISTPL_DATA(buf, 1) == ETHER_ADDR_LEN)) {
 422 #if XE_DEBUG > 1
 423         device_printf(dev, "Got MAC address (0x22)\n");
 424 #endif
 425         for (i = 0; i < ETHER_ADDR_LEN; i++)
 426           scp->arpcom.ac_enaddr[i] = CISTPL_DATA(buf, i+2);
 427       }
 428       success++;
 429       break;
 430     default:
 431       break;
 432     }
 433
 434     if (CISTPL_TYPE(buf) == 0xff)
 435       break;
 436     /* Skip to next tuple */
 437     buf += ((CISTPL_LEN(buf) + 2) << 1);
 438
 439   } while (1);
 440
 441   /* unmap the cis */
 442   bus_release_resource(dev, SYS_RES_MEMORY, rid, r);
 443
 444   if (rc)
 445     return(rc);
 446
 447   /* Die now if something went wrong above */
 448   if (success < 3)
 449     return ENXIO;
 450
 451   /* Check for certain strange CE2's that look like CE's */
 452   if (strcmp(scp->card_type, "CE") == 0) {
 453     u_char *str = ver_str;
 454 #if XE_DEBUG > 1
 455     device_printf(dev, "Checking for weird CE2 string\n");
 456 #endif
 457     str += strlen(str) + 1;                     /* Skip forward to 3rd version string */
 458     str += strlen(str) + 1;
 459     str += strlen(str) + 1;
 460     for (i = 0; i < strlen(str) - 2; i++) {
 461       if (bcmp(&str[i], "CE2", 3) ==0) {        /* Look for "CE2" string */
 462         scp->card_type = "CE2";
 463       }
 464     }
 465   }
 466
 467   /* Reject unsupported cards */
 468   if (strcmp(scp->card_type, "CE") == 0 || strcmp(scp->card_type, "CEM") == 0) {
 469     device_printf(dev, "Sorry, your %s card is not supported :(\n",
 470      scp->card_type);
 471     return ENODEV;
 472   }
 473
 474   /* Success */
 475   return 0;
 476 }
 477
 478 /*
 479  * The device entry is being removed, probably because someone ejected the
 480  * card.  The interface should have been brought down manually before calling
 481  * this function; if not you may well lose packets.  In any case, I shut down
 482  * the card and the interface, and hope for the best.
 483  */
 484 static int
 485 xe_detach(device_t dev) {
 486   struct xe_softc *sc = device_get_softc(dev);
 487
 488   sc->arpcom.ac_if.if_flags &= ~IFF_RUNNING;
 489   callout_stop(&sc->xe_timer);
 490   ether_ifdetach(&sc->arpcom.ac_if);
 491   xe_deactivate(dev);
 492   return 0;
 493 }
 494
 495 /*
 496  * Attach a device.
 497  */
 498 static int
 499 xe_attach (device_t dev) {
 500   struct xe_softc *scp = device_get_softc(dev);
 501   int err;
 502
 503 #ifdef XE_DEBUG
 504   device_printf(dev, "attach\n");
 505 #endif
 506
 507   if ((err = xe_activate(dev)) != 0)
 508     return (err);
 509
 510   /* Fill in some private data */
 511   scp->ifp = &scp->arpcom.ac_if;
 512   scp->ifm = &scp->ifmedia;
 513   scp->autoneg_status = 0;
 514
 515   /* Hack RealPorts into submission */
 516   if (scp->dingo && xe_cem56fix(dev) < 0) {
 517     device_printf(dev, "Unable to fix your RealPort\n");
 518     xe_deactivate(dev);
 519     return ENODEV;
 520   }
 521
 522   /* Hopefully safe to read this here */
 523   XE_SELECT_PAGE(4);
 524   scp->version = XE_INB(XE_BOV);
 525
 526   /* Initialise the ifnet structure */
 527   scp->ifp->if_softc = scp;
 528   if_initname(scp->ifp, device_get_name(dev), device_get_unit(dev));
 529   scp->ifp->if_timer = 0;
 530   scp->ifp->if_flags = (IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST);
 531   scp->ifp->if_linkmib = &scp->mibdata;
 532   scp->ifp->if_linkmiblen = sizeof scp->mibdata;
 533   scp->ifp->if_start = xe_start;
 534   scp->ifp->if_ioctl = xe_ioctl;
 535   scp->ifp->if_watchdog = xe_watchdog;
 536   scp->ifp->if_init = xe_init;
 537   ifq_set_maxlen(&scp->ifp->if_snd, IFQ_MAXLEN);
 538   ifq_set_ready(&scp->ifp->if_snd);
 539
 540   /* Initialise the ifmedia structure */
 541   ifmedia_init(scp->ifm, 0, xe_media_change, xe_media_status);
 542   callout_init(&scp->xe_timer);
 543
 544   /*
 545    * Fill in supported media types.  Some cards _do_ support full duplex
 546    * operation, but this driver doesn't, yet.  Therefore we leave those modes
 547    * out of the list.  We support some form of autoselection in all cases.
 548    */
 549   if (scp->mohawk) {
 550     ifmedia_add(scp->ifm, IFM_ETHER|IFM_100_TX, 0, NULL);
 551     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
 552   }
 553   else {
 554     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_T, 0, NULL);
 555     ifmedia_add(scp->ifm, IFM_ETHER|IFM_10_2, 0, NULL);
 556   }
 557   ifmedia_add(scp->ifm, IFM_ETHER|IFM_AUTO, 0, NULL);
 558
 559   /* Default is to autoselect best supported media type */
 560   ifmedia_set(scp->ifm, IFM_ETHER|IFM_AUTO);
 561
 562   /* Print some useful information */
 563   device_printf(dev, "%s %s, bonding version %#x%s%s\n",
 564          scp->vendor,
 565          scp->card_type,
 566          scp->version,
 567          scp->mohawk ? ", 100Mbps capable" : "",
 568          scp->modem ?  ", with modem"      : "");
 569   if (scp->mohawk) {
 570     XE_SELECT_PAGE(0x10);
 571     device_printf(dev, "DingoID = %#x, RevisionID = %#x, VendorID = %#x\n",
 572            XE_INW(XE_DINGOID),
 573            XE_INW(XE_RevID),
 574            XE_INW(XE_VendorID));
 575   }
 576   if (scp->ce2) {
 577     XE_SELECT_PAGE(0x45);
 578     device_printf(dev, "CE2 version = %#x\n", XE_INB(XE_REV));
 579   }
 580
 581   /* Attach the interface */
 582   ether_ifattach(scp->ifp, scp->arpcom.ac_enaddr);
 583
 584   /* Done */
 585   return 0;
 586 }
 587
 588
 589 /*
 590  * Initialize device.  Completes the reset procedure on the card and starts
 591  * output.  If there's an autonegotiation in progress we DON'T do anything;
 592  * the media selection code will call us again when it's done.
 593  */
 594 static void
 595 xe_init(void *xscp) {
 596   struct xe_softc *scp = xscp;
 597
 598 #ifdef XE_DEBUG
 599   if_printf(scp->ifp, "init\n");
 600 #endif
 601
 602   /* Reset transmitter flags */
 603   scp->tx_queued = 0;
 604   scp->tx_tpr = 0;
 605   scp->tx_collisions = 0;
 606   scp->ifp->if_timer = 0;
 607
 608   crit_enter();
 609
 610   XE_SELECT_PAGE(0x42);
 611   XE_OUTB(XE_SWC0, 0x20);       /* Disable source insertion (WTF is that?) */
 612
 613   /*
 614    * Set the 'local memory dividing line' -- splits the 32K card memory into
 615    * 8K for transmit buffers and 24K for receive.  This is done automatically
 616    * on newer revision cards.
 617    */
 618   if (scp->srev != 1) {
 619     XE_SELECT_PAGE(2);
 620     XE_OUTW(XE_RBS, 0x2000);
 621   }
 622
 623   /* Set up multicast addresses */
 624   xe_setmulti(scp);
 625
 626   /* Fix the data offset register -- reset leaves it off-by-one */
 627   XE_SELECT_PAGE(0);
 628   XE_OUTW(XE_DO, 0x2000);
 629
 630   /*
 631    * Set MAC interrupt masks and clear status regs.  The bit names are direct
 632    * from the Linux code; I have no idea what most of them do.
 633    */
 634   XE_SELECT_PAGE(0x40);         /* Bit 7..0 */
 635   XE_OUTB(XE_RX0Msk, 0xff);     /* ROK, RAB, rsv, RO,  CRC, AE,  PTL, MP  */
 636   XE_OUTB(XE_TX0Msk, 0xff);     /* TOK, TAB, SQE, LL,  TU,  JAB, EXC, CRS */
 637   XE_OUTB(XE_TX0Msk+1, 0xb0);   /* rsv, rsv, PTD, EXT, rsv, rsv, rsv, rsv */
 638   XE_OUTB(XE_RST0, 0x00);       /* ROK, RAB, REN, RO,  CRC, AE,  PTL, MP  */
 639   XE_OUTB(XE_TXST0, 0x00);      /* TOK, TAB, SQE, LL,  TU,  JAB, EXC, CRS */
 640   XE_OUTB(XE_TXST1, 0x00);      /* TEN, rsv, PTD, EXT, retry_counter:4    */
 641
 642   /*
 643    * Check for an in-progress autonegotiation.  If one is active, just set
 644    * IFF_RUNNING and return.  The media selection code will call us again when
 645    * it's done.
 646    */
 647   if (scp->autoneg_status) {
 648     scp->ifp->if_flags |= IFF_RUNNING;
 649   }
 650   else {
 651     /* Enable receiver, put MAC online */
 652     XE_SELECT_PAGE(0x40);
 653     XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
 654
 655     /* Set up IMR, enable interrupts */
 656     xe_enable_intr(scp);
 657
 658     /* Attempt to start output */
 659     scp->ifp->if_flags |= IFF_RUNNING;
 660     scp->ifp->if_flags &= ~IFF_OACTIVE;
 661     xe_start(scp->ifp);
 662   }
 663
 664   crit_exit();
 665 }
 666
 667
 668 /*
 669  * Start output on interface.  We make two assumptions here:
 670  *  1) that we are in a critical section _before_ this code
 671  *     is called *and* is returned to the appropriate priority after
 672  *     return
 673  *  2) that the IFF_OACTIVE flag is checked before this code is called
 674  *     (i.e. that the output part of the interface is idle)
 675  */
 676 static void
 677 xe_start(struct ifnet *ifp) {
 678   struct xe_softc *scp = ifp->if_softc;
 679   struct mbuf *mbp;
 680
 681   /*
 682    * Loop while there are packets to be sent, and space to send them.
 683    */
 684   while (1) {
 685     mbp = ifq_poll(&ifp->if_snd);       /* Suck a packet off the send queue */
 686
 687     if (mbp == NULL) {
 688       /*
 689        * We are using the !OACTIVE flag to indicate to the outside world that
 690        * we can accept an additional packet rather than that the transmitter
 691        * is _actually_ active. Indeed, the transmitter may be active, but if
 692        * we haven't filled all the buffers with data then we still want to
 693        * accept more.
 694        */
 695       ifp->if_flags &= ~IFF_OACTIVE;
 696       return;
 697     }
 698
 699     if (xe_pio_write_packet(scp, mbp) != 0) {
 700       ifp->if_flags |= IFF_OACTIVE;
 701       return;
 702     }
 703
 704     mbp = ifq_dequeue(&ifp->if_snd);
 705     BPF_MTAP(ifp, mbp);
 706
 707     ifp->if_timer = 5;                  /* In case we don't hear from the card again */
 708     scp->tx_queued++;
 709
 710     m_freem(mbp);
 711   }
 712 }
 713
 714
 715 /*
 716  * Process an ioctl request.  Adapted from the ed driver.
 717  */
 718 static int
 719 xe_ioctl (struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr) {
 720   struct xe_softc *scp;
 721   int           error;
 722
 723   scp = ifp->if_softc;
 724   error = 0;
 725
 726   crit_enter();
 727
 728   switch (command) {
 729
 730    case SIOCSIFFLAGS:
 731     /*
 732      * If the interface is marked up and stopped, then start it.  If it is
 733      * marked down and running, then stop it.
 734      */
 735     if (ifp->if_flags & IFF_UP) {
 736       if (!(ifp->if_flags & IFF_RUNNING)) {
 737         xe_hard_reset(scp);
 738         xe_setmedia(scp);
 739         xe_init(scp);
 740       }
 741     }
 742     else {
 743       if (ifp->if_flags & IFF_RUNNING)
 744         xe_stop(scp);
 745     }
 746
 747    case SIOCADDMULTI:
 748    case SIOCDELMULTI:
 749     /*
 750      * Multicast list has (maybe) changed; set the hardware filter
 751      * accordingly.  This also serves to deal with promiscuous mode if we have
 752      * a BPF listener active.
 753      */
 754     xe_setmulti(scp);
 755     error = 0;
 756     break;
 757
 758    case SIOCSIFMEDIA:
 759    case SIOCGIFMEDIA:
 760     /*
 761      * Someone wants to get/set media options.
 762      */
 763     error = ifmedia_ioctl(ifp, (struct ifreq *)data, &scp->ifmedia, command);
 764     break;
 765
 766    default:
 767     error = ether_ioctl(ifp, command, data);
 768     break;
 769   }
 770
 771   crit_exit();
 772
 773   return error;
 774 }
 775
 776
 777 /*
 778  * Card interrupt handler.
 779  *
 780  * This function is probably more complicated than it needs to be, as it
 781  * attempts to deal with the case where multiple packets get sent between
 782  * interrupts.  This is especially annoying when working out the collision
 783  * stats.  Not sure whether this case ever really happens or not (maybe on a
 784  * slow/heavily loaded machine?) so it's probably best to leave this like it
 785  * is.
 786  *
 787  * Note that the crappy PIO used to get packets on and off the card means that
 788  * you will spend a lot of time in this routine -- I can get my P150 to spend
 789  * 90% of its time servicing interrupts if I really hammer the network.  Could
 790  * fix this, but then you'd start dropping/losing packets.  The moral of this
 791  * story?  If you want good network performance _and_ some cycles left over to
 792  * get your work done, don't buy a Xircom card.  Or convince them to tell me
 793  * how to do memory-mapped I/O :)
 794  */
 795 static void
 796 xe_intr(void *xscp)
 797 {
 798   struct xe_softc *scp = (struct xe_softc *) xscp;
 799   struct ifnet *ifp;
 800   int result;
 801   u_int16_t rx_bytes, rxs, txs;
 802   u_int8_t psr, isr, esr, rsr;
 803
 804   ifp = &scp->arpcom.ac_if;
 805   rx_bytes = 0;                 /* Bytes received on this interrupt */
 806   result = 0;                   /* Set true if the interrupt is for us */
 807
 808   if (scp->mohawk) {
 809     XE_OUTB(XE_CR, 0);          /* Disable interrupts */
 810   }
 811
 812   psr = XE_INB(XE_PR);          /* Stash the current register page */
 813
 814   /*
 815    * Read ISR to see what caused this interrupt.  Note that this clears the
 816    * ISR on CE2 type cards.
 817    */
 818   if ((isr = XE_INB(XE_ISR)) && isr != 0xff) {
 819
 820     result = 1;                 /* This device did generate an int */
 821     esr = XE_INB(XE_ESR);       /* Read the other status registers */
 822     XE_SELECT_PAGE(0x40);
 823     rxs = XE_INB(XE_RST0);
 824     XE_OUTB(XE_RST0, ~rxs & 0xff);
 825     txs = XE_INB(XE_TXST0);
 826     txs |= XE_INB(XE_TXST1) << 8;
 827     XE_OUTB(XE_TXST0, 0);
 828     XE_OUTB(XE_TXST1, 0);
 829     XE_SELECT_PAGE(0);
 830
 831 #if XE_DEBUG > 2
 832     if_printf(ifp, "ISR=%#2.2x ESR=%#2.2x RST=%#2.2x TXST=%#4.4x\n", isr, esr, rxs, txs);
 833 #endif
 834
 835     /*
 836      * Handle transmit interrupts
 837      */
 838     if (isr & XE_ISR_TX_PACKET) {
 839       u_int8_t new_tpr, sent;
 840
 841       if ((new_tpr = XE_INB(XE_TPR)) < scp->tx_tpr)     /* Update packet count */
 842         sent = (0xff - scp->tx_tpr) + new_tpr;          /* TPR rolled over */
 843       else
 844         sent = new_tpr - scp->tx_tpr;
 845
 846       if (sent > 0) {                           /* Packets sent since last interrupt */
 847         scp->tx_tpr = new_tpr;
 848         scp->tx_queued -= sent;
 849         ifp->if_opackets += sent;
 850         ifp->if_collisions += scp->tx_collisions;
 851
 852         /*
 853          * Collision stats are a PITA.  If multiples frames have been sent, we
 854          * distribute any outstanding collision count equally amongst them.
 855          * However, if we're missing interrupts we're quite likely to also
 856          * miss some collisions; thus the total count will be off anyway.
 857          * Likewise, if we miss a frame dropped due to excessive collisions
 858          * any outstanding collisions count will be held against the next
 859          * frame to be successfully sent.  Hopefully it averages out in the
 860          * end!
 861          * XXX - This will screw up if tx_collisions/sent > 14. FIX IT!
 862          */
 863         switch (scp->tx_collisions) {
 864          case 0:
 865           break;
 866          case 1:
 867           scp->mibdata.dot3StatsSingleCollisionFrames++;
 868           scp->mibdata.dot3StatsCollFrequencies[0]++;
 869           break;
 870          default:
 871           if (sent == 1) {
 872             scp->mibdata.dot3StatsMultipleCollisionFrames++;
 873             scp->mibdata.dot3StatsCollFrequencies[scp->tx_collisions-1]++;
 874           }
 875           else {                /* Distribute across multiple frames */
 876             scp->mibdata.dot3StatsMultipleCollisionFrames += sent;
 877             scp->mibdata.
 878               dot3StatsCollFrequencies[scp->tx_collisions/sent] += sent - scp->tx_collisions%sent;
 879             scp->mibdata.
 880               dot3StatsCollFrequencies[scp->tx_collisions/sent + 1] += scp->tx_collisions%sent;
 881           }
 882         }
 883         scp->tx_collisions = 0;
 884       }
 885       ifp->if_timer = 0;
 886       ifp->if_flags &= ~IFF_OACTIVE;
 887     }
 888     if (txs & 0x0002) {         /* Excessive collisions (packet dropped) */
 889       ifp->if_collisions += 16;
 890       ifp->if_oerrors++;
 891       scp->tx_collisions = 0;
 892       scp->mibdata.dot3StatsExcessiveCollisions++;
 893       scp->mibdata.dot3StatsMultipleCollisionFrames++;
 894       scp->mibdata.dot3StatsCollFrequencies[15]++;
 895       XE_OUTB(XE_CR, XE_CR_RESTART_TX);
 896     }
 897     if (txs & 0x0040)           /* Transmit aborted -- probably collisions */
 898       scp->tx_collisions++;
 899
 900
 901     /*
 902      * Handle receive interrupts
 903      */
 904     while ((esr = XE_INB(XE_ESR)) & XE_ESR_FULL_PACKET_RX) {
 905
 906       if ((rsr = XE_INB(XE_RSR)) & XE_RSR_RX_OK) {
 907         struct ether_header *ehp;
 908         struct mbuf *mbp;
 909         u_int16_t len;
 910
 911         len = XE_INW(XE_RBC);
 912
 913         if (len == 0)
 914           continue;
 915
 916 #if 0
 917         /*
 918          * Limit the amount of time we spend in this loop, dropping packets if
 919          * necessary.  The Linux code does this with considerably more
 920          * finesse, adjusting the threshold dynamically.
 921          */
 922         if ((rx_bytes += len) > 22000) {
 923           ifp->if_iqdrops++;
 924           scp->mibData.dot3StatsMissedFrames++;
 925           XE_OUTW(XE_DO, 0x8000);
 926           continue;
 927         }
 928 #endif
 929
 930         if (len & 0x01)
 931           len++;
 932
 933         MGETHDR(mbp, MB_DONTWAIT, MT_DATA);     /* Allocate a header mbuf */
 934         if (mbp != NULL) {
 935           mbp->m_pkthdr.rcvif = ifp;
 936           mbp->m_pkthdr.len = mbp->m_len = len;
 937
 938           /*
 939            * If the mbuf header isn't big enough for the packet, attach an
 940            * mbuf cluster to hold it.  The +2 is to allow for the nasty little
 941            * alignment hack below.
 942            */
 943           if (len + 2 > MHLEN) {
 944             MCLGET(mbp, MB_DONTWAIT);
 945             if ((mbp->m_flags & M_EXT) == 0) {
 946               m_freem(mbp);
 947               mbp = NULL;
 948             }
 949           }
 950         }
 951
 952         if (mbp != NULL) {
 953           /*
 954            * The Ethernet header is 14 bytes long; thus the actual packet data
 955            * won't be 32-bit aligned when it's dumped into the mbuf.  We
 956            * offset everything by 2 bytes to fix this.  Apparently the
 957            * alignment is important for NFS, damn its eyes.
 958            */
 959           mbp->m_data += 2;
 960           ehp = mtod(mbp, struct ether_header *);
 961
 962           /*
 963            * Now get the packet, including the Ethernet header and trailer (?)
 964            * We use programmed I/O, because we don't know how to do shared
 965            * memory with these cards.  So yes, it's real slow, and heavy on
 966            * the interrupts (CPU on my P150 maxed out at ~950KBps incoming).
 967            */
 968           if (scp->srev == 0) {         /* Workaround a bug in old cards */
 969             u_short rhs;
 970
 971             XE_SELECT_PAGE(5);
 972             rhs = XE_INW(XE_RHSA);
 973             XE_SELECT_PAGE(0);
 974
 975             rhs += 3;                    /* Skip control info */
 976
 977             if (rhs >= 0x8000)
 978               rhs = 0;
 979
 980             if (rhs + len > 0x8000) {
 981               int i;
 982
 983               /*
 984                * XXX - This i-- seems very wrong, but it's what the Linux guys
 985                * XXX - do.  Need someone with an old CE2 to test this for me.
 986                * XXX - 99/3/28: Changed the first i-- to an i++, maybe that'll
 987                * XXX - fix it?  It seems as though the previous version would
 988                * XXX - have caused an infinite loop (what, another one?).
 989                */
 990               for (i = 0; i < len; i++, rhs++) {
 991                 ((char *)ehp)[i] = XE_INB(XE_EDP);
 992                 if (rhs == 0x8000) {
 993                   rhs = 0;
 994                   i--;
 995                 }
 996               }
 997             }
 998             else
 999               bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP,
1000                (u_int16_t *) ehp, len >> 1);
1001           }
1002           else
1003             bus_space_read_multi_2(scp->bst, scp->bsh, XE_EDP,
1004              (u_int16_t *) ehp, len >> 1);
1005
1006           /* Deliver packet to upper layers */
1007           if (mbp != NULL) {
1008             mbp->m_pkthdr.len = mbp->m_len = len;
1009             (*ifp->if_input)(ifp, mbp);         /* Send the packet on its way */
1010             ifp->if_ipackets++;                 /* Success! */
1011           }
1012           XE_OUTW(XE_DO, 0x8000);               /* skip_rx_packet command */
1013         }
1014       }
1015       else if (rsr & XE_RSR_LONG_PACKET) {      /* Packet length >1518 bytes */
1016         scp->mibdata.dot3StatsFrameTooLongs++;
1017         ifp->if_ierrors++;
1018       }
1019       else if (rsr & XE_RSR_CRC_ERROR) {        /* Bad checksum on packet */
1020         scp->mibdata.dot3StatsFCSErrors++;
1021         ifp->if_ierrors++;
1022       }
1023       else if (rsr & XE_RSR_ALIGN_ERROR) {      /* Packet alignment error */
1024         scp->mibdata.dot3StatsAlignmentErrors++;
1025         ifp->if_ierrors++;
1026       }
1027     }
1028     if (rxs & 0x10) {                           /* Receiver overrun */
1029       scp->mibdata.dot3StatsInternalMacReceiveErrors++;
1030       ifp->if_ierrors++;
1031       XE_OUTB(XE_CR, XE_CR_CLEAR_OVERRUN);
1032     }
1033   }
1034
1035   XE_SELECT_PAGE(psr);                          /* Restore saved page */
1036   XE_OUTB(XE_CR, XE_CR_ENABLE_INTR);            /* Re-enable interrupts */
1037
1038   /* Could force an int here, instead of dropping packets? */
1039   /* XE_OUTB(XE_CR, XE_CR_ENABLE_INTR|XE_CE_FORCE_INTR); */
1040
1041   return;
1042 }
1043
1044
1045 /*
1046  * Device timeout/watchdog routine.  Called automatically if we queue a packet
1047  * for transmission but don't get an interrupt within a specified timeout
1048  * (usually 5 seconds).  When this happens we assume the worst and reset the
1049  * card.
1050  */
1051 static void
1052 xe_watchdog(struct ifnet *ifp) {
1053   struct xe_softc *scp = ifp->if_softc;
1054
1055   if_printf(ifp, "watchdog timeout; resetting card\n");
1056   scp->tx_timeouts++;
1057   ifp->if_oerrors += scp->tx_queued;
1058   xe_stop(scp);
1059   xe_hard_reset(scp);
1060   xe_setmedia(scp);
1061   xe_init(scp);
1062 }
1063
1064
1065 /*
1066  * Change media selection.
1067  */
1068 static int
1069 xe_media_change(struct ifnet *ifp) {
1070   struct xe_softc *scp = ifp->if_softc;
1071
1072 #ifdef XE_DEBUG
1073   if_printf(ifp, "media_change\n");
1074 #endif
1075
1076   if (IFM_TYPE(scp->ifm->ifm_media) != IFM_ETHER)
1077     return(EINVAL);
1078
1079   /*
1080    * Some card/media combos aren't always possible -- filter those out here.
1081    */
1082   if ((IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_AUTO ||
1083        IFM_SUBTYPE(scp->ifm->ifm_media) == IFM_100_TX) && !scp->phy_ok)
1084     return (EINVAL);
1085
1086   xe_setmedia(scp);
1087
1088   return 0;
1089 }
1090
1091
1092 /*
1093  * Return current media selection.
1094  */
1095 static void
1096 xe_media_status(struct ifnet *ifp, struct ifmediareq *mrp) {
1097
1098 #ifdef XE_DEBUG
1099   if_printf(ifp, "media_status\n");
1100 #endif
1101
1102   mrp->ifm_active = ((struct xe_softc *)ifp->if_softc)->media;
1103
1104   return;
1105 }
1106
1107
1108 /*
1109  * Select active media.
1110  */
1111 static void xe_setmedia(void *xscp) {
1112   struct xe_softc *scp = xscp;
1113   u_int16_t bmcr, bmsr, anar, lpar;
1114
1115 #ifdef XE_DEBUG
1116   if_printf(scp->ifp, "setmedia\n");
1117 #endif
1118
1119   /* Cancel any pending timeout */
1120   callout_stop(&scp->xe_timer);
1121   xe_disable_intr(scp);
1122
1123   /* Select media */
1124   scp->media = IFM_ETHER;
1125   switch (IFM_SUBTYPE(scp->ifm->ifm_media)) {
1126
1127    case IFM_AUTO:       /* Autoselect media */
1128     scp->media = IFM_ETHER|IFM_AUTO;
1129
1130     /*
1131      * Autoselection is really awful.  It goes something like this:
1132      *
1133      * Wait until the transmitter goes idle (2sec timeout).
1134      * Reset card
1135      *   IF a 100Mbit PHY exists
1136      *     Start NWAY autonegotiation (3.5sec timeout)
1137      *     IF that succeeds
1138      *       Select 100baseTX or 10baseT, whichever was detected
1139      *     ELSE
1140      *       Reset card
1141      *       IF a 100Mbit PHY exists
1142      *         Try to force a 100baseTX link (3sec timeout)
1143      *         IF that succeeds
1144      *           Select 100baseTX
1145      *         ELSE
1146      *           Disable the PHY
1147      *         ENDIF
1148      *       ENDIF
1149      *     ENDIF
1150      *   ENDIF
1151      * IF nothing selected so far
1152      *   IF a 100Mbit PHY exists
1153      *     Select 10baseT
1154      *   ELSE
1155      *     Select 10baseT or 10base2, whichever is connected
1156      *   ENDIF
1157      * ENDIF
1158      */
1159     switch (scp->autoneg_status) {
1160
1161      case XE_AUTONEG_NONE:
1162 #if XE_DEBUG > 1
1163       if_printf(scp->ifp, "Waiting for idle transmitter\n");
1164 #endif
1165       scp->arpcom.ac_if.if_flags |= IFF_OACTIVE;
1166       scp->autoneg_status = XE_AUTONEG_WAITING;
1167       callout_reset(&scp->xe_timer, hz * 2, xe_setmedia, scp);
1168       return;
1169
1170      case XE_AUTONEG_WAITING:
1171       xe_soft_reset(scp);
1172       if (scp->phy_ok) {
1173 #if XE_DEBUG > 1
1174         if_printf(scp->ifp, "Starting autonegotiation\n");
1175 #endif
1176         bmcr = xe_phy_readreg(scp, PHY_BMCR);
1177         bmcr &= ~(PHY_BMCR_AUTONEGENBL);
1178         xe_phy_writereg(scp, PHY_BMCR, bmcr);
1179         anar = xe_phy_readreg(scp, PHY_ANAR);
1180         anar &= ~(PHY_ANAR_100BT4|PHY_ANAR_100BTXFULL|PHY_ANAR_10BTFULL);
1181         anar |= PHY_ANAR_100BTXHALF|PHY_ANAR_10BTHALF;
1182         xe_phy_writereg(scp, PHY_ANAR, anar);
1183         bmcr |= PHY_BMCR_AUTONEGENBL|PHY_BMCR_AUTONEGRSTR;
1184         xe_phy_writereg(scp, PHY_BMCR, bmcr);
1185         scp->autoneg_status = XE_AUTONEG_STARTED;
1186         callout_reset(&scp->xe_timer, hz * 7 / 2, xe_setmedia, scp);
1187         return;
1188       }
1189       else {
1190         scp->autoneg_status = XE_AUTONEG_FAIL;
1191       }
1192       break;
1193
1194      case XE_AUTONEG_STARTED:
1195       bmsr = xe_phy_readreg(scp, PHY_BMSR);
1196       lpar = xe_phy_readreg(scp, PHY_LPAR);
1197       if (bmsr & (PHY_BMSR_AUTONEGCOMP|PHY_BMSR_LINKSTAT)) {
1198 #if XE_DEBUG > 1
1199         if_printf(scp->ifp, "Autonegotiation complete!\n");
1200 #endif
1201         /*
1202          * XXX - Shouldn't have to do this, but (on my hub at least) the
1203          * XXX - transmitter won't work after a successful autoneg.  So we see
1204          * XXX - what the negotiation result was and force that mode.  I'm
1205          * XXX - sure there is an easy fix for this.
1206          */
1207         if (lpar & PHY_LPAR_100BTXHALF) {
1208           xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1209           XE_MII_DUMP(scp);
1210           XE_SELECT_PAGE(2);
1211           XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1212           scp->media = IFM_ETHER|IFM_100_TX;
1213           scp->autoneg_status = XE_AUTONEG_NONE;
1214         }
1215         else {
1216           /*
1217            * XXX - Bit of a hack going on in here.
1218            * XXX - This is derived from Ken Hughes patch to the Linux driver
1219            * XXX - to make it work with 10Mbit _autonegotiated_ links on CE3B
1220            * XXX - cards.  What's a CE3B and how's it differ from a plain CE3?
1221            * XXX - these are the things we need to find out.
1222            */
1223           xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1224           XE_SELECT_PAGE(2);
1225           /* BEGIN HACK */
1226           XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1227           XE_SELECT_PAGE(0x42);
1228           XE_OUTB(XE_SWC1, 0x80);
1229           scp->media = IFM_ETHER|IFM_10_T;
1230           scp->autoneg_status = XE_AUTONEG_NONE;
1231           /* END HACK */
1232           /*XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);*/  /* Disable PHY? */
1233           /*scp->autoneg_status = XE_AUTONEG_FAIL;*/
1234         }
1235       }
1236       else {
1237 #if XE_DEBUG > 1
1238         if_printf(scp->ifp, "Autonegotiation failed; trying 100baseTX\n");
1239 #endif
1240         XE_MII_DUMP(scp);
1241         xe_soft_reset(scp);
1242         if (scp->phy_ok) {
1243           xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1244           scp->autoneg_status = XE_AUTONEG_100TX;
1245           callout_reset(&scp->xe_timer, hz * 3, xe_setmedia, scp);
1246           return;
1247         }
1248         else {
1249           scp->autoneg_status = XE_AUTONEG_FAIL;
1250         }
1251       }
1252       break;
1253
1254      case XE_AUTONEG_100TX:
1255       (void)xe_phy_readreg(scp, PHY_BMSR);
1256       bmsr = xe_phy_readreg(scp, PHY_BMSR);
1257       if (bmsr & PHY_BMSR_LINKSTAT) {
1258 #if XE_DEBUG > 1
1259         if_printf(scp->ifp, "Got 100baseTX link!\n");
1260 #endif
1261         XE_MII_DUMP(scp);
1262         XE_SELECT_PAGE(2);
1263         XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1264         scp->media = IFM_ETHER|IFM_100_TX;
1265         scp->autoneg_status = XE_AUTONEG_NONE;
1266       }
1267       else {
1268 #if XE_DEBUG > 1
1269         if_printf(scp->ifp, "Autonegotiation failed; disabling PHY\n");
1270 #endif
1271         XE_MII_DUMP(scp);
1272         xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1273         XE_SELECT_PAGE(2);
1274         XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);        /* Disable PHY? */
1275         scp->autoneg_status = XE_AUTONEG_FAIL;
1276       }
1277       break;
1278     }
1279
1280     /*
1281      * If we got down here _and_ autoneg_status is XE_AUTONEG_FAIL, then
1282      * either autonegotiation failed, or never got started to begin with.  In
1283      * either case, select a suitable 10Mbit media and hope it works.  We
1284      * don't need to reset the card again, since it will have been done
1285      * already by the big switch above.
1286      */
1287     if (scp->autoneg_status == XE_AUTONEG_FAIL) {
1288 #if XE_DEBUG > 1
1289       if_printf(scp->ifp, "Selecting 10baseX\n");
1290 #endif
1291       if (scp->mohawk) {
1292         XE_SELECT_PAGE(0x42);
1293         XE_OUTB(XE_SWC1, 0x80);
1294         scp->media = IFM_ETHER|IFM_10_T;
1295         scp->autoneg_status = XE_AUTONEG_NONE;
1296       }
1297       else {
1298         XE_SELECT_PAGE(4);
1299         XE_OUTB(XE_GPR0, 4);
1300         DELAY(50000);
1301         XE_SELECT_PAGE(0x42);
1302         XE_OUTB(XE_SWC1, (XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? 0x80 : 0xc0);
1303         scp->media = IFM_ETHER|((XE_INB(XE_ESR) & XE_ESR_MEDIA_SELECT) ? IFM_10_T : IFM_10_2);
1304         scp->autoneg_status = XE_AUTONEG_NONE;
1305       }
1306     }
1307     break;
1308
1309
1310     /*
1311      * If a specific media has been requested, we just reset the card and
1312      * select it (one small exception -- if 100baseTX is requested by there is
1313      * no PHY, we fall back to 10baseT operation).
1314      */
1315    case IFM_100_TX:     /* Force 100baseTX */
1316     xe_soft_reset(scp);
1317     if (scp->phy_ok) {
1318 #if XE_DEBUG > 1
1319       if_printf(scp->ifp, "Selecting 100baseTX\n");
1320 #endif
1321       XE_SELECT_PAGE(0x42);
1322       XE_OUTB(XE_SWC1, 0);
1323       xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_SPEEDSEL);
1324       XE_SELECT_PAGE(2);
1325       XE_OUTB(XE_MSR, XE_INB(XE_MSR) | 0x08);
1326       scp->media |= IFM_100_TX;
1327       break;
1328     }
1329     /* FALLTHROUGH */
1330
1331    case IFM_10_T:       /* Force 10baseT */
1332     xe_soft_reset(scp);
1333 #if XE_DEBUG > 1
1334     if_printf(scp->ifp, "Selecting 10baseT\n");
1335 #endif
1336     if (scp->phy_ok) {
1337       xe_phy_writereg(scp, PHY_BMCR, 0x0000);
1338       XE_SELECT_PAGE(2);
1339       XE_OUTB(XE_MSR, XE_INB(XE_MSR) & ~0x08);  /* Disable PHY */
1340     }
1341     XE_SELECT_PAGE(0x42);
1342     XE_OUTB(XE_SWC1, 0x80);
1343     scp->media |= IFM_10_T;
1344     break;
1345
1346    case IFM_10_2:
1347     xe_soft_reset(scp);
1348 #if XE_DEBUG > 1
1349     if_printf(scp->ifp, "Selecting 10base2\n");
1350 #endif
1351     XE_SELECT_PAGE(0x42);
1352     XE_OUTB(XE_SWC1, 0xc0);
1353     scp->media |= IFM_10_2;
1354     break;
1355   }
1356
1357
1358   /*
1359    * Finally, the LEDs are set to match whatever media was chosen and the
1360    * transmitter is unblocked.
1361    */
1362 #if XE_DEBUG > 1
1363   if_printf(scp->ifp, "Setting LEDs\n");
1364 #endif
1365   XE_SELECT_PAGE(2);
1366   switch (IFM_SUBTYPE(scp->media)) {
1367    case IFM_100_TX:
1368    case IFM_10_T:
1369     XE_OUTB(XE_LED, 0x3b);
1370     if (scp->dingo)
1371       XE_OUTB(0x0b, 0x04);      /* 100Mbit LED */
1372     break;
1373
1374    case IFM_10_2:
1375     XE_OUTB(XE_LED, 0x3a);
1376     break;
1377   }
1378
1379   /* Restart output? */
1380   scp->ifp->if_flags &= ~IFF_OACTIVE;
1381   xe_init(scp);
1382 }
1383
1384
1385 /*
1386  * Hard reset (power cycle) the card.
1387  */
1388 static void
1389 xe_hard_reset(struct xe_softc *scp) {
1390
1391 #ifdef XE_DEBUG
1392   if_printf(scp->ifp, "hard_reset\n");
1393 #endif
1394
1395   crit_enter();
1396
1397   /*
1398    * Power cycle the card.
1399    */
1400   XE_SELECT_PAGE(4);
1401   XE_OUTB(XE_GPR1, 0);          /* Power off */
1402   DELAY(40000);
1403
1404   if (scp->mohawk)
1405     XE_OUTB(XE_GPR1, 1);        /* And back on again */
1406   else
1407     XE_OUTB(XE_GPR1, 5);        /* Also set AIC bit, whatever that is */
1408   DELAY(40000);
1409   XE_SELECT_PAGE(0);
1410
1411   crit_exit();
1412 }
1413
1414
1415 /*
1416  * Soft reset the card.  Also makes sure that the ML6692 and 10Mbit controller
1417  * are powered up, sets the silicon revision number in softc, disables
1418  * interrupts and checks for the prescence of a 100Mbit PHY.  This should
1419  * leave us in a position where we can access the PHY and do media
1420  * selection. The function imposes a 0.5s delay while the hardware powers up.
1421  */
1422 static void
1423 xe_soft_reset(struct xe_softc *scp) {
1424
1425 #ifdef XE_DEBUG
1426   if_printf(scp->ifp, "soft_reset\n");
1427 #endif
1428
1429   crit_enter();
1430
1431   /*
1432    * Reset the card, (again).
1433    */
1434   XE_SELECT_PAGE(0);
1435   XE_OUTB(XE_CR, XE_CR_SOFT_RESET);
1436   DELAY(40000);
1437   XE_OUTB(XE_CR, 0);
1438   DELAY(40000);
1439
1440   if (scp->mohawk) {
1441     /*
1442      * set GP1 and GP2 as outputs (bits 2 & 3)
1443      * set GP1 low to power on the ML6692 (bit 0)
1444      * set GP2 high to power on the 10Mhz chip (bit 1)
1445      */
1446     XE_SELECT_PAGE(4);
1447     XE_OUTB(XE_GPR0, 0x0e);
1448   }
1449
1450   /*
1451    * Wait for everything to wake up.
1452    */
1453   DELAY(500000);
1454
1455   /*
1456    * Get silicon revision number.
1457    */
1458   XE_SELECT_PAGE(4);
1459   if (scp->mohawk)
1460     scp->srev = (XE_INB(XE_BOV) & 0x70) >> 4;
1461   else
1462     scp->srev = (XE_INB(XE_BOV) & 0x30) >> 4;
1463 #ifdef XE_DEBUG
1464   if_printf(scp->ifp, "silicon revision = %d\n", scp->srev);
1465 #endif
1466
1467   /*
1468    * Shut off interrupts.
1469    */
1470   xe_disable_intr(scp);
1471
1472   /*
1473    * Check for PHY.
1474    */
1475   if (scp->mohawk) {
1476     scp->phy_ok = xe_mii_init(scp);
1477   }
1478
1479   XE_SELECT_PAGE(0);
1480
1481   crit_exit();
1482 }
1483
1484
1485 /*
1486  * Take interface offline.  This is done by powering down the device, which I
1487  * assume means just shutting down the transceiver and Ethernet logic.  This
1488  * requires a _hard_ reset to recover from, as we need to power up again.
1489  */
1490 static void
1491 xe_stop(struct xe_softc *scp) {
1492
1493 #ifdef XE_DEBUG
1494   if_printf(scp->ifp, "stop\n");
1495 #endif
1496
1497   crit_enter();
1498
1499   /*
1500    * Shut off interrupts.
1501    */
1502   xe_disable_intr(scp);
1503
1504   /*
1505    * Power down.
1506    */
1507   XE_SELECT_PAGE(4);
1508   XE_OUTB(XE_GPR1, 0);
1509   XE_SELECT_PAGE(0);
1510
1511   /*
1512    * ~IFF_RUNNING == interface down.
1513    */
1514   scp->ifp->if_flags &= ~IFF_RUNNING;
1515   scp->ifp->if_flags &= ~IFF_OACTIVE;
1516   scp->ifp->if_timer = 0;
1517
1518   crit_exit();
1519 }
1520
1521
1522 /*
1523  * Enable Ethernet interrupts from the card.
1524  */
1525 static void
1526 xe_enable_intr(struct xe_softc *scp) {
1527 #ifdef XE_DEBUG
1528   if_printf(scp->ifp, "enable_intr\n");
1529 #endif
1530
1531   XE_SELECT_PAGE(1);
1532   XE_OUTB(XE_IMR0, 0xff);               /* Unmask everything */
1533   XE_OUTB(XE_IMR1, 0x01);               /* Unmask TX underrun detection */
1534   DELAY(1);
1535
1536   XE_SELECT_PAGE(0);
1537   XE_OUTB(XE_CR, XE_CR_ENABLE_INTR);    /* Enable interrupts */
1538   if (scp->modem && !scp->dingo) {      /* This bit is just magic */
1539     if (!(XE_INB(0x10) & 0x01)) {
1540       XE_OUTB(0x10, 0x11);              /* Unmask master int enable bit */
1541     }
1542   }
1543 }
1544
1545
1546 /*
1547  * Disable all Ethernet interrupts from the card.
1548  */
1549 static void
1550 xe_disable_intr(struct xe_softc *scp) {
1551 #ifdef XE_DEBUG
1552   if_printf(scp->ifp, "disable_intr\n");
1553 #endif
1554
1555   XE_SELECT_PAGE(0);
1556   XE_OUTB(XE_CR, 0);                    /* Disable interrupts */
1557   if (scp->modem && !scp->dingo) {      /* More magic (does this work?) */
1558     XE_OUTB(0x10, 0x10);                /* Mask the master int enable bit */
1559   }
1560
1561   XE_SELECT_PAGE(1);
1562   XE_OUTB(XE_IMR0, 0);                  /* Forbid all interrupts */
1563   XE_OUTB(XE_IMR1, 0);
1564   XE_SELECT_PAGE(0);
1565 }
1566
1567
1568 /*
1569  * Set up multicast filter and promiscuous mode
1570  */
1571 static void
1572 xe_setmulti(struct xe_softc *scp) {
1573   struct ifnet *ifp;
1574   struct ifmultiaddr *ifma;
1575   int count;
1576
1577   ifp = &scp->arpcom.ac_if;
1578
1579   /* Get length of multicast list */
1580   count = 0;
1581   LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
1582     count++;
1583
1584   if ((ifp->if_flags & IFF_PROMISC) || (ifp->if_flags & IFF_ALLMULTI) || (count > 9)) {
1585     /*
1586      * Go into promiscuous mode if either of the PROMISC or ALLMULTI flags are
1587      * set, or if we have been asked to deal with more than 9 multicast
1588      * addresses.  To do this: set MPE and PME in SWC1
1589      */
1590     XE_SELECT_PAGE(0x42);
1591     XE_OUTB(XE_SWC1, 0x06);
1592   }
1593   else if ((ifp->if_flags & IFF_MULTICAST) && (count > 0)) {
1594     /*
1595      * Program the filters for up to 9 addresses
1596      */
1597     XE_SELECT_PAGE(0x42);
1598     XE_OUTB(XE_SWC1, 0x01);
1599     XE_SELECT_PAGE(0x40);
1600     XE_OUTB(XE_CMD0, XE_CMD0_OFFLINE);
1601     /*xe_reg_dump(scp);*/
1602     xe_setaddrs(scp);
1603     /*xe_reg_dump(scp);*/
1604     XE_SELECT_PAGE(0x40);
1605     XE_OUTB(XE_CMD0, XE_CMD0_RX_ENABLE|XE_CMD0_ONLINE);
1606   }
1607   else {
1608     /*
1609      * No multicast operation (default)
1610      */
1611     XE_SELECT_PAGE(0x42);
1612     XE_OUTB(XE_SWC1, 0);
1613   }
1614   XE_SELECT_PAGE(0);
1615 }
1616
1617
1618 /*
1619  * Set up all on-chip addresses (for multicast).  AFAICS, there are 10
1620  * of these things; the first is our MAC address, the other 9 are mcast
1621  * addresses, padded with the MAC address if there aren't enough.
1622  * XXX - This doesn't work right, but I'm not sure why yet.  We seem to be
1623  * XXX - doing much the same as the Linux code, which is weird enough that
1624  * XXX - it's probably right (despite my earlier comments to the contrary).
1625  */
1626 static void
1627 xe_setaddrs(struct xe_softc *scp) {
1628   struct ifmultiaddr *ifma;
1629   u_int8_t *addr;
1630   u_int8_t page, slot, byte, i;
1631
1632   ifma = LIST_FIRST(&scp->arpcom.ac_if.if_multiaddrs);
1633
1634   XE_SELECT_PAGE(page = 0x50);
1635
1636   for (slot = 0, byte = 8; slot < 10; slot++) {
1637
1638     if (slot == 0)
1639       addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1640     else {
1641       while (ifma != NULL && ifma->ifma_addr->sa_family != AF_LINK)
1642         ifma = LIST_NEXT(ifma, ifma_link);
1643       if (ifma != NULL)
1644         addr = LLADDR((struct sockaddr_dl *)ifma->ifma_addr);
1645       else
1646         addr = (u_int8_t *)(&scp->arpcom.ac_enaddr);
1647     }
1648
1649     for (i = 0; i < 6; i++, byte++) {
1650 #if XE_DEBUG > 2
1651       if (i)
1652         printf(":%x", addr[i]);
1653       else
1654         if_printf(scp->ifp, "individual addresses %d: %x", slot, addr[0]);
1655 #endif
1656
1657       if (byte > 15) {
1658         page++;
1659         byte = 8;
1660         XE_SELECT_PAGE(page);
1661       }
1662
1663       if (scp->mohawk)
1664         XE_OUTB(byte, addr[5 - i]);
1665       else
1666         XE_OUTB(byte, addr[i]);
1667     }
1668 #if XE_DEBUG > 2
1669     printf("\n");
1670 #endif
1671   }
1672
1673   XE_SELECT_PAGE(0);
1674 }
1675
1676
1677 /*
1678  * Write an outgoing packet to the card using programmed I/O.
1679  */
1680 static int
1681 xe_pio_write_packet(struct xe_softc *scp, struct mbuf *mbp) {
1682   struct mbuf *mbp2;
1683   u_int16_t len, pad, free, ok;
1684   u_int8_t *data;
1685   u_int8_t savebyte[2], wantbyte;
1686
1687   /* Get total packet length */
1688   for (len = 0, mbp2 = mbp; mbp2 != NULL; len += mbp2->m_len, mbp2 = mbp2->m_next);
1689
1690   /* Packets < minimum length may need to be padded out */
1691   pad = 0;
1692   if (len < ETHER_MIN_LEN - ETHER_CRC_LEN) {
1693     pad = (ETHER_MIN_LEN - ETHER_CRC_LEN - len + 1) >> 1;
1694     len = ETHER_MIN_LEN - ETHER_CRC_LEN;
1695   }
1696
1697   /* Check transmit buffer space */
1698   XE_SELECT_PAGE(0);
1699   XE_OUTW(XE_TRS, len+2);
1700   free = XE_INW(XE_TSO);
1701   ok = free & 0x8000;
1702   free &= 0x7fff;
1703   if (free <= len + 2)
1704     return 1;
1705
1706   /* Send packet length to card */
1707   XE_OUTW(XE_EDP, len);
1708
1709   /*
1710    * Write packet to card using PIO (code stolen from the ed driver)
1711    */
1712   wantbyte = 0;
1713   while (mbp != NULL) {
1714     len = mbp->m_len;
1715     if (len > 0) {
1716       data = mtod(mbp, caddr_t);
1717       if (wantbyte) {           /* Finish the last word */
1718         savebyte[1] = *data;
1719         XE_OUTW(XE_EDP, *(u_short *)savebyte);
1720         data++;
1721         len--;
1722         wantbyte = 0;
1723       }
1724       if (len > 1) {            /* Output contiguous words */
1725         bus_space_write_multi_2(scp->bst, scp->bsh, XE_EDP, (u_int16_t *) data,
1726          len >> 1);
1727         data += len & ~1;
1728         len &= 1;
1729       }
1730       if (len == 1) {           /* Save last byte, if necessary */
1731         savebyte[0] = *data;
1732         wantbyte = 1;
1733       }
1734     }
1735     mbp = mbp->m_next;
1736   }
1737   if (wantbyte)                 /* Last byte for odd-length packets */
1738     XE_OUTW(XE_EDP, *(u_short *)savebyte);
1739
1740   /*
1741    * For CE3 cards, just tell 'em to send -- apparently the card will pad out
1742    * short packets with random cruft.  Otherwise, write nonsense words to fill
1743    * out the packet.  I guess it is then sent automatically (?)
1744    */
1745   if (scp->mohawk)
1746     XE_OUTB(XE_CR, XE_CR_TX_PACKET|XE_CR_ENABLE_INTR);
1747   else
1748     while (pad > 0) {
1749       XE_OUTW(XE_EDP, 0xdead);
1750       pad--;
1751     }
1752
1753   return 0;
1754 }
1755
1756 #if 0
1757 /*
1758  * Compute the 32-bit Ethernet CRC for the given buffer.
1759  */
1760 static u_int32_t
1761 xe_compute_crc(u_int8_t *data, int len) {
1762   u_int32_t crc = 0xffffffff;
1763   u_int32_t poly = 0x04c11db6;
1764   u_int8_t current, crc31, bit;
1765   int i, k;
1766
1767   for (i = 0; i < len; i++) {
1768     current = data[i];
1769     for (k = 1; k <= 8; k++) {
1770       if (crc & 0x80000000) {
1771         crc31 = 0x01;
1772       }
1773       else {
1774         crc31 = 0;
1775       }
1776       bit = crc31 ^ (current & 0x01);
1777       crc <<= 1;
1778       current >>= 1;
1779       if (bit) {
1780         crc = (crc ^ poly)|1;
1781       }
1782     }
1783   }
1784   return crc;
1785 }
1786
1787
1788 /*
1789  * Convert a CRC into an index into the multicast hash table.  What we do is
1790  * take the most-significant 6 bits of the CRC, reverse them, and use that as
1791  * the bit number in the hash table.  Bits 5:3 of the result give the byte
1792  * within the table (0-7); bits 2:0 give the bit number within that byte (also
1793  * 0-7), ie. the number of shifts needed to get it into the lsb position.
1794  */
1795 static int
1796 xe_compute_hashbit(u_int32_t crc) {
1797   u_int8_t hashbit = 0;
1798   int i;
1799
1800   for (i = 0; i < 6; i++) {
1801     hashbit >>= 1;
1802     if (crc & 0x80000000) {
1803       hashbit &= 0x80;
1804     }
1805     crc <<= 1;
1806   }
1807   return (hashbit >> 2);
1808 }
1809
1810 #endif
1811
1812
1813
1814 /**************************************************************
1815  *                                                            *
1816  *                  M I I  F U N C T I O N S                  *
1817  *                                                            *
1818  **************************************************************/
1819
1820 /*
1821  * Alternative MII/PHY handling code adapted from the xl driver.  It doesn't
1822  * seem to work any better than the xirc2_ps stuff, but it's cleaner code.
1823  * XXX - this stuff shouldn't be here.  It should all be abstracted off to
1824  * XXX - some kind of common MII-handling code, shared by all drivers.  But
1825  * XXX - that's a whole other mission.
1826  */
1827 #define XE_MII_SET(x)   XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) | (x))
1828 #define XE_MII_CLR(x)   XE_OUTB(XE_GPR2, (XE_INB(XE_GPR2) | 0x04) & ~(x))
1829
1830
1831 /*
1832  * Sync the PHYs by setting data bit and strobing the clock 32 times.
1833  */
1834 static void
1835 xe_mii_sync(struct xe_softc *scp) {
1836   int i;
1837
1838   XE_SELECT_PAGE(2);
1839   XE_MII_SET(XE_MII_DIR|XE_MII_WRD);
1840
1841   for (i = 0; i < 32; i++) {
1842     XE_MII_SET(XE_MII_CLK);
1843     DELAY(1);
1844     XE_MII_CLR(XE_MII_CLK);
1845     DELAY(1);
1846   }
1847 }
1848
1849
1850 /*
1851  * Look for a MII-compliant PHY.  If we find one, reset it.
1852  */
1853 static int
1854 xe_mii_init(struct xe_softc *scp) {
1855   u_int16_t status;
1856
1857   status = xe_phy_readreg(scp, PHY_BMSR);
1858   if ((status & 0xff00) != 0x7800) {
1859 #if XE_DEBUG > 1
1860     if_printf(scp->ifp, "no PHY found, %0x\n", status);
1861 #endif
1862     return 0;
1863   }
1864   else {
1865 #if XE_DEBUG > 1
1866     if_printf(scp->ifp, "PHY OK!\n");
1867 #endif
1868
1869     /* Reset the PHY */
1870     xe_phy_writereg(scp, PHY_BMCR, PHY_BMCR_RESET);
1871     DELAY(500);
1872     while(xe_phy_readreg(scp, PHY_BMCR) & PHY_BMCR_RESET);
1873     XE_MII_DUMP(scp);
1874     return 1;
1875   }
1876 }
1877
1878
1879 /*
1880  * Clock a series of bits through the MII.
1881  */
1882 static void
1883 xe_mii_send(struct xe_softc *scp, u_int32_t bits, int cnt) {
1884   int i;
1885
1886   XE_SELECT_PAGE(2);
1887   XE_MII_CLR(XE_MII_CLK);
1888
1889   for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
1890     if (bits & i) {
1891       XE_MII_SET(XE_MII_WRD);
1892     } else {
1893       XE_MII_CLR(XE_MII_WRD);
1894     }
1895     DELAY(1);
1896     XE_MII_CLR(XE_MII_CLK);
1897     DELAY(1);
1898     XE_MII_SET(XE_MII_CLK);
1899   }
1900 }
1901
1902
1903 /*
1904  * Read an PHY register through the MII.
1905  */
1906 static int
1907 xe_mii_readreg(struct xe_softc *scp, struct xe_mii_frame *frame) {
1908   int i, ack;
1909
1910   crit_enter();
1911
1912   /*
1913    * Set up frame for RX.
1914    */
1915   frame->mii_stdelim = XE_MII_STARTDELIM;
1916   frame->mii_opcode = XE_MII_READOP;
1917   frame->mii_turnaround = 0;
1918   frame->mii_data = 0;
1919
1920   XE_SELECT_PAGE(2);
1921   XE_OUTB(XE_GPR2, 0);
1922
1923   /*
1924    * Turn on data xmit.
1925    */
1926   XE_MII_SET(XE_MII_DIR);
1927
1928   xe_mii_sync(scp);
1929
1930   /*
1931    * Send command/address info.
1932    */
1933   xe_mii_send(scp, frame->mii_stdelim, 2);
1934   xe_mii_send(scp, frame->mii_opcode, 2);
1935   xe_mii_send(scp, frame->mii_phyaddr, 5);
1936   xe_mii_send(scp, frame->mii_regaddr, 5);
1937
1938   /* Idle bit */
1939   XE_MII_CLR((XE_MII_CLK|XE_MII_WRD));
1940   DELAY(1);
1941   XE_MII_SET(XE_MII_CLK);
1942   DELAY(1);
1943
1944   /* Turn off xmit. */
1945   XE_MII_CLR(XE_MII_DIR);
1946
1947   /* Check for ack */
1948   XE_MII_CLR(XE_MII_CLK);
1949   DELAY(1);
1950   ack = XE_INB(XE_GPR2) & XE_MII_RDD;
1951   XE_MII_SET(XE_MII_CLK);
1952   DELAY(1);
1953
1954   /*
1955    * Now try reading data bits. If the ack failed, we still
1956    * need to clock through 16 cycles to keep the PHY(s) in sync.
1957    */
1958   if (ack) {
1959     for(i = 0; i < 16; i++) {
1960       XE_MII_CLR(XE_MII_CLK);
1961       DELAY(1);
1962       XE_MII_SET(XE_MII_CLK);
1963       DELAY(1);
1964     }
1965     goto fail;
1966   }
1967
1968   for (i = 0x8000; i; i >>= 1) {
1969     XE_MII_CLR(XE_MII_CLK);
1970     DELAY(1);
1971     if (!ack) {
1972       if (XE_INB(XE_GPR2) & XE_MII_RDD)
1973         frame->mii_data |= i;
1974       DELAY(1);
1975     }
1976     XE_MII_SET(XE_MII_CLK);
1977     DELAY(1);
1978   }
1979
1980 fail:
1981
1982   XE_MII_CLR(XE_MII_CLK);
1983   DELAY(1);
1984   XE_MII_SET(XE_MII_CLK);
1985   DELAY(1);
1986
1987   crit_exit();
1988
1989   if (ack)
1990     return(1);
1991   return(0);
1992 }
1993
1994
1995 /*
1996  * Write to a PHY register through the MII.
1997  */
1998 static int
1999 xe_mii_writereg(struct xe_softc *scp, struct xe_mii_frame *frame) {
2000
2001   crit_enter();
2002
2003   /*
2004    * Set up frame for TX.
2005    */
2006   frame->mii_stdelim = XE_MII_STARTDELIM;
2007   frame->mii_opcode = XE_MII_WRITEOP;
2008   frame->mii_turnaround = XE_MII_TURNAROUND;
2009
2010   XE_SELECT_PAGE(2);
2011
2012   /*
2013    * Turn on data output.
2014    */
2015   XE_MII_SET(XE_MII_DIR);
2016
2017   xe_mii_sync(scp);
2018
2019   xe_mii_send(scp, frame->mii_stdelim, 2);
2020   xe_mii_send(scp, frame->mii_opcode, 2);
2021   xe_mii_send(scp, frame->mii_phyaddr, 5);
2022   xe_mii_send(scp, frame->mii_regaddr, 5);
2023   xe_mii_send(scp, frame->mii_turnaround, 2);
2024   xe_mii_send(scp, frame->mii_data, 16);
2025
2026   /* Idle bit. */
2027   XE_MII_SET(XE_MII_CLK);
2028   DELAY(1);
2029   XE_MII_CLR(XE_MII_CLK);
2030   DELAY(1);
2031
2032   /*
2033    * Turn off xmit.
2034    */
2035   XE_MII_CLR(XE_MII_DIR);
2036
2037   crit_exit();
2038
2039   return(0);
2040 }
2041
2042
2043 /*
2044  * Read a register from the PHY.
2045  */
2046 static u_int16_t
2047 xe_phy_readreg(struct xe_softc *scp, u_int16_t reg) {
2048   struct xe_mii_frame frame;
2049
2050   bzero((char *)&frame, sizeof(frame));
2051
2052   frame.mii_phyaddr = 0;
2053   frame.mii_regaddr = reg;
2054   xe_mii_readreg(scp, &frame);
2055
2056   return(frame.mii_data);
2057 }
2058
2059
2060 /*
2061  * Write to a PHY register.
2062  */
2063 static void
2064 xe_phy_writereg(struct xe_softc *scp, u_int16_t reg, u_int16_t data) {
2065   struct xe_mii_frame frame;
2066
2067   bzero((char *)&frame, sizeof(frame));
2068
2069   frame.mii_phyaddr = 0;
2070   frame.mii_regaddr = reg;
2071   frame.mii_data = data;
2072   xe_mii_writereg(scp, &frame);
2073
2074   return;
2075 }
2076
2077
2078 #ifdef XE_DEBUG
2079 /*
2080  * A bit of debugging code.
2081  */
2082 static void
2083 xe_mii_dump(struct xe_softc *scp) {
2084   int i;
2085
2086   crit_enter();
2087
2088   if_printf(scp->ifp, "MII registers: ");
2089   for (i = 0; i < 2; i++) {
2090     printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2091   }
2092   for (i = 4; i < 7; i++) {
2093     printf(" %d:%04x", i, xe_phy_readreg(scp, i));
2094   }
2095   printf("\n");
2096
2097   crit_exit();
2098 }
2099
2100 static void
2101 xe_reg_dump(struct xe_softc *scp) {
2102   int page, i;
2103
2104   crit_enter();
2105
2106   if_printf(scp->ifp, "Common registers: ");
2107   for (i = 0; i < 8; i++) {
2108     printf(" %2.2x", XE_INB(i));
2109   }
2110   printf("\n");
2111
2112   for (page = 0; page <= 8; page++) {
2113     if_printf(scp->ifp, "Register page %2.2x: ", page);
2114     XE_SELECT_PAGE(page);
2115     for (i = 8; i < 16; i++) {
2116       printf(" %2.2x", XE_INB(i));
2117     }
2118     printf("\n");
2119   }
2120
2121   for (page = 0x10; page < 0x5f; page++) {
2122     if ((page >= 0x11 && page <= 0x3f) ||
2123         (page == 0x41) ||
2124         (page >= 0x43 && page <= 0x4f) ||
2125         (page >= 0x59))
2126       continue;
2127     if_printf(scp->ifp, "Register page %2.2x: ", page);
2128     XE_SELECT_PAGE(page);
2129     for (i = 8; i < 16; i++) {
2130       printf(" %2.2x", XE_INB(i));
2131     }
2132     printf("\n");
2133   }
2134
2135   crit_exit();
2136 }
2137 #endif
2138
2139 int
2140 xe_activate(device_t dev)
2141 {
2142         struct xe_softc *sc = device_get_softc(dev);
2143         int start, err;
2144
2145         if (!sc->dingo) {
2146                 sc->port_rid = 0;       /* 0 is managed by pccard */
2147                 sc->port_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
2148                     &sc->port_rid, 0, ~0, 16, RF_ACTIVE);
2149         } else {
2150                 /*
2151                  * Find a 16 byte aligned ioport for the card.
2152                  */
2153 #if XE_DEBUG > 0
2154                 device_printf(dev, "Finding an aligned port for RealPort\n");
2155 #endif /* XE_DEBUG */
2156                 sc->port_rid = 1;       /* 0 is managed by pccard */
2157                 start = 0x100;
2158                 do {
2159                         sc->port_res = bus_alloc_resource(dev,
2160                             SYS_RES_IOPORT, &sc->port_rid, start, 0x3ff, 16,
2161                             RF_ACTIVE);
2162                         if (sc->port_res == 0)
2163                                 break;          /* we failed */
2164                         if ((rman_get_start(sc->port_res) & 0xf) == 0)
2165                                 break;          /* good */
2166                         bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid,
2167                             sc->port_res);
2168                         start = (rman_get_start(sc->port_res) + 15) & ~0xf;
2169                 } while (1);
2170 #if XE_DEBUG > 2
2171                 device_printf(dev, "port 0x%0lx, size 0x%0lx\n",
2172                     bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid),
2173                     bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid));
2174 #endif /* XE_DEBUG */
2175         }
2176         if (!sc->port_res) {
2177 #if XE_DEBUG > 0
2178                 device_printf(dev, "Cannot allocate ioport\n");
2179 #endif
2180                 return ENOMEM;
2181         }
2182
2183         sc->irq_rid = 0;
2184         sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irq_rid,
2185             RF_ACTIVE);
2186         if (!sc->irq_res) {
2187 #if XE_DEBUG > 0
2188                 device_printf(dev, "Cannot allocate irq\n");
2189 #endif
2190                 xe_deactivate(dev);
2191                 return ENOMEM;
2192         }
2193         err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_NET, xe_intr, sc,
2194                              &sc->intrhand, NULL);
2195         if (err) {
2196                 ether_ifdetach(&sc->arpcom.ac_if);
2197                 xe_deactivate(dev);
2198                 return err;
2199         }
2200
2201         sc->bst = rman_get_bustag(sc->port_res);
2202         sc->bsh = rman_get_bushandle(sc->port_res);
2203         return (0);
2204 }
2205
2206 void
2207 xe_deactivate(device_t dev)
2208 {
2209         struct xe_softc *sc = device_get_softc(dev);
2210
2211         if (sc->intrhand)
2212                 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
2213         sc->intrhand = 0;
2214         if (sc->port_res)
2215                 bus_release_resource(dev, SYS_RES_IOPORT, sc->port_rid,
2216                     sc->port_res);
2217         sc->port_res = 0;
2218         if (sc->irq_res)
2219                 bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
2220                     sc->irq_res);
2221         sc->irq_res = 0;
2222         return;
2223 }
2224
2225 static device_method_t xe_pccard_methods[] = {
2226         /* Device interface */
2227         DEVMETHOD(device_probe,         xe_probe),
2228         DEVMETHOD(device_attach,        xe_attach),
2229         DEVMETHOD(device_detach,        xe_detach),
2230
2231         { 0, 0 }
2232 };
2233
2234 static driver_t xe_pccard_driver = {
2235         "xe",
2236         xe_pccard_methods,
2237         sizeof(struct xe_softc),
2238 };
2239
2240 devclass_t xe_devclass;
2241
2242 DECLARE_DUMMY_MODULE(if_xe);
2243 DRIVER_MODULE(if_xe, pccard, xe_pccard_driver, xe_devclass, 0, 0);
2244