xref: /netbsd/sys/dev/cardbus/if_rtk_cardbus.c (revision bf9ec67e)
1 /*	$NetBSD: if_rtk_cardbus.c,v 1.7 2002/01/04 15:24:24 kanaoka 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.7 2002/01/04 15:24:24 kanaoka 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 	{ 0, 0, NULL, 0 }
118 };
119 
120 static int rtk_cardbus_match	__P((struct device *, struct cfdata *, void *));
121 static void rtk_cardbus_attach	__P((struct device *, struct device *, void *));
122 static int rtk_cardbus_detach	__P((struct device *, int));
123 
124 struct rtk_cardbus_softc {
125 	struct rtk_softc sc_rtk;	/* real rtk softc */
126 
127 	/* CardBus-specific goo. */
128 	void *sc_ih;
129 	cardbus_devfunc_t sc_ct;
130 	cardbustag_t sc_tag;
131 	int sc_csr;
132 	int sc_cben;
133 	int sc_bar_reg;
134 	pcireg_t sc_bar_val;
135 	bus_size_t sc_mapsize;
136 	int sc_intrline;
137 };
138 
139 struct cfattach rtk_cardbus_ca = {
140 	sizeof(struct rtk_cardbus_softc),
141 	rtk_cardbus_match, rtk_cardbus_attach,
142 	rtk_cardbus_detach, rtk_activate,
143 };
144 
145 const struct rtk_type *rtk_cardbus_lookup
146 	__P((const struct cardbus_attach_args *));
147 
148 void rtk_cardbus_setup		__P((struct rtk_cardbus_softc *));
149 
150 int rtk_cardbus_enable		__P((struct rtk_softc *));
151 void rtk_cardbus_disable	__P((struct rtk_softc *));
152 void rtk_cardbus_power		__P((struct rtk_softc *, int));
153 const struct rtk_type *
154 rtk_cardbus_lookup(ca)
155 	const struct cardbus_attach_args *ca;
156 {
157 	const struct rtk_type *t;
158 
159 	for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){
160 		if (CARDBUS_VENDOR(ca->ca_id) == t->rtk_vid &&
161 		    CARDBUS_PRODUCT(ca->ca_id) == t->rtk_did) {
162 			return (t);
163 		}
164 	}
165 	return (NULL);
166 }
167 
168 int
169 rtk_cardbus_match(parent, match, aux)
170 	struct device *parent;
171 	struct cfdata *match;
172 	void *aux;
173 {
174 	struct cardbus_attach_args *ca = aux;
175 
176 	if (rtk_cardbus_lookup(ca) != NULL)
177 		return (1);
178 
179 	return (0);
180 }
181 
182 
183 void
184 rtk_cardbus_attach(parent, self, aux)
185 	struct device *parent, *self;
186 	void *aux;
187 {
188 	struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)self;
189 	struct rtk_softc *sc = &csc->sc_rtk;
190 	struct cardbus_attach_args *ca = aux;
191 	cardbus_devfunc_t ct = ca->ca_ct;
192 	const struct rtk_type *t;
193 	bus_addr_t adr;
194 
195 	sc->sc_dmat = ca->ca_dmat;
196 	csc->sc_ct = ct;
197 	csc->sc_tag = ca->ca_tag;
198 	csc->sc_intrline = ca->ca_intrline;
199 
200 	t = rtk_cardbus_lookup(ca);
201 	if (t == NULL) {
202 		printf("\n");
203 		panic("rtk_cardbus_attach: impossible");
204 	 }
205 	printf(": %s\n", t->rtk_name);
206 
207 	/*
208 	 * Power management hooks.
209 	 */
210 	sc->sc_enable = rtk_cardbus_enable;
211 	sc->sc_disable = rtk_cardbus_disable;
212 	sc->sc_power = rtk_cardbus_power;
213 
214 	/*
215 	 * Map control/status registers.
216 	 */
217 	csc->sc_csr = CARDBUS_COMMAND_MASTER_ENABLE;
218 #ifdef RTK_USEIOSPACE
219 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, CARDBUS_MAPREG_TYPE_IO, 0,
220 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
221 #if rbus
222 #else
223 		(*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr+csc->sc_mapsize);
224 #endif
225 		csc->sc_cben = CARDBUS_IO_ENABLE;
226 		csc->sc_csr |= CARDBUS_COMMAND_IO_ENABLE;
227 		csc->sc_bar_reg = RTK_PCI_LOIO;
228 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
229 	}
230 #else
231 	if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, CARDBUS_MAPREG_TYPE_MEM, 0,
232 	    &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
233 #if rbus
234 #else
235 		(*ct->ct_cf->cardbus_mem_open)(cc, 0, adr, adr+csc->sc_mapsize);
236 #endif
237 		csc->sc_cben = CARDBUS_MEM_ENABLE;
238 		csc->sc_csr |= CARDBUS_COMMAND_MEM_ENABLE;
239 		csc->sc_bar_reg = RTK_PCI_LOMEM;
240 		csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_MEM;
241 	}
242 #endif
243 	else {
244 		printf("%s: unable to map deviceregisters\n",
245 			 sc->sc_dev.dv_xname);
246 		return;
247 	}
248 	/*
249 	 * Handle power management nonsense and initialize the
250 	 * configuration registers.
251 	 */
252 	rtk_cardbus_setup(csc);
253 	sc->rtk_type = t->rtk_type;
254 
255 	rtk_attach(sc);
256 
257 	/*
258 	 * Power down the socket.
259 	 */
260 	Cardbus_function_disable(csc->sc_ct);
261 }
262 
263 int
264 rtk_cardbus_detach(self, flags)
265 	struct device *self;
266 	int flags;
267 {
268 	struct rtk_cardbus_softc *csc = (void *) self;
269 	struct rtk_softc *sc = &csc->sc_rtk;
270 	struct cardbus_devfunc *ct = csc->sc_ct;
271 	int	rv;
272 
273 #ifdef DIAGNOSTIC
274 	if (ct == NULL)
275 		panic("%s: data structure lacks\n", sc->sc_dev.dv_xname);
276 #endif
277 	rv = rtk_detach(sc);
278 	if (rv)
279 		return (rv);
280 	/*
281 	 * Unhook the interrut handler.
282 	 */
283 	if (csc->sc_ih != NULL)
284 		cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, csc->sc_ih);
285 
286 	/*
287 	 * Release bus space and close window.
288 	 */
289 	if (csc->sc_bar_reg != 0)
290 		Cardbus_mapreg_unmap(ct, csc->sc_bar_reg,
291 			sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize);
292 
293 	return (0);
294 }
295 
296 void
297 rtk_cardbus_setup(csc)
298 	struct rtk_cardbus_softc *csc;
299 {
300 	struct rtk_softc *sc = &csc->sc_rtk;
301 	cardbus_devfunc_t ct = csc->sc_ct;
302 	cardbus_chipset_tag_t cc = ct->ct_cc;
303 	cardbus_function_tag_t cf = ct->ct_cf;
304 	pcireg_t	reg,command;
305 	int		pmreg;
306 
307 	/*
308 	 * Handle power management nonsense.
309 	 */
310 	if (cardbus_get_capability(cc, cf, csc->sc_tag,
311 	    PCI_CAP_PWRMGMT, &pmreg, 0)) {
312 		command = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4);
313 		if (command & RTK_PSTATE_MASK) {
314 			pcireg_t		iobase, membase, irq;
315 
316 			/* Save important PCI config data. */
317 			iobase = cardbus_conf_read(cc, cf, csc->sc_tag,
318 			    RTK_PCI_LOIO);
319 			membase = cardbus_conf_read(cc, cf,csc->sc_tag,
320 			    RTK_PCI_LOMEM);
321 			irq = cardbus_conf_read(cc, cf,csc->sc_tag,
322 			    PCI_PRODUCT_DELTA_8139);
323 
324 			/* Reset the power state. */
325 			printf("%s: chip is is in D%d power mode "
326 			    "-- setting to D0\n", sc->sc_dev.dv_xname,
327 			    command & RTK_PSTATE_MASK);
328 			command &= 0xFFFFFFFC;
329 			cardbus_conf_write(cc, cf, csc->sc_tag,
330 			    pmreg + 4, command);
331 
332 			/* Restore PCI config data. */
333 			cardbus_conf_write(cc, cf, csc->sc_tag,
334 			    RTK_PCI_LOIO, iobase);
335 			cardbus_conf_write(cc, cf, csc->sc_tag,
336 			    RTK_PCI_LOMEM, membase);
337 			cardbus_conf_write(cc, cf, csc->sc_tag,
338 			    PCI_PRODUCT_DELTA_8139, irq);
339 		}
340 	}
341 
342 	/* Make sure the right access type is on the CardBus bridge. */
343 	(*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben);
344 	(*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
345 
346 	/* Program the BAR */
347 	cardbus_conf_write(cc, cf, csc->sc_tag,
348 		csc->sc_bar_reg, csc->sc_bar_val);
349 
350 	/* Enable the appropriate bits in the CARDBUS CSR. */
351 	reg = cardbus_conf_read(cc, cf, csc->sc_tag,
352 	    CARDBUS_COMMAND_STATUS_REG);
353 	reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE);
354 	reg |= csc->sc_csr;
355 	cardbus_conf_write(cc, cf, csc->sc_tag,
356 	    CARDBUS_COMMAND_STATUS_REG, reg);
357 
358 	/*
359 	 * Make sure the latency timer is set to some reasonable
360 	 * value.
361 	 */
362 	reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
363 	if (CARDBUS_LATTIMER(reg) < 0x20) {
364 		reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
365 		reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
366 		cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
367 	}
368 }
369 
370 int
371 rtk_cardbus_enable(sc)
372 	struct rtk_softc *sc;
373 {
374 	struct rtk_cardbus_softc *csc = (void *) sc;
375 	cardbus_devfunc_t ct = csc->sc_ct;
376 	cardbus_chipset_tag_t cc = ct->ct_cc;
377 	cardbus_function_tag_t cf = ct->ct_cf;
378 
379 	/*
380 	 * Power on the socket.
381 	 */
382 	Cardbus_function_enable(ct);
383 
384 	/*
385 	 * Set up the PCI configuration registers.
386 	 */
387 	rtk_cardbus_setup(csc);
388 
389 	/*
390 	 * Map and establish the interrupt.
391 	 */
392 	csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
393 		IPL_NET, rtk_intr, sc);
394 	if (csc->sc_ih == NULL) {
395 		printf("%s: unable to establish interrupt at %d\n",
396 			sc->sc_dev.dv_xname, csc->sc_intrline);
397 		Cardbus_function_disable(csc->sc_ct);
398 		return (1);
399 	}
400 	printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
401 		csc->sc_intrline);
402 	return (0);
403 }
404 
405 void
406 rtk_cardbus_disable(sc)
407 	struct rtk_softc *sc;
408 {
409 	struct rtk_cardbus_softc *csc = (void *) sc;
410 	cardbus_devfunc_t ct = csc->sc_ct;
411 	cardbus_chipset_tag_t cc = ct->ct_cc;
412 	cardbus_function_tag_t cf = ct->ct_cf;
413 
414 	/* Unhook the interrupt handler. */
415 	cardbus_intr_disestablish(cc, cf, csc->sc_ih);
416 
417 	/* Power down the socket. */
418 	Cardbus_function_disable(ct);
419 }
420 
421 void
422 rtk_cardbus_power(sc, why)
423 	struct rtk_softc *sc;
424 	int why;
425 {
426 	struct rtk_cardbus_softc *csc = (void *) sc;
427 
428 	if (why == PWR_RESUME) {
429 		/*
430 		 * Give the PCI configuration registers a kick
431 		 * in the head.
432 		 */
433 #ifdef DIAGNOSTIC
434 		if (RTK_IS_ENABLED(sc) == 0)
435 			panic("rtk_cardbus_power");
436 #endif
437 		rtk_cardbus_setup(csc);
438 	}
439 }
440