1 /* $NetBSD: if_ex_cardbus.c,v 1.28.2.1 2004/07/23 22:10:25 he Exp $ */
2
3 /*
4 * CardBus specific routines for 3Com 3C575-family CardBus ethernet adapter
5 *
6 * Copyright (c) 1998 and 1999
7 * HAYAKAWA Koichi. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the author.
20 * 4. Neither the name of the author nor the names of any co-contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY HAYAKAWA KOICHI ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL TAKESHI OHASHI OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *
37 */
38
39 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: if_ex_cardbus.c,v 1.28.2.1 2004/07/23 22:10:25 he Exp $");
41
42 /* #define EX_DEBUG 4 */ /* define to report information for debugging */
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/mbuf.h>
47 #include <sys/socket.h>
48 #include <sys/ioctl.h>
49 #include <sys/errno.h>
50 #include <sys/syslog.h>
51 #include <sys/select.h>
52 #include <sys/device.h>
53
54 #include <net/if.h>
55 #include <net/if_dl.h>
56 #include <net/if_ether.h>
57 #include <net/if_media.h>
58
59 #include <machine/cpu.h>
60 #include <machine/bus.h>
61
62 #include <dev/cardbus/cardbusvar.h>
63 #include <dev/cardbus/cardbusdevs.h>
64
65 #include <dev/mii/miivar.h>
66
67 #include <dev/ic/elink3var.h>
68 #include <dev/ic/elink3reg.h>
69 #include <dev/ic/elinkxlreg.h>
70 #include <dev/ic/elinkxlvar.h>
71
72 #if defined DEBUG && !defined EX_DEBUG
73 #define EX_DEBUG
74 #endif
75
76 #if defined EX_DEBUG
77 #define DPRINTF(a) printf a
78 #else
79 #define DPRINTF(a)
80 #endif
81
82 #define CARDBUS_3C575BTX_FUNCSTAT_PCIREG CARDBUS_BASE2_REG /* means 0x18 */
83 #define EX_CB_INTR 4 /* intr acknowledge reg. CardBus only */
84 #define EX_CB_INTR_ACK 0x8000 /* intr acknowledge bit */
85
86 int ex_cardbus_match __P((struct device *, struct cfdata *, void *));
87 void ex_cardbus_attach __P((struct device *, struct device *,void *));
88 int ex_cardbus_detach __P((struct device *, int));
89 void ex_cardbus_intr_ack __P((struct ex_softc *));
90
91 int ex_cardbus_enable __P((struct ex_softc *));
92 void ex_cardbus_disable __P((struct ex_softc *));
93 void ex_cardbus_power __P((struct ex_softc *, int));
94
95 struct ex_cardbus_softc {
96 struct ex_softc sc_softc;
97
98 cardbus_devfunc_t sc_ct;
99 int sc_intrline;
100 u_int8_t sc_cardbus_flags;
101 #define EX_REATTACH 0x01
102 #define EX_ABSENT 0x02
103 u_int8_t sc_cardtype;
104 #define EX_CB_BOOMERANG 1
105 #define EX_CB_CYCLONE 2
106
107 /* CardBus function status space. 575B requests it. */
108 bus_space_tag_t sc_funct;
109 bus_space_handle_t sc_funch;
110 bus_size_t sc_funcsize;
111
112 bus_size_t sc_mapsize; /* the size of mapped bus space region */
113
114 cardbustag_t sc_tag;
115
116 int sc_csr; /* CSR bits */
117 int sc_bar_reg; /* which BAR to use */
118 pcireg_t sc_bar_val; /* value of the BAR */
119 int sc_bar_reg1; /* which BAR to use */
120 pcireg_t sc_bar_val1; /* value of the BAR */
121
122 };
123
124 CFATTACH_DECL(ex_cardbus, sizeof(struct ex_cardbus_softc),
125 ex_cardbus_match, ex_cardbus_attach, ex_cardbus_detach, ex_activate);
126
127 const struct ex_cardbus_product {
128 u_int32_t ecp_prodid; /* CardBus product ID */
129 int ecp_flags; /* initial softc flags */
130 pcireg_t ecp_csr; /* PCI CSR flags */
131 int ecp_cardtype; /* card type */
132 const char *ecp_name; /* device name */
133 } ex_cardbus_products[] = {
134 { CARDBUS_PRODUCT_3COM_3C575TX,
135 EX_CONF_MII | EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
136 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MASTER_ENABLE,
137 EX_CB_BOOMERANG,
138 "3c575-TX Ethernet" },
139
140 { CARDBUS_PRODUCT_3COM_3C575BTX,
141 EX_CONF_90XB|EX_CONF_MII|EX_CONF_INV_LED_POLARITY |
142 EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
143 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
144 CARDBUS_COMMAND_MASTER_ENABLE,
145 EX_CB_CYCLONE,
146 "3c575B-TX Ethernet" },
147
148 { CARDBUS_PRODUCT_3COM_3C575CTX,
149 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
150 EX_CONF_EEPROM_8BIT,
151 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
152 CARDBUS_COMMAND_MASTER_ENABLE,
153 EX_CB_CYCLONE,
154 "3c575CT Ethernet" },
155
156 { CARDBUS_PRODUCT_3COM_3C656_E,
157 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
158 EX_CONF_EEPROM_8BIT | EX_CONF_INV_LED_POLARITY,
159 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
160 CARDBUS_COMMAND_MASTER_ENABLE,
161 EX_CB_CYCLONE,
162 "3c656-TX Ethernet" },
163
164 { CARDBUS_PRODUCT_3COM_3C656B_E,
165 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
166 EX_CONF_EEPROM_8BIT | EX_CONF_INV_LED_POLARITY,
167 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
168 CARDBUS_COMMAND_MASTER_ENABLE,
169 EX_CB_CYCLONE,
170 "3c656B-TX Ethernet" },
171
172 { CARDBUS_PRODUCT_3COM_3C656C_E,
173 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
174 EX_CONF_EEPROM_8BIT,
175 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
176 CARDBUS_COMMAND_MASTER_ENABLE,
177 EX_CB_CYCLONE,
178 "3c656C-TX Ethernet" },
179
180 { 0,
181 0,
182 0,
183 0,
184 NULL },
185 };
186
187
188 void ex_cardbus_setup __P((struct ex_cardbus_softc *));
189
190 const struct ex_cardbus_product *ex_cardbus_lookup
191 __P((const struct cardbus_attach_args *));
192
193 const struct ex_cardbus_product *
194 ex_cardbus_lookup(ca)
195 const struct cardbus_attach_args *ca;
196 {
197 const struct ex_cardbus_product *ecp;
198
199 if (CARDBUS_VENDOR(ca->ca_id) != CARDBUS_VENDOR_3COM)
200 return (NULL);
201
202 for (ecp = ex_cardbus_products; ecp->ecp_name != NULL; ecp++)
203 if (CARDBUS_PRODUCT(ca->ca_id) == ecp->ecp_prodid)
204 return (ecp);
205 return (NULL);
206 }
207
208 int
209 ex_cardbus_match(parent, cf, aux)
210 struct device *parent;
211 struct cfdata *cf;
212 void *aux;
213 {
214 struct cardbus_attach_args *ca = aux;
215
216 if (ex_cardbus_lookup(ca) != NULL)
217 return (1);
218
219 return (0);
220 }
221
222 void
223 ex_cardbus_attach(parent, self, aux)
224 struct device *parent;
225 struct device *self;
226 void *aux;
227 {
228 struct ex_cardbus_softc *csc = (void *)self;
229 struct ex_softc *sc = &csc->sc_softc;
230 struct cardbus_attach_args *ca = aux;
231 cardbus_devfunc_t ct = ca->ca_ct;
232 #if rbus
233 #else
234 cardbus_chipset_tag_t cc = ct->ct_cc;
235 #endif
236 const struct ex_cardbus_product *ecp;
237 bus_addr_t adr, adr1;
238
239 sc->ex_bustype = EX_BUS_CARDBUS;
240 sc->sc_dmat = ca->ca_dmat;
241 csc->sc_ct = ca->ca_ct;
242 csc->sc_intrline = ca->ca_intrline;
243 csc->sc_tag = ca->ca_tag;
244
245 ecp = ex_cardbus_lookup(ca);
246 if (ecp == NULL) {
247 printf("\n");
248 panic("ex_cardbus_attach: impossible");
249 }
250
251 printf(": 3Com %s\n", ecp->ecp_name);
252
253 sc->ex_conf = ecp->ecp_flags;
254 csc->sc_cardtype = ecp->ecp_cardtype;
255 csc->sc_csr = ecp->ecp_csr;
256
257 if (Cardbus_mapreg_map(ct, CARDBUS_BASE0_REG, CARDBUS_MAPREG_TYPE_IO, 0,
258 &sc->sc_iot, &sc->sc_ioh, &adr, &csc->sc_mapsize) == 0) {
259 #if rbus
260 #else
261 (*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr + csc->sc_mapsize);
262 #endif
263 csc->sc_bar_reg = CARDBUS_BASE0_REG;
264 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
265
266 if (csc->sc_cardtype == EX_CB_CYCLONE) {
267 /* Map CardBus function status window. */
268 if (Cardbus_mapreg_map(ct,
269 CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
270 CARDBUS_MAPREG_TYPE_MEM, 0,
271 &csc->sc_funct, &csc->sc_funch,
272 &adr1, &csc->sc_funcsize) == 0) {
273
274 csc->sc_bar_reg1 =
275 CARDBUS_3C575BTX_FUNCSTAT_PCIREG;
276 csc->sc_bar_val1 =
277 adr1 | CARDBUS_MAPREG_TYPE_MEM;
278
279 } else {
280 printf("%s: unable to map function "
281 "status window\n", self->dv_xname);
282 return;
283 }
284
285 /* Setup interrupt acknowledge hook */
286 sc->intr_ack = ex_cardbus_intr_ack;
287 }
288 }
289 else {
290 printf(": can't map i/o space\n");
291 return;
292 }
293
294 /* Power management hooks. */
295 sc->enable = ex_cardbus_enable;
296 sc->disable = ex_cardbus_disable;
297 sc->power = ex_cardbus_power;
298
299 /*
300 * Handle power management nonsense and
301 * initialize the configuration registers.
302 */
303 ex_cardbus_setup(csc);
304
305 ex_config(sc);
306
307 if (csc->sc_cardtype == EX_CB_CYCLONE)
308 bus_space_write_4(csc->sc_funct, csc->sc_funch,
309 EX_CB_INTR, EX_CB_INTR_ACK);
310
311 Cardbus_function_disable(csc->sc_ct);
312 }
313
314 void
315 ex_cardbus_intr_ack(sc)
316 struct ex_softc *sc;
317 {
318 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
319
320 bus_space_write_4(csc->sc_funct, csc->sc_funch, EX_CB_INTR,
321 EX_CB_INTR_ACK);
322 }
323
324 int
325 ex_cardbus_detach(self, arg)
326 struct device *self;
327 int arg;
328 {
329 struct ex_cardbus_softc *csc = (void *)self;
330 struct ex_softc *sc = &csc->sc_softc;
331 struct cardbus_devfunc *ct = csc->sc_ct;
332 int rv;
333
334 #if defined(DIAGNOSTIC)
335 if (ct == NULL) {
336 panic("%s: data structure lacks", sc->sc_dev.dv_xname);
337 }
338 #endif
339
340 rv = ex_detach(sc);
341 if (rv == 0) {
342 /*
343 * Unhook the interrupt handler.
344 */
345 cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, sc->sc_ih);
346
347 if (csc->sc_cardtype == EX_CB_CYCLONE) {
348 Cardbus_mapreg_unmap(ct,
349 CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
350 csc->sc_funct, csc->sc_funch, csc->sc_funcsize);
351 }
352
353 Cardbus_mapreg_unmap(ct, CARDBUS_BASE0_REG, sc->sc_iot,
354 sc->sc_ioh, csc->sc_mapsize);
355 }
356 return (rv);
357 }
358
359 int
360 ex_cardbus_enable(sc)
361 struct ex_softc *sc;
362 {
363 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
364 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
365 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
366
367 Cardbus_function_enable(csc->sc_ct);
368 ex_cardbus_setup(csc);
369
370 sc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
371 IPL_NET, ex_intr, sc);
372 if (NULL == sc->sc_ih) {
373 printf("%s: couldn't establish interrupt\n",
374 sc->sc_dev.dv_xname);
375 return (1);
376 }
377 printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
378 csc->sc_intrline);
379
380 return (0);
381 }
382
383 void
384 ex_cardbus_disable(sc)
385 struct ex_softc *sc;
386 {
387 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
388 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
389 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
390
391 cardbus_intr_disestablish(cc, cf, sc->sc_ih);
392 sc->sc_ih = NULL;
393
394 Cardbus_function_disable(csc->sc_ct);
395
396 }
397
398 void
399 ex_cardbus_power(sc, why)
400 struct ex_softc *sc;
401 int why;
402 {
403 struct ex_cardbus_softc *csc = (void *) sc;
404
405 if (why == PWR_RESUME) {
406 /*
407 * Give the PCI configuration registers a kick
408 * in the head.
409 */
410 #ifdef DIAGNOSTIC
411 if (sc->enabled == 0)
412 panic("ex_cardbus_power");
413 #endif
414 ex_cardbus_setup(csc);
415 }
416 }
417
418 void
419 ex_cardbus_setup(csc)
420 struct ex_cardbus_softc *csc;
421 {
422 struct ex_softc *sc = &csc->sc_softc;
423 cardbus_devfunc_t ct = csc->sc_ct;
424 cardbus_chipset_tag_t cc = ct->ct_cc;
425 cardbus_function_tag_t cf = ct->ct_cf;
426 cardbusreg_t reg;
427 int pmreg;
428
429 /* Get it out of power save mode if needed (BIOS bugs). */
430 if (cardbus_get_capability(cc, cf, csc->sc_tag,
431 PCI_CAP_PWRMGMT, &pmreg, 0)) {
432 reg = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4) & 0x03;
433 #if 1 /* XXX Probably not right for CardBus. */
434 if (reg == 3) {
435 /*
436 * The card has lost all configuration data in
437 * this state, so punt.
438 */
439 printf("%s: unable to wake up from power state D3\n",
440 sc->sc_dev.dv_xname);
441 return;
442 }
443 #endif
444 if (reg != 0) {
445 printf("%s: waking up from power state D%d\n",
446 sc->sc_dev.dv_xname, reg);
447 cardbus_conf_write(cc, cf, csc->sc_tag,
448 pmreg + 4, 0);
449 }
450 }
451
452 /* Make sure the right access type is on the CardBus bridge. */
453 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_IO_ENABLE);
454 if (csc->sc_cardtype == EX_CB_CYCLONE) {
455 /*
456 * Make sure CardBus brigde can access memory space. Usually
457 * memory access is enabled by BIOS, but some BIOSes do not
458 * enable it.
459 */
460 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_MEM_ENABLE);
461
462 /* Program the BAR */
463 cardbus_conf_write(cc, cf, csc->sc_tag,
464 csc->sc_bar_reg1, csc->sc_bar_val1);
465 }
466 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
467
468
469 /* Program the BAR */
470 cardbus_conf_write(cc, cf, csc->sc_tag,
471 csc->sc_bar_reg, csc->sc_bar_val);
472
473 /* Enable the appropriate bits in the CARDBUS CSR. */
474 reg = cardbus_conf_read(cc, cf, csc->sc_tag,
475 CARDBUS_COMMAND_STATUS_REG);
476 reg |= csc->sc_csr;
477 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_COMMAND_STATUS_REG,
478 reg);
479
480 /*
481 * set latency timer
482 */
483 reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
484 if (CARDBUS_LATTIMER(reg) < 0x20) {
485 /* at least the value of latency timer should 0x20. */
486 DPRINTF(("if_ex_cardbus: lattimer 0x%x -> 0x20\n",
487 CARDBUS_LATTIMER(reg)));
488 reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
489 reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
490 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
491 }
492 }
Cache object: efcef9e80ba4e8386c03eab7f4766587
|