Update cardbus/pccard support.
[dragonfly/port-amd64.git] / sys / dev / netif / ed / if_ed_pccard.c
blob8cb09211bf210e090b13e6d620ef5e906fceb3be
1 /*
2 * Copyright (c) 1995, David Greenman
3 * All rights reserved.
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 unmodified, this list of conditions, and the following
10 * disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
27 * $FreeBSD: src/sys/dev/ed/if_ed_pccard.c,v 1.55 2003/12/31 04:25:00 kato Exp $
28 * $DragonFly: src/sys/dev/netif/ed/if_ed_pccard.c,v 1.19 2007/07/05 12:08:53 sephe Exp $
31 #include "opt_ed.h"
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/socket.h>
36 #include <sys/kernel.h>
37 #include <sys/conf.h>
38 #include <sys/uio.h>
39 #include <sys/module.h>
40 #include <sys/bus.h>
41 #include <sys/rman.h>
43 #include <net/ethernet.h>
44 #include <net/if.h>
45 #include <net/if_arp.h>
46 #include <net/if_mib.h>
47 #include <net/if_media.h>
49 #include "if_edreg.h"
50 #include "if_edvar.h"
51 #include <bus/pccard/pccard_cis.h>
52 #include <bus/pccard/pccardvar.h>
53 #include <bus/pccard/pccarddevs.h>
54 #ifndef ED_NO_MIIBUS
55 #include <dev/netif/mii_layer/mii.h>
56 #include <dev/netif/mii_layer/miivar.h>
57 #endif
59 #include "card_if.h"
60 #ifndef ED_NO_MIIBUS
61 /* "device miibus" required. See GENERIC if you get errors here. */
62 #include "miibus_if.h"
64 MODULE_DEPEND(ed, miibus, 1, 1, 1);
65 #endif
66 MODULE_DEPEND(ed, pccard, 1, 1, 1);
69 * PC-Card (PCMCIA) specific code.
71 static int ed_pccard_match(device_t);
72 static int ed_pccard_probe(device_t);
73 static int ed_pccard_attach(device_t);
74 static int ed_pccard_detach(device_t);
76 static int ed_pccard_Linksys(device_t dev);
77 static int ed_pccard_ax88190(device_t dev);
79 static void ax88190_geteprom(struct ed_softc *);
80 static int ed_pccard_memwrite(device_t dev, off_t offset, u_char byte);
81 #ifndef ED_NO_MIIBUS
82 static void ed_pccard_dlink_mii_reset(struct ed_softc *sc);
83 static u_int ed_pccard_dlink_mii_readbits(struct ed_softc *sc, int nbits);
84 static void ed_pccard_dlink_mii_writebits(struct ed_softc *sc, u_int val,
85 int nbits);
86 #endif
89 * ed_pccard_detach - unload the driver and clear the table.
90 * XXX TODO:
91 * This is usually called when the card is ejected, but
92 * can be caused by a modunload of a controller driver.
93 * The idea is to reset the driver's view of the device
94 * and ensure that any driver entry points such as
95 * read and write do not hang.
97 static int
98 ed_pccard_detach(device_t dev)
100 struct ed_softc *sc = device_get_softc(dev);
101 struct ifnet *ifp = &sc->arpcom.ac_if;
103 lwkt_serialize_enter(ifp->if_serializer);
105 if (sc->gone) {
106 device_printf(dev, "already unloaded\n");
107 lwkt_serialize_exit(ifp->if_serializer);
108 return (0);
110 ed_stop(sc);
111 ifp->if_flags &= ~IFF_RUNNING;
112 sc->gone = 1;
113 bus_teardown_intr(dev, sc->irq_res, sc->irq_handle);
115 lwkt_serialize_exit(ifp->if_serializer);
117 ether_ifdetach(ifp);
118 ed_release_resources(dev);
119 return (0);
122 static const struct ed_product {
123 struct pccard_product prod;
124 int flags;
125 #define NE2000DVF_DL10019 0x0001 /* chip is D-Link DL10019 */
126 #define NE2000DVF_AX88190 0x0002 /* chip is ASIX AX88190 */
127 } ed_pccard_products[] = {
128 { PCMCIA_CARD(ACCTON, EN2212, 0), 0},
129 { PCMCIA_CARD(ALLIEDTELESIS, LA_PCM, 0), 0},
130 { PCMCIA_CARD(AMBICOM, AMB8002T, 0), 0},
131 { PCMCIA_CARD(BILLIONTON, LNT10TN, 0), 0},
132 { PCMCIA_CARD(BILLIONTON, CFLT10N, 0), 0},
133 { PCMCIA_CARD(BUFFALO, LPC3_CLT, 0), 0},
134 { PCMCIA_CARD(BUFFALO, LPC3_CLX, 0), NE2000DVF_AX88190},
135 { PCMCIA_CARD(BUFFALO, LPC_CF_CLT, 0), 0},
136 { PCMCIA_CARD(CNET, NE2000, 0), 0},
137 { PCMCIA_CARD(COMPEX, LINKPORT_ENET_B, 0), 0},
138 { PCMCIA_CARD(COREGA, ETHER_II_PCC_T, 0), 0},
139 { PCMCIA_CARD(COREGA, ETHER_II_PCC_TD, 0), 0},
140 { PCMCIA_CARD(COREGA, ETHER_PCC_T, 0), 0},
141 { PCMCIA_CARD(COREGA, ETHER_PCC_TD, 0), 0},
142 { PCMCIA_CARD(COREGA, FAST_ETHER_PCC_TX, 0), NE2000DVF_DL10019 },
143 { PCMCIA_CARD(COREGA, FETHER_PCC_TXD, 0), NE2000DVF_AX88190 },
144 { PCMCIA_CARD(COREGA, FETHER_PCC_TXF, 0), NE2000DVF_DL10019 },
145 { PCMCIA_CARD(DAYNA, COMMUNICARD_E_1, 0), 0},
146 { PCMCIA_CARD(DAYNA, COMMUNICARD_E_2, 0), 0},
147 { PCMCIA_CARD(DLINK, DE650, 0), 0},
148 { PCMCIA_CARD(DLINK, DE660, 0), 0 },
149 { PCMCIA_CARD(DLINK, DE660PLUS, 0), 0},
150 { PCMCIA_CARD(DLINK, DFE670TXD, 0), NE2000DVF_DL10019},
151 { PCMCIA_CARD(DYNALINK, L10C, 0), 0},
152 { PCMCIA_CARD(EDIMAX, EP4000A, 0), 0},
153 { PCMCIA_CARD(EPSON, EEN10B, 0), 0},
154 { PCMCIA_CARD(EXP, THINLANCOMBO, 0), 0},
155 { PCMCIA_CARD(IBM, INFOMOVER, 0), 0},
156 { PCMCIA_CARD(IODATA3, PCLAT, 0), 0},
157 { PCMCIA_CARD(KINGSTON, KNE2, 0), 0},
158 { PCMCIA_CARD(LANTECH, FASTNETTX, 0),NE2000DVF_AX88190 },
159 { PCMCIA_CARD(LINKSYS, COMBO_ECARD, 0), NE2000DVF_DL10019 },
160 { PCMCIA_CARD(LINKSYS, ECARD_1, 0), 0},
161 { PCMCIA_CARD(LINKSYS, ECARD_2, 0), 0},
162 { PCMCIA_CARD(LINKSYS, ETHERFAST, 0), NE2000DVF_DL10019 },
163 { PCMCIA_CARD(LINKSYS, TRUST_COMBO_ECARD, 0), 0},
164 { PCMCIA_CARD(MACNICA, ME1_JEIDA, 0), 0},
165 { PCMCIA_CARD(MELCO, LPC3_CLX, 0), NE2000DVF_AX88190},
166 { PCMCIA_CARD(MELCO, LPC3_TX, 0), NE2000DVF_AX88190 },
167 { PCMCIA_CARD(NDC, ND5100_E, 0), 0},
168 { PCMCIA_CARD(NETGEAR, FA410TXC, 0), NE2000DVF_DL10019},
169 { PCMCIA_CARD(NETGEAR, FA411, 0), NE2000DVF_AX88190},
170 { PCMCIA_CARD(NEXTCOM, NEXTHAWK, 0), 0},
171 { PCMCIA_CARD(OEM2, ETHERNET, 0), 0},
172 { PCMCIA_CARD(PLANET, SMARTCOM2000, 0), 0 },
173 { PCMCIA_CARD(PREMAX, PE200, 0), 0},
174 { PCMCIA_CARD(RACORE, ETHERNET, 0), 0},
175 { PCMCIA_CARD(RPTI, EP400, 0), 0},
176 { PCMCIA_CARD(RPTI, EP401, 0), 0},
177 { PCMCIA_CARD(SMC, EZCARD, 0), 0},
178 { PCMCIA_CARD(SOCKET, EA_ETHER, 0), 0},
179 { PCMCIA_CARD(SOCKET, LP_ETHER, 0), 0},
180 { PCMCIA_CARD(SOCKET, LP_ETHER_CF, 0), 0},
181 { PCMCIA_CARD(SOCKET, LP_ETH_10_100_CF, 0), NE2000DVF_DL10019},
182 { PCMCIA_CARD(SVEC, COMBOCARD, 0), 0},
183 { PCMCIA_CARD(SVEC, LANCARD, 0), 0},
184 { PCMCIA_CARD(TAMARACK, ETHERNET, 0), 0},
185 { PCMCIA_CARD(TDK, LAK_CD031, 0), 0},
186 { PCMCIA_CARD(TELECOMDEVICE, TCD_HPC100, 0), NE2000DVF_AX88190 },
187 { PCMCIA_CARD(XIRCOM, CFE_10, 0), 0},
188 { PCMCIA_CARD(ZONET, ZEN, 0), 0},
189 { { NULL } }
192 static int
193 ed_pccard_match(device_t dev)
195 const struct ed_product *pp;
197 if ((pp = (const struct ed_product *) pccard_product_lookup(dev,
198 (const struct pccard_product *) ed_pccard_products,
199 sizeof(ed_pccard_products[0]), NULL)) != NULL) {
200 if (pp->prod.pp_name != NULL)
201 device_set_desc(dev, pp->prod.pp_name);
202 if (pp->flags & NE2000DVF_DL10019)
203 device_set_flags(dev, ED_FLAGS_LINKSYS);
204 else if (pp->flags & NE2000DVF_AX88190)
205 device_set_flags(dev, ED_FLAGS_AX88190);
206 return (0);
208 return (EIO);
212 * Probe framework for pccards. Replicates the standard framework,
213 * minus the pccard driver registration and ignores the ether address
214 * supplied (from the CIS), relying on the probe to find it instead.
216 static int
217 ed_pccard_probe(device_t dev)
219 int error;
220 int flags = device_get_flags(dev);
222 if (ED_FLAGS_GETTYPE(flags) == ED_FLAGS_AX88190) {
223 error = ed_pccard_ax88190(dev);
224 goto end2;
227 error = ed_probe_Novell(dev, 0, flags);
228 if (error == 0)
229 goto end;
230 ed_release_resources(dev);
232 error = ed_probe_WD80x3(dev, 0, flags);
233 if (error == 0)
234 goto end;
235 ed_release_resources(dev);
236 goto end2;
238 end:
239 if (ED_FLAGS_GETTYPE(flags) & ED_FLAGS_LINKSYS)
240 ed_pccard_Linksys(dev);
241 end2:
242 if (error == 0)
243 error = ed_alloc_irq(dev, 0, 0);
245 ed_release_resources(dev);
246 return (error);
249 static int
250 ed_pccard_attach(device_t dev)
252 struct ed_softc *sc = device_get_softc(dev);
253 int error;
254 int i;
255 uint8_t sum;
256 uint8_t *ether_addr;
258 if (sc->port_used > 0)
259 ed_alloc_port(dev, sc->port_rid, sc->port_used);
260 if (sc->mem_used)
261 ed_alloc_memory(dev, sc->mem_rid, sc->mem_used);
262 ed_alloc_irq(dev, sc->irq_rid, 0);
264 if (sc->vendor != ED_VENDOR_LINKSYS) {
265 ether_addr = pccard_get_ether(dev);
266 for (i = 0, sum = 0; i < ETHER_ADDR_LEN; i++)
267 sum |= ether_addr[i];
268 if (sum)
269 bcopy(ether_addr, sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
272 error = ed_attach(dev);
273 #ifndef ED_NO_MIIBUS
274 if (error == 0 && sc->vendor == ED_VENDOR_LINKSYS) {
275 /* Probe for an MII bus, but ignore errors. */
276 ed_pccard_dlink_mii_reset(sc);
277 sc->mii_readbits = ed_pccard_dlink_mii_readbits;
278 sc->mii_writebits = ed_pccard_dlink_mii_writebits;
279 mii_phy_probe(dev, &sc->miibus, ed_ifmedia_upd,
280 ed_ifmedia_sts);
282 #endif
284 error = bus_setup_intr(dev, sc->irq_res, INTR_NETSAFE,
285 edintr, sc, &sc->irq_handle,
286 sc->arpcom.ac_if.if_serializer);
287 if (error) {
288 kprintf("setup intr failed %d \n", error);
289 ed_release_resources(dev);
290 return (error);
293 return (error);
296 static void
297 ax88190_geteprom(struct ed_softc *sc)
299 int prom[16],i;
300 u_char tmp;
301 struct {
302 u_char offset, value;
303 } pg_seq[] = {
304 {ED_P0_CR, ED_CR_RD2|ED_CR_STP}, /* Select Page0 */
305 {ED_P0_DCR, 0x01},
306 {ED_P0_RBCR0, 0x00}, /* Clear the count regs. */
307 {ED_P0_RBCR1, 0x00},
308 {ED_P0_IMR, 0x00}, /* Mask completion irq. */
309 {ED_P0_ISR, 0xff},
310 {ED_P0_RCR, ED_RCR_MON | ED_RCR_INTT}, /* Set To Monitor */
311 {ED_P0_TCR, ED_TCR_LB0}, /* loopback mode. */
312 {ED_P0_RBCR0, 32},
313 {ED_P0_RBCR1, 0x00},
314 {ED_P0_RSAR0, 0x00},
315 {ED_P0_RSAR1, 0x04},
316 {ED_P0_CR ,ED_CR_RD0 | ED_CR_STA},
319 /* Reset Card */
320 tmp = ed_asic_inb(sc, ED_NOVELL_RESET);
321 ed_asic_outb(sc, ED_NOVELL_RESET, tmp);
322 DELAY(5000);
323 ed_asic_outb(sc, ED_P0_CR, ED_CR_RD2 | ED_CR_STP);
324 DELAY(5000);
326 /* Card Settings */
327 for (i = 0; i < sizeof(pg_seq) / sizeof(pg_seq[0]); i++)
328 ed_nic_outb(sc, pg_seq[i].offset, pg_seq[i].value);
330 /* Get Data */
331 for (i = 0; i < 16; i++)
332 prom[i] = ed_asic_inb(sc, 0);
333 sc->arpcom.ac_enaddr[0] = prom[0] & 0xff;
334 sc->arpcom.ac_enaddr[1] = prom[0] >> 8;
335 sc->arpcom.ac_enaddr[2] = prom[1] & 0xff;
336 sc->arpcom.ac_enaddr[3] = prom[1] >> 8;
337 sc->arpcom.ac_enaddr[4] = prom[2] & 0xff;
338 sc->arpcom.ac_enaddr[5] = prom[2] >> 8;
341 static int
342 ed_pccard_memwrite(device_t dev, off_t offset, u_char byte)
344 int cis_rid;
345 struct resource *cis;
347 cis_rid = 0;
348 cis = bus_alloc_resource(dev, SYS_RES_MEMORY, &cis_rid, 0, ~0,
349 4 << 10, RF_ACTIVE | RF_SHAREABLE);
350 if (cis == NULL)
351 return (ENXIO);
352 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY,
353 cis_rid, PCCARD_A_MEM_ATTR);
355 bus_space_write_1(rman_get_bustag(cis), rman_get_bushandle(cis),
356 offset, byte);
358 bus_deactivate_resource(dev, SYS_RES_MEMORY, cis_rid, cis);
359 bus_release_resource(dev, SYS_RES_MEMORY, cis_rid, cis);
361 return (0);
365 * Probe the Ethernet MAC addrees for PCMCIA Linksys EtherFast 10/100
366 * and compatible cards (DL10019C Ethernet controller).
368 * Note: The PAO patches try to use more memory for the card, but that
369 * seems to fail for my card. A future optimization would add this back
370 * conditionally.
372 static int
373 ed_pccard_Linksys(device_t dev)
375 struct ed_softc *sc = device_get_softc(dev);
376 u_char sum;
377 int i;
380 * Linksys registers(offset from ASIC base)
382 * 0x04-0x09 : Physical Address Register 0-5 (PAR0-PAR5)
383 * 0x0A : Card ID Register (CIR)
384 * 0x0B : Check Sum Register (SR)
386 for (sum = 0, i = 0x04; i < 0x0c; i++)
387 sum += ed_asic_inb(sc, i);
388 if (sum != 0xff)
389 return (0); /* invalid DL10019C */
390 for (i = 0; i < ETHER_ADDR_LEN; i++) {
391 sc->arpcom.ac_enaddr[i] = ed_asic_inb(sc, 0x04 + i);
394 ed_nic_outb(sc, ED_P0_DCR, ED_DCR_WTS | ED_DCR_FT1 | ED_DCR_LS);
395 sc->isa16bit = 1;
396 sc->vendor = ED_VENDOR_LINKSYS;
397 sc->type = ED_TYPE_NE2000;
398 sc->type_str = "Linksys";
400 return (1);
404 * Special setup for AX88190
406 static int
407 ed_pccard_ax88190(device_t dev)
409 int error;
410 int flags = device_get_flags(dev);
411 int iobase;
412 struct ed_softc *sc = device_get_softc(dev);
414 /* Allocate the port resource during setup. */
415 error = ed_alloc_port(dev, 0, ED_NOVELL_IO_PORTS);
416 if (error)
417 return (error);
419 sc->asic_offset = ED_NOVELL_ASIC_OFFSET;
420 sc->nic_offset = ED_NOVELL_NIC_OFFSET;
421 sc->chip_type = ED_CHIP_TYPE_AX88190;
424 * Set Attribute Memory IOBASE Register. Is this a deficiency in
425 * the PC Card layer, or an ax88190 specific issue? xxx
427 iobase = rman_get_start(sc->port_res);
428 ed_pccard_memwrite(dev, ED_AX88190_IOBASE0, iobase & 0xff);
429 ed_pccard_memwrite(dev, ED_AX88190_IOBASE1, (iobase >> 8) & 0xff);
430 ax88190_geteprom(sc);
431 ed_release_resources(dev);
432 error = ed_probe_Novell(dev, 0, flags);
433 if (error == 0) {
434 sc->vendor = ED_VENDOR_PCCARD;
435 sc->type = ED_TYPE_NE2000;
436 sc->type_str = "AX88190";
438 return (error);
441 #ifndef ED_NO_MIIBUS
442 /* MII bit-twiddling routines for cards using Dlink chipset */
443 #define DLINK_MIISET(sc, x) ed_asic_outb(sc, ED_DLINK_MIIBUS, \
444 ed_asic_inb(sc, ED_DLINK_MIIBUS) | (x))
445 #define DLINK_MIICLR(sc, x) ed_asic_outb(sc, ED_DLINK_MIIBUS, \
446 ed_asic_inb(sc, ED_DLINK_MIIBUS) & ~(x))
448 static void
449 ed_pccard_dlink_mii_reset(struct ed_softc *sc)
451 ed_asic_outb(sc, ED_DLINK_MIIBUS, 0);
452 DELAY(10);
453 DLINK_MIISET(sc, ED_DLINK_MII_RESET2);
454 DELAY(10);
455 DLINK_MIISET(sc, ED_DLINK_MII_RESET1);
456 DELAY(10);
457 DLINK_MIICLR(sc, ED_DLINK_MII_RESET1);
458 DELAY(10);
459 DLINK_MIICLR(sc, ED_DLINK_MII_RESET2);
460 DELAY(10);
463 static void
464 ed_pccard_dlink_mii_writebits(struct ed_softc *sc, u_int val, int nbits)
466 int i;
468 DLINK_MIISET(sc, ED_DLINK_MII_DIROUT);
470 for (i = nbits - 1; i >= 0; i--) {
471 if ((val >> i) & 1)
472 DLINK_MIISET(sc, ED_DLINK_MII_DATAOUT);
473 else
474 DLINK_MIICLR(sc, ED_DLINK_MII_DATAOUT);
475 DELAY(10);
476 DLINK_MIISET(sc, ED_DLINK_MII_CLK);
477 DELAY(10);
478 DLINK_MIICLR(sc, ED_DLINK_MII_CLK);
479 DELAY(10);
483 static u_int
484 ed_pccard_dlink_mii_readbits(struct ed_softc *sc, int nbits)
486 int i;
487 u_int val = 0;
489 DLINK_MIICLR(sc, ED_DLINK_MII_DIROUT);
491 for (i = nbits - 1; i >= 0; i--) {
492 DLINK_MIISET(sc, ED_DLINK_MII_CLK);
493 DELAY(10);
494 val <<= 1;
495 if (ed_asic_inb(sc, ED_DLINK_MIIBUS) & ED_DLINK_MII_DATATIN)
496 val++;
497 DLINK_MIICLR(sc, ED_DLINK_MII_CLK);
498 DELAY(10);
501 return val;
503 #endif
505 static device_method_t ed_pccard_methods[] = {
506 /* Device interface */
507 DEVMETHOD(device_probe, pccard_compat_probe),
508 DEVMETHOD(device_attach, pccard_compat_attach),
509 DEVMETHOD(device_detach, ed_pccard_detach),
511 #ifndef ED_NO_MIIBUS
512 /* Bus interface */
513 DEVMETHOD(bus_child_detached, ed_child_detached),
515 /* MII interface */
516 DEVMETHOD(miibus_readreg, ed_miibus_readreg),
517 DEVMETHOD(miibus_writereg, ed_miibus_writereg),
518 #endif
520 /* Card interface */
521 DEVMETHOD(card_compat_match, ed_pccard_match),
522 DEVMETHOD(card_compat_probe, ed_pccard_probe),
523 DEVMETHOD(card_compat_attach, ed_pccard_attach),
524 { 0, 0 }
527 static driver_t ed_pccard_driver = {
528 "ed",
529 ed_pccard_methods,
530 sizeof(struct ed_softc)
533 DRIVER_MODULE(if_ed, pccard, ed_pccard_driver, ed_devclass, 0, 0);
534 #ifndef ED_NO_MIIBUS
535 MODULE_DEPEND(if_ed, miibus, 1, 1, 1);
536 DRIVER_MODULE(miibus, ed, miibus_driver, miibus_devclass, 0, 0);
537 #endif