if_xe_pccard.c revision 147961
1/*- 2 * Copyright (c) 2002 Takeshi Shibagaki 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27#include <sys/cdefs.h> 28__FBSDID("$FreeBSD: head/sys/dev/xe/if_xe_pccard.c 147961 2005-07-13 14:57:36Z imp $"); 29 30/* xe pccard interface driver */ 31 32#include <sys/param.h> 33#include <sys/bus.h> 34#include <sys/kernel.h> 35#include <sys/module.h> 36#include <sys/socket.h> 37#include <sys/systm.h> 38 39#include <machine/bus.h> 40#include <machine/resource.h> 41#include <sys/rman.h> 42 43#include <net/ethernet.h> 44#include <net/if.h> 45#include <net/if_arp.h> 46#include <net/if_media.h> 47#include <net/if_mib.h> 48 49 50#include <dev/xe/if_xereg.h> 51#include <dev/xe/if_xevar.h> 52 53#include <dev/pccard/pccardvar.h> 54#include <dev/pccard/pccard_cis.h> 55 56#include "card_if.h" 57#include "pccarddevs.h" 58 59/* 60 * Debug logging levels - set with hw.xe.debug sysctl 61 * 0 = None 62 * 1 = More hardware details, probe/attach progress 63 * 2 = Most function calls, ioctls and media selection progress 64 * 3 = Everything - interrupts, packets in/out and multicast address setup 65 */ 66#define XE_DEBUG 67#ifdef XE_DEBUG 68 69extern int xe_debug; 70 71#define DEVPRINTF(level, arg) if (xe_debug >= (level)) device_printf arg 72#define DPRINTF(level, arg) if (xe_debug >= (level)) printf arg 73#else 74#define DEVPRINTF(level, arg) 75#define DPRINTF(level, arg) 76#endif 77 78 79#define XE_CARD_TYPE_FLAGS_NO 0x0 80#define XE_CARD_TYPE_FLAGS_CE2 0x1 81#define XE_CARD_TYPE_FLAGS_MOHAWK 0x2 82#define XE_CARD_TYPE_FLAGS_DINGO 0x4 83#define XE_PROD_ETHER_MASK 0x0100 84#define XE_PROD_MODEM_MASK 0x1000 85 86#define XE_BOGUS_MAC_OFFSET 0x90 87 88/* MAC vendor prefix used by most Xircom cards is 00:80:c7 */ 89#define XE_MAC_ADDR_0 0x00 90#define XE_MAC_ADDR_1 0x80 91#define XE_MAC_ADDR_2 0xc7 92 93/* Some (all?) REM56 cards have vendor prefix 00:10:a4 */ 94#define XE_REM56_MAC_ADDR_0 0x00 95#define XE_REM56_MAC_ADDR_1 0x10 96#define XE_REM56_MAC_ADDR_2 0xa4 97 98 99struct xe_pccard_product { 100 struct pccard_product product; 101 uint16_t prodext; 102 uint16_t flags; 103}; 104 105static const struct xe_pccard_product xe_pccard_products[] = { 106 { PCMCIA_CARD_D(COMPAQ, CPQ550), 0x43, XE_CARD_TYPE_FLAGS_CE2 }, 107 { PCMCIA_CARD_D(COMPAQ2, CPQ_10_100), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 108 { PCMCIA_CARD_D(INTEL, EEPRO100), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 109 { PCMCIA_CARD_D(INTEL, PRO100LAN56), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 110 { PCMCIA_CARD_D(RACORE, ACCTON_EN2226),0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 111 { PCMCIA_CARD_D(XIRCOM, CE), 0x41, XE_CARD_TYPE_FLAGS_NO }, 112 { PCMCIA_CARD_D(XIRCOM, CE2), 0x41, XE_CARD_TYPE_FLAGS_CE2 }, 113 { PCMCIA_CARD_D(XIRCOM, CE2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 114 { PCMCIA_CARD_D(XIRCOM, CE2_2), 0x41, XE_CARD_TYPE_FLAGS_CE2 }, 115 { PCMCIA_CARD_D(XIRCOM, CE2_2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 116 { PCMCIA_CARD_D(XIRCOM, CE3), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 117 { PCMCIA_CARD_D(XIRCOM, CEM), 0x41, XE_CARD_TYPE_FLAGS_NO }, 118 { PCMCIA_CARD_D(XIRCOM, CEM2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 119 { PCMCIA_CARD_D(XIRCOM, CEM28), 0x43, XE_CARD_TYPE_FLAGS_CE2 }, 120 { PCMCIA_CARD_D(XIRCOM, CEM33), 0x44, XE_CARD_TYPE_FLAGS_CE2 }, 121 { PCMCIA_CARD_D(XIRCOM, CEM33_2), 0x44, XE_CARD_TYPE_FLAGS_CE2 }, 122 { PCMCIA_CARD_D(XIRCOM, CEM56), 0x45, XE_CARD_TYPE_FLAGS_DINGO }, 123 { PCMCIA_CARD_D(XIRCOM, CEM56_2), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 124 { PCMCIA_CARD_D(XIRCOM, REM56), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 125 { PCMCIA_CARD_D(XIRCOM, REM10), 0x47, XE_CARD_TYPE_FLAGS_DINGO }, 126 { PCMCIA_CARD_D(XIRCOM, XEM5600), 0x56, XE_CARD_TYPE_FLAGS_DINGO }, 127 { { NULL }, 0, 0 } 128}; 129 130 131/* 132 * Fixing for CEM2, CEM3 and CEM56/REM56 cards. These need some magic to 133 * enable the Ethernet function, which isn't mentioned anywhere in the CIS. 134 * Despite the register names, most of this isn't Dingo-specific. 135 */ 136static int 137xe_cemfix(device_t dev) 138{ 139 struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev); 140 bus_space_tag_t bst; 141 bus_space_handle_t bsh; 142 struct resource *r; 143 int rid; 144 int ioport; 145 146 DEVPRINTF(2, (dev, "cemfix\n")); 147 148 DEVPRINTF(1, (dev, "CEM I/O port 0x%0lx, size 0x%0lx\n", 149 bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid), 150 bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid))); 151 152 rid = 0; 153 r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, 154 ~0, 4 << 10, RF_ACTIVE); 155 if (!r) { 156 device_printf(dev, "cemfix: Can't map in attribute memory\n"); 157 return (-1); 158 } 159 160 bsh = rman_get_bushandle(r); 161 bst = rman_get_bustag(r); 162 163 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid, 164 PCCARD_A_MEM_ATTR); 165 166 bus_space_write_1(bst, bsh, DINGO_ECOR, DINGO_ECOR_IRQ_LEVEL | 167 DINGO_ECOR_INT_ENABLE | 168 DINGO_ECOR_IOB_ENABLE | 169 DINGO_ECOR_ETH_ENABLE); 170 ioport = bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid); 171 bus_space_write_1(bst, bsh, DINGO_EBAR0, ioport & 0xff); 172 bus_space_write_1(bst, bsh, DINGO_EBAR1, (ioport >> 8) & 0xff); 173 174 if (sc->dingo) { 175 bus_space_write_1(bst, bsh, DINGO_DCOR0, DINGO_DCOR0_SF_INT); 176 bus_space_write_1(bst, bsh, DINGO_DCOR1, DINGO_DCOR1_INT_LEVEL | 177 DINGO_DCOR1_EEDIO); 178 bus_space_write_1(bst, bsh, DINGO_DCOR2, 0x00); 179 bus_space_write_1(bst, bsh, DINGO_DCOR3, 0x00); 180 bus_space_write_1(bst, bsh, DINGO_DCOR4, 0x00); 181 } 182 183 bus_release_resource(dev, SYS_RES_MEMORY, rid, r); 184 185 /* success! */ 186 return (0); 187} 188 189/* 190 * Fixing for CE2-class cards with bogus CIS entry for MAC address. This 191 * should be in a type 0x22 tuple, but some cards seem to use 0x89. 192 * This function looks for a sensible MAC address tuple starting at the given 193 * offset in attribute memory, ignoring the tuple type field. 194 */ 195static int 196xe_macfix(device_t dev, int offset) 197{ 198 struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev); 199 bus_space_tag_t bst; 200 bus_space_handle_t bsh; 201 struct resource *r; 202 int rid, i; 203 uint8_t cisdata[9]; 204 uint8_t required[6] = { 0x08, PCCARD_TPLFE_TYPE_LAN_NID, ETHER_ADDR_LEN, 205 XE_MAC_ADDR_0, XE_MAC_ADDR_1, XE_MAC_ADDR_2 }; 206 207 DEVPRINTF(2, (dev, "macfix\n")); 208 209 rid = 0; 210 r = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, 211 ~0, 4 << 10, RF_ACTIVE); 212 if (!r) { 213 device_printf(dev, "macfix: Can't map in attribute memory\n"); 214 return (-1); 215 } 216 217 bsh = rman_get_bushandle(r); 218 bst = rman_get_bustag(r); 219 220 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY, rid, 221 PCCARD_A_MEM_ATTR); 222 223 /* 224 * Looking for (relative to offset): 225 * 226 * 0x00 0x?? Tuple type (ignored) 227 * 0x02 0x08 Tuple length (must be 8) 228 * 0x04 0x04 Address type? (must be 4) 229 * 0x06 0x06 Address length (must be 6) 230 * 0x08 0x00 Manufacturer ID, byte 1 231 * 0x0a 0x80 Manufacturer ID, byte 2 232 * 0x0c 0xc7 Manufacturer ID, byte 3 233 * 0x0e 0x?? Card ID, byte 1 234 * 0x10 0x?? Card ID, byte 2 235 * 0x12 0x?? Card ID, byte 3 236 */ 237 for (i = 0; i < 9; i++) { 238 cisdata[i] = bus_space_read_1(bst, bsh, offset + (2 * i) + 2); 239 if (i < 6 && required[i] != cisdata[i]) { 240 device_printf(dev, "macfix: Can't find valid MAC address\n"); 241 bus_release_resource(dev, SYS_RES_MEMORY, rid, r); 242 return (-1); 243 } 244 } 245 246 for (i = 0; i < ETHER_ADDR_LEN; i++) { 247 sc->enaddr[i] = cisdata[i + 3]; 248 } 249 250 bus_release_resource(dev, SYS_RES_MEMORY, rid, r); 251 252 /* success! */ 253 return (0); 254} 255 256static int 257xe_pccard_product_match(device_t dev, const struct pccard_product* ent, int vpfmatch) 258{ 259 const struct xe_pccard_product* xpp; 260 uint16_t prodext; 261 262 xpp = (const struct xe_pccard_product*)ent; 263 pccard_get_prodext(dev, &prodext); 264 if (xpp->prodext != prodext) 265 vpfmatch = 0; 266 else 267 vpfmatch++; 268 return (vpfmatch); 269} 270 271static const struct xe_pccard_product * 272xe_pccard_get_product(device_t dev) 273{ 274 return ((const struct xe_pccard_product *) pccard_product_lookup(dev, 275 (const struct pccard_product *)xe_pccard_products, 276 sizeof(xe_pccard_products[0]), xe_pccard_product_match)); 277} 278 279/* 280 * PCMCIA attach routine. 281 * Identify the device. Called from the bus driver when the card is 282 * inserted or otherwise powers up. 283 */ 284static int 285xe_pccard_attach(device_t dev) 286{ 287 struct xe_softc *scp = (struct xe_softc *) device_get_softc(dev); 288 uint32_t vendor,product; 289 uint16_t prodext; 290 const char* vendor_str = NULL; 291 const char* product_str = NULL; 292 const char* cis4_str = NULL; 293 const char *cis3_str=NULL; 294 const struct xe_pccard_product *xpp; 295 int err; 296 297 DEVPRINTF(2, (dev, "pccard_attach\n")); 298 299 pccard_get_vendor(dev, &vendor); 300 pccard_get_product(dev, &product); 301 pccard_get_prodext(dev, &prodext); 302 pccard_get_vendor_str(dev, &vendor_str); 303 pccard_get_product_str(dev, &product_str); 304 pccard_get_cis3_str(dev, &cis3_str); 305 pccard_get_cis4_str(dev, &cis4_str); 306 307 DEVPRINTF(1, (dev, "vendor = 0x%04x\n", vendor)); 308 DEVPRINTF(1, (dev, "product = 0x%04x\n", product)); 309 DEVPRINTF(1, (dev, "prodext = 0x%02x\n", prodext)); 310 DEVPRINTF(1, (dev, "vendor_str = %s\n", vendor_str)); 311 DEVPRINTF(1, (dev, "product_str = %s\n", product_str)); 312 DEVPRINTF(1, (dev, "cis3_str = %s\n", cis3_str)); 313 DEVPRINTF(1, (dev, "cis4_str = %s\n", cis4_str)); 314 315 316 xpp = xe_pccard_get_product(dev); 317 if (xpp == NULL) 318 return (ENXIO); 319 320 /* Set various card ID fields in softc */ 321 scp->vendor = vendor_str; 322 scp->card_type = product_str; 323 if (xpp->flags & XE_CARD_TYPE_FLAGS_CE2) 324 scp->ce2 = 1; 325 if (xpp->flags & XE_CARD_TYPE_FLAGS_MOHAWK) 326 scp->mohawk = 1; 327 if (xpp->flags & XE_CARD_TYPE_FLAGS_DINGO) { 328 scp->dingo = 1; 329 scp->mohawk = 1; 330 } 331 if (xpp->product.pp_product & XE_PROD_MODEM_MASK) 332 scp->modem = 1; 333 334 /* Get MAC address */ 335 pccard_get_ether(dev, scp->enaddr); 336 337 /* Deal with bogus MAC address */ 338 if (xpp->product.pp_vendor == PCMCIA_VENDOR_XIRCOM 339 && scp->ce2 340 && (scp->enaddr[0] != XE_MAC_ADDR_0 341 || scp->enaddr[1] != XE_MAC_ADDR_1 342 || scp->enaddr[2] != XE_MAC_ADDR_2) 343 && xe_macfix(dev, XE_BOGUS_MAC_OFFSET) < 0) { 344 device_printf(dev, 345 "Unable to find MAC address for your %s card\n", 346 device_get_desc(dev)); 347 return (ENXIO); 348 } 349 350 if ((err = xe_activate(dev)) != 0) 351 return (err); 352 353 /* Hack RealPorts into submission */ 354 if (scp->modem && xe_cemfix(dev) < 0) { 355 device_printf(dev, "Unable to fix your %s combo card\n", 356 device_get_desc(dev)); 357 xe_deactivate(dev); 358 return (ENXIO); 359 } 360 if ((err = xe_attach(dev))) { 361 device_printf(dev, "xe_attach() failed! (%d)\n", err); 362 return (err); 363 } 364 return (0); 365} 366 367/* 368 * The device entry is being removed, probably because someone ejected the 369 * card. The interface should have been brought down manually before calling 370 * this function; if not you may well lose packets. In any case, I shut down 371 * the card and the interface, and hope for the best. 372 */ 373static int 374xe_pccard_detach(device_t dev) 375{ 376 struct xe_softc *sc = device_get_softc(dev); 377 378 DEVPRINTF(2, (dev, "pccard_detach\n")); 379 380 sc->ifp->if_flags &= ~IFF_RUNNING; 381 ether_ifdetach(sc->ifp); 382 if_free(sc->ifp); 383 xe_deactivate(dev); 384 return (0); 385} 386 387static int 388xe_pccard_probe(device_t dev) 389{ 390 const struct xe_pccard_product *xpp; 391 392 DEVPRINTF(2, (dev, "pccard_probe\n")); 393 394 /* 395 * Xircom cards aren't proper MFC cards, so we have to take all 396 * cards that match, not just ones that are network. 397 */ 398 399 /* If we match something in the table, it is our device. */ 400 if ((xpp = xe_pccard_get_product(dev)) == NULL) 401 return (ENXIO); 402 403 /* Set card name for logging later */ 404 if (xpp->product.pp_name != NULL) 405 device_set_desc(dev, xpp->product.pp_name); 406 407 /* Reject known but unsupported cards */ 408 if (xpp->flags & XE_CARD_TYPE_FLAGS_NO) { 409 device_printf(dev, "Sorry, your %s card is not supported :(\n", 410 device_get_desc(dev)); 411 return (ENXIO); 412 } 413 414 return (0); 415} 416 417static device_method_t xe_pccard_methods[] = { 418 /* Device interface */ 419 DEVMETHOD(device_probe, xe_pccard_probe), 420 DEVMETHOD(device_attach, xe_pccard_attach), 421 DEVMETHOD(device_detach, xe_pccard_detach), 422 423 { 0, 0 } 424}; 425 426static driver_t xe_pccard_driver = { 427 "xe", 428 xe_pccard_methods, 429 sizeof(struct xe_softc), 430}; 431 432devclass_t xe_devclass; 433 434DRIVER_MODULE(xe, pccard, xe_pccard_driver, xe_devclass, 0, 0); 435