Home | History | Annotate | Line # | Download | only in pci
if_gem_pci.c revision 1.30
      1 /*	$NetBSD: if_gem_pci.c,v 1.30 2008/05/25 16:00:11 chs 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.30 2008/05/25 16:00:11 chs 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_SHASTA_GMAC ||
    126 	     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_INTREPID2_GMAC))
    127 		return (1);
    128 
    129 
    130 	return (0);
    131 }
    132 
    133 #if GEM_USE_LOCAL_MAC_ADDRESS
    134 static inline int
    135 gempromvalid(u_int8_t* buf)
    136 {
    137 	return buf[0] == 0x18 && buf[1] == 0x00 &&	/* structure length */
    138 	    buf[2] == 0x00 &&				/* revision */
    139 	    (buf[3] == 0x00 ||				/* hme */
    140 	     buf[3] == 0x80) &&				/* qfe */
    141 	    buf[4] == PCI_SUBCLASS_NETWORK_ETHERNET &&	/* subclass code */
    142 	    buf[5] == PCI_CLASS_NETWORK;		/* class code */
    143 }
    144 
    145 static inline int
    146 isshared_pins(u_int8_t* buf)
    147 {
    148 	return buf[0] == 's' && buf[1] == 'h' && buf[2] == 'a' &&
    149 	    buf[3] == 'r' && buf[4] == 'e' && buf[5] == 'd' &&
    150 	    buf[6] == '-' && buf[7] == 'p' && buf[8] == 'i' &&
    151 	    buf[9] == 'n' && buf[10] == 's';
    152 }
    153 #endif
    154 
    155 static inline int
    156 isserdes(u_int8_t* buf)
    157 {
    158 	return buf[0] == 's' && buf[1] == 'e' && buf[2] == 'r' &&
    159 	    buf[3] == 'd' && buf[4] == 'e' && buf[5] == 's';
    160 }
    161 
    162 void
    163 gem_attach_pci(parent, self, aux)
    164 	struct device *parent, *self;
    165 	void *aux;
    166 {
    167 	struct pci_attach_args *pa = aux;
    168 	struct gem_pci_softc *gsc = (void *)self;
    169 	struct gem_softc *sc = &gsc->gsc_gem;
    170 	pci_intr_handle_t ih;
    171 	const char *intrstr;
    172 	char devinfo[256];
    173 	uint8_t enaddr[ETHER_ADDR_LEN];
    174 #if GEM_USE_LOCAL_MAC_ADDRESS
    175 	u_int8_t		*enp;
    176 	bus_space_handle_t	romh;
    177 	u_int8_t		buf[0x0800];
    178 	int			dataoff, vpdoff, serdes;
    179 #if GEM_USE_LOCAL_MAC_ADDRESS || defined(GEM_DEBUG)
    180 	int i;
    181 #endif
    182 #ifdef GEM_DEBUG
    183 	int j;
    184 #endif
    185 	struct pci_vpd		*vpd;
    186 	static const u_int8_t promhdr[] = { 0x55, 0xaa };
    187 #define PROMHDR_PTR_DATA	0x18
    188 	static const u_int8_t promdat[] = {
    189 		0x50, 0x43, 0x49, 0x52,		/* "PCIR" */
    190 		PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8,
    191 		PCI_PRODUCT_SUN_GEMNETWORK & 0xff,
    192 		PCI_PRODUCT_SUN_GEMNETWORK >> 8
    193 	};
    194 #define PROMDATA_PTR_VPD	0x08
    195 #define PROMDATA_DATA2		0x0a
    196 #endif  /* GEM_USE_LOCAL_MAC_ADDRESS */
    197 
    198 	aprint_naive(": Ethernet controller\n");
    199 
    200 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
    201 	sc->sc_chiprev = PCI_REVISION(pa->pa_class);
    202 	aprint_normal(": %s (rev. 0x%02x)\n", devinfo, sc->sc_chiprev);
    203 
    204 	/*
    205 	 * Some Sun GEMs/ERIs do have their intpin register bogusly set to 0,
    206 	 * although it should be 1. correct that.
    207 	 */
    208 	if (pa->pa_intrpin == 0)
    209 		pa->pa_intrpin = 1;
    210 
    211 	sc->sc_variant = GEM_UNKNOWN;
    212 
    213 	sc->sc_dmatag = pa->pa_dmat;
    214 
    215 	sc->sc_flags |= GEM_PCI;
    216 
    217 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN) {
    218 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_GEMNETWORK)
    219 			sc->sc_variant = GEM_SUN_GEM;
    220 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_ERINETWORK)
    221 			sc->sc_variant = GEM_SUN_ERI;
    222 	} else if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_APPLE) {
    223 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC ||
    224 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC2 ||
    225 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC3 ||
    226 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_SHASTA_GMAC ||
    227 		     PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_INTREPID2_GMAC)
    228 			sc->sc_variant = GEM_APPLE_GMAC;
    229 		if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_K2_GMAC)
    230 			sc->sc_variant = GEM_APPLE_K2_GMAC;
    231 	}
    232 
    233 	if (sc->sc_variant == GEM_UNKNOWN) {
    234 		aprint_error_dev(&sc->sc_dev, "unknown adaptor\n");
    235 		return;
    236 	}
    237 
    238 #define PCI_GEM_BASEADDR	(PCI_MAPREG_START + 0x00)
    239 
    240 	/* XXX Need to check for a 64-bit mem BAR? */
    241 	if (pci_mapreg_map(pa, PCI_GEM_BASEADDR,
    242 	    PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT, 0,
    243 	    &sc->sc_bustag, &sc->sc_h1, NULL, NULL) != 0)
    244 	{
    245 		aprint_error_dev(&sc->sc_dev, "unable to map device registers\n");
    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_dev(&sc->sc_dev, "unable to create bank 2 subregion\n");
    251 		return;
    252 	}
    253 
    254 #if GEM_USE_LOCAL_MAC_ADDRESS
    255 	/*
    256 	 * Dig out VPD (vital product data) and acquire Ethernet address.
    257 	 * The VPD of gem resides in the PCI PROM (PCI FCode).
    258 	 */
    259 	/*
    260 	 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later)
    261 	 * chapter 2 describes the data structure.
    262 	 */
    263 
    264 	enp = NULL;
    265 
    266 	if (sc->sc_variant == GEM_SUN_GEM &&
    267 	    (bus_space_subregion(sc->sc_bustag, sc->sc_h1,
    268 	    GEM_PCI_ROM_OFFSET, GEM_PCI_ROM_SIZE, &romh)) == 0) {
    269 
    270 		/* read PCI Expansion PROM Header */
    271 		bus_space_read_region_1(sc->sc_bustag,
    272 		    romh, 0, buf, sizeof buf);
    273 
    274 		/* Check for "shared-pins = serdes" in FCode. */
    275 		i = 0;
    276 		serdes = 0;
    277 		while (i < (sizeof buf) - sizeof "serdes") {
    278 			if (!serdes) {
    279 				if (isserdes(&buf[i]))
    280 					serdes = 1;
    281 			} else {
    282 				if (isshared_pins(&buf[i]))
    283 					serdes = 2;
    284 			}
    285 			if (serdes == 2) {
    286 				sc->sc_flags |= GEM_SERDES;
    287 				break;
    288 			}
    289 			i++;
    290 		}
    291 #ifdef GEM_DEBUG
    292 		/* PROM dump */
    293 		printf("%s: PROM dump (0x0000 to %04lx)\n", device_xname(&sc->sc_dev),
    294 		    (sizeof buf) - 1);
    295 		i = 0;
    296 		j = 0;
    297 		printf("  %04x  ", i);
    298 		while (i < sizeof buf) {
    299 			printf("%02x ", buf[i]);
    300 			if (i && !(i % 8))
    301 				printf(" ");
    302 			if (i && !(i % 16)) {
    303 				printf(" ");
    304 				while (j < i) {
    305 					if (buf[j] > 31 && buf[j] < 128)
    306 						printf("%c", buf[j]);
    307 					else
    308 						printf(".");
    309 					j++;
    310 				}
    311 				j = i;
    312 				printf("\n  %04x  ", i);
    313 				}
    314 			i++;
    315 		}
    316 		printf("\n");
    317 #endif
    318 
    319 		if (memcmp(buf, promhdr, sizeof promhdr) == 0 &&
    320 		    (dataoff = (buf[PROMHDR_PTR_DATA] |
    321 			(buf[PROMHDR_PTR_DATA + 1] << 8))) >= 0x1c) {
    322 
    323 			/* read PCI Expansion PROM Data */
    324 			bus_space_read_region_1(sc->sc_bustag, romh, dataoff,
    325 			    buf, 64);
    326 			if (memcmp(buf, promdat, sizeof promdat) == 0 &&
    327 			    gempromvalid(buf + PROMDATA_DATA2) &&
    328 			    (vpdoff = (buf[PROMDATA_PTR_VPD] |
    329 				(buf[PROMDATA_PTR_VPD + 1] << 8))) >= 0x1c) {
    330 
    331 				/*
    332 				 * The VPD of gem is not in PCI 2.2 standard
    333 				 * format.  The length in the resource header
    334 				 * is in big endian, and resources are not
    335 				 * properly terminated (only one resource
    336 				 * and no end tag).
    337 				 */
    338 				/* read PCI VPD */
    339 				bus_space_read_region_1(sc->sc_bustag, romh,
    340 				    vpdoff, buf, 64);
    341 				vpd = (void *)(buf + 3);
    342 				if (PCI_VPDRES_ISLARGE(buf[0]) &&
    343 				    PCI_VPDRES_LARGE_NAME(buf[0])
    344 					== PCI_VPDRES_TYPE_VPD &&
    345 				    vpd->vpd_key0 == 0x4e /* N */ &&
    346 				    vpd->vpd_key1 == 0x41 /* A */ &&
    347 				    vpd->vpd_len == ETHER_ADDR_LEN) {
    348 					/*
    349 					 * Ethernet address found
    350 					 */
    351 					enp = buf + 6;
    352 				}
    353 			}
    354 		}
    355 	}
    356 
    357 	if (enp)
    358 		memcpy(enaddr, enp, ETHER_ADDR_LEN);
    359 	else
    360 #endif  /* GEM_USE_LOCAL_MAC_ADDRESS */
    361 #ifdef __sparc__
    362 	{
    363 		if (strcmp(prom_getpropstring(PCITAG_NODE(pa->pa_tag),
    364 		    "shared-pins"), "serdes") == 0)
    365 			sc->sc_flags |= GEM_SERDES;
    366 		prom_getether(PCITAG_NODE(pa->pa_tag), enaddr);
    367 	}
    368 #else
    369 #ifdef macppc
    370 	{
    371 		int node;
    372 		char sp[6];	/* "serdes" */
    373 
    374 		node = pcidev_to_ofdev(pa->pa_pc, pa->pa_tag);
    375 		if (node == 0) {
    376 			aprint_error_dev(&sc->sc_dev, "unable to locate OpenFirmware node\n");
    377 			return;
    378 		}
    379 
    380 		OF_getprop(node, "shared-pins", sp, sizeof(sp));
    381 		if (isserdes(sp))
    382 			sc->sc_flags |= GEM_SERDES;
    383 		OF_getprop(node, "local-mac-address", enaddr, sizeof(enaddr));
    384 	}
    385 #else
    386 		printf("%s: no Ethernet address found\n", device_xname(&sc->sc_dev));
    387 #endif /* macppc */
    388 #endif /* __sparc__ */
    389 
    390 	if (pci_intr_map(pa, &ih) != 0) {
    391 		aprint_error_dev(&sc->sc_dev, "unable to map interrupt\n");
    392 		return;
    393 	}
    394 	intrstr = pci_intr_string(pa->pa_pc, ih);
    395 	gsc->gsc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_NET, gem_intr, sc);
    396 	if (gsc->gsc_ih == NULL) {
    397 		aprint_error_dev(&sc->sc_dev, "unable to establish interrupt");
    398 		if (intrstr != NULL)
    399 			aprint_normal(" at %s", intrstr);
    400 		aprint_normal("\n");
    401 		return;
    402 	}
    403 	aprint_normal_dev(&sc->sc_dev, "interrupting at %s\n", intrstr);
    404 
    405 	/* Finish off the attach. */
    406 	gem_attach(sc, enaddr);
    407 }
    408