if_fe_pccard.c revision 189728 
1/*-
2 * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
3 *
4 * This software may be used, modified, copied, distributed, and sold, in
5 * both source and binary form provided that the above copyright, these
6 * terms and the following disclaimer are retained.  The name of the author
7 * and/or the contributor may not be used to endorse or promote products
8 * derived from this software without specific prior written permission.
9 *
10 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
11 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
12 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
13 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
14 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
15 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
16 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION.
17 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
18 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
19 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
20 * SUCH DAMAGE.
21 *
22 */
23
24#include <sys/cdefs.h>
25__FBSDID("$FreeBSD: head/sys/dev/fe/if_fe_pccard.c 189728 2009-03-12 07:18:27Z imp $");
26
27#include <sys/param.h>
28#include <sys/kernel.h>
29#include <sys/socket.h>
30#include <sys/systm.h>
31#include <sys/module.h>
32
33#include <sys/bus.h>
34#include <machine/bus.h>
35#include <sys/rman.h>
36
37#include <net/ethernet.h>
38#include <net/if.h>
39#include <net/if_mib.h>
40#include <net/if_media.h>
41
42#include <netinet/in.h>
43#include <netinet/if_ether.h>
44
45#include <dev/fe/mb86960.h>
46#include <dev/fe/if_fereg.h>
47#include <dev/fe/if_fevar.h>
48
49#include <dev/pccard/pccardvar.h>
50#include <dev/pccard/pccard_cis.h>
51
52#include "card_if.h"
53#include "pccarddevs.h"
54
55/*
56 *	PC Card (PCMCIA) specific code.
57 */
58static int fe_pccard_probe(device_t);
59static int fe_pccard_attach(device_t);
60static int fe_pccard_detach(device_t);
61
62static const struct fe_pccard_product {
63	struct pccard_product mpp_product;
64	int mpp_flags;
65#define MPP_MBH10302 1
66#define MPP_ANYFUNC 2
67#define MPP_SKIP_TO_CFE_10 4
68} fe_pccard_products[] = {
69	/* These need to be first */
70	{ PCMCIA_CARD(FUJITSU2, FMV_J181), MPP_MBH10302 },
71	{ PCMCIA_CARD(FUJITSU2, FMV_J182), 0 },
72	{ PCMCIA_CARD(FUJITSU2, FMV_J182A), 0 },
73	{ PCMCIA_CARD(FUJITSU2, ITCFJ182A), 0 },
74	/* These need to be second */
75	{ PCMCIA_CARD(TDK, LAK_CD021BX), 0 },
76	{ PCMCIA_CARD(TDK, LAK_CF010), 0 },
77#if 0 /* XXX 86960-based? */
78	{ PCMCIA_CARD(TDK, LAK_DFL9610), 0 },
79#endif
80	{ PCMCIA_CARD(CONTEC, CNETPC), 0 },
81	{ PCMCIA_CARD(FUJITSU, LA501), 0 },
82	{ PCMCIA_CARD(FUJITSU, LA10S), 0 },
83	{ PCMCIA_CARD(FUJITSU, NE200T), MPP_MBH10302 },/* Sold by Eagle */
84	{ PCMCIA_CARD(HITACHI, HT_4840), MPP_MBH10302 | MPP_SKIP_TO_CFE_10},
85	{ PCMCIA_CARD(RATOC, REX_R280), 0 },
86	{ PCMCIA_CARD(XIRCOM, CE), MPP_ANYFUNC },
87	{ { NULL } }
88};
89
90static int
91fe_pccard_probe(device_t dev)
92{
93	int		error;
94	uint32_t	fcn = PCCARD_FUNCTION_UNSPEC;
95	const struct fe_pccard_product *pp;
96	int i;
97
98	if ((pp = (const struct fe_pccard_product *)pccard_product_lookup(dev,
99		 (const struct pccard_product *)fe_pccard_products,
100		 sizeof(fe_pccard_products[0]), NULL)) != NULL) {
101		if (pp->mpp_product.pp_name != NULL)
102			device_set_desc(dev, pp->mpp_product.pp_name);
103		if (pp->mpp_flags & MPP_ANYFUNC)
104			return (0);
105		/* Make sure we're a network function */
106		error = pccard_get_function(dev, &fcn);
107		if (error != 0)
108			return (error);
109		if (fcn != PCCARD_FUNCTION_NETWORK)
110			return (ENXIO);
111		if (pp->mpp_flags & MPP_SKIP_TO_CFE_10) {
112			for (i = 10; i < 27; i++) {
113				if (pccard_select_cfe(dev, i) == 0)
114					goto good;
115			}
116			device_printf(dev,
117			    "Hitachi HT-4840-11 workaround failed\n");
118			return ENXIO;
119		}
120	good:;
121		return (0);
122	}
123	return (ENXIO);
124}
125
126static device_method_t fe_pccard_methods[] = {
127	/* Device interface */
128	DEVMETHOD(device_probe,		fe_pccard_probe),
129	DEVMETHOD(device_attach,	fe_pccard_attach),
130	DEVMETHOD(device_detach,	fe_pccard_detach),
131
132	{ 0, 0 }
133};
134
135static driver_t fe_pccard_driver = {
136	"fe",
137	fe_pccard_methods,
138	sizeof (struct fe_softc)
139};
140
141DRIVER_MODULE(fe, pccard, fe_pccard_driver, fe_devclass, 0, 0);
142MODULE_DEPEND(fe, pccard, 1, 1, 1);
143
144static int fe_probe_mbh(device_t, const struct fe_pccard_product *);
145static int fe_probe_tdk(device_t, const struct fe_pccard_product *);
146
147static int
148fe_pccard_attach(device_t dev)
149{
150	struct fe_softc *sc;
151	const struct fe_pccard_product *pp;
152	int error;
153
154	/* Prepare for the device probe process.  */
155	sc = device_get_softc(dev);
156	sc->sc_unit = device_get_unit(dev);
157
158	pp = (const struct fe_pccard_product *) pccard_product_lookup(dev,
159	    (const struct pccard_product *)fe_pccard_products,
160	    sizeof(fe_pccard_products[0]), NULL);
161	if (pp == NULL)
162		return (ENXIO);
163
164	if (pp->mpp_flags & MPP_MBH10302)
165		error = fe_probe_mbh(dev, pp);
166	else
167		error = fe_probe_tdk(dev, pp);
168	if (error != 0) {
169		fe_release_resource(dev);
170		return (error);
171	}
172	error = fe_alloc_irq(dev, 0);
173	if (error != 0) {
174		fe_release_resource(dev);
175		return (error);
176	}
177	return (fe_attach(dev));
178}
179
180/*
181 *	feunload - unload the driver and clear the table.
182 */
183static int
184fe_pccard_detach(device_t dev)
185{
186	struct fe_softc *sc = device_get_softc(dev);
187	struct ifnet *ifp = sc->ifp;
188
189	FE_LOCK(sc);
190	fe_stop(sc);
191	FE_UNLOCK(sc);
192	callout_drain(&sc->timer);
193	ether_ifdetach(ifp);
194	bus_teardown_intr(dev, sc->irq_res, sc->irq_handle);
195	if_free(ifp);
196	fe_release_resource(dev);
197	mtx_destroy(&sc->lock);
198
199	return 0;
200}
201
202
203/*
204 * Probe and initialization for Fujitsu MBH10302 PCMCIA Ethernet interface.
205 * Note that this is for 10302 only; MBH10304 is handled by fe_probe_tdk().
206 */
207static void
208fe_init_mbh(struct fe_softc *sc)
209{
210	/* Minimal initialization of 86960.  */
211	DELAY(200);
212	fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
213	DELAY(200);
214
215	/* Disable all interrupts.  */
216	fe_outb(sc, FE_DLCR2, 0);
217	fe_outb(sc, FE_DLCR3, 0);
218
219	/* Enable master interrupt flag.  */
220	fe_outb(sc, FE_MBH0, FE_MBH0_MAGIC | FE_MBH0_INTR_ENABLE);
221}
222
223static int
224fe_probe_mbh(device_t dev, const struct fe_pccard_product *pp)
225{
226	struct fe_softc *sc = device_get_softc(dev);
227
228	static struct fe_simple_probe_struct probe_table [] = {
229		{ FE_DLCR2, 0x58, 0x00 },
230		{ FE_DLCR4, 0x08, 0x00 },
231		{ FE_DLCR6, 0xFF, 0xB6 },
232		{ 0 }
233	};
234
235	/* MBH10302 occupies 32 I/O addresses. */
236	if (fe_alloc_port(dev, 32))
237		return ENXIO;
238
239	/* Fill the softc struct with default values.  */
240	fe_softc_defaults(sc);
241
242	/*
243	 * See if MBH10302 is on its address.
244	 * I'm not sure the following probe code works.  FIXME.
245	 */
246	if (!fe_simple_probe(sc, probe_table))
247		return ENXIO;
248
249	/* Get our station address from EEPROM.  */
250	fe_inblk(sc, FE_MBH10, sc->enaddr, ETHER_ADDR_LEN);
251
252	/* Make sure we got a valid station address.  */
253	if (!fe_valid_Ether_p(sc->enaddr, 0))
254		return ENXIO;
255
256	/* Determine the card type.  */
257	sc->type = FE_TYPE_MBH;
258	sc->typestr = "MBH10302 (PCMCIA)";
259
260	/* We seems to need our own IDENT bits...  FIXME.  */
261	sc->proto_dlcr7 = FE_D7_BYTSWP_LH | FE_D7_IDENT_NICE;
262
263	/* Setup hooks.  We need a special initialization procedure.  */
264	sc->init = fe_init_mbh;
265
266	return 0;
267}
268
269static int
270fe_pccard_xircom_mac(const struct pccard_tuple *tuple, void *argp)
271{
272	uint8_t *enaddr = argp;
273	int i;
274
275#if 1
276	/*
277	 * We fail to map the CIS twice, for reasons unknown.  We
278	 * may fix this in the future by loading the CIS with a sane
279	 * CIS from userland.
280	 */
281	static uint8_t defaultmac[ETHER_ADDR_LEN] = {
282		0x00, 0x80, 0xc7, 0xed, 0x16, 0x7b};
283
284	/* Copy the MAC ADDR and return success */
285	for (i = 0; i < ETHER_ADDR_LEN; i++)
286		enaddr[i] = defaultmac[i];
287#else
288	/* FUNCE is not after FUNCID, so we gotta go find it */
289	if (tuple->code != 0x22)
290		return (0);
291
292	/* Make sure this is a sane node */
293	if (tuple->length < ETHER_ADDR_LEN + 3)
294		return (0);
295
296	/* Copy the MAC ADDR and return success */
297	for (i = 0; i < ETHER_ADDR_LEN; i++)
298		enaddr[i] = pccard_tuple_read_1(tuple, i + 3);
299#endif
300	return (1);
301}
302
303/*
304 * Probe and initialization for TDK/CONTEC PCMCIA Ethernet interface.
305 * by MASUI Kenji <masui@cs.titech.ac.jp>
306 *
307 * (Contec uses TDK Ethenet chip -- hosokawa)
308 *
309 * This version of fe_probe_tdk has been rewrote to handle
310 * *generic* PC Card implementation of Fujitsu MB8696x family.  The
311 * name _tdk is just for a historical reason. :-)
312 */
313static int
314fe_probe_tdk (device_t dev, const struct fe_pccard_product *pp)
315{
316	struct fe_softc *sc = device_get_softc(dev);
317
318	static struct fe_simple_probe_struct probe_table [] = {
319		{ FE_DLCR2, 0x10, 0x00 },
320		{ FE_DLCR4, 0x08, 0x00 },
321/*		{ FE_DLCR5, 0x80, 0x00 },	Does not work well.  */
322		{ 0 }
323	};
324
325
326	/* C-NET(PC)C occupies 16 I/O addresses. */
327	if (fe_alloc_port(dev, 16))
328		return ENXIO;
329
330	/* Fill the softc struct with default values.  */
331	fe_softc_defaults(sc);
332
333	/*
334	 * See if C-NET(PC)C is on its address.
335	 */
336	if (!fe_simple_probe(sc, probe_table))
337		return ENXIO;
338
339	/* Determine the card type.  */
340	sc->type = FE_TYPE_TDK;
341	sc->typestr = "Generic MB8696x/78Q837x Ethernet (PCMCIA)";
342
343	pccard_get_ether(dev, sc->enaddr);
344
345	/* Make sure we got a valid station address.  */
346	if (!fe_valid_Ether_p(sc->enaddr, 0)) {
347		pccard_cis_scan(dev, fe_pccard_xircom_mac, sc->enaddr);
348	}
349
350	/* Make sure we got a valid station address.  */
351	if (!fe_valid_Ether_p(sc->enaddr, 0))
352		return ENXIO;
353
354	return 0;
355}
356