sys/pci/if_rl.c

   1 /*-
   2  * Copyright (c) 1997, 1998
   3  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 /*
  37  * RealTek 8129/8139 PCI NIC driver
  38  *
  39  * Supports several extremely cheap PCI 10/100 adapters based on
  40  * the RealTek chipset. Datasheets can be obtained from
  41  * www.realtek.com.tw.
  42  *
  43  * Written by Bill Paul <wpaul@ctr.columbia.edu>
  44  * Electrical Engineering Department
  45  * Columbia University, New York City
  46  */
  47 /*
  48  * The RealTek 8139 PCI NIC redefines the meaning of 'low end.' This is
  49  * probably the worst PCI ethernet controller ever made, with the possible
  50  * exception of the FEAST chip made by SMC. The 8139 supports bus-master
  51  * DMA, but it has a terrible interface that nullifies any performance
  52  * gains that bus-master DMA usually offers.
  53  *
  54  * For transmission, the chip offers a series of four TX descriptor
  55  * registers. Each transmit frame must be in a contiguous buffer, aligned
  56  * on a longword (32-bit) boundary. This means we almost always have to
  57  * do mbuf copies in order to transmit a frame, except in the unlikely
  58  * case where a) the packet fits into a single mbuf, and b) the packet
  59  * is 32-bit aligned within the mbuf's data area. The presence of only
  60  * four descriptor registers means that we can never have more than four
  61  * packets queued for transmission at any one time.
  62  *
  63  * Reception is not much better. The driver has to allocate a single large
  64  * buffer area (up to 64K in size) into which the chip will DMA received
  65  * frames. Because we don't know where within this region received packets
  66  * will begin or end, we have no choice but to copy data from the buffer
  67  * area into mbufs in order to pass the packets up to the higher protocol
  68  * levels.
  69  *
  70  * It's impossible given this rotten design to really achieve decent
  71  * performance at 100Mbps, unless you happen to have a 400Mhz PII or
  72  * some equally overmuscled CPU to drive it.
  73  *
  74  * On the bright side, the 8139 does have a built-in PHY, although
  75  * rather than using an MDIO serial interface like most other NICs, the
  76  * PHY registers are directly accessible through the 8139's register
  77  * space. The 8139 supports autonegotiation, as well as a 64-bit multicast
  78  * filter.
  79  *
  80  * The 8129 chip is an older version of the 8139 that uses an external PHY
  81  * chip. The 8129 has a serial MDIO interface for accessing the MII where
  82  * the 8139 lets you directly access the on-board PHY registers. We need
  83  * to select which interface to use depending on the chip type.
  84  */
  85
  86 #ifdef HAVE_KERNEL_OPTION_HEADERS
  87 #include "opt_device_polling.h"
  88 #endif
  89
  90 #include <sys/param.h>
  91 #include <sys/endian.h>
  92 #include <sys/systm.h>
  93 #include <sys/sockio.h>
  94 #include <sys/mbuf.h>
  95 #include <sys/malloc.h>
  96 #include <sys/kernel.h>
  97 #include <sys/module.h>
  98 #include <sys/socket.h>
  99
 100 #include <net/if.h>
 101 #include <net/if_arp.h>
 102 #include <net/ethernet.h>
 103 #include <net/if_dl.h>
 104 #include <net/if_media.h>
 105 #include <net/if_types.h>
 106
 107 #include <net/bpf.h>
 108
 109 #include <machine/bus.h>
 110 #include <machine/resource.h>
 111 #include <sys/bus.h>
 112 #include <sys/rman.h>
 113
 114 #include <dev/mii/mii.h>
 115 #include <dev/mii/miivar.h>
 116
 117 #include <dev/pci/pcireg.h>
 118 #include <dev/pci/pcivar.h>
 119
 120 MODULE_DEPEND(rl, pci, 1, 1, 1);
 121 MODULE_DEPEND(rl, ether, 1, 1, 1);
 122 MODULE_DEPEND(rl, miibus, 1, 1, 1);
 123
 124 /* "device miibus" required.  See GENERIC if you get errors here. */
 125 #include "miibus_if.h"
 126
 127 /*
 128  * Default to using PIO access for this driver. On SMP systems,
 129  * there appear to be problems with memory mapped mode: it looks like
 130  * doing too many memory mapped access back to back in rapid succession
 131  * can hang the bus. I'm inclined to blame this on crummy design/construction
 132  * on the part of RealTek. Memory mapped mode does appear to work on
 133  * uniprocessor systems though.
 134  */
 135 #define RL_USEIOSPACE
 136
 137 #include <pci/if_rlreg.h>
 138
 139 /*
 140  * Various supported device vendors/types and their names.
 141  */
 142 static struct rl_type rl_devs[] = {
 143         { RT_VENDORID, RT_DEVICEID_8129, RL_8129,
 144                 "RealTek 8129 10/100BaseTX" },
 145         { RT_VENDORID, RT_DEVICEID_8139, RL_8139,
 146                 "RealTek 8139 10/100BaseTX" },
 147         { RT_VENDORID, RT_DEVICEID_8138, RL_8139,
 148                 "RealTek 8139 10/100BaseTX CardBus" },
 149         { RT_VENDORID, RT_DEVICEID_8100, RL_8139,
 150                 "RealTek 8100 10/100BaseTX" },
 151         { ACCTON_VENDORID, ACCTON_DEVICEID_5030, RL_8139,
 152                 "Accton MPX 5030/5038 10/100BaseTX" },
 153         { DELTA_VENDORID, DELTA_DEVICEID_8139, RL_8139,
 154                 "Delta Electronics 8139 10/100BaseTX" },
 155         { ADDTRON_VENDORID, ADDTRON_DEVICEID_8139, RL_8139,
 156                 "Addtron Technolgy 8139 10/100BaseTX" },
 157         { DLINK_VENDORID, DLINK_DEVICEID_530TXPLUS, RL_8139,
 158                 "D-Link DFE-530TX+ 10/100BaseTX" },
 159         { DLINK_VENDORID, DLINK_DEVICEID_690TXD, RL_8139,
 160                 "D-Link DFE-690TXD 10/100BaseTX" },
 161         { NORTEL_VENDORID, ACCTON_DEVICEID_5030, RL_8139,
 162                 "Nortel Networks 10/100BaseTX" },
 163         { COREGA_VENDORID, COREGA_DEVICEID_FETHERCBTXD, RL_8139,
 164                 "Corega FEther CB-TXD" },
 165         { COREGA_VENDORID, COREGA_DEVICEID_FETHERIICBTXD, RL_8139,
 166                 "Corega FEtherII CB-TXD" },
 167         { PEPPERCON_VENDORID, PEPPERCON_DEVICEID_ROLF, RL_8139,
 168                 "Peppercon AG ROL-F" },
 169         { PLANEX_VENDORID, PLANEX_DEVICEID_FNW3603TX, RL_8139,
 170                 "Planex FNW-3603-TX" },
 171         { PLANEX_VENDORID, PLANEX_DEVICEID_FNW3800TX, RL_8139,
 172                 "Planex FNW-3800-TX" },
 173         { CP_VENDORID, RT_DEVICEID_8139, RL_8139,
 174                 "Compaq HNE-300" },
 175         { LEVEL1_VENDORID, LEVEL1_DEVICEID_FPC0106TX, RL_8139,
 176                 "LevelOne FPC-0106TX" },
 177         { EDIMAX_VENDORID, EDIMAX_DEVICEID_EP4103DL, RL_8139,
 178                 "Edimax EP-4103DL CardBus" }
 179 };
 180
 181 static int rl_attach(device_t);
 182 static int rl_detach(device_t);
 183 static void rl_dma_map_rxbuf(void *, bus_dma_segment_t *, int, int);
 184 static void rl_dma_map_txbuf(void *, bus_dma_segment_t *, int, int);
 185 static void rl_eeprom_putbyte(struct rl_softc *, int);
 186 static void rl_eeprom_getword(struct rl_softc *, int, uint16_t *);
 187 static int rl_encap(struct rl_softc *, struct mbuf * );
 188 static int rl_list_tx_init(struct rl_softc *);
 189 static int rl_ifmedia_upd(struct ifnet *);
 190 static void rl_ifmedia_sts(struct ifnet *, struct ifmediareq *);
 191 static int rl_ioctl(struct ifnet *, u_long, caddr_t);
 192 static void rl_intr(void *);
 193 static void rl_init(void *);
 194 static void rl_init_locked(struct rl_softc *sc);
 195 static void rl_mii_send(struct rl_softc *, uint32_t, int);
 196 static void rl_mii_sync(struct rl_softc *);
 197 static int rl_mii_readreg(struct rl_softc *, struct rl_mii_frame *);
 198 static int rl_mii_writereg(struct rl_softc *, struct rl_mii_frame *);
 199 static int rl_miibus_readreg(device_t, int, int);
 200 static void rl_miibus_statchg(device_t);
 201 static int rl_miibus_writereg(device_t, int, int, int);
 202 #ifdef DEVICE_POLLING
 203 static void rl_poll(struct ifnet *ifp, enum poll_cmd cmd, int count);
 204 static void rl_poll_locked(struct ifnet *ifp, enum poll_cmd cmd, int count);
 205 #endif
 206 static int rl_probe(device_t);
 207 static void rl_read_eeprom(struct rl_softc *, uint8_t *, int, int, int);
 208 static void rl_reset(struct rl_softc *);
 209 static int rl_resume(device_t);
 210 static void rl_rxeof(struct rl_softc *);
 211 static void rl_setmulti(struct rl_softc *);
 212 static int rl_shutdown(device_t);
 213 static void rl_start(struct ifnet *);
 214 static void rl_start_locked(struct ifnet *);
 215 static void rl_stop(struct rl_softc *);
 216 static int rl_suspend(device_t);
 217 static void rl_tick(void *);
 218 static void rl_txeof(struct rl_softc *);
 219 static void rl_watchdog(struct rl_softc *);
 220
 221 #ifdef RL_USEIOSPACE
 222 #define RL_RES                  SYS_RES_IOPORT
 223 #define RL_RID                  RL_PCI_LOIO
 224 #else
 225 #define RL_RES                  SYS_RES_MEMORY
 226 #define RL_RID                  RL_PCI_LOMEM
 227 #endif
 228
 229 static device_method_t rl_methods[] = {
 230         /* Device interface */
 231         DEVMETHOD(device_probe,         rl_probe),
 232         DEVMETHOD(device_attach,        rl_attach),
 233         DEVMETHOD(device_detach,        rl_detach),
 234         DEVMETHOD(device_suspend,       rl_suspend),
 235         DEVMETHOD(device_resume,        rl_resume),
 236         DEVMETHOD(device_shutdown,      rl_shutdown),
 237
 238         /* bus interface */
 239         DEVMETHOD(bus_print_child,      bus_generic_print_child),
 240         DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
 241
 242         /* MII interface */
 243         DEVMETHOD(miibus_readreg,       rl_miibus_readreg),
 244         DEVMETHOD(miibus_writereg,      rl_miibus_writereg),
 245         DEVMETHOD(miibus_statchg,       rl_miibus_statchg),
 246
 247         { 0, 0 }
 248 };
 249
 250 static driver_t rl_driver = {
 251         "rl",
 252         rl_methods,
 253         sizeof(struct rl_softc)
 254 };
 255
 256 static devclass_t rl_devclass;
 257
 258 DRIVER_MODULE(rl, pci, rl_driver, rl_devclass, 0, 0);
 259 DRIVER_MODULE(rl, cardbus, rl_driver, rl_devclass, 0, 0);
 260 DRIVER_MODULE(miibus, rl, miibus_driver, miibus_devclass, 0, 0);
 261
 262 #define EE_SET(x)                                       \
 263         CSR_WRITE_1(sc, RL_EECMD,                       \
 264                 CSR_READ_1(sc, RL_EECMD) | x)
 265
 266 #define EE_CLR(x)                                       \
 267         CSR_WRITE_1(sc, RL_EECMD,                       \
 268                 CSR_READ_1(sc, RL_EECMD) & ~x)
 269
 270 static void
 271 rl_dma_map_rxbuf(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 272 {
 273         struct rl_softc *sc = arg;
 274
 275         CSR_WRITE_4(sc, RL_RXADDR, segs->ds_addr & 0xFFFFFFFF);
 276 }
 277
 278 static void
 279 rl_dma_map_txbuf(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 280 {
 281         struct rl_softc *sc = arg;
 282
 283         CSR_WRITE_4(sc, RL_CUR_TXADDR(sc), segs->ds_addr & 0xFFFFFFFF);
 284 }
 285
 286 /*
 287  * Send a read command and address to the EEPROM, check for ACK.
 288  */
 289 static void
 290 rl_eeprom_putbyte(struct rl_softc *sc, int addr)
 291 {
 292         register int            d, i;
 293
 294         d = addr | sc->rl_eecmd_read;
 295
 296         /*
 297          * Feed in each bit and strobe the clock.
 298          */
 299         for (i = 0x400; i; i >>= 1) {
 300                 if (d & i) {
 301                         EE_SET(RL_EE_DATAIN);
 302                 } else {
 303                         EE_CLR(RL_EE_DATAIN);
 304                 }
 305                 DELAY(100);
 306                 EE_SET(RL_EE_CLK);
 307                 DELAY(150);
 308                 EE_CLR(RL_EE_CLK);
 309                 DELAY(100);
 310         }
 311 }
 312
 313 /*
 314  * Read a word of data stored in the EEPROM at address 'addr.'
 315  */
 316 static void
 317 rl_eeprom_getword(struct rl_softc *sc, int addr, uint16_t *dest)
 318 {
 319         register int            i;
 320         uint16_t                word = 0;
 321
 322         /* Enter EEPROM access mode. */
 323         CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_PROGRAM|RL_EE_SEL);
 324
 325         /*
 326          * Send address of word we want to read.
 327          */
 328         rl_eeprom_putbyte(sc, addr);
 329
 330         CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_PROGRAM|RL_EE_SEL);
 331
 332         /*
 333          * Start reading bits from EEPROM.
 334          */
 335         for (i = 0x8000; i; i >>= 1) {
 336                 EE_SET(RL_EE_CLK);
 337                 DELAY(100);
 338                 if (CSR_READ_1(sc, RL_EECMD) & RL_EE_DATAOUT)
 339                         word |= i;
 340                 EE_CLR(RL_EE_CLK);
 341                 DELAY(100);
 342         }
 343
 344         /* Turn off EEPROM access mode. */
 345         CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_OFF);
 346
 347         *dest = word;
 348 }
 349
 350 /*
 351  * Read a sequence of words from the EEPROM.
 352  */
 353 static void
 354 rl_read_eeprom(struct rl_softc *sc, uint8_t *dest, int off, int cnt, int swap)
 355 {
 356         int                     i;
 357         uint16_t                word = 0, *ptr;
 358
 359         for (i = 0; i < cnt; i++) {
 360                 rl_eeprom_getword(sc, off + i, &word);
 361                 ptr = (uint16_t *)(dest + (i * 2));
 362                 if (swap)
 363                         *ptr = ntohs(word);
 364                 else
 365                         *ptr = word;
 366         }
 367 }
 368
 369 /*
 370  * MII access routines are provided for the 8129, which
 371  * doesn't have a built-in PHY. For the 8139, we fake things
 372  * up by diverting rl_phy_readreg()/rl_phy_writereg() to the
 373  * direct access PHY registers.
 374  */
 375 #define MII_SET(x)                                      \
 376         CSR_WRITE_1(sc, RL_MII,                         \
 377                 CSR_READ_1(sc, RL_MII) | (x))
 378
 379 #define MII_CLR(x)                                      \
 380         CSR_WRITE_1(sc, RL_MII,                         \
 381                 CSR_READ_1(sc, RL_MII) & ~(x))
 382
 383 /*
 384  * Sync the PHYs by setting data bit and strobing the clock 32 times.
 385  */
 386 static void
 387 rl_mii_sync(struct rl_softc *sc)
 388 {
 389         register int            i;
 390
 391         MII_SET(RL_MII_DIR|RL_MII_DATAOUT);
 392
 393         for (i = 0; i < 32; i++) {
 394                 MII_SET(RL_MII_CLK);
 395                 DELAY(1);
 396                 MII_CLR(RL_MII_CLK);
 397                 DELAY(1);
 398         }
 399 }
 400
 401 /*
 402  * Clock a series of bits through the MII.
 403  */
 404 static void
 405 rl_mii_send(struct rl_softc *sc, uint32_t bits, int cnt)
 406 {
 407         int                     i;
 408
 409         MII_CLR(RL_MII_CLK);
 410
 411         for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
 412                 if (bits & i) {
 413                         MII_SET(RL_MII_DATAOUT);
 414                 } else {
 415                         MII_CLR(RL_MII_DATAOUT);
 416                 }
 417                 DELAY(1);
 418                 MII_CLR(RL_MII_CLK);
 419                 DELAY(1);
 420                 MII_SET(RL_MII_CLK);
 421         }
 422 }
 423
 424 /*
 425  * Read an PHY register through the MII.
 426  */
 427 static int
 428 rl_mii_readreg(struct rl_softc *sc, struct rl_mii_frame *frame)
 429 {
 430         int                     i, ack;
 431
 432         /* Set up frame for RX. */
 433         frame->mii_stdelim = RL_MII_STARTDELIM;
 434         frame->mii_opcode = RL_MII_READOP;
 435         frame->mii_turnaround = 0;
 436         frame->mii_data = 0;
 437
 438         CSR_WRITE_2(sc, RL_MII, 0);
 439
 440         /* Turn on data xmit. */
 441         MII_SET(RL_MII_DIR);
 442
 443         rl_mii_sync(sc);
 444
 445         /* Send command/address info. */
 446         rl_mii_send(sc, frame->mii_stdelim, 2);
 447         rl_mii_send(sc, frame->mii_opcode, 2);
 448         rl_mii_send(sc, frame->mii_phyaddr, 5);
 449         rl_mii_send(sc, frame->mii_regaddr, 5);
 450
 451         /* Idle bit */
 452         MII_CLR((RL_MII_CLK|RL_MII_DATAOUT));
 453         DELAY(1);
 454         MII_SET(RL_MII_CLK);
 455         DELAY(1);
 456
 457         /* Turn off xmit. */
 458         MII_CLR(RL_MII_DIR);
 459
 460         /* Check for ack */
 461         MII_CLR(RL_MII_CLK);
 462         DELAY(1);
 463         ack = CSR_READ_2(sc, RL_MII) & RL_MII_DATAIN;
 464         MII_SET(RL_MII_CLK);
 465         DELAY(1);
 466
 467         /*
 468          * Now try reading data bits. If the ack failed, we still
 469          * need to clock through 16 cycles to keep the PHY(s) in sync.
 470          */
 471         if (ack) {
 472                 for(i = 0; i < 16; i++) {
 473                         MII_CLR(RL_MII_CLK);
 474                         DELAY(1);
 475                         MII_SET(RL_MII_CLK);
 476                         DELAY(1);
 477                 }
 478                 goto fail;
 479         }
 480
 481         for (i = 0x8000; i; i >>= 1) {
 482                 MII_CLR(RL_MII_CLK);
 483                 DELAY(1);
 484                 if (!ack) {
 485                         if (CSR_READ_2(sc, RL_MII) & RL_MII_DATAIN)
 486                                 frame->mii_data |= i;
 487                         DELAY(1);
 488                 }
 489                 MII_SET(RL_MII_CLK);
 490                 DELAY(1);
 491         }
 492
 493 fail:
 494         MII_CLR(RL_MII_CLK);
 495         DELAY(1);
 496         MII_SET(RL_MII_CLK);
 497         DELAY(1);
 498
 499         return (ack ? 1 : 0);
 500 }
 501
 502 /*
 503  * Write to a PHY register through the MII.
 504  */
 505 static int
 506 rl_mii_writereg(struct rl_softc *sc, struct rl_mii_frame *frame)
 507 {
 508
 509         /* Set up frame for TX. */
 510         frame->mii_stdelim = RL_MII_STARTDELIM;
 511         frame->mii_opcode = RL_MII_WRITEOP;
 512         frame->mii_turnaround = RL_MII_TURNAROUND;
 513
 514         /* Turn on data output. */
 515         MII_SET(RL_MII_DIR);
 516
 517         rl_mii_sync(sc);
 518
 519         rl_mii_send(sc, frame->mii_stdelim, 2);
 520         rl_mii_send(sc, frame->mii_opcode, 2);
 521         rl_mii_send(sc, frame->mii_phyaddr, 5);
 522         rl_mii_send(sc, frame->mii_regaddr, 5);
 523         rl_mii_send(sc, frame->mii_turnaround, 2);
 524         rl_mii_send(sc, frame->mii_data, 16);
 525
 526         /* Idle bit. */
 527         MII_SET(RL_MII_CLK);
 528         DELAY(1);
 529         MII_CLR(RL_MII_CLK);
 530         DELAY(1);
 531
 532         /* Turn off xmit. */
 533         MII_CLR(RL_MII_DIR);
 534
 535         return (0);
 536 }
 537
 538 static int
 539 rl_miibus_readreg(device_t dev, int phy, int reg)
 540 {
 541         struct rl_softc         *sc;
 542         struct rl_mii_frame     frame;
 543         uint16_t                rval = 0;
 544         uint16_t                rl8139_reg = 0;
 545
 546         sc = device_get_softc(dev);
 547
 548         if (sc->rl_type == RL_8139) {
 549                 /* Pretend the internal PHY is only at address 0 */
 550                 if (phy) {
 551                         return (0);
 552                 }
 553                 switch (reg) {
 554                 case MII_BMCR:
 555                         rl8139_reg = RL_BMCR;
 556                         break;
 557                 case MII_BMSR:
 558                         rl8139_reg = RL_BMSR;
 559                         break;
 560                 case MII_ANAR:
 561                         rl8139_reg = RL_ANAR;
 562                         break;
 563                 case MII_ANER:
 564                         rl8139_reg = RL_ANER;
 565                         break;
 566                 case MII_ANLPAR:
 567                         rl8139_reg = RL_LPAR;
 568                         break;
 569                 case MII_PHYIDR1:
 570                 case MII_PHYIDR2:
 571                         return (0);
 572                 /*
 573                  * Allow the rlphy driver to read the media status
 574                  * register. If we have a link partner which does not
 575                  * support NWAY, this is the register which will tell
 576                  * us the results of parallel detection.
 577                  */
 578                 case RL_MEDIASTAT:
 579                         rval = CSR_READ_1(sc, RL_MEDIASTAT);
 580                         return (rval);
 581                 default:
 582                         device_printf(sc->rl_dev, "bad phy register\n");
 583                         return (0);
 584                 }
 585                 rval = CSR_READ_2(sc, rl8139_reg);
 586                 return (rval);
 587         }
 588
 589         bzero((char *)&frame, sizeof(frame));
 590         frame.mii_phyaddr = phy;
 591         frame.mii_regaddr = reg;
 592         rl_mii_readreg(sc, &frame);
 593
 594         return (frame.mii_data);
 595 }
 596
 597 static int
 598 rl_miibus_writereg(device_t dev, int phy, int reg, int data)
 599 {
 600         struct rl_softc         *sc;
 601         struct rl_mii_frame     frame;
 602         uint16_t                rl8139_reg = 0;
 603
 604         sc = device_get_softc(dev);
 605
 606         if (sc->rl_type == RL_8139) {
 607                 /* Pretend the internal PHY is only at address 0 */
 608                 if (phy) {
 609                         return (0);
 610                 }
 611                 switch (reg) {
 612                 case MII_BMCR:
 613                         rl8139_reg = RL_BMCR;
 614                         break;
 615                 case MII_BMSR:
 616                         rl8139_reg = RL_BMSR;
 617                         break;
 618                 case MII_ANAR:
 619                         rl8139_reg = RL_ANAR;
 620                         break;
 621                 case MII_ANER:
 622                         rl8139_reg = RL_ANER;
 623                         break;
 624                 case MII_ANLPAR:
 625                         rl8139_reg = RL_LPAR;
 626                         break;
 627                 case MII_PHYIDR1:
 628                 case MII_PHYIDR2:
 629                         return (0);
 630                         break;
 631                 default:
 632                         device_printf(sc->rl_dev, "bad phy register\n");
 633                         return (0);
 634                 }
 635                 CSR_WRITE_2(sc, rl8139_reg, data);
 636                 return (0);
 637         }
 638
 639         bzero((char *)&frame, sizeof(frame));
 640         frame.mii_phyaddr = phy;
 641         frame.mii_regaddr = reg;
 642         frame.mii_data = data;
 643         rl_mii_writereg(sc, &frame);
 644
 645         return (0);
 646 }
 647
 648 static void
 649 rl_miibus_statchg(device_t dev)
 650 {
 651 }
 652
 653 /*
 654  * Program the 64-bit multicast hash filter.
 655  */
 656 static void
 657 rl_setmulti(struct rl_softc *sc)
 658 {
 659         struct ifnet            *ifp = sc->rl_ifp;
 660         int                     h = 0;
 661         uint32_t                hashes[2] = { 0, 0 };
 662         struct ifmultiaddr      *ifma;
 663         uint32_t                rxfilt;
 664         int                     mcnt = 0;
 665
 666         RL_LOCK_ASSERT(sc);
 667
 668         rxfilt = CSR_READ_4(sc, RL_RXCFG);
 669
 670         if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
 671                 rxfilt |= RL_RXCFG_RX_MULTI;
 672                 CSR_WRITE_4(sc, RL_RXCFG, rxfilt);
 673                 CSR_WRITE_4(sc, RL_MAR0, 0xFFFFFFFF);
 674                 CSR_WRITE_4(sc, RL_MAR4, 0xFFFFFFFF);
 675                 return;
 676         }
 677
 678         /* first, zot all the existing hash bits */
 679         CSR_WRITE_4(sc, RL_MAR0, 0);
 680         CSR_WRITE_4(sc, RL_MAR4, 0);
 681
 682         /* now program new ones */
 683         IF_ADDR_LOCK(ifp);
 684         TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 685                 if (ifma->ifma_addr->sa_family != AF_LINK)
 686                         continue;
 687                 h = ether_crc32_be(LLADDR((struct sockaddr_dl *)
 688                     ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
 689                 if (h < 32)
 690                         hashes[0] |= (1 << h);
 691                 else
 692                         hashes[1] |= (1 << (h - 32));
 693                 mcnt++;
 694         }
 695         IF_ADDR_UNLOCK(ifp);
 696
 697         if (mcnt)
 698                 rxfilt |= RL_RXCFG_RX_MULTI;
 699         else
 700                 rxfilt &= ~RL_RXCFG_RX_MULTI;
 701
 702         CSR_WRITE_4(sc, RL_RXCFG, rxfilt);
 703         CSR_WRITE_4(sc, RL_MAR0, hashes[0]);
 704         CSR_WRITE_4(sc, RL_MAR4, hashes[1]);
 705 }
 706
 707 static void
 708 rl_reset(struct rl_softc *sc)
 709 {
 710         register int            i;
 711
 712         RL_LOCK_ASSERT(sc);
 713
 714         CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_RESET);
 715
 716         for (i = 0; i < RL_TIMEOUT; i++) {
 717                 DELAY(10);
 718                 if (!(CSR_READ_1(sc, RL_COMMAND) & RL_CMD_RESET))
 719                         break;
 720         }
 721         if (i == RL_TIMEOUT)
 722                 device_printf(sc->rl_dev, "reset never completed!\n");
 723 }
 724
 725 /*
 726  * Probe for a RealTek 8129/8139 chip. Check the PCI vendor and device
 727  * IDs against our list and return a device name if we find a match.
 728  */
 729 static int
 730 rl_probe(device_t dev)
 731 {
 732         struct rl_type          *t;
 733         uint16_t                devid, revid, vendor;
 734         int                     i;
 735
 736         vendor = pci_get_vendor(dev);
 737         devid = pci_get_device(dev);
 738         revid = pci_get_revid(dev);
 739
 740         if (vendor == RT_VENDORID && devid == RT_DEVICEID_8139) {
 741                 if (revid == 0x20) {
 742                         /* 8139C+, let re(4) take care of this device. */
 743                         return (ENXIO);
 744                 }
 745         }
 746         t = rl_devs;
 747         for (i = 0; i < sizeof(rl_devs) / sizeof(rl_devs[0]); i++, t++) {
 748                 if (vendor == t->rl_vid && devid == t->rl_did) {
 749                         device_set_desc(dev, t->rl_name);
 750                         return (BUS_PROBE_DEFAULT);
 751                 }
 752         }
 753
 754         return (ENXIO);
 755 }
 756
 757 /*
 758  * Attach the interface. Allocate softc structures, do ifmedia
 759  * setup and ethernet/BPF attach.
 760  */
 761 static int
 762 rl_attach(device_t dev)
 763 {
 764         uint8_t                 eaddr[ETHER_ADDR_LEN];
 765         uint16_t                as[3];
 766         struct ifnet            *ifp;
 767         struct rl_softc         *sc;
 768         struct rl_type          *t;
 769         int                     error = 0, i, rid;
 770         int                     unit;
 771         uint16_t                rl_did = 0;
 772
 773         sc = device_get_softc(dev);
 774         unit = device_get_unit(dev);
 775         sc->rl_dev = dev;
 776
 777         mtx_init(&sc->rl_mtx, device_get_nameunit(dev), MTX_NETWORK_LOCK,
 778             MTX_DEF);
 779         callout_init_mtx(&sc->rl_stat_callout, &sc->rl_mtx, 0);
 780
 781         pci_enable_busmaster(dev);
 782
 783         /* Map control/status registers. */
 784         rid = RL_RID;
 785         sc->rl_res = bus_alloc_resource_any(dev, RL_RES, &rid, RF_ACTIVE);
 786
 787         if (sc->rl_res == NULL) {
 788                 device_printf(dev, "couldn't map ports/memory\n");
 789                 error = ENXIO;
 790                 goto fail;
 791         }
 792
 793 #ifdef notdef
 794         /*
 795          * Detect the Realtek 8139B. For some reason, this chip is very
 796          * unstable when left to autoselect the media
 797          * The best workaround is to set the device to the required
 798          * media type or to set it to the 10 Meg speed.
 799          */
 800         if ((rman_get_end(sc->rl_res) - rman_get_start(sc->rl_res)) == 0xFF)
 801                 device_printf(dev,
 802 "Realtek 8139B detected. Warning, this may be unstable in autoselect mode\n");
 803 #endif
 804
 805         sc->rl_btag = rman_get_bustag(sc->rl_res);
 806         sc->rl_bhandle = rman_get_bushandle(sc->rl_res);
 807
 808         /* Allocate interrupt */
 809         rid = 0;
 810         sc->rl_irq[0] = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 811             RF_SHAREABLE | RF_ACTIVE);
 812
 813         if (sc->rl_irq[0] == NULL) {
 814                 device_printf(dev, "couldn't map interrupt\n");
 815                 error = ENXIO;
 816                 goto fail;
 817         }
 818
 819         /*
 820          * Reset the adapter. Only take the lock here as it's needed in
 821          * order to call rl_reset().
 822          */
 823         RL_LOCK(sc);
 824         rl_reset(sc);
 825         RL_UNLOCK(sc);
 826
 827         sc->rl_eecmd_read = RL_EECMD_READ_6BIT;
 828         rl_read_eeprom(sc, (uint8_t *)&rl_did, 0, 1, 0);
 829         if (rl_did != 0x8129)
 830                 sc->rl_eecmd_read = RL_EECMD_READ_8BIT;
 831
 832         /*
 833          * Get station address from the EEPROM.
 834          */
 835         rl_read_eeprom(sc, (uint8_t *)as, RL_EE_EADDR, 3, 0);
 836         for (i = 0; i < 3; i++) {
 837                 eaddr[(i * 2) + 0] = as[i] & 0xff;
 838                 eaddr[(i * 2) + 1] = as[i] >> 8;
 839         }
 840
 841         /*
 842          * Now read the exact device type from the EEPROM to find
 843          * out if it's an 8129 or 8139.
 844          */
 845         rl_read_eeprom(sc, (uint8_t *)&rl_did, RL_EE_PCI_DID, 1, 0);
 846
 847         t = rl_devs;
 848         sc->rl_type = 0;
 849         while(t->rl_name != NULL) {
 850                 if (rl_did == t->rl_did) {
 851                         sc->rl_type = t->rl_basetype;
 852                         break;
 853                 }
 854                 t++;
 855         }
 856
 857         if (sc->rl_type == 0) {
 858                 device_printf(dev, "unknown device ID: %x\n", rl_did);
 859                 error = ENXIO;
 860                 goto fail;
 861         }
 862
 863         /*
 864          * Allocate the parent bus DMA tag appropriate for PCI.
 865          */
 866 #define RL_NSEG_NEW 32
 867         error = bus_dma_tag_create(bus_get_dma_tag(dev),        /* parent */
 868                         1, 0,                   /* alignment, boundary */
 869                         BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
 870                         BUS_SPACE_MAXADDR,      /* highaddr */
 871                         NULL, NULL,             /* filter, filterarg */
 872                         MAXBSIZE, RL_NSEG_NEW,  /* maxsize, nsegments */
 873                         BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
 874                         BUS_DMA_ALLOCNOW,       /* flags */
 875                         NULL, NULL,             /* lockfunc, lockarg */
 876                         &sc->rl_parent_tag);
 877         if (error)
 878                 goto fail;
 879
 880         /*
 881          * Now allocate a tag for the DMA descriptor lists.
 882          * All of our lists are allocated as a contiguous block
 883          * of memory.
 884          */
 885         error = bus_dma_tag_create(sc->rl_parent_tag,   /* parent */
 886                         1, 0,                   /* alignment, boundary */
 887                         BUS_SPACE_MAXADDR,      /* lowaddr */
 888                         BUS_SPACE_MAXADDR,      /* highaddr */
 889                         NULL, NULL,             /* filter, filterarg */
 890                         RL_RXBUFLEN + 1518, 1,  /* maxsize,nsegments */
 891                         BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
 892                         BUS_DMA_ALLOCNOW,               /* flags */
 893                         NULL, NULL,             /* lockfunc, lockarg */
 894                         &sc->rl_tag);
 895         if (error)
 896                 goto fail;
 897
 898         /*
 899          * Now allocate a chunk of DMA-able memory based on the
 900          * tag we just created.
 901          */
 902         error = bus_dmamem_alloc(sc->rl_tag,
 903             (void **)&sc->rl_cdata.rl_rx_buf, BUS_DMA_NOWAIT | BUS_DMA_ZERO,
 904             &sc->rl_cdata.rl_rx_dmamap);
 905         if (error) {
 906                 device_printf(dev, "no memory for list buffers!\n");
 907                 bus_dma_tag_destroy(sc->rl_tag);
 908                 sc->rl_tag = NULL;
 909                 goto fail;
 910         }
 911
 912         /* Leave a few bytes before the start of the RX ring buffer. */
 913         sc->rl_cdata.rl_rx_buf_ptr = sc->rl_cdata.rl_rx_buf;
 914         sc->rl_cdata.rl_rx_buf += sizeof(uint64_t);
 915
 916         ifp = sc->rl_ifp = if_alloc(IFT_ETHER);
 917         if (ifp == NULL) {
 918                 device_printf(dev, "can not if_alloc()\n");
 919                 error = ENOSPC;
 920                 goto fail;
 921         }
 922
 923         /* Do MII setup */
 924         if (mii_phy_probe(dev, &sc->rl_miibus,
 925             rl_ifmedia_upd, rl_ifmedia_sts)) {
 926                 device_printf(dev, "MII without any phy!\n");
 927                 error = ENXIO;
 928                 goto fail;
 929         }
 930
 931         ifp->if_softc = sc;
 932         if_initname(ifp, device_get_name(dev), device_get_unit(dev));
 933         ifp->if_mtu = ETHERMTU;
 934         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
 935         ifp->if_ioctl = rl_ioctl;
 936         ifp->if_start = rl_start;
 937         ifp->if_init = rl_init;
 938         ifp->if_capabilities = IFCAP_VLAN_MTU;
 939         ifp->if_capenable = ifp->if_capabilities;
 940 #ifdef DEVICE_POLLING
 941         ifp->if_capabilities |= IFCAP_POLLING;
 942 #endif
 943         IFQ_SET_MAXLEN(&ifp->if_snd, IFQ_MAXLEN);
 944         ifp->if_snd.ifq_drv_maxlen = IFQ_MAXLEN;
 945         IFQ_SET_READY(&ifp->if_snd);
 946
 947         /*
 948          * Call MI attach routine.
 949          */
 950         ether_ifattach(ifp, eaddr);
 951
 952         /* Hook interrupt last to avoid having to lock softc */
 953         error = bus_setup_intr(dev, sc->rl_irq[0], INTR_TYPE_NET | INTR_MPSAFE,
 954             NULL, rl_intr, sc, &sc->rl_intrhand[0]);
 955         if (error) {
 956                 device_printf(sc->rl_dev, "couldn't set up irq\n");
 957                 ether_ifdetach(ifp);
 958         }
 959
 960 fail:
 961         if (error)
 962                 rl_detach(dev);
 963
 964         return (error);
 965 }
 966
 967 /*
 968  * Shutdown hardware and free up resources. This can be called any
 969  * time after the mutex has been initialized. It is called in both
 970  * the error case in attach and the normal detach case so it needs
 971  * to be careful about only freeing resources that have actually been
 972  * allocated.
 973  */
 974 static int
 975 rl_detach(device_t dev)
 976 {
 977         struct rl_softc         *sc;
 978         struct ifnet            *ifp;
 979
 980         sc = device_get_softc(dev);
 981         ifp = sc->rl_ifp;
 982
 983         KASSERT(mtx_initialized(&sc->rl_mtx), ("rl mutex not initialized"));
 984
 985 #ifdef DEVICE_POLLING
 986         if (ifp->if_capenable & IFCAP_POLLING)
 987                 ether_poll_deregister(ifp);
 988 #endif
 989         /* These should only be active if attach succeeded */
 990         if (device_is_attached(dev)) {
 991                 RL_LOCK(sc);
 992                 rl_stop(sc);
 993                 RL_UNLOCK(sc);
 994                 callout_drain(&sc->rl_stat_callout);
 995                 ether_ifdetach(ifp);
 996         }
 997 #if 0
 998         sc->suspended = 1;
 999 #endif
1000         if (sc->rl_miibus)
1001                 device_delete_child(dev, sc->rl_miibus);
1002         bus_generic_detach(dev);
1003
1004         if (sc->rl_intrhand[0])
1005                 bus_teardown_intr(dev, sc->rl_irq[0], sc->rl_intrhand[0]);
1006         if (sc->rl_irq[0])
1007                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq[0]);
1008         if (sc->rl_res)
1009                 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
1010
1011         if (ifp)
1012                 if_free(ifp);
1013
1014         if (sc->rl_tag) {
1015                 bus_dmamap_unload(sc->rl_tag, sc->rl_cdata.rl_rx_dmamap);
1016                 bus_dmamem_free(sc->rl_tag, sc->rl_cdata.rl_rx_buf,
1017                     sc->rl_cdata.rl_rx_dmamap);
1018                 bus_dma_tag_destroy(sc->rl_tag);
1019         }
1020         if (sc->rl_parent_tag)
1021                 bus_dma_tag_destroy(sc->rl_parent_tag);
1022
1023         mtx_destroy(&sc->rl_mtx);
1024
1025         return (0);
1026 }
1027
1028 /*
1029  * Initialize the transmit descriptors.
1030  */
1031 static int
1032 rl_list_tx_init(struct rl_softc *sc)
1033 {
1034         struct rl_chain_data    *cd;
1035         int                     i;
1036
1037         RL_LOCK_ASSERT(sc);
1038
1039         cd = &sc->rl_cdata;
1040         for (i = 0; i < RL_TX_LIST_CNT; i++) {
1041                 cd->rl_tx_chain[i] = NULL;
1042                 CSR_WRITE_4(sc,
1043                     RL_TXADDR0 + (i * sizeof(uint32_t)), 0x0000000);
1044         }
1045
1046         sc->rl_cdata.cur_tx = 0;
1047         sc->rl_cdata.last_tx = 0;
1048
1049         return (0);
1050 }
1051
1052 /*
1053  * A frame has been uploaded: pass the resulting mbuf chain up to
1054  * the higher level protocols.
1055  *
1056  * You know there's something wrong with a PCI bus-master chip design
1057  * when you have to use m_devget().
1058  *
1059  * The receive operation is badly documented in the datasheet, so I'll
1060  * attempt to document it here. The driver provides a buffer area and
1061  * places its base address in the RX buffer start address register.
1062  * The chip then begins copying frames into the RX buffer. Each frame
1063  * is preceded by a 32-bit RX status word which specifies the length
1064  * of the frame and certain other status bits. Each frame (starting with
1065  * the status word) is also 32-bit aligned. The frame length is in the
1066  * first 16 bits of the status word; the lower 15 bits correspond with
1067  * the 'rx status register' mentioned in the datasheet.
1068  *
1069  * Note: to make the Alpha happy, the frame payload needs to be aligned
1070  * on a 32-bit boundary. To achieve this, we pass RL_ETHER_ALIGN (2 bytes)
1071  * as the offset argument to m_devget().
1072  */
1073 static void
1074 rl_rxeof(struct rl_softc *sc)
1075 {
1076         struct mbuf             *m;
1077         struct ifnet            *ifp = sc->rl_ifp;
1078         uint8_t                 *rxbufpos;
1079         int                     total_len = 0;
1080         int                     wrap = 0;
1081         uint32_t                rxstat;
1082         uint16_t                cur_rx;
1083         uint16_t                limit;
1084         uint16_t                max_bytes, rx_bytes = 0;
1085
1086         RL_LOCK_ASSERT(sc);
1087
1088         bus_dmamap_sync(sc->rl_tag, sc->rl_cdata.rl_rx_dmamap,
1089             BUS_DMASYNC_POSTREAD);
1090
1091         cur_rx = (CSR_READ_2(sc, RL_CURRXADDR) + 16) % RL_RXBUFLEN;
1092
1093         /* Do not try to read past this point. */
1094         limit = CSR_READ_2(sc, RL_CURRXBUF) % RL_RXBUFLEN;
1095
1096         if (limit < cur_rx)
1097                 max_bytes = (RL_RXBUFLEN - cur_rx) + limit;
1098         else
1099                 max_bytes = limit - cur_rx;
1100
1101         while((CSR_READ_1(sc, RL_COMMAND) & RL_CMD_EMPTY_RXBUF) == 0) {
1102 #ifdef DEVICE_POLLING
1103                 if (ifp->if_capenable & IFCAP_POLLING) {
1104                         if (sc->rxcycles <= 0)
1105                                 break;
1106                         sc->rxcycles--;
1107                 }
1108 #endif
1109                 rxbufpos = sc->rl_cdata.rl_rx_buf + cur_rx;
1110                 rxstat = le32toh(*(uint32_t *)rxbufpos);
1111
1112                 /*
1113                  * Here's a totally undocumented fact for you. When the
1114                  * RealTek chip is in the process of copying a packet into
1115                  * RAM for you, the length will be 0xfff0. If you spot a
1116                  * packet header with this value, you need to stop. The
1117                  * datasheet makes absolutely no mention of this and
1118                  * RealTek should be shot for this.
1119                  */
1120                 if ((uint16_t)(rxstat >> 16) == RL_RXSTAT_UNFINISHED)
1121                         break;
1122
1123                 if (!(rxstat & RL_RXSTAT_RXOK)) {
1124                         ifp->if_ierrors++;
1125                         rl_init_locked(sc);
1126                         return;
1127                 }
1128
1129                 /* No errors; receive the packet. */
1130                 total_len = rxstat >> 16;
1131                 rx_bytes += total_len + 4;
1132
1133                 /*
1134                  * XXX The RealTek chip includes the CRC with every
1135                  * received frame, and there's no way to turn this
1136                  * behavior off (at least, I can't find anything in
1137                  * the manual that explains how to do it) so we have
1138                  * to trim off the CRC manually.
1139                  */
1140                 total_len -= ETHER_CRC_LEN;
1141
1142                 /*
1143                  * Avoid trying to read more bytes than we know
1144                  * the chip has prepared for us.
1145                  */
1146                 if (rx_bytes > max_bytes)
1147                         break;
1148
1149                 rxbufpos = sc->rl_cdata.rl_rx_buf +
1150                         ((cur_rx + sizeof(uint32_t)) % RL_RXBUFLEN);
1151                 if (rxbufpos == (sc->rl_cdata.rl_rx_buf + RL_RXBUFLEN))
1152                         rxbufpos = sc->rl_cdata.rl_rx_buf;
1153
1154                 wrap = (sc->rl_cdata.rl_rx_buf + RL_RXBUFLEN) - rxbufpos;
1155                 if (total_len > wrap) {
1156                         m = m_devget(rxbufpos, total_len, RL_ETHER_ALIGN, ifp,
1157                             NULL);
1158                         if (m == NULL) {
1159                                 ifp->if_ierrors++;
1160                         } else {
1161                                 m_copyback(m, wrap, total_len - wrap,
1162                                         sc->rl_cdata.rl_rx_buf);
1163                         }
1164                         cur_rx = (total_len - wrap + ETHER_CRC_LEN);
1165                 } else {
1166                         m = m_devget(rxbufpos, total_len, RL_ETHER_ALIGN, ifp,
1167                             NULL);
1168                         if (m == NULL)
1169                                 ifp->if_ierrors++;
1170                         cur_rx += total_len + 4 + ETHER_CRC_LEN;
1171                 }
1172
1173                 /* Round up to 32-bit boundary. */
1174                 cur_rx = (cur_rx + 3) & ~3;
1175                 CSR_WRITE_2(sc, RL_CURRXADDR, cur_rx - 16);
1176
1177                 if (m == NULL)
1178                         continue;
1179
1180                 ifp->if_ipackets++;
1181                 RL_UNLOCK(sc);
1182                 (*ifp->if_input)(ifp, m);
1183                 RL_LOCK(sc);
1184         }
1185 }
1186
1187 /*
1188  * A frame was downloaded to the chip. It's safe for us to clean up
1189  * the list buffers.
1190  */
1191 static void
1192 rl_txeof(struct rl_softc *sc)
1193 {
1194         struct ifnet            *ifp = sc->rl_ifp;
1195         uint32_t                txstat;
1196
1197         RL_LOCK_ASSERT(sc);
1198
1199         /*
1200          * Go through our tx list and free mbufs for those
1201          * frames that have been uploaded.
1202          */
1203         do {
1204                 if (RL_LAST_TXMBUF(sc) == NULL)
1205                         break;
1206                 txstat = CSR_READ_4(sc, RL_LAST_TXSTAT(sc));
1207                 if (!(txstat & (RL_TXSTAT_TX_OK|
1208                     RL_TXSTAT_TX_UNDERRUN|RL_TXSTAT_TXABRT)))
1209                         break;
1210
1211                 ifp->if_collisions += (txstat & RL_TXSTAT_COLLCNT) >> 24;
1212
1213                 bus_dmamap_unload(sc->rl_tag, RL_LAST_DMAMAP(sc));
1214                 bus_dmamap_destroy(sc->rl_tag, RL_LAST_DMAMAP(sc));
1215                 m_freem(RL_LAST_TXMBUF(sc));
1216                 RL_LAST_TXMBUF(sc) = NULL;
1217                 /*
1218                  * If there was a transmit underrun, bump the TX threshold.
1219                  * Make sure not to overflow the 63 * 32byte we can address
1220                  * with the 6 available bit.
1221                  */
1222                 if ((txstat & RL_TXSTAT_TX_UNDERRUN) &&
1223                     (sc->rl_txthresh < 2016))
1224                         sc->rl_txthresh += 32;
1225                 if (txstat & RL_TXSTAT_TX_OK)
1226                         ifp->if_opackets++;
1227                 else {
1228                         int                     oldthresh;
1229                         ifp->if_oerrors++;
1230                         if ((txstat & RL_TXSTAT_TXABRT) ||
1231                             (txstat & RL_TXSTAT_OUTOFWIN))
1232                                 CSR_WRITE_4(sc, RL_TXCFG, RL_TXCFG_CONFIG);
1233                         oldthresh = sc->rl_txthresh;
1234                         /* error recovery */
1235                         rl_reset(sc);
1236                         rl_init_locked(sc);
1237                         /* restore original threshold */
1238                         sc->rl_txthresh = oldthresh;
1239                         return;
1240                 }
1241                 RL_INC(sc->rl_cdata.last_tx);
1242                 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1243         } while (sc->rl_cdata.last_tx != sc->rl_cdata.cur_tx);
1244
1245         if (RL_LAST_TXMBUF(sc) == NULL)
1246                 sc->rl_watchdog_timer = 0;
1247         else if (sc->rl_watchdog_timer == 0)
1248                 sc->rl_watchdog_timer = 5;
1249 }
1250
1251 static void
1252 rl_tick(void *xsc)
1253 {
1254         struct rl_softc         *sc = xsc;
1255         struct mii_data         *mii;
1256
1257         RL_LOCK_ASSERT(sc);
1258         mii = device_get_softc(sc->rl_miibus);
1259         mii_tick(mii);
1260
1261         rl_watchdog(sc);
1262
1263         callout_reset(&sc->rl_stat_callout, hz, rl_tick, sc);
1264 }
1265
1266 #ifdef DEVICE_POLLING
1267 static void
1268 rl_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
1269 {
1270         struct rl_softc *sc = ifp->if_softc;
1271
1272         RL_LOCK(sc);
1273         if (ifp->if_drv_flags & IFF_DRV_RUNNING)
1274                 rl_poll_locked(ifp, cmd, count);
1275         RL_UNLOCK(sc);
1276 }
1277
1278 static void
1279 rl_poll_locked(struct ifnet *ifp, enum poll_cmd cmd, int count)
1280 {
1281         struct rl_softc *sc = ifp->if_softc;
1282
1283         RL_LOCK_ASSERT(sc);
1284
1285         sc->rxcycles = count;
1286         rl_rxeof(sc);
1287         rl_txeof(sc);
1288
1289         if (!IFQ_DRV_IS_EMPTY(&ifp->if_snd))
1290                 rl_start_locked(ifp);
1291
1292         if (cmd == POLL_AND_CHECK_STATUS) {
1293                 uint16_t        status;
1294
1295                 /* We should also check the status register. */
1296                 status = CSR_READ_2(sc, RL_ISR);
1297                 if (status == 0xffff)
1298                         return;
1299                 if (status != 0)
1300                         CSR_WRITE_2(sc, RL_ISR, status);
1301
1302                 /* XXX We should check behaviour on receiver stalls. */
1303
1304                 if (status & RL_ISR_SYSTEM_ERR) {
1305                         rl_reset(sc);
1306                         rl_init_locked(sc);
1307                 }
1308         }
1309 }
1310 #endif /* DEVICE_POLLING */
1311
1312 static void
1313 rl_intr(void *arg)
1314 {
1315         struct rl_softc         *sc = arg;
1316         struct ifnet            *ifp = sc->rl_ifp;
1317         uint16_t                status;
1318
1319         RL_LOCK(sc);
1320
1321         if (sc->suspended)
1322                 goto done_locked;
1323
1324 #ifdef DEVICE_POLLING
1325         if  (ifp->if_capenable & IFCAP_POLLING)
1326                 goto done_locked;
1327 #endif
1328
1329         for (;;) {
1330                 status = CSR_READ_2(sc, RL_ISR);
1331                 /* If the card has gone away, the read returns 0xffff. */
1332                 if (status == 0xffff)
1333                         break;
1334                 if (status != 0)
1335                         CSR_WRITE_2(sc, RL_ISR, status);
1336                 if ((status & RL_INTRS) == 0)
1337                         break;
1338                 if (status & RL_ISR_RX_OK)
1339                         rl_rxeof(sc);
1340                 if (status & RL_ISR_RX_ERR)
1341                         rl_rxeof(sc);
1342                 if ((status & RL_ISR_TX_OK) || (status & RL_ISR_TX_ERR))
1343                         rl_txeof(sc);
1344                 if (status & RL_ISR_SYSTEM_ERR) {
1345                         rl_reset(sc);
1346                         rl_init_locked(sc);
1347                 }
1348         }
1349
1350         if (!IFQ_DRV_IS_EMPTY(&ifp->if_snd))
1351                 rl_start_locked(ifp);
1352
1353 done_locked:
1354         RL_UNLOCK(sc);
1355 }
1356
1357 /*
1358  * Encapsulate an mbuf chain in a descriptor by coupling the mbuf data
1359  * pointers to the fragment pointers.
1360  */
1361 static int
1362 rl_encap(struct rl_softc *sc, struct mbuf *m_head)
1363 {
1364         struct mbuf             *m_new = NULL;
1365
1366         RL_LOCK_ASSERT(sc);
1367
1368         /*
1369          * The RealTek is brain damaged and wants longword-aligned
1370          * TX buffers, plus we can only have one fragment buffer
1371          * per packet. We have to copy pretty much all the time.
1372          */
1373         m_new = m_defrag(m_head, M_DONTWAIT);
1374
1375         if (m_new == NULL) {
1376                 m_freem(m_head);
1377                 return (1);
1378         }
1379         m_head = m_new;
1380
1381         /* Pad frames to at least 60 bytes. */
1382         if (m_head->m_pkthdr.len < RL_MIN_FRAMELEN) {
1383                 /*
1384                  * Make security concious people happy: zero out the
1385                  * bytes in the pad area, since we don't know what
1386                  * this mbuf cluster buffer's previous user might
1387                  * have left in it.
1388                  */
1389                 bzero(mtod(m_head, char *) + m_head->m_pkthdr.len,
1390                      RL_MIN_FRAMELEN - m_head->m_pkthdr.len);
1391                 m_head->m_pkthdr.len +=
1392                     (RL_MIN_FRAMELEN - m_head->m_pkthdr.len);
1393                 m_head->m_len = m_head->m_pkthdr.len;
1394         }
1395
1396         RL_CUR_TXMBUF(sc) = m_head;
1397
1398         return (0);
1399 }
1400
1401 /*
1402  * Main transmit routine.
1403  */
1404 static void
1405 rl_start(struct ifnet *ifp)
1406 {
1407         struct rl_softc         *sc = ifp->if_softc;
1408
1409         RL_LOCK(sc);
1410         rl_start_locked(ifp);
1411         RL_UNLOCK(sc);
1412 }
1413
1414 static void
1415 rl_start_locked(struct ifnet *ifp)
1416 {
1417         struct rl_softc         *sc = ifp->if_softc;
1418         struct mbuf             *m_head = NULL;
1419
1420         RL_LOCK_ASSERT(sc);
1421
1422         while (RL_CUR_TXMBUF(sc) == NULL) {
1423
1424                 IFQ_DRV_DEQUEUE(&ifp->if_snd, m_head);
1425
1426                 if (m_head == NULL)
1427                         break;
1428
1429                 if (rl_encap(sc, m_head))
1430                         break;
1431
1432                 /* Pass a copy of this mbuf chain to the bpf subsystem. */
1433                 BPF_MTAP(ifp, RL_CUR_TXMBUF(sc));
1434
1435                 /* Transmit the frame. */
1436                 bus_dmamap_create(sc->rl_tag, 0, &RL_CUR_DMAMAP(sc));
1437                 bus_dmamap_load(sc->rl_tag, RL_CUR_DMAMAP(sc),
1438                     mtod(RL_CUR_TXMBUF(sc), void *),
1439                     RL_CUR_TXMBUF(sc)->m_pkthdr.len, rl_dma_map_txbuf, sc, 0);
1440                 bus_dmamap_sync(sc->rl_tag, RL_CUR_DMAMAP(sc),
1441                     BUS_DMASYNC_PREREAD);
1442                 CSR_WRITE_4(sc, RL_CUR_TXSTAT(sc),
1443                     RL_TXTHRESH(sc->rl_txthresh) |
1444                     RL_CUR_TXMBUF(sc)->m_pkthdr.len);
1445
1446                 RL_INC(sc->rl_cdata.cur_tx);
1447
1448                 /* Set a timeout in case the chip goes out to lunch. */
1449                 sc->rl_watchdog_timer = 5;
1450         }
1451
1452         /*
1453          * We broke out of the loop because all our TX slots are
1454          * full. Mark the NIC as busy until it drains some of the
1455          * packets from the queue.
1456          */
1457         if (RL_CUR_TXMBUF(sc) != NULL)
1458                 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1459 }
1460
1461 static void
1462 rl_init(void *xsc)
1463 {
1464         struct rl_softc         *sc = xsc;
1465
1466         RL_LOCK(sc);
1467         rl_init_locked(sc);
1468         RL_UNLOCK(sc);
1469 }
1470
1471 static void
1472 rl_init_locked(struct rl_softc *sc)
1473 {
1474         struct ifnet            *ifp = sc->rl_ifp;
1475         struct mii_data         *mii;
1476         uint32_t                rxcfg = 0;
1477         uint32_t                eaddr[2];
1478
1479         RL_LOCK_ASSERT(sc);
1480
1481         mii = device_get_softc(sc->rl_miibus);
1482
1483         /*
1484          * Cancel pending I/O and free all RX/TX buffers.
1485          */
1486         rl_stop(sc);
1487
1488         /*
1489          * Init our MAC address.  Even though the chipset
1490          * documentation doesn't mention it, we need to enter "Config
1491          * register write enable" mode to modify the ID registers.
1492          */
1493         CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_WRITECFG);
1494         bzero(eaddr, sizeof(eaddr));
1495         bcopy(IF_LLADDR(sc->rl_ifp), eaddr, ETHER_ADDR_LEN);
1496         CSR_WRITE_STREAM_4(sc, RL_IDR0, eaddr[0]);
1497         CSR_WRITE_STREAM_4(sc, RL_IDR4, eaddr[1]);
1498         CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_OFF);
1499
1500         /* Init the RX buffer pointer register. */
1501         bus_dmamap_load(sc->rl_tag, sc->rl_cdata.rl_rx_dmamap,
1502             sc->rl_cdata.rl_rx_buf, RL_RXBUFLEN, rl_dma_map_rxbuf, sc, 0);
1503         bus_dmamap_sync(sc->rl_tag, sc->rl_cdata.rl_rx_dmamap,
1504             BUS_DMASYNC_PREWRITE);
1505
1506         /* Init TX descriptors. */
1507         rl_list_tx_init(sc);
1508
1509         /*
1510          * Enable transmit and receive.
1511          */
1512         CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_TX_ENB|RL_CMD_RX_ENB);
1513
1514         /*
1515          * Set the initial TX and RX configuration.
1516          */
1517         CSR_WRITE_4(sc, RL_TXCFG, RL_TXCFG_CONFIG);
1518         CSR_WRITE_4(sc, RL_RXCFG, RL_RXCFG_CONFIG);
1519
1520         /* Set the individual bit to receive frames for this host only. */
1521         rxcfg = CSR_READ_4(sc, RL_RXCFG);
1522         rxcfg |= RL_RXCFG_RX_INDIV;
1523
1524         /* If we want promiscuous mode, set the allframes bit. */
1525         if (ifp->if_flags & IFF_PROMISC) {
1526                 rxcfg |= RL_RXCFG_RX_ALLPHYS;
1527                 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1528         } else {
1529                 rxcfg &= ~RL_RXCFG_RX_ALLPHYS;
1530                 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1531         }
1532
1533         /* Set capture broadcast bit to capture broadcast frames. */
1534         if (ifp->if_flags & IFF_BROADCAST) {
1535                 rxcfg |= RL_RXCFG_RX_BROAD;
1536                 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1537         } else {
1538                 rxcfg &= ~RL_RXCFG_RX_BROAD;
1539                 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1540         }
1541
1542         /* Program the multicast filter, if necessary. */
1543         rl_setmulti(sc);
1544
1545 #ifdef DEVICE_POLLING
1546         /* Disable interrupts if we are polling. */
1547         if (ifp->if_capenable & IFCAP_POLLING)
1548                 CSR_WRITE_2(sc, RL_IMR, 0);
1549         else
1550 #endif
1551         /* Enable interrupts. */
1552         CSR_WRITE_2(sc, RL_IMR, RL_INTRS);
1553
1554         /* Set initial TX threshold */
1555         sc->rl_txthresh = RL_TX_THRESH_INIT;
1556
1557         /* Start RX/TX process. */
1558         CSR_WRITE_4(sc, RL_MISSEDPKT, 0);
1559
1560         /* Enable receiver and transmitter. */
1561         CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_TX_ENB|RL_CMD_RX_ENB);
1562
1563         mii_mediachg(mii);
1564
1565         CSR_WRITE_1(sc, RL_CFG1, RL_CFG1_DRVLOAD|RL_CFG1_FULLDUPLEX);
1566
1567         ifp->if_drv_flags |= IFF_DRV_RUNNING;
1568         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1569
1570         callout_reset(&sc->rl_stat_callout, hz, rl_tick, sc);
1571 }
1572
1573 /*
1574  * Set media options.
1575  */
1576 static int
1577 rl_ifmedia_upd(struct ifnet *ifp)
1578 {
1579         struct rl_softc         *sc = ifp->if_softc;
1580         struct mii_data         *mii;
1581
1582         mii = device_get_softc(sc->rl_miibus);
1583
1584         RL_LOCK(sc);
1585         mii_mediachg(mii);
1586         RL_UNLOCK(sc);
1587
1588         return (0);
1589 }
1590
1591 /*
1592  * Report current media status.
1593  */
1594 static void
1595 rl_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
1596 {
1597         struct rl_softc         *sc = ifp->if_softc;
1598         struct mii_data         *mii;
1599
1600         mii = device_get_softc(sc->rl_miibus);
1601
1602         RL_LOCK(sc);
1603         mii_pollstat(mii);
1604         RL_UNLOCK(sc);
1605         ifmr->ifm_active = mii->mii_media_active;
1606         ifmr->ifm_status = mii->mii_media_status;
1607 }
1608
1609 static int
1610 rl_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
1611 {
1612         struct ifreq            *ifr = (struct ifreq *)data;
1613         struct mii_data         *mii;
1614         struct rl_softc         *sc = ifp->if_softc;
1615         int                     error = 0;
1616
1617         switch (command) {
1618         case SIOCSIFFLAGS:
1619                 RL_LOCK(sc);
1620                 if (ifp->if_flags & IFF_UP) {
1621                         rl_init_locked(sc);
1622                 } else {
1623                         if (ifp->if_drv_flags & IFF_DRV_RUNNING)
1624                                 rl_stop(sc);
1625                 }
1626                 RL_UNLOCK(sc);
1627                 error = 0;
1628                 break;
1629         case SIOCADDMULTI:
1630         case SIOCDELMULTI:
1631                 RL_LOCK(sc);
1632                 rl_setmulti(sc);
1633                 RL_UNLOCK(sc);
1634                 error = 0;
1635                 break;
1636         case SIOCGIFMEDIA:
1637         case SIOCSIFMEDIA:
1638                 mii = device_get_softc(sc->rl_miibus);
1639                 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
1640                 break;
1641         case SIOCSIFCAP:
1642 #ifdef DEVICE_POLLING
1643                 if (ifr->ifr_reqcap & IFCAP_POLLING &&
1644                     !(ifp->if_capenable & IFCAP_POLLING)) {
1645                         error = ether_poll_register(rl_poll, ifp);
1646                         if (error)
1647                                 return(error);
1648                         RL_LOCK(sc);
1649                         /* Disable interrupts */
1650                         CSR_WRITE_2(sc, RL_IMR, 0x0000);
1651                         ifp->if_capenable |= IFCAP_POLLING;
1652                         RL_UNLOCK(sc);
1653                         return (error);
1654
1655                 }
1656                 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
1657                     ifp->if_capenable & IFCAP_POLLING) {
1658                         error = ether_poll_deregister(ifp);
1659                         /* Enable interrupts. */
1660                         RL_LOCK(sc);
1661                         CSR_WRITE_2(sc, RL_IMR, RL_INTRS);
1662                         ifp->if_capenable &= ~IFCAP_POLLING;
1663                         RL_UNLOCK(sc);
1664                         return (error);
1665                 }
1666 #endif /* DEVICE_POLLING */
1667                 break;
1668         default:
1669                 error = ether_ioctl(ifp, command, data);
1670                 break;
1671         }
1672
1673         return (error);
1674 }
1675
1676 static void
1677 rl_watchdog(struct rl_softc *sc)
1678 {
1679
1680         RL_LOCK_ASSERT(sc);
1681
1682         if (sc->rl_watchdog_timer == 0 || --sc->rl_watchdog_timer >0)
1683                 return;
1684
1685         device_printf(sc->rl_dev, "watchdog timeout\n");
1686         sc->rl_ifp->if_oerrors++;
1687
1688         rl_txeof(sc);
1689         rl_rxeof(sc);
1690         rl_init_locked(sc);
1691 }
1692
1693 /*
1694  * Stop the adapter and free any mbufs allocated to the
1695  * RX and TX lists.
1696  */
1697 static void
1698 rl_stop(struct rl_softc *sc)
1699 {
1700         register int            i;
1701         struct ifnet            *ifp = sc->rl_ifp;
1702
1703         RL_LOCK_ASSERT(sc);
1704
1705         sc->rl_watchdog_timer = 0;
1706         callout_stop(&sc->rl_stat_callout);
1707         ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
1708
1709         CSR_WRITE_1(sc, RL_COMMAND, 0x00);
1710         CSR_WRITE_2(sc, RL_IMR, 0x0000);
1711         bus_dmamap_unload(sc->rl_tag, sc->rl_cdata.rl_rx_dmamap);
1712
1713         /*
1714          * Free the TX list buffers.
1715          */
1716         for (i = 0; i < RL_TX_LIST_CNT; i++) {
1717                 if (sc->rl_cdata.rl_tx_chain[i] != NULL) {
1718                         bus_dmamap_unload(sc->rl_tag,
1719                             sc->rl_cdata.rl_tx_dmamap[i]);
1720                         bus_dmamap_destroy(sc->rl_tag,
1721                             sc->rl_cdata.rl_tx_dmamap[i]);
1722                         m_freem(sc->rl_cdata.rl_tx_chain[i]);
1723                         sc->rl_cdata.rl_tx_chain[i] = NULL;
1724                         CSR_WRITE_4(sc, RL_TXADDR0 + (i * sizeof(uint32_t)),
1725                             0x0000000);
1726                 }
1727         }
1728 }
1729
1730 /*
1731  * Device suspend routine.  Stop the interface and save some PCI
1732  * settings in case the BIOS doesn't restore them properly on
1733  * resume.
1734  */
1735 static int
1736 rl_suspend(device_t dev)
1737 {
1738         struct rl_softc         *sc;
1739
1740         sc = device_get_softc(dev);
1741
1742         RL_LOCK(sc);
1743         rl_stop(sc);
1744         sc->suspended = 1;
1745         RL_UNLOCK(sc);
1746
1747         return (0);
1748 }
1749
1750 /*
1751  * Device resume routine.  Restore some PCI settings in case the BIOS
1752  * doesn't, re-enable busmastering, and restart the interface if
1753  * appropriate.
1754  */
1755 static int
1756 rl_resume(device_t dev)
1757 {
1758         struct rl_softc         *sc;
1759         struct ifnet            *ifp;
1760
1761         sc = device_get_softc(dev);
1762         ifp = sc->rl_ifp;
1763
1764         RL_LOCK(sc);
1765
1766         /* reinitialize interface if necessary */
1767         if (ifp->if_flags & IFF_UP)
1768                 rl_init_locked(sc);
1769
1770         sc->suspended = 0;
1771
1772         RL_UNLOCK(sc);
1773
1774         return (0);
1775 }
1776
1777 /*
1778  * Stop all chip I/O so that the kernel's probe routines don't
1779  * get confused by errant DMAs when rebooting.
1780  */
1781 static int
1782 rl_shutdown(device_t dev)
1783 {
1784         struct rl_softc         *sc;
1785
1786         sc = device_get_softc(dev);
1787
1788         RL_LOCK(sc);
1789         rl_stop(sc);
1790         RL_UNLOCK(sc);
1791
1792         return (0);
1793 }