if_rtk_cardbus.c revision 1.5 1 /* $NetBSD: if_rtk_cardbus.c,v 1.5 2001/06/20 05:41:27 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 "opt_inet.h"
39 #include "opt_ns.h"
40 #include "bpfilter.h"
41 #include "rnd.h"
42
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/callout.h>
46 #include <sys/device.h>
47 #include <sys/sockio.h>
48 #include <sys/mbuf.h>
49 #include <sys/malloc.h>
50 #include <sys/kernel.h>
51 #include <sys/socket.h>
52
53 #include <net/if.h>
54 #include <net/if_arp.h>
55 #include <net/if_ether.h>
56 #include <net/if_dl.h>
57 #include <net/if_media.h>
58 #ifdef INET
59 #include <netinet/in.h>
60 #include <netinet/if_inarp.h>
61 #endif
62 #ifdef NS
63 #include <netns/ns.h>
64 #include <netns/ns_if.h>
65 #endif
66
67 #if NBPFILTER > 0
68 #include <net/bpf.h>
69 #endif
70 #if NRND > 0
71 #include <sys/rnd.h>
72 #endif
73
74 #include <machine/bus.h>
75
76 #include <dev/pci/pcireg.h>
77 #include <dev/pci/pcivar.h>
78 #include <dev/pci/pcidevs.h>
79
80 #include <dev/cardbus/cardbusvar.h>
81 #include <dev/cardbus/cardbusdevs.h>
82
83 #include <dev/mii/mii.h>
84 #include <dev/mii/miivar.h>
85
86 /*
87 * Default to using PIO access for this driver. On SMP systems,
88 * there appear to be problems with memory mapped mode: it looks like
89 * doing too many memory mapped access back to back in rapid succession
90 * can hang the bus. I'm inclined to blame this on crummy design/construction
91 * on the part of RealTek. Memory mapped mode does appear to work on
92 * uniprocessor systems though.
93 */
94 #define RTK_USEIOSPACE
95
96 #include <dev/ic/rtl81x9reg.h>
97 #include <dev/ic/rtl81x9var.h>
98
99 /*
100 * Various supported device vendors/types and their names.
101 */
102 static const struct rtk_type rtk_cardbus_devs[] = {
103 { CARDBUS_VENDOR_ACCTON, CARDBUS_PRODUCT_ACCTON_MPX5030,
104 "Accton MPX 5030/5038 10/100BaseTX",
105 RTK_8139 },
106 { CARDBUS_VENDOR_REALTEK, CARDBUS_PRODUCT_REALTEK_RT8138,
107 "RealTek 8138 10/100BaseTX", RTK_8139 },
108 { CARDBUS_VENDOR_REALTEK, CARDBUS_PRODUCT_REALTEK_RT8139,
109 "RealTek 8139 10/100BaseTX", RTK_8139 },
110 { CARDBUS_VENDOR_COREGA, CARDBUS_PRODUCT_COREGA_CB_TXD,
111 "Corega FEther CB-TXD 10/100BaseTX", RTK_8139 },
112 { 0, 0, NULL, 0 }
113 };
114
115 static int rtk_cardbus_match __P((struct device *, struct cfdata *, void *));
116 static void rtk_cardbus_attach __P((struct device *, struct device *, void *));
117 static int rtk_cardbus_detach __P((struct device *, int));
118
119 struct rtk_cardbus_softc {
120 struct rtk_softc sc_rtk; /* real rtk softc */
121
122 /* CardBus-specific goo. */
123 void *sc_ih;
124 cardbus_devfunc_t sc_ct;
125 cardbustag_t sc_tag;
126 int sc_csr;
127 int sc_cben;
128 int sc_bar_reg;
129 pcireg_t sc_bar_val;
130 bus_size_t sc_mapsize;
131 int sc_intrline;
132 };
133
134 struct cfattach rtk_cardbus_ca = {
135 sizeof(struct rtk_cardbus_softc),
136 rtk_cardbus_match, rtk_cardbus_attach,
137 rtk_cardbus_detach, rtk_activate,
138 };
139
140 const struct rtk_type *rtk_cardbus_lookup
141 __P((const struct cardbus_attach_args *));
142
143 void rtk_cardbus_setup __P((struct rtk_cardbus_softc *));
144
145 int rtk_cardbus_enable __P((struct rtk_softc *));
146 void rtk_cardbus_disable __P((struct rtk_softc *));
147 void rtk_cardbus_power __P((struct rtk_softc *, int));
148 const struct rtk_type *
149 rtk_cardbus_lookup(ca)
150 const struct cardbus_attach_args *ca;
151 {
152 const struct rtk_type *t;
153
154 for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){
155 if (CARDBUS_VENDOR(ca->ca_id) == t->rtk_vid &&
156 CARDBUS_PRODUCT(ca->ca_id) == t->rtk_did) {
157 return (t);
158 }
159 }
160 return (NULL);
161 }
162
163 int
164 rtk_cardbus_match(parent, match, aux)
165 struct device *parent;
166 struct cfdata *match;
167 void *aux;
168 {
169 struct cardbus_attach_args *ca = aux;
170
171 if (rtk_cardbus_lookup(ca) != NULL)
172 return (1);
173
174 return (0);
175 }
176
177
178 void
179 rtk_cardbus_attach(parent, self, aux)
180 struct device *parent, *self;
181 void *aux;
182 {
183 struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)self;
184 struct rtk_softc *sc = &csc->sc_rtk;
185 struct cardbus_attach_args *ca = aux;
186 cardbus_devfunc_t ct = ca->ca_ct;
187 const struct rtk_type *t;
188 bus_addr_t adr;
189
190 sc->sc_dmat = ca->ca_dmat;
191 csc->sc_ct = ct;
192 csc->sc_tag = ca->ca_tag;
193 csc->sc_intrline = ca->ca_intrline;
194
195 t = rtk_cardbus_lookup(ca);
196 if (t == NULL) {
197 printf("\n");
198 panic("rtk_cardbus_attach: impossible");
199 }
200 printf(": %s\n", t->rtk_name);
201
202 /*
203 * Power management hooks.
204 */
205 sc->sc_enable = rtk_cardbus_enable;
206 sc->sc_disable = rtk_cardbus_disable;
207 sc->sc_power = rtk_cardbus_power;
208
209 /*
210 * Map control/status registers.
211 */
212 csc->sc_csr = CARDBUS_COMMAND_MASTER_ENABLE;
213 #ifdef RTK_USEIOSPACE
214 if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, CARDBUS_MAPREG_TYPE_IO, 0,
215 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
216 #if rbus
217 #else
218 (*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr+csc->sc_mapsize);
219 #endif
220 csc->sc_cben = CARDBUS_IO_ENABLE;
221 csc->sc_csr |= CARDBUS_COMMAND_IO_ENABLE;
222 csc->sc_bar_reg = RTK_PCI_LOIO;
223 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
224 }
225 #else
226 if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, CARDBUS_MAPREG_TYPE_MEM, 0,
227 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
228 #if rbus
229 #else
230 (*ct->ct_cf->cardbus_mem_open)(cc, 0, adr, adr+csc->sc_mapsize);
231 #endif
232 csc->sc_cben = CARDBUS_MEM_ENABLE;
233 csc->sc_csr |= CARDBUS_COMMAND_MEM_ENABLE;
234 csc->sc_bar_reg = RTK_PCI_LOMEM;
235 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_MEM;
236 }
237 #endif
238 else {
239 printf("%s: unable to map deviceregisters\n",
240 sc->sc_dev.dv_xname);
241 return;
242 }
243 /*
244 * Handle power management nonsense and initialize the
245 * configuration registers.
246 */
247 rtk_cardbus_setup(csc);
248 sc->rtk_type = t->rtk_type;
249
250 rtk_attach(sc);
251
252 /*
253 * Power down the socket.
254 */
255 Cardbus_function_disable(csc->sc_ct);
256 }
257
258 int
259 rtk_cardbus_detach(self, flags)
260 struct device *self;
261 int flags;
262 {
263 struct rtk_cardbus_softc *csc = (void *) self;
264 struct rtk_softc *sc = &csc->sc_rtk;
265 struct cardbus_devfunc *ct = csc->sc_ct;
266 int rv;
267
268 #ifdef DIAGNOSTIC
269 if (ct == NULL)
270 panic("%s: data structure lacks\n", sc->sc_dev.dv_xname);
271 #endif
272 rv = rtk_detach(sc);
273 if (rv)
274 return (rv);
275 /*
276 * Unhook the interrut handler.
277 */
278 if (csc->sc_ih != NULL)
279 cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, csc->sc_ih);
280
281 /*
282 * Release bus space and close window.
283 */
284 if (csc->sc_bar_reg != 0)
285 Cardbus_mapreg_unmap(ct, csc->sc_bar_reg,
286 sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize);
287
288 return (0);
289 }
290
291 void
292 rtk_cardbus_setup(csc)
293 struct rtk_cardbus_softc *csc;
294 {
295 struct rtk_softc *sc = &csc->sc_rtk;
296 cardbus_devfunc_t ct = csc->sc_ct;
297 cardbus_chipset_tag_t cc = ct->ct_cc;
298 cardbus_function_tag_t cf = ct->ct_cf;
299 pcireg_t reg,command;
300 int pmreg;
301
302 /*
303 * Handle power management nonsense.
304 */
305 if (cardbus_get_capability(cc, cf, csc->sc_tag,
306 PCI_CAP_PWRMGMT, &pmreg, 0)) {
307 command = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4);
308 if (command & RTK_PSTATE_MASK) {
309 pcireg_t iobase, membase, irq;
310
311 /* Save important PCI config data. */
312 iobase = cardbus_conf_read(cc, cf, csc->sc_tag,
313 RTK_PCI_LOIO);
314 membase = cardbus_conf_read(cc, cf,csc->sc_tag,
315 RTK_PCI_LOMEM);
316 irq = cardbus_conf_read(cc, cf,csc->sc_tag,
317 PCI_PRODUCT_DELTA_8139);
318
319 /* Reset the power state. */
320 printf("%s: chip is is in D%d power mode "
321 "-- setting to D0\n", sc->sc_dev.dv_xname,
322 command & RTK_PSTATE_MASK);
323 command &= 0xFFFFFFFC;
324 cardbus_conf_write(cc, cf, csc->sc_tag,
325 pmreg + 4, command);
326
327 /* Restore PCI config data. */
328 cardbus_conf_write(cc, cf, csc->sc_tag,
329 RTK_PCI_LOIO, iobase);
330 cardbus_conf_write(cc, cf, csc->sc_tag,
331 RTK_PCI_LOMEM, membase);
332 cardbus_conf_write(cc, cf, csc->sc_tag,
333 PCI_PRODUCT_DELTA_8139, irq);
334 }
335 }
336
337 /* Make sure the right access type is on the CardBus bridge. */
338 (*ct->ct_cf->cardbus_ctrl)(cc, csc->sc_cben);
339 (*ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
340
341 /* Program the BAR */
342 cardbus_conf_write(cc, cf, csc->sc_tag,
343 csc->sc_bar_reg, csc->sc_bar_val);
344
345 /* Enable the appropriate bits in the CARDBUS CSR. */
346 reg = cardbus_conf_read(cc, cf, csc->sc_tag,
347 CARDBUS_COMMAND_STATUS_REG);
348 reg &= ~(CARDBUS_COMMAND_IO_ENABLE|CARDBUS_COMMAND_MEM_ENABLE);
349 reg |= csc->sc_csr;
350 cardbus_conf_write(cc, cf, csc->sc_tag,
351 CARDBUS_COMMAND_STATUS_REG, reg);
352
353 /*
354 * Make sure the latency timer is set to some reasonable
355 * value.
356 */
357 reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
358 if (CARDBUS_LATTIMER(reg) < 0x20) {
359 reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
360 reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
361 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
362 }
363 }
364
365 int
366 rtk_cardbus_enable(sc)
367 struct rtk_softc *sc;
368 {
369 struct rtk_cardbus_softc *csc = (void *) sc;
370 cardbus_devfunc_t ct = csc->sc_ct;
371 cardbus_chipset_tag_t cc = ct->ct_cc;
372 cardbus_function_tag_t cf = ct->ct_cf;
373
374 /*
375 * Power on the socket.
376 */
377 Cardbus_function_enable(ct);
378
379 /*
380 * Set up the PCI configuration registers.
381 */
382 rtk_cardbus_setup(csc);
383
384 /*
385 * Map and establish the interrupt.
386 */
387 csc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
388 IPL_NET, rtk_intr, sc);
389 if (csc->sc_ih == NULL) {
390 printf("%s: unable to establish interrupt at %d\n",
391 sc->sc_dev.dv_xname, csc->sc_intrline);
392 Cardbus_function_disable(csc->sc_ct);
393 return (1);
394 }
395 printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
396 csc->sc_intrline);
397 return (0);
398 }
399
400 void
401 rtk_cardbus_disable(sc)
402 struct rtk_softc *sc;
403 {
404 struct rtk_cardbus_softc *csc = (void *) sc;
405 cardbus_devfunc_t ct = csc->sc_ct;
406 cardbus_chipset_tag_t cc = ct->ct_cc;
407 cardbus_function_tag_t cf = ct->ct_cf;
408
409 /* Unhook the interrupt handler. */
410 cardbus_intr_disestablish(cc, cf, csc->sc_ih);
411
412 /* Power down the socket. */
413 Cardbus_function_disable(ct);
414 }
415
416 void
417 rtk_cardbus_power(sc, why)
418 struct rtk_softc *sc;
419 int why;
420 {
421 struct rtk_cardbus_softc *csc = (void *) sc;
422
423 if (why == PWR_RESUME) {
424 /*
425 * Give the PCI configuration registers a kick
426 * in the head.
427 */
428 #ifdef DIAGNOSTIC
429 if (RTK_IS_ENABLED(sc) == 0)
430 panic("rtk_cardbus_power");
431 #endif
432 rtk_cardbus_setup(csc);
433 }
434 }
435