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