if_ep_pccard.c revision 66137
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 * $FreeBSD: head/sys/dev/ep/if_ep_pccard.c 66137 2000-09-20 19:31:37Z imp $
31 */
32
33/*
34 * Pccard support for 3C589 by:
35 *		HAMADA Naoki
36 *		nao@tom-yam.or.jp
37 */
38
39#include <sys/param.h>
40#include <sys/systm.h>
41#include <sys/kernel.h>
42#include <sys/socket.h>
43
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 <machine/clock.h>
56
57#include <dev/ep/if_epreg.h>
58#include <dev/ep/if_epvar.h>
59
60#include "card_if.h"
61#include <dev/pccard/pccardvar.h>
62
63static const char *ep_pccard_identify(u_short id);
64
65/*
66 * Initialize the device - called from Slot manager.
67 */
68static int
69ep_pccard_probe(device_t dev)
70{
71	struct ep_softc *	sc = device_get_softc(dev);
72	struct ep_board *	epb = &sc->epb;
73	const char *		desc;
74	int			error;
75
76	error = ep_alloc(dev);
77	if (error)
78		return error;
79
80	/*
81	 * XXX - Certain (newer?) 3Com cards need epb->cmd_off ==
82	 * 2. Sadly, you need to have a correct cmd_off in order to
83	 * identify the card.  So we have to hit it with both and
84	 * cross our virtual fingers.  There's got to be a better way
85	 * to do this.  jyoung@accessus.net 09/11/1999
86	 */
87
88	epb->cmd_off = 0;
89	epb->prod_id = get_e(sc, EEPROM_PROD_ID);
90	if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) {
91		if (bootverbose)
92			device_printf(dev, "Pass 1 of 2 detection "
93			    "failed (nonfatal) id 0x%x\n", epb->prod_id);
94		epb->cmd_off = 2;
95		epb->prod_id = get_e(sc, EEPROM_PROD_ID);
96		if ((desc = ep_pccard_identify(epb->prod_id)) == NULL) {
97			device_printf(dev, "Unit failed to come ready or "
98			    "product ID unknown! (id 0x%x)\n", epb->prod_id);
99			ep_free(dev);
100			return (ENXIO);
101		}
102	}
103	device_set_desc(dev, desc);
104
105	/*
106	 * For some reason the 3c574 needs this.
107	 */
108	ep_get_macaddr(sc, (u_char *)&sc->arpcom.ac_enaddr);
109
110	ep_free(dev);
111	return (0);
112}
113
114static const char *
115ep_pccard_identify(u_short id)
116{
117	/* Determine device type and associated MII capabilities  */
118	switch (id) {
119	case 0x6055: /* 3C556 */
120		return ("3Com 3C556");
121	case 0x4057: /* 3C574 */
122		return ("3Com 3C574");
123	case 0x4b57: /* 3C574B */
124		return ("3Com 3C574B, Megahertz 3CCFE574BT or "
125		    "Fast Etherlink 3C574-TX");
126	case 0x2b57: /* 3CXSH572BT */
127		return ("3Com OfficeConnect 572BT");
128	case 0x9058: /* 3C589 */
129		return ("3Com Etherlink III 3C589");
130	case 0x2056: /* 3C562/3C563 */
131		return ("3Com 3C562D/3C563D");
132	case 0x0010:	/* 3C1 */
133		return ("3Com Megahertz C1");
134	}
135	return (NULL);
136}
137
138static int
139ep_pccard_card_attach(struct ep_board *epb)
140{
141	/* Determine device type and associated MII capabilities  */
142	switch (epb->prod_id) {
143	case 0x6055: /* 3C556 */
144	case 0x2b57: /* 3C572BT */
145	case 0x4057: /* 3C574 */
146	case 0x4b57: /* 3C574B */
147	case 0x0010: /* 3C1 */
148		epb->mii_trans = 1;
149		return (1);
150	case 0x2056: /* 3C562D/3C563D */
151	case 0x9058: /* 3C589 */
152		epb->mii_trans = 0;
153		return (1);
154	}
155	return (0);
156}
157
158static int
159ep_pccard_attach(device_t dev)
160{
161	struct ep_softc *	sc = device_get_softc(dev);
162	int			error = 0;
163
164	if ((error = ep_alloc(dev))) {
165		device_printf(dev, "ep_alloc() failed! (%d)\n", error);
166		goto bad;
167	}
168
169	sc->epb.cmd_off = 0;
170	sc->epb.prod_id = get_e(sc, EEPROM_PROD_ID);
171	if (!ep_pccard_card_attach(&sc->epb)) {
172		sc->epb.cmd_off = 2;
173		sc->epb.prod_id = get_e(sc, EEPROM_PROD_ID);
174		sc->epb.res_cfg = get_e(sc, EEPROM_RESOURCE_CFG);
175		if (!ep_pccard_card_attach(&sc->epb)) {
176			device_printf(dev,
177			    "Probe found ID, attach failed so ignore card!\n");
178			error = ENXIO;
179			goto bad;
180		}
181	}
182
183	/* ROM size = 0, ROM base = 0 */
184	/* For now, ignore AUTO SELECT feature of 3C589B and later. */
185	outw(BASE + EP_W0_ADDRESS_CFG, get_e(sc, EEPROM_ADDR_CFG) & 0xc000);
186
187	/* Fake IRQ must be 3 */
188	outw(BASE + EP_W0_RESOURCE_CFG, (sc->epb.res_cfg & 0x0fff) | 0x3000);
189
190	outw(BASE + EP_W0_PRODUCT_ID, sc->epb.prod_id);
191
192	if (sc->epb.mii_trans) {
193		/*
194		 * turn on the MII transciever
195		 */
196		GO_WINDOW(3);
197		outw(BASE + EP_W3_OPTIONS, 0x8040);
198		DELAY(1000);
199		outw(BASE + EP_W3_OPTIONS, 0xc040);
200		outw(BASE + EP_COMMAND, RX_RESET);
201		outw(BASE + EP_COMMAND, TX_RESET);
202		while (inw(BASE + EP_STATUS) & S_COMMAND_IN_PROGRESS);
203		DELAY(1000);
204		outw(BASE + EP_W3_OPTIONS, 0x8040);
205	} else {
206		ep_get_media(sc);
207	}
208
209	if ((error = ep_attach(sc))) {
210		device_printf(dev, "ep_attach() failed! (%d)\n", error);
211		goto bad;
212	}
213
214	if ((error = bus_setup_intr(dev, sc->irq, INTR_TYPE_NET, ep_intr,
215				    sc, &sc->ep_intrhand))) {
216		device_printf(dev, "bus_setup_intr() failed! (%d)\n", error);
217		goto bad;
218	}
219
220	return (0);
221bad:
222	ep_free(dev);
223	return (error);
224}
225
226static int
227ep_pccard_detach(device_t dev)
228{
229	struct ep_softc *sc = device_get_softc(dev);
230
231	if (sc->gone) {
232		device_printf(dev, "already unloaded\n");
233		return (0);
234	}
235	sc->arpcom.ac_if.if_flags &= ~IFF_RUNNING;
236	ether_ifdetach(&sc->arpcom.ac_if, ETHER_BPF_SUPPORTED);
237	sc->gone = 1;
238	bus_teardown_intr(dev, sc->irq, sc->ep_intrhand);
239	ep_free(dev);
240	return (0);
241}
242
243static int
244ep_pccard_match(device_t dev)
245{
246	return EIO;
247}
248
249static device_method_t ep_pccard_methods[] = {
250	/* Device interface */
251	DEVMETHOD(device_probe,		pccard_compat_probe),
252	DEVMETHOD(device_attach,	pccard_compat_attach),
253	DEVMETHOD(device_detach,	ep_pccard_detach),
254
255	/* Card interface */
256	DEVMETHOD(card_compat_match,	ep_pccard_match),
257	DEVMETHOD(card_compat_probe,	ep_pccard_probe),
258	DEVMETHOD(card_compat_attach,	ep_pccard_attach),
259
260	{ 0, 0 }
261};
262
263static driver_t ep_pccard_driver = {
264	"ep",
265	ep_pccard_methods,
266	sizeof(struct ep_softc),
267};
268
269extern devclass_t ep_devclass;
270
271DRIVER_MODULE(ep, pccard, ep_pccard_driver, ep_devclass, 0, 0);
272