if_rtk_cardbus.c revision 1.26.4.1 1 /* $NetBSD: if_rtk_cardbus.c,v 1.26.4.1 2006/09/09 02:49:44 rpaulo 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.26.4.1 2006/09/09 02:49:44 rpaulo Exp $");
40
41 #include "opt_inet.h"
42 #include "bpfilter.h"
43 #include "rnd.h"
44
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/callout.h>
48 #include <sys/device.h>
49 #include <sys/sockio.h>
50 #include <sys/mbuf.h>
51 #include <sys/malloc.h>
52 #include <sys/kernel.h>
53 #include <sys/socket.h>
54
55 #include <net/if.h>
56 #include <net/if_arp.h>
57 #include <net/if_ether.h>
58 #include <net/if_dl.h>
59 #include <net/if_media.h>
60 #ifdef INET
61 #include <netinet/in.h>
62 #include <netinet/if_inarp.h>
63 #endif
64
65 #if NBPFILTER > 0
66 #include <net/bpf.h>
67 #endif
68 #if NRND > 0
69 #include <sys/rnd.h>
70 #endif
71
72 #include <machine/bus.h>
73
74 #include <dev/pci/pcireg.h>
75 #include <dev/pci/pcivar.h>
76 #include <dev/pci/pcidevs.h>
77
78 #include <dev/cardbus/cardbusvar.h>
79 #include <dev/pci/pcidevs.h>
80
81 #include <dev/mii/mii.h>
82 #include <dev/mii/miivar.h>
83
84 /*
85 * Default to using PIO access for this driver. On SMP systems,
86 * there appear to be problems with memory mapped mode: it looks like
87 * doing too many memory mapped access back to back in rapid succession
88 * can hang the bus. I'm inclined to blame this on crummy design/construction
89 * on the part of Realtek. Memory mapped mode does appear to work on
90 * uniprocessor systems though.
91 */
92 #define RTK_USEIOSPACE
93
94 #include <dev/ic/rtl81x9reg.h>
95 #include <dev/ic/rtl81x9var.h>
96
97 /*
98 * Various supported device vendors/types and their names.
99 */
100 static const struct rtk_type rtk_cardbus_devs[] = {
101 { PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030,
102 RTK_8139, "Accton MPX 5030/5038 10/100BaseTX" },
103 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE690TXD,
104 RTK_8139, "D-Link DFE-690TXD 10/100BaseTX" },
105 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8138,
106 RTK_8139, "Realtek 8138 10/100BaseTX" },
107 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
108 RTK_8139, "Realtek 8139 10/100BaseTX" },
109 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_CB_TXD,
110 RTK_8139, "Corega FEther CB-TXD 10/100BaseTX" },
111 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_2CB_TXD,
112 RTK_8139, "Corega FEther II CB-TXD 10/100BaseTX" },
113 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3603_TX,
114 RTK_8139, "Planex FNW-3603 10/100BaseTX" },
115 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3800_TX,
116 RTK_8139, "Planex 10/100BaseTX FNW-3800-TX" },
117 { PCI_VENDOR_ABOCOM, PCI_PRODUCT_ABOCOM_FE2000VX,
118 RTK_8139, "AboCom FE2000VX 10/100BaseTX" },
119
120 { 0, 0, 0, NULL }
121 };
122
123 static int rtk_cardbus_match(struct device *, struct cfdata *, void *);
124 static void rtk_cardbus_attach(struct device *, struct device *, void *);
125 static int rtk_cardbus_detach(struct device *, int);
126
127 struct rtk_cardbus_softc {
128 struct rtk_softc sc_rtk; /* real rtk softc */
129
130 /* CardBus-specific goo. */
131 void *sc_ih;
132 cardbus_devfunc_t sc_ct;
133 cardbustag_t sc_tag;
134 int sc_csr;
135 int sc_cben;
136 int sc_bar_reg;
137 pcireg_t sc_bar_val;
138 bus_size_t sc_mapsize;
139 int sc_intrline;
140 };
141
142 CFATTACH_DECL(rtk_cardbus, sizeof(struct rtk_cardbus_softc),
143 rtk_cardbus_match, rtk_cardbus_attach, rtk_cardbus_detach, rtk_activate);
144
145 const struct rtk_type *rtk_cardbus_lookup
146 (const struct cardbus_attach_args *);
147
148 void rtk_cardbus_setup (struct rtk_cardbus_softc *);
149
150 int rtk_cardbus_enable (struct rtk_softc *);
151 void rtk_cardbus_disable(struct rtk_softc *);
152 void rtk_cardbus_power (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 = device_private(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_basetype;
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 = device_private(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", sc->sc_dev.dv_xname);
276 #endif
277 rv = rtk_detach(sc);
278 if (rv)
279 return (rv);
280 /*
281 * Unhook the interrupt 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,
313 pmreg + PCI_PMCSR);
314 if (command & RTK_PSTATE_MASK) {
315 pcireg_t iobase, membase, irq;
316
317 /* Save important PCI config data. */
318 iobase = cardbus_conf_read(cc, cf, csc->sc_tag,
319 RTK_PCI_LOIO);
320 membase = cardbus_conf_read(cc, cf,csc->sc_tag,
321 RTK_PCI_LOMEM);
322 irq = cardbus_conf_read(cc, cf,csc->sc_tag,
323 CARDBUS_INTERRUPT_REG);
324
325 /* Reset the power state. */
326 printf("%s: chip is in D%d power mode "
327 "-- setting to D0\n", sc->sc_dev.dv_xname,
328 command & RTK_PSTATE_MASK);
329 command &= ~RTK_PSTATE_MASK;
330 cardbus_conf_write(cc, cf, csc->sc_tag,
331 pmreg + PCI_PMCSR, command);
332
333 /* Restore PCI config data. */
334 cardbus_conf_write(cc, cf, csc->sc_tag,
335 RTK_PCI_LOIO, iobase);
336 cardbus_conf_write(cc, cf, csc->sc_tag,
337 RTK_PCI_LOMEM, membase);
338 cardbus_conf_write(cc, cf, csc->sc_tag,
339 CARDBUS_INTERRUPT_REG, irq);
340 }
341 }
342
343 /* Program the BAR */
344 cardbus_conf_write(cc, cf, csc->sc_tag,
345 csc->sc_bar_reg, csc->sc_bar_val);
346
347 /* Make sure the right access type is on the CardBus bridge. */
348 (*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben);
349 (*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
350
351 /* Enable the appropriate bits in the CARDBUS CSR. */
352 reg = cardbus_conf_read(cc, cf, csc->sc_tag,
353 CARDBUS_COMMAND_STATUS_REG);
354 reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE);
355 reg |= csc->sc_csr;
356 cardbus_conf_write(cc, cf, csc->sc_tag,
357 CARDBUS_COMMAND_STATUS_REG, reg);
358
359 /*
360 * Make sure the latency timer is set to some reasonable
361 * value.
362 */
363 reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
364 if (CARDBUS_LATTIMER(reg) < 0x20) {
365 reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
366 reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
367 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
368 }
369 }
370
371 int
372 rtk_cardbus_enable(sc)
373 struct rtk_softc *sc;
374 {
375 struct rtk_cardbus_softc *csc = (void *) sc;
376 cardbus_devfunc_t ct = csc->sc_ct;
377 cardbus_chipset_tag_t cc = ct->ct_cc;
378 cardbus_function_tag_t cf = ct->ct_cf;
379
380 /*
381 * Power on the socket.
382 */
383 Cardbus_function_enable(ct);
384
385 /*
386 * Set up the PCI configuration registers.
387 */
388 rtk_cardbus_setup(csc);
389
390 /*
391 * Map and establish the interrupt.
392 */
393 csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
394 IPL_NET, rtk_intr, sc);
395 if (csc->sc_ih == NULL) {
396 printf("%s: unable to establish interrupt at %d\n",
397 sc->sc_dev.dv_xname, csc->sc_intrline);
398 Cardbus_function_disable(csc->sc_ct);
399 return (1);
400 }
401 printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
402 csc->sc_intrline);
403 return (0);
404 }
405
406 void
407 rtk_cardbus_disable(sc)
408 struct rtk_softc *sc;
409 {
410 struct rtk_cardbus_softc *csc = (void *) sc;
411 cardbus_devfunc_t ct = csc->sc_ct;
412 cardbus_chipset_tag_t cc = ct->ct_cc;
413 cardbus_function_tag_t cf = ct->ct_cf;
414
415 /* Unhook the interrupt handler. */
416 cardbus_intr_disestablish(cc, cf, csc->sc_ih);
417 csc->sc_ih = NULL;
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