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$"); 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 "pccarddevs.h" 62 63struct ep_pccard_product 64{ 65 struct pccard_product prod; 66 int chipset; 67}; 68 69#define EP_CHIP_589 1 /* Classic 3c5x9 chipset */ 70#define EP_CHIP_574 2 /* Roadrunner */ 71#define EP_CHIP_C1 3 /* 3c1 */ 72 73static const struct ep_pccard_product ep_pccard_products[] = { 74 { PCMCIA_CARD(3COM, 3C1), EP_CHIP_C1 }, 75 { PCMCIA_CARD(3COM, 3C562), EP_CHIP_589 }, 76 { PCMCIA_CARD(3COM, 3C589), EP_CHIP_589 }, 77 { PCMCIA_CARD(3COM, 3CXEM556), EP_CHIP_589 }, 78 { PCMCIA_CARD(3COM, 3CXEM556INT), EP_CHIP_589 }, 79 { PCMCIA_CARD(3COM, 3C574), EP_CHIP_574 }, 80 { PCMCIA_CARD(3COM, 3CCFEM556BI), EP_CHIP_574 }, 81 { { NULL } } 82}; 83 84static const struct ep_pccard_product * 85ep_pccard_lookup(device_t dev) 86{ 87 return ((const struct ep_pccard_product *)pccard_product_lookup(dev, 88 (const struct pccard_product *)ep_pccard_products, 89 sizeof(ep_pccard_products[0]), NULL)); 90} 91 92static int 93ep_pccard_probe(device_t dev) 94{ 95 const struct ep_pccard_product *pp; 96 int error; 97 uint32_t fcn = PCCARD_FUNCTION_UNSPEC; 98 99 /* Make sure we're a network function */ 100 error = pccard_get_function(dev, &fcn); 101 if (error != 0) 102 return (error); 103 if (fcn != PCCARD_FUNCTION_NETWORK) 104 return (ENXIO); 105 106 /* Check to see if we know about this card */ 107 if ((pp = ep_pccard_lookup(dev)) == NULL) 108 return EIO; 109 if (pp->prod.pp_name != NULL) 110 device_set_desc(dev, pp->prod.pp_name); 111 112 return 0; 113} 114 115static int 116ep_pccard_mac(const struct pccard_tuple *tuple, void *argp) 117{ 118 uint8_t *enaddr = argp; 119 int i; 120 121 /* Code 0x88 is 3com's special cis node contianing the MAC */ 122 if (tuple->code != 0x88) 123 return (0); 124 125 /* Make sure this is a sane node */ 126 if (tuple->length < ETHER_ADDR_LEN) 127 return (0); 128 129 /* Copy the MAC ADDR and return success */ 130 for (i = 0; i < ETHER_ADDR_LEN; i += 2) { 131 enaddr[i] = pccard_tuple_read_1(tuple, i + 1); 132 enaddr[i + 1] = pccard_tuple_read_1(tuple, i); 133 } 134 return (1); 135} 136 137static int 138ep_pccard_attach(device_t dev) 139{ 140 struct ep_softc *sc = device_get_softc(dev); 141 uint16_t result; 142 int error = 0; 143 const struct ep_pccard_product *pp; 144 145 if ((pp = ep_pccard_lookup(dev)) == NULL) 146 panic("ep_pccard_attach: can't find product in attach."); 147 148 if (pp->chipset == EP_CHIP_574) { 149 sc->epb.mii_trans = 1; 150 sc->epb.cmd_off = 2; 151 } else { 152 sc->epb.mii_trans = 0; 153 sc->epb.cmd_off = 0; 154 } 155 if ((error = ep_alloc(dev))) { 156 device_printf(dev, "ep_alloc() failed! (%d)\n", error); 157 goto bad; 158 } 159 160 if (pp->chipset == EP_CHIP_C1) 161 sc->stat |= F_HAS_TX_PLL; 162 163 /* ROM size = 0, ROM base = 0 */ 164 /* For now, ignore AUTO SELECT feature of 3C589B and later. */ 165 error = ep_get_e(sc, EEPROM_ADDR_CFG, &result); 166 CSR_WRITE_2(sc, EP_W0_ADDRESS_CFG, result & 0xc000); 167 168 /* 169 * Fake IRQ must be 3 for 3C589 and 3C589B. 3C589D and newer 170 * ignore this value. 3C589C is unknown, as are the other 171 * cards supported by this driver, but it appears to never hurt 172 * and always helps. 173 */ 174 SET_IRQ(sc, 3); 175 CSR_WRITE_2(sc, EP_W0_PRODUCT_ID, sc->epb.prod_id); 176 177 if (sc->epb.mii_trans) { 178 /* 179 * turn on the MII transciever 180 */ 181 GO_WINDOW(sc, 3); 182 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 183 DELAY(1000); 184 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0xc040); 185 CSR_WRITE_2(sc, EP_COMMAND, RX_RESET); 186 CSR_WRITE_2(sc, EP_COMMAND, TX_RESET); 187 EP_BUSY_WAIT(sc); 188 DELAY(1000); 189 CSR_WRITE_2(sc, EP_W3_OPTIONS, 0x8040); 190 } else 191 ep_get_media(sc); 192 193 /* 194 * The 3C562 (a-c revisions) stores the MAC in the CIS in a 195 * way that's unique to 3com. If we have one of these cards, 196 * scan the CIS for that MAC address, and use it if we find 197 * it. The NetBSD driver says that the ROADRUNNER chips also 198 * do this, which may be true, but none of the cards that I 199 * have include this TUPLE. Always prefer the MAC addr in the 200 * CIS tuple to the one returned by the card, as it appears that 201 * only those cards that need it have this special tuple. 202 */ 203 if (pccard_cis_scan(dev, ep_pccard_mac, sc->eaddr)) 204 sc->stat |= F_ENADDR_SKIP; 205 if ((error = ep_attach(sc))) { 206 device_printf(dev, "ep_attach() failed! (%d)\n", error); 207 goto bad; 208 } 209 if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET | INTR_MPSAFE, 210 NULL, ep_intr, sc, &sc->ep_intrhand))) { 211 device_printf(dev, "bus_setup_intr() failed! (%d)\n", error); 212 goto bad; 213 } 214 return (0); 215bad: 216 ep_free(dev); 217 return (error); 218} 219 220static device_method_t ep_pccard_methods[] = { 221 /* Device interface */ 222 DEVMETHOD(device_probe, ep_pccard_probe), 223 DEVMETHOD(device_attach, ep_pccard_attach), 224 DEVMETHOD(device_detach, ep_detach), 225 226 DEVMETHOD_END 227}; 228 229static driver_t ep_pccard_driver = { 230 "ep", 231 ep_pccard_methods, 232 sizeof(struct ep_softc), 233}; 234 235extern devclass_t ep_devclass; 236 237DRIVER_MODULE(ep, pccard, ep_pccard_driver, ep_devclass, 0, 0); 238PCCARD_PNP_INFO(ep_pccard_products); 239