if_ep_pccard.c revision 147607
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 147607 2005-06-26 04:19:45Z 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 uint8_t enaddr[6]; 77 int error; 78 79 error = ep_alloc(dev); 80 if (error) 81 return (error); 82 83 /* 84 * It appears that the eeprom comes in two sizes. There's 85 * a 512 byte eeprom and a 2k eeprom. Bit 13 of the eeprom 86 * command register is supposed to contain the size of the 87 * eeprom. 88 */ 89 /* 90 * XXX - Certain (newer?) 3Com cards need epb->cmd_off == 91 * 2. Sadly, you need to have a correct cmd_off in order to 92 * identify the card. So we have to hit it with both and 93 * cross our virtual fingers. There's got to be a better way 94 * to do this. jyoung@accessus.net 09/11/1999 95 */ 96 97 epb->cmd_off = 0; 98 99 /* XXX check return */ 100 error = ep_get_e(sc, EEPROM_PROD_ID, &result); 101 epb->prod_id = result; 102 103 if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) { 104 if (bootverbose) 105 device_printf(dev, "Pass 1 of 2 detection " 106 "failed (nonfatal) id 0x%x\n", epb->prod_id); 107 epb->cmd_off = 2; 108 /* XXX check return */ 109 error = ep_get_e(sc, EEPROM_PROD_ID, &result); 110 epb->prod_id = result; 111 if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) { 112 device_printf(dev, "Unit failed to come ready or " 113 "product ID unknown! (id 0x%x)\n", epb->prod_id); 114 ep_free(dev); 115 return (ENXIO); 116 } 117 } 118 /* 119 * For reasons unknown, getting the MAC address here makes the 120 * 3C574 and 3C556 families get the right MAC address later. 121 * otherwise, the ID field is used for each of the words of the 122 * MAC address instead of the proper one. It is unclear why 123 * ep_get_macaddr would have this side effect, or even what 124 * that side effect really is. 125 */ 126 ep_get_macaddr(sc, enaddr); 127 device_set_desc(dev, desc); 128 ep_free(dev); 129 return (0); 130} 131 132static const char * 133ep_pccard_identify(u_short id) 134{ 135 /* Determine device type and associated MII capabilities */ 136 switch (id) { 137 case 0x6055: /* 3C556 */ 138 return ("3Com 3C556"); 139 case 0x4057: /* 3C574 */ 140 return ("3Com 3C574"); 141 case 0x4b57: /* 3C574B */ 142 return ("3Com 3C574B, Megahertz 3CCFE574BT or " 143 "Fast Etherlink 3C574-TX"); 144 case 0x2b57: /* 3CXSH572BT */ 145 return ("3Com OfficeConnect 572BT"); 146 case 0x9058: /* 3C589 */ 147 return ("3Com Etherlink III 3C589"); 148 case 0x2056: /* 3C562/3C563 */ 149 return ("3Com 3C562D/3C563D"); 150 case 0x0010: /* 3C1 */ 151 return ("3Com Megahertz C1"); 152 case 0x0035: 153 return ("3Com 3CCEM556"); 154 default: 155 return (NULL); 156 } 157} 158 159static int 160ep_pccard_card_attach(struct ep_board * epb) 161{ 162 /* Determine device type and associated MII capabilities */ 163 switch (epb->prod_id) { 164 case 0x6055: /* 3C556 */ 165 case 0x2b57: /* 3C572BT */ 166 case 0x4057: /* 3C574, 3C574-TX */ 167 case 0x4b57: /* 3C574B */ 168 epb->mii_trans = 1; 169 return (1); 170 case 0x2056: /* 3C562D/3C563D */ 171 case 0x9058: /* 3C589 */ 172 case 0x0010: /* 3C1 */ 173 case 0x0035: /* 3C[XC]EM556 */ 174 epb->mii_trans = 0; 175 return (1); 176 default: 177 return (0); 178 } 179} 180 181static int 182ep_pccard_attach(device_t dev) 183{ 184 struct ep_softc *sc = device_get_softc(dev); 185 uint16_t result; 186 int error = 0; 187 188 if ((error = ep_alloc(dev))) { 189 device_printf(dev, "ep_alloc() failed! (%d)\n", error); 190 goto bad; 191 } 192 sc->epb.cmd_off = 0; 193 194 /* XXX check return */ 195 error = ep_get_e(sc, EEPROM_PROD_ID, &result); 196 sc->epb.prod_id = result; 197 198 if (!ep_pccard_card_attach(&sc->epb)) { 199 sc->epb.cmd_off = 2; 200 error = ep_get_e(sc, EEPROM_PROD_ID, &result); 201 sc->epb.prod_id = result; 202 error = ep_get_e(sc, EEPROM_RESOURCE_CFG, &result); 203 sc->epb.res_cfg = result; 204 if (!ep_pccard_card_attach(&sc->epb)) { 205 device_printf(dev, 206 "Probe found ID, attach failed so ignore card!\n"); 207 error = ENXIO; 208 goto bad; 209 } 210 } 211 error = ep_get_e(sc, EEPROM_ADDR_CFG, &result); 212 213 /* ROM size = 0, ROM base = 0 */ 214 /* For now, ignore AUTO SELECT feature of 3C589B and later. */ 215 CSR_WRITE_2(sc, EP_W0_ADDRESS_CFG, result & 0xc000); 216 217 /* 218 * Fake IRQ must be 3 for 3C589 and 3C589B. 3C589D and newer 219 * ignore this value. 3C589C is unknown, as are the other 220 * cards supported by this driver, but it appears to never hurt 221 * and always helps. 222 */ 223 SET_IRQ(sc, 3); 224 CSR_WRITE_2(sc, EP_W0_PRODUCT_ID, sc->epb.prod_id); 225 226 if (sc->epb.mii_trans) { 227 /* 228 * turn on the MII transciever 229 */ 230 GO_WINDOW(sc, 3); 231 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 232 DELAY(1000); 233 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0xc040); 234 CSR_WRITE_2(sc, EP_COMMAND, RX_RESET); 235 CSR_WRITE_2(sc, EP_COMMAND, TX_RESET); 236 EP_BUSY_WAIT(sc); 237 DELAY(1000); 238 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 239 } else 240 ep_get_media(sc); 241 242 if ((error = ep_attach(sc))) { 243 device_printf(dev, "ep_attach() failed! (%d)\n", error); 244 goto bad; 245 } 246 if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET | INTR_MPSAFE, ep_intr, 247 sc, &sc->ep_intrhand))) { 248 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error); 249 goto bad; 250 } 251 return (0); 252bad: 253 ep_free(dev); 254 return (error); 255} 256 257static const struct pccard_product ep_pccard_products[] = { 258 PCMCIA_CARD(3COM, 3C1), 259 PCMCIA_CARD(3COM, 3C562), 260 PCMCIA_CARD(3COM, 3C574), /* ROADRUNNER */ 261 PCMCIA_CARD(3COM, 3C589), 262 PCMCIA_CARD(3COM, 3CCFEM556BI), /* ROADRUNNER */ 263 PCMCIA_CARD(3COM, 3CXEM556), 264 PCMCIA_CARD(3COM, 3CXEM556INT), 265 {NULL} 266}; 267 268static int 269ep_pccard_match(device_t dev) 270{ 271 const struct pccard_product *pp; 272 int error; 273 uint32_t fcn = PCCARD_FUNCTION_UNSPEC; 274 275 /* Make sure we're a network function */ 276 error = pccard_get_function(dev, &fcn); 277 if (error != 0) 278 return (error); 279 if (fcn != PCCARD_FUNCTION_NETWORK) 280 return (ENXIO); 281 282 if ((pp = pccard_product_lookup(dev, ep_pccard_products, 283 sizeof(ep_pccard_products[0]), NULL)) != NULL) { 284 if (pp->pp_name != NULL) 285 device_set_desc(dev, pp->pp_name); 286 return 0; 287 } 288 return EIO; 289} 290 291static device_method_t ep_pccard_methods[] = { 292 /* Device interface */ 293 DEVMETHOD(device_probe, pccard_compat_probe), 294 DEVMETHOD(device_attach, pccard_compat_attach), 295 DEVMETHOD(device_detach, ep_detach), 296 297 /* Card interface */ 298 DEVMETHOD(card_compat_match, ep_pccard_match), 299 DEVMETHOD(card_compat_probe, ep_pccard_probe), 300 DEVMETHOD(card_compat_attach, ep_pccard_attach), 301 302 {0, 0} 303}; 304 305static driver_t ep_pccard_driver = { 306 "ep", 307 ep_pccard_methods, 308 sizeof(struct ep_softc), 309}; 310 311extern devclass_t ep_devclass; 312 313DRIVER_MODULE(ep, pccard, ep_pccard_driver, ep_devclass, 0, 0); 314