xref: /netbsd-src/sys/dev/cardbus/if_rtk_cardbus.c (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: if_rtk_cardbus.c,v 1.14 2003/02/01 07:50:38 ichiro Exp $	*/
2 
3 /*
4  * Copyright (c) 2000 Masanori Kanaoka
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 /*
31  * if_rtk_cardbus.c:
32  *	Cardbus specific routines for RealTek 8139 ethernet adapter.
33  *	Tested for
34  *		- elecom-Laneed	LD-10/100CBA (Accton MPX5030)
35  *		- MELCO		LPC3-TX-CB   (RealTek 8139)
36  */
37 
38 #include <sys/cdefs.h>
39 __KERNEL_RCSID(0, "$NetBSD: if_rtk_cardbus.c,v 1.14 2003/02/01 07:50:38 ichiro Exp $");
40 
41 #include "opt_inet.h"
42 #include "opt_ns.h"
43 #include "bpfilter.h"
44 #include "rnd.h"
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/callout.h>
49 #include <sys/device.h>
50 #include <sys/sockio.h>
51 #include <sys/mbuf.h>
52 #include <sys/malloc.h>
53 #include <sys/kernel.h>
54 #include <sys/socket.h>
55 
56 #include <net/if.h>
57 #include <net/if_arp.h>
58 #include <net/if_ether.h>
59 #include <net/if_dl.h>
60 #include <net/if_media.h>
61 #ifdef INET
62 #include <netinet/in.h>
63 #include <netinet/if_inarp.h>
64 #endif
65 #ifdef NS
66 #include <netns/ns.h>
67 #include <netns/ns_if.h>
68 #endif
69 
70 #if NBPFILTER > 0
71 #include <net/bpf.h>
72 #endif
73 #if NRND > 0
74 #include <sys/rnd.h>
75 #endif
76 
77 #include <machine/bus.h>
78 
79 #include <dev/pci/pcireg.h>
80 #include <dev/pci/pcivar.h>
81 #include <dev/pci/pcidevs.h>
82 
83 #include <dev/cardbus/cardbusvar.h>
84 #include <dev/cardbus/cardbusdevs.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 
89 /*
90  * Default to using PIO access for this driver. On SMP systems,
91  * there appear to be problems with memory mapped mode: it looks like
92  * doing too many memory mapped access back to back in rapid succession
93  * can hang the bus. I'm inclined to blame this on crummy design/construction
94  * on the part of RealTek. Memory mapped mode does appear to work on
95  * uniprocessor systems though.
96  */
97 #define RTK_USEIOSPACE
98 
99 #include <dev/ic/rtl81x9reg.h>
100 #include <dev/ic/rtl81x9var.h>
101 
102 /*
103  * Various supported device vendors/types and their names.
104  */
105 static const struct rtk_type rtk_cardbus_devs[] = {
106 	{ CARDBUS_VENDOR_ACCTON, CARDBUS_PRODUCT_ACCTON_MPX5030,
107 		"Accton MPX 5030/5038 10/100BaseTX",
108 		RTK_8139 },
109 	{ CARDBUS_VENDOR_DLINK, CARDBUS_PRODUCT_DLINK_DFE_690TXD,
110 		"D-Link DFE-690TXD 10/100BaseTX", RTK_8139 },
111 	{ CARDBUS_VENDOR_REALTEK, CARDBUS_PRODUCT_REALTEK_RT8138,
112 		"RealTek 8138 10/100BaseTX", RTK_8139 },
113 	{ CARDBUS_VENDOR_REALTEK, CARDBUS_PRODUCT_REALTEK_RT8139,
114 		"RealTek 8139 10/100BaseTX", RTK_8139 },
115 	{ CARDBUS_VENDOR_COREGA, CARDBUS_PRODUCT_COREGA_CB_TXD,
116 		"Corega FEther CB-TXD 10/100BaseTX", RTK_8139 },
117 	{ CARDBUS_VENDOR_PLANEX, CARDBUS_PRODUCT_PLANEX_FNW_3603_TX,
118 		"Planex FNW-3603 10/100BaseTX", RTK_8139 },
119 	{ CARDBUS_VENDOR_ABOCOM, CARDBUS_PRODUCT_ABOCOM_FE2000VX,
120 		"AboCom FE2000VX 10/100BaseTX", RTK_8139 },
121 
122 	{ 0, 0, NULL, 0 }
123 };
124 
125 static int rtk_cardbus_match	__P((struct device *, struct cfdata *, void *));
126 static void rtk_cardbus_attach	__P((struct device *, struct device *, void *));
127 static int rtk_cardbus_detach	__P((struct device *, int));
128 
129 struct rtk_cardbus_softc {
130 	struct rtk_softc sc_rtk;	/* real rtk softc */
131 
132 	/* CardBus-specific goo. */
133 	void *sc_ih;
134 	cardbus_devfunc_t sc_ct;
135 	cardbustag_t sc_tag;
136 	int sc_csr;
137 	int sc_cben;
138 	int sc_bar_reg;
139 	pcireg_t sc_bar_val;
140 	bus_size_t sc_mapsize;
141 	int sc_intrline;
142 };
143 
144 CFATTACH_DECL(rtk_cardbus, sizeof(struct rtk_cardbus_softc),
145     rtk_cardbus_match, rtk_cardbus_attach, rtk_cardbus_detach, rtk_activate);
146 
147 const struct rtk_type *rtk_cardbus_lookup
148 	__P((const struct cardbus_attach_args *));
149 
150 void rtk_cardbus_setup		__P((struct rtk_cardbus_softc *));
151 
152 int rtk_cardbus_enable		__P((struct rtk_softc *));
153 void rtk_cardbus_disable	__P((struct rtk_softc *));
154 void rtk_cardbus_power		__P((struct rtk_softc *, int));
155 const struct rtk_type *
156 rtk_cardbus_lookup(ca)
157 	const struct cardbus_attach_args *ca;
158 {
159 	const struct rtk_type *t;
160 
161 	for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){
162 		if (CARDBUS_VENDOR(ca->ca_id) == t->rtk_vid &&
163 		    CARDBUS_PRODUCT(ca->ca_id) == t->rtk_did) {
164 			return (t);
165 		}
166 	}
167 	return (NULL);
168 }
169 
170 int
171 rtk_cardbus_match(parent, match, aux)
172 	struct device *parent;
173 	struct cfdata *match;
174 	void *aux;
175 {
176 	struct cardbus_attach_args *ca = aux;
177 
178 	if (rtk_cardbus_lookup(ca) != NULL)
179 		return (1);
180 
181 	return (0);
182 }
183 
184 
185 void
186 rtk_cardbus_attach(parent, self, aux)
187 	struct device *parent, *self;
188 	void *aux;
189 {
190 	struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)self;
191 	struct rtk_softc *sc = &csc->sc_rtk;
192 	struct cardbus_attach_args *ca = aux;
193 	cardbus_devfunc_t ct = ca->ca_ct;
194 	const struct rtk_type *t;
195 	bus_addr_t adr;
196 
197 	sc->sc_dmat = ca->ca_dmat;
198 	csc->sc_ct = ct;
199 	csc->sc_tag = ca->ca_tag;
200 	csc->sc_intrline = ca->ca_intrline;
201 
202 	t = rtk_cardbus_lookup(ca);
203 	if (t == NULL) {
204 		printf("\n");
205 		panic("rtk_cardbus_attach: impossible");
206 	 }
207 	printf(": %s\n", t->rtk_name);
208 
209 	/*
210 	 * Power management hooks.
211 	 */
212 	sc->sc_enable = rtk_cardbus_enable;
213 	sc->sc_disable = rtk_cardbus_disable;
214 	sc->sc_power = rtk_cardbus_power;
215 
216 	/*
217 	 * Map control/status registers.
218 	 */
219 	csc->sc_csr = CARDBUS_COMMAND_MASTER_ENABLE;
220 #ifdef RTK_USEIOSPACE
221 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, CARDBUS_MAPREG_TYPE_IO, 0,
222 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
223 #if rbus
224 #else
225 		(*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr+csc->sc_mapsize);
226 #endif
227 		csc->sc_cben = CARDBUS_IO_ENABLE;
228 		csc->sc_csr |= CARDBUS_COMMAND_IO_ENABLE;
229 		csc->sc_bar_reg = RTK_PCI_LOIO;
230 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
231 	}
232 #else
233 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, CARDBUS_MAPREG_TYPE_MEM, 0,
234 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
235 #if rbus
236 #else
237 		(*ct->ct_cf->cardbus_mem_open)(cc, 0, adr, adr+csc->sc_mapsize);
238 #endif
239 		csc->sc_cben = CARDBUS_MEM_ENABLE;
240 		csc->sc_csr |= CARDBUS_COMMAND_MEM_ENABLE;
241 		csc->sc_bar_reg = RTK_PCI_LOMEM;
242 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_MEM;
243 	}
244 #endif
245 	else {
246 		printf("%s: unable to map deviceregisters\n",
247 			 sc->sc_dev.dv_xname);
248 		return;
249 	}
250 	/*
251 	 * Handle power management nonsense and initialize the
252 	 * configuration registers.
253 	 */
254 	rtk_cardbus_setup(csc);
255 	sc->rtk_type = t->rtk_type;
256 
257 	rtk_attach(sc);
258 
259 	/*
260 	 * Power down the socket.
261 	 */
262 	Cardbus_function_disable(csc->sc_ct);
263 }
264 
265 int
266 rtk_cardbus_detach(self, flags)
267 	struct device *self;
268 	int flags;
269 {
270 	struct rtk_cardbus_softc *csc = (void *) self;
271 	struct rtk_softc *sc = &csc->sc_rtk;
272 	struct cardbus_devfunc *ct = csc->sc_ct;
273 	int	rv;
274 
275 #ifdef DIAGNOSTIC
276 	if (ct == NULL)
277 		panic("%s: data structure lacks", sc->sc_dev.dv_xname);
278 #endif
279 	rv = rtk_detach(sc);
280 	if (rv)
281 		return (rv);
282 	/*
283 	 * Unhook the interrut handler.
284 	 */
285 	if (csc->sc_ih != NULL)
286 		cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, csc->sc_ih);
287 
288 	/*
289 	 * Release bus space and close window.
290 	 */
291 	if (csc->sc_bar_reg != 0)
292 		Cardbus_mapreg_unmap(ct, csc->sc_bar_reg,
293 			sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize);
294 
295 	return (0);
296 }
297 
298 void
299 rtk_cardbus_setup(csc)
300 	struct rtk_cardbus_softc *csc;
301 {
302 	struct rtk_softc *sc = &csc->sc_rtk;
303 	cardbus_devfunc_t ct = csc->sc_ct;
304 	cardbus_chipset_tag_t cc = ct->ct_cc;
305 	cardbus_function_tag_t cf = ct->ct_cf;
306 	pcireg_t	reg,command;
307 	int		pmreg;
308 
309 	/*
310 	 * Handle power management nonsense.
311 	 */
312 	if (cardbus_get_capability(cc, cf, csc->sc_tag,
313 	    PCI_CAP_PWRMGMT, &pmreg, 0)) {
314 		command = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4);
315 		if (command & RTK_PSTATE_MASK) {
316 			pcireg_t		iobase, membase, irq;
317 
318 			/* Save important PCI config data. */
319 			iobase = cardbus_conf_read(cc, cf, csc->sc_tag,
320 			    RTK_PCI_LOIO);
321 			membase = cardbus_conf_read(cc, cf,csc->sc_tag,
322 			    RTK_PCI_LOMEM);
323 			irq = cardbus_conf_read(cc, cf,csc->sc_tag,
324 			    CARDBUS_INTERRUPT_REG);
325 
326 			/* Reset the power state. */
327 			printf("%s: chip is in D%d power mode "
328 			    "-- setting to D0\n", sc->sc_dev.dv_xname,
329 			    command & RTK_PSTATE_MASK);
330 			command &= 0xFFFFFFFC;
331 			cardbus_conf_write(cc, cf, csc->sc_tag,
332 			    pmreg + 4, command);
333 
334 			/* Restore PCI config data. */
335 			cardbus_conf_write(cc, cf, csc->sc_tag,
336 			    RTK_PCI_LOIO, iobase);
337 			cardbus_conf_write(cc, cf, csc->sc_tag,
338 			    RTK_PCI_LOMEM, membase);
339 			cardbus_conf_write(cc, cf, csc->sc_tag,
340 			    CARDBUS_INTERRUPT_REG, irq);
341 		}
342 	}
343 
344 	/* Make sure the right access type is on the CardBus bridge. */
345 	(*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben);
346 	(*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
347 
348 	/* Program the BAR */
349 	cardbus_conf_write(cc, cf, csc->sc_tag,
350 		csc->sc_bar_reg, csc->sc_bar_val);
351 
352 	/* Enable the appropriate bits in the CARDBUS CSR. */
353 	reg = cardbus_conf_read(cc, cf, csc->sc_tag,
354 	    CARDBUS_COMMAND_STATUS_REG);
355 	reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE);
356 	reg |= csc->sc_csr;
357 	cardbus_conf_write(cc, cf, csc->sc_tag,
358 	    CARDBUS_COMMAND_STATUS_REG, reg);
359 
360 	/*
361 	 * Make sure the latency timer is set to some reasonable
362 	 * value.
363 	 */
364 	reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
365 	if (CARDBUS_LATTIMER(reg) < 0x20) {
366 		reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
367 		reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
368 		cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
369 	}
370 }
371 
372 int
373 rtk_cardbus_enable(sc)
374 	struct rtk_softc *sc;
375 {
376 	struct rtk_cardbus_softc *csc = (void *) sc;
377 	cardbus_devfunc_t ct = csc->sc_ct;
378 	cardbus_chipset_tag_t cc = ct->ct_cc;
379 	cardbus_function_tag_t cf = ct->ct_cf;
380 
381 	/*
382 	 * Power on the socket.
383 	 */
384 	Cardbus_function_enable(ct);
385 
386 	/*
387 	 * Set up the PCI configuration registers.
388 	 */
389 	rtk_cardbus_setup(csc);
390 
391 	/*
392 	 * Map and establish the interrupt.
393 	 */
394 	csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
395 		IPL_NET, rtk_intr, sc);
396 	if (csc->sc_ih == NULL) {
397 		printf("%s: unable to establish interrupt at %d\n",
398 			sc->sc_dev.dv_xname, csc->sc_intrline);
399 		Cardbus_function_disable(csc->sc_ct);
400 		return (1);
401 	}
402 	printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
403 		csc->sc_intrline);
404 	return (0);
405 }
406 
407 void
408 rtk_cardbus_disable(sc)
409 	struct rtk_softc *sc;
410 {
411 	struct rtk_cardbus_softc *csc = (void *) sc;
412 	cardbus_devfunc_t ct = csc->sc_ct;
413 	cardbus_chipset_tag_t cc = ct->ct_cc;
414 	cardbus_function_tag_t cf = ct->ct_cf;
415 
416 	/* Unhook the interrupt handler. */
417 	cardbus_intr_disestablish(cc, cf, csc->sc_ih);
418 
419 	/* Power down the socket. */
420 	Cardbus_function_disable(ct);
421 }
422 
423 void
424 rtk_cardbus_power(sc, why)
425 	struct rtk_softc *sc;
426 	int why;
427 {
428 	struct rtk_cardbus_softc *csc = (void *) sc;
429 
430 	if (why == PWR_RESUME) {
431 		/*
432 		 * Give the PCI configuration registers a kick
433 		 * in the head.
434 		 */
435 #ifdef DIAGNOSTIC
436 		if (RTK_IS_ENABLED(sc) == 0)
437 			panic("rtk_cardbus_power");
438 #endif
439 		rtk_cardbus_setup(csc);
440 	}
441 }
442