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