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