Home | History | Annotate | Line # | Download | only in pci
if_re_pci.c revision 1.50.2.1
      1 /*	$NetBSD: if_re_pci.c,v 1.50.2.1 2020/02/29 20:19:10 ad 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 <sys/cdefs.h>
     49 __KERNEL_RCSID(0, "$NetBSD: if_re_pci.c,v 1.50.2.1 2020/02/29 20:19:10 ad Exp $");
     50 
     51 #include <sys/types.h>
     52 
     53 #include <sys/param.h>
     54 #include <sys/systm.h>
     55 #include <sys/device.h>
     56 
     57 #include <net/if.h>
     58 #include <net/if_ether.h>
     59 #include <net/if_media.h>
     60 
     61 #include <sys/bus.h>
     62 
     63 #include <dev/mii/mii.h>
     64 #include <dev/mii/miivar.h>
     65 
     66 #include <dev/pci/pcireg.h>
     67 #include <dev/pci/pcivar.h>
     68 #include <dev/pci/pcidevs.h>
     69 
     70 #include <dev/ic/rtl81x9reg.h>
     71 #include <dev/ic/rtl81x9var.h>
     72 #include <dev/ic/rtl8169var.h>
     73 
     74 struct re_pci_softc {
     75 	struct rtk_softc sc_rtk;
     76 
     77 	void *sc_ih;
     78 	pci_intr_handle_t *sc_pihp;
     79 	pci_chipset_tag_t sc_pc;
     80 };
     81 
     82 static int	re_pci_match(device_t, cfdata_t, void *);
     83 static void	re_pci_attach(device_t, device_t, void *);
     84 static int	re_pci_detach(device_t, int);
     85 
     86 CFATTACH_DECL_NEW(re_pci, sizeof(struct re_pci_softc),
     87     re_pci_match, re_pci_attach, re_pci_detach, NULL);
     88 
     89 /*
     90  * Various supported device vendors/types and their names.
     91  */
     92 static const struct rtk_type re_devs[] = {
     93 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
     94 	    RTK_8139CPLUS,
     95 	    "RealTek 8139C+ 10/100BaseTX" },
     96 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8101E,
     97 	    RTK_8101E,
     98 	    "RealTek 8100E/8101E/8102E/8102EL PCIe 10/100BaseTX" },
     99 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8168,
    100 	    RTK_8168,
    101 	    "RealTek 8168/8111 PCIe Gigabit Ethernet" },
    102 	{ PCI_VENDOR_NCUBE, PCI_PRODUCT_NCUBE_TG3648,
    103 	    RTK_8168,
    104 	    "TP-Link TG-3468 v2 (RTL8168) Gigabit Ethernet" },
    105 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169,
    106 	    RTK_8169,
    107 	    "RealTek 8169/8110 Gigabit Ethernet" },
    108 	{ PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8169SC,
    109 	    RTK_8169,
    110 	    "RealTek 8169SC/8110SC Single-chip Gigabit Ethernet" },
    111 	{ PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_LAPCIGT,
    112 	    RTK_8169,
    113 	    "Corega CG-LAPCIGT Gigabit Ethernet" },
    114 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE528T,
    115 	    RTK_8169,
    116 	    "D-Link DGE-528T Gigabit Ethernet" },
    117 	{ PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DGE530T_C1,
    118 	    RTK_8169,
    119 	    "D-Link DGE-530T C1 Gigabit Ethernet" },
    120 	{ PCI_VENDOR_USR2, PCI_PRODUCT_USR2_USR997902,
    121 	    RTK_8169,
    122 	    "US Robotics (3Com) USR997902 Gigabit Ethernet" },
    123 	{ PCI_VENDOR_LINKSYS, PCI_PRODUCT_LINKSYS_EG1032,
    124 	    RTK_8169,
    125 	    "Linksys EG1032 rev. 3 Gigabit Ethernet" },
    126 };
    127 
    128 static const struct rtk_type *
    129 re_pci_lookup(const struct pci_attach_args * pa)
    130 {
    131 	int i;
    132 
    133 	for (i = 0; i < __arraycount(re_devs); i++) {
    134 		if (PCI_VENDOR(pa->pa_id) != re_devs[i].rtk_vid)
    135 			continue;
    136 		if (PCI_PRODUCT(pa->pa_id) == re_devs[i].rtk_did)
    137 			return &re_devs[i];
    138 	}
    139 
    140 	return NULL;
    141 }
    142 
    143 #define RE_LINKSYS_EG1032_SUBID	0x00241737
    144 
    145 /*
    146  * Probe for a RealTek 8139C+/8169/8110 chip. Check the PCI vendor and device
    147  * IDs against our list and return a device name if we find a match.
    148  */
    149 static int
    150 re_pci_match(device_t parent, cfdata_t cf, void *aux)
    151 {
    152 	struct pci_attach_args *pa = aux;
    153 	pcireg_t subid;
    154 
    155 	subid = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG);
    156 
    157 	/* special-case Linksys EG1032, since rev 2 uses sk(4) */
    158 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_LINKSYS &&
    159 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_LINKSYS_EG1032) {
    160 		if (subid != RE_LINKSYS_EG1032_SUBID)
    161 			return 0;
    162 	}
    163 
    164 	/* Don't match 8139 other than C-PLUS */
    165 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_REALTEK &&
    166 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_REALTEK_RT8139) {
    167 		if (PCI_REVISION(pa->pa_class) != 0x20)
    168 			return 0;
    169 	}
    170 
    171 	if (re_pci_lookup(pa) != NULL)
    172 		return 2;	/* defeat rtk(4) */
    173 
    174 	return 0;
    175 }
    176 
    177 static void
    178 re_pci_attach(device_t parent, device_t self, void *aux)
    179 {
    180 	struct re_pci_softc *psc = device_private(self);
    181 	struct rtk_softc *sc = &psc->sc_rtk;
    182 	struct pci_attach_args *pa = aux;
    183 	pci_chipset_tag_t pc = pa->pa_pc;
    184 	const char *intrstr = NULL;
    185 	const struct rtk_type *t;
    186 	uint32_t hwrev;
    187 	pcireg_t command, memtype;
    188 	bool ioh_valid, memh_valid;
    189 	bus_space_tag_t iot, memt;
    190 	bus_space_handle_t ioh, memh;
    191 	bus_size_t iosize, memsize;
    192 	char intrbuf[PCI_INTRSTR_LEN];
    193 	bool prefer_io = false;
    194 
    195 	sc->sc_dev = self;
    196 	psc->sc_pc = pa->pa_pc;
    197 
    198 	command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
    199 	command |= PCI_COMMAND_MASTER_ENABLE;
    200 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
    201 
    202 	/*
    203 	 * Map control/status registers.
    204 	 */
    205 	ioh_valid = (pci_mapreg_map(pa, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
    206 	    &iot, &ioh, NULL, &iosize) == 0);
    207 	memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, RTK_PCI_LOMEM);
    208 	switch (memtype) {
    209 	case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT:
    210 	case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_64BIT:
    211 		memh_valid =
    212 		    (pci_mapreg_map(pa, RTK_PCI_LOMEM,
    213 			memtype, 0, &memt, &memh, NULL, &memsize) == 0) ||
    214 		    (pci_mapreg_map(pa, RTK_PCI_LOMEM + 4,
    215 			PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_64BIT,
    216 			0, &memt, &memh, NULL, &memsize) == 0);
    217 		break;
    218 	default:
    219 		memh_valid = 0;
    220 		break;
    221 	}
    222 
    223 	switch (PCI_VENDOR(pa->pa_id)) {
    224 	case PCI_VENDOR_REALTEK:
    225 		switch (PCI_PRODUCT(pa->pa_id)) {
    226 		case PCI_PRODUCT_REALTEK_RT8169SC:
    227 			prefer_io = true;
    228 			break;
    229 		}
    230 		break;
    231 	}
    232 	if (!memh_valid)
    233 		prefer_io = true;
    234 
    235 	if (ioh_valid && prefer_io) {
    236 		sc->rtk_btag = iot;
    237 		sc->rtk_bhandle = ioh;
    238 		sc->rtk_bsize = iosize;
    239 		if (memh_valid)
    240 			bus_space_unmap(memt, memh, memsize);
    241 
    242 		command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
    243 		command |= PCI_COMMAND_IO_ENABLE;
    244 		pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
    245 	} else if (memh_valid) {
    246 		sc->rtk_btag = memt;
    247 		sc->rtk_bhandle = memh;
    248 		sc->rtk_bsize = memsize;
    249 		if (ioh_valid)
    250 			bus_space_unmap(iot, ioh, iosize);
    251 
    252 		command = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
    253 		command |= PCI_COMMAND_MEM_ENABLE;
    254 		pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, command);
    255 	} else {
    256 		aprint_error(": can't map registers\n");
    257 		return;
    258 	}
    259 
    260 	t = re_pci_lookup(pa);
    261 	KASSERT(t != NULL);
    262 
    263 	pci_aprint_devinfo_fancy(pa, NULL, t->rtk_name, 1);
    264 
    265 	if (t->rtk_basetype == RTK_8139CPLUS)
    266 		sc->sc_quirk |= RTKQ_8139CPLUS;
    267 
    268 	if (t->rtk_basetype == RTK_8168 ||
    269 	    t->rtk_basetype == RTK_8101E)
    270 		sc->sc_quirk |= RTKQ_PCIE;
    271 
    272 	if (t->rtk_basetype == RTK_8168)
    273 		sc->sc_quirk |= RTKQ_IM_HW;
    274 
    275 	if (pci_dma64_available(pa) && (sc->sc_quirk & RTKQ_PCIE))
    276 		sc->sc_dmat = pa->pa_dmat64;
    277 	else
    278 		sc->sc_dmat = pa->pa_dmat;
    279 
    280 	/*
    281 	 * No power/enable/disable machinery for PCI attach;
    282 	 * mark the card enabled now.
    283 	 */
    284 	sc->sc_flags |= RTK_ENABLED;
    285 
    286 	/* Hook interrupt last to avoid having to lock softc */
    287 	/* Allocate interrupt */
    288 	if (pci_intr_alloc(pa, &psc->sc_pihp, NULL, 0)) {
    289 		aprint_error_dev(self, "couldn't map interrupt\n");
    290 		return;
    291 	}
    292 	intrstr = pci_intr_string(pc, psc->sc_pihp[0], intrbuf,
    293 	    sizeof(intrbuf));
    294 	psc->sc_ih = pci_intr_establish_xname(pc, psc->sc_pihp[0], IPL_NET,
    295 	    re_intr, sc, device_xname(sc->sc_dev));
    296 	if (psc->sc_ih == NULL) {
    297 		aprint_error_dev(self, "couldn't establish interrupt");
    298 		if (intrstr != NULL)
    299 			aprint_error(" at %s", intrstr);
    300 		aprint_error("\n");
    301 		return;
    302 	}
    303 	aprint_normal_dev(self, "interrupting at %s\n", intrstr);
    304 
    305 	re_attach(sc);
    306 
    307 	hwrev = CSR_READ_4(sc, RTK_TXCFG) & RTK_TXCFG_HWREV;
    308 
    309 	/*
    310 	 * Perform hardware diagnostic on the original RTL8169.
    311 	 * Some 32-bit cards were incorrectly wired and would
    312 	 * malfunction if plugged into a 64-bit slot.
    313 	 */
    314 	if (hwrev == RTK_HWREV_8169) {
    315 		if (re_diag(sc)) {
    316 			re_pci_detach(self, 0);
    317 			aprint_error_dev(self, "disabled\n");
    318 		}
    319 	}
    320 }
    321 
    322 static int
    323 re_pci_detach(device_t self, int flags)
    324 {
    325 	struct re_pci_softc *psc = device_private(self);
    326 	struct rtk_softc *sc = &psc->sc_rtk;
    327 	int rv;
    328 
    329 	if ((sc->sc_flags & RTK_ATTACHED) != 0)
    330 		/* re_stop() */
    331 		sc->ethercom.ec_if.if_stop(&sc->ethercom.ec_if, 0);
    332 
    333 	rv = re_detach(sc);
    334 	if (rv)
    335 		return rv;
    336 
    337 	if (psc->sc_ih != NULL) {
    338 		pci_intr_disestablish(psc->sc_pc, psc->sc_ih);
    339 		psc->sc_ih = NULL;
    340 	}
    341 
    342 	if (psc->sc_pihp != NULL) {
    343 		pci_intr_release(psc->sc_pc, psc->sc_pihp, 1);
    344 		psc->sc_pihp = NULL;
    345 	}
    346 
    347 	if (sc->rtk_bsize != 0) {
    348 		bus_space_unmap(sc->rtk_btag, sc->rtk_bhandle, sc->rtk_bsize);
    349 		sc->rtk_bsize = 0;
    350 	}
    351 
    352 	return 0;
    353 }
    354