if_ed_pccard.c revision 113320 
1/*
2 * Copyright (c) 1995, David Greenman
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 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.
14 *
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.
26 *
27 * $FreeBSD: head/sys/dev/ed/if_ed_pccard.c 113320 2003-04-10 07:04:39Z imp $
28 */
29
30#include "opt_ed.h"
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/socket.h>
35#include <sys/kernel.h>
36#include <sys/conf.h>
37#include <sys/uio.h>
38
39#include <sys/module.h>
40#include <sys/bus.h>
41#include <machine/bus.h>
42#include <sys/rman.h>
43#include <machine/resource.h>
44
45#include <net/ethernet.h>
46#include <net/if.h>
47#include <net/if_arp.h>
48#include <net/if_mib.h>
49#include <net/if_media.h>
50
51#include <dev/ed/if_edreg.h>
52#include <dev/ed/if_edvar.h>
53#include <dev/pccard/pccardvar.h>
54#include <dev/pccard/pccarddevs.h>
55#ifndef ED_NO_MIIBUS
56#include <dev/mii/mii.h>
57#include <dev/mii/miivar.h>
58#endif
59
60#include "card_if.h"
61#ifndef ED_NO_MIIBUS
62/* "device miibus" required.  See GENERIC if you get errors here. */
63#include "miibus_if.h"
64
65MODULE_DEPEND(ed, miibus, 1, 1, 1);
66#endif
67
68/*
69 *      PC-Card (PCMCIA) specific code.
70 */
71static int	ed_pccard_match(device_t);
72static int	ed_pccard_probe(device_t);
73static int	ed_pccard_attach(device_t);
74static int	ed_pccard_detach(device_t);
75
76static int	ed_pccard_Linksys(device_t dev);
77static int	ed_pccard_ax88190(device_t dev);
78
79static void	ax88190_geteprom(struct ed_softc *);
80static int	ed_pccard_memwrite(device_t dev, off_t offset, u_char byte);
81#ifndef ED_NO_MIIBUS
82static void	ed_pccard_dlink_mii_reset(struct ed_softc *sc);
83static u_int	ed_pccard_dlink_mii_readbits(struct ed_softc *sc, int nbits);
84static void	ed_pccard_dlink_mii_writebits(struct ed_softc *sc, u_int val,
85    int nbits);
86#endif
87
88/*
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.
96 */
97static int
98ed_pccard_detach(device_t dev)
99{
100	struct ed_softc *sc = device_get_softc(dev);
101	struct ifnet *ifp = &sc->arpcom.ac_if;
102
103	if (sc->gone) {
104		device_printf(dev, "already unloaded\n");
105		return (0);
106	}
107	ed_stop(sc);
108	ifp->if_flags &= ~IFF_RUNNING;
109	ether_ifdetach(ifp);
110	sc->gone = 1;
111	bus_teardown_intr(dev, sc->irq_res, sc->irq_handle);
112	ed_release_resources(dev);
113	return (0);
114}
115
116static const struct ed_product {
117	struct pccard_product	prod;
118	int flags;
119#define	NE2000DVF_DL10019	0x0001		/* chip is D-Link DL10019 */
120#define	NE2000DVF_AX88190	0x0002		/* chip is ASIX AX88190 */
121} ed_pccard_products[] = {
122	{ PCMCIA_CARD(ACCTON, EN2212, 0), 0},
123	{ PCMCIA_CARD(ALLIEDTELESIS, LA_PCM, 0), 0},
124	{ PCMCIA_CARD(AMBICOM, AMB8002T, 0), 0},
125	{ PCMCIA_CARD(BILLIONTON, LNT10TN, 0), 0},
126	{ PCMCIA_CARD(BUFFALO, LPC3_CLT,  0), 0},
127	{ PCMCIA_CARD(BUFFALO, LPC_CF_CLT,  0), 0},
128	{ PCMCIA_CARD(CNET, NE2000, 0), 0},
129	{ PCMCIA_CARD(COMPEX, LINKPORT_ENET_B, 0), 0},
130	{ PCMCIA_CARD(COREGA, ETHER_II_PCC_T, 0), 0},
131	{ PCMCIA_CARD(COREGA, ETHER_II_PCC_TD, 0), 0},
132	{ PCMCIA_CARD(COREGA, ETHER_PCC_T, 0), 0},
133	{ PCMCIA_CARD(COREGA, ETHER_PCC_TD, 0), 0},
134	{ PCMCIA_CARD(COREGA, FAST_ETHER_PCC_TX, 0), NE2000DVF_DL10019 },
135	{ PCMCIA_CARD(COREGA, FETHER_PCC_TXD, 0), NE2000DVF_AX88190 },
136	{ PCMCIA_CARD(COREGA, FETHER_PCC_TXF, 0), NE2000DVF_DL10019 },
137	{ PCMCIA_CARD(DAYNA, COMMUNICARD_E_1, 0), 0},
138	{ PCMCIA_CARD(DAYNA, COMMUNICARD_E_2, 0), 0},
139	{ PCMCIA_CARD(DIGITAL, DEPCMXX, 0), 0 },
140	{ PCMCIA_CARD(DLINK, DE650, 0), 0},
141	{ PCMCIA_CARD(DLINK, DE660, 0), 0 },
142	{ PCMCIA_CARD(DLINK, DE660PLUS, 0), 0},
143	{ PCMCIA_CARD(DLINK, DFE670TXD, 0), NE2000DVF_DL10019},
144	{ PCMCIA_CARD(DYNALINK, L10C, 0), 0},
145	{ PCMCIA_CARD(EDIMAX, EP4000A, 0), 0},
146	{ PCMCIA_CARD(EPSON, EEN10B, 0), 0},
147	{ PCMCIA_CARD(IBM, INFOMOVER, 0), 0},
148	{ PCMCIA_CARD(IODATA, PCLAT, 0), 0},
149	{ PCMCIA_CARD(IODATA, PCLATE, 0), 0},
150	{ PCMCIA_CARD(KINGSTON, KNE2, 0), 0},
151	{ PCMCIA_CARD(KINGSTON, KNE2, 0), 0},
152	{ PCMCIA_CARD(LANTECH, FASTNETTX, 0),NE2000DVF_AX88190 },
153	{ PCMCIA_CARD(LINKSYS, COMBO_ECARD, 0), NE2000DVF_DL10019 },
154	{ PCMCIA_CARD(LINKSYS, ECARD_1, 0), 0},
155	{ PCMCIA_CARD(LINKSYS, ECARD_2, 0), 0},
156	{ PCMCIA_CARD(LINKSYS, ETHERFAST, 0), NE2000DVF_DL10019 },
157	{ PCMCIA_CARD(LINKSYS, PCM100, 0), 0},
158	{ PCMCIA_CARD(LINKSYS, TRUST_COMBO_ECARD, 0), 0},
159	{ PCMCIA_CARD(LINKSYS, ETHERFAST, 0), NE2000DVF_DL10019 },
160	{ PCMCIA_CARD(MACNICA, ME1_JEIDA, 0), 0},
161	{ PCMCIA_CARD(MELCO, LPC3_TX, 0), NE2000DVF_AX88190 },
162	{ PCMCIA_CARD(NDC, ND5100_E, 0), 0},
163	{ PCMCIA_CARD(NETGEAR, FA410TXC, 0), NE2000DVF_DL10019},
164	{ PCMCIA_CARD(NETGEAR, FA411, 0), NE2000DVF_AX88190},
165	{ PCMCIA_CARD(PLANET, SMARTCOM2000, 0), 0 },
166	{ PCMCIA_CARD(PREMAX, PE200, 0), 0},
167	{ PCMCIA_CARD(RPTI, EP400, 0), 0},
168	{ PCMCIA_CARD(RPTI, EP401, 0), 0},
169	{ PCMCIA_CARD(SMC, EZCARD, 0), 0},
170	{ PCMCIA_CARD(SOCKET, EA_ETHER, 0), 0},
171	{ PCMCIA_CARD(SOCKET, LP_ETHER, 0), 0},
172	{ PCMCIA_CARD(SOCKET, LP_ETHER_CF, 0), 0},
173	{ PCMCIA_CARD(SVEC, COMBOCARD, 0), 0},
174	{ PCMCIA_CARD(SVEC, LANCARD, 0), 0},
175	{ PCMCIA_CARD(SYNERGY21, S21810, 0), 0},
176	{ PCMCIA_CARD(TELECOMDEVICE, TCD_HPC100, 0), NE2000DVF_AX88190 },
177	{ PCMCIA_CARD(XIRCOM, CFE_10, 0), 0},
178	{ PCMCIA_CARD(ZONET, ZEN, 0), 0},
179	{ { NULL } }
180};
181
182static int
183ed_pccard_match(device_t dev)
184{
185	const struct ed_product *pp;
186
187	if ((pp = (const struct ed_product *) pccard_product_lookup(dev,
188	    (const struct pccard_product *) ed_pccard_products,
189	    sizeof(ed_pccard_products[0]), NULL)) != NULL) {
190		if (pp->prod.pp_name != NULL)
191			device_set_desc(dev, pp->prod.pp_name);
192		if (pp->flags & NE2000DVF_DL10019)
193			device_set_flags(dev, ED_FLAGS_LINKSYS);
194		else if (pp->flags & NE2000DVF_AX88190)
195			device_set_flags(dev, ED_FLAGS_AX88190);
196		return (0);
197	}
198	return (EIO);
199}
200
201/*
202 * Probe framework for pccards.  Replicates the standard framework,
203 * minus the pccard driver registration and ignores the ether address
204 * supplied (from the CIS), relying on the probe to find it instead.
205 */
206static int
207ed_pccard_probe(device_t dev)
208{
209	int	error;
210	int	flags = device_get_flags(dev);
211
212	if (ED_FLAGS_GETTYPE(flags) == ED_FLAGS_AX88190) {
213		error = ed_pccard_ax88190(dev);
214		goto end2;
215	}
216
217	error = ed_probe_Novell(dev, 0, flags);
218	if (error == 0)
219		goto end;
220	ed_release_resources(dev);
221
222	error = ed_probe_WD80x3(dev, 0, flags);
223	if (error == 0)
224		goto end;
225	ed_release_resources(dev);
226	goto end2;
227
228end:
229	if (ED_FLAGS_GETTYPE(flags) & ED_FLAGS_LINKSYS)
230		ed_pccard_Linksys(dev);
231end2:
232	if (error == 0)
233		error = ed_alloc_irq(dev, 0, 0);
234
235	ed_release_resources(dev);
236	return (error);
237}
238
239static int
240ed_pccard_attach(device_t dev)
241{
242	int error;
243	int	flags = device_get_flags(dev);
244	int i;
245	struct ed_softc *sc = device_get_softc(dev);
246	u_char sum;
247	u_char ether_addr[ETHER_ADDR_LEN];
248
249	if (sc->port_used > 0)
250		ed_alloc_port(dev, sc->port_rid, sc->port_used);
251	if (sc->mem_used)
252		ed_alloc_memory(dev, sc->mem_rid, sc->mem_used);
253	ed_alloc_irq(dev, sc->irq_rid, 0);
254
255	error = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_NET,
256			       edintr, sc, &sc->irq_handle);
257	if (error) {
258		printf("setup intr failed %d \n", error);
259		ed_release_resources(dev);
260		return (error);
261	}
262
263	if (sc->vendor != ED_VENDOR_LINKSYS) {
264		pccard_get_ether(dev, ether_addr);
265		for (i = 0, sum = 0; i < ETHER_ADDR_LEN; i++)
266			sum |= ether_addr[i];
267		if (sum)
268			bcopy(ether_addr, sc->arpcom.ac_enaddr, ETHER_ADDR_LEN);
269	}
270
271	error = ed_attach(sc, device_get_unit(dev), flags);
272#ifndef ED_NO_MIIBUS
273	if (error == 0 && sc->vendor == ED_VENDOR_LINKSYS) {
274		/* Probe for an MII bus, but ignore errors. */
275		ed_pccard_dlink_mii_reset(sc);
276		sc->mii_readbits = ed_pccard_dlink_mii_readbits;
277		sc->mii_writebits = ed_pccard_dlink_mii_writebits;
278		mii_phy_probe(dev, &sc->miibus, ed_ifmedia_upd,
279		    ed_ifmedia_sts);
280	}
281#endif
282
283	return (error);
284}
285
286static void
287ax88190_geteprom(struct ed_softc *sc)
288{
289	int prom[16],i;
290	u_char tmp;
291	struct {
292		unsigned char offset, value;
293	} pg_seq[] = {
294		{ED_P0_CR, ED_CR_RD2|ED_CR_STP},/* Select Page0 */
295		{ED_P0_DCR, 0x01},
296		{ED_P0_RBCR0, 0x00},		/* Clear the count regs. */
297		{ED_P0_RBCR1, 0x00},
298		{ED_P0_IMR, 0x00},		/* Mask completion irq. */
299		{ED_P0_ISR, 0xff},
300		{ED_P0_RCR, ED_RCR_MON | ED_RCR_INTT}, /* Set To Monitor */
301		{ED_P0_TCR, ED_TCR_LB0},	/* loopback mode. */
302		{ED_P0_RBCR0, 32},
303		{ED_P0_RBCR1, 0x00},
304		{ED_P0_RSAR0, 0x00},
305		{ED_P0_RSAR1, 0x04},
306		{ED_P0_CR ,ED_CR_RD0 | ED_CR_STA},
307	};
308
309	/* Reset Card */
310	tmp = ed_asic_inb(sc, ED_NOVELL_RESET);
311	ed_asic_outb(sc, ED_NOVELL_RESET, tmp);
312	DELAY(5000);
313	ed_asic_outb(sc, ED_P0_CR, ED_CR_RD2 | ED_CR_STP);
314	DELAY(5000);
315
316	/* Card Settings */
317	for (i = 0; i < sizeof(pg_seq) / sizeof(pg_seq[0]); i++)
318		ed_nic_outb(sc, pg_seq[i].offset, pg_seq[i].value);
319
320	/* Get Data */
321	for (i = 0; i < 16; i++)
322		prom[i] = ed_asic_inb(sc, 0);
323	sc->arpcom.ac_enaddr[0] = prom[0] & 0xff;
324	sc->arpcom.ac_enaddr[1] = prom[0] >> 8;
325	sc->arpcom.ac_enaddr[2] = prom[1] & 0xff;
326	sc->arpcom.ac_enaddr[3] = prom[1] >> 8;
327	sc->arpcom.ac_enaddr[4] = prom[2] & 0xff;
328	sc->arpcom.ac_enaddr[5] = prom[2] >> 8;
329}
330
331static int
332ed_pccard_memwrite(device_t dev, off_t offset, u_char byte)
333{
334	int cis_rid;
335	struct resource *cis;
336
337	cis_rid = 0;
338	cis = bus_alloc_resource(dev, SYS_RES_MEMORY, &cis_rid, 0, ~0,
339	    4 << 10, RF_ACTIVE | RF_SHAREABLE);
340	if (cis == NULL)
341		return (ENXIO);
342	CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY,
343	    cis_rid, PCCARD_A_MEM_ATTR);
344
345	bus_space_write_1(rman_get_bustag(cis), rman_get_bushandle(cis),
346	    offset, byte);
347
348	bus_deactivate_resource(dev, SYS_RES_MEMORY, cis_rid, cis);
349	bus_release_resource(dev, SYS_RES_MEMORY, cis_rid, cis);
350
351	return (0);
352}
353
354/*
355 * Probe the Ethernet MAC addrees for PCMCIA Linksys EtherFast 10/100
356 * and compatible cards (DL10019C Ethernet controller).
357 *
358 * Note: The PAO patches try to use more memory for the card, but that
359 * seems to fail for my card.  A future optimization would add this back
360 * conditionally.
361 */
362static int
363ed_pccard_Linksys(device_t dev)
364{
365	struct ed_softc *sc = device_get_softc(dev);
366	u_char sum;
367	int i;
368
369	/*
370	 * Linksys registers(offset from ASIC base)
371	 *
372	 * 0x04-0x09 : Physical Address Register 0-5 (PAR0-PAR5)
373	 * 0x0A      : Card ID Register (CIR)
374	 * 0x0B      : Check Sum Register (SR)
375	 */
376	for (sum = 0, i = 0x04; i < 0x0c; i++)
377		sum += ed_asic_inb(sc, i);
378	if (sum != 0xff)
379		return (0);		/* invalid DL10019C */
380	for (i = 0; i < ETHER_ADDR_LEN; i++) {
381		sc->arpcom.ac_enaddr[i] = ed_asic_inb(sc, 0x04 + i);
382	}
383
384	ed_nic_outb(sc, ED_P0_DCR, ED_DCR_WTS | ED_DCR_FT1 | ED_DCR_LS);
385	sc->isa16bit = 1;
386	sc->vendor = ED_VENDOR_LINKSYS;
387	sc->type = ED_TYPE_NE2000;
388	sc->type_str = "Linksys";
389
390	return (1);
391}
392
393/*
394 * Special setup for AX88190
395 */
396static int
397ed_pccard_ax88190(device_t dev)
398{
399	int	error;
400	int	flags = device_get_flags(dev);
401	int	iobase;
402	struct	ed_softc *sc = device_get_softc(dev);
403
404	/* Allocate the port resource during setup. */
405	error = ed_alloc_port(dev, 0, ED_NOVELL_IO_PORTS);
406	if (error)
407		return (error);
408
409	sc->asic_offset = ED_NOVELL_ASIC_OFFSET;
410	sc->nic_offset  = ED_NOVELL_NIC_OFFSET;
411	sc->chip_type = ED_CHIP_TYPE_AX88190;
412
413	/*
414	 * Set Attribute Memory IOBASE Register
415	 */
416	iobase = rman_get_start(sc->port_res);
417	ed_pccard_memwrite(dev, ED_AX88190_IOBASE0, iobase & 0xff);
418	ed_pccard_memwrite(dev, ED_AX88190_IOBASE1, (iobase >> 8) & 0xff);
419	ax88190_geteprom(sc);
420	ed_release_resources(dev);
421	error = ed_probe_Novell(dev, 0, flags);
422	if (error == 0) {
423		sc->vendor = ED_VENDOR_PCCARD;
424		sc->type = ED_TYPE_NE2000;
425		sc->type_str = "AX88190";
426	}
427	return (error);
428}
429
430#ifndef ED_NO_MIIBUS
431/* MII bit-twiddling routines for cards using Dlink chipset */
432#define DLINK_MIISET(sc, x) ed_asic_outb(sc, ED_DLINK_MIIBUS, \
433    ed_asic_inb(sc, ED_DLINK_MIIBUS) | (x))
434#define DLINK_MIICLR(sc, x) ed_asic_outb(sc, ED_DLINK_MIIBUS, \
435    ed_asic_inb(sc, ED_DLINK_MIIBUS) & ~(x))
436
437static void
438ed_pccard_dlink_mii_reset(sc)
439	struct ed_softc *sc;
440{
441	ed_asic_outb(sc, ED_DLINK_MIIBUS, 0);
442	DELAY(10);
443	DLINK_MIISET(sc, ED_DLINK_MII_RESET2);
444	DELAY(10);
445	DLINK_MIISET(sc, ED_DLINK_MII_RESET1);
446	DELAY(10);
447	DLINK_MIICLR(sc, ED_DLINK_MII_RESET1);
448	DELAY(10);
449	DLINK_MIICLR(sc, ED_DLINK_MII_RESET2);
450	DELAY(10);
451}
452
453static void
454ed_pccard_dlink_mii_writebits(sc, val, nbits)
455	struct ed_softc *sc;
456	u_int val;
457	int nbits;
458{
459	int i;
460
461	DLINK_MIISET(sc, ED_DLINK_MII_DIROUT);
462
463	for (i = nbits - 1; i >= 0; i--) {
464		if ((val >> i) & 1)
465			DLINK_MIISET(sc, ED_DLINK_MII_DATAOUT);
466		else
467			DLINK_MIICLR(sc, ED_DLINK_MII_DATAOUT);
468		DELAY(10);
469		DLINK_MIISET(sc, ED_DLINK_MII_CLK);
470		DELAY(10);
471		DLINK_MIICLR(sc, ED_DLINK_MII_CLK);
472		DELAY(10);
473	}
474}
475
476static u_int
477ed_pccard_dlink_mii_readbits(sc, nbits)
478	struct ed_softc *sc;
479	int nbits;
480{
481	int i;
482	u_int val = 0;
483
484	DLINK_MIICLR(sc, ED_DLINK_MII_DIROUT);
485
486	for (i = nbits - 1; i >= 0; i--) {
487		DLINK_MIISET(sc, ED_DLINK_MII_CLK);
488		DELAY(10);
489		val <<= 1;
490		if (ed_asic_inb(sc, ED_DLINK_MIIBUS) & ED_DLINK_MII_DATATIN)
491			val++;
492		DLINK_MIICLR(sc, ED_DLINK_MII_CLK);
493		DELAY(10);
494	}
495
496	return val;
497}
498#endif
499
500static device_method_t ed_pccard_methods[] = {
501	/* Device interface */
502	DEVMETHOD(device_probe,		pccard_compat_probe),
503	DEVMETHOD(device_attach,	pccard_compat_attach),
504	DEVMETHOD(device_detach,	ed_pccard_detach),
505
506#ifndef ED_NO_MIIBUS
507	/* Bus interface */
508	DEVMETHOD(bus_child_detached,	ed_child_detached),
509
510	/* MII interface */
511	DEVMETHOD(miibus_readreg,	ed_miibus_readreg),
512	DEVMETHOD(miibus_writereg,	ed_miibus_writereg),
513#endif
514
515	/* Card interface */
516	DEVMETHOD(card_compat_match,	ed_pccard_match),
517	DEVMETHOD(card_compat_probe,	ed_pccard_probe),
518	DEVMETHOD(card_compat_attach,	ed_pccard_attach),
519	{ 0, 0 }
520};
521
522static driver_t ed_pccard_driver = {
523	"ed",
524	ed_pccard_methods,
525	sizeof(struct ed_softc)
526};
527
528DRIVER_MODULE(if_ed, pccard, ed_pccard_driver, ed_devclass, 0, 0);
529#ifndef ED_NO_MIIBUS
530DRIVER_MODULE(miibus, ed, miibus_driver, miibus_devclass, 0, 0);
531#endif
532