if_xe_pccard.c revision 179492
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 179492 2008-06-02 19:43:24Z jhb $"); 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#include <dev/xe/if_xereg.h> 50#include <dev/xe/if_xevar.h> 51 52#include <dev/pccard/pccardvar.h> 53#include <dev/pccard/pccard_cis.h> 54 55#include "card_if.h" 56#include "pccarddevs.h" 57 58/* 59 * Debug logging levels - set with hw.xe.debug sysctl 60 * 0 = None 61 * 1 = More hardware details, probe/attach progress 62 * 2 = Most function calls, ioctls and media selection progress 63 * 3 = Everything - interrupts, packets in/out and multicast address setup 64 */ 65#define XE_DEBUG 66#ifdef XE_DEBUG 67 68extern int xe_debug; 69 70#define DEVPRINTF(level, arg) if (xe_debug >= (level)) device_printf arg 71#define DPRINTF(level, arg) if (xe_debug >= (level)) printf arg 72#else 73#define DEVPRINTF(level, arg) 74#define DPRINTF(level, arg) 75#endif 76 77 78#define XE_CARD_TYPE_FLAGS_NO 0x0 79#define XE_CARD_TYPE_FLAGS_CE2 0x1 80#define XE_CARD_TYPE_FLAGS_MOHAWK 0x2 81#define XE_CARD_TYPE_FLAGS_DINGO 0x4 82#define XE_PROD_ETHER_MASK 0x0100 83#define XE_PROD_MODEM_MASK 0x1000 84 85#define XE_BOGUS_MAC_OFFSET 0x90 86 87/* MAC vendor prefix used by most Xircom cards is 00:80:c7 */ 88#define XE_MAC_ADDR_0 0x00 89#define XE_MAC_ADDR_1 0x80 90#define XE_MAC_ADDR_2 0xc7 91 92/* Some (all?) REM56 cards have vendor prefix 00:10:a4 */ 93#define XE_REM56_MAC_ADDR_0 0x00 94#define XE_REM56_MAC_ADDR_1 0x10 95#define XE_REM56_MAC_ADDR_2 0xa4 96 97 98struct xe_pccard_product { 99 struct pccard_product product; 100 uint16_t prodext; 101 uint16_t flags; 102}; 103 104static const struct xe_pccard_product xe_pccard_products[] = { 105 { PCMCIA_CARD_D(COMPAQ, CPQ550), 0x43, XE_CARD_TYPE_FLAGS_CE2 }, 106 { PCMCIA_CARD_D(COMPAQ2, CPQ_10_100), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 107 { PCMCIA_CARD_D(INTEL, EEPRO100), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 108 { PCMCIA_CARD_D(INTEL, PRO100LAN56), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 109 { PCMCIA_CARD_D(RACORE, ACCTON_EN2226),0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 110 { PCMCIA_CARD_D(XIRCOM, CE), 0x41, XE_CARD_TYPE_FLAGS_NO }, 111 { PCMCIA_CARD_D(XIRCOM, CE2), 0x41, XE_CARD_TYPE_FLAGS_CE2 }, 112 { PCMCIA_CARD_D(XIRCOM, CE2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 113 { PCMCIA_CARD_D(XIRCOM, CE2_2), 0x41, XE_CARD_TYPE_FLAGS_CE2 }, 114 { PCMCIA_CARD_D(XIRCOM, CE2_2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 115 { PCMCIA_CARD_D(XIRCOM, CE3), 0x43, XE_CARD_TYPE_FLAGS_MOHAWK }, 116 { PCMCIA_CARD_D(XIRCOM, CEM), 0x41, XE_CARD_TYPE_FLAGS_NO }, 117 { PCMCIA_CARD_D(XIRCOM, CEM2), 0x42, XE_CARD_TYPE_FLAGS_CE2 }, 118 { PCMCIA_CARD_D(XIRCOM, CEM28), 0x43, XE_CARD_TYPE_FLAGS_CE2 }, 119 { PCMCIA_CARD_D(XIRCOM, CEM33), 0x44, XE_CARD_TYPE_FLAGS_CE2 }, 120 { PCMCIA_CARD_D(XIRCOM, CEM33_2), 0x44, XE_CARD_TYPE_FLAGS_CE2 }, 121 { PCMCIA_CARD_D(XIRCOM, CEM56), 0x45, XE_CARD_TYPE_FLAGS_DINGO }, 122 { PCMCIA_CARD_D(XIRCOM, CEM56_2), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 123 { PCMCIA_CARD_D(XIRCOM, REM56), 0x46, XE_CARD_TYPE_FLAGS_DINGO }, 124 { PCMCIA_CARD_D(XIRCOM, REM10), 0x47, XE_CARD_TYPE_FLAGS_DINGO }, 125 { PCMCIA_CARD_D(XIRCOM, XEM5600), 0x56, XE_CARD_TYPE_FLAGS_DINGO }, 126 { { NULL }, 0, 0 } 127}; 128 129 130/* 131 * Fixing for CEM2, CEM3 and CEM56/REM56 cards. These need some magic to 132 * enable the Ethernet function, which isn't mentioned anywhere in the CIS. 133 * Despite the register names, most of this isn't Dingo-specific. 134 */ 135static int 136xe_cemfix(device_t dev) 137{ 138 struct xe_softc *sc = (struct xe_softc *) device_get_softc(dev); 139 int ioport; 140 141 DEVPRINTF(2, (dev, "cemfix\n")); 142 143 DEVPRINTF(1, (dev, "CEM I/O port 0x%0lx, size 0x%0lx\n", 144 bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid), 145 bus_get_resource_count(dev, SYS_RES_IOPORT, sc->port_rid))); 146 147 pccard_attr_write_1(dev, DINGO_ECOR, DINGO_ECOR_IRQ_LEVEL | 148 DINGO_ECOR_INT_ENABLE | DINGO_ECOR_IOB_ENABLE | 149 DINGO_ECOR_ETH_ENABLE); 150 ioport = bus_get_resource_start(dev, SYS_RES_IOPORT, sc->port_rid); 151 pccard_attr_write_1(dev, DINGO_EBAR0, ioport & 0xff); 152 pccard_attr_write_1(dev, DINGO_EBAR1, (ioport >> 8) & 0xff); 153 154 if (sc->dingo) { 155 pccard_attr_write_1(dev, DINGO_DCOR0, DINGO_DCOR0_SF_INT); 156 pccard_attr_write_1(dev, DINGO_DCOR1, DINGO_DCOR1_INT_LEVEL | 157 DINGO_DCOR1_EEDIO); 158 pccard_attr_write_1(dev, DINGO_DCOR2, 0x00); 159 pccard_attr_write_1(dev, DINGO_DCOR3, 0x00); 160 pccard_attr_write_1(dev, DINGO_DCOR4, 0x00); 161 } 162 /* success! */ 163 return (0); 164} 165 166static int 167xe_pccard_product_match(device_t dev, const struct pccard_product* ent, int vpfmatch) 168{ 169 const struct xe_pccard_product* xpp; 170 uint16_t prodext; 171 172 if (vpfmatch == 0) 173 return (0); 174 175 xpp = (const struct xe_pccard_product*)ent; 176 pccard_get_prodext(dev, &prodext); 177 if (xpp->prodext != prodext) 178 vpfmatch = 0; 179 else 180 vpfmatch++; 181 return (vpfmatch); 182} 183 184static const struct xe_pccard_product * 185xe_pccard_get_product(device_t dev) 186{ 187 return ((const struct xe_pccard_product *) pccard_product_lookup(dev, 188 (const struct pccard_product *)xe_pccard_products, 189 sizeof(xe_pccard_products[0]), xe_pccard_product_match)); 190} 191 192/* 193 * Fixing for CE2-class cards with bogus CIS entry for MAC address. 194 */ 195static int 196xe_pccard_mac(const struct pccard_tuple *tuple, void *argp) 197{ 198 uint8_t *enaddr = argp, test; 199 int i; 200 201 /* Code 0x89 is Xircom special cis node contianing the MAC */ 202 if (tuple->code != 0x89) 203 return (0); 204 205 /* Make sure this is a sane node */ 206 if (tuple->length != ETHER_ADDR_LEN + 2) 207 return (0); 208 test = pccard_tuple_read_1(tuple, 0); 209 if (test != PCCARD_TPLFE_TYPE_LAN_NID) 210 return (0); 211 test = pccard_tuple_read_1(tuple, 1); 212 if (test != ETHER_ADDR_LEN) 213 return (0); 214 215 /* Copy the MAC ADDR and return success */ 216 for (i = 0; i < ETHER_ADDR_LEN; i++) 217 enaddr[i] = pccard_tuple_read_1(tuple, i + 2); 218 return (1); 219} 220 221static int 222xe_bad_mac(uint8_t *enaddr) 223{ 224 int i; 225 uint8_t sum; 226 227 for (i = 0, sum = 0; i < ETHER_ADDR_LEN; i++) 228 sum |= enaddr[i]; 229 return (sum == 0); 230} 231 232/* 233 * PCMCIA attach routine. 234 * Identify the device. Called from the bus driver when the card is 235 * inserted or otherwise powers up. 236 */ 237static int 238xe_pccard_attach(device_t dev) 239{ 240 struct xe_softc *scp = (struct xe_softc *) device_get_softc(dev); 241 uint32_t vendor,product; 242 uint16_t prodext; 243 const char* vendor_str = NULL; 244 const char* product_str = NULL; 245 const char* cis4_str = NULL; 246 const char *cis3_str=NULL; 247 const struct xe_pccard_product *xpp; 248 int err; 249 250 DEVPRINTF(2, (dev, "pccard_attach\n")); 251 252 pccard_get_vendor(dev, &vendor); 253 pccard_get_product(dev, &product); 254 pccard_get_prodext(dev, &prodext); 255 pccard_get_vendor_str(dev, &vendor_str); 256 pccard_get_product_str(dev, &product_str); 257 pccard_get_cis3_str(dev, &cis3_str); 258 pccard_get_cis4_str(dev, &cis4_str); 259 260 DEVPRINTF(1, (dev, "vendor = 0x%04x\n", vendor)); 261 DEVPRINTF(1, (dev, "product = 0x%04x\n", product)); 262 DEVPRINTF(1, (dev, "prodext = 0x%02x\n", prodext)); 263 DEVPRINTF(1, (dev, "vendor_str = %s\n", vendor_str)); 264 DEVPRINTF(1, (dev, "product_str = %s\n", product_str)); 265 DEVPRINTF(1, (dev, "cis3_str = %s\n", cis3_str)); 266 DEVPRINTF(1, (dev, "cis4_str = %s\n", cis4_str)); 267 268 xpp = xe_pccard_get_product(dev); 269 if (xpp == NULL) 270 return (ENXIO); 271 272 /* Set various card ID fields in softc */ 273 scp->vendor = vendor_str; 274 scp->card_type = product_str; 275 if (xpp->flags & XE_CARD_TYPE_FLAGS_CE2) 276 scp->ce2 = 1; 277 if (xpp->flags & XE_CARD_TYPE_FLAGS_MOHAWK) 278 scp->mohawk = 1; 279 if (xpp->flags & XE_CARD_TYPE_FLAGS_DINGO) { 280 scp->dingo = 1; 281 scp->mohawk = 1; 282 } 283 if (xpp->product.pp_product & XE_PROD_MODEM_MASK) 284 scp->modem = 1; 285 286 /* Get MAC address */ 287 pccard_get_ether(dev, scp->enaddr); 288 289 /* Deal with bogus MAC address */ 290 if (xe_bad_mac(scp->enaddr) && 291 !pccard_cis_scan(dev, xe_pccard_mac, scp->enaddr)) { 292 device_printf(dev, 293 "Unable to find MAC address for your %s card\n", 294 device_get_desc(dev)); 295 return (ENXIO); 296 } 297 298 if ((err = xe_activate(dev)) != 0) 299 return (err); 300 301 /* Hack RealPorts into submission */ 302 if (scp->modem && xe_cemfix(dev) < 0) { 303 device_printf(dev, "Unable to fix your %s combo card\n", 304 device_get_desc(dev)); 305 xe_deactivate(dev); 306 return (ENXIO); 307 } 308 if ((err = xe_attach(dev))) { 309 device_printf(dev, "xe_attach() failed! (%d)\n", err); 310 xe_deactivate(dev); 311 return (err); 312 } 313 return (0); 314} 315 316/* 317 * The device entry is being removed, probably because someone ejected the 318 * card. The interface should have been brought down manually before calling 319 * this function; if not you may well lose packets. In any case, I shut down 320 * the card and the interface, and hope for the best. 321 */ 322static int 323xe_pccard_detach(device_t dev) 324{ 325 struct xe_softc *sc = device_get_softc(dev); 326 327 DEVPRINTF(2, (dev, "pccard_detach\n")); 328 329 XE_LOCK(sc); 330 xe_stop(sc); 331 XE_UNLOCK(sc); 332 callout_drain(&sc->media_timer); 333 callout_drain(&sc->wdog_timer); 334 ether_ifdetach(sc->ifp); 335 xe_deactivate(dev); 336 mtx_destroy(&sc->lock); 337 return (0); 338} 339 340static int 341xe_pccard_probe(device_t dev) 342{ 343 const struct xe_pccard_product *xpp; 344 345 DEVPRINTF(2, (dev, "pccard_probe\n")); 346 347 /* 348 * Xircom cards aren't proper MFC cards, so we have to take all 349 * cards that match, not just ones that are network. 350 */ 351 352 /* If we match something in the table, it is our device. */ 353 if ((xpp = xe_pccard_get_product(dev)) == NULL) 354 return (ENXIO); 355 356 /* Set card name for logging later */ 357 if (xpp->product.pp_name != NULL) 358 device_set_desc(dev, xpp->product.pp_name); 359 360 /* Reject known but unsupported cards */ 361 if (xpp->flags & XE_CARD_TYPE_FLAGS_NO) { 362 device_printf(dev, "Sorry, your %s card is not supported :(\n", 363 device_get_desc(dev)); 364 return (ENXIO); 365 } 366 367 return (0); 368} 369 370static device_method_t xe_pccard_methods[] = { 371 /* Device interface */ 372 DEVMETHOD(device_probe, xe_pccard_probe), 373 DEVMETHOD(device_attach, xe_pccard_attach), 374 DEVMETHOD(device_detach, xe_pccard_detach), 375 376 { 0, 0 } 377}; 378 379static driver_t xe_pccard_driver = { 380 "xe", 381 xe_pccard_methods, 382 sizeof(struct xe_softc), 383}; 384 385devclass_t xe_devclass; 386 387DRIVER_MODULE(xe, pccard, xe_pccard_driver, xe_devclass, 0, 0); 388