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.
32 * $FreeBSD: src/sys/pci/if_rl.c,v 1.38.2.16 2003/03/05 18:42:33 njl Exp $
36 * RealTek 8129/8139 PCI NIC driver
38 * Supports several extremely cheap PCI 10/100 adapters based on
39 * the RealTek chipset. Datasheets can be obtained from
42 * Written by Bill Paul <wpaul@ctr.columbia.edu>
43 * Electrical Engineering Department
44 * Columbia University, New York City
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.
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.
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
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.
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
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.
86 #include <sys/param.h>
87 #include <sys/systm.h>
88 #include <sys/sockio.h>
90 #include <sys/malloc.h>
91 #include <sys/kernel.h>
92 #include <sys/socket.h>
95 #include <net/if_arp.h>
96 #include <net/ethernet.h>
97 #include <net/if_dl.h>
98 #include <net/if_media.h>
102 #include <vm/vm.h> /* for vtophys */
103 #include <vm/pmap.h> /* for vtophys */
104 #include <machine/clock.h> /* for DELAY */
105 #include <machine/bus_pio.h>
106 #include <machine/bus_memio.h>
107 #include <machine/bus.h>
108 #include <machine/resource.h>
110 #include <sys/rman.h>
112 #include <dev/mii/mii.h>
113 #include <dev/mii/miivar.h>
115 #include <pci/pcireg.h>
116 #include <pci/pcivar.h>
118 /* "controller miibus0" required. See GENERIC if you get errors here. */
119 #include "miibus_if.h"
122 * Default to using PIO access for this driver. On SMP systems,
123 * there appear to be problems with memory mapped mode: it looks like
124 * doing too many memory mapped access back to back in rapid succession
125 * can hang the bus. I'm inclined to blame this on crummy design/construction
126 * on the part of RealTek. Memory mapped mode does appear to work on
127 * uniprocessor systems though.
129 #define RL_USEIOSPACE
131 #include <pci/if_rlreg.h>
134 static const char rcsid[] =
135 "$FreeBSD: src/sys/pci/if_rl.c,v 1.38.2.16 2003/03/05 18:42:33 njl Exp $";
139 * Various supported device vendors/types and their names.
141 static struct rl_type rl_devs[] = {
142 { RT_VENDORID, RT_DEVICEID_8129,
143 "RealTek 8129 10/100BaseTX" },
144 { RT_VENDORID, RT_DEVICEID_8139,
145 "RealTek 8139 10/100BaseTX" },
146 { ACCTON_VENDORID, ACCTON_DEVICEID_5030,
147 "Accton MPX 5030/5038 10/100BaseTX" },
148 { DELTA_VENDORID, DELTA_DEVICEID_8139,
149 "Delta Electronics 8139 10/100BaseTX" },
150 { ADDTRON_VENDORID, ADDTRON_DEVICEID_8139,
151 "Addtron Technolgy 8139 10/100BaseTX" },
152 { DLINK_VENDORID, DLINK_DEVICEID_530TXPLUS,
153 "D-Link DFE-530TX+ 10/100BaseTX" },
154 { NORTEL_VENDORID, ACCTON_DEVICEID_5030,
155 "Nortel Networks 10/100BaseTX" },
156 { PEPPERCON_VENDORID, PEPPERCON_DEVICEID_ROLF,
157 "Peppercon AG ROL/F" },
161 static int rl_probe __P((device_t));
162 static int rl_attach __P((device_t));
163 static int rl_detach __P((device_t));
165 static int rl_encap __P((struct rl_softc *, struct mbuf * ));
167 static void rl_rxeof __P((struct rl_softc *));
168 static void rl_txeof __P((struct rl_softc *));
169 static void rl_intr __P((void *));
170 static void rl_tick __P((void *));
171 static void rl_start __P((struct ifnet *));
172 static int rl_ioctl __P((struct ifnet *, u_long, caddr_t));
173 static void rl_init __P((void *));
174 static void rl_stop __P((struct rl_softc *));
175 static void rl_watchdog __P((struct ifnet *));
176 static int rl_suspend __P((device_t));
177 static int rl_resume __P((device_t));
178 static void rl_shutdown __P((device_t));
179 static int rl_ifmedia_upd __P((struct ifnet *));
180 static void rl_ifmedia_sts __P((struct ifnet *, struct ifmediareq *));
182 static void rl_eeprom_putbyte __P((struct rl_softc *, int));
183 static void rl_eeprom_getword __P((struct rl_softc *, int, u_int16_t *));
184 static void rl_read_eeprom __P((struct rl_softc *, caddr_t,
186 static void rl_mii_sync __P((struct rl_softc *));
187 static void rl_mii_send __P((struct rl_softc *, u_int32_t, int));
188 static int rl_mii_readreg __P((struct rl_softc *, struct rl_mii_frame *));
189 static int rl_mii_writereg __P((struct rl_softc *, struct rl_mii_frame *));
191 static int rl_miibus_readreg __P((device_t, int, int));
192 static int rl_miibus_writereg __P((device_t, int, int, int));
193 static void rl_miibus_statchg __P((device_t));
195 static u_int8_t rl_calchash __P((caddr_t));
196 static void rl_setmulti __P((struct rl_softc *));
197 static void rl_reset __P((struct rl_softc *));
198 static int rl_list_tx_init __P((struct rl_softc *));
201 #define RL_RES SYS_RES_IOPORT
202 #define RL_RID RL_PCI_LOIO
204 #define RL_RES SYS_RES_MEMORY
205 #define RL_RID RL_PCI_LOMEM
208 static device_method_t rl_methods[] = {
209 /* Device interface */
210 DEVMETHOD(device_probe, rl_probe),
211 DEVMETHOD(device_attach, rl_attach),
212 DEVMETHOD(device_detach, rl_detach),
213 DEVMETHOD(device_suspend, rl_suspend),
214 DEVMETHOD(device_resume, rl_resume),
215 DEVMETHOD(device_shutdown, rl_shutdown),
218 DEVMETHOD(bus_print_child, bus_generic_print_child),
219 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
222 DEVMETHOD(miibus_readreg, rl_miibus_readreg),
223 DEVMETHOD(miibus_writereg, rl_miibus_writereg),
224 DEVMETHOD(miibus_statchg, rl_miibus_statchg),
229 static driver_t rl_driver = {
232 sizeof(struct rl_softc)
235 static devclass_t rl_devclass;
237 DRIVER_MODULE(if_rl, pci, rl_driver, rl_devclass, 0, 0);
238 DRIVER_MODULE(miibus, rl, miibus_driver, miibus_devclass, 0, 0);
241 CSR_WRITE_1(sc, RL_EECMD, \
242 CSR_READ_1(sc, RL_EECMD) | x)
245 CSR_WRITE_1(sc, RL_EECMD, \
246 CSR_READ_1(sc, RL_EECMD) & ~x)
249 * Send a read command and address to the EEPROM, check for ACK.
251 static void rl_eeprom_putbyte(sc, addr)
257 d = addr | RL_EECMD_READ;
260 * Feed in each bit and strobe the clock.
262 for (i = 0x400; i; i >>= 1) {
264 EE_SET(RL_EE_DATAIN);
266 EE_CLR(RL_EE_DATAIN);
279 * Read a word of data stored in the EEPROM at address 'addr.'
281 static void rl_eeprom_getword(sc, addr, dest)
289 /* Enter EEPROM access mode. */
290 CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_PROGRAM|RL_EE_SEL);
293 * Send address of word we want to read.
295 rl_eeprom_putbyte(sc, addr);
297 CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_PROGRAM|RL_EE_SEL);
300 * Start reading bits from EEPROM.
302 for (i = 0x8000; i; i >>= 1) {
305 if (CSR_READ_1(sc, RL_EECMD) & RL_EE_DATAOUT)
311 /* Turn off EEPROM access mode. */
312 CSR_WRITE_1(sc, RL_EECMD, RL_EEMODE_OFF);
320 * Read a sequence of words from the EEPROM.
322 static void rl_read_eeprom(sc, dest, off, cnt, swap)
330 u_int16_t word = 0, *ptr;
332 for (i = 0; i < cnt; i++) {
333 rl_eeprom_getword(sc, off + i, &word);
334 ptr = (u_int16_t *)(dest + (i * 2));
346 * MII access routines are provided for the 8129, which
347 * doesn't have a built-in PHY. For the 8139, we fake things
348 * up by diverting rl_phy_readreg()/rl_phy_writereg() to the
349 * direct access PHY registers.
352 CSR_WRITE_1(sc, RL_MII, \
353 CSR_READ_1(sc, RL_MII) | x)
356 CSR_WRITE_1(sc, RL_MII, \
357 CSR_READ_1(sc, RL_MII) & ~x)
360 * Sync the PHYs by setting data bit and strobing the clock 32 times.
362 static void rl_mii_sync(sc)
367 MII_SET(RL_MII_DIR|RL_MII_DATAOUT);
369 for (i = 0; i < 32; i++) {
380 * Clock a series of bits through the MII.
382 static void rl_mii_send(sc, bits, cnt)
391 for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
393 MII_SET(RL_MII_DATAOUT);
395 MII_CLR(RL_MII_DATAOUT);
405 * Read an PHY register through the MII.
407 static int rl_mii_readreg(sc, frame)
409 struct rl_mii_frame *frame;
417 * Set up frame for RX.
419 frame->mii_stdelim = RL_MII_STARTDELIM;
420 frame->mii_opcode = RL_MII_READOP;
421 frame->mii_turnaround = 0;
424 CSR_WRITE_2(sc, RL_MII, 0);
434 * Send command/address info.
436 rl_mii_send(sc, frame->mii_stdelim, 2);
437 rl_mii_send(sc, frame->mii_opcode, 2);
438 rl_mii_send(sc, frame->mii_phyaddr, 5);
439 rl_mii_send(sc, frame->mii_regaddr, 5);
442 MII_CLR((RL_MII_CLK|RL_MII_DATAOUT));
453 ack = CSR_READ_2(sc, RL_MII) & RL_MII_DATAIN;
458 * Now try reading data bits. If the ack failed, we still
459 * need to clock through 16 cycles to keep the PHY(s) in sync.
462 for(i = 0; i < 16; i++) {
471 for (i = 0x8000; i; i >>= 1) {
475 if (CSR_READ_2(sc, RL_MII) & RL_MII_DATAIN)
476 frame->mii_data |= i;
498 * Write to a PHY register through the MII.
500 static int rl_mii_writereg(sc, frame)
502 struct rl_mii_frame *frame;
509 * Set up frame for TX.
512 frame->mii_stdelim = RL_MII_STARTDELIM;
513 frame->mii_opcode = RL_MII_WRITEOP;
514 frame->mii_turnaround = RL_MII_TURNAROUND;
517 * Turn on data output.
523 rl_mii_send(sc, frame->mii_stdelim, 2);
524 rl_mii_send(sc, frame->mii_opcode, 2);
525 rl_mii_send(sc, frame->mii_phyaddr, 5);
526 rl_mii_send(sc, frame->mii_regaddr, 5);
527 rl_mii_send(sc, frame->mii_turnaround, 2);
528 rl_mii_send(sc, frame->mii_data, 16);
546 static int rl_miibus_readreg(dev, phy, reg)
551 struct rl_mii_frame frame;
553 u_int16_t rl8139_reg = 0;
555 sc = device_get_softc(dev);
557 if (sc->rl_type == RL_8139) {
558 /* Pretend the internal PHY is only at address 0 */
563 rl8139_reg = RL_BMCR;
566 rl8139_reg = RL_BMSR;
569 rl8139_reg = RL_ANAR;
572 rl8139_reg = RL_ANER;
575 rl8139_reg = RL_LPAR;
582 * Allow the rlphy driver to read the media status
583 * register. If we have a link partner which does not
584 * support NWAY, this is the register which will tell
585 * us the results of parallel detection.
588 rval = CSR_READ_1(sc, RL_MEDIASTAT);
592 printf("rl%d: bad phy register\n", sc->rl_unit);
595 rval = CSR_READ_2(sc, rl8139_reg);
599 bzero((char *)&frame, sizeof(frame));
601 frame.mii_phyaddr = phy;
602 frame.mii_regaddr = reg;
603 rl_mii_readreg(sc, &frame);
605 return(frame.mii_data);
608 static int rl_miibus_writereg(dev, phy, reg, data)
613 struct rl_mii_frame frame;
614 u_int16_t rl8139_reg = 0;
616 sc = device_get_softc(dev);
618 if (sc->rl_type == RL_8139) {
619 /* Pretend the internal PHY is only at address 0 */
624 rl8139_reg = RL_BMCR;
627 rl8139_reg = RL_BMSR;
630 rl8139_reg = RL_ANAR;
633 rl8139_reg = RL_ANER;
636 rl8139_reg = RL_LPAR;
643 printf("rl%d: bad phy register\n", sc->rl_unit);
646 CSR_WRITE_2(sc, rl8139_reg, data);
650 bzero((char *)&frame, sizeof(frame));
652 frame.mii_phyaddr = phy;
653 frame.mii_regaddr = reg;
654 frame.mii_data = data;
656 rl_mii_writereg(sc, &frame);
661 static void rl_miibus_statchg(dev)
668 * Calculate CRC of a multicast group address, return the upper 6 bits.
670 static u_int8_t rl_calchash(addr)
673 u_int32_t crc, carry;
677 /* Compute CRC for the address value. */
678 crc = 0xFFFFFFFF; /* initial value */
680 for (i = 0; i < 6; i++) {
682 for (j = 0; j < 8; j++) {
683 carry = ((crc & 0x80000000) ? 1 : 0) ^ (c & 0x01);
687 crc = (crc ^ 0x04c11db6) | carry;
691 /* return the filter bit position */
696 * Program the 64-bit multicast hash filter.
698 static void rl_setmulti(sc)
703 u_int32_t hashes[2] = { 0, 0 };
704 struct ifmultiaddr *ifma;
708 ifp = &sc->arpcom.ac_if;
710 rxfilt = CSR_READ_4(sc, RL_RXCFG);
712 if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) {
713 rxfilt |= RL_RXCFG_RX_MULTI;
714 CSR_WRITE_4(sc, RL_RXCFG, rxfilt);
715 CSR_WRITE_4(sc, RL_MAR0, 0xFFFFFFFF);
716 CSR_WRITE_4(sc, RL_MAR4, 0xFFFFFFFF);
720 /* first, zot all the existing hash bits */
721 CSR_WRITE_4(sc, RL_MAR0, 0);
722 CSR_WRITE_4(sc, RL_MAR4, 0);
724 /* now program new ones */
725 for (ifma = ifp->if_multiaddrs.lh_first; ifma != NULL;
726 ifma = ifma->ifma_link.le_next) {
727 if (ifma->ifma_addr->sa_family != AF_LINK)
729 h = rl_calchash(LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
731 hashes[0] |= (1 << h);
733 hashes[1] |= (1 << (h - 32));
738 rxfilt |= RL_RXCFG_RX_MULTI;
740 rxfilt &= ~RL_RXCFG_RX_MULTI;
742 CSR_WRITE_4(sc, RL_RXCFG, rxfilt);
743 CSR_WRITE_4(sc, RL_MAR0, hashes[0]);
744 CSR_WRITE_4(sc, RL_MAR4, hashes[1]);
749 static void rl_reset(sc)
754 CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_RESET);
756 for (i = 0; i < RL_TIMEOUT; i++) {
758 if (!(CSR_READ_1(sc, RL_COMMAND) & RL_CMD_RESET))
762 printf("rl%d: reset never completed!\n", sc->rl_unit);
768 * Probe for a RealTek 8129/8139 chip. Check the PCI vendor and device
769 * IDs against our list and return a device name if we find a match.
771 static int rl_probe(dev)
778 while(t->rl_name != NULL) {
779 if ((pci_get_vendor(dev) == t->rl_vid) &&
780 (pci_get_device(dev) == t->rl_did)) {
781 device_set_desc(dev, t->rl_name);
791 * Attach the interface. Allocate softc structures, do ifmedia
792 * setup and ethernet/BPF attach.
794 static int rl_attach(dev)
798 u_char eaddr[ETHER_ADDR_LEN];
802 u_int16_t rl_did = 0;
803 int unit, error = 0, rid;
807 sc = device_get_softc(dev);
808 unit = device_get_unit(dev);
809 bzero(sc, sizeof(struct rl_softc));
812 * Handle power management nonsense.
815 command = pci_read_config(dev, RL_PCI_CAPID, 4) & 0x000000FF;
816 if (command == 0x01) {
818 command = pci_read_config(dev, RL_PCI_PWRMGMTCTRL, 4);
819 if (command & RL_PSTATE_MASK) {
820 u_int32_t iobase, membase, irq;
822 /* Save important PCI config data. */
823 iobase = pci_read_config(dev, RL_PCI_LOIO, 4);
824 membase = pci_read_config(dev, RL_PCI_LOMEM, 4);
825 irq = pci_read_config(dev, RL_PCI_INTLINE, 4);
827 /* Reset the power state. */
828 printf("rl%d: chip is is in D%d power mode "
829 "-- setting to D0\n", unit, command & RL_PSTATE_MASK);
830 command &= 0xFFFFFFFC;
831 pci_write_config(dev, RL_PCI_PWRMGMTCTRL, command, 4);
833 /* Restore PCI config data. */
834 pci_write_config(dev, RL_PCI_LOIO, iobase, 4);
835 pci_write_config(dev, RL_PCI_LOMEM, membase, 4);
836 pci_write_config(dev, RL_PCI_INTLINE, irq, 4);
841 * Map control/status registers.
843 command = pci_read_config(dev, PCIR_COMMAND, 4);
844 command |= (PCIM_CMD_PORTEN|PCIM_CMD_MEMEN|PCIM_CMD_BUSMASTEREN);
845 pci_write_config(dev, PCIR_COMMAND, command, 4);
846 command = pci_read_config(dev, PCIR_COMMAND, 4);
849 if (!(command & PCIM_CMD_PORTEN)) {
850 printf("rl%d: failed to enable I/O ports!\n", unit);
855 if (!(command & PCIM_CMD_MEMEN)) {
856 printf("rl%d: failed to enable memory mapping!\n", unit);
863 sc->rl_res = bus_alloc_resource(dev, RL_RES, &rid,
864 0, ~0, 1, RF_ACTIVE);
866 if (sc->rl_res == NULL) {
867 printf ("rl%d: couldn't map ports/memory\n", unit);
872 sc->rl_btag = rman_get_bustag(sc->rl_res);
873 sc->rl_bhandle = rman_get_bushandle(sc->rl_res);
876 sc->rl_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
877 RF_SHAREABLE | RF_ACTIVE);
879 if (sc->rl_irq == NULL) {
880 printf("rl%d: couldn't map interrupt\n", unit);
881 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
886 error = bus_setup_intr(dev, sc->rl_irq, INTR_TYPE_NET,
887 rl_intr, sc, &sc->rl_intrhand);
890 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq);
891 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
892 printf("rl%d: couldn't set up irq\n", unit);
896 callout_handle_init(&sc->rl_stat_ch);
898 /* Reset the adapter. */
902 * Get station address from the EEPROM.
904 rl_read_eeprom(sc, (caddr_t)&eaddr, RL_EE_EADDR, 3, 0);
907 * A RealTek chip was detected. Inform the world.
909 printf("rl%d: Ethernet address: %6D\n", unit, eaddr, ":");
912 bcopy(eaddr, (char *)&sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
915 * Now read the exact device type from the EEPROM to find
916 * out if it's an 8129 or 8139.
918 rl_read_eeprom(sc, (caddr_t)&rl_did, RL_EE_PCI_DID, 1, 0);
920 if (rl_did == RT_DEVICEID_8139 || rl_did == ACCTON_DEVICEID_5030 ||
921 rl_did == DELTA_DEVICEID_8139 || rl_did == ADDTRON_DEVICEID_8139 ||
922 rl_did == DLINK_DEVICEID_530TXPLUS)
923 sc->rl_type = RL_8139;
924 else if (rl_did == RT_DEVICEID_8129)
925 sc->rl_type = RL_8129;
927 printf("rl%d: unknown device ID: %x\n", unit, rl_did);
928 bus_teardown_intr(dev, sc->rl_irq, sc->rl_intrhand);
929 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq);
930 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
935 sc->rl_cdata.rl_rx_buf = contigmalloc(RL_RXBUFLEN + 1518, M_DEVBUF,
936 M_NOWAIT, 0, 0xffffffff, PAGE_SIZE, 0);
938 if (sc->rl_cdata.rl_rx_buf == NULL) {
939 printf("rl%d: no memory for list buffers!\n", unit);
940 bus_teardown_intr(dev, sc->rl_irq, sc->rl_intrhand);
941 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq);
942 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
947 /* Leave a few bytes before the start of the RX ring buffer. */
948 sc->rl_cdata.rl_rx_buf_ptr = sc->rl_cdata.rl_rx_buf;
949 sc->rl_cdata.rl_rx_buf += sizeof(u_int64_t);
952 if (mii_phy_probe(dev, &sc->rl_miibus,
953 rl_ifmedia_upd, rl_ifmedia_sts)) {
954 printf("rl%d: MII without any phy!\n", sc->rl_unit);
955 contigfree(sc->rl_cdata.rl_rx_buf, RL_RXBUFLEN + 1518,
957 bus_teardown_intr(dev, sc->rl_irq, sc->rl_intrhand);
958 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq);
959 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
960 free(sc->rl_cdata.rl_rx_buf, M_DEVBUF);
965 ifp = &sc->arpcom.ac_if;
969 ifp->if_mtu = ETHERMTU;
970 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
971 ifp->if_ioctl = rl_ioctl;
972 ifp->if_output = ether_output;
973 ifp->if_start = rl_start;
974 ifp->if_watchdog = rl_watchdog;
975 ifp->if_init = rl_init;
976 ifp->if_baudrate = 10000000;
977 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
980 * Call MI attach routine.
982 ether_ifattach(ifp, ETHER_BPF_SUPPORTED);
989 static int rl_detach(dev)
998 sc = device_get_softc(dev);
999 ifp = &sc->arpcom.ac_if;
1001 ether_ifdetach(ifp, ETHER_BPF_SUPPORTED);
1004 bus_generic_detach(dev);
1005 device_delete_child(dev, sc->rl_miibus);
1007 bus_teardown_intr(dev, sc->rl_irq, sc->rl_intrhand);
1008 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->rl_irq);
1009 bus_release_resource(dev, RL_RES, RL_RID, sc->rl_res);
1011 contigfree(sc->rl_cdata.rl_rx_buf, RL_RXBUFLEN + 1518, M_DEVBUF);
1019 * Initialize the transmit descriptors.
1021 static int rl_list_tx_init(sc)
1022 struct rl_softc *sc;
1024 struct rl_chain_data *cd;
1028 for (i = 0; i < RL_TX_LIST_CNT; i++) {
1029 cd->rl_tx_chain[i] = NULL;
1031 RL_TXADDR0 + (i * sizeof(u_int32_t)), 0x0000000);
1034 sc->rl_cdata.cur_tx = 0;
1035 sc->rl_cdata.last_tx = 0;
1041 * A frame has been uploaded: pass the resulting mbuf chain up to
1042 * the higher level protocols.
1044 * You know there's something wrong with a PCI bus-master chip design
1045 * when you have to use m_devget().
1047 * The receive operation is badly documented in the datasheet, so I'll
1048 * attempt to document it here. The driver provides a buffer area and
1049 * places its base address in the RX buffer start address register.
1050 * The chip then begins copying frames into the RX buffer. Each frame
1051 * is preceeded by a 32-bit RX status word which specifies the length
1052 * of the frame and certain other status bits. Each frame (starting with
1053 * the status word) is also 32-bit aligned. The frame length is in the
1054 * first 16 bits of the status word; the lower 15 bits correspond with
1055 * the 'rx status register' mentioned in the datasheet.
1057 * Note: to make the Alpha happy, the frame payload needs to be aligned
1058 * on a 32-bit boundary. To achieve this, we cheat a bit by copying from
1059 * the ring buffer starting at an address two bytes before the actual
1060 * data location. We can then shave off the first two bytes using m_adj().
1061 * The reason we do this is because m_devget() doesn't let us specify an
1062 * offset into the mbuf storage space, so we have to artificially create
1063 * one. The ring is allocated in such a way that there are a few unused
1064 * bytes of space preceecing it so that it will be safe for us to do the
1065 * 2-byte backstep even if reading from the ring at offset 0.
1067 static void rl_rxeof(sc)
1068 struct rl_softc *sc;
1070 struct ether_header *eh;
1079 u_int16_t rx_bytes = 0, max_bytes;
1081 ifp = &sc->arpcom.ac_if;
1083 cur_rx = (CSR_READ_2(sc, RL_CURRXADDR) + 16) % RL_RXBUFLEN;
1085 /* Do not try to read past this point. */
1086 limit = CSR_READ_2(sc, RL_CURRXBUF) % RL_RXBUFLEN;
1089 max_bytes = (RL_RXBUFLEN - cur_rx) + limit;
1091 max_bytes = limit - cur_rx;
1093 while((CSR_READ_1(sc, RL_COMMAND) & RL_CMD_EMPTY_RXBUF) == 0) {
1094 #ifdef DEVICE_POLLING
1095 if (ifp->if_ipending & IFF_POLLING) {
1096 if (sc->rxcycles <= 0)
1100 #endif /* DEVICE_POLLING */
1101 rxbufpos = sc->rl_cdata.rl_rx_buf + cur_rx;
1102 rxstat = *(u_int32_t *)rxbufpos;
1105 * Here's a totally undocumented fact for you. When the
1106 * RealTek chip is in the process of copying a packet into
1107 * RAM for you, the length will be 0xfff0. If you spot a
1108 * packet header with this value, you need to stop. The
1109 * datasheet makes absolutely no mention of this and
1110 * RealTek should be shot for this.
1112 if ((u_int16_t)(rxstat >> 16) == RL_RXSTAT_UNFINISHED)
1115 if (!(rxstat & RL_RXSTAT_RXOK)) {
1121 /* No errors; receive the packet. */
1122 total_len = rxstat >> 16;
1123 rx_bytes += total_len + 4;
1126 * XXX The RealTek chip includes the CRC with every
1127 * received frame, and there's no way to turn this
1128 * behavior off (at least, I can't find anything in
1129 * the manual that explains how to do it) so we have
1130 * to trim off the CRC manually.
1132 total_len -= ETHER_CRC_LEN;
1135 * Avoid trying to read more bytes than we know
1136 * the chip has prepared for us.
1138 if (rx_bytes > max_bytes)
1141 rxbufpos = sc->rl_cdata.rl_rx_buf +
1142 ((cur_rx + sizeof(u_int32_t)) % RL_RXBUFLEN);
1144 if (rxbufpos == (sc->rl_cdata.rl_rx_buf + RL_RXBUFLEN))
1145 rxbufpos = sc->rl_cdata.rl_rx_buf;
1147 wrap = (sc->rl_cdata.rl_rx_buf + RL_RXBUFLEN) - rxbufpos;
1149 if (total_len > wrap) {
1151 * Fool m_devget() into thinking we want to copy
1152 * the whole buffer so we don't end up fragmenting
1155 m = m_devget(rxbufpos - RL_ETHER_ALIGN,
1156 total_len + RL_ETHER_ALIGN, 0, ifp, NULL);
1160 m_adj(m, RL_ETHER_ALIGN);
1161 m_copyback(m, wrap, total_len - wrap,
1162 sc->rl_cdata.rl_rx_buf);
1164 cur_rx = (total_len - wrap + ETHER_CRC_LEN);
1166 m = m_devget(rxbufpos - RL_ETHER_ALIGN,
1167 total_len + RL_ETHER_ALIGN, 0, ifp, NULL);
1171 m_adj(m, RL_ETHER_ALIGN);
1172 cur_rx += total_len + 4 + ETHER_CRC_LEN;
1176 * Round up to 32-bit boundary.
1178 cur_rx = (cur_rx + 3) & ~3;
1179 CSR_WRITE_2(sc, RL_CURRXADDR, cur_rx - 16);
1184 eh = mtod(m, struct ether_header *);
1187 /* Remove header from mbuf and pass it on. */
1188 m_adj(m, sizeof(struct ether_header));
1189 ether_input(ifp, eh, m);
1196 * A frame was downloaded to the chip. It's safe for us to clean up
1199 static void rl_txeof(sc)
1200 struct rl_softc *sc;
1205 ifp = &sc->arpcom.ac_if;
1208 * Go through our tx list and free mbufs for those
1209 * frames that have been uploaded.
1212 txstat = CSR_READ_4(sc, RL_LAST_TXSTAT(sc));
1213 if (!(txstat & (RL_TXSTAT_TX_OK|
1214 RL_TXSTAT_TX_UNDERRUN|RL_TXSTAT_TXABRT)))
1217 ifp->if_collisions += (txstat & RL_TXSTAT_COLLCNT) >> 24;
1219 if (RL_LAST_TXMBUF(sc) != NULL) {
1220 m_freem(RL_LAST_TXMBUF(sc));
1221 RL_LAST_TXMBUF(sc) = NULL;
1223 if (txstat & RL_TXSTAT_TX_OK)
1228 if ((txstat & RL_TXSTAT_TXABRT) ||
1229 (txstat & RL_TXSTAT_OUTOFWIN))
1230 CSR_WRITE_4(sc, RL_TXCFG, RL_TXCFG_CONFIG);
1231 oldthresh = sc->rl_txthresh;
1232 /* error recovery */
1236 * If there was a transmit underrun,
1237 * bump the TX threshold.
1239 if (txstat & RL_TXSTAT_TX_UNDERRUN)
1240 sc->rl_txthresh = oldthresh + 32;
1243 RL_INC(sc->rl_cdata.last_tx);
1244 ifp->if_flags &= ~IFF_OACTIVE;
1245 } while (sc->rl_cdata.last_tx != sc->rl_cdata.cur_tx);
1248 (sc->rl_cdata.last_tx == sc->rl_cdata.cur_tx) ? 0 : 5;
1253 static void rl_tick(xsc)
1256 struct rl_softc *sc;
1257 struct mii_data *mii;
1263 mii = device_get_softc(sc->rl_miibus);
1269 sc->rl_stat_ch = timeout(rl_tick, sc, hz);
1274 #ifdef DEVICE_POLLING
1275 static poll_handler_t rl_poll;
1278 rl_poll (struct ifnet *ifp, enum poll_cmd cmd, int count)
1280 struct rl_softc *sc = ifp->if_softc;
1282 if (cmd == POLL_DEREGISTER) { /* final call, enable interrupts */
1283 CSR_WRITE_4(sc, RL_IMR, RL_INTRS);
1287 sc->rxcycles = count;
1290 if (ifp->if_snd.ifq_head != NULL)
1293 if (cmd == POLL_AND_CHECK_STATUS) { /* also check status register */
1296 status = CSR_READ_2(sc, RL_ISR);
1298 CSR_WRITE_2(sc, RL_ISR, status);
1301 * XXX check behaviour on receiver stalls.
1304 if (status & RL_ISR_SYSTEM_ERR) {
1310 #endif /* DEVICE_POLLING */
1312 static void rl_intr(arg)
1315 struct rl_softc *sc;
1321 if (sc->suspended) {
1325 ifp = &sc->arpcom.ac_if;
1326 #ifdef DEVICE_POLLING
1327 if (ifp->if_ipending & IFF_POLLING)
1329 if (ether_poll_register(rl_poll, ifp)) { /* ok, disable interrupts */
1330 CSR_WRITE_2(sc, RL_IMR, 0x0000);
1334 #endif /* DEVICE_POLLING */
1338 status = CSR_READ_2(sc, RL_ISR);
1340 CSR_WRITE_2(sc, RL_ISR, status);
1342 if ((status & RL_INTRS) == 0)
1345 if (status & RL_ISR_RX_OK)
1348 if (status & RL_ISR_RX_ERR)
1351 if ((status & RL_ISR_TX_OK) || (status & RL_ISR_TX_ERR))
1354 if (status & RL_ISR_SYSTEM_ERR) {
1360 if (ifp->if_snd.ifq_head != NULL)
1367 * Encapsulate an mbuf chain in a descriptor by coupling the mbuf data
1368 * pointers to the fragment pointers.
1370 static int rl_encap(sc, m_head)
1371 struct rl_softc *sc;
1372 struct mbuf *m_head;
1374 struct mbuf *m_new = NULL;
1377 * The RealTek is brain damaged and wants longword-aligned
1378 * TX buffers, plus we can only have one fragment buffer
1379 * per packet. We have to copy pretty much all the time.
1382 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1385 if (m_head->m_pkthdr.len > MHLEN) {
1386 MCLGET(m_new, M_DONTWAIT);
1387 if (!(m_new->m_flags & M_EXT)) {
1392 m_copydata(m_head, 0, m_head->m_pkthdr.len, mtod(m_new, caddr_t));
1393 m_new->m_pkthdr.len = m_new->m_len = m_head->m_pkthdr.len;
1397 /* Pad frames to at least 60 bytes. */
1398 if (m_head->m_pkthdr.len < RL_MIN_FRAMELEN) {
1400 * Make security concious people happy: zero out the
1401 * bytes in the pad area, since we don't know what
1402 * this mbuf cluster buffer's previous user might
1405 bzero(mtod(m_head, char *) + m_head->m_pkthdr.len,
1406 RL_MIN_FRAMELEN - m_head->m_pkthdr.len);
1407 m_head->m_pkthdr.len +=
1408 (RL_MIN_FRAMELEN - m_head->m_pkthdr.len);
1409 m_head->m_len = m_head->m_pkthdr.len;
1412 RL_CUR_TXMBUF(sc) = m_head;
1418 * Main transmit routine.
1421 static void rl_start(ifp)
1424 struct rl_softc *sc;
1425 struct mbuf *m_head = NULL;
1429 while(RL_CUR_TXMBUF(sc) == NULL) {
1430 IF_DEQUEUE(&ifp->if_snd, m_head);
1434 if (rl_encap(sc, m_head)) {
1435 IF_PREPEND(&ifp->if_snd, m_head);
1436 ifp->if_flags |= IFF_OACTIVE;
1441 * If there's a BPF listener, bounce a copy of this frame
1445 bpf_mtap(ifp, RL_CUR_TXMBUF(sc));
1448 * Transmit the frame.
1450 CSR_WRITE_4(sc, RL_CUR_TXADDR(sc),
1451 vtophys(mtod(RL_CUR_TXMBUF(sc), caddr_t)));
1452 CSR_WRITE_4(sc, RL_CUR_TXSTAT(sc),
1453 RL_TXTHRESH(sc->rl_txthresh) |
1454 RL_CUR_TXMBUF(sc)->m_pkthdr.len);
1456 RL_INC(sc->rl_cdata.cur_tx);
1460 * We broke out of the loop because all our TX slots are
1461 * full. Mark the NIC as busy until it drains some of the
1462 * packets from the queue.
1464 if (RL_CUR_TXMBUF(sc) != NULL)
1465 ifp->if_flags |= IFF_OACTIVE;
1468 * Set a timeout in case the chip goes out to lunch.
1475 static void rl_init(xsc)
1478 struct rl_softc *sc = xsc;
1479 struct ifnet *ifp = &sc->arpcom.ac_if;
1480 struct mii_data *mii;
1482 u_int32_t rxcfg = 0;
1486 mii = device_get_softc(sc->rl_miibus);
1489 * Cancel pending I/O and free all RX/TX buffers.
1493 /* Init our MAC address */
1494 for (i = 0; i < ETHER_ADDR_LEN; i++) {
1495 CSR_WRITE_1(sc, RL_IDR0 + i, sc->arpcom.ac_enaddr[i]);
1498 /* Init the RX buffer pointer register. */
1499 CSR_WRITE_4(sc, RL_RXADDR, vtophys(sc->rl_cdata.rl_rx_buf));
1501 /* Init TX descriptors. */
1502 rl_list_tx_init(sc);
1505 * Enable transmit and receive.
1507 CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_TX_ENB|RL_CMD_RX_ENB);
1510 * Set the initial TX and RX configuration.
1512 CSR_WRITE_4(sc, RL_TXCFG, RL_TXCFG_CONFIG);
1513 CSR_WRITE_4(sc, RL_RXCFG, RL_RXCFG_CONFIG);
1515 /* Set the individual bit to receive frames for this host only. */
1516 rxcfg = CSR_READ_4(sc, RL_RXCFG);
1517 rxcfg |= RL_RXCFG_RX_INDIV;
1519 /* If we want promiscuous mode, set the allframes bit. */
1520 if (ifp->if_flags & IFF_PROMISC) {
1521 rxcfg |= RL_RXCFG_RX_ALLPHYS;
1522 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1524 rxcfg &= ~RL_RXCFG_RX_ALLPHYS;
1525 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1529 * Set capture broadcast bit to capture broadcast frames.
1531 if (ifp->if_flags & IFF_BROADCAST) {
1532 rxcfg |= RL_RXCFG_RX_BROAD;
1533 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1535 rxcfg &= ~RL_RXCFG_RX_BROAD;
1536 CSR_WRITE_4(sc, RL_RXCFG, rxcfg);
1540 * Program the multicast filter, if necessary.
1544 #ifdef DEVICE_POLLING
1546 * Only enable interrupts if we are polling, keep them off otherwise.
1548 if (ifp->if_ipending & IFF_POLLING)
1549 CSR_WRITE_2(sc, RL_IMR, 0);
1551 #endif /* DEVICE_POLLING */
1553 * Enable interrupts.
1555 CSR_WRITE_2(sc, RL_IMR, RL_INTRS);
1557 /* Set initial TX threshold */
1558 sc->rl_txthresh = RL_TX_THRESH_INIT;
1560 /* Start RX/TX process. */
1561 CSR_WRITE_4(sc, RL_MISSEDPKT, 0);
1563 /* Enable receiver and transmitter. */
1564 CSR_WRITE_1(sc, RL_COMMAND, RL_CMD_TX_ENB|RL_CMD_RX_ENB);
1568 CSR_WRITE_1(sc, RL_CFG1, RL_CFG1_DRVLOAD|RL_CFG1_FULLDUPLEX);
1570 ifp->if_flags |= IFF_RUNNING;
1571 ifp->if_flags &= ~IFF_OACTIVE;
1575 sc->rl_stat_ch = timeout(rl_tick, sc, hz);
1581 * Set media options.
1583 static int rl_ifmedia_upd(ifp)
1586 struct rl_softc *sc;
1587 struct mii_data *mii;
1590 mii = device_get_softc(sc->rl_miibus);
1597 * Report current media status.
1599 static void rl_ifmedia_sts(ifp, ifmr)
1601 struct ifmediareq *ifmr;
1603 struct rl_softc *sc;
1604 struct mii_data *mii;
1607 mii = device_get_softc(sc->rl_miibus);
1610 ifmr->ifm_active = mii->mii_media_active;
1611 ifmr->ifm_status = mii->mii_media_status;
1616 static int rl_ioctl(ifp, command, data)
1621 struct rl_softc *sc = ifp->if_softc;
1622 struct ifreq *ifr = (struct ifreq *) data;
1623 struct mii_data *mii;
1632 error = ether_ioctl(ifp, command, data);
1635 if (ifp->if_flags & IFF_UP) {
1638 if (ifp->if_flags & IFF_RUNNING)
1650 mii = device_get_softc(sc->rl_miibus);
1651 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
1663 static void rl_watchdog(ifp)
1666 struct rl_softc *sc;
1670 printf("rl%d: watchdog timeout\n", sc->rl_unit);
1681 * Stop the adapter and free any mbufs allocated to the
1684 static void rl_stop(sc)
1685 struct rl_softc *sc;
1690 ifp = &sc->arpcom.ac_if;
1693 untimeout(rl_tick, sc, sc->rl_stat_ch);
1694 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
1695 #ifdef DEVICE_POLLING
1696 ether_poll_deregister(ifp);
1697 #endif /* DEVICE_POLLING */
1699 CSR_WRITE_1(sc, RL_COMMAND, 0x00);
1700 CSR_WRITE_2(sc, RL_IMR, 0x0000);
1703 * Free the TX list buffers.
1705 for (i = 0; i < RL_TX_LIST_CNT; i++) {
1706 if (sc->rl_cdata.rl_tx_chain[i] != NULL) {
1707 m_freem(sc->rl_cdata.rl_tx_chain[i]);
1708 sc->rl_cdata.rl_tx_chain[i] = NULL;
1709 CSR_WRITE_4(sc, RL_TXADDR0 + i, 0x0000000);
1718 * Stop all chip I/O so that the kernel's probe routines don't
1719 * get confused by errant DMAs when rebooting.
1721 static void rl_shutdown(dev)
1724 struct rl_softc *sc;
1726 sc = device_get_softc(dev);
1734 * Device suspend routine. Stop the interface and save some PCI
1735 * settings in case the BIOS doesn't restore them properly on
1738 static int rl_suspend(dev)
1742 struct rl_softc *sc;
1744 sc = device_get_softc(dev);
1748 for (i = 0; i < 5; i++)
1749 sc->saved_maps[i] = pci_read_config(dev, PCIR_MAPS + i * 4, 4);
1750 sc->saved_biosaddr = pci_read_config(dev, PCIR_BIOS, 4);
1751 sc->saved_intline = pci_read_config(dev, PCIR_INTLINE, 1);
1752 sc->saved_cachelnsz = pci_read_config(dev, PCIR_CACHELNSZ, 1);
1753 sc->saved_lattimer = pci_read_config(dev, PCIR_LATTIMER, 1);
1761 * Device resume routine. Restore some PCI settings in case the BIOS
1762 * doesn't, re-enable busmastering, and restart the interface if
1765 static int rl_resume(dev)
1769 struct rl_softc *sc;
1772 sc = device_get_softc(dev);
1773 ifp = &sc->arpcom.ac_if;
1775 /* better way to do this? */
1776 for (i = 0; i < 5; i++)
1777 pci_write_config(dev, PCIR_MAPS + i * 4, sc->saved_maps[i], 4);
1778 pci_write_config(dev, PCIR_BIOS, sc->saved_biosaddr, 4);
1779 pci_write_config(dev, PCIR_INTLINE, sc->saved_intline, 1);
1780 pci_write_config(dev, PCIR_CACHELNSZ, sc->saved_cachelnsz, 1);
1781 pci_write_config(dev, PCIR_LATTIMER, sc->saved_lattimer, 1);
1783 /* reenable busmastering */
1784 pci_enable_busmaster(dev);
1785 pci_enable_io(dev, RL_RES);
1787 /* reinitialize interface if necessary */
1788 if (ifp->if_flags & IFF_UP)