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