1 /* $NetBSD: if_rtk_cardbus.c,v 1.39 2010/01/18 18:52:35 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2000 Masanori Kanaoka 5 * 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. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 /* 31 * if_rtk_cardbus.c: 32 * Cardbus specific routines for Realtek 8139 ethernet adapter. 33 * Tested for 34 * - elecom-Laneed LD-10/100CBA (Accton MPX5030) 35 * - MELCO LPC3-TX-CB (Realtek 8139) 36 */ 37 38 #include <sys/cdefs.h> 39 __KERNEL_RCSID(0, "$NetBSD: if_rtk_cardbus.c,v 1.39 2010/01/18 18:52:35 pooka Exp $"); 40 41 #include "opt_inet.h" 42 #include "rnd.h" 43 44 #include <sys/param.h> 45 #include <sys/systm.h> 46 #include <sys/callout.h> 47 #include <sys/device.h> 48 #include <sys/sockio.h> 49 #include <sys/mbuf.h> 50 #include <sys/malloc.h> 51 #include <sys/kernel.h> 52 #include <sys/socket.h> 53 54 #include <net/if.h> 55 #include <net/if_arp.h> 56 #include <net/if_ether.h> 57 #include <net/if_dl.h> 58 #include <net/if_media.h> 59 #ifdef INET 60 #include <netinet/in.h> 61 #include <netinet/if_inarp.h> 62 #endif 63 64 #if NRND > 0 65 #include <sys/rnd.h> 66 #endif 67 68 #include <sys/bus.h> 69 70 #include <dev/pci/pcireg.h> 71 #include <dev/pci/pcivar.h> 72 #include <dev/pci/pcidevs.h> 73 74 #include <dev/cardbus/cardbusvar.h> 75 #include <dev/pci/pcidevs.h> 76 77 #include <dev/mii/mii.h> 78 #include <dev/mii/miivar.h> 79 80 /* 81 * Default to using PIO access for this driver. On SMP systems, 82 * there appear to be problems with memory mapped mode: it looks like 83 * doing too many memory mapped access back to back in rapid succession 84 * can hang the bus. I'm inclined to blame this on crummy design/construction 85 * on the part of Realtek. Memory mapped mode does appear to work on 86 * uniprocessor systems though. 87 */ 88 #define RTK_USEIOSPACE 89 90 #include <dev/ic/rtl81x9reg.h> 91 #include <dev/ic/rtl81x9var.h> 92 93 /* 94 * Various supported device vendors/types and their names. 95 */ 96 static const struct rtk_type rtk_cardbus_devs[] = { 97 { PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030, 98 RTK_8139, "Accton MPX 5030/5038 10/100BaseTX" }, 99 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE690TXD, 100 RTK_8139, "D-Link DFE-690TXD 10/100BaseTX" }, 101 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8138, 102 RTK_8139, "Realtek 8138 10/100BaseTX" }, 103 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139, 104 RTK_8139, "Realtek 8139 10/100BaseTX" }, 105 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_CB_TXD, 106 RTK_8139, "Corega FEther CB-TXD 10/100BaseTX" }, 107 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_2CB_TXD, 108 RTK_8139, "Corega FEther II CB-TXD 10/100BaseTX" }, 109 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3603_TX, 110 RTK_8139, "Planex FNW-3603 10/100BaseTX" }, 111 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3800_TX, 112 RTK_8139, "Planex 10/100BaseTX FNW-3800-TX" }, 113 { PCI_VENDOR_ABOCOM, PCI_PRODUCT_ABOCOM_FE2000VX, 114 RTK_8139, "AboCom FE2000VX 10/100BaseTX" }, 115 116 { 0, 0, 0, NULL } 117 }; 118 119 static int rtk_cardbus_match(device_t, cfdata_t, void *); 120 static void rtk_cardbus_attach(device_t, device_t, void *); 121 static int rtk_cardbus_detach(device_t, int); 122 123 struct rtk_cardbus_softc { 124 struct rtk_softc sc_rtk; /* real rtk softc */ 125 126 /* CardBus-specific goo. */ 127 void *sc_ih; 128 cardbus_devfunc_t sc_ct; 129 cardbustag_t sc_tag; 130 int sc_csr; 131 int sc_cben; 132 int sc_bar_reg; 133 pcireg_t sc_bar_val; 134 bus_size_t sc_mapsize; 135 cardbus_intr_line_t sc_intrline; 136 }; 137 138 CFATTACH_DECL_NEW(rtk_cardbus, sizeof(struct rtk_cardbus_softc), 139 rtk_cardbus_match, rtk_cardbus_attach, rtk_cardbus_detach, rtk_activate); 140 141 const struct rtk_type *rtk_cardbus_lookup(const struct cardbus_attach_args *); 142 143 void rtk_cardbus_setup(struct rtk_cardbus_softc *); 144 145 int rtk_cardbus_enable(struct rtk_softc *); 146 void rtk_cardbus_disable(struct rtk_softc *); 147 void rtk_cardbus_power(struct rtk_softc *, int); 148 149 const struct rtk_type * 150 rtk_cardbus_lookup(const struct cardbus_attach_args *ca) 151 { 152 const struct rtk_type *t; 153 154 for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){ 155 if (CARDBUS_VENDOR(ca->ca_id) == t->rtk_vid && 156 CARDBUS_PRODUCT(ca->ca_id) == t->rtk_did) { 157 return t; 158 } 159 } 160 return NULL; 161 } 162 163 int 164 rtk_cardbus_match(device_t parent, cfdata_t cf, void *aux) 165 { 166 struct cardbus_attach_args *ca = aux; 167 168 if (rtk_cardbus_lookup(ca) != NULL) 169 return 1; 170 171 return 0; 172 } 173 174 175 void 176 rtk_cardbus_attach(device_t parent, device_t self, void *aux) 177 { 178 struct rtk_cardbus_softc *csc = device_private(self); 179 struct rtk_softc *sc = &csc->sc_rtk; 180 struct cardbus_attach_args *ca = aux; 181 cardbus_devfunc_t ct = ca->ca_ct; 182 const struct rtk_type *t; 183 bus_addr_t adr; 184 185 sc->sc_dev = self; 186 sc->sc_dmat = ca->ca_dmat; 187 csc->sc_ct = ct; 188 csc->sc_tag = ca->ca_tag; 189 csc->sc_intrline = ca->ca_intrline; 190 191 t = rtk_cardbus_lookup(ca); 192 if (t == NULL) { 193 aprint_error("\n"); 194 panic("%s: impossible", __func__); 195 } 196 aprint_normal(": %s\n", t->rtk_name); 197 198 /* 199 * Power management hooks. 200 */ 201 sc->sc_enable = rtk_cardbus_enable; 202 sc->sc_disable = rtk_cardbus_disable; 203 204 /* 205 * Map control/status registers. 206 */ 207 csc->sc_csr = CARDBUS_COMMAND_MASTER_ENABLE; 208 #ifdef RTK_USEIOSPACE 209 if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, CARDBUS_MAPREG_TYPE_IO, 0, 210 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) { 211 #if rbus 212 #else 213 (*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr+csc->sc_mapsize); 214 #endif 215 csc->sc_cben = CARDBUS_IO_ENABLE; 216 csc->sc_csr |= CARDBUS_COMMAND_IO_ENABLE; 217 csc->sc_bar_reg = RTK_PCI_LOIO; 218 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO; 219 } 220 #else 221 if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, CARDBUS_MAPREG_TYPE_MEM, 0, 222 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) { 223 #if rbus 224 #else 225 (*ct->ct_cf->cardbus_mem_open)(cc, 0, adr, adr+csc->sc_mapsize); 226 #endif 227 csc->sc_cben = CARDBUS_MEM_ENABLE; 228 csc->sc_csr |= CARDBUS_COMMAND_MEM_ENABLE; 229 csc->sc_bar_reg = RTK_PCI_LOMEM; 230 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_MEM; 231 } 232 #endif 233 else { 234 aprint_error_dev(self, " unable to map deviceregisters\n"); 235 return; 236 } 237 /* 238 * Handle power management nonsense and initialize the 239 * configuration registers. 240 */ 241 rtk_cardbus_setup(csc); 242 243 rtk_attach(sc); 244 245 if (pmf_device_register(self, NULL, NULL)) 246 pmf_class_network_register(self, &sc->ethercom.ec_if); 247 else 248 aprint_error_dev(self, "couldn't establish power handler\n"); 249 250 /* 251 * Power down the socket. 252 */ 253 Cardbus_function_disable(csc->sc_ct); 254 } 255 256 int 257 rtk_cardbus_detach(device_t self, int flags) 258 { 259 struct rtk_cardbus_softc *csc = device_private(self); 260 struct rtk_softc *sc = &csc->sc_rtk; 261 struct cardbus_devfunc *ct = csc->sc_ct; 262 int rv; 263 264 #ifdef DIAGNOSTIC 265 if (ct == NULL) 266 panic("%s: data structure lacks", device_xname(self)); 267 #endif 268 rv = rtk_detach(sc); 269 if (rv) 270 return rv; 271 /* 272 * Unhook the interrupt handler. 273 */ 274 if (csc->sc_ih != NULL) 275 cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, csc->sc_ih); 276 277 /* 278 * Release bus space and close window. 279 */ 280 if (csc->sc_bar_reg != 0) 281 Cardbus_mapreg_unmap(ct, csc->sc_bar_reg, 282 sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize); 283 284 return 0; 285 } 286 287 void 288 rtk_cardbus_setup(struct rtk_cardbus_softc *csc) 289 { 290 struct rtk_softc *sc = &csc->sc_rtk; 291 cardbus_devfunc_t ct = csc->sc_ct; 292 cardbus_chipset_tag_t cc = ct->ct_cc; 293 cardbus_function_tag_t cf = ct->ct_cf; 294 pcireg_t reg, command; 295 int pmreg; 296 297 /* 298 * Handle power management nonsense. 299 */ 300 if (cardbus_get_capability(cc, cf, csc->sc_tag, 301 PCI_CAP_PWRMGMT, &pmreg, 0)) { 302 command = cardbus_conf_read(cc, cf, csc->sc_tag, 303 pmreg + PCI_PMCSR); 304 if (command & PCI_PMCSR_STATE_MASK) { 305 pcireg_t iobase, membase, irq; 306 307 /* Save important PCI config data. */ 308 iobase = cardbus_conf_read(cc, cf, csc->sc_tag, 309 RTK_PCI_LOIO); 310 membase = cardbus_conf_read(cc, cf,csc->sc_tag, 311 RTK_PCI_LOMEM); 312 irq = cardbus_conf_read(cc, cf,csc->sc_tag, 313 CARDBUS_INTERRUPT_REG); 314 315 /* Reset the power state. */ 316 aprint_normal_dev(sc->sc_dev, 317 "chip is in D%d power mode -- setting to D0\n", 318 command & PCI_PMCSR_STATE_MASK); 319 command &= ~PCI_PMCSR_STATE_MASK; 320 cardbus_conf_write(cc, cf, csc->sc_tag, 321 pmreg + PCI_PMCSR, command); 322 323 /* Restore PCI config data. */ 324 cardbus_conf_write(cc, cf, csc->sc_tag, 325 RTK_PCI_LOIO, iobase); 326 cardbus_conf_write(cc, cf, csc->sc_tag, 327 RTK_PCI_LOMEM, membase); 328 cardbus_conf_write(cc, cf, csc->sc_tag, 329 CARDBUS_INTERRUPT_REG, irq); 330 } 331 } 332 333 /* Program the BAR */ 334 cardbus_conf_write(cc, cf, csc->sc_tag, 335 csc->sc_bar_reg, csc->sc_bar_val); 336 337 /* Make sure the right access type is on the CardBus bridge. */ 338 (*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben); 339 (*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE); 340 341 /* Enable the appropriate bits in the CARDBUS CSR. */ 342 reg = cardbus_conf_read(cc, cf, csc->sc_tag, 343 CARDBUS_COMMAND_STATUS_REG); 344 reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE); 345 reg |= csc->sc_csr; 346 cardbus_conf_write(cc, cf, csc->sc_tag, 347 CARDBUS_COMMAND_STATUS_REG, reg); 348 349 /* 350 * Make sure the latency timer is set to some reasonable 351 * value. 352 */ 353 reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG); 354 if (CARDBUS_LATTIMER(reg) < 0x20) { 355 reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT); 356 reg |= (0x20 << CARDBUS_LATTIMER_SHIFT); 357 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg); 358 } 359 } 360 361 int 362 rtk_cardbus_enable(struct rtk_softc *sc) 363 { 364 struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)sc; 365 cardbus_devfunc_t ct = csc->sc_ct; 366 cardbus_chipset_tag_t cc = ct->ct_cc; 367 cardbus_function_tag_t cf = ct->ct_cf; 368 369 /* 370 * Power on the socket. 371 */ 372 Cardbus_function_enable(ct); 373 374 /* 375 * Set up the PCI configuration registers. 376 */ 377 rtk_cardbus_setup(csc); 378 379 /* 380 * Map and establish the interrupt. 381 */ 382 csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline, 383 IPL_NET, rtk_intr, sc); 384 if (csc->sc_ih == NULL) { 385 aprint_error_dev(sc->sc_dev, 386 "unable to establish interrupt\n"); 387 Cardbus_function_disable(csc->sc_ct); 388 return 1; 389 } 390 return 0; 391 } 392 393 void 394 rtk_cardbus_disable(struct rtk_softc *sc) 395 { 396 struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)sc; 397 cardbus_devfunc_t ct = csc->sc_ct; 398 cardbus_chipset_tag_t cc = ct->ct_cc; 399 cardbus_function_tag_t cf = ct->ct_cf; 400 401 /* Unhook the interrupt handler. */ 402 cardbus_intr_disestablish(cc, cf, csc->sc_ih); 403 csc->sc_ih = NULL; 404 405 /* Power down the socket. */ 406 Cardbus_function_disable(ct); 407 } 408