Home | History | Annotate | Line # | Download | only in pci
if_re_pci.c revision 1.21.2.1
      1 /*	$NetBSD: if_re_pci.c,v 1.21.2.1 2007/02/10 14:26:31 tron Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1997, 1998-2003
      5  *	Bill Paul <wpaul (at) windriver.com>.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by Bill Paul.
     18  * 4. Neither the name of the author nor the names of any co-contributors
     19  *    may be used to endorse or promote products derived from this software
     20  *    without specific prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
     26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
     32  * THE POSSIBILITY OF SUCH DAMAGE.
     33  */
     34 
     35 /* $FreeBSD: /repoman/r/ncvs/src/sys/dev/re/if_re.c,v 1.20 2004/04/11 20:34:08 ru Exp $ */
     36 
     37 /*
     38  * RealTek 8139C+/8169/8169S/8110S PCI NIC driver
     39  *
     40  * Written by Bill Paul <wpaul (at) windriver.com>
     41  * Senior Networking Software Engineer
     42  * Wind River Systems
     43  *
     44  * NetBSD bus-specific frontends for written by
     45  * Jonathan Stone <jonathan (at) netbsd.org>
     46  */
     47 
     48 #include "bpfilter.h"
     49 #include "vlan.h"
     50 
     51 #include <sys/types.h>
     52 
     53 #include <sys/param.h>
     54 #include <sys/endian.h>
     55 #include <sys/systm.h>
     56 #include <sys/sockio.h>
     57 #include <sys/mbuf.h>
     58 #include <sys/malloc.h>
     59 #include <sys/kernel.h>
     60 #include <sys/socket.h>
     61 #include <sys/device.h>
     62 
     63 #include <net/if.h>
     64 #include <net/if_arp.h>
     65 #include <net/if_dl.h>
     66 #include <net/if_ether.h>
     67 #include <net/if_media.h>
     68 #include <net/if_vlanvar.h>
     69 
     70 #include <machine/bus.h>
     71 
     72 #include <dev/mii/mii.h>
     73 #include <dev/mii/miivar.h>
     74 
     75 #include <dev/pci/pcireg.h>
     76 #include <dev/pci/pcivar.h>
     77 #include <dev/pci/pcidevs.h>
     78 
     79 #include <dev/ic/rtl81x9reg.h>
     80 #include <dev/ic/rtl81x9var.h>
     81 #include <dev/ic/rtl8169var.h>
     82 
     83 struct re_pci_softc {
     84 	struct rtk_softc sc_rtk;
     85 
     86 	void *sc_ih;
     87 	pci_chipset_tag_t sc_pc;
     88 	pcitag_t sc_pcitag;
     89 };
     90 
     91 static int	re_pci_match(struct device *, struct cfdata *, void *);
     92 static void	re_pci_attach(struct device *, struct device *, void *);
     93 
     94 /*
     95  * Various supported device vendors/types and their names.
     96  */
     97 static const struct rtk_type re_devs[] = {
     98 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
     99 	    RTK_HWREV_8139CPLUS,
    100 	    "RealTek 8139C+ 10/100BaseTX" },
    101 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
    102 	    RTK_HWREV_8100E,
    103 	    "RealTek 8100E PCIe 10/100BaseTX" },
    104 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
    105 	    RTK_HWREV_8101E,
    106 	    "RealTek 8101E PCIe 10/100BaseTX" },
    107 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
    108 	    RTK_HWREV_8168_SPIN1,
    109 	    "RealTek 8168B/8111B PCIe Gigabit Ethernet" },
    110 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
    111 	    RTK_HWREV_8168_SPIN2,
    112 	    "RealTek 8168B/8111B PCIe Gigabit Ethernet" },
    113 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    114 	    RTK_HWREV_8169,
    115 	    "RealTek 8169 Gigabit Ethernet" },
    116 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    117 	    RTK_HWREV_8169S,
    118 	    "RealTek 8169S Single-chip Gigabit Ethernet" },
    119 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    120 	    RTK_HWREV_8110S,
    121 	    "RealTek 8110S Single-chip Gigabit Ethernet" },
    122 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    123 	    RTK_HWREV_8169_8110SB,
    124 	    "RealTek 8169SB/8110SB Single-chip Gigabit Ethernet" },
    125 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169SC,
    126 	    RTK_HWREV_8169_8110SC,
    127 	    "RealTek 8169SC/8110SC Single-chip Gigabit Ethernet" },
    128 	{ PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_LAPCIGT,
    129 	    RTK_HWREV_8169S,
    130 	    "Corega CG-LAPCIGT Gigabit Ethernet" },
    131 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T,
    132 	    RTK_HWREV_8169S,
    133 	    "D-Link DGE-528T Gigabit Ethernet" },
    134 	{ PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902,
    135 	    RTK_HWREV_8169S,
    136 	    "US Robotics (3Com) USR997902 Gigabit Ethernet" },
    137 	{ PCI_VENDOR_LINKSYS, PCI_PRODUCT_LINKSYS_EG1032,
    138 	    RTK_HWREV_8169S,
    139 	    "Linksys EG1032 rev. 3 Gigabit Ethernet" },
    140 	{ 0, 0, 0, NULL }
    141 };
    142 
    143 static const struct rtk_hwrev re_hwrevs[] = {
    144 	{ RTK_HWREV_8139, RTK_8139,  "" },
    145 	{ RTK_HWREV_8139A, RTK_8139, "A" },
    146 	{ RTK_HWREV_8139AG, RTK_8139, "A-G" },
    147 	{ RTK_HWREV_8139B, RTK_8139, "B" },
    148 	{ RTK_HWREV_8130, RTK_8139, "8130" },
    149 	{ RTK_HWREV_8139C, RTK_8139, "C" },
    150 	{ RTK_HWREV_8139D, RTK_8139, "8139D/8100B/8100C" },
    151 	{ RTK_HWREV_8139CPLUS, RTK_8139CPLUS, "C+"},
    152 	{ RTK_HWREV_8168_SPIN1, RTK_8169, "8168B/8111B"},
    153 	{ RTK_HWREV_8168_SPIN2, RTK_8169, "8168B/8111B"},
    154 	{ RTK_HWREV_8169, RTK_8169, "8169"},
    155 	{ RTK_HWREV_8169S, RTK_8169, "8169S"},
    156 	{ RTK_HWREV_8110S, RTK_8169, "8110S"},
    157 	{ RTK_HWREV_8169_8110SB, RTK_8169, "8169SB"},
    158 	{ RTK_HWREV_8169_8110SC, RTK_8169, "8169SC"},
    159 	{ RTK_HWREV_8100E, RTK_8169, "8100E"},
    160 	{ RTK_HWREV_8101E, RTK_8169, "8101E"},
    161 	{ RTK_HWREV_8100, RTK_8139, "8100"},
    162 	{ RTK_HWREV_8101, RTK_8139, "8101"},
    163 	{ 0, 0, NULL }
    164 };
    165 
    166 #define RE_LINKSYS_EG1032_SUBID	0x00241737
    167 
    168 CFATTACH_DECL(re_pci, sizeof(struct re_pci_softc), re_pci_match, re_pci_attach,
    169 	      NULL, NULL);
    170 
    171 /*
    172  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
    173  * IDs against our list and return a device name if we find a match.
    174  */
    175 static int
    176 re_pci_match(struct device *parent, struct cfdata *match, void *aux)
    177 {
    178 	const struct rtk_type	*t;
    179 	struct pci_attach_args	*pa = aux;
    180 	bus_space_tag_t		iot, memt, bst;
    181 	bus_space_handle_t	ioh, memh, bsh;
    182 	bus_size_t		memsize, iosize, bsize;
    183 	u_int32_t		hwrev;
    184 	pcireg_t subid;
    185 	boolean_t ioh_valid, memh_valid;
    186 
    187 	subid = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG);
    188 
    189 	/* special-case Linksys EG1032, since rev 2 uses sk(4) */
    190 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_LINKSYS &&
    191 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_LINKSYS_EG1032 &&
    192 	    subid == RE_LINKSYS_EG1032_SUBID)
    193 		return 1;
    194 
    195 	t = re_devs;
    196 
    197 	while (t->rtk_name != NULL) {
    198 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
    199 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
    200 
    201 			/*
    202 			 * Temporarily map the I/O space
    203 			 * so we can read the chip ID register.
    204 			 */
    205 			ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO,
    206 			    PCI_MAPREG_TYPE_IO, 0, &iot, &ioh,
    207 			    NULL, &iosize) == 0);
    208 			memh_valid = (pci_mapreg_map(pa, RTK_PCI_LOMEM,
    209 			    PCI_MAPREG_TYPE_MEM, 0, &memt, &memh,
    210 			    NULL, &memsize) == 0);
    211 			if (ioh_valid) {
    212 				bst = iot;
    213 				bsh = ioh;
    214 				bsize = iosize;
    215 			} else if (memh_valid) {
    216 				bst = memt;
    217 				bsh = memh;
    218 				bsize = memsize;
    219 			} else
    220 				return 0;
    221 			hwrev = bus_space_read_4(bst, bsh, RTK_TXCFG) &
    222 			    RTK_TXCFG_HWREV;
    223 			bus_space_unmap(bst, bsh, bsize);
    224 			if (t->rtk_basetype == hwrev)
    225 				return 2;	/* defeat rtk(4) */
    226 		}
    227 		t++;
    228 	}
    229 
    230 	return 0;
    231 }
    232 
    233 static void
    234 re_pci_attach(struct device *parent, struct device *self, void *aux)
    235 {
    236 	struct re_pci_softc	*psc = (void *)self;
    237 	struct rtk_softc	*sc = &psc->sc_rtk;
    238 	struct pci_attach_args 	*pa = aux;
    239 	pci_chipset_tag_t pc = pa->pa_pc;
    240 	pci_intr_handle_t ih;
    241 	const char *intrstr = NULL;
    242 	const struct rtk_type	*t;
    243 	const struct rtk_hwrev	*hw_rev;
    244 	uint32_t		hwrev;
    245 	int			error = 0;
    246 	int			pmreg;
    247 	boolean_t		ioh_valid, memh_valid;
    248 	pcireg_t		command;
    249 	bus_space_tag_t		iot, memt;
    250 	bus_space_handle_t	ioh, memh;
    251 	bus_size_t		iosize, memsize, bsize;
    252 
    253 
    254 	/*
    255 	 * Handle power management nonsense.
    256 	 */
    257 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
    258 		command = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
    259 		if (command & PCI_PMCSR_STATE_MASK) {
    260 			u_int32_t		iobase, membase, irq;
    261 
    262 			/* Save important PCI config data. */
    263 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
    264 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
    265 			irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
    266 
    267 			/* Reset the power state. */
    268 			aprint_normal("%s: chip is is in D%d power mode "
    269 		    	    "-- setting to D0\n", sc->sc_dev.dv_xname,
    270 		    	    command & PCI_PMCSR_STATE_MASK);
    271 
    272 			command &= ~PCI_PMCSR_STATE_MASK;
    273 			pci_conf_write(pc, pa->pa_tag,
    274 			    pmreg + PCI_PMCSR, command);
    275 
    276 			/* Restore PCI config data. */
    277 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
    278 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
    279 			pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
    280 		}
    281 	}
    282 
    283 	/*
    284 	 * Map control/status registers.
    285 	 */
    286 	command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
    287 	command |= PCI_COMMAND_MASTER_ENABLE;
    288 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
    289 
    290 	ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
    291 	    &iot, &ioh, NULL, &iosize) == 0);
    292 	memh_valid = (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
    293 	    &memt, &memh, NULL, &memsize) == 0);
    294 	if (ioh_valid) {
    295 		sc->rtk_btag = iot;
    296 		sc->rtk_bhandle = ioh;
    297 		bsize = iosize;
    298 	} else if (memh_valid) {
    299 		sc->rtk_btag = memt;
    300 		sc->rtk_bhandle = memh;
    301 		bsize = memsize;
    302 	} else {
    303 		aprint_error("%s: can't map registers\n", sc->sc_dev.dv_xname);
    304 		return;
    305 	}
    306 
    307 	t = re_devs;
    308 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
    309 
    310 	while (t->rtk_name != NULL) {
    311 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
    312 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
    313 
    314 			if (t->rtk_basetype == hwrev)
    315 				break;
    316 		}
    317 		t++;
    318 	}
    319 	aprint_normal(": %s\n", t->rtk_name);
    320 
    321 	hw_rev = re_hwrevs;
    322 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
    323 	while (hw_rev->rtk_desc != NULL) {
    324 		if (hw_rev->rtk_rev == hwrev) {
    325 			sc->rtk_type = hw_rev->rtk_type;
    326 			break;
    327 		}
    328 		hw_rev++;
    329 	}
    330 
    331 	sc->sc_dmat = pa->pa_dmat;
    332 
    333 	/*
    334 	 * No power/enable/disable machinery for PCI attac;
    335 	 * mark the card enabled now.
    336 	 */
    337 	sc->sc_flags |= RTK_ENABLED;
    338 
    339 	/* Hook interrupt last to avoid having to lock softc */
    340 	/* Allocate interrupt */
    341 	if (pci_intr_map(pa, &ih)) {
    342 		aprint_error("%s: couldn't map interrupt\n",
    343 		    sc->sc_dev.dv_xname);
    344 		return;
    345 	}
    346 	intrstr = pci_intr_string(pc, ih);
    347 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, re_intr, sc);
    348 	if (psc->sc_ih == NULL) {
    349 		aprint_error("%s: couldn't establish interrupt",
    350 		    sc->sc_dev.dv_xname);
    351 		if (intrstr != NULL)
    352 			aprint_error(" at %s", intrstr);
    353 		aprint_error("\n");
    354 		return;
    355 	}
    356 	aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
    357 
    358 	re_attach(sc);
    359 
    360 	/*
    361 	 * Perform hardware diagnostic on the original RTL8169.
    362 	 * Some 32-bit cards were incorrectly wired and would
    363 	 * malfunction if plugged into a 64-bit slot.
    364 	 */
    365 	if (hwrev == RTK_HWREV_8169) {
    366 		error = re_diag(sc);
    367 		if (error) {
    368 			aprint_error(
    369 			    "%s: attach aborted due to hardware diag failure\n",
    370 			    sc->sc_dev.dv_xname);
    371 
    372 			re_detach(sc);
    373 
    374 			if (psc->sc_ih != NULL) {
    375 				pci_intr_disestablish(pc, psc->sc_ih);
    376 				psc->sc_ih = NULL;
    377 			}
    378 
    379 			if (bsize)
    380 				bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle,
    381 				    bsize);
    382 		}
    383 	}
    384 }
    385