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