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