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