2 * Copyright (c) 1997, 1998
3 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * Winbond fast ethernet PCI NIC driver
39 * Supports various cheap network adapters based on the Winbond W89C840F
40 * fast ethernet controller chip. This includes adapters manufactured by
41 * Winbond itself and some made by Linksys.
43 * Written by Bill Paul <wpaul@ctr.columbia.edu>
44 * Electrical Engineering Department
45 * Columbia University, New York City
48 * The Winbond W89C840F chip is a bus master; in some ways it resembles
49 * a DEC 'tulip' chip, only not as complicated. Unfortunately, it has
50 * one major difference which is that while the registers do many of
51 * the same things as a tulip adapter, the offsets are different: where
52 * tulip registers are typically spaced 8 bytes apart, the Winbond
53 * registers are spaced 4 bytes apart. The receiver filter is also
54 * programmed differently.
56 * Like the tulip, the Winbond chip uses small descriptors containing
57 * a status word, a control word and 32-bit areas that can either be used
58 * to point to two external data blocks, or to point to a single block
59 * and another descriptor in a linked list. Descriptors can be grouped
60 * together in blocks to form fixed length rings or can be chained
61 * together in linked lists. A single packet may be spread out over
62 * several descriptors if necessary.
64 * For the receive ring, this driver uses a linked list of descriptors,
65 * each pointing to a single mbuf cluster buffer, which us large enough
66 * to hold an entire packet. The link list is looped back to created a
69 * For transmission, the driver creates a linked list of 'super descriptors'
70 * which each contain several individual descriptors linked toghether.
71 * Each 'super descriptor' contains WB_MAXFRAGS descriptors, which we
72 * abuse as fragment pointers. This allows us to use a buffer managment
73 * scheme very similar to that used in the ThunderLAN and Etherlink XL
76 * Autonegotiation is performed using the external PHY via the MII bus.
77 * The sample boards I have all use a Davicom PHY.
79 * Note: the author of the Linux driver for the Winbond chip alludes
80 * to some sort of flaw in the chip's design that seems to mandate some
81 * drastic workaround which signigicantly impairs transmit performance.
82 * I have no idea what he's on about: transmit performance with all
83 * three of my test boards seems fine.
88 #include <sys/param.h>
89 #include <sys/systm.h>
90 #include <sys/sockio.h>
92 #include <sys/malloc.h>
93 #include <sys/module.h>
94 #include <sys/kernel.h>
95 #include <sys/socket.h>
96 #include <sys/queue.h>
99 #include <net/if_arp.h>
100 #include <net/ethernet.h>
101 #include <net/if_dl.h>
102 #include <net/if_media.h>
103 #include <net/if_types.h>
107 #include <vm/vm.h> /* for vtophys */
108 #include <vm/pmap.h> /* for vtophys */
109 #include <machine/bus.h>
110 #include <machine/resource.h>
112 #include <sys/rman.h>
114 #include <dev/pci/pcireg.h>
115 #include <dev/pci/pcivar.h>
117 #include <dev/mii/mii.h>
118 #include <dev/mii/miivar.h>
120 /* "controller miibus0" required. See GENERIC if you get errors here. */
121 #include "miibus_if.h"
123 #define WB_USEIOSPACE
125 #include <pci/if_wbreg.h>
127 MODULE_DEPEND(wb, pci, 1, 1, 1);
128 MODULE_DEPEND(wb, ether, 1, 1, 1);
129 MODULE_DEPEND(wb, miibus, 1, 1, 1);
132 * Various supported device vendors/types and their names.
134 static struct wb_type wb_devs[] = {
135 { WB_VENDORID, WB_DEVICEID_840F,
136 "Winbond W89C840F 10/100BaseTX" },
137 { CP_VENDORID, CP_DEVICEID_RL100,
138 "Compex RL100-ATX 10/100baseTX" },
142 static int wb_probe(device_t);
143 static int wb_attach(device_t);
144 static int wb_detach(device_t);
146 static void wb_bfree(void *addr, void *args);
147 static int wb_newbuf(struct wb_softc *, struct wb_chain_onefrag *,
149 static int wb_encap(struct wb_softc *, struct wb_chain *, struct mbuf *);
151 static void wb_rxeof(struct wb_softc *);
152 static void wb_rxeoc(struct wb_softc *);
153 static void wb_txeof(struct wb_softc *);
154 static void wb_txeoc(struct wb_softc *);
155 static void wb_intr(void *);
156 static void wb_tick(void *);
157 static void wb_start(struct ifnet *);
158 static void wb_start_locked(struct ifnet *);
159 static int wb_ioctl(struct ifnet *, u_long, caddr_t);
160 static void wb_init(void *);
161 static void wb_init_locked(struct wb_softc *);
162 static void wb_stop(struct wb_softc *);
163 static void wb_watchdog(struct ifnet *);
164 static void wb_shutdown(device_t);
165 static int wb_ifmedia_upd(struct ifnet *);
166 static void wb_ifmedia_sts(struct ifnet *, struct ifmediareq *);
168 static void wb_eeprom_putbyte(struct wb_softc *, int);
169 static void wb_eeprom_getword(struct wb_softc *, int, u_int16_t *);
170 static void wb_read_eeprom(struct wb_softc *, caddr_t, int, int, int);
171 static void wb_mii_sync(struct wb_softc *);
172 static void wb_mii_send(struct wb_softc *, u_int32_t, int);
173 static int wb_mii_readreg(struct wb_softc *, struct wb_mii_frame *);
174 static int wb_mii_writereg(struct wb_softc *, struct wb_mii_frame *);
176 static void wb_setcfg(struct wb_softc *, u_int32_t);
177 static void wb_setmulti(struct wb_softc *);
178 static void wb_reset(struct wb_softc *);
179 static void wb_fixmedia(struct wb_softc *);
180 static int wb_list_rx_init(struct wb_softc *);
181 static int wb_list_tx_init(struct wb_softc *);
183 static int wb_miibus_readreg(device_t, int, int);
184 static int wb_miibus_writereg(device_t, int, int, int);
185 static void wb_miibus_statchg(device_t);
188 #define WB_RES SYS_RES_IOPORT
189 #define WB_RID WB_PCI_LOIO
191 #define WB_RES SYS_RES_MEMORY
192 #define WB_RID WB_PCI_LOMEM
195 static device_method_t wb_methods[] = {
196 /* Device interface */
197 DEVMETHOD(device_probe, wb_probe),
198 DEVMETHOD(device_attach, wb_attach),
199 DEVMETHOD(device_detach, wb_detach),
200 DEVMETHOD(device_shutdown, wb_shutdown),
202 /* bus interface, for miibus */
203 DEVMETHOD(bus_print_child, bus_generic_print_child),
204 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
207 DEVMETHOD(miibus_readreg, wb_miibus_readreg),
208 DEVMETHOD(miibus_writereg, wb_miibus_writereg),
209 DEVMETHOD(miibus_statchg, wb_miibus_statchg),
213 static driver_t wb_driver = {
216 sizeof(struct wb_softc)
219 static devclass_t wb_devclass;
221 DRIVER_MODULE(wb, pci, wb_driver, wb_devclass, 0, 0);
222 DRIVER_MODULE(miibus, wb, miibus_driver, miibus_devclass, 0, 0);
224 #define WB_SETBIT(sc, reg, x) \
225 CSR_WRITE_4(sc, reg, \
226 CSR_READ_4(sc, reg) | (x))
228 #define WB_CLRBIT(sc, reg, x) \
229 CSR_WRITE_4(sc, reg, \
230 CSR_READ_4(sc, reg) & ~(x))
233 CSR_WRITE_4(sc, WB_SIO, \
234 CSR_READ_4(sc, WB_SIO) | (x))
237 CSR_WRITE_4(sc, WB_SIO, \
238 CSR_READ_4(sc, WB_SIO) & ~(x))
241 * Send a read command and address to the EEPROM, check for ACK.
244 wb_eeprom_putbyte(sc, addr)
250 d = addr | WB_EECMD_READ;
253 * Feed in each bit and stobe the clock.
255 for (i = 0x400; i; i >>= 1) {
257 SIO_SET(WB_SIO_EE_DATAIN);
259 SIO_CLR(WB_SIO_EE_DATAIN);
262 SIO_SET(WB_SIO_EE_CLK);
264 SIO_CLR(WB_SIO_EE_CLK);
272 * Read a word of data stored in the EEPROM at address 'addr.'
275 wb_eeprom_getword(sc, addr, dest)
283 /* Enter EEPROM access mode. */
284 CSR_WRITE_4(sc, WB_SIO, WB_SIO_EESEL|WB_SIO_EE_CS);
287 * Send address of word we want to read.
289 wb_eeprom_putbyte(sc, addr);
291 CSR_WRITE_4(sc, WB_SIO, WB_SIO_EESEL|WB_SIO_EE_CS);
294 * Start reading bits from EEPROM.
296 for (i = 0x8000; i; i >>= 1) {
297 SIO_SET(WB_SIO_EE_CLK);
299 if (CSR_READ_4(sc, WB_SIO) & WB_SIO_EE_DATAOUT)
301 SIO_CLR(WB_SIO_EE_CLK);
305 /* Turn off EEPROM access mode. */
306 CSR_WRITE_4(sc, WB_SIO, 0);
314 * Read a sequence of words from the EEPROM.
317 wb_read_eeprom(sc, dest, off, cnt, swap)
325 u_int16_t word = 0, *ptr;
327 for (i = 0; i < cnt; i++) {
328 wb_eeprom_getword(sc, off + i, &word);
329 ptr = (u_int16_t *)(dest + (i * 2));
340 * Sync the PHYs by setting data bit and strobing the clock 32 times.
348 SIO_SET(WB_SIO_MII_DIR|WB_SIO_MII_DATAIN);
350 for (i = 0; i < 32; i++) {
351 SIO_SET(WB_SIO_MII_CLK);
353 SIO_CLR(WB_SIO_MII_CLK);
361 * Clock a series of bits through the MII.
364 wb_mii_send(sc, bits, cnt)
371 SIO_CLR(WB_SIO_MII_CLK);
373 for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
375 SIO_SET(WB_SIO_MII_DATAIN);
377 SIO_CLR(WB_SIO_MII_DATAIN);
380 SIO_CLR(WB_SIO_MII_CLK);
382 SIO_SET(WB_SIO_MII_CLK);
387 * Read an PHY register through the MII.
390 wb_mii_readreg(sc, frame)
392 struct wb_mii_frame *frame;
398 * Set up frame for RX.
400 frame->mii_stdelim = WB_MII_STARTDELIM;
401 frame->mii_opcode = WB_MII_READOP;
402 frame->mii_turnaround = 0;
405 CSR_WRITE_4(sc, WB_SIO, 0);
410 SIO_SET(WB_SIO_MII_DIR);
415 * Send command/address info.
417 wb_mii_send(sc, frame->mii_stdelim, 2);
418 wb_mii_send(sc, frame->mii_opcode, 2);
419 wb_mii_send(sc, frame->mii_phyaddr, 5);
420 wb_mii_send(sc, frame->mii_regaddr, 5);
423 SIO_CLR((WB_SIO_MII_CLK|WB_SIO_MII_DATAIN));
425 SIO_SET(WB_SIO_MII_CLK);
429 SIO_CLR(WB_SIO_MII_DIR);
431 SIO_CLR(WB_SIO_MII_CLK);
433 ack = CSR_READ_4(sc, WB_SIO) & WB_SIO_MII_DATAOUT;
434 SIO_SET(WB_SIO_MII_CLK);
436 SIO_CLR(WB_SIO_MII_CLK);
438 SIO_SET(WB_SIO_MII_CLK);
442 * Now try reading data bits. If the ack failed, we still
443 * need to clock through 16 cycles to keep the PHY(s) in sync.
446 for(i = 0; i < 16; i++) {
447 SIO_CLR(WB_SIO_MII_CLK);
449 SIO_SET(WB_SIO_MII_CLK);
455 for (i = 0x8000; i; i >>= 1) {
456 SIO_CLR(WB_SIO_MII_CLK);
459 if (CSR_READ_4(sc, WB_SIO) & WB_SIO_MII_DATAOUT)
460 frame->mii_data |= i;
463 SIO_SET(WB_SIO_MII_CLK);
469 SIO_CLR(WB_SIO_MII_CLK);
471 SIO_SET(WB_SIO_MII_CLK);
480 * Write to a PHY register through the MII.
483 wb_mii_writereg(sc, frame)
485 struct wb_mii_frame *frame;
490 * Set up frame for TX.
493 frame->mii_stdelim = WB_MII_STARTDELIM;
494 frame->mii_opcode = WB_MII_WRITEOP;
495 frame->mii_turnaround = WB_MII_TURNAROUND;
498 * Turn on data output.
500 SIO_SET(WB_SIO_MII_DIR);
504 wb_mii_send(sc, frame->mii_stdelim, 2);
505 wb_mii_send(sc, frame->mii_opcode, 2);
506 wb_mii_send(sc, frame->mii_phyaddr, 5);
507 wb_mii_send(sc, frame->mii_regaddr, 5);
508 wb_mii_send(sc, frame->mii_turnaround, 2);
509 wb_mii_send(sc, frame->mii_data, 16);
512 SIO_SET(WB_SIO_MII_CLK);
514 SIO_CLR(WB_SIO_MII_CLK);
520 SIO_CLR(WB_SIO_MII_DIR);
526 wb_miibus_readreg(dev, phy, reg)
531 struct wb_mii_frame frame;
533 sc = device_get_softc(dev);
535 bzero((char *)&frame, sizeof(frame));
537 frame.mii_phyaddr = phy;
538 frame.mii_regaddr = reg;
539 wb_mii_readreg(sc, &frame);
541 return(frame.mii_data);
545 wb_miibus_writereg(dev, phy, reg, data)
550 struct wb_mii_frame frame;
552 sc = device_get_softc(dev);
554 bzero((char *)&frame, sizeof(frame));
556 frame.mii_phyaddr = phy;
557 frame.mii_regaddr = reg;
558 frame.mii_data = data;
560 wb_mii_writereg(sc, &frame);
566 wb_miibus_statchg(dev)
570 struct mii_data *mii;
572 sc = device_get_softc(dev);
573 mii = device_get_softc(sc->wb_miibus);
574 wb_setcfg(sc, mii->mii_media_active);
580 * Program the 64-bit multicast hash filter.
588 u_int32_t hashes[2] = { 0, 0 };
589 struct ifmultiaddr *ifma;
595 rxfilt = CSR_READ_4(sc, WB_NETCFG);
597 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
598 rxfilt |= WB_NETCFG_RX_MULTI;
599 CSR_WRITE_4(sc, WB_NETCFG, rxfilt);
600 CSR_WRITE_4(sc, WB_MAR0, 0xFFFFFFFF);
601 CSR_WRITE_4(sc, WB_MAR1, 0xFFFFFFFF);
605 /* first, zot all the existing hash bits */
606 CSR_WRITE_4(sc, WB_MAR0, 0);
607 CSR_WRITE_4(sc, WB_MAR1, 0);
609 /* now program new ones */
611 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
612 if (ifma->ifma_addr->sa_family != AF_LINK)
614 h = ~ether_crc32_be(LLADDR((struct sockaddr_dl *)
615 ifma->ifma_addr), ETHER_ADDR_LEN) >> 26;
617 hashes[0] |= (1 << h);
619 hashes[1] |= (1 << (h - 32));
625 rxfilt |= WB_NETCFG_RX_MULTI;
627 rxfilt &= ~WB_NETCFG_RX_MULTI;
629 CSR_WRITE_4(sc, WB_MAR0, hashes[0]);
630 CSR_WRITE_4(sc, WB_MAR1, hashes[1]);
631 CSR_WRITE_4(sc, WB_NETCFG, rxfilt);
637 * The Winbond manual states that in order to fiddle with the
638 * 'full-duplex' and '100Mbps' bits in the netconfig register, we
639 * first have to put the transmit and/or receive logic in the idle state.
648 if (CSR_READ_4(sc, WB_NETCFG) & (WB_NETCFG_TX_ON|WB_NETCFG_RX_ON)) {
650 WB_CLRBIT(sc, WB_NETCFG, (WB_NETCFG_TX_ON|WB_NETCFG_RX_ON));
652 for (i = 0; i < WB_TIMEOUT; i++) {
654 if ((CSR_READ_4(sc, WB_ISR) & WB_ISR_TX_IDLE) &&
655 (CSR_READ_4(sc, WB_ISR) & WB_ISR_RX_IDLE))
660 if_printf(sc->wb_ifp,
661 "failed to force tx and rx to idle state\n");
664 if (IFM_SUBTYPE(media) == IFM_10_T)
665 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_100MBPS);
667 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_100MBPS);
669 if ((media & IFM_GMASK) == IFM_FDX)
670 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_FULLDUPLEX);
672 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_FULLDUPLEX);
675 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON|WB_NETCFG_RX_ON);
685 struct mii_data *mii;
687 CSR_WRITE_4(sc, WB_NETCFG, 0);
688 CSR_WRITE_4(sc, WB_BUSCTL, 0);
689 CSR_WRITE_4(sc, WB_TXADDR, 0);
690 CSR_WRITE_4(sc, WB_RXADDR, 0);
692 WB_SETBIT(sc, WB_BUSCTL, WB_BUSCTL_RESET);
693 WB_SETBIT(sc, WB_BUSCTL, WB_BUSCTL_RESET);
695 for (i = 0; i < WB_TIMEOUT; i++) {
697 if (!(CSR_READ_4(sc, WB_BUSCTL) & WB_BUSCTL_RESET))
701 if_printf(sc->wb_ifp, "reset never completed!\n");
703 /* Wait a little while for the chip to get its brains in order. */
706 if (sc->wb_miibus == NULL)
709 mii = device_get_softc(sc->wb_miibus);
713 if (mii->mii_instance) {
714 struct mii_softc *miisc;
715 LIST_FOREACH(miisc, &mii->mii_phys, mii_list)
716 mii_phy_reset(miisc);
726 struct mii_data *mii = NULL;
730 if (sc->wb_miibus == NULL)
733 mii = device_get_softc(sc->wb_miibus);
737 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_10_T) {
738 media = mii->mii_media_active & ~IFM_10_T;
740 } else if (IFM_SUBTYPE(mii->mii_media_active) == IFM_100_TX) {
741 media = mii->mii_media_active & ~IFM_100_TX;
746 ifmedia_set(&mii->mii_media, media);
752 * Probe for a Winbond chip. Check the PCI vendor and device
753 * IDs against our list and return a device name if we find a match.
763 while(t->wb_name != NULL) {
764 if ((pci_get_vendor(dev) == t->wb_vid) &&
765 (pci_get_device(dev) == t->wb_did)) {
766 device_set_desc(dev, t->wb_name);
767 return (BUS_PROBE_DEFAULT);
776 * Attach the interface. Allocate softc structures, do ifmedia
777 * setup and ethernet/BPF attach.
783 u_char eaddr[ETHER_ADDR_LEN];
788 sc = device_get_softc(dev);
790 mtx_init(&sc->wb_mtx, device_get_nameunit(dev), MTX_NETWORK_LOCK,
792 callout_init_mtx(&sc->wb_stat_callout, &sc->wb_mtx, 0);
795 * Map control/status registers.
797 pci_enable_busmaster(dev);
800 sc->wb_res = bus_alloc_resource_any(dev, WB_RES, &rid, RF_ACTIVE);
802 if (sc->wb_res == NULL) {
803 device_printf(dev, "couldn't map ports/memory\n");
808 sc->wb_btag = rman_get_bustag(sc->wb_res);
809 sc->wb_bhandle = rman_get_bushandle(sc->wb_res);
811 /* Allocate interrupt */
813 sc->wb_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
814 RF_SHAREABLE | RF_ACTIVE);
816 if (sc->wb_irq == NULL) {
817 device_printf(dev, "couldn't map interrupt\n");
822 /* Save the cache line size. */
823 sc->wb_cachesize = pci_read_config(dev, WB_PCI_CACHELEN, 4) & 0xFF;
825 /* Reset the adapter. */
829 * Get station address from the EEPROM.
831 wb_read_eeprom(sc, (caddr_t)&eaddr, 0, 3, 0);
833 sc->wb_ldata = contigmalloc(sizeof(struct wb_list_data) + 8, M_DEVBUF,
834 M_NOWAIT, 0, 0xffffffff, PAGE_SIZE, 0);
836 if (sc->wb_ldata == NULL) {
837 device_printf(dev, "no memory for list buffers!\n");
842 bzero(sc->wb_ldata, sizeof(struct wb_list_data));
844 ifp = sc->wb_ifp = if_alloc(IFT_ETHER);
846 device_printf(dev, "can not if_alloc()\n");
851 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
852 ifp->if_mtu = ETHERMTU;
853 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
854 ifp->if_ioctl = wb_ioctl;
855 ifp->if_start = wb_start;
856 ifp->if_watchdog = wb_watchdog;
857 ifp->if_init = wb_init;
858 ifp->if_snd.ifq_maxlen = WB_TX_LIST_CNT - 1;
863 if (mii_phy_probe(dev, &sc->wb_miibus,
864 wb_ifmedia_upd, wb_ifmedia_sts)) {
870 * Call MI attach routine.
872 ether_ifattach(ifp, eaddr);
874 /* Hook interrupt last to avoid having to lock softc */
875 error = bus_setup_intr(dev, sc->wb_irq, INTR_TYPE_NET | INTR_MPSAFE,
876 wb_intr, sc, &sc->wb_intrhand);
879 device_printf(dev, "couldn't set up irq\n");
892 * Shutdown hardware and free up resources. This can be called any
893 * time after the mutex has been initialized. It is called in both
894 * the error case in attach and the normal detach case so it needs
895 * to be careful about only freeing resources that have actually been
905 sc = device_get_softc(dev);
906 KASSERT(mtx_initialized(&sc->wb_mtx), ("wb mutex not initialized"));
910 * Delete any miibus and phy devices attached to this interface.
911 * This should only be done if attach succeeded.
913 if (device_is_attached(dev)) {
917 callout_drain(&sc->wb_stat_callout);
923 device_delete_child(dev, sc->wb_miibus);
924 bus_generic_detach(dev);
927 bus_teardown_intr(dev, sc->wb_irq, sc->wb_intrhand);
929 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->wb_irq);
931 bus_release_resource(dev, WB_RES, WB_RID, sc->wb_res);
934 contigfree(sc->wb_ldata, sizeof(struct wb_list_data) + 8,
938 mtx_destroy(&sc->wb_mtx);
944 * Initialize the transmit descriptors.
950 struct wb_chain_data *cd;
951 struct wb_list_data *ld;
957 for (i = 0; i < WB_TX_LIST_CNT; i++) {
958 cd->wb_tx_chain[i].wb_ptr = &ld->wb_tx_list[i];
959 if (i == (WB_TX_LIST_CNT - 1)) {
960 cd->wb_tx_chain[i].wb_nextdesc =
963 cd->wb_tx_chain[i].wb_nextdesc =
964 &cd->wb_tx_chain[i + 1];
968 cd->wb_tx_free = &cd->wb_tx_chain[0];
969 cd->wb_tx_tail = cd->wb_tx_head = NULL;
976 * Initialize the RX descriptors and allocate mbufs for them. Note that
977 * we arrange the descriptors in a closed ring, so that the last descriptor
978 * points back to the first.
984 struct wb_chain_data *cd;
985 struct wb_list_data *ld;
991 for (i = 0; i < WB_RX_LIST_CNT; i++) {
992 cd->wb_rx_chain[i].wb_ptr =
993 (struct wb_desc *)&ld->wb_rx_list[i];
994 cd->wb_rx_chain[i].wb_buf = (void *)&ld->wb_rxbufs[i];
995 if (wb_newbuf(sc, &cd->wb_rx_chain[i], NULL) == ENOBUFS)
997 if (i == (WB_RX_LIST_CNT - 1)) {
998 cd->wb_rx_chain[i].wb_nextdesc = &cd->wb_rx_chain[0];
999 ld->wb_rx_list[i].wb_next =
1000 vtophys(&ld->wb_rx_list[0]);
1002 cd->wb_rx_chain[i].wb_nextdesc =
1003 &cd->wb_rx_chain[i + 1];
1004 ld->wb_rx_list[i].wb_next =
1005 vtophys(&ld->wb_rx_list[i + 1]);
1009 cd->wb_rx_head = &cd->wb_rx_chain[0];
1023 * Initialize an RX descriptor and attach an MBUF cluster.
1027 struct wb_softc *sc;
1028 struct wb_chain_onefrag *c;
1031 struct mbuf *m_new = NULL;
1034 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1037 m_new->m_data = c->wb_buf;
1038 m_new->m_pkthdr.len = m_new->m_len = WB_BUFBYTES;
1039 MEXTADD(m_new, c->wb_buf, WB_BUFBYTES, wb_bfree, NULL, 0,
1043 m_new->m_len = m_new->m_pkthdr.len = WB_BUFBYTES;
1044 m_new->m_data = m_new->m_ext.ext_buf;
1047 m_adj(m_new, sizeof(u_int64_t));
1050 c->wb_ptr->wb_data = vtophys(mtod(m_new, caddr_t));
1051 c->wb_ptr->wb_ctl = WB_RXCTL_RLINK | 1536;
1052 c->wb_ptr->wb_status = WB_RXSTAT;
1058 * A frame has been uploaded: pass the resulting mbuf chain up to
1059 * the higher level protocols.
1063 struct wb_softc *sc;
1065 struct mbuf *m = NULL;
1067 struct wb_chain_onefrag *cur_rx;
1075 while(!((rxstat = sc->wb_cdata.wb_rx_head->wb_ptr->wb_status) &
1077 struct mbuf *m0 = NULL;
1079 cur_rx = sc->wb_cdata.wb_rx_head;
1080 sc->wb_cdata.wb_rx_head = cur_rx->wb_nextdesc;
1082 m = cur_rx->wb_mbuf;
1084 if ((rxstat & WB_RXSTAT_MIIERR) ||
1085 (WB_RXBYTES(cur_rx->wb_ptr->wb_status) < WB_MIN_FRAMELEN) ||
1086 (WB_RXBYTES(cur_rx->wb_ptr->wb_status) > 1536) ||
1087 !(rxstat & WB_RXSTAT_LASTFRAG) ||
1088 !(rxstat & WB_RXSTAT_RXCMP)) {
1090 wb_newbuf(sc, cur_rx, m);
1091 if_printf(ifp, "receiver babbling: possible chip "
1092 "bug, forcing reset\n");
1099 if (rxstat & WB_RXSTAT_RXERR) {
1101 wb_newbuf(sc, cur_rx, m);
1105 /* No errors; receive the packet. */
1106 total_len = WB_RXBYTES(cur_rx->wb_ptr->wb_status);
1109 * XXX The Winbond chip includes the CRC with every
1110 * received frame, and there's no way to turn this
1111 * behavior off (at least, I can't find anything in
1112 * the manual that explains how to do it) so we have
1113 * to trim off the CRC manually.
1115 total_len -= ETHER_CRC_LEN;
1117 m0 = m_devget(mtod(m, char *), total_len, ETHER_ALIGN, ifp,
1119 wb_newbuf(sc, cur_rx, m);
1128 (*ifp->if_input)(ifp, m);
1135 struct wb_softc *sc;
1139 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_RX_ON);
1140 CSR_WRITE_4(sc, WB_RXADDR, vtophys(&sc->wb_ldata->wb_rx_list[0]));
1141 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_RX_ON);
1142 if (CSR_READ_4(sc, WB_ISR) & WB_RXSTATE_SUSPEND)
1143 CSR_WRITE_4(sc, WB_RXSTART, 0xFFFFFFFF);
1149 * A frame was downloaded to the chip. It's safe for us to clean up
1154 struct wb_softc *sc;
1156 struct wb_chain *cur_tx;
1161 /* Clear the timeout timer. */
1164 if (sc->wb_cdata.wb_tx_head == NULL)
1168 * Go through our tx list and free mbufs for those
1169 * frames that have been transmitted.
1171 while(sc->wb_cdata.wb_tx_head->wb_mbuf != NULL) {
1174 cur_tx = sc->wb_cdata.wb_tx_head;
1175 txstat = WB_TXSTATUS(cur_tx);
1177 if ((txstat & WB_TXSTAT_OWN) || txstat == WB_UNSENT)
1180 if (txstat & WB_TXSTAT_TXERR) {
1182 if (txstat & WB_TXSTAT_ABORT)
1183 ifp->if_collisions++;
1184 if (txstat & WB_TXSTAT_LATECOLL)
1185 ifp->if_collisions++;
1188 ifp->if_collisions += (txstat & WB_TXSTAT_COLLCNT) >> 3;
1191 m_freem(cur_tx->wb_mbuf);
1192 cur_tx->wb_mbuf = NULL;
1194 if (sc->wb_cdata.wb_tx_head == sc->wb_cdata.wb_tx_tail) {
1195 sc->wb_cdata.wb_tx_head = NULL;
1196 sc->wb_cdata.wb_tx_tail = NULL;
1200 sc->wb_cdata.wb_tx_head = cur_tx->wb_nextdesc;
1207 * TX 'end of channel' interrupt handler.
1211 struct wb_softc *sc;
1219 if (sc->wb_cdata.wb_tx_head == NULL) {
1220 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1221 sc->wb_cdata.wb_tx_tail = NULL;
1223 if (WB_TXOWN(sc->wb_cdata.wb_tx_head) == WB_UNSENT) {
1224 WB_TXOWN(sc->wb_cdata.wb_tx_head) = WB_TXSTAT_OWN;
1226 CSR_WRITE_4(sc, WB_TXSTART, 0xFFFFFFFF);
1237 struct wb_softc *sc;
1245 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1250 /* Disable interrupts. */
1251 CSR_WRITE_4(sc, WB_IMR, 0x00000000);
1255 status = CSR_READ_4(sc, WB_ISR);
1257 CSR_WRITE_4(sc, WB_ISR, status);
1259 if ((status & WB_INTRS) == 0)
1262 if ((status & WB_ISR_RX_NOBUF) || (status & WB_ISR_RX_ERR)) {
1265 if (status & WB_ISR_RX_ERR)
1271 if (status & WB_ISR_RX_OK)
1274 if (status & WB_ISR_RX_IDLE)
1277 if (status & WB_ISR_TX_OK)
1280 if (status & WB_ISR_TX_NOBUF)
1283 if (status & WB_ISR_TX_IDLE) {
1285 if (sc->wb_cdata.wb_tx_head != NULL) {
1286 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON);
1287 CSR_WRITE_4(sc, WB_TXSTART, 0xFFFFFFFF);
1291 if (status & WB_ISR_TX_UNDERRUN) {
1294 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON);
1295 /* Jack up TX threshold */
1296 sc->wb_txthresh += WB_TXTHRESH_CHUNK;
1297 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_TX_THRESH);
1298 WB_SETBIT(sc, WB_NETCFG, WB_TXTHRESH(sc->wb_txthresh));
1299 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON);
1302 if (status & WB_ISR_BUS_ERR) {
1309 /* Re-enable interrupts. */
1310 CSR_WRITE_4(sc, WB_IMR, WB_INTRS);
1312 if (ifp->if_snd.ifq_head != NULL) {
1313 wb_start_locked(ifp);
1325 struct wb_softc *sc;
1326 struct mii_data *mii;
1330 mii = device_get_softc(sc->wb_miibus);
1334 callout_reset(&sc->wb_stat_callout, hz, wb_tick, sc);
1340 * Encapsulate an mbuf chain in a descriptor by coupling the mbuf data
1341 * pointers to the fragment pointers.
1344 wb_encap(sc, c, m_head)
1345 struct wb_softc *sc;
1347 struct mbuf *m_head;
1350 struct wb_desc *f = NULL;
1355 * Start packing the mbufs in this chain into
1356 * the fragment pointers. Stop when we run out
1357 * of fragments or hit the end of the mbuf chain.
1362 for (m = m_head, frag = 0; m != NULL; m = m->m_next) {
1363 if (m->m_len != 0) {
1364 if (frag == WB_MAXFRAGS)
1366 total_len += m->m_len;
1367 f = &c->wb_ptr->wb_frag[frag];
1368 f->wb_ctl = WB_TXCTL_TLINK | m->m_len;
1370 f->wb_ctl |= WB_TXCTL_FIRSTFRAG;
1373 f->wb_status = WB_TXSTAT_OWN;
1374 f->wb_next = vtophys(&c->wb_ptr->wb_frag[frag + 1]);
1375 f->wb_data = vtophys(mtod(m, vm_offset_t));
1381 * Handle special case: we used up all 16 fragments,
1382 * but we have more mbufs left in the chain. Copy the
1383 * data into an mbuf cluster. Note that we don't
1384 * bother clearing the values in the other fragment
1385 * pointers/counters; it wouldn't gain us anything,
1386 * and would waste cycles.
1389 struct mbuf *m_new = NULL;
1391 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1394 if (m_head->m_pkthdr.len > MHLEN) {
1395 MCLGET(m_new, M_DONTWAIT);
1396 if (!(m_new->m_flags & M_EXT)) {
1401 m_copydata(m_head, 0, m_head->m_pkthdr.len,
1402 mtod(m_new, caddr_t));
1403 m_new->m_pkthdr.len = m_new->m_len = m_head->m_pkthdr.len;
1406 f = &c->wb_ptr->wb_frag[0];
1408 f->wb_data = vtophys(mtod(m_new, caddr_t));
1409 f->wb_ctl = total_len = m_new->m_len;
1410 f->wb_ctl |= WB_TXCTL_TLINK|WB_TXCTL_FIRSTFRAG;
1414 if (total_len < WB_MIN_FRAMELEN) {
1415 f = &c->wb_ptr->wb_frag[frag];
1416 f->wb_ctl = WB_MIN_FRAMELEN - total_len;
1417 f->wb_data = vtophys(&sc->wb_cdata.wb_pad);
1418 f->wb_ctl |= WB_TXCTL_TLINK;
1419 f->wb_status = WB_TXSTAT_OWN;
1423 c->wb_mbuf = m_head;
1424 c->wb_lastdesc = frag - 1;
1425 WB_TXCTL(c) |= WB_TXCTL_LASTFRAG;
1426 WB_TXNEXT(c) = vtophys(&c->wb_nextdesc->wb_ptr->wb_frag[0]);
1432 * Main transmit routine. To avoid having to do mbuf copies, we put pointers
1433 * to the mbuf data regions directly in the transmit lists. We also save a
1434 * copy of the pointers since the transmit list fragment pointers are
1435 * physical addresses.
1442 struct wb_softc *sc;
1446 wb_start_locked(ifp);
1451 wb_start_locked(ifp)
1454 struct wb_softc *sc;
1455 struct mbuf *m_head = NULL;
1456 struct wb_chain *cur_tx = NULL, *start_tx;
1462 * Check for an available queue slot. If there are none,
1465 if (sc->wb_cdata.wb_tx_free->wb_mbuf != NULL) {
1466 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1470 start_tx = sc->wb_cdata.wb_tx_free;
1472 while(sc->wb_cdata.wb_tx_free->wb_mbuf == NULL) {
1473 IF_DEQUEUE(&ifp->if_snd, m_head);
1477 /* Pick a descriptor off the free list. */
1478 cur_tx = sc->wb_cdata.wb_tx_free;
1479 sc->wb_cdata.wb_tx_free = cur_tx->wb_nextdesc;
1481 /* Pack the data into the descriptor. */
1482 wb_encap(sc, cur_tx, m_head);
1484 if (cur_tx != start_tx)
1485 WB_TXOWN(cur_tx) = WB_TXSTAT_OWN;
1488 * If there's a BPF listener, bounce a copy of this frame
1491 BPF_MTAP(ifp, cur_tx->wb_mbuf);
1495 * If there are no packets queued, bail.
1501 * Place the request for the upload interrupt
1502 * in the last descriptor in the chain. This way, if
1503 * we're chaining several packets at once, we'll only
1504 * get an interupt once for the whole chain rather than
1505 * once for each packet.
1507 WB_TXCTL(cur_tx) |= WB_TXCTL_FINT;
1508 cur_tx->wb_ptr->wb_frag[0].wb_ctl |= WB_TXCTL_FINT;
1509 sc->wb_cdata.wb_tx_tail = cur_tx;
1511 if (sc->wb_cdata.wb_tx_head == NULL) {
1512 sc->wb_cdata.wb_tx_head = start_tx;
1513 WB_TXOWN(start_tx) = WB_TXSTAT_OWN;
1514 CSR_WRITE_4(sc, WB_TXSTART, 0xFFFFFFFF);
1517 * We need to distinguish between the case where
1518 * the own bit is clear because the chip cleared it
1519 * and where the own bit is clear because we haven't
1520 * set it yet. The magic value WB_UNSET is just some
1521 * ramdomly chosen number which doesn't have the own
1522 * bit set. When we actually transmit the frame, the
1523 * status word will have _only_ the own bit set, so
1524 * the txeoc handler will be able to tell if it needs
1525 * to initiate another transmission to flush out pending
1528 WB_TXOWN(start_tx) = WB_UNSENT;
1532 * Set a timeout in case the chip goes out to lunch.
1543 struct wb_softc *sc = xsc;
1552 struct wb_softc *sc;
1554 struct ifnet *ifp = sc->wb_ifp;
1556 struct mii_data *mii;
1559 mii = device_get_softc(sc->wb_miibus);
1562 * Cancel pending I/O and free all RX/TX buffers.
1567 sc->wb_txthresh = WB_TXTHRESH_INIT;
1570 * Set cache alignment and burst length.
1573 CSR_WRITE_4(sc, WB_BUSCTL, WB_BUSCTL_CONFIG);
1574 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_TX_THRESH);
1575 WB_SETBIT(sc, WB_NETCFG, WB_TXTHRESH(sc->wb_txthresh));
1578 CSR_WRITE_4(sc, WB_BUSCTL, WB_BUSCTL_MUSTBEONE|WB_BUSCTL_ARBITRATION);
1579 WB_SETBIT(sc, WB_BUSCTL, WB_BURSTLEN_16LONG);
1580 switch(sc->wb_cachesize) {
1582 WB_SETBIT(sc, WB_BUSCTL, WB_CACHEALIGN_32LONG);
1585 WB_SETBIT(sc, WB_BUSCTL, WB_CACHEALIGN_16LONG);
1588 WB_SETBIT(sc, WB_BUSCTL, WB_CACHEALIGN_8LONG);
1592 WB_SETBIT(sc, WB_BUSCTL, WB_CACHEALIGN_NONE);
1596 /* This doesn't tend to work too well at 100Mbps. */
1597 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_TX_EARLY_ON);
1599 /* Init our MAC address */
1600 for (i = 0; i < ETHER_ADDR_LEN; i++) {
1601 CSR_WRITE_1(sc, WB_NODE0 + i, IFP2ENADDR(sc->wb_ifp)[i]);
1604 /* Init circular RX list. */
1605 if (wb_list_rx_init(sc) == ENOBUFS) {
1607 "initialization failed: no memory for rx buffers\n");
1612 /* Init TX descriptors. */
1613 wb_list_tx_init(sc);
1615 /* If we want promiscuous mode, set the allframes bit. */
1616 if (ifp->if_flags & IFF_PROMISC) {
1617 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_RX_ALLPHYS);
1619 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_RX_ALLPHYS);
1623 * Set capture broadcast bit to capture broadcast frames.
1625 if (ifp->if_flags & IFF_BROADCAST) {
1626 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_RX_BROAD);
1628 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_RX_BROAD);
1632 * Program the multicast filter, if necessary.
1637 * Load the address of the RX list.
1639 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_RX_ON);
1640 CSR_WRITE_4(sc, WB_RXADDR, vtophys(&sc->wb_ldata->wb_rx_list[0]));
1643 * Enable interrupts.
1645 CSR_WRITE_4(sc, WB_IMR, WB_INTRS);
1646 CSR_WRITE_4(sc, WB_ISR, 0xFFFFFFFF);
1648 /* Enable receiver and transmitter. */
1649 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_RX_ON);
1650 CSR_WRITE_4(sc, WB_RXSTART, 0xFFFFFFFF);
1652 WB_CLRBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON);
1653 CSR_WRITE_4(sc, WB_TXADDR, vtophys(&sc->wb_ldata->wb_tx_list[0]));
1654 WB_SETBIT(sc, WB_NETCFG, WB_NETCFG_TX_ON);
1658 ifp->if_drv_flags |= IFF_DRV_RUNNING;
1659 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1661 callout_reset(&sc->wb_stat_callout, hz, wb_tick, sc);
1667 * Set media options.
1673 struct wb_softc *sc;
1678 if (ifp->if_flags & IFF_UP)
1686 * Report current media status.
1689 wb_ifmedia_sts(ifp, ifmr)
1691 struct ifmediareq *ifmr;
1693 struct wb_softc *sc;
1694 struct mii_data *mii;
1699 mii = device_get_softc(sc->wb_miibus);
1702 ifmr->ifm_active = mii->mii_media_active;
1703 ifmr->ifm_status = mii->mii_media_status;
1710 wb_ioctl(ifp, command, data)
1715 struct wb_softc *sc = ifp->if_softc;
1716 struct mii_data *mii;
1717 struct ifreq *ifr = (struct ifreq *) data;
1723 if (ifp->if_flags & IFF_UP) {
1726 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
1741 mii = device_get_softc(sc->wb_miibus);
1742 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
1745 error = ether_ioctl(ifp, command, data);
1756 struct wb_softc *sc;
1762 if_printf(ifp, "watchdog timeout\n");
1764 if (!(wb_phy_readreg(sc, PHY_BMSR) & PHY_BMSR_LINKSTAT))
1765 if_printf(ifp, "no carrier - transceiver cable problem?\n");
1771 if (ifp->if_snd.ifq_head != NULL)
1772 wb_start_locked(ifp);
1779 * Stop the adapter and free any mbufs allocated to the
1784 struct wb_softc *sc;
1793 callout_stop(&sc->wb_stat_callout);
1795 WB_CLRBIT(sc, WB_NETCFG, (WB_NETCFG_RX_ON|WB_NETCFG_TX_ON));
1796 CSR_WRITE_4(sc, WB_IMR, 0x00000000);
1797 CSR_WRITE_4(sc, WB_TXADDR, 0x00000000);
1798 CSR_WRITE_4(sc, WB_RXADDR, 0x00000000);
1801 * Free data in the RX lists.
1803 for (i = 0; i < WB_RX_LIST_CNT; i++) {
1804 if (sc->wb_cdata.wb_rx_chain[i].wb_mbuf != NULL) {
1805 m_freem(sc->wb_cdata.wb_rx_chain[i].wb_mbuf);
1806 sc->wb_cdata.wb_rx_chain[i].wb_mbuf = NULL;
1809 bzero((char *)&sc->wb_ldata->wb_rx_list,
1810 sizeof(sc->wb_ldata->wb_rx_list));
1813 * Free the TX list buffers.
1815 for (i = 0; i < WB_TX_LIST_CNT; i++) {
1816 if (sc->wb_cdata.wb_tx_chain[i].wb_mbuf != NULL) {
1817 m_freem(sc->wb_cdata.wb_tx_chain[i].wb_mbuf);
1818 sc->wb_cdata.wb_tx_chain[i].wb_mbuf = NULL;
1822 bzero((char *)&sc->wb_ldata->wb_tx_list,
1823 sizeof(sc->wb_ldata->wb_tx_list));
1825 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
1831 * Stop all chip I/O so that the kernel's probe routines don't
1832 * get confused by errant DMAs when rebooting.
1838 struct wb_softc *sc;
1840 sc = device_get_softc(dev);