Home | History | Annotate | Line # | Download | only in pci
if_re_pci.c revision 1.19
      1 /*	$NetBSD: if_re_pci.c,v 1.19 2006/11/18 07:22:06 tsutsui 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 /*
     80  * Default to using PIO access for this driver.
     81  */
     82 #define RE_USEIOSPACE
     83 
     84 #include <dev/ic/rtl81x9reg.h>
     85 #include <dev/ic/rtl81x9var.h>
     86 #include <dev/ic/rtl8169var.h>
     87 
     88 struct re_pci_softc {
     89 	struct rtk_softc sc_rtk;
     90 
     91 	void *sc_ih;
     92 	pci_chipset_tag_t sc_pc;
     93 	pcitag_t sc_pcitag;
     94 };
     95 
     96 static int	re_pci_probe(struct device *, struct cfdata *, void *);
     97 static void	re_pci_attach(struct device *, struct device *, void *);
     98 
     99 /*
    100  * Various supported device vendors/types and their names.
    101  */
    102 static const struct rtk_type re_devs[] = {
    103 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
    104 	    RTK_HWREV_8139CPLUS,
    105 	    "RealTek 8139C+ 10/100BaseTX" },
    106 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
    107 	    RTK_HWREV_8100E,
    108 	    "RealTek 8100E PCIe 10/100BaseTX" },
    109 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
    110 	    RTK_HWREV_8101E,
    111 	    "RealTek 8101E PCIe 10/100BaseTX" },
    112 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
    113 	    RTK_HWREV_8168_SPIN1,
    114 	    "RealTek 8168B/8111B PCIe Gigabit Ethernet" },
    115 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
    116 	    RTK_HWREV_8168_SPIN2,
    117 	    "RealTek 8168B/8111B PCIe Gigabit Ethernet" },
    118 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    119 	    RTK_HWREV_8169,
    120 	    "RealTek 8169 Gigabit Ethernet" },
    121 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    122 	    RTK_HWREV_8169S,
    123 	    "RealTek 8169S Single-chip Gigabit Ethernet" },
    124 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    125 	    RTK_HWREV_8110S,
    126 	    "RealTek 8110S Single-chip Gigabit Ethernet" },
    127 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    128 	    RTK_HWREV_8169_8110SB,
    129 	    "RealTek 8169SB/8110SB Single-chip Gigabit Ethernet" },
    130 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169SC,
    131 	    RTK_HWREV_8169_8110SC,
    132 	    "RealTek 8169SC/8110SC Single-chip Gigabit Ethernet" },
    133 	{ PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_LAPCIGT,
    134 	    RTK_HWREV_8169S,
    135 	    "Corega CG-LAPCIGT Gigabit Ethernet" },
    136 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T,
    137 	    RTK_HWREV_8169S,
    138 	    "D-Link DGE-528T Gigabit Ethernet" },
    139 	{ PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902,
    140 	    RTK_HWREV_8169S,
    141 	    "US Robotics (3Com) USR997902 Gigabit Ethernet" },
    142 	{ PCI_VENDOR_LINKSYS, PCI_PRODUCT_LINKSYS_EG1032,
    143 	    RTK_HWREV_8169S,
    144 	    "Linksys EG1032 rev. 3 Gigabit Ethernet" },
    145 	{ 0, 0, 0, NULL }
    146 };
    147 
    148 static const struct rtk_hwrev re_hwrevs[] = {
    149 	{ RTK_HWREV_8139, RTK_8139,  "" },
    150 	{ RTK_HWREV_8139A, RTK_8139, "A" },
    151 	{ RTK_HWREV_8139AG, RTK_8139, "A-G" },
    152 	{ RTK_HWREV_8139B, RTK_8139, "B" },
    153 	{ RTK_HWREV_8130, RTK_8139, "8130" },
    154 	{ RTK_HWREV_8139C, RTK_8139, "C" },
    155 	{ RTK_HWREV_8139D, RTK_8139, "8139D/8100B/8100C" },
    156 	{ RTK_HWREV_8139CPLUS, RTK_8139CPLUS, "C+"},
    157 	{ RTK_HWREV_8168_SPIN1, RTK_8169, "8168B/8111B"},
    158 	{ RTK_HWREV_8168_SPIN2, RTK_8169, "8168B/8111B"},
    159 	{ RTK_HWREV_8169, RTK_8169, "8169"},
    160 	{ RTK_HWREV_8169S, RTK_8169, "8169S"},
    161 	{ RTK_HWREV_8110S, RTK_8169, "8110S"},
    162 	{ RTK_HWREV_8169_8110SB, RTK_8169, "8169SB"},
    163 	{ RTK_HWREV_8169_8110SC, RTK_8169, "8169SC"},
    164 	{ RTK_HWREV_8100E, RTK_8169, "8100E"},
    165 	{ RTK_HWREV_8101E, RTK_8169, "8101E"},
    166 	{ RTK_HWREV_8100, RTK_8139, "8100"},
    167 	{ RTK_HWREV_8101, RTK_8139, "8101"},
    168 	{ 0, 0, NULL }
    169 };
    170 
    171 #define RE_LINKSYS_EG1032_SUBID	0x00241737
    172 
    173 CFATTACH_DECL(re_pci, sizeof(struct re_pci_softc), re_pci_probe, re_pci_attach,
    174 	      NULL, NULL);
    175 
    176 /*
    177  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
    178  * IDs against our list and return a device name if we find a match.
    179  */
    180 static int
    181 re_pci_probe(struct device *parent, struct cfdata *match,
    182     void *aux)
    183 {
    184 	const struct rtk_type		*t;
    185 	struct pci_attach_args	*pa = aux;
    186 	bus_space_tag_t		rtk_btag;
    187 	bus_space_handle_t	rtk_bhandle;
    188 	bus_size_t		bsize;
    189 	u_int32_t		hwrev;
    190 	pcireg_t subid;
    191 
    192 	subid = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG);
    193 
    194 	/* special-case Linksys EG1032, since rev 2 uses sk(4) */
    195 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_LINKSYS &&
    196 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_LINKSYS_EG1032 &&
    197 	    subid == RE_LINKSYS_EG1032_SUBID)
    198 		return 1;
    199 
    200 	t = re_devs;
    201 
    202 	while (t->rtk_name != NULL) {
    203 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
    204 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
    205 
    206 			/*
    207 			 * Temporarily map the I/O space
    208 			 * so we can read the chip ID register.
    209 			 */
    210 #ifdef RE_USEIOSPACE
    211 			if (pci_mapreg_map(pa, RTK_PCI_LOIO,
    212 			    PCI_MAPREG_TYPE_IO, 0, &rtk_btag,
    213 			    &rtk_bhandle, NULL, &bsize)) {
    214 				aprint_error("can't map i/o space\n");
    215 				return 0;
    216 			}
    217 #else
    218 			if (pci_mapreg_map(pa, RTK_PCI_LOMEM,
    219 			    PCI_MAPREG_TYPE_MEM, 0, &rtk_btag,
    220 			    &rtk_bhandle, NULL, &bsize)) {
    221 				aprint_error("can't map mem space\n");
    222 				return 0;
    223 			}
    224 #endif
    225 			hwrev = bus_space_read_4(rtk_btag, rtk_bhandle,
    226 			    RTK_TXCFG) & RTK_TXCFG_HWREV;
    227 			bus_space_unmap(rtk_btag, rtk_bhandle, bsize);
    228 			if (t->rtk_basetype == hwrev)
    229 				return 2;	/* defeat rtk(4) */
    230 		}
    231 		t++;
    232 	}
    233 
    234 	return 0;
    235 }
    236 
    237 static void
    238 re_pci_attach(struct device *parent, struct device *self, void *aux)
    239 {
    240 	struct re_pci_softc	*psc = (void *)self;
    241 	struct rtk_softc	*sc = &psc->sc_rtk;
    242 	struct pci_attach_args 	*pa = aux;
    243 	pci_chipset_tag_t pc = pa->pa_pc;
    244 	pci_intr_handle_t ih;
    245 	const char *intrstr = NULL;
    246 	const struct rtk_type	*t;
    247 	const struct rtk_hwrev	*hw_rev;
    248 	int			hwrev;
    249 	int			error = 0;
    250 	int			pmreg;
    251 	pcireg_t		command;
    252 	bus_size_t		bsize;
    253 
    254 
    255 	/*
    256 	 * Handle power management nonsense.
    257 	 */
    258 	if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, &pmreg, 0)) {
    259 		command = pci_conf_read(pc, pa->pa_tag, pmreg + PCI_PMCSR);
    260 		if (command & PCI_PMCSR_STATE_MASK) {
    261 			u_int32_t		iobase, membase, irq;
    262 
    263 			/* Save important PCI config data. */
    264 			iobase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOIO);
    265 			membase = pci_conf_read(pc, pa->pa_tag, RTK_PCI_LOMEM);
    266 			irq = pci_conf_read(pc, pa->pa_tag, PCI_INTERRUPT_REG);
    267 
    268 			/* Reset the power state. */
    269 			aprint_normal("%s: chip is is in D%d power mode "
    270 		    	    "-- setting to D0\n", sc->sc_dev.dv_xname,
    271 		    	    command & PCI_PMCSR_STATE_MASK);
    272 
    273 			command &= ~PCI_PMCSR_STATE_MASK;
    274 			pci_conf_write(pc, pa->pa_tag,
    275 			    pmreg + PCI_PMCSR, command);
    276 
    277 			/* Restore PCI config data. */
    278 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOIO, iobase);
    279 			pci_conf_write(pc, pa->pa_tag, RTK_PCI_LOMEM, membase);
    280 			pci_conf_write(pc, pa->pa_tag, PCI_INTERRUPT_REG, irq);
    281 		}
    282 	}
    283 
    284 	/*
    285 	 * Map control/status registers.
    286 	 */
    287 	command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
    288 	command |= PCI_COMMAND_MASTER_ENABLE;
    289 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
    290 
    291 #ifdef RE_USEIOSPACE
    292 	if (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
    293 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
    294 		aprint_error("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
    295 		return;
    296 	}
    297 #else
    298 	if (pci_mapreg_map(pa, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
    299 	    &sc->rtk_btag, &sc->rtk_bhandle, NULL, &bsize)) {
    300 		aprint_error("%s: can't map mem space\n", sc->sc_dev.dv_xname);
    301 		return;
    302 	}
    303 #endif
    304 	t = re_devs;
    305 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
    306 
    307 	while (t->rtk_name != NULL) {
    308 		if ((PCI_VENDOR(pa->pa_id) == t->rtk_vid) &&
    309 		    (PCI_PRODUCT(pa->pa_id) == t->rtk_did)) {
    310 
    311 			if (t->rtk_basetype == hwrev)
    312 				break;
    313 		}
    314 		t++;
    315 	}
    316 	aprint_normal(": %s\n", t->rtk_name);
    317 
    318 	hw_rev = re_hwrevs;
    319 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
    320 	while (hw_rev->rtk_desc != NULL) {
    321 		if (hw_rev->rtk_rev == hwrev) {
    322 			sc->rtk_type = hw_rev->rtk_type;
    323 			break;
    324 		}
    325 		hw_rev++;
    326 	}
    327 
    328 	sc->sc_dmat = pa->pa_dmat;
    329 
    330 	/*
    331 	 * No power/enable/disable machinery for PCI attac;
    332 	 * mark the card enabled now.
    333 	 */
    334 	sc->sc_flags |= RTK_ENABLED;
    335 
    336 	/* Hook interrupt last to avoid having to lock softc */
    337 	/* Allocate interrupt */
    338 	if (pci_intr_map(pa, &ih)) {
    339 		aprint_error("%s: couldn't map interrupt\n",
    340 		    sc->sc_dev.dv_xname);
    341 		return;
    342 	}
    343 	intrstr = pci_intr_string(pc, ih);
    344 	psc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, re_intr, sc);
    345 	if (psc->sc_ih == NULL) {
    346 		aprint_error("%s: couldn't establish interrupt",
    347 		    sc->sc_dev.dv_xname);
    348 		if (intrstr != NULL)
    349 			aprint_error(" at %s", intrstr);
    350 		aprint_error("\n");
    351 		return;
    352 	}
    353 	aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
    354 
    355 	re_attach(sc);
    356 
    357 	/*
    358 	 * Perform hardware diagnostic on the original RTL8169.
    359 	 * Some 32-bit cards were incorrectly wired and would
    360 	 * malfunction if plugged into a 64-bit slot.
    361 	 */
    362 	if (hwrev == RTK_HWREV_8169) {
    363 		error = re_diag(sc);
    364 		if (error) {
    365 			aprint_error(
    366 			    "%s: attach aborted due to hardware diag failure\n",
    367 			    sc->sc_dev.dv_xname);
    368 
    369 			re_detach(sc);
    370 
    371 			if (psc->sc_ih != NULL) {
    372 				pci_intr_disestablish(pc, psc->sc_ih);
    373 				psc->sc_ih = NULL;
    374 			}
    375 
    376 			if (bsize)
    377 				bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle,
    378 				    bsize);
    379 		}
    380 	}
    381 }
    382