if_ex_cardbus.c revision 1.23 1 /* $NetBSD: if_ex_cardbus.c,v 1.23 2001/11/13 12:51:13 lukem 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.23 2001/11/13 12:51:13 lukem 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 struct cfattach ex_cardbus_ca = {
125 sizeof(struct ex_cardbus_softc), ex_cardbus_match,
126 ex_cardbus_attach, ex_cardbus_detach, ex_activate
127 };
128
129 const struct ex_cardbus_product {
130 u_int32_t ecp_prodid; /* CardBus product ID */
131 int ecp_flags; /* initial softc flags */
132 pcireg_t ecp_csr; /* PCI CSR flags */
133 int ecp_cardtype; /* card type */
134 const char *ecp_name; /* device name */
135 } ex_cardbus_products[] = {
136 { CARDBUS_PRODUCT_3COM_3C575TX,
137 EX_CONF_MII | EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
138 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MASTER_ENABLE,
139 EX_CB_BOOMERANG,
140 "3c575-TX Ethernet" },
141
142 { CARDBUS_PRODUCT_3COM_3C575BTX,
143 EX_CONF_90XB|EX_CONF_MII|EX_CONF_INV_LED_POLARITY |
144 EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
145 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
146 CARDBUS_COMMAND_MASTER_ENABLE,
147 EX_CB_CYCLONE,
148 "3c575B-TX Ethernet" },
149
150 { CARDBUS_PRODUCT_3COM_3C575CTX,
151 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
152 EX_CONF_EEPROM_8BIT,
153 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
154 CARDBUS_COMMAND_MASTER_ENABLE,
155 EX_CB_CYCLONE,
156 "3c575CT Ethernet" },
157
158 { 0,
159 0,
160 0,
161 0,
162 NULL },
163 };
164
165
166 void ex_cardbus_setup __P((struct ex_cardbus_softc *));
167
168 const struct ex_cardbus_product *ex_cardbus_lookup
169 __P((const struct cardbus_attach_args *));
170
171 const struct ex_cardbus_product *
172 ex_cardbus_lookup(ca)
173 const struct cardbus_attach_args *ca;
174 {
175 const struct ex_cardbus_product *ecp;
176
177 if (CARDBUS_VENDOR(ca->ca_id) != CARDBUS_VENDOR_3COM)
178 return (NULL);
179
180 for (ecp = ex_cardbus_products; ecp->ecp_name != NULL; ecp++)
181 if (CARDBUS_PRODUCT(ca->ca_id) == ecp->ecp_prodid)
182 return (ecp);
183 return (NULL);
184 }
185
186 int
187 ex_cardbus_match(parent, cf, aux)
188 struct device *parent;
189 struct cfdata *cf;
190 void *aux;
191 {
192 struct cardbus_attach_args *ca = aux;
193
194 if (ex_cardbus_lookup(ca) != NULL)
195 return (1);
196
197 return (0);
198 }
199
200 void
201 ex_cardbus_attach(parent, self, aux)
202 struct device *parent;
203 struct device *self;
204 void *aux;
205 {
206 struct ex_cardbus_softc *csc = (void *)self;
207 struct ex_softc *sc = &csc->sc_softc;
208 struct cardbus_attach_args *ca = aux;
209 cardbus_devfunc_t ct = ca->ca_ct;
210 #if rbus
211 #else
212 cardbus_chipset_tag_t cc = ct->ct_cc;
213 #endif
214 const struct ex_cardbus_product *ecp;
215 bus_addr_t adr, adr1;
216
217 sc->ex_bustype = EX_BUS_CARDBUS;
218 sc->sc_dmat = ca->ca_dmat;
219 csc->sc_ct = ca->ca_ct;
220 csc->sc_intrline = ca->ca_intrline;
221 csc->sc_tag = ca->ca_tag;
222
223 ecp = ex_cardbus_lookup(ca);
224 if (ecp == NULL) {
225 printf("\n");
226 panic("ex_cardbus_attach: impossible");
227 }
228
229 printf(": 3Com %s\n", ecp->ecp_name);
230
231 sc->ex_conf = ecp->ecp_flags;
232 csc->sc_cardtype = ecp->ecp_cardtype;
233 csc->sc_csr = ecp->ecp_csr;
234
235 if (Cardbus_mapreg_map(ct, CARDBUS_BASE0_REG, CARDBUS_MAPREG_TYPE_IO, 0,
236 &sc->sc_iot, &sc->sc_ioh, &adr, &csc->sc_mapsize) == 0) {
237 #if rbus
238 #else
239 (*ct->ct_cf->cardbus_io_open)(cc, 0, adr, adr + csc->sc_mapsize);
240 #endif
241 csc->sc_bar_reg = CARDBUS_BASE0_REG;
242 csc->sc_bar_val = adr | CARDBUS_MAPREG_TYPE_IO;
243
244 if (csc->sc_cardtype == EX_CB_CYCLONE) {
245 /* Map CardBus function status window. */
246 if (Cardbus_mapreg_map(ct,
247 CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
248 CARDBUS_MAPREG_TYPE_MEM, 0,
249 &csc->sc_funct, &csc->sc_funch,
250 &adr1, &csc->sc_funcsize) == 0) {
251
252 csc->sc_bar_reg1 =
253 CARDBUS_3C575BTX_FUNCSTAT_PCIREG;
254 csc->sc_bar_val1 =
255 adr1 | CARDBUS_MAPREG_TYPE_MEM;
256
257 } else {
258 printf("%s: unable to map function "
259 "status window\n", self->dv_xname);
260 return;
261 }
262
263 /* Setup interrupt acknowledge hook */
264 sc->intr_ack = ex_cardbus_intr_ack;
265 }
266 }
267 else {
268 printf(": can't map i/o space\n");
269 return;
270 }
271
272 /* Power management hooks. */
273 sc->enable = ex_cardbus_enable;
274 sc->disable = ex_cardbus_disable;
275 sc->power = ex_cardbus_power;
276
277 /*
278 * Handle power management nonsense and
279 * initialize the configuration registers.
280 */
281 ex_cardbus_setup(csc);
282
283 ex_config(sc);
284
285 if (csc->sc_cardtype == EX_CB_CYCLONE)
286 bus_space_write_4(csc->sc_funct, csc->sc_funch,
287 EX_CB_INTR, EX_CB_INTR_ACK);
288
289 Cardbus_function_disable(csc->sc_ct);
290 }
291
292 void
293 ex_cardbus_intr_ack(sc)
294 struct ex_softc *sc;
295 {
296 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
297
298 bus_space_write_4(csc->sc_funct, csc->sc_funch, EX_CB_INTR,
299 EX_CB_INTR_ACK);
300 }
301
302 int
303 ex_cardbus_detach(self, arg)
304 struct device *self;
305 int arg;
306 {
307 struct ex_cardbus_softc *csc = (void *)self;
308 struct ex_softc *sc = &csc->sc_softc;
309 struct cardbus_devfunc *ct = csc->sc_ct;
310 int rv;
311
312 #if defined(DIAGNOSTIC)
313 if (ct == NULL) {
314 panic("%s: data structure lacks\n", sc->sc_dev.dv_xname);
315 }
316 #endif
317
318 rv = ex_detach(sc);
319 if (rv == 0) {
320 /*
321 * Unhook the interrupt handler.
322 */
323 cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, sc->sc_ih);
324
325 if (csc->sc_cardtype == EX_CB_CYCLONE) {
326 Cardbus_mapreg_unmap(ct,
327 CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
328 csc->sc_funct, csc->sc_funch, csc->sc_funcsize);
329 }
330
331 Cardbus_mapreg_unmap(ct, CARDBUS_BASE0_REG, sc->sc_iot,
332 sc->sc_ioh, csc->sc_mapsize);
333 }
334 return (rv);
335 }
336
337 int
338 ex_cardbus_enable(sc)
339 struct ex_softc *sc;
340 {
341 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
342 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
343 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
344
345 Cardbus_function_enable(csc->sc_ct);
346 ex_cardbus_setup(csc);
347
348 sc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
349 IPL_NET, ex_intr, sc);
350 if (NULL == sc->sc_ih) {
351 printf("%s: couldn't establish interrupt\n",
352 sc->sc_dev.dv_xname);
353 return (1);
354 }
355 printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
356 csc->sc_intrline);
357
358 return (0);
359 }
360
361 void
362 ex_cardbus_disable(sc)
363 struct ex_softc *sc;
364 {
365 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
366 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
367 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
368
369 cardbus_intr_disestablish(cc, cf, sc->sc_ih);
370 sc->sc_ih = NULL;
371
372 Cardbus_function_disable(csc->sc_ct);
373
374 }
375
376 void
377 ex_cardbus_power(sc, why)
378 struct ex_softc *sc;
379 int why;
380 {
381 struct ex_cardbus_softc *csc = (void *) sc;
382
383 if (why == PWR_RESUME) {
384 /*
385 * Give the PCI configuration registers a kick
386 * in the head.
387 */
388 #ifdef DIAGNOSTIC
389 if (sc->enabled == 0)
390 panic("ex_cardbus_power");
391 #endif
392 ex_cardbus_setup(csc);
393 }
394 }
395
396 void
397 ex_cardbus_setup(csc)
398 struct ex_cardbus_softc *csc;
399 {
400 struct ex_softc *sc = &csc->sc_softc;
401 cardbus_devfunc_t ct = csc->sc_ct;
402 cardbus_chipset_tag_t cc = ct->ct_cc;
403 cardbus_function_tag_t cf = ct->ct_cf;
404 cardbusreg_t reg;
405 int pmreg;
406
407 /* Get it out of power save mode if needed (BIOS bugs). */
408 if (cardbus_get_capability(cc, cf, csc->sc_tag,
409 PCI_CAP_PWRMGMT, &pmreg, 0)) {
410 reg = cardbus_conf_read(cc, cf, csc->sc_tag, pmreg + 4) & 0x03;
411 #if 1 /* XXX Probably not right for CardBus. */
412 if (reg == 3) {
413 /*
414 * The card has lost all configuration data in
415 * this state, so punt.
416 */
417 printf("%s: unable to wake up from power state D3\n",
418 sc->sc_dev.dv_xname);
419 return;
420 }
421 #endif
422 if (reg != 0) {
423 printf("%s: waking up from power state D%d\n",
424 sc->sc_dev.dv_xname, reg);
425 cardbus_conf_write(cc, cf, csc->sc_tag,
426 pmreg + 4, 0);
427 }
428 }
429
430 /* Make sure the right access type is on the CardBus bridge. */
431 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_IO_ENABLE);
432 if (csc->sc_cardtype == EX_CB_CYCLONE) {
433 /*
434 * Make sure CardBus brigde can access memory space. Usually
435 * memory access is enabled by BIOS, but some BIOSes do not
436 * enable it.
437 */
438 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_MEM_ENABLE);
439
440 /* Program the BAR */
441 cardbus_conf_write(cc, cf, csc->sc_tag,
442 csc->sc_bar_reg1, csc->sc_bar_val1);
443 }
444 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
445
446
447 /* Program the BAR */
448 cardbus_conf_write(cc, cf, csc->sc_tag,
449 csc->sc_bar_reg, csc->sc_bar_val);
450
451 /* Enable the appropriate bits in the CARDBUS CSR. */
452 reg = cardbus_conf_read(cc, cf, csc->sc_tag,
453 CARDBUS_COMMAND_STATUS_REG);
454 reg |= csc->sc_csr;
455 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_COMMAND_STATUS_REG,
456 reg);
457
458 /*
459 * set latency timmer
460 */
461 reg = cardbus_conf_read(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG);
462 if (CARDBUS_LATTIMER(reg) < 0x20) {
463 /* at least the value of latency timer should 0x20. */
464 DPRINTF(("if_ex_cardbus: lattimer 0x%x -> 0x20\n",
465 CARDBUS_LATTIMER(reg)));
466 reg &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
467 reg |= (0x20 << CARDBUS_LATTIMER_SHIFT);
468 cardbus_conf_write(cc, cf, csc->sc_tag, CARDBUS_BHLC_REG, reg);
469 }
470 }
471