sys/dev/netif/re/if_re.c

   1 /*
   2  * Copyright (c) 2004
   3  *      Joerg Sonnenberger <joerg@bec.de>.  All rights reserved.
   4  *
   5  * Copyright (c) 1997, 1998-2003
   6  *      Bill Paul <wpaul@windriver.com>.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by Bill Paul.
  19  * 4. Neither the name of the author nor the names of any co-contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  33  * THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  * $FreeBSD: src/sys/dev/re/if_re.c,v 1.25 2004/06/09 14:34:01 naddy Exp $
  36  * $DragonFly: src/sys/dev/netif/re/if_re.c,v 1.25 2006/10/16 13:32:02 sephe Exp $
  37  */
  38
  39 /*
  40  * RealTek 8139C+/8169/8169S/8110S PCI NIC driver
  41  *
  42  * Written by Bill Paul <wpaul@windriver.com>
  43  * Senior Networking Software Engineer
  44  * Wind River Systems
  45  */
  46
  47 /*
  48  * This driver is designed to support RealTek's next generation of
  49  * 10/100 and 10/100/1000 PCI ethernet controllers. There are currently
  50  * four devices in this family: the RTL8139C+, the RTL8169, the RTL8169S
  51  * and the RTL8110S.
  52  *
  53  * The 8139C+ is a 10/100 ethernet chip. It is backwards compatible
  54  * with the older 8139 family, however it also supports a special
  55  * C+ mode of operation that provides several new performance enhancing
  56  * features. These include:
  57  *
  58  *      o Descriptor based DMA mechanism. Each descriptor represents
  59  *        a single packet fragment. Data buffers may be aligned on
  60  *        any byte boundary.
  61  *
  62  *      o 64-bit DMA
  63  *
  64  *      o TCP/IP checksum offload for both RX and TX
  65  *
  66  *      o High and normal priority transmit DMA rings
  67  *
  68  *      o VLAN tag insertion and extraction
  69  *
  70  *      o TCP large send (segmentation offload)
  71  *
  72  * Like the 8139, the 8139C+ also has a built-in 10/100 PHY. The C+
  73  * programming API is fairly straightforward. The RX filtering, EEPROM
  74  * access and PHY access is the same as it is on the older 8139 series
  75  * chips.
  76  *
  77  * The 8169 is a 64-bit 10/100/1000 gigabit ethernet MAC. It has almost the
  78  * same programming API and feature set as the 8139C+ with the following
  79  * differences and additions:
  80  *
  81  *      o 1000Mbps mode
  82  *
  83  *      o Jumbo frames
  84  *
  85  *      o GMII and TBI ports/registers for interfacing with copper
  86  *        or fiber PHYs
  87  *
  88  *      o RX and TX DMA rings can have up to 1024 descriptors
  89  *        (the 8139C+ allows a maximum of 64)
  90  *
  91  *      o Slight differences in register layout from the 8139C+
  92  *
  93  * The TX start and timer interrupt registers are at different locations
  94  * on the 8169 than they are on the 8139C+. Also, the status word in the
  95  * RX descriptor has a slightly different bit layout. The 8169 does not
  96  * have a built-in PHY. Most reference boards use a Marvell 88E1000 'Alaska'
  97  * copper gigE PHY.
  98  *
  99  * The 8169S/8110S 10/100/1000 devices have built-in copper gigE PHYs
 100  * (the 'S' stands for 'single-chip'). These devices have the same
 101  * programming API as the older 8169, but also have some vendor-specific
 102  * registers for the on-board PHY. The 8110S is a LAN-on-motherboard
 103  * part designed to be pin-compatible with the RealTek 8100 10/100 chip.
 104  *
 105  * This driver takes advantage of the RX and TX checksum offload and
 106  * VLAN tag insertion/extraction features. It also implements TX
 107  * interrupt moderation using the timer interrupt registers, which
 108  * significantly reduces TX interrupt load. There is also support
 109  * for jumbo frames, however the 8169/8169S/8110S can not transmit
 110  * jumbo frames larger than 7440, so the max MTU possible with this
 111  * driver is 7422 bytes.
 112  */
 113
 114 #include "opt_polling.h"
 115
 116 #include <sys/param.h>
 117 #include <sys/endian.h>
 118 #include <sys/systm.h>
 119 #include <sys/sockio.h>
 120 #include <sys/mbuf.h>
 121 #include <sys/malloc.h>
 122 #include <sys/module.h>
 123 #include <sys/kernel.h>
 124 #include <sys/socket.h>
 125 #include <sys/serialize.h>
 126 #include <sys/thread2.h>
 127
 128 #include <net/if.h>
 129 #include <net/ifq_var.h>
 130 #include <net/if_arp.h>
 131 #include <net/ethernet.h>
 132 #include <net/if_dl.h>
 133 #include <net/if_media.h>
 134 #include <net/if_types.h>
 135 #include <net/vlan/if_vlan_var.h>
 136
 137 #include <net/bpf.h>
 138
 139 #include <machine/bus_pio.h>
 140 #include <machine/bus_memio.h>
 141 #include <machine/bus.h>
 142 #include <machine/resource.h>
 143 #include <sys/bus.h>
 144 #include <sys/rman.h>
 145
 146 #include <dev/netif/mii_layer/mii.h>
 147 #include <dev/netif/mii_layer/miivar.h>
 148
 149 #include <bus/pci/pcidevs.h>
 150 #include <bus/pci/pcireg.h>
 151 #include <bus/pci/pcivar.h>
 152
 153 /* "controller miibus0" required.  See GENERIC if you get errors here. */
 154 #include "miibus_if.h"
 155
 156 #include <dev/netif/re/if_rereg.h>
 157
 158 /*
 159  * The hardware supports checksumming but, as usual, some chipsets screw it
 160  * all up and produce bogus packets, so we disable it by default.
 161  */
 162 #define RE_CSUM_FEATURES    (CSUM_IP | CSUM_TCP | CSUM_UDP)
 163 #define RE_DISABLE_HWCSUM
 164
 165 /*
 166  * Various supported device vendors/types and their names.
 167  */
 168 static struct re_type re_devs[] = {
 169         { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T, RE_HWREV_8169S,
 170                 "D-Link DGE-528(T) Gigabit Ethernet Adapter" },
 171         { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139, RE_HWREV_8139CPLUS,
 172                 "RealTek 8139C+ 10/100BaseTX" },
 173         { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RE_HWREV_8169,
 174                 "RealTek 8169 Gigabit Ethernet" },
 175         { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RE_HWREV_8169S,
 176                 "RealTek 8169S Single-chip Gigabit Ethernet" },
 177         { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169, RE_HWREV_8110S,
 178                 "RealTek 8110S Single-chip Gigabit Ethernet" },
 179         { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_CG_LAPCIGT, RE_HWREV_8169S,
 180                 "Corega CG-LAPCIGT Gigabit Ethernet" },
 181         { 0, 0, 0, NULL }
 182 };
 183
 184 static struct re_hwrev re_hwrevs[] = {
 185         { RE_HWREV_8139CPLUS, RE_8139CPLUS, "C+"},
 186         { RE_HWREV_8169, RE_8169, "8169"},
 187         { RE_HWREV_8169S, RE_8169, "8169S"},
 188         { RE_HWREV_8110S, RE_8169, "8110S"},
 189         { 0, 0, NULL }
 190 };
 191
 192 static int      re_probe(device_t);
 193 static int      re_attach(device_t);
 194 static int      re_detach(device_t);
 195
 196 static int      re_encap(struct re_softc *, struct mbuf **, int *, int *);
 197
 198 static void     re_dma_map_addr(void *, bus_dma_segment_t *, int, int);
 199 static void     re_dma_map_desc(void *, bus_dma_segment_t *, int,
 200                                 bus_size_t, int);
 201 static int      re_allocmem(device_t, struct re_softc *);
 202 static int      re_newbuf(struct re_softc *, int, struct mbuf *);
 203 static int      re_rx_list_init(struct re_softc *);
 204 static int      re_tx_list_init(struct re_softc *);
 205 static void     re_rxeof(struct re_softc *);
 206 static void     re_txeof(struct re_softc *);
 207 static void     re_intr(void *);
 208 static void     re_tick(void *);
 209 static void     re_tick_serialized(void *);
 210 static void     re_start(struct ifnet *);
 211 static int      re_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
 212 static void     re_init(void *);
 213 static void     re_stop(struct re_softc *);
 214 static void     re_watchdog(struct ifnet *);
 215 static int      re_suspend(device_t);
 216 static int      re_resume(device_t);
 217 static void     re_shutdown(device_t);
 218 static int      re_ifmedia_upd(struct ifnet *);
 219 static void     re_ifmedia_sts(struct ifnet *, struct ifmediareq *);
 220
 221 static void     re_eeprom_putbyte(struct re_softc *, int);
 222 static void     re_eeprom_getword(struct re_softc *, int, u_int16_t *);
 223 static void     re_read_eeprom(struct re_softc *, caddr_t, int, int, int);
 224 static int      re_gmii_readreg(device_t, int, int);
 225 static int      re_gmii_writereg(device_t, int, int, int);
 226
 227 static int      re_miibus_readreg(device_t, int, int);
 228 static int      re_miibus_writereg(device_t, int, int, int);
 229 static void     re_miibus_statchg(device_t);
 230
 231 static void     re_setmulti(struct re_softc *);
 232 static void     re_reset(struct re_softc *);
 233
 234 static int      re_diag(struct re_softc *);
 235 #ifdef DEVICE_POLLING
 236 static void     re_poll(struct ifnet *ifp, enum poll_cmd cmd, int count);
 237 #endif
 238
 239 static device_method_t re_methods[] = {
 240         /* Device interface */
 241         DEVMETHOD(device_probe,         re_probe),
 242         DEVMETHOD(device_attach,        re_attach),
 243         DEVMETHOD(device_detach,        re_detach),
 244         DEVMETHOD(device_suspend,       re_suspend),
 245         DEVMETHOD(device_resume,        re_resume),
 246         DEVMETHOD(device_shutdown,      re_shutdown),
 247
 248         /* bus interface */
 249         DEVMETHOD(bus_print_child,      bus_generic_print_child),
 250         DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
 251
 252         /* MII interface */
 253         DEVMETHOD(miibus_readreg,       re_miibus_readreg),
 254         DEVMETHOD(miibus_writereg,      re_miibus_writereg),
 255         DEVMETHOD(miibus_statchg,       re_miibus_statchg),
 256
 257         { 0, 0 }
 258 };
 259
 260 static driver_t re_driver = {
 261         "re",
 262         re_methods,
 263         sizeof(struct re_softc)
 264 };
 265
 266 static devclass_t re_devclass;
 267
 268 DECLARE_DUMMY_MODULE(if_re);
 269 DRIVER_MODULE(if_re, pci, re_driver, re_devclass, 0, 0);
 270 DRIVER_MODULE(if_re, cardbus, re_driver, re_devclass, 0, 0);
 271 DRIVER_MODULE(miibus, re, miibus_driver, miibus_devclass, 0, 0);
 272
 273 #define EE_SET(x)       \
 274         CSR_WRITE_1(sc, RE_EECMD, CSR_READ_1(sc, RE_EECMD) | (x))
 275
 276 #define EE_CLR(x)       \
 277         CSR_WRITE_1(sc, RE_EECMD, CSR_READ_1(sc, RE_EECMD) & ~(x))
 278
 279 /*
 280  * Send a read command and address to the EEPROM, check for ACK.
 281  */
 282 static void
 283 re_eeprom_putbyte(struct re_softc *sc, int addr)
 284 {
 285         int d, i;
 286
 287         d = addr | sc->re_eecmd_read;
 288
 289         /*
 290          * Feed in each bit and strobe the clock.
 291          */
 292         for (i = 0x400; i != 0; i >>= 1) {
 293                 if (d & i)
 294                         EE_SET(RE_EE_DATAIN);
 295                 else
 296                         EE_CLR(RE_EE_DATAIN);
 297                 DELAY(100);
 298                 EE_SET(RE_EE_CLK);
 299                 DELAY(150);
 300                 EE_CLR(RE_EE_CLK);
 301                 DELAY(100);
 302         }
 303 }
 304
 305 /*
 306  * Read a word of data stored in the EEPROM at address 'addr.'
 307  */
 308 static void
 309 re_eeprom_getword(struct re_softc *sc, int addr, uint16_t *dest)
 310 {
 311         int i;
 312         uint16_t word = 0;
 313
 314         /* Enter EEPROM access mode. */
 315         CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_PROGRAM|RE_EE_SEL);
 316
 317         /*
 318          * Send address of word we want to read.
 319          */
 320         re_eeprom_putbyte(sc, addr);
 321
 322         CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_PROGRAM|RE_EE_SEL);
 323
 324         /*
 325          * Start reading bits from EEPROM.
 326          */
 327         for (i = 0x8000; i != 0; i >>= 1) {
 328                 EE_SET(RE_EE_CLK);
 329                 DELAY(100);
 330                 if (CSR_READ_1(sc, RE_EECMD) & RE_EE_DATAOUT)
 331                         word |= i;
 332                 EE_CLR(RE_EE_CLK);
 333                 DELAY(100);
 334         }
 335
 336         /* Turn off EEPROM access mode. */
 337         CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_OFF);
 338
 339         *dest = word;
 340 }
 341
 342 /*
 343  * Read a sequence of words from the EEPROM.
 344  */
 345 static void
 346 re_read_eeprom(struct re_softc *sc, caddr_t dest, int off, int cnt, int swap)
 347 {
 348         int i;
 349         uint16_t word = 0, *ptr;
 350
 351         for (i = 0; i < cnt; i++) {
 352                 re_eeprom_getword(sc, off + i, &word);
 353                 ptr = (u_int16_t *)(dest + (i * 2));
 354                 if (swap)
 355                         *ptr = be16toh(word);
 356                 else
 357                         *ptr = word;
 358         }
 359 }
 360
 361 static int
 362 re_gmii_readreg(device_t dev, int phy, int reg)
 363 {
 364         struct re_softc *sc = device_get_softc(dev);
 365         u_int32_t rval;
 366         int i;
 367
 368         if (phy != 1)
 369                 return(0);
 370
 371         /* Let the rgephy driver read the GMEDIASTAT register */
 372
 373         if (reg == RE_GMEDIASTAT)
 374                 return(CSR_READ_1(sc, RE_GMEDIASTAT));
 375
 376         CSR_WRITE_4(sc, RE_PHYAR, reg << 16);
 377         DELAY(1000);
 378
 379         for (i = 0; i < RE_TIMEOUT; i++) {
 380                 rval = CSR_READ_4(sc, RE_PHYAR);
 381                 if (rval & RE_PHYAR_BUSY)
 382                         break;
 383                 DELAY(100);
 384         }
 385
 386         if (i == RE_TIMEOUT) {
 387                 device_printf(dev, "PHY read failed\n");
 388                 return(0);
 389         }
 390
 391         return(rval & RE_PHYAR_PHYDATA);
 392 }
 393
 394 static int
 395 re_gmii_writereg(device_t dev, int phy, int reg, int data)
 396 {
 397         struct re_softc *sc = device_get_softc(dev);
 398         uint32_t rval;
 399         int i;
 400
 401         CSR_WRITE_4(sc, RE_PHYAR,
 402                     (reg << 16) | (data & RE_PHYAR_PHYDATA) | RE_PHYAR_BUSY);
 403         DELAY(1000);
 404
 405         for (i = 0; i < RE_TIMEOUT; i++) {
 406                 rval = CSR_READ_4(sc, RE_PHYAR);
 407                 if ((rval & RE_PHYAR_BUSY) == 0)
 408                         break;
 409                 DELAY(100);
 410         }
 411
 412         if (i == RE_TIMEOUT)
 413                 device_printf(dev, "PHY write failed\n");
 414
 415         return(0);
 416 }
 417
 418 static int
 419 re_miibus_readreg(device_t dev, int phy, int reg)
 420 {
 421         struct re_softc *sc = device_get_softc(dev);
 422         uint16_t rval = 0;
 423         uint16_t re8139_reg = 0;
 424
 425         if (sc->re_type == RE_8169) {
 426                 rval = re_gmii_readreg(dev, phy, reg);
 427                 return(rval);
 428         }
 429
 430         /* Pretend the internal PHY is only at address 0 */
 431         if (phy)
 432                 return(0);
 433
 434         switch(reg) {
 435         case MII_BMCR:
 436                 re8139_reg = RE_BMCR;
 437                 break;
 438         case MII_BMSR:
 439                 re8139_reg = RE_BMSR;
 440                 break;
 441         case MII_ANAR:
 442                 re8139_reg = RE_ANAR;
 443                 break;
 444         case MII_ANER:
 445                 re8139_reg = RE_ANER;
 446                 break;
 447         case MII_ANLPAR:
 448                 re8139_reg = RE_LPAR;
 449                 break;
 450         case MII_PHYIDR1:
 451         case MII_PHYIDR2:
 452                 return(0);
 453         /*
 454          * Allow the rlphy driver to read the media status
 455          * register. If we have a link partner which does not
 456          * support NWAY, this is the register which will tell
 457          * us the results of parallel detection.
 458          */
 459         case RE_MEDIASTAT:
 460                 return(CSR_READ_1(sc, RE_MEDIASTAT));
 461         default:
 462                 device_printf(dev, "bad phy register\n");
 463                 return(0);
 464         }
 465         rval = CSR_READ_2(sc, re8139_reg);
 466         return(rval);
 467 }
 468
 469 static int
 470 re_miibus_writereg(device_t dev, int phy, int reg, int data)
 471 {
 472         struct re_softc *sc= device_get_softc(dev);
 473         u_int16_t re8139_reg = 0;
 474
 475         if (sc->re_type == RE_8169)
 476                 return(re_gmii_writereg(dev, phy, reg, data));
 477
 478         /* Pretend the internal PHY is only at address 0 */
 479         if (phy)
 480                 return(0);
 481
 482         switch(reg) {
 483         case MII_BMCR:
 484                 re8139_reg = RE_BMCR;
 485                 break;
 486         case MII_BMSR:
 487                 re8139_reg = RE_BMSR;
 488                 break;
 489         case MII_ANAR:
 490                 re8139_reg = RE_ANAR;
 491                 break;
 492         case MII_ANER:
 493                 re8139_reg = RE_ANER;
 494                 break;
 495         case MII_ANLPAR:
 496                 re8139_reg = RE_LPAR;
 497                 break;
 498         case MII_PHYIDR1:
 499         case MII_PHYIDR2:
 500                 return(0);
 501         default:
 502                 device_printf(dev, "bad phy register\n");
 503                 return(0);
 504         }
 505         CSR_WRITE_2(sc, re8139_reg, data);
 506         return(0);
 507 }
 508
 509 static void
 510 re_miibus_statchg(device_t dev)
 511 {
 512 }
 513
 514 /*
 515  * Program the 64-bit multicast hash filter.
 516  */
 517 static void
 518 re_setmulti(struct re_softc *sc)
 519 {
 520         struct ifnet *ifp = &sc->arpcom.ac_if;
 521         int h = 0;
 522         uint32_t hashes[2] = { 0, 0 };
 523         struct ifmultiaddr *ifma;
 524         uint32_t rxfilt;
 525         int mcnt = 0;
 526
 527         rxfilt = CSR_READ_4(sc, RE_RXCFG);
 528
 529         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
 530                 rxfilt |= RE_RXCFG_RX_MULTI;
 531                 CSR_WRITE_4(sc, RE_RXCFG, rxfilt);
 532                 CSR_WRITE_4(sc, RE_MAR0, 0xFFFFFFFF);
 533                 CSR_WRITE_4(sc, RE_MAR4, 0xFFFFFFFF);
 534                 return;
 535         }
 536
 537         /* first, zot all the existing hash bits */
 538         CSR_WRITE_4(sc, RE_MAR0, 0);
 539         CSR_WRITE_4(sc, RE_MAR4, 0);
 540
 541         /* now program new ones */
 542         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 543                 if (ifma->ifma_addr->sa_family != AF_LINK)
 544                         continue;
 545                 h = ether_crc32_be(LLADDR((struct sockaddr_dl *)
 546                     ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
 547                 if (h < 32)
 548                         hashes[0] |= (1 << h);
 549                 else
 550                         hashes[1] |= (1 << (h - 32));
 551                 mcnt++;
 552         }
 553
 554         if (mcnt)
 555                 rxfilt |= RE_RXCFG_RX_MULTI;
 556         else
 557                 rxfilt &= ~RE_RXCFG_RX_MULTI;
 558
 559         CSR_WRITE_4(sc, RE_RXCFG, rxfilt);
 560         CSR_WRITE_4(sc, RE_MAR0, hashes[0]);
 561         CSR_WRITE_4(sc, RE_MAR4, hashes[1]);
 562 }
 563
 564 static void
 565 re_reset(struct re_softc *sc)
 566 {
 567         int i;
 568
 569         CSR_WRITE_1(sc, RE_COMMAND, RE_CMD_RESET);
 570
 571         for (i = 0; i < RE_TIMEOUT; i++) {
 572                 DELAY(10);
 573                 if ((CSR_READ_1(sc, RE_COMMAND) & RE_CMD_RESET) == 0)
 574                         break;
 575         }
 576         if (i == RE_TIMEOUT)
 577                 if_printf(&sc->arpcom.ac_if, "reset never completed!\n");
 578
 579         CSR_WRITE_1(sc, 0x82, 1);
 580 }
 581
 582 /*
 583  * The following routine is designed to test for a defect on some
 584  * 32-bit 8169 cards. Some of these NICs have the REQ64# and ACK64#
 585  * lines connected to the bus, however for a 32-bit only card, they
 586  * should be pulled high. The result of this defect is that the
 587  * NIC will not work right if you plug it into a 64-bit slot: DMA
 588  * operations will be done with 64-bit transfers, which will fail
 589  * because the 64-bit data lines aren't connected.
 590  *
 591  * There's no way to work around this (short of talking a soldering
 592  * iron to the board), however we can detect it. The method we use
 593  * here is to put the NIC into digital loopback mode, set the receiver
 594  * to promiscuous mode, and then try to send a frame. We then compare
 595  * the frame data we sent to what was received. If the data matches,
 596  * then the NIC is working correctly, otherwise we know the user has
 597  * a defective NIC which has been mistakenly plugged into a 64-bit PCI
 598  * slot. In the latter case, there's no way the NIC can work correctly,
 599  * so we print out a message on the console and abort the device attach.
 600  */
 601
 602 static int
 603 re_diag(struct re_softc *sc)
 604 {
 605         struct ifnet *ifp = &sc->arpcom.ac_if;
 606         struct mbuf *m0;
 607         struct ether_header *eh;
 608         struct re_desc *cur_rx;
 609         uint16_t status;
 610         uint32_t rxstat;
 611         int total_len, i, error = 0;
 612         uint8_t dst[ETHER_ADDR_LEN] = { 0x00, 'h', 'e', 'l', 'l', 'o' };
 613         uint8_t src[ETHER_ADDR_LEN] = { 0x00, 'w', 'o', 'r', 'l', 'd' };
 614
 615         /* Allocate a single mbuf */
 616
 617         MGETHDR(m0, MB_DONTWAIT, MT_DATA);
 618         if (m0 == NULL)
 619                 return(ENOBUFS);
 620
 621         /*
 622          * Initialize the NIC in test mode. This sets the chip up
 623          * so that it can send and receive frames, but performs the
 624          * following special functions:
 625          * - Puts receiver in promiscuous mode
 626          * - Enables digital loopback mode
 627          * - Leaves interrupts turned off
 628          */
 629
 630         ifp->if_flags |= IFF_PROMISC;
 631         sc->re_testmode = 1;
 632         re_init(sc);
 633         re_stop(sc);
 634         DELAY(100000);
 635         re_init(sc);
 636
 637         /* Put some data in the mbuf */
 638
 639         eh = mtod(m0, struct ether_header *);
 640         bcopy (dst, eh->ether_dhost, ETHER_ADDR_LEN);
 641         bcopy (src, eh->ether_shost, ETHER_ADDR_LEN);
 642         eh->ether_type = htons(ETHERTYPE_IP);
 643         m0->m_pkthdr.len = m0->m_len = ETHER_MIN_LEN - ETHER_CRC_LEN;
 644
 645         /*
 646          * Queue the packet, start transmission.
 647          * Note: ifq_handoff() ultimately calls re_start() for us.
 648          */
 649
 650         CSR_WRITE_2(sc, RE_ISR, 0xFFFF);
 651         error = ifq_handoff(ifp, m0, NULL);
 652         if (error) {
 653                 m0 = NULL;
 654                 goto done;
 655         }
 656         m0 = NULL;
 657
 658         /* Wait for it to propagate through the chip */
 659
 660         DELAY(100000);
 661         for (i = 0; i < RE_TIMEOUT; i++) {
 662                 status = CSR_READ_2(sc, RE_ISR);
 663                 if ((status & (RE_ISR_TIMEOUT_EXPIRED|RE_ISR_RX_OK)) ==
 664                     (RE_ISR_TIMEOUT_EXPIRED|RE_ISR_RX_OK))
 665                         break;
 666                 DELAY(10);
 667         }
 668
 669         if (i == RE_TIMEOUT) {
 670                 if_printf(ifp, "diagnostic failed to receive packet "
 671                           "in loopback mode\n");
 672                 error = EIO;
 673                 goto done;
 674         }
 675
 676         /*
 677          * The packet should have been dumped into the first
 678          * entry in the RX DMA ring. Grab it from there.
 679          */
 680
 681         bus_dmamap_sync(sc->re_ldata.re_rx_list_tag,
 682                         sc->re_ldata.re_rx_list_map, BUS_DMASYNC_POSTREAD);
 683         bus_dmamap_sync(sc->re_ldata.re_mtag, sc->re_ldata.re_rx_dmamap[0],
 684                         BUS_DMASYNC_POSTWRITE);
 685         bus_dmamap_unload(sc->re_ldata.re_mtag, sc->re_ldata.re_rx_dmamap[0]);
 686
 687         m0 = sc->re_ldata.re_rx_mbuf[0];
 688         sc->re_ldata.re_rx_mbuf[0] = NULL;
 689         eh = mtod(m0, struct ether_header *);
 690
 691         cur_rx = &sc->re_ldata.re_rx_list[0];
 692         total_len = RE_RXBYTES(cur_rx);
 693         rxstat = le32toh(cur_rx->re_cmdstat);
 694
 695         if (total_len != ETHER_MIN_LEN) {
 696                 if_printf(ifp, "diagnostic failed, received short packet\n");
 697                 error = EIO;
 698                 goto done;
 699         }
 700
 701         /* Test that the received packet data matches what we sent. */
 702
 703         if (bcmp(eh->ether_dhost, dst, ETHER_ADDR_LEN) ||
 704             bcmp(eh->ether_shost, &src, ETHER_ADDR_LEN) ||
 705             be16toh(eh->ether_type) != ETHERTYPE_IP) {
 706                 if_printf(ifp, "WARNING, DMA FAILURE!\n");
 707                 if_printf(ifp, "expected TX data: %6D/%6D/0x%x\n",
 708                     dst, ":", src, ":", ETHERTYPE_IP);
 709                 if_printf(ifp, "received RX data: %6D/%6D/0x%x\n",
 710                     eh->ether_dhost, ":",  eh->ether_shost, ":",
 711                     ntohs(eh->ether_type));
 712                 if_printf(ifp, "You may have a defective 32-bit NIC plugged "
 713                     "into a 64-bit PCI slot.\n");
 714                 if_printf(ifp, "Please re-install the NIC in a 32-bit slot "
 715                     "for proper operation.\n");
 716                 if_printf(ifp, "Read the re(4) man page for more details.\n");
 717                 error = EIO;
 718         }
 719
 720 done:
 721         /* Turn interface off, release resources */
 722
 723         sc->re_testmode = 0;
 724         ifp->if_flags &= ~IFF_PROMISC;
 725         re_stop(sc);
 726         if (m0 != NULL)
 727                 m_freem(m0);
 728
 729         return (error);
 730 }
 731
 732 /*
 733  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
 734  * IDs against our list and return a device name if we find a match.
 735  */
 736 static int
 737 re_probe(device_t dev)
 738 {
 739         struct re_type *t;
 740         struct re_softc *sc;
 741         int rid;
 742         uint32_t hwrev;
 743         uint16_t vendor, product;
 744
 745         t = re_devs;
 746
 747         vendor = pci_get_vendor(dev);
 748         product = pci_get_device(dev);
 749
 750         for (t = re_devs; t->re_name != NULL; t++) {
 751                 if (product == t->re_did && vendor == t->re_vid)
 752                         break;
 753         }
 754
 755         /*
 756          * Check if we found a RealTek device.
 757          */
 758         if (t->re_name == NULL)
 759                 return(ENXIO);
 760
 761         /*
 762          * Temporarily map the I/O space so we can read the chip ID register.
 763          */
 764         sc = kmalloc(sizeof(*sc), M_TEMP, M_WAITOK | M_ZERO);
 765         rid = RE_PCI_LOIO;
 766         sc->re_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
 767                                             RF_ACTIVE);
 768         if (sc->re_res == NULL) {
 769                 device_printf(dev, "couldn't map ports/memory\n");
 770                 kfree(sc, M_TEMP);
 771                 return(ENXIO);
 772         }
 773
 774         sc->re_btag = rman_get_bustag(sc->re_res);
 775         sc->re_bhandle = rman_get_bushandle(sc->re_res);
 776
 777         hwrev = CSR_READ_4(sc, RE_TXCFG) & RE_TXCFG_HWREV;
 778         bus_release_resource(dev, SYS_RES_IOPORT, RE_PCI_LOIO, sc->re_res);
 779         kfree(sc, M_TEMP);
 780
 781         /*
 782          * and continue matching for the specific chip...
 783          */
 784         for (; t->re_name != NULL; t++) {
 785                 if (product == t->re_did && vendor == t->re_vid &&
 786                     t->re_basetype == hwrev) {
 787                         device_set_desc(dev, t->re_name);
 788                         return(0);
 789                 }
 790         }
 791         return(ENXIO);
 792 }
 793
 794 /*
 795  * This routine takes the segment list provided as the result of
 796  * a bus_dma_map_load() operation and assigns the addresses/lengths
 797  * to RealTek DMA descriptors. This can be called either by the RX
 798  * code or the TX code. In the RX case, we'll probably wind up mapping
 799  * at most one segment. For the TX case, there could be any number of
 800  * segments since TX packets may span multiple mbufs. In either case,
 801  * if the number of segments is larger than the re_maxsegs limit
 802  * specified by the caller, we abort the mapping operation. Sadly,
 803  * whoever designed the buffer mapping API did not provide a way to
 804  * return an error from here, so we have to fake it a bit.
 805  */
 806
 807 static void
 808 re_dma_map_desc(void *arg, bus_dma_segment_t *segs, int nseg,
 809                 bus_size_t mapsize, int error)
 810 {
 811         struct re_dmaload_arg *ctx;
 812         struct re_desc *d = NULL;
 813         int i = 0, idx;
 814         uint32_t cmdstat;
 815
 816         if (error)
 817                 return;
 818
 819         ctx = arg;
 820
 821         /* Signal error to caller if there's too many segments */
 822         if (nseg > ctx->re_maxsegs) {
 823                 ctx->re_maxsegs = 0;
 824                 return;
 825         }
 826
 827         /*
 828          * Map the segment array into descriptors. Note that we set the
 829          * start-of-frame and end-of-frame markers for either TX or RX, but
 830          * they really only have meaning in the TX case. (In the RX case,
 831          * it's the chip that tells us where packets begin and end.)
 832          * We also keep track of the end of the ring and set the
 833          * end-of-ring bits as needed, and we set the ownership bits
 834          * in all except the very first descriptor. (The caller will
 835          * set this descriptor later when it start transmission or
 836          * reception.)
 837          */
 838         idx = ctx->re_idx;
 839         for (;;) {
 840                 d = &ctx->re_ring[idx];
 841                 if (le32toh(d->re_cmdstat) & RE_RDESC_STAT_OWN) {
 842                         ctx->re_maxsegs = 0;
 843                         return;
 844                 }
 845                 cmdstat = segs[i].ds_len;
 846                 d->re_bufaddr_lo = htole32(RE_ADDR_LO(segs[i].ds_addr));
 847                 d->re_bufaddr_hi = htole32(RE_ADDR_HI(segs[i].ds_addr));
 848                 if (i == 0)
 849                         cmdstat |= RE_TDESC_CMD_SOF;
 850                 else
 851                         cmdstat |= RE_TDESC_CMD_OWN;
 852                 if (idx == (RE_RX_DESC_CNT - 1))
 853                         cmdstat |= RE_TDESC_CMD_EOR;
 854                 d->re_cmdstat = htole32(cmdstat | ctx->re_flags);
 855                 i++;
 856                 if (i == nseg)
 857                         break;
 858                 RE_DESC_INC(idx);
 859         }
 860
 861         d->re_cmdstat |= htole32(RE_TDESC_CMD_EOF);
 862         ctx->re_maxsegs = nseg;
 863         ctx->re_idx = idx;
 864 }
 865
 866 /*
 867  * Map a single buffer address.
 868  */
 869
 870 static void
 871 re_dma_map_addr(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 872 {
 873         uint32_t *addr;
 874
 875         if (error)
 876                 return;
 877
 878         KASSERT(nseg == 1, ("too many DMA segments, %d should be 1", nseg));
 879         addr = arg;
 880         *addr = segs->ds_addr;
 881 }
 882
 883 static int
 884 re_allocmem(device_t dev, struct re_softc *sc)
 885 {
 886         int error, i, nseg;
 887
 888         /*
 889          * Allocate map for RX mbufs.
 890          */
 891         nseg = 32;
 892         error = bus_dma_tag_create(sc->re_parent_tag, ETHER_ALIGN, 0,
 893             BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL,
 894             NULL, MCLBYTES * nseg, nseg, MCLBYTES, BUS_DMA_ALLOCNOW,
 895             &sc->re_ldata.re_mtag);
 896         if (error) {
 897                 device_printf(dev, "could not allocate dma tag\n");
 898                 return(error);
 899         }
 900
 901         /*
 902          * Allocate map for TX descriptor list.
 903          */
 904         error = bus_dma_tag_create(sc->re_parent_tag, RE_RING_ALIGN,
 905             0, BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL,
 906             NULL, RE_TX_LIST_SZ, 1, RE_TX_LIST_SZ, BUS_DMA_ALLOCNOW,
 907             &sc->re_ldata.re_tx_list_tag);
 908         if (error) {
 909                 device_printf(dev, "could not allocate dma tag\n");
 910                 return(error);
 911         }
 912
 913         /* Allocate DMA'able memory for the TX ring */
 914
 915         error = bus_dmamem_alloc(sc->re_ldata.re_tx_list_tag,
 916             (void **)&sc->re_ldata.re_tx_list, BUS_DMA_WAITOK | BUS_DMA_ZERO,
 917             &sc->re_ldata.re_tx_list_map);
 918         if (error) {
 919                 device_printf(dev, "could not allocate TX ring\n");
 920                 return(error);
 921         }
 922
 923         /* Load the map for the TX ring. */
 924
 925         error = bus_dmamap_load(sc->re_ldata.re_tx_list_tag,
 926              sc->re_ldata.re_tx_list_map, sc->re_ldata.re_tx_list,
 927              RE_TX_LIST_SZ, re_dma_map_addr,
 928              &sc->re_ldata.re_tx_list_addr, BUS_DMA_NOWAIT);
 929         if (error) {
 930                 device_printf(dev, "could not get addres of TX ring\n");
 931                 return(error);
 932         }
 933
 934         /* Create DMA maps for TX buffers */
 935
 936         for (i = 0; i < RE_TX_DESC_CNT; i++) {
 937                 error = bus_dmamap_create(sc->re_ldata.re_mtag, 0,
 938                             &sc->re_ldata.re_tx_dmamap[i]);
 939                 if (error) {
 940                         device_printf(dev, "can't create DMA map for TX\n");
 941                         return(error);
 942                 }
 943         }
 944
 945         /*
 946          * Allocate map for RX descriptor list.
 947          */
 948         error = bus_dma_tag_create(sc->re_parent_tag, RE_RING_ALIGN,
 949             0, BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL,
 950             NULL, RE_RX_LIST_SZ, 1, RE_RX_LIST_SZ, BUS_DMA_ALLOCNOW,
 951             &sc->re_ldata.re_rx_list_tag);
 952         if (error) {
 953                 device_printf(dev, "could not allocate dma tag\n");
 954                 return(error);
 955         }
 956
 957         /* Allocate DMA'able memory for the RX ring */
 958
 959         error = bus_dmamem_alloc(sc->re_ldata.re_rx_list_tag,
 960             (void **)&sc->re_ldata.re_rx_list, BUS_DMA_WAITOK | BUS_DMA_ZERO,
 961             &sc->re_ldata.re_rx_list_map);
 962         if (error) {
 963                 device_printf(dev, "could not allocate RX ring\n");
 964                 return(error);
 965         }
 966
 967         /* Load the map for the RX ring. */
 968
 969         error = bus_dmamap_load(sc->re_ldata.re_rx_list_tag,
 970              sc->re_ldata.re_rx_list_map, sc->re_ldata.re_rx_list,
 971              RE_RX_LIST_SZ, re_dma_map_addr,
 972              &sc->re_ldata.re_rx_list_addr, BUS_DMA_NOWAIT);
 973         if (error) {
 974                 device_printf(dev, "could not get address of RX ring\n");
 975                 return(error);
 976         }
 977
 978         /* Create DMA maps for RX buffers */
 979
 980         for (i = 0; i < RE_RX_DESC_CNT; i++) {
 981                 error = bus_dmamap_create(sc->re_ldata.re_mtag, 0,
 982                             &sc->re_ldata.re_rx_dmamap[i]);
 983                 if (error) {
 984                         device_printf(dev, "can't create DMA map for RX\n");
 985                         return(ENOMEM);
 986                 }
 987         }
 988
 989         return(0);
 990 }
 991
 992 /*
 993  * Attach the interface. Allocate softc structures, do ifmedia
 994  * setup and ethernet/BPF attach.
 995  */
 996 static int
 997 re_attach(device_t dev)
 998 {
 999         struct re_softc *sc = device_get_softc(dev);
1000         struct ifnet *ifp;
1001         struct re_hwrev *hw_rev;
1002         uint8_t eaddr[ETHER_ADDR_LEN];
1003         int hwrev;
1004         u_int16_t re_did = 0;
1005         int error = 0, rid, i;
1006
1007         callout_init(&sc->re_timer);
1008
1009 #ifndef BURN_BRIDGES
1010         /*
1011          * Handle power management nonsense.
1012          */
1013
1014         if (pci_get_powerstate(dev) != PCI_POWERSTATE_D0) {
1015                 uint32_t membase, irq;
1016
1017                 /* Save important PCI config data. */
1018                 membase = pci_read_config(dev, RE_PCI_LOMEM, 4);
1019                 irq = pci_read_config(dev, PCIR_INTLINE, 4);
1020
1021                 /* Reset the power state. */
1022                 device_printf(dev, "chip is is in D%d power mode "
1023                     "-- setting to D0\n", pci_get_powerstate(dev));
1024
1025                 pci_set_powerstate(dev, PCI_POWERSTATE_D0);
1026
1027                 /* Restore PCI config data. */
1028                 pci_write_config(dev, RE_PCI_LOMEM, membase, 4);
1029                 pci_write_config(dev, PCIR_INTLINE, irq, 4);
1030         }
1031 #endif
1032         /*
1033          * Map control/status registers.
1034          */
1035         pci_enable_busmaster(dev);
1036
1037         rid = RE_PCI_LOIO;
1038         sc->re_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
1039                                             RF_ACTIVE);
1040
1041         if (sc->re_res == NULL) {
1042                 device_printf(dev, "couldn't map ports/memory\n");
1043                 error = ENXIO;
1044                 goto fail;
1045         }
1046
1047         sc->re_btag = rman_get_bustag(sc->re_res);
1048         sc->re_bhandle = rman_get_bushandle(sc->re_res);
1049
1050         /* Allocate interrupt */
1051         rid = 0;
1052         sc->re_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
1053                                             RF_SHAREABLE | RF_ACTIVE);
1054
1055         if (sc->re_irq == NULL) {
1056                 device_printf(dev, "couldn't map interrupt\n");
1057                 error = ENXIO;
1058                 goto fail;
1059         }
1060
1061         /* Reset the adapter. */
1062         re_reset(sc);
1063
1064         hwrev = CSR_READ_4(sc, RE_TXCFG) & RE_TXCFG_HWREV;
1065         for (hw_rev = re_hwrevs; hw_rev->re_desc != NULL; hw_rev++) {
1066                 if (hw_rev->re_rev == hwrev) {
1067                         sc->re_type = hw_rev->re_type;
1068                         break;
1069                 }
1070         }
1071
1072         if (sc->re_type == RE_8169) {
1073                 /* Set RX length mask */
1074                 sc->re_rxlenmask = RE_RDESC_STAT_GFRAGLEN;
1075
1076                 /* Force station address autoload from the EEPROM */
1077                 CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_AUTOLOAD);
1078                 for (i = 0; i < RE_TIMEOUT; i++) {
1079                         if ((CSR_READ_1(sc, RE_EECMD) & RE_EEMODE_AUTOLOAD) == 0)
1080                                 break;
1081                         DELAY(100);
1082                 }
1083                 if (i == RE_TIMEOUT)
1084                         device_printf(dev, "eeprom autoload timed out\n");
1085
1086                 for (i = 0; i < ETHER_ADDR_LEN; i++)
1087                         eaddr[i] = CSR_READ_1(sc, RE_IDR0 + i);
1088         } else {
1089                 uint16_t as[3];
1090
1091                 /* Set RX length mask */
1092                 sc->re_rxlenmask = RE_RDESC_STAT_FRAGLEN;
1093
1094                 sc->re_eecmd_read = RE_EECMD_READ_6BIT;
1095                 re_read_eeprom(sc, (caddr_t)&re_did, 0, 1, 0);
1096                 if (re_did != 0x8129)
1097                         sc->re_eecmd_read = RE_EECMD_READ_8BIT;
1098
1099                 /*
1100                  * Get station address from the EEPROM.
1101                  */
1102                 re_read_eeprom(sc, (caddr_t)as, RE_EE_EADDR, 3, 0);
1103                 for (i = 0; i < 3; i++) {
1104                         eaddr[(i * 2) + 0] = as[i] & 0xff;
1105                         eaddr[(i * 2) + 1] = as[i] >> 8;
1106                 }
1107         }
1108
1109         /*
1110          * Allocate the parent bus DMA tag appropriate for PCI.
1111          */
1112 #define RE_NSEG_NEW 32
1113         error = bus_dma_tag_create(NULL,        /* parent */
1114                         1, 0,                   /* alignment, boundary */
1115                         BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1116                         BUS_SPACE_MAXADDR,      /* highaddr */
1117                         NULL, NULL,             /* filter, filterarg */
1118                         MAXBSIZE, RE_NSEG_NEW,  /* maxsize, nsegments */
1119                         BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
1120                         BUS_DMA_ALLOCNOW,       /* flags */
1121                         &sc->re_parent_tag);
1122         if (error)
1123                 goto fail;
1124
1125         error = re_allocmem(dev, sc);
1126
1127         if (error)
1128                 goto fail;
1129
1130         /* Do MII setup */
1131         if (mii_phy_probe(dev, &sc->re_miibus,
1132             re_ifmedia_upd, re_ifmedia_sts)) {
1133                 device_printf(dev, "MII without any phy!\n");
1134                 error = ENXIO;
1135                 goto fail;
1136         }
1137
1138         ifp = &sc->arpcom.ac_if;
1139         ifp->if_softc = sc;
1140         if_initname(ifp, device_get_name(dev), device_get_unit(dev));
1141         ifp->if_mtu = ETHERMTU;
1142         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
1143         ifp->if_ioctl = re_ioctl;
1144         ifp->if_capabilities = IFCAP_VLAN_MTU;
1145         ifp->if_start = re_start;
1146         ifp->if_capabilities |= IFCAP_HWCSUM|IFCAP_VLAN_HWTAGGING;
1147 #ifdef DEVICE_POLLING
1148         ifp->if_poll = re_poll;
1149 #endif
1150         ifp->if_watchdog = re_watchdog;
1151         ifp->if_init = re_init;
1152         if (sc->re_type == RE_8169)
1153                 ifp->if_baudrate = 1000000000;
1154         else
1155                 ifp->if_baudrate = 100000000;
1156         ifq_set_maxlen(&ifp->if_snd, RE_IFQ_MAXLEN);
1157         ifq_set_ready(&ifp->if_snd);
1158 #ifdef RE_DISABLE_HWCSUM
1159         ifp->if_capenable = ifp->if_capabilities & ~IFCAP_HWCSUM;
1160         ifp->if_hwassist = 0;
1161 #else
1162         ifp->if_capenable = ifp->if_capabilities;
1163         ifp->if_hwassist = RE_CSUM_FEATURES;
1164 #endif
1165
1166         /*
1167          * Call MI attach routine.
1168          */
1169         ether_ifattach(ifp, eaddr, NULL);
1170
1171         lwkt_serialize_enter(ifp->if_serializer);
1172         /* Perform hardware diagnostic. */
1173         error = re_diag(sc);
1174         lwkt_serialize_exit(ifp->if_serializer);
1175
1176         if (error) {
1177                 device_printf(dev, "hardware diagnostic failure\n");
1178                 ether_ifdetach(ifp);
1179                 goto fail;
1180         }
1181
1182         /* Hook interrupt last to avoid having to lock softc */
1183         error = bus_setup_intr(dev, sc->re_irq, INTR_NETSAFE, re_intr, sc,
1184                                &sc->re_intrhand, ifp->if_serializer);
1185
1186         if (error) {
1187                 device_printf(dev, "couldn't set up irq\n");
1188                 ether_ifdetach(ifp);
1189                 goto fail;
1190         }
1191
1192 fail:
1193         if (error)
1194                 re_detach(dev);
1195
1196         return (error);
1197 }
1198
1199 /*
1200  * Shutdown hardware and free up resources. This can be called any
1201  * time after the mutex has been initialized. It is called in both
1202  * the error case in attach and the normal detach case so it needs
1203  * to be careful about only freeing resources that have actually been
1204  * allocated.
1205  */
1206 static int
1207 re_detach(device_t dev)
1208 {
1209         struct re_softc *sc = device_get_softc(dev);
1210         struct ifnet *ifp = &sc->arpcom.ac_if;
1211         int i;
1212
1213         /* These should only be active if attach succeeded */
1214         if (device_is_attached(dev)) {
1215                 lwkt_serialize_enter(ifp->if_serializer);
1216                 re_stop(sc);
1217                 bus_teardown_intr(dev, sc->re_irq, sc->re_intrhand);
1218                 lwkt_serialize_exit(ifp->if_serializer);
1219
1220                 ether_ifdetach(ifp);
1221         }
1222         if (sc->re_miibus)
1223                 device_delete_child(dev, sc->re_miibus);
1224         bus_generic_detach(dev);
1225
1226         if (sc->re_irq)
1227                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->re_irq);
1228         if (sc->re_res) {
1229                 bus_release_resource(dev, SYS_RES_IOPORT, RE_PCI_LOIO,
1230                                      sc->re_res);
1231         }
1232
1233         /* Unload and free the RX DMA ring memory and map */
1234
1235         if (sc->re_ldata.re_rx_list_tag) {
1236                 bus_dmamap_unload(sc->re_ldata.re_rx_list_tag,
1237                     sc->re_ldata.re_rx_list_map);
1238                 bus_dmamem_free(sc->re_ldata.re_rx_list_tag,
1239                     sc->re_ldata.re_rx_list,
1240                     sc->re_ldata.re_rx_list_map);
1241                 bus_dma_tag_destroy(sc->re_ldata.re_rx_list_tag);
1242         }
1243
1244         /* Unload and free the TX DMA ring memory and map */
1245
1246         if (sc->re_ldata.re_tx_list_tag) {
1247                 bus_dmamap_unload(sc->re_ldata.re_tx_list_tag,
1248                     sc->re_ldata.re_tx_list_map);
1249                 bus_dmamem_free(sc->re_ldata.re_tx_list_tag,
1250                     sc->re_ldata.re_tx_list,
1251                     sc->re_ldata.re_tx_list_map);
1252                 bus_dma_tag_destroy(sc->re_ldata.re_tx_list_tag);
1253         }
1254
1255         /* Destroy all the RX and TX buffer maps */
1256
1257         if (sc->re_ldata.re_mtag) {
1258                 for (i = 0; i < RE_TX_DESC_CNT; i++)
1259                         bus_dmamap_destroy(sc->re_ldata.re_mtag,
1260                             sc->re_ldata.re_tx_dmamap[i]);
1261                 for (i = 0; i < RE_RX_DESC_CNT; i++)
1262                         bus_dmamap_destroy(sc->re_ldata.re_mtag,
1263                             sc->re_ldata.re_rx_dmamap[i]);
1264                 bus_dma_tag_destroy(sc->re_ldata.re_mtag);
1265         }
1266
1267         /* Unload and free the stats buffer and map */
1268
1269         if (sc->re_ldata.re_stag) {
1270                 bus_dmamap_unload(sc->re_ldata.re_stag,
1271                     sc->re_ldata.re_rx_list_map);
1272                 bus_dmamem_free(sc->re_ldata.re_stag,
1273                     sc->re_ldata.re_stats,
1274                     sc->re_ldata.re_smap);
1275                 bus_dma_tag_destroy(sc->re_ldata.re_stag);
1276         }
1277
1278         if (sc->re_parent_tag)
1279                 bus_dma_tag_destroy(sc->re_parent_tag);
1280
1281         return(0);
1282 }
1283
1284 static int
1285 re_newbuf(struct re_softc *sc, int idx, struct mbuf *m)
1286 {
1287         struct re_dmaload_arg arg;
1288         struct mbuf *n = NULL;
1289         int error;
1290
1291         if (m == NULL) {
1292                 n = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
1293                 if (n == NULL)
1294                         return(ENOBUFS);
1295                 m = n;
1296         } else
1297                 m->m_data = m->m_ext.ext_buf;
1298
1299         /*
1300          * Initialize mbuf length fields and fixup
1301          * alignment so that the frame payload is
1302          * longword aligned.
1303          */
1304         m->m_len = m->m_pkthdr.len = MCLBYTES;
1305         m_adj(m, ETHER_ALIGN);
1306
1307         arg.sc = sc;
1308         arg.re_idx = idx;
1309         arg.re_maxsegs = 1;
1310         arg.re_flags = 0;
1311         arg.re_ring = sc->re_ldata.re_rx_list;
1312
1313         error = bus_dmamap_load_mbuf(sc->re_ldata.re_mtag,
1314             sc->re_ldata.re_rx_dmamap[idx], m, re_dma_map_desc,
1315             &arg, BUS_DMA_NOWAIT);
1316         if (error || arg.re_maxsegs != 1) {
1317                 if (n != NULL)
1318                         m_freem(n);
1319                 return (ENOMEM);
1320         }
1321
1322         sc->re_ldata.re_rx_list[idx].re_cmdstat |= htole32(RE_RDESC_CMD_OWN);
1323         sc->re_ldata.re_rx_mbuf[idx] = m;
1324
1325         bus_dmamap_sync(sc->re_ldata.re_mtag, sc->re_ldata.re_rx_dmamap[idx],
1326                         BUS_DMASYNC_PREREAD);
1327
1328         return(0);
1329 }
1330
1331 static int
1332 re_tx_list_init(struct re_softc *sc)
1333 {
1334         bzero(sc->re_ldata.re_tx_list, RE_TX_LIST_SZ);
1335         bzero(&sc->re_ldata.re_tx_mbuf, RE_TX_DESC_CNT * sizeof(struct mbuf *));
1336
1337         bus_dmamap_sync(sc->re_ldata.re_tx_list_tag,
1338                         sc->re_ldata.re_tx_list_map, BUS_DMASYNC_PREWRITE);
1339         sc->re_ldata.re_tx_prodidx = 0;
1340         sc->re_ldata.re_tx_considx = 0;
1341         sc->re_ldata.re_tx_free = RE_TX_DESC_CNT;
1342
1343         return(0);
1344 }
1345
1346 static int
1347 re_rx_list_init(struct re_softc *sc)
1348 {
1349         int i, error;
1350
1351         bzero(sc->re_ldata.re_rx_list, RE_RX_LIST_SZ);
1352         bzero(&sc->re_ldata.re_rx_mbuf, RE_RX_DESC_CNT * sizeof(struct mbuf *));
1353
1354         for (i = 0; i < RE_RX_DESC_CNT; i++) {
1355                 error = re_newbuf(sc, i, NULL);
1356                 if (error)
1357                         return(error);
1358         }
1359
1360         /* Flush the RX descriptors */
1361
1362         bus_dmamap_sync(sc->re_ldata.re_rx_list_tag,
1363                         sc->re_ldata.re_rx_list_map, BUS_DMASYNC_PREWRITE);
1364
1365         sc->re_ldata.re_rx_prodidx = 0;
1366         sc->re_head = sc->re_tail = NULL;
1367
1368         return(0);
1369 }
1370
1371 /*
1372  * RX handler for C+ and 8169. For the gigE chips, we support
1373  * the reception of jumbo frames that have been fragmented
1374  * across multiple 2K mbuf cluster buffers.
1375  */
1376 static void
1377 re_rxeof(struct re_softc *sc)
1378 {
1379         struct ifnet *ifp = &sc->arpcom.ac_if;
1380         struct mbuf *m;
1381         struct re_desc  *cur_rx;
1382         uint32_t rxstat, rxvlan;
1383         int i, total_len;
1384
1385         /* Invalidate the descriptor memory */
1386
1387         bus_dmamap_sync(sc->re_ldata.re_rx_list_tag,
1388                         sc->re_ldata.re_rx_list_map, BUS_DMASYNC_POSTREAD);
1389
1390         for (i = sc->re_ldata.re_rx_prodidx;
1391              RE_OWN(&sc->re_ldata.re_rx_list[i]) == 0 ; RE_DESC_INC(i)) {
1392                 cur_rx = &sc->re_ldata.re_rx_list[i];
1393                 m = sc->re_ldata.re_rx_mbuf[i];
1394                 total_len = RE_RXBYTES(cur_rx);
1395                 rxstat = le32toh(cur_rx->re_cmdstat);
1396                 rxvlan = le32toh(cur_rx->re_vlanctl);
1397
1398                 /* Invalidate the RX mbuf and unload its map */
1399
1400                 bus_dmamap_sync(sc->re_ldata.re_mtag,
1401                                 sc->re_ldata.re_rx_dmamap[i],
1402                                 BUS_DMASYNC_POSTWRITE);
1403                 bus_dmamap_unload(sc->re_ldata.re_mtag,
1404                                   sc->re_ldata.re_rx_dmamap[i]);
1405
1406                 if ((rxstat & RE_RDESC_STAT_EOF) == 0) {
1407                         m->m_len = MCLBYTES - ETHER_ALIGN;
1408                         if (sc->re_head == NULL) {
1409                                 sc->re_head = sc->re_tail = m;
1410                         } else {
1411                                 sc->re_tail->m_next = m;
1412                                 sc->re_tail = m;
1413                         }
1414                         re_newbuf(sc, i, NULL);
1415                         continue;
1416                 }
1417
1418                 /*
1419                  * NOTE: for the 8139C+, the frame length field
1420                  * is always 12 bits in size, but for the gigE chips,
1421                  * it is 13 bits (since the max RX frame length is 16K).
1422                  * Unfortunately, all 32 bits in the status word
1423                  * were already used, so to make room for the extra
1424                  * length bit, RealTek took out the 'frame alignment
1425                  * error' bit and shifted the other status bits
1426                  * over one slot. The OWN, EOR, FS and LS bits are
1427                  * still in the same places. We have already extracted
1428                  * the frame length and checked the OWN bit, so rather
1429                  * than using an alternate bit mapping, we shift the
1430                  * status bits one space to the right so we can evaluate
1431                  * them using the 8169 status as though it was in the
1432                  * same format as that of the 8139C+.
1433                  */
1434                 if (sc->re_type == RE_8169)
1435                         rxstat >>= 1;
1436
1437                 if (rxstat & RE_RDESC_STAT_RXERRSUM) {
1438                         ifp->if_ierrors++;
1439                         /*
1440                          * If this is part of a multi-fragment packet,
1441                          * discard all the pieces.
1442                          */
1443                         if (sc->re_head != NULL) {
1444                                 m_freem(sc->re_head);
1445                                 sc->re_head = sc->re_tail = NULL;
1446                         }
1447                         re_newbuf(sc, i, m);
1448                         continue;
1449                 }
1450
1451                 /*
1452                  * If allocating a replacement mbuf fails,
1453                  * reload the current one.
1454                  */
1455
1456                 if (re_newbuf(sc, i, NULL)) {
1457                         ifp->if_ierrors++;
1458                         if (sc->re_head != NULL) {
1459                                 m_freem(sc->re_head);
1460                                 sc->re_head = sc->re_tail = NULL;
1461                         }
1462                         re_newbuf(sc, i, m);
1463                         continue;
1464                 }
1465
1466                 if (sc->re_head != NULL) {
1467                         m->m_len = total_len % (MCLBYTES - ETHER_ALIGN);
1468                         /*
1469                          * Special case: if there's 4 bytes or less
1470                          * in this buffer, the mbuf can be discarded:
1471                          * the last 4 bytes is the CRC, which we don't
1472                          * care about anyway.
1473                          */
1474                         if (m->m_len <= ETHER_CRC_LEN) {
1475                                 sc->re_tail->m_len -=
1476                                     (ETHER_CRC_LEN - m->m_len);
1477                                 m_freem(m);
1478                         } else {
1479                                 m->m_len -= ETHER_CRC_LEN;
1480                                 sc->re_tail->m_next = m;
1481                         }
1482                         m = sc->re_head;
1483                         sc->re_head = sc->re_tail = NULL;
1484                         m->m_pkthdr.len = total_len - ETHER_CRC_LEN;
1485                 } else
1486                         m->m_pkthdr.len = m->m_len =
1487                             (total_len - ETHER_CRC_LEN);
1488
1489                 ifp->if_ipackets++;
1490                 m->m_pkthdr.rcvif = ifp;
1491
1492                 /* Do RX checksumming if enabled */
1493
1494                 if (ifp->if_capenable & IFCAP_RXCSUM) {
1495
1496                         /* Check IP header checksum */
1497                         if (rxstat & RE_RDESC_STAT_PROTOID)
1498                                 m->m_pkthdr.csum_flags |= CSUM_IP_CHECKED;
1499                         if ((rxstat & RE_RDESC_STAT_IPSUMBAD) == 0)
1500                                 m->m_pkthdr.csum_flags |= CSUM_IP_VALID;
1501
1502                         /* Check TCP/UDP checksum */
1503                         if ((RE_TCPPKT(rxstat) &&
1504                             (rxstat & RE_RDESC_STAT_TCPSUMBAD) == 0) ||
1505                             (RE_UDPPKT(rxstat) &&
1506                             (rxstat & RE_RDESC_STAT_UDPSUMBAD)) == 0) {
1507                                 m->m_pkthdr.csum_flags |=
1508                                     CSUM_DATA_VALID|CSUM_PSEUDO_HDR;
1509                                 m->m_pkthdr.csum_data = 0xffff;
1510                         }
1511                 }
1512
1513                 if (rxvlan & RE_RDESC_VLANCTL_TAG) {
1514                         VLAN_INPUT_TAG(m,
1515                            be16toh((rxvlan & RE_RDESC_VLANCTL_DATA)));
1516                 } else {
1517                         ifp->if_input(ifp, m);
1518                 }
1519         }
1520
1521         /* Flush the RX DMA ring */
1522
1523         bus_dmamap_sync(sc->re_ldata.re_rx_list_tag,
1524                         sc->re_ldata.re_rx_list_map, BUS_DMASYNC_PREWRITE);
1525
1526         sc->re_ldata.re_rx_prodidx = i;
1527 }
1528
1529 static void
1530 re_txeof(struct re_softc *sc)
1531 {
1532         struct ifnet *ifp = &sc->arpcom.ac_if;
1533         uint32_t txstat;
1534         int idx;
1535
1536         /* Invalidate the TX descriptor list */
1537
1538         bus_dmamap_sync(sc->re_ldata.re_tx_list_tag,
1539                         sc->re_ldata.re_tx_list_map, BUS_DMASYNC_POSTREAD);
1540
1541         for (idx = sc->re_ldata.re_tx_considx;
1542              idx != sc->re_ldata.re_tx_prodidx; RE_DESC_INC(idx)) {
1543                 txstat = le32toh(sc->re_ldata.re_tx_list[idx].re_cmdstat);
1544                 if (txstat & RE_TDESC_CMD_OWN)
1545                         break;
1546
1547                 /*
1548                  * We only stash mbufs in the last descriptor
1549                  * in a fragment chain, which also happens to
1550                  * be the only place where the TX status bits
1551                  * are valid.
1552                  */
1553                 if (txstat & RE_TDESC_CMD_EOF) {
1554                         m_freem(sc->re_ldata.re_tx_mbuf[idx]);
1555                         sc->re_ldata.re_tx_mbuf[idx] = NULL;
1556                         bus_dmamap_unload(sc->re_ldata.re_mtag,
1557                             sc->re_ldata.re_tx_dmamap[idx]);
1558                         if (txstat & (RE_TDESC_STAT_EXCESSCOL|
1559                             RE_TDESC_STAT_COLCNT))
1560                                 ifp->if_collisions++;
1561                         if (txstat & RE_TDESC_STAT_TXERRSUM)
1562                                 ifp->if_oerrors++;
1563                         else
1564                                 ifp->if_opackets++;
1565                 }
1566                 sc->re_ldata.re_tx_free++;
1567         }
1568
1569         /* No changes made to the TX ring, so no flush needed */
1570         if (idx != sc->re_ldata.re_tx_considx) {
1571                 sc->re_ldata.re_tx_considx = idx;
1572                 ifp->if_flags &= ~IFF_OACTIVE;
1573                 ifp->if_timer = 0;
1574         }
1575
1576         /*
1577          * If not all descriptors have been released reaped yet,
1578          * reload the timer so that we will eventually get another
1579          * interrupt that will cause us to re-enter this routine.
1580          * This is done in case the transmitter has gone idle.
1581          */
1582         if (sc->re_ldata.re_tx_free != RE_TX_DESC_CNT)
1583                 CSR_WRITE_4(sc, RE_TIMERCNT, 1);
1584 }
1585
1586 static void
1587 re_tick(void *xsc)
1588 {
1589         struct re_softc *sc = xsc;
1590
1591         lwkt_serialize_enter(sc->arpcom.ac_if.if_serializer);
1592         re_tick_serialized(xsc);
1593         lwkt_serialize_exit(sc->arpcom.ac_if.if_serializer);
1594 }
1595
1596 static void
1597 re_tick_serialized(void *xsc)
1598 {
1599         struct re_softc *sc = xsc;
1600         struct mii_data *mii;
1601
1602         mii = device_get_softc(sc->re_miibus);
1603         mii_tick(mii);
1604
1605         callout_reset(&sc->re_timer, hz, re_tick, sc);
1606 }
1607
1608 #ifdef DEVICE_POLLING
1609
1610 static void
1611 re_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
1612 {
1613         struct re_softc *sc = ifp->if_softc;
1614
1615         switch(cmd) {
1616         case POLL_REGISTER:
1617                 /* disable interrupts */
1618                 CSR_WRITE_2(sc, RE_IMR, 0x0000);
1619                 break;
1620         case POLL_DEREGISTER:
1621                 /* enable interrupts */
1622                 CSR_WRITE_2(sc, RE_IMR, RE_INTRS_CPLUS);
1623                 break;
1624         default:
1625                 sc->rxcycles = count;
1626                 re_rxeof(sc);
1627                 re_txeof(sc);
1628
1629                 if (!ifq_is_empty(&ifp->if_snd))
1630                         (*ifp->if_start)(ifp);
1631
1632                 if (cmd == POLL_AND_CHECK_STATUS) { /* also check status register */
1633                         uint16_t       status;
1634
1635                         status = CSR_READ_2(sc, RE_ISR);
1636                         if (status == 0xffff)
1637                                 return;
1638                         if (status)
1639                                 CSR_WRITE_2(sc, RE_ISR, status);
1640
1641                         /*
1642                          * XXX check behaviour on receiver stalls.
1643                          */
1644
1645                         if (status & RE_ISR_SYSTEM_ERR) {
1646                                 re_reset(sc);
1647                                 re_init(sc);
1648                         }
1649                 }
1650                 break;
1651         }
1652 }
1653 #endif /* DEVICE_POLLING */
1654
1655 static void
1656 re_intr(void *arg)
1657 {
1658         struct re_softc *sc = arg;
1659         struct ifnet *ifp = &sc->arpcom.ac_if;
1660         uint16_t status;
1661
1662         if (sc->suspended || (ifp->if_flags & IFF_UP) == 0)
1663                 return;
1664
1665         for (;;) {
1666                 status = CSR_READ_2(sc, RE_ISR);
1667                 /* If the card has gone away the read returns 0xffff. */
1668                 if (status == 0xffff)
1669                         break;
1670                 if (status)
1671                         CSR_WRITE_2(sc, RE_ISR, status);
1672
1673                 if ((status & RE_INTRS_CPLUS) == 0)
1674                         break;
1675
1676                 if (status & RE_ISR_RX_OK)
1677                         re_rxeof(sc);
1678
1679                 if (status & RE_ISR_RX_ERR)
1680                         re_rxeof(sc);
1681
1682                 if ((status & RE_ISR_TIMEOUT_EXPIRED) ||
1683                     (status & RE_ISR_TX_ERR) ||
1684                     (status & RE_ISR_TX_DESC_UNAVAIL))
1685                         re_txeof(sc);
1686
1687                 if (status & RE_ISR_SYSTEM_ERR) {
1688                         re_reset(sc);
1689                         re_init(sc);
1690                 }
1691
1692                 if (status & RE_ISR_LINKCHG)
1693                         re_tick_serialized(sc);
1694         }
1695
1696         if (!ifq_is_empty(&ifp->if_snd))
1697                 (*ifp->if_start)(ifp);
1698 }
1699
1700 static int
1701 re_encap(struct re_softc *sc, struct mbuf **m_head, int *idx, int *called_defrag)
1702 {
1703         struct ifnet *ifp = &sc->arpcom.ac_if;
1704         struct mbuf *m, *m_new = NULL;
1705         struct re_dmaload_arg   arg;
1706         bus_dmamap_t            map;
1707         int                     error;
1708
1709         *called_defrag = 0;
1710         if (sc->re_ldata.re_tx_free <= 4)
1711                 return(EFBIG);
1712
1713         m = *m_head;
1714
1715         /*
1716          * Set up checksum offload. Note: checksum offload bits must
1717          * appear in all descriptors of a multi-descriptor transmit
1718          * attempt. (This is according to testing done with an 8169
1719          * chip. I'm not sure if this is a requirement or a bug.)
1720          */
1721
1722         arg.re_flags = 0;
1723
1724         if (m->m_pkthdr.csum_flags & CSUM_IP)
1725                 arg.re_flags |= RE_TDESC_CMD_IPCSUM;
1726         if (m->m_pkthdr.csum_flags & CSUM_TCP)
1727                 arg.re_flags |= RE_TDESC_CMD_TCPCSUM;
1728         if (m->m_pkthdr.csum_flags & CSUM_UDP)
1729                 arg.re_flags |= RE_TDESC_CMD_UDPCSUM;
1730
1731         arg.sc = sc;
1732         arg.re_idx = *idx;
1733         arg.re_maxsegs = sc->re_ldata.re_tx_free;
1734         if (arg.re_maxsegs > 4)
1735                 arg.re_maxsegs -= 4;
1736         arg.re_ring = sc->re_ldata.re_tx_list;
1737
1738         map = sc->re_ldata.re_tx_dmamap[*idx];
1739         error = bus_dmamap_load_mbuf(sc->re_ldata.re_mtag, map,
1740             m, re_dma_map_desc, &arg, BUS_DMA_NOWAIT);
1741
1742         if (error && error != EFBIG) {
1743                 if_printf(ifp, "can't map mbuf (error %d)\n", error);
1744                 return(ENOBUFS);
1745         }
1746
1747         /* Too many segments to map, coalesce into a single mbuf */
1748
1749         if (error || arg.re_maxsegs == 0) {
1750                 m_new = m_defrag_nofree(m, MB_DONTWAIT);
1751                 if (m_new == NULL)
1752                         return(1);
1753                 else {
1754                         m = m_new;
1755                         *m_head = m;
1756                 }
1757
1758                 *called_defrag = 1;
1759                 arg.sc = sc;
1760                 arg.re_idx = *idx;
1761                 arg.re_maxsegs = sc->re_ldata.re_tx_free;
1762                 arg.re_ring = sc->re_ldata.re_tx_list;
1763
1764                 error = bus_dmamap_load_mbuf(sc->re_ldata.re_mtag, map,
1765                     m, re_dma_map_desc, &arg, BUS_DMA_NOWAIT);
1766                 if (error) {
1767                         m_freem(m);
1768                         if_printf(ifp, "can't map mbuf (error %d)\n", error);
1769                         return(EFBIG);
1770                 }
1771         }
1772
1773         /*
1774          * Insure that the map for this transmission
1775          * is placed at the array index of the last descriptor
1776          * in this chain.
1777          */
1778         sc->re_ldata.re_tx_dmamap[*idx] =
1779             sc->re_ldata.re_tx_dmamap[arg.re_idx];
1780         sc->re_ldata.re_tx_dmamap[arg.re_idx] = map;
1781
1782         sc->re_ldata.re_tx_mbuf[arg.re_idx] = m;
1783         sc->re_ldata.re_tx_free -= arg.re_maxsegs;
1784
1785         /*
1786          * Set up hardware VLAN tagging. Note: vlan tag info must
1787          * appear in the first descriptor of a multi-descriptor
1788          * transmission attempt.
1789          */
1790
1791         if ((m->m_flags & (M_PROTO1|M_PKTHDR)) == (M_PROTO1|M_PKTHDR) &&
1792             m->m_pkthdr.rcvif != NULL &&
1793             m->m_pkthdr.rcvif->if_type == IFT_L2VLAN) {
1794                 struct ifvlan *ifv;
1795                 ifv = m->m_pkthdr.rcvif->if_softc;
1796                 if (ifv != NULL)
1797                         sc->re_ldata.re_tx_list[*idx].re_vlanctl =
1798                             htole32(htobe16(ifv->ifv_tag) | RE_TDESC_VLANCTL_TAG);
1799         }
1800
1801         /* Transfer ownership of packet to the chip. */
1802
1803         sc->re_ldata.re_tx_list[arg.re_idx].re_cmdstat |=
1804             htole32(RE_TDESC_CMD_OWN);
1805         if (*idx != arg.re_idx)
1806                 sc->re_ldata.re_tx_list[*idx].re_cmdstat |=
1807                     htole32(RE_TDESC_CMD_OWN);
1808
1809         RE_DESC_INC(arg.re_idx);
1810         *idx = arg.re_idx;
1811
1812         return(0);
1813 }
1814
1815 /*
1816  * Main transmit routine for C+ and gigE NICs.
1817  */
1818
1819 static void
1820 re_start(struct ifnet *ifp)
1821 {
1822         struct re_softc *sc = ifp->if_softc;
1823         struct mbuf *m_head;
1824         struct mbuf *m_head2;
1825         int called_defrag, idx, need_trans;
1826
1827         idx = sc->re_ldata.re_tx_prodidx;
1828
1829         need_trans = 0;
1830         while (sc->re_ldata.re_tx_mbuf[idx] == NULL) {
1831                 m_head = ifq_poll(&ifp->if_snd);
1832                 if (m_head == NULL)
1833                         break;
1834                 m_head2 = m_head;
1835                 if (re_encap(sc, &m_head2, &idx, &called_defrag)) {
1836                         /*
1837                          * If we could not encapsulate the defragged packet,
1838                          * the returned m_head2 is garbage and we must dequeue
1839                          * and throw away the original packet.
1840                          */
1841                         if (called_defrag) {
1842                                 ifq_dequeue(&ifp->if_snd, m_head);
1843                                 m_freem(m_head);
1844                         }
1845                         ifp->if_flags |= IFF_OACTIVE;
1846                         break;
1847                 }
1848
1849                 /*
1850                  * Clean out the packet we encapsulated.  If we defragged
1851                  * the packet the m_head2 is the one that got encapsulated
1852                  * and the original must be thrown away.  Otherwise m_head2
1853                  * *IS* the original.
1854                  */
1855                 ifq_dequeue(&ifp->if_snd, m_head);
1856                 if (called_defrag)
1857                         m_freem(m_head);
1858                 need_trans = 1;
1859
1860                 /*
1861                  * If there's a BPF listener, bounce a copy of this frame
1862                  * to him.
1863                  */
1864                 BPF_MTAP(ifp, m_head2);
1865         }
1866
1867         if (!need_trans) {
1868                 return;
1869         }
1870
1871         /* Flush the TX descriptors */
1872         bus_dmamap_sync(sc->re_ldata.re_tx_list_tag,
1873                         sc->re_ldata.re_tx_list_map, BUS_DMASYNC_PREWRITE);
1874
1875         sc->re_ldata.re_tx_prodidx = idx;
1876
1877         /*
1878          * RealTek put the TX poll request register in a different
1879          * location on the 8169 gigE chip. I don't know why.
1880          */
1881         if (sc->re_type == RE_8169)
1882                 CSR_WRITE_2(sc, RE_GTXSTART, RE_TXSTART_START);
1883         else
1884                 CSR_WRITE_2(sc, RE_TXSTART, RE_TXSTART_START);
1885
1886         /*
1887          * Use the countdown timer for interrupt moderation.
1888          * 'TX done' interrupts are disabled. Instead, we reset the
1889          * countdown timer, which will begin counting until it hits
1890          * the value in the TIMERINT register, and then trigger an
1891          * interrupt. Each time we write to the TIMERCNT register,
1892          * the timer count is reset to 0.
1893          */
1894         CSR_WRITE_4(sc, RE_TIMERCNT, 1);
1895
1896         /*
1897          * Set a timeout in case the chip goes out to lunch.
1898          */
1899         ifp->if_timer = 5;
1900 }
1901
1902 static void
1903 re_init(void *xsc)
1904 {
1905         struct re_softc *sc = xsc;
1906         struct ifnet *ifp = &sc->arpcom.ac_if;
1907         struct mii_data *mii;
1908         uint32_t rxcfg = 0;
1909
1910         mii = device_get_softc(sc->re_miibus);
1911
1912         /*
1913          * Cancel pending I/O and free all RX/TX buffers.
1914          */
1915         re_stop(sc);
1916
1917         /*
1918          * Enable C+ RX and TX mode, as well as VLAN stripping and
1919          * RX checksum offload. We must configure the C+ register
1920          * before all others.
1921          */
1922         CSR_WRITE_2(sc, RE_CPLUS_CMD, RE_CPLUSCMD_RXENB | RE_CPLUSCMD_TXENB |
1923                     RE_CPLUSCMD_PCI_MRW | RE_CPLUSCMD_VLANSTRIP |
1924                     (ifp->if_capenable & IFCAP_RXCSUM ?
1925                      RE_CPLUSCMD_RXCSUM_ENB : 0));
1926
1927         /*
1928          * Init our MAC address.  Even though the chipset
1929          * documentation doesn't mention it, we need to enter "Config
1930          * register write enable" mode to modify the ID registers.
1931          */
1932         CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_WRITECFG);
1933         CSR_WRITE_STREAM_4(sc, RE_IDR0,
1934             *(u_int32_t *)(&sc->arpcom.ac_enaddr[0]));
1935         CSR_WRITE_STREAM_4(sc, RE_IDR4,
1936             *(u_int32_t *)(&sc->arpcom.ac_enaddr[4]));
1937         CSR_WRITE_1(sc, RE_EECMD, RE_EEMODE_OFF);
1938
1939         /*
1940          * For C+ mode, initialize the RX descriptors and mbufs.
1941          */
1942         re_rx_list_init(sc);
1943         re_tx_list_init(sc);
1944
1945         /*
1946          * Enable transmit and receive.
1947          */
1948         CSR_WRITE_1(sc, RE_COMMAND, RE_CMD_TX_ENB|RE_CMD_RX_ENB);
1949
1950         /*
1951          * Set the initial TX and RX configuration.
1952          */
1953         if (sc->re_testmode) {
1954                 if (sc->re_type == RE_8169)
1955                         CSR_WRITE_4(sc, RE_TXCFG,
1956                                     RE_TXCFG_CONFIG | RE_LOOPTEST_ON);
1957                 else
1958                         CSR_WRITE_4(sc, RE_TXCFG,
1959                                     RE_TXCFG_CONFIG | RE_LOOPTEST_ON_CPLUS);
1960         } else
1961                 CSR_WRITE_4(sc, RE_TXCFG, RE_TXCFG_CONFIG);
1962         CSR_WRITE_4(sc, RE_RXCFG, RE_RXCFG_CONFIG);
1963
1964         /* Set the individual bit to receive frames for this host only. */
1965         rxcfg = CSR_READ_4(sc, RE_RXCFG);
1966         rxcfg |= RE_RXCFG_RX_INDIV;
1967
1968         /* If we want promiscuous mode, set the allframes bit. */
1969         if (ifp->if_flags & IFF_PROMISC) {
1970                 rxcfg |= RE_RXCFG_RX_ALLPHYS;
1971                 CSR_WRITE_4(sc, RE_RXCFG, rxcfg);
1972         } else {
1973                 rxcfg &= ~RE_RXCFG_RX_ALLPHYS;
1974                 CSR_WRITE_4(sc, RE_RXCFG, rxcfg);
1975         }
1976
1977         /*
1978          * Set capture broadcast bit to capture broadcast frames.
1979          */
1980         if (ifp->if_flags & IFF_BROADCAST) {
1981                 rxcfg |= RE_RXCFG_RX_BROAD;
1982                 CSR_WRITE_4(sc, RE_RXCFG, rxcfg);
1983         } else {
1984                 rxcfg &= ~RE_RXCFG_RX_BROAD;
1985                 CSR_WRITE_4(sc, RE_RXCFG, rxcfg);
1986         }
1987
1988         /*
1989          * Program the multicast filter, if necessary.
1990          */
1991         re_setmulti(sc);
1992
1993 #ifdef DEVICE_POLLING
1994         /*
1995          * Disable interrupts if we are polling.
1996          */
1997         if (ifp->if_flags & IFF_POLLING)
1998                 CSR_WRITE_2(sc, RE_IMR, 0);
1999         else    /* otherwise ... */
2000 #endif /* DEVICE_POLLING */
2001         /*
2002          * Enable interrupts.
2003          */
2004         if (sc->re_testmode)
2005                 CSR_WRITE_2(sc, RE_IMR, 0);
2006         else
2007                 CSR_WRITE_2(sc, RE_IMR, RE_INTRS_CPLUS);
2008
2009         /* Set initial TX threshold */
2010         sc->re_txthresh = RE_TX_THRESH_INIT;
2011
2012         /* Start RX/TX process. */
2013         CSR_WRITE_4(sc, RE_MISSEDPKT, 0);
2014 #ifdef notdef
2015         /* Enable receiver and transmitter. */
2016         CSR_WRITE_1(sc, RE_COMMAND, RE_CMD_TX_ENB|RE_CMD_RX_ENB);
2017 #endif
2018         /*
2019          * Load the addresses of the RX and TX lists into the chip.
2020          */
2021
2022         CSR_WRITE_4(sc, RE_RXLIST_ADDR_HI,
2023             RE_ADDR_HI(sc->re_ldata.re_rx_list_addr));
2024         CSR_WRITE_4(sc, RE_RXLIST_ADDR_LO,
2025             RE_ADDR_LO(sc->re_ldata.re_rx_list_addr));
2026
2027         CSR_WRITE_4(sc, RE_TXLIST_ADDR_HI,
2028             RE_ADDR_HI(sc->re_ldata.re_tx_list_addr));
2029         CSR_WRITE_4(sc, RE_TXLIST_ADDR_LO,
2030             RE_ADDR_LO(sc->re_ldata.re_tx_list_addr));
2031
2032         CSR_WRITE_1(sc, RE_EARLY_TX_THRESH, 16);
2033
2034         /*
2035          * Initialize the timer interrupt register so that
2036          * a timer interrupt will be generated once the timer
2037          * reaches a certain number of ticks. The timer is
2038          * reloaded on each transmit. This gives us TX interrupt
2039          * moderation, which dramatically improves TX frame rate.
2040          */
2041
2042         if (sc->re_type == RE_8169)
2043                 CSR_WRITE_4(sc, RE_TIMERINT_8169, 0x800);
2044         else
2045                 CSR_WRITE_4(sc, RE_TIMERINT, 0x400);
2046
2047         /*
2048          * For 8169 gigE NICs, set the max allowed RX packet
2049          * size so we can receive jumbo frames.
2050          */
2051         if (sc->re_type == RE_8169)
2052                 CSR_WRITE_2(sc, RE_MAXRXPKTLEN, 16383);
2053
2054         if (sc->re_testmode) {
2055                 return;
2056         }
2057
2058         mii_mediachg(mii);
2059
2060         CSR_WRITE_1(sc, RE_CFG1, RE_CFG1_DRVLOAD|RE_CFG1_FULLDUPLEX);
2061
2062         ifp->if_flags |= IFF_RUNNING;
2063         ifp->if_flags &= ~IFF_OACTIVE;
2064
2065         callout_reset(&sc->re_timer, hz, re_tick, sc);
2066 }
2067
2068 /*
2069  * Set media options.
2070  */
2071 static int
2072 re_ifmedia_upd(struct ifnet *ifp)
2073 {
2074         struct re_softc *sc = ifp->if_softc;
2075         struct mii_data *mii;
2076
2077         mii = device_get_softc(sc->re_miibus);
2078         mii_mediachg(mii);
2079
2080         return(0);
2081 }
2082
2083 /*
2084  * Report current media status.
2085  */
2086 static void
2087 re_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
2088 {
2089         struct re_softc *sc = ifp->if_softc;
2090         struct mii_data *mii;
2091
2092         mii = device_get_softc(sc->re_miibus);
2093
2094         mii_pollstat(mii);
2095         ifmr->ifm_active = mii->mii_media_active;
2096         ifmr->ifm_status = mii->mii_media_status;
2097 }
2098
2099 static int
2100 re_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
2101 {
2102         struct re_softc *sc = ifp->if_softc;
2103         struct ifreq *ifr = (struct ifreq *) data;
2104         struct mii_data *mii;
2105         int error = 0;
2106
2107         switch(command) {
2108         case SIOCSIFMTU:
2109                 if (ifr->ifr_mtu > RE_JUMBO_MTU)
2110                         error = EINVAL;
2111                 ifp->if_mtu = ifr->ifr_mtu;
2112                 break;
2113         case SIOCSIFFLAGS:
2114                 if (ifp->if_flags & IFF_UP)
2115                         re_init(sc);
2116                 else if (ifp->if_flags & IFF_RUNNING)
2117                                 re_stop(sc);
2118                 error = 0;
2119                 break;
2120         case SIOCADDMULTI:
2121         case SIOCDELMULTI:
2122                 re_setmulti(sc);
2123                 error = 0;
2124                 break;
2125         case SIOCGIFMEDIA:
2126         case SIOCSIFMEDIA:
2127                 mii = device_get_softc(sc->re_miibus);
2128                 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
2129                 break;
2130         case SIOCSIFCAP:
2131                 ifp->if_capenable &= ~(IFCAP_HWCSUM);
2132                 ifp->if_capenable |=
2133                     ifr->ifr_reqcap & (IFCAP_HWCSUM);
2134                 if (ifp->if_capenable & IFCAP_TXCSUM)
2135                         ifp->if_hwassist = RE_CSUM_FEATURES;
2136                 else
2137                         ifp->if_hwassist = 0;
2138                 if (ifp->if_flags & IFF_RUNNING)
2139                         re_init(sc);
2140                 break;
2141         default:
2142                 error = ether_ioctl(ifp, command, data);
2143                 break;
2144         }
2145         return(error);
2146 }
2147
2148 static void
2149 re_watchdog(struct ifnet *ifp)
2150 {
2151         struct re_softc *sc = ifp->if_softc;
2152
2153         if_printf(ifp, "watchdog timeout\n");
2154
2155         ifp->if_oerrors++;
2156
2157         re_txeof(sc);
2158         re_rxeof(sc);
2159
2160         re_init(sc);
2161
2162         if (!ifq_is_empty(&ifp->if_snd))
2163                 ifp->if_start(ifp);
2164 }
2165
2166 /*
2167  * Stop the adapter and free any mbufs allocated to the
2168  * RX and TX lists.
2169  */
2170 static void
2171 re_stop(struct re_softc *sc)
2172 {
2173         struct ifnet *ifp = &sc->arpcom.ac_if;
2174         int i;
2175
2176         ifp->if_timer = 0;
2177         callout_stop(&sc->re_timer);
2178
2179         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
2180
2181         CSR_WRITE_1(sc, RE_COMMAND, 0x00);
2182         CSR_WRITE_2(sc, RE_IMR, 0x0000);
2183
2184         if (sc->re_head != NULL) {
2185                 m_freem(sc->re_head);
2186                 sc->re_head = sc->re_tail = NULL;
2187         }
2188
2189         /* Free the TX list buffers. */
2190         for (i = 0; i < RE_TX_DESC_CNT; i++) {
2191                 if (sc->re_ldata.re_tx_mbuf[i] != NULL) {
2192                         bus_dmamap_unload(sc->re_ldata.re_mtag,
2193                                           sc->re_ldata.re_tx_dmamap[i]);
2194                         m_freem(sc->re_ldata.re_tx_mbuf[i]);
2195                         sc->re_ldata.re_tx_mbuf[i] = NULL;
2196                 }
2197         }
2198
2199         /* Free the RX list buffers. */
2200         for (i = 0; i < RE_RX_DESC_CNT; i++) {
2201                 if (sc->re_ldata.re_rx_mbuf[i] != NULL) {
2202                         bus_dmamap_unload(sc->re_ldata.re_mtag,
2203                                           sc->re_ldata.re_rx_dmamap[i]);
2204                         m_freem(sc->re_ldata.re_rx_mbuf[i]);
2205                         sc->re_ldata.re_rx_mbuf[i] = NULL;
2206                 }
2207         }
2208 }
2209
2210 /*
2211  * Device suspend routine.  Stop the interface and save some PCI
2212  * settings in case the BIOS doesn't restore them properly on
2213  * resume.
2214  */
2215 static int
2216 re_suspend(device_t dev)
2217 {
2218 #ifndef BURN_BRIDGES
2219         int i;
2220 #endif
2221         struct re_softc *sc = device_get_softc(dev);
2222
2223         re_stop(sc);
2224
2225 #ifndef BURN_BRIDGES
2226         for (i = 0; i < 5; i++)
2227                 sc->saved_maps[i] = pci_read_config(dev, PCIR_MAPS + i * 4, 4);
2228         sc->saved_biosaddr = pci_read_config(dev, PCIR_BIOS, 4);
2229         sc->saved_intline = pci_read_config(dev, PCIR_INTLINE, 1);
2230         sc->saved_cachelnsz = pci_read_config(dev, PCIR_CACHELNSZ, 1);
2231         sc->saved_lattimer = pci_read_config(dev, PCIR_LATTIMER, 1);
2232 #endif
2233
2234         sc->suspended = 1;
2235
2236         return (0);
2237 }
2238
2239 /*
2240  * Device resume routine.  Restore some PCI settings in case the BIOS
2241  * doesn't, re-enable busmastering, and restart the interface if
2242  * appropriate.
2243  */
2244 static int
2245 re_resume(device_t dev)
2246 {
2247         struct re_softc *sc = device_get_softc(dev);
2248         struct ifnet *ifp = &sc->arpcom.ac_if;
2249 #ifndef BURN_BRIDGES
2250         int i;
2251 #endif
2252
2253 #ifndef BURN_BRIDGES
2254         /* better way to do this? */
2255         for (i = 0; i < 5; i++)
2256                 pci_write_config(dev, PCIR_MAPS + i * 4, sc->saved_maps[i], 4);
2257         pci_write_config(dev, PCIR_BIOS, sc->saved_biosaddr, 4);
2258         pci_write_config(dev, PCIR_INTLINE, sc->saved_intline, 1);
2259         pci_write_config(dev, PCIR_CACHELNSZ, sc->saved_cachelnsz, 1);
2260         pci_write_config(dev, PCIR_LATTIMER, sc->saved_lattimer, 1);
2261
2262         /* reenable busmastering */
2263         pci_enable_busmaster(dev);
2264         pci_enable_io(dev, SYS_RES_IOPORT);
2265 #endif
2266
2267         /* reinitialize interface if necessary */
2268         if (ifp->if_flags & IFF_UP)
2269                 re_init(sc);
2270
2271         sc->suspended = 0;
2272
2273         return (0);
2274 }
2275
2276 /*
2277  * Stop all chip I/O so that the kernel's probe routines don't
2278  * get confused by errant DMAs when rebooting.
2279  */
2280 static void
2281 re_shutdown(device_t dev)
2282 {
2283         struct re_softc *sc = device_get_softc(dev);
2284
2285         re_stop(sc);
2286 }