if_ep_pccard.c revision 147580
1/*- 2 * Copyright (c) 1994 Herb Peyerl <hpeyerl@novatel.ca> 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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by Herb Peyerl. 16 * 4. The name of Herb Peyerl may not be used to endorse or promote products 17 * derived from this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31/* 32 * Pccard support for 3C589 by: 33 * HAMADA Naoki 34 * nao@tom-yam.or.jp 35 */ 36 37#include <sys/cdefs.h> 38__FBSDID("$FreeBSD: head/sys/dev/ep/if_ep_pccard.c 147580 2005-06-24 14:36:54Z imp $"); 39 40#include <sys/param.h> 41#include <sys/systm.h> 42#include <sys/kernel.h> 43#include <sys/socket.h> 44#include <sys/module.h> 45#include <sys/bus.h> 46 47#include <machine/bus.h> 48#include <machine/resource.h> 49 50#include <net/ethernet.h> 51#include <net/if.h> 52#include <net/if_arp.h> 53#include <net/if_media.h> 54 55#include <dev/ep/if_epreg.h> 56#include <dev/ep/if_epvar.h> 57 58#include <dev/pccard/pccardvar.h> 59#include <dev/pccard/pccard_cis.h> 60 61#include "card_if.h" 62#include "pccarddevs.h" 63 64static const char *ep_pccard_identify(u_short id); 65 66/* 67 * Initialize the device - called from Slot manager. 68 */ 69static int 70ep_pccard_probe(device_t dev) 71{ 72 struct ep_softc *sc = device_get_softc(dev); 73 struct ep_board *epb = &sc->epb; 74 const char *desc; 75 uint16_t result; 76 int error; 77 78 error = ep_alloc(dev); 79 if (error) 80 return (error); 81 82 /* 83 * It appears that the eeprom comes in two sizes. There's 84 * a 512 byte eeprom and a 2k eeprom. Bit 13 of the eeprom 85 * command register is supposed to contain the size of the 86 * eeprom. 87 */ 88 /* 89 * XXX - Certain (newer?) 3Com cards need epb->cmd_off == 90 * 2. Sadly, you need to have a correct cmd_off in order to 91 * identify the card. So we have to hit it with both and 92 * cross our virtual fingers. There's got to be a better way 93 * to do this. jyoung@accessus.net 09/11/1999 94 */ 95 96 epb->cmd_off = 0; 97 98 /* XXX check return */ 99 error = get_e(sc, EEPROM_PROD_ID, &result); 100 epb->prod_id = result; 101 102 if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) { 103 if (bootverbose) 104 device_printf(dev, "Pass 1 of 2 detection " 105 "failed (nonfatal) id 0x%x\n", epb->prod_id); 106 epb->cmd_off = 2; 107 /* XXX check return */ 108 error = get_e(sc, EEPROM_PROD_ID, &result); 109 epb->prod_id = result; 110 if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) { 111 device_printf(dev, "Unit failed to come ready or " 112 "product ID unknown! (id 0x%x)\n", epb->prod_id); 113 ep_free(dev); 114 return (ENXIO); 115 } 116 } 117 device_set_desc(dev, desc); 118 119 /* 120 * Newer cards supported by this device need to have their 121 * MAC address set. 122 */ 123 error = ep_get_macaddr(sc, (u_char *)&IFP2ENADDR(sc->ifp)); 124 125 ep_free(dev); 126 return (0); 127} 128 129static const char * 130ep_pccard_identify(u_short id) 131{ 132 /* Determine device type and associated MII capabilities */ 133 switch (id) { 134 case 0x6055: /* 3C556 */ 135 return ("3Com 3C556"); 136 case 0x4057: /* 3C574 */ 137 return ("3Com 3C574"); 138 case 0x4b57: /* 3C574B */ 139 return ("3Com 3C574B, Megahertz 3CCFE574BT or " 140 "Fast Etherlink 3C574-TX"); 141 case 0x2b57: /* 3CXSH572BT */ 142 return ("3Com OfficeConnect 572BT"); 143 case 0x9058: /* 3C589 */ 144 return ("3Com Etherlink III 3C589"); 145 case 0x2056: /* 3C562/3C563 */ 146 return ("3Com 3C562D/3C563D"); 147 case 0x0010: /* 3C1 */ 148 return ("3Com Megahertz C1"); 149 case 0x0035: 150 return ("3Com 3CCEM556"); 151 default: 152 return (NULL); 153 } 154} 155 156static int 157ep_pccard_card_attach(struct ep_board * epb) 158{ 159 /* Determine device type and associated MII capabilities */ 160 switch (epb->prod_id) { 161 case 0x6055: /* 3C556 */ 162 case 0x2b57: /* 3C572BT */ 163 case 0x4057: /* 3C574, 3C574-TX */ 164 case 0x4b57: /* 3C574B */ 165 epb->mii_trans = 1; 166 return (1); 167 case 0x2056: /* 3C562D/3C563D */ 168 case 0x9058: /* 3C589 */ 169 case 0x0010: /* 3C1 */ 170 case 0x0035: /* 3C[XC]EM556 */ 171 epb->mii_trans = 0; 172 return (1); 173 default: 174 return (0); 175 } 176} 177 178static int 179ep_pccard_attach(device_t dev) 180{ 181 struct ep_softc *sc = device_get_softc(dev); 182 uint16_t result; 183 int error = 0; 184 185 if ((error = ep_alloc(dev))) { 186 device_printf(dev, "ep_alloc() failed! (%d)\n", error); 187 goto bad; 188 } 189 sc->epb.cmd_off = 0; 190 191 /* XXX check return */ 192 error = get_e(sc, EEPROM_PROD_ID, &result); 193 sc->epb.prod_id = result; 194 195 if (!ep_pccard_card_attach(&sc->epb)) { 196 sc->epb.cmd_off = 2; 197 error = get_e(sc, EEPROM_PROD_ID, &result); 198 sc->epb.prod_id = result; 199 error = get_e(sc, EEPROM_RESOURCE_CFG, &result); 200 sc->epb.res_cfg = result; 201 if (!ep_pccard_card_attach(&sc->epb)) { 202 device_printf(dev, 203 "Probe found ID, attach failed so ignore card!\n"); 204 error = ENXIO; 205 goto bad; 206 } 207 } 208 error = get_e(sc, EEPROM_ADDR_CFG, &result); 209 210 /* ROM size = 0, ROM base = 0 */ 211 /* For now, ignore AUTO SELECT feature of 3C589B and later. */ 212 CSR_WRITE_2(sc, EP_W0_ADDRESS_CFG, result & 0xc000); 213 214 /* 215 * Fake IRQ must be 3 for 3C589 and 3C589B. 3C589D and newer 216 * ignore this value. 3C589C is unknown, as are the other 217 * cards supported by this driver, but it appears to never hurt 218 * and always helps. 219 */ 220 SET_IRQ(sc, 3); 221 CSR_WRITE_2(sc, EP_W0_PRODUCT_ID, sc->epb.prod_id); 222 223 if (sc->epb.mii_trans) { 224 /* 225 * turn on the MII transciever 226 */ 227 GO_WINDOW(sc, 3); 228 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 229 DELAY(1000); 230 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0xc040); 231 CSR_WRITE_2(sc, EP_COMMAND, RX_RESET); 232 CSR_WRITE_2(sc, EP_COMMAND, TX_RESET); 233 EP_BUSY_WAIT(sc); 234 DELAY(1000); 235 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 236 } else 237 ep_get_media(sc); 238 239 if ((error = ep_attach(sc))) { 240 device_printf(dev, "ep_attach() failed! (%d)\n", error); 241 goto bad; 242 } 243 if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET | INTR_MPSAFE, ep_intr, 244 sc, &sc->ep_intrhand))) { 245 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error); 246 goto bad; 247 } 248 return (0); 249bad: 250 ep_free(dev); 251 return (error); 252} 253 254static const struct pccard_product ep_pccard_products[] = { 255 PCMCIA_CARD(3COM, 3C1), 256 PCMCIA_CARD(3COM, 3C562), 257 PCMCIA_CARD(3COM, 3C574), /* ROADRUNNER */ 258 PCMCIA_CARD(3COM, 3C589), 259 PCMCIA_CARD(3COM, 3CCFEM556BI), /* ROADRUNNER */ 260 PCMCIA_CARD(3COM, 3CXEM556), 261 PCMCIA_CARD(3COM, 3CXEM556INT), 262 {NULL} 263}; 264 265static int 266ep_pccard_match(device_t dev) 267{ 268 const struct pccard_product *pp; 269 int error; 270 uint32_t fcn = PCCARD_FUNCTION_UNSPEC; 271 272 /* Make sure we're a network function */ 273 error = pccard_get_function(dev, &fcn); 274 if (error != 0) 275 return (error); 276 if (fcn != PCCARD_FUNCTION_NETWORK) 277 return (ENXIO); 278 279 if ((pp = pccard_product_lookup(dev, ep_pccard_products, 280 sizeof(ep_pccard_products[0]), NULL)) != NULL) { 281 if (pp->pp_name != NULL) 282 device_set_desc(dev, pp->pp_name); 283 return 0; 284 } 285 return EIO; 286} 287 288static device_method_t ep_pccard_methods[] = { 289 /* Device interface */ 290 DEVMETHOD(device_probe, pccard_compat_probe), 291 DEVMETHOD(device_attach, pccard_compat_attach), 292 DEVMETHOD(device_detach, ep_detach), 293 294 /* Card interface */ 295 DEVMETHOD(card_compat_match, ep_pccard_match), 296 DEVMETHOD(card_compat_probe, ep_pccard_probe), 297 DEVMETHOD(card_compat_attach, ep_pccard_attach), 298 299 {0, 0} 300}; 301 302static driver_t ep_pccard_driver = { 303 "ep", 304 ep_pccard_methods, 305 sizeof(struct ep_softc), 306}; 307 308extern devclass_t ep_devclass; 309 310DRIVER_MODULE(ep, pccard, ep_pccard_driver, ep_devclass, 0, 0); 311