Home | History | Annotate | Line # | Download | only in pci
if_gem_pci.c revision 1.28
      1 /*	$NetBSD: if_gem_pci.c,v 1.28 2008/04/04 16:26:52 martin Exp $ */
      2 
      3 /*
      4  *
      5  * Copyright (C) 2001 Eduardo Horvath.
      6  * All rights reserved.
      7  *
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR  ``AS IS'' AND
     19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR  BE LIABLE
     22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     28  * SUCH DAMAGE.
     29  *
     30  */
     31 
     32 /*
     33  * PCI bindings for Apple GMAC, Sun ERI and Sun GEM Ethernet controllers
     34  */
     35 
     36 #include <sys/cdefs.h>
     37 __KERNEL_RCSID(0, "$NetBSD: if_gem_pci.c,v 1.28 2008/04/04 16:26:52 martin Exp $");
     38 
     39 #include <sys/param.h>
     40 #include <sys/systm.h>
     41 #include <sys/malloc.h>
     42 #include <sys/kernel.h>
     43 #include <sys/socket.h>
     44 #include <sys/errno.h>
     45 #include <sys/device.h>
     46 
     47 #include <machine/endian.h>
     48 
     49 #include <uvm/uvm_extern.h>
     50 
     51 #include <net/if.h>
     52 #include <net/if_dl.h>
     53 #include <net/if_media.h>
     54 #include <net/if_ether.h>
     55 
     56 #if NBPFILTER > 0
     57 #include <net/bpf.h>
     58 #endif
     59 
     60 #include <sys/bus.h>
     61 #include <sys/intr.h>
     62 
     63 #include <dev/mii/mii.h>
     64 #include <dev/mii/miivar.h>
     65 #include <dev/mii/mii_bitbang.h>
     66 
     67 #include <dev/ic/gemreg.h>
     68 #include <dev/ic/gemvar.h>
     69 
     70 #include <dev/pci/pcivar.h>
     71 #include <dev/pci/pcireg.h>
     72 #include <dev/pci/pcidevs.h>
     73 
     74 /* XXX Should use Properties when that's fleshed out. */
     75 #ifdef macppc
     76 #include <dev/ofw/openfirm.h>
     77 #endif /* macppc */
     78 #ifdef __sparc__
     79 #include <machine/promlib.h>
     80 #endif
     81 
     82 #ifndef GEM_USE_LOCAL_MAC_ADDRESS
     83 #if defined (macppc) || defined (__sparc__)
     84 #define GEM_USE_LOCAL_MAC_ADDRESS	0	/* use system-wide address */
     85 #else
     86 #define GEM_USE_LOCAL_MAC_ADDRESS	1
     87 #endif
     88 #endif
     89 
     90 
     91 struct gem_pci_softc {
     92 	struct	gem_softc	gsc_gem;	/* GEM device */
     93 	void			*gsc_ih;
     94 };
     95 
     96 int	gem_match_pci(struct device *, struct cfdata *, void *);
     97 void	gem_attach_pci(struct device *, struct device *, void *);
     98 
     99 CFATTACH_DECL(gem_pci, sizeof(struct gem_pci_softc),
    100     gem_match_pci, gem_attach_pci, NULL, NULL);
    101 
    102 /*
    103  * Attach routines need to be split out to different bus-specific files.
    104  */
    105 
    106 int
    107 gem_match_pci(parent, cf, aux)
    108 	struct device *parent;
    109 	struct cfdata *cf;
    110 	void *aux;
    111 {
    112 	struct pci_attach_args *pa = aux;
    113 
    114 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN &&
    115 	    (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_ERINETWORK ||
    116 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_GEMNETWORK))
    117 		return (1);
    118 
    119 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_APPLE &&
    120 	    (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC ||
    121 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC2 ||
    122 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC3 ||
    123  	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_SHASTA_GMAC ||
    124 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_K2_GMAC ||
    125 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_INTREPID2_GMAC))
    126 		return (1);
    127 
    128 
    129 	return (0);
    130 }
    131 
    132 #if GEM_USE_LOCAL_MAC_ADDRESS
    133 static inline int
    134 gempromvalid(u_int8_t* buf)
    135 {
    136 	return buf[0] == 0x18 && buf[1] == 0x00 &&	/* structure length */
    137 	    buf[2] == 0x00 &&				/* revision */
    138 	    (buf[3] == 0x00 ||				/* hme */
    139 	     buf[3] == 0x80) &&				/* qfe */
    140 	    buf[4] == PCI_SUBCLASS_NETWORK_ETHERNET &&	/* subclass code */
    141 	    buf[5] == PCI_CLASS_NETWORK;		/* class code */
    142 }
    143 
    144 static inline int
    145 isshared_pins(u_int8_t* buf)
    146 {
    147 	return buf[0] == 's' && buf[1] == 'h' && buf[2] == 'a' &&
    148 	    buf[3] == 'r' && buf[4] == 'e' && buf[5] == 'd' &&
    149 	    buf[6] == '-' && buf[7] == 'p' && buf[8] == 'i' &&
    150 	    buf[9] == 'n' && buf[10] == 's';
    151 }
    152 #endif
    153 
    154 static inline int
    155 isserdes(u_int8_t* buf)
    156 {
    157 	return buf[0] == 's' && buf[1] == 'e' && buf[2] == 'r' &&
    158 	    buf[3] == 'd' && buf[4] == 'e' && buf[5] == 's';
    159 }
    160 
    161 void
    162 gem_attach_pci(parent, self, aux)
    163 	struct device *parent, *self;
    164 	void *aux;
    165 {
    166 	struct pci_attach_args *pa = aux;
    167 	struct gem_pci_softc *gsc = (void *)self;
    168 	struct gem_softc *sc = &gsc->gsc_gem;
    169 	pci_intr_handle_t ih;
    170 	const char *intrstr;
    171 	char devinfo[256];
    172 	uint8_t enaddr[ETHER_ADDR_LEN];
    173 #if GEM_USE_LOCAL_MAC_ADDRESS
    174 	u_int8_t		*enp;
    175 	bus_space_handle_t	romh;
    176 	u_int8_t		buf[0x0800];
    177 	int			dataoff, vpdoff, serdes;
    178 #if GEM_USE_LOCAL_MAC_ADDRESS || defined(GEM_DEBUG)
    179 	int i;
    180 #endif
    181 #ifdef GEM_DEBUG
    182 	int j;
    183 #endif
    184 	struct pci_vpd		*vpd;
    185 	static const u_int8_t promhdr[] = { 0x55, 0xaa };
    186 #define PROMHDR_PTR_DATA	0x18
    187 	static const u_int8_t promdat[] = {
    188 		0x50, 0x43, 0x49, 0x52,		/* "PCIR" */
    189 		PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8,
    190 		PCI_PRODUCT_SUN_GEMNETWORK & 0xff,
    191 		PCI_PRODUCT_SUN_GEMNETWORK >> 8
    192 	};
    193 #define PROMDATA_PTR_VPD	0x08
    194 #define PROMDATA_DATA2		0x0a
    195 #endif  /* GEM_USE_LOCAL_MAC_ADDRESS */
    196 
    197 	aprint_naive(": Ethernet controller\n");
    198 
    199 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
    200 	sc->sc_chiprev = PCI_REVISION(pa->pa_class);
    201 	aprint_normal(": %s (rev. 0x%02x)\n", devinfo, sc->sc_chiprev);
    202 
    203 	/*
    204 	 * Some Sun GEMs/ERIs do have their intpin register bogusly set to 0,
    205 	 * although it should be 1. correct that.
    206 	 */
    207 	if (pa->pa_intrpin == 0)
    208 		pa->pa_intrpin = 1;
    209 
    210 	sc->sc_variant = GEM_UNKNOWN;
    211 
    212 	sc->sc_dmatag = pa->pa_dmat;
    213 
    214 	sc->sc_flags |= GEM_PCI;
    215 
    216 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN) {
    217 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_GEMNETWORK)
    218 			sc->sc_variant = GEM_SUN_GEM;
    219 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_ERINETWORK)
    220 			sc->sc_variant = GEM_SUN_ERI;
    221 	} else if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_APPLE) {
    222 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC ||
    223 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC2 ||
    224 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC3 ||
    225 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_SHASTA_GMAC ||
    226 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_INTREPID2_GMAC)
    227 			sc->sc_variant = GEM_APPLE_GMAC;
    228 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_K2_GMAC)
    229 			sc->sc_variant = GEM_APPLE_K2_GMAC;
    230 	}
    231 
    232 	if (sc->sc_variant == GEM_UNKNOWN) {
    233 		aprint_error("%s: unknown adaptor\n", sc->sc_dev.dv_xname);
    234 		return;
    235 	}
    236 
    237 #define PCI_GEM_BASEADDR	(PCI_MAPREG_START + 0x00)
    238 
    239 	/* XXX Need to check for a 64-bit mem BAR? */
    240 	if (pci_mapreg_map(pa, PCI_GEM_BASEADDR,
    241 	    PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT, 0,
    242 	    &sc->sc_bustag, &sc->sc_h1, NULL, NULL) != 0)
    243 	{
    244 		aprint_error("%s: unable to map device registers\n",
    245 		    sc->sc_dev.dv_xname);
    246 		return;
    247 	}
    248 	if (bus_space_subregion(sc->sc_bustag, sc->sc_h1,
    249 	    GEM_PCI_BANK2_OFFSET, GEM_PCI_BANK2_SIZE, &sc->sc_h2)) {
    250 		aprint_error("%s: unable to create bank 2 subregion\n",
    251 		    sc->sc_dev.dv_xname);
    252 		return;
    253 	}
    254 
    255 #if GEM_USE_LOCAL_MAC_ADDRESS
    256 	/*
    257 	 * Dig out VPD (vital product data) and acquire Ethernet address.
    258 	 * The VPD of gem resides in the PCI PROM (PCI FCode).
    259 	 */
    260 	/*
    261 	 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later)
    262 	 * chapter 2 describes the data structure.
    263 	 */
    264 
    265 	enp = NULL;
    266 
    267 	if (sc->sc_variant == GEM_SUN_GEM &&
    268 	    (bus_space_subregion(sc->sc_bustag, sc->sc_h1,
    269 	    GEM_PCI_ROM_OFFSET, GEM_PCI_ROM_SIZE, &romh)) == 0) {
    270 
    271 		/* read PCI Expansion PROM Header */
    272 		bus_space_read_region_1(sc->sc_bustag,
    273 		    romh, 0, buf, sizeof buf);
    274 
    275 		/* Check for "shared-pins = serdes" in FCode. */
    276 		i = 0;
    277 		serdes = 0;
    278 		while (i < (sizeof buf) - sizeof "serdes") {
    279 			if (!serdes) {
    280 				if (isserdes(&buf[i]))
    281 					serdes = 1;
    282 			} else {
    283 				if (isshared_pins(&buf[i]))
    284 					serdes = 2;
    285 			}
    286 			if (serdes == 2) {
    287 				sc->sc_flags |= GEM_SERDES;
    288 				break;
    289 			}
    290 			i++;
    291 		}
    292 #ifdef GEM_DEBUG
    293 		/* PROM dump */
    294 		printf("%s: PROM dump (0x0000 to %04lx)\n", sc->sc_dev.dv_xname,
    295 		    (sizeof buf) - 1);
    296 		i = 0;
    297 		j = 0;
    298 		printf("  %04x  ", i);
    299 		while (i < sizeof buf) {
    300 			printf("%02x ", buf[i]);
    301 			if (i && !(i % 8))
    302 				printf(" ");
    303 			if (i && !(i % 16)) {
    304 				printf(" ");
    305 				while (j < i) {
    306 					if (buf[j] > 31 && buf[j] < 128)
    307 						printf("%c", buf[j]);
    308 					else
    309 						printf(".");
    310 					j++;
    311 				}
    312 				j = i;
    313 				printf("\n  %04x  ", i);
    314 				}
    315 			i++;
    316 		}
    317 		printf("\n");
    318 #endif
    319 
    320 		if (memcmp(buf, promhdr, sizeof promhdr) == 0 &&
    321 		    (dataoff = (buf[PROMHDR_PTR_DATA] |
    322 			(buf[PROMHDR_PTR_DATA + 1] << 8))) >= 0x1c) {
    323 
    324 			/* read PCI Expansion PROM Data */
    325 			bus_space_read_region_1(sc->sc_bustag, romh, dataoff,
    326 			    buf, 64);
    327 			if (memcmp(buf, promdat, sizeof promdat) == 0 &&
    328 			    gempromvalid(buf + PROMDATA_DATA2) &&
    329 			    (vpdoff = (buf[PROMDATA_PTR_VPD] |
    330 				(buf[PROMDATA_PTR_VPD + 1] << 8))) >= 0x1c) {
    331 
    332 				/*
    333 				 * The VPD of gem is not in PCI 2.2 standard
    334 				 * format.  The length in the resource header
    335 				 * is in big endian, and resources are not
    336 				 * properly terminated (only one resource
    337 				 * and no end tag).
    338 				 */
    339 				/* read PCI VPD */
    340 				bus_space_read_region_1(sc->sc_bustag, romh,
    341 				    vpdoff, buf, 64);
    342 				vpd = (void *)(buf + 3);
    343 				if (PCI_VPDRES_ISLARGE(buf[0]) &&
    344 				    PCI_VPDRES_LARGE_NAME(buf[0])
    345 					== PCI_VPDRES_TYPE_VPD &&
    346 				    vpd->vpd_key0 == 0x4e /* N */ &&
    347 				    vpd->vpd_key1 == 0x41 /* A */ &&
    348 				    vpd->vpd_len == ETHER_ADDR_LEN) {
    349 					/*
    350 					 * Ethernet address found
    351 					 */
    352 					enp = buf + 6;
    353 				}
    354 			}
    355 		}
    356 	}
    357 
    358 	if (enp)
    359 		memcpy(enaddr, enp, ETHER_ADDR_LEN);
    360 	else
    361 #endif  /* GEM_USE_LOCAL_MAC_ADDRESS */
    362 #ifdef __sparc__
    363 	{
    364 		if (strcmp(prom_getpropstring(PCITAG_NODE(pa->pa_tag),
    365 		    "shared-pins"), "serdes") == 0)
    366 			sc->sc_flags |= GEM_SERDES;
    367 		prom_getether(PCITAG_NODE(pa->pa_tag), enaddr);
    368 	}
    369 #else
    370 #ifdef macppc
    371 	{
    372 		int node;
    373 		char sp[6];	/* "serdes" */
    374 
    375 		node = pcidev_to_ofdev(pa->pa_pc, pa->pa_tag);
    376 		if (node == 0) {
    377 			aprint_error("%s: unable to locate OpenFirmware node\n",
    378 			    sc->sc_dev.dv_xname);
    379 			return;
    380 		}
    381 
    382 		OF_getprop(node, "shared-pins", sp, sizeof(sp));
    383 		if (isserdes(sp))
    384 			sc->sc_flags |= GEM_SERDES;
    385 		OF_getprop(node, "local-mac-address", enaddr, sizeof(enaddr));
    386 	}
    387 #else
    388 		printf("%s: no Ethernet address found\n", sc->sc_dev.dv_xname);
    389 #endif /* macppc */
    390 #endif /* __sparc__ */
    391 
    392 	if (pci_intr_map(pa, &ih) != 0) {
    393 		aprint_error("%s: unable to map interrupt\n",
    394 		    sc->sc_dev.dv_xname);
    395 		return;
    396 	}
    397 	intrstr = pci_intr_string(pa->pa_pc, ih);
    398 	gsc->gsc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_NET, gem_intr, sc);
    399 	if (gsc->gsc_ih == NULL) {
    400 		aprint_error("%s: unable to establish interrupt",
    401 		    sc->sc_dev.dv_xname);
    402 		if (intrstr != NULL)
    403 			aprint_normal(" at %s", intrstr);
    404 		aprint_normal("\n");
    405 		return;
    406 	}
    407 	aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr);
    408 
    409 	/* Finish off the attach. */
    410 	gem_attach(sc, enaddr);
    411 }
    412