1 /* $NetBSD: if_gem_pci.c,v 1.27 2008/02/01 10:58:28 jdc 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.27 2008/02/01 10:58:28 jdc 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 #ifdef GEM_DEBUG 179 int i, j; 180 #endif 181 struct pci_vpd *vpd; 182 static const u_int8_t promhdr[] = { 0x55, 0xaa }; 183 #define PROMHDR_PTR_DATA 0x18 184 static const u_int8_t promdat[] = { 185 0x50, 0x43, 0x49, 0x52, /* "PCIR" */ 186 PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8, 187 PCI_PRODUCT_SUN_GEMNETWORK & 0xff, 188 PCI_PRODUCT_SUN_GEMNETWORK >> 8 189 }; 190 #define PROMDATA_PTR_VPD 0x08 191 #define PROMDATA_DATA2 0x0a 192 #endif /* GEM_USE_LOCAL_MAC_ADDRESS */ 193 194 aprint_naive(": Ethernet controller\n"); 195 196 pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo)); 197 sc->sc_chiprev = PCI_REVISION(pa->pa_class); 198 aprint_normal(": %s (rev. 0x%02x)\n", devinfo, sc->sc_chiprev); 199 200 /* 201 * Some Sun GEMs/ERIs do have their intpin register bogusly set to 0, 202 * although it should be 1. correct that. 203 */ 204 if (pa->pa_intrpin == 0) 205 pa->pa_intrpin = 1; 206 207 sc->sc_variant = GEM_UNKNOWN; 208 209 sc->sc_dmatag = pa->pa_dmat; 210 211 sc->sc_flags |= GEM_PCI; 212 213 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN) { 214 if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_GEMNETWORK) 215 sc->sc_variant = GEM_SUN_GEM; 216 if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_ERINETWORK) 217 sc->sc_variant = GEM_SUN_ERI; 218 } else if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_APPLE) { 219 if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC || 220 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC2 || 221 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_GMAC3 || 222 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_SHASTA_GMAC || 223 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_INTREPID2_GMAC) 224 sc->sc_variant = GEM_APPLE_GMAC; 225 if (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_APPLE_K2_GMAC) 226 sc->sc_variant = GEM_APPLE_K2_GMAC; 227 } 228 229 if (sc->sc_variant == GEM_UNKNOWN) { 230 aprint_error("%s: unknown adaptor\n", sc->sc_dev.dv_xname); 231 return; 232 } 233 234 #define PCI_GEM_BASEADDR (PCI_MAPREG_START + 0x00) 235 236 /* XXX Need to check for a 64-bit mem BAR? */ 237 if (pci_mapreg_map(pa, PCI_GEM_BASEADDR, 238 PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT, 0, 239 &sc->sc_bustag, &sc->sc_h1, NULL, NULL) != 0) 240 { 241 aprint_error("%s: unable to map device registers\n", 242 sc->sc_dev.dv_xname); 243 return; 244 } 245 if (bus_space_subregion(sc->sc_bustag, sc->sc_h1, 246 GEM_PCI_BANK2_OFFSET, GEM_PCI_BANK2_SIZE, &sc->sc_h2)) { 247 aprint_error("%s: unable to create bank 2 subregion\n", 248 sc->sc_dev.dv_xname); 249 return; 250 } 251 252 #if GEM_USE_LOCAL_MAC_ADDRESS 253 /* 254 * Dig out VPD (vital product data) and acquire Ethernet address. 255 * The VPD of gem resides in the PCI PROM (PCI FCode). 256 */ 257 /* 258 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later) 259 * chapter 2 describes the data structure. 260 */ 261 262 enp = NULL; 263 264 if (sc->sc_variant == GEM_SUN_GEM && 265 (bus_space_subregion(sc->sc_bustag, sc->sc_h1, 266 GEM_PCI_ROM_OFFSET, GEM_PCI_ROM_SIZE, &romh)) == 0) { 267 268 /* read PCI Expansion PROM Header */ 269 bus_space_read_region_1(sc->sc_bustag, 270 romh, 0, buf, sizeof buf); 271 272 /* Check for "shared-pins = serdes" in FCode. */ 273 i = 0; 274 serdes = 0; 275 while (i < (sizeof buf) - sizeof "serdes") { 276 if (!serdes) { 277 if (isserdes(&buf[i])) 278 serdes = 1; 279 } else { 280 if (isshared_pins(&buf[i])) 281 serdes = 2; 282 } 283 if (serdes == 2) { 284 sc->sc_flags |= GEM_SERDES; 285 break; 286 } 287 i++; 288 } 289 #ifdef GEM_DEBUG 290 /* PROM dump */ 291 printf("%s: PROM dump (0x0000 to %04lx)\n", sc->sc_dev.dv_xname, 292 (sizeof buf) - 1); 293 i = 0; 294 j = 0; 295 printf(" %04x ", i); 296 while (i < sizeof buf) { 297 printf("%02x ", buf[i]); 298 if (i && !(i % 8)) 299 printf(" "); 300 if (i && !(i % 16)) { 301 printf(" "); 302 while (j < i) { 303 if (buf[j] > 31 && buf[j] < 128) 304 printf("%c", buf[j]); 305 else 306 printf("."); 307 j++; 308 } 309 j = i; 310 printf("\n %04x ", i); 311 } 312 i++; 313 } 314 printf("\n"); 315 #endif 316 317 if (memcmp(buf, promhdr, sizeof promhdr) == 0 && 318 (dataoff = (buf[PROMHDR_PTR_DATA] | 319 (buf[PROMHDR_PTR_DATA + 1] << 8))) >= 0x1c) { 320 321 /* read PCI Expansion PROM Data */ 322 bus_space_read_region_1(sc->sc_bustag, romh, dataoff, 323 buf, 64); 324 if (memcmp(buf, promdat, sizeof promdat) == 0 && 325 gempromvalid(buf + PROMDATA_DATA2) && 326 (vpdoff = (buf[PROMDATA_PTR_VPD] | 327 (buf[PROMDATA_PTR_VPD + 1] << 8))) >= 0x1c) { 328 329 /* 330 * The VPD of gem is not in PCI 2.2 standard 331 * format. The length in the resource header 332 * is in big endian, and resources are not 333 * properly terminated (only one resource 334 * and no end tag). 335 */ 336 /* read PCI VPD */ 337 bus_space_read_region_1(sc->sc_bustag, romh, 338 vpdoff, buf, 64); 339 vpd = (void *)(buf + 3); 340 if (PCI_VPDRES_ISLARGE(buf[0]) && 341 PCI_VPDRES_LARGE_NAME(buf[0]) 342 == PCI_VPDRES_TYPE_VPD && 343 vpd->vpd_key0 == 0x4e /* N */ && 344 vpd->vpd_key1 == 0x41 /* A */ && 345 vpd->vpd_len == ETHER_ADDR_LEN) { 346 /* 347 * Ethernet address found 348 */ 349 enp = buf + 6; 350 } 351 } 352 } 353 } 354 355 if (enp) 356 memcpy(enaddr, enp, ETHER_ADDR_LEN); 357 else 358 #endif /* GEM_USE_LOCAL_MAC_ADDRESS */ 359 #ifdef __sparc__ 360 { 361 if (strcmp(prom_getpropstring(PCITAG_NODE(pa->pa_tag), 362 "shared-pins"), "serdes") == 0) 363 sc->sc_flags |= GEM_SERDES; 364 prom_getether(PCITAG_NODE(pa->pa_tag), enaddr); 365 } 366 #else 367 #ifdef macppc 368 { 369 int node; 370 char sp[6]; /* "serdes" */ 371 372 node = pcidev_to_ofdev(pa->pa_pc, pa->pa_tag); 373 if (node == 0) { 374 aprint_error("%s: unable to locate OpenFirmware node\n", 375 sc->sc_dev.dv_xname); 376 return; 377 } 378 379 OF_getprop(node, "shared-pins", sp, sizeof(sp)); 380 if (isserdes(sp)) 381 sc->sc_flags |= GEM_SERDES; 382 OF_getprop(node, "local-mac-address", enaddr, sizeof(enaddr)); 383 } 384 #else 385 printf("%s: no Ethernet address found\n", sc->sc_dev.dv_xname); 386 #endif /* macppc */ 387 #endif /* __sparc__ */ 388 389 if (pci_intr_map(pa, &ih) != 0) { 390 aprint_error("%s: unable to map interrupt\n", 391 sc->sc_dev.dv_xname); 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("%s: unable to establish interrupt", 398 sc->sc_dev.dv_xname); 399 if (intrstr != NULL) 400 aprint_normal(" at %s", intrstr); 401 aprint_normal("\n"); 402 return; 403 } 404 aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr); 405 406 /* Finish off the attach. */ 407 gem_attach(sc, enaddr); 408 } 409