1 /* $NetBSD: if_fxp_pci.c,v 1.33 2003/03/14 22:04:03 jdolecek Exp $ */ 2 3 /*- 4 * Copyright (c) 1997, 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * PCI bus front-end for the Intel i82557 fast Ethernet controller 42 * driver. Works with Intel Etherexpress Pro 10+, 100B, 100+ cards. 43 */ 44 45 #include <sys/cdefs.h> 46 __KERNEL_RCSID(0, "$NetBSD: if_fxp_pci.c,v 1.33 2003/03/14 22:04:03 jdolecek Exp $"); 47 48 #include "rnd.h" 49 50 #include <sys/param.h> 51 #include <sys/systm.h> 52 #include <sys/mbuf.h> 53 #include <sys/malloc.h> 54 #include <sys/kernel.h> 55 #include <sys/socket.h> 56 #include <sys/ioctl.h> 57 #include <sys/errno.h> 58 #include <sys/device.h> 59 60 #if NRND > 0 61 #include <sys/rnd.h> 62 #endif 63 64 #include <machine/endian.h> 65 66 #include <net/if.h> 67 #include <net/if_dl.h> 68 #include <net/if_media.h> 69 #include <net/if_ether.h> 70 71 #include <machine/bus.h> 72 #include <machine/intr.h> 73 74 #include <dev/mii/miivar.h> 75 76 #include <dev/ic/i82557reg.h> 77 #include <dev/ic/i82557var.h> 78 79 #include <dev/pci/pcivar.h> 80 #include <dev/pci/pcireg.h> 81 #include <dev/pci/pcidevs.h> 82 83 struct fxp_pci_softc { 84 struct fxp_softc psc_fxp; 85 86 pci_chipset_tag_t psc_pc; /* pci chipset tag */ 87 pcireg_t psc_regs[0x20>>2]; /* saved PCI config regs (sparse) */ 88 pcitag_t psc_tag; /* pci register tag */ 89 void *psc_powerhook; /* power hook */ 90 91 int psc_pwrmgmt_csr_reg; /* ACPI power management register */ 92 pcireg_t psc_pwrmgmt_csr; /* ...and the contents at D0 */ 93 }; 94 95 int fxp_pci_match __P((struct device *, struct cfdata *, void *)); 96 void fxp_pci_attach __P((struct device *, struct device *, void *)); 97 98 int fxp_pci_enable __P((struct fxp_softc *)); 99 void fxp_pci_disable __P((struct fxp_softc *)); 100 101 static void fxp_pci_confreg_restore __P((struct fxp_pci_softc *psc)); 102 static void fxp_pci_power __P((int why, void *arg)); 103 104 CFATTACH_DECL(fxp_pci, sizeof(struct fxp_pci_softc), 105 fxp_pci_match, fxp_pci_attach, NULL, NULL); 106 107 const struct fxp_pci_product { 108 u_int32_t fpp_prodid; /* PCI product ID */ 109 const char *fpp_name; /* device name */ 110 } fxp_pci_products[] = { 111 { PCI_PRODUCT_INTEL_82557, 112 "Intel i82557 Ethernet" }, 113 { PCI_PRODUCT_INTEL_82559ER, 114 "Intel i82559ER Ethernet" }, 115 { PCI_PRODUCT_INTEL_IN_BUSINESS, 116 "Intel InBusiness Ethernet" }, 117 { PCI_PRODUCT_INTEL_82801BA_LAN, 118 "Intel i82562 Ethernet" }, 119 { PCI_PRODUCT_INTEL_82801E_LAN_1, 120 "Intel i82559 Ethernet" }, 121 { PCI_PRODUCT_INTEL_82801E_LAN_2, 122 "Intel i82559 Ethernet" }, 123 { PCI_PRODUCT_INTEL_PRO_100_VE_0, 124 "Intel PRO/100 VE Network Controller" }, 125 { PCI_PRODUCT_INTEL_PRO_100_VE_1, 126 "Intel PRO/100 VE Network Controller" }, 127 { PCI_PRODUCT_INTEL_PRO_100_VE_2, 128 "Intel PRO/100 VE Network Controller with 82562ET/EZ PHY" }, 129 { PCI_PRODUCT_INTEL_PRO_100_VE_3, 130 "Intel PRO/100 VE Network Controller with 82562ET/EZ (CNR) PHY" }, 131 { PCI_PRODUCT_INTEL_PRO_100_VE_4, 132 "Intel PRO/100 VE (MOB) Network Controller" }, 133 { PCI_PRODUCT_INTEL_PRO_100_VM_0, 134 "Intel PRO/100 VM Network Controller" }, 135 { PCI_PRODUCT_INTEL_PRO_100_VM_1, 136 "Intel PRO/100 VM Network Controller" }, 137 { PCI_PRODUCT_INTEL_PRO_100_VM_2, 138 "Intel PRO/100 VM Network Controller" }, 139 { PCI_PRODUCT_INTEL_PRO_100_VM_3, 140 "Intel PRO/100 VM Network Controller with 82562EM/EX PHY" }, 141 { PCI_PRODUCT_INTEL_PRO_100_VM_4, 142 "Intel PRO/100 VM Network Controller with 82562EM/EX (CNR) PHY" }, 143 { PCI_PRODUCT_INTEL_PRO_100_M, 144 "Intel PRO/100 M Network Controller" }, 145 { 0, 146 NULL }, 147 }; 148 149 static const struct fxp_pci_product * 150 fxp_pci_lookup(const struct pci_attach_args *pa) 151 { 152 const struct fxp_pci_product *fpp; 153 154 if (PCI_VENDOR(pa->pa_id) != PCI_VENDOR_INTEL) 155 return (NULL); 156 157 for (fpp = fxp_pci_products; fpp->fpp_name != NULL; fpp++) 158 if (PCI_PRODUCT(pa->pa_id) == fpp->fpp_prodid) 159 return (fpp); 160 161 return (NULL); 162 } 163 164 int 165 fxp_pci_match(parent, match, aux) 166 struct device *parent; 167 struct cfdata *match; 168 void *aux; 169 { 170 struct pci_attach_args *pa = aux; 171 172 if (fxp_pci_lookup(pa) != NULL) 173 return (1); 174 175 return (0); 176 } 177 178 /* 179 * Restore PCI configuration registers that may have been clobbered. 180 * This is necessary due to bugs on the Sony VAIO Z505-series on-board 181 * ethernet, after an APM suspend/resume, as well as after an ACPI 182 * D3->D0 transition. We call this function from a power hook after 183 * APM resume events, as well as after the ACPI D3->D0 transition. 184 */ 185 static void 186 fxp_pci_confreg_restore(psc) 187 struct fxp_pci_softc *psc; 188 { 189 pcireg_t reg; 190 191 #if 0 192 /* 193 * Check to see if the command register is blank -- if so, then 194 * we'll assume that all the clobberable-registers have been 195 * clobbered. 196 */ 197 198 /* 199 * In general, the above metric is accurate. Unfortunately, 200 * it is inaccurate across a hibernation. Ideally APM/ACPI 201 * code should take note of hibernation events and execute 202 * a hibernation wakeup hook, but at present a hibernation wake 203 * is indistinguishable from a suspend wake. 204 */ 205 206 if (((reg = pci_conf_read(psc->psc_pc, psc->psc_tag, 207 PCI_COMMAND_STATUS_REG)) & 0xffff) != 0) 208 return; 209 #else 210 reg = pci_conf_read(psc->psc_pc, psc->psc_tag, PCI_COMMAND_STATUS_REG); 211 #endif 212 213 pci_conf_write(psc->psc_pc, psc->psc_tag, 214 PCI_COMMAND_STATUS_REG, 215 (reg & 0xffff0000) | 216 (psc->psc_regs[PCI_COMMAND_STATUS_REG>>2] & 0xffff)); 217 pci_conf_write(psc->psc_pc, psc->psc_tag, PCI_BHLC_REG, 218 psc->psc_regs[PCI_BHLC_REG>>2]); 219 pci_conf_write(psc->psc_pc, psc->psc_tag, PCI_MAPREG_START+0x0, 220 psc->psc_regs[(PCI_MAPREG_START+0x0)>>2]); 221 pci_conf_write(psc->psc_pc, psc->psc_tag, PCI_MAPREG_START+0x4, 222 psc->psc_regs[(PCI_MAPREG_START+0x4)>>2]); 223 pci_conf_write(psc->psc_pc, psc->psc_tag, PCI_MAPREG_START+0x8, 224 psc->psc_regs[(PCI_MAPREG_START+0x8)>>2]); 225 } 226 227 228 /* 229 * Power handler routine. Called when the system is transitioning into/out 230 * of power save modes. We restore the (bashed) PCI configuration registers 231 * on a resume. 232 */ 233 static void 234 fxp_pci_power(why, arg) 235 int why; 236 void *arg; 237 { 238 struct fxp_pci_softc *psc = arg; 239 240 if (why == PWR_RESUME) 241 fxp_pci_confreg_restore(psc); 242 } 243 244 void 245 fxp_pci_attach(parent, self, aux) 246 struct device *parent, *self; 247 void *aux; 248 { 249 struct fxp_pci_softc *psc = (struct fxp_pci_softc *)self; 250 struct fxp_softc *sc = (struct fxp_softc *)self; 251 struct pci_attach_args *pa = aux; 252 pci_chipset_tag_t pc = pa->pa_pc; 253 pci_intr_handle_t ih; 254 const struct fxp_pci_product *fpp; 255 const char *intrstr = NULL; 256 bus_space_tag_t iot, memt; 257 bus_space_handle_t ioh, memh; 258 int ioh_valid, memh_valid; 259 bus_addr_t addr; 260 bus_size_t size; 261 int flags; 262 int pci_pwrmgmt_cap_reg; 263 264 aprint_naive(": Ethernet controller\n"); 265 266 /* 267 * Map control/status registers. 268 */ 269 ioh_valid = (pci_mapreg_map(pa, FXP_PCI_IOBA, 270 PCI_MAPREG_TYPE_IO, 0, 271 &iot, &ioh, NULL, NULL) == 0); 272 273 /* 274 * Version 2.1 of the PCI spec, page 196, "Address Maps": 275 * 276 * Prefetchable 277 * 278 * Set to one if there are no side effects on reads, the 279 * device returns all bytes regardless of the byte enables, 280 * and host bridges can merge processor writes into this 281 * range without causing errors. Bit must be set to zero 282 * otherwise. 283 * 284 * The 82557 incorrectly sets the "prefetchable" bit, resulting 285 * in errors on systems which will do merged reads and writes. 286 * These errors manifest themselves as all-bits-set when reading 287 * from the EEPROM or other < 4 byte registers. 288 * 289 * We must work around this problem by always forcing the mapping 290 * for memory space to be uncacheable. On systems which cannot 291 * create an uncacheable mapping (because the firmware mapped it 292 * into only cacheable/prefetchable space due to the "prefetchable" 293 * bit), we can fall back onto i/o mapped access. 294 */ 295 memh_valid = 0; 296 memt = pa->pa_memt; 297 if (((pa->pa_flags & PCI_FLAGS_MEM_ENABLED) != 0) && 298 pci_mapreg_info(pa->pa_pc, pa->pa_tag, FXP_PCI_MMBA, 299 PCI_MAPREG_TYPE_MEM|PCI_MAPREG_MEM_TYPE_32BIT, 300 &addr, &size, &flags) == 0) { 301 flags &= ~BUS_SPACE_MAP_PREFETCHABLE; 302 if (bus_space_map(memt, addr, size, flags, &memh) == 0) 303 memh_valid = 1; 304 } 305 306 if (memh_valid) { 307 sc->sc_st = memt; 308 sc->sc_sh = memh; 309 } else if (ioh_valid) { 310 sc->sc_st = iot; 311 sc->sc_sh = ioh; 312 } else { 313 aprint_error(": unable to map device registers\n"); 314 return; 315 } 316 317 sc->sc_dmat = pa->pa_dmat; 318 319 fpp = fxp_pci_lookup(pa); 320 if (fpp == NULL) { 321 printf("\n"); 322 panic("fxp_pci_attach: impossible"); 323 } 324 325 sc->sc_rev = PCI_REVISION(pa->pa_class); 326 327 switch (fpp->fpp_prodid) { 328 case PCI_PRODUCT_INTEL_82557: 329 case PCI_PRODUCT_INTEL_82559ER: 330 case PCI_PRODUCT_INTEL_IN_BUSINESS: 331 { 332 const char *chipname = NULL; 333 334 if (sc->sc_rev >= FXP_REV_82558_A4) { 335 chipname = "i82558 Ethernet"; 336 /* 337 * Enable the MWI command for memory writes. 338 */ 339 if (pa->pa_flags & PCI_FLAGS_MWI_OKAY) 340 sc->sc_flags |= FXPF_MWI; 341 } 342 if (sc->sc_rev >= FXP_REV_82559_A0) 343 chipname = "i82559 Ethernet"; 344 if (sc->sc_rev >= FXP_REV_82559S_A) 345 chipname = "i82559S Ethernet"; 346 if (sc->sc_rev >= FXP_REV_82550) 347 chipname = "i82550 Ethernet"; 348 349 /* 350 * Mark all i82559 and i82550 revisions as having 351 * the "resume bug". See i82557.c for details. 352 */ 353 if (sc->sc_rev >= FXP_REV_82559_A0) 354 sc->sc_flags |= FXPF_HAS_RESUME_BUG; 355 356 aprint_normal(": %s, rev %d\n", chipname != NULL ? chipname : 357 fpp->fpp_name, sc->sc_rev); 358 break; 359 } 360 361 case PCI_PRODUCT_INTEL_82801BA_LAN: 362 aprint_normal(": %s, rev %d\n", fpp->fpp_name, sc->sc_rev); 363 364 /* 365 * The 82801BA Ethernet has a bug which requires us to send a 366 * NOP before a CU_RESUME if we're in 10baseT mode. 367 */ 368 if (fpp->fpp_prodid == PCI_PRODUCT_INTEL_82801BA_LAN) 369 sc->sc_flags |= FXPF_HAS_RESUME_BUG; 370 break; 371 372 case PCI_PRODUCT_INTEL_PRO_100_VE_0: 373 case PCI_PRODUCT_INTEL_PRO_100_VE_1: 374 case PCI_PRODUCT_INTEL_PRO_100_VM_0: 375 case PCI_PRODUCT_INTEL_PRO_100_VM_1: 376 case PCI_PRODUCT_INTEL_82562EH_HPNA_0: 377 case PCI_PRODUCT_INTEL_82562EH_HPNA_1: 378 case PCI_PRODUCT_INTEL_82562EH_HPNA_2: 379 case PCI_PRODUCT_INTEL_PRO_100_VM_2: 380 case PCI_PRODUCT_INTEL_PRO_100_VM_3: 381 case PCI_PRODUCT_INTEL_PRO_100_VM_4: 382 aprint_normal(": %s, rev %d\n", fpp->fpp_name, sc->sc_rev); 383 384 /* 385 * ICH3 chips apparently have problems with the enhanced 386 * features, so just treat them as an i82557. It also 387 * has the resume bug that the ICH2 has. 388 */ 389 sc->sc_rev = 1; 390 sc->sc_flags |= FXPF_HAS_RESUME_BUG; 391 break; 392 case PCI_PRODUCT_INTEL_82801E_LAN_1: 393 case PCI_PRODUCT_INTEL_82801E_LAN_2: 394 aprint_normal(": %s, rev %d\n", fpp->fpp_name, sc->sc_rev); 395 396 /* 397 * XXX We have to read the C-ICH's developer's manual 398 * in detail 399 */ 400 break; 401 } 402 403 /* Make sure bus-mastering is enabled. */ 404 pci_conf_write(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, 405 pci_conf_read(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG) | 406 PCI_COMMAND_MASTER_ENABLE); 407 408 /* 409 * Under some circumstances (such as APM suspend/resume 410 * cycles, and across ACPI power state changes), the 411 * i82257-family can lose the contents of critical PCI 412 * configuration registers, causing the card to be 413 * non-responsive and useless. This occurs on the Sony VAIO 414 * Z505-series, among others. Preserve them here so they can 415 * be later restored (by fxp_pci_confreg_restore()). 416 */ 417 psc->psc_pc = pc; 418 psc->psc_tag = pa->pa_tag; 419 psc->psc_regs[PCI_COMMAND_STATUS_REG>>2] = 420 pci_conf_read(pc, pa->pa_tag, PCI_COMMAND_STATUS_REG); 421 psc->psc_regs[PCI_BHLC_REG>>2] = 422 pci_conf_read(pc, pa->pa_tag, PCI_BHLC_REG); 423 psc->psc_regs[(PCI_MAPREG_START+0x0)>>2] = 424 pci_conf_read(pc, pa->pa_tag, PCI_MAPREG_START+0x0); 425 psc->psc_regs[(PCI_MAPREG_START+0x4)>>2] = 426 pci_conf_read(pc, pa->pa_tag, PCI_MAPREG_START+0x4); 427 psc->psc_regs[(PCI_MAPREG_START+0x8)>>2] = 428 pci_conf_read(pc, pa->pa_tag, PCI_MAPREG_START+0x8); 429 430 /* 431 * Work around BIOS ACPI bugs where the chip is inadvertantly 432 * left in ACPI D3 (lowest power state). First confirm the device 433 * supports ACPI power management, then move it to the D0 (fully 434 * functional) state if it is not already there. 435 */ 436 if (pci_get_capability(pc, pa->pa_tag, PCI_CAP_PWRMGMT, 437 &pci_pwrmgmt_cap_reg, 0)) { 438 pcireg_t reg; 439 440 sc->sc_enable = fxp_pci_enable; 441 sc->sc_disable = fxp_pci_disable; 442 443 psc->psc_pwrmgmt_csr_reg = pci_pwrmgmt_cap_reg + PCI_PMCSR; 444 reg = pci_conf_read(pc, pa->pa_tag, psc->psc_pwrmgmt_csr_reg); 445 psc->psc_pwrmgmt_csr = (reg & ~PCI_PMCSR_STATE_MASK) | 446 PCI_PMCSR_STATE_D0; 447 if ((reg & PCI_PMCSR_STATE_MASK) != PCI_PMCSR_STATE_D0) 448 pci_conf_write(pc, pa->pa_tag, psc->psc_pwrmgmt_csr_reg, 449 psc->psc_pwrmgmt_csr); 450 } 451 /* Restore PCI configuration registers. */ 452 fxp_pci_confreg_restore(psc); 453 454 sc->sc_enabled = 1; 455 456 /* 457 * Map and establish our interrupt. 458 */ 459 if (pci_intr_map(pa, &ih)) { 460 aprint_error("%s: couldn't map interrupt\n", 461 sc->sc_dev.dv_xname); 462 return; 463 } 464 intrstr = pci_intr_string(pc, ih); 465 sc->sc_ih = pci_intr_establish(pc, ih, IPL_NET, fxp_intr, sc); 466 if (sc->sc_ih == NULL) { 467 aprint_error("%s: couldn't establish interrupt", 468 sc->sc_dev.dv_xname); 469 if (intrstr != NULL) 470 aprint_normal(" at %s", intrstr); 471 aprint_normal("\n"); 472 return; 473 } 474 aprint_normal("%s: interrupting at %s\n", sc->sc_dev.dv_xname, intrstr); 475 476 /* Finish off the attach. */ 477 fxp_attach(sc); 478 if (sc->sc_disable != NULL) 479 fxp_disable(sc); 480 481 /* Add a suspend hook to restore PCI config state */ 482 psc->psc_powerhook = powerhook_establish(fxp_pci_power, psc); 483 if (psc->psc_powerhook == NULL) 484 aprint_error( 485 "%s: WARNING: unable to establish pci power hook\n", 486 sc->sc_dev.dv_xname); 487 } 488 489 int 490 fxp_pci_enable(struct fxp_softc *sc) 491 { 492 struct fxp_pci_softc *psc = (void *) sc; 493 494 #if 0 495 printf("%s: going to power state D0\n", sc->sc_dev.dv_xname); 496 #endif 497 498 /* Bring the device into D0 power state. */ 499 pci_conf_write(psc->psc_pc, psc->psc_tag, 500 psc->psc_pwrmgmt_csr_reg, psc->psc_pwrmgmt_csr); 501 502 /* Now restore the configuration registers. */ 503 fxp_pci_confreg_restore(psc); 504 505 return (0); 506 } 507 508 void 509 fxp_pci_disable(struct fxp_softc *sc) 510 { 511 struct fxp_pci_softc *psc = (void *) sc; 512 513 /* 514 * for some 82558_A4 and 82558_B0, entering D3 state makes 515 * media detection disordered. 516 */ 517 if (sc->sc_rev <= FXP_REV_82558_B0) 518 return; 519 520 #if 0 521 printf("%s: going to power state D3\n", sc->sc_dev.dv_xname); 522 #endif 523 524 /* Put the device into D3 state. */ 525 pci_conf_write(psc->psc_pc, psc->psc_tag, 526 psc->psc_pwrmgmt_csr_reg, (psc->psc_pwrmgmt_csr & 527 ~PCI_PMCSR_STATE_MASK) | PCI_PMCSR_STATE_D3); 528 } 529