if_rtk_cardbus.c revision 1.44 1 /* $NetBSD: if_rtk_cardbus.c,v 1.44 2010/03/11 17:24:27 dyoung 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.44 2010/03/11 17:24:27 dyoung Exp $");
40
41 #include "opt_inet.h"
42 #include "rnd.h"
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/callout.h>
47 #include <sys/device.h>
48 #include <sys/sockio.h>
49 #include <sys/mbuf.h>
50 #include <sys/malloc.h>
51 #include <sys/kernel.h>
52 #include <sys/socket.h>
53
54 #include <net/if.h>
55 #include <net/if_arp.h>
56 #include <net/if_ether.h>
57 #include <net/if_dl.h>
58 #include <net/if_media.h>
59 #ifdef INET
60 #include <netinet/in.h>
61 #include <netinet/if_inarp.h>
62 #endif
63
64 #if NRND > 0
65 #include <sys/rnd.h>
66 #endif
67
68 #include <sys/bus.h>
69
70 #include <dev/pci/pcireg.h>
71 #include <dev/pci/pcivar.h>
72 #include <dev/pci/pcidevs.h>
73
74 #include <dev/cardbus/cardbusvar.h>
75 #include <dev/pci/pcidevs.h>
76
77 #include <dev/mii/mii.h>
78 #include <dev/mii/miivar.h>
79
80 /*
81 * Default to using PIO access for this driver. On SMP systems,
82 * there appear to be problems with memory mapped mode: it looks like
83 * doing too many memory mapped access back to back in rapid succession
84 * can hang the bus. I'm inclined to blame this on crummy design/construction
85 * on the part of Realtek. Memory mapped mode does appear to work on
86 * uniprocessor systems though.
87 */
88 #define RTK_USEIOSPACE
89
90 #include <dev/ic/rtl81x9reg.h>
91 #include <dev/ic/rtl81x9var.h>
92
93 /*
94 * Various supported device vendors/types and their names.
95 */
96 static const struct rtk_type rtk_cardbus_devs[] = {
97 { PCI_VENDOR_ACCTON, PCI_PRODUCT_ACCTON_MPX5030,
98 RTK_8139, "Accton MPX 5030/5038 10/100BaseTX" },
99 { PCI_VENDOR_DLINK, PCI_PRODUCT_DLINK_DFE690TXD,
100 RTK_8139, "D-Link DFE-690TXD 10/100BaseTX" },
101 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8138,
102 RTK_8139, "Realtek 8138 10/100BaseTX" },
103 { PCI_VENDOR_REALTEK, PCI_PRODUCT_REALTEK_RT8139,
104 RTK_8139, "Realtek 8139 10/100BaseTX" },
105 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_CB_TXD,
106 RTK_8139, "Corega FEther CB-TXD 10/100BaseTX" },
107 { PCI_VENDOR_COREGA, PCI_PRODUCT_COREGA_2CB_TXD,
108 RTK_8139, "Corega FEther II CB-TXD 10/100BaseTX" },
109 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3603_TX,
110 RTK_8139, "Planex FNW-3603 10/100BaseTX" },
111 { PCI_VENDOR_PLANEX, PCI_PRODUCT_PLANEX_FNW_3800_TX,
112 RTK_8139, "Planex 10/100BaseTX FNW-3800-TX" },
113 { PCI_VENDOR_ABOCOM, PCI_PRODUCT_ABOCOM_FE2000VX,
114 RTK_8139, "AboCom FE2000VX 10/100BaseTX" },
115
116 { 0, 0, 0, NULL }
117 };
118
119 static int rtk_cardbus_match(device_t, cfdata_t, void *);
120 static void rtk_cardbus_attach(device_t, device_t, void *);
121 static int rtk_cardbus_detach(device_t, int);
122
123 struct rtk_cardbus_softc {
124 struct rtk_softc sc_rtk; /* real rtk softc */
125
126 /* CardBus-specific goo. */
127 void *sc_ih;
128 cardbus_devfunc_t sc_ct;
129 pcitag_t sc_tag;
130 pcireg_t sc_csr;
131 int sc_bar_reg;
132 pcireg_t sc_bar_val;
133 bus_size_t sc_mapsize;
134 cardbus_intr_line_t sc_intrline;
135 };
136
137 CFATTACH_DECL_NEW(rtk_cardbus, sizeof(struct rtk_cardbus_softc),
138 rtk_cardbus_match, rtk_cardbus_attach, rtk_cardbus_detach, rtk_activate);
139
140 const struct rtk_type *rtk_cardbus_lookup(const struct cardbus_attach_args *);
141
142 void rtk_cardbus_setup(struct rtk_cardbus_softc *);
143
144 int rtk_cardbus_enable(struct rtk_softc *);
145 void rtk_cardbus_disable(struct rtk_softc *);
146 void rtk_cardbus_power(struct rtk_softc *, int);
147
148 const struct rtk_type *
149 rtk_cardbus_lookup(const struct cardbus_attach_args *ca)
150 {
151 const struct rtk_type *t;
152
153 for (t = rtk_cardbus_devs; t->rtk_name != NULL; t++){
154 if (PCI_VENDOR(ca->ca_id) == t->rtk_vid &&
155 PCI_PRODUCT(ca->ca_id) == t->rtk_did) {
156 return t;
157 }
158 }
159 return NULL;
160 }
161
162 int
163 rtk_cardbus_match(device_t parent, cfdata_t cf, void *aux)
164 {
165 struct cardbus_attach_args *ca = aux;
166
167 if (rtk_cardbus_lookup(ca) != NULL)
168 return 1;
169
170 return 0;
171 }
172
173
174 void
175 rtk_cardbus_attach(device_t parent, device_t self, void *aux)
176 {
177 struct rtk_cardbus_softc *csc = device_private(self);
178 struct rtk_softc *sc = &csc->sc_rtk;
179 struct cardbus_attach_args *ca = aux;
180 cardbus_devfunc_t ct = ca->ca_ct;
181 const struct rtk_type *t;
182 bus_addr_t adr;
183
184 sc->sc_dev = self;
185 sc->sc_dmat = ca->ca_dmat;
186 csc->sc_ct = ct;
187 csc->sc_tag = ca->ca_tag;
188 csc->sc_intrline = ca->ca_intrline;
189
190 t = rtk_cardbus_lookup(ca);
191 if (t == NULL) {
192 aprint_error("\n");
193 panic("%s: impossible", __func__);
194 }
195 aprint_normal(": %s\n", t->rtk_name);
196
197 /*
198 * Power management hooks.
199 */
200 sc->sc_enable = rtk_cardbus_enable;
201 sc->sc_disable = rtk_cardbus_disable;
202
203 /*
204 * Map control/status registers.
205 */
206 csc->sc_csr = PCI_COMMAND_MASTER_ENABLE;
207 #ifdef RTK_USEIOSPACE
208 if (Cardbus_mapreg_map(ct, RTK_PCI_LOIO, PCI_MAPREG_TYPE_IO, 0,
209 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
210 csc->sc_csr |= PCI_COMMAND_IO_ENABLE;
211 csc->sc_bar_reg = RTK_PCI_LOIO;
212 csc->sc_bar_val = adr | PCI_MAPREG_TYPE_IO;
213 }
214 #else
215 if (Cardbus_mapreg_map(ct, RTK_PCI_LOMEM, PCI_MAPREG_TYPE_MEM, 0,
216 &sc->rtk_btag, &sc->rtk_bhandle, &adr, &csc->sc_mapsize) == 0) {
217 csc->sc_csr |= PCI_COMMAND_MEM_ENABLE;
218 csc->sc_bar_reg = RTK_PCI_LOMEM;
219 csc->sc_bar_val = adr | PCI_MAPREG_TYPE_MEM;
220 }
221 #endif
222 else {
223 aprint_error_dev(self, " unable to map deviceregisters\n");
224 return;
225 }
226 /*
227 * Handle power management nonsense and initialize the
228 * configuration registers.
229 */
230 rtk_cardbus_setup(csc);
231
232 rtk_attach(sc);
233
234 if (pmf_device_register(self, NULL, NULL))
235 pmf_class_network_register(self, &sc->ethercom.ec_if);
236 else
237 aprint_error_dev(self, "couldn't establish power handler\n");
238
239 /*
240 * Power down the socket.
241 */
242 Cardbus_function_disable(csc->sc_ct);
243 }
244
245 int
246 rtk_cardbus_detach(device_t self, int flags)
247 {
248 struct rtk_cardbus_softc *csc = device_private(self);
249 struct rtk_softc *sc = &csc->sc_rtk;
250 struct cardbus_devfunc *ct = csc->sc_ct;
251 int rv;
252
253 #ifdef DIAGNOSTIC
254 if (ct == NULL)
255 panic("%s: data structure lacks", device_xname(self));
256 #endif
257 rv = rtk_detach(sc);
258 if (rv)
259 return rv;
260 /*
261 * Unhook the interrupt handler.
262 */
263 if (csc->sc_ih != NULL)
264 Cardbus_intr_disestablish(ct, csc->sc_ih);
265
266 /*
267 * Release bus space and close window.
268 */
269 if (csc->sc_bar_reg != 0)
270 Cardbus_mapreg_unmap(ct, csc->sc_bar_reg,
271 sc->rtk_btag, sc->rtk_bhandle, csc->sc_mapsize);
272
273 return 0;
274 }
275
276 void
277 rtk_cardbus_setup(struct rtk_cardbus_softc *csc)
278 {
279 struct rtk_softc *sc = &csc->sc_rtk;
280 cardbus_devfunc_t ct = csc->sc_ct;
281 cardbus_chipset_tag_t cc = ct->ct_cc;
282 cardbus_function_tag_t cf = ct->ct_cf;
283 pcireg_t reg, command;
284 int pmreg;
285
286 /*
287 * Handle power management nonsense.
288 */
289 if (cardbus_get_capability(cc, cf, csc->sc_tag,
290 PCI_CAP_PWRMGMT, &pmreg, 0)) {
291 command = Cardbus_conf_read(ct, csc->sc_tag,
292 pmreg + PCI_PMCSR);
293 if (command & PCI_PMCSR_STATE_MASK) {
294 pcireg_t iobase, membase, irq;
295
296 /* Save important PCI config data. */
297 iobase = Cardbus_conf_read(ct, csc->sc_tag,
298 RTK_PCI_LOIO);
299 membase = Cardbus_conf_read(ct, csc->sc_tag,
300 RTK_PCI_LOMEM);
301 irq = Cardbus_conf_read(ct, csc->sc_tag,
302 PCI_INTERRUPT_REG);
303
304 /* Reset the power state. */
305 aprint_normal_dev(sc->sc_dev,
306 "chip is in D%d power mode -- setting to D0\n",
307 command & PCI_PMCSR_STATE_MASK);
308 command &= ~PCI_PMCSR_STATE_MASK;
309 Cardbus_conf_write(ct, csc->sc_tag,
310 pmreg + PCI_PMCSR, command);
311
312 /* Restore PCI config data. */
313 Cardbus_conf_write(ct, csc->sc_tag,
314 RTK_PCI_LOIO, iobase);
315 Cardbus_conf_write(ct, csc->sc_tag,
316 RTK_PCI_LOMEM, membase);
317 Cardbus_conf_write(ct, csc->sc_tag,
318 PCI_INTERRUPT_REG, irq);
319 }
320 }
321
322 /* Program the BAR */
323 Cardbus_conf_write(ct, csc->sc_tag, csc->sc_bar_reg, csc->sc_bar_val);
324
325 /* Enable the appropriate bits in the CARDBUS CSR. */
326 reg = Cardbus_conf_read(ct, csc->sc_tag, PCI_COMMAND_STATUS_REG);
327 reg &= ~(PCI_COMMAND_IO_ENABLE|PCI_COMMAND_MEM_ENABLE);
328 reg |= csc->sc_csr;
329 Cardbus_conf_write(ct, csc->sc_tag, PCI_COMMAND_STATUS_REG, reg);
330
331 /*
332 * Make sure the latency timer is set to some reasonable
333 * value.
334 */
335 reg = Cardbus_conf_read(ct, csc->sc_tag, PCI_BHLC_REG);
336 if (PCI_LATTIMER(reg) < 0x20) {
337 reg &= ~(PCI_LATTIMER_MASK << PCI_LATTIMER_SHIFT);
338 reg |= (0x20 << PCI_LATTIMER_SHIFT);
339 Cardbus_conf_write(ct, csc->sc_tag, PCI_BHLC_REG, reg);
340 }
341 }
342
343 int
344 rtk_cardbus_enable(struct rtk_softc *sc)
345 {
346 struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)sc;
347 cardbus_devfunc_t ct = csc->sc_ct;
348
349 /*
350 * Power on the socket.
351 */
352 Cardbus_function_enable(ct);
353
354 /*
355 * Set up the PCI configuration registers.
356 */
357 rtk_cardbus_setup(csc);
358
359 /*
360 * Map and establish the interrupt.
361 */
362 csc->sc_ih = Cardbus_intr_establish(ct, csc->sc_intrline,
363 IPL_NET, rtk_intr, sc);
364 if (csc->sc_ih == NULL) {
365 aprint_error_dev(sc->sc_dev,
366 "unable to establish interrupt\n");
367 Cardbus_function_disable(csc->sc_ct);
368 return 1;
369 }
370 return 0;
371 }
372
373 void
374 rtk_cardbus_disable(struct rtk_softc *sc)
375 {
376 struct rtk_cardbus_softc *csc = (struct rtk_cardbus_softc *)sc;
377 cardbus_devfunc_t ct = csc->sc_ct;
378
379 /* Unhook the interrupt handler. */
380 Cardbus_intr_disestablish(ct, csc->sc_ih);
381 csc->sc_ih = NULL;
382
383 /* Power down the socket. */
384 Cardbus_function_disable(ct);
385 }
386