if_ex_cardbus.c revision 1.3.2.1 1 /* $NetBSD: if_ex_cardbus.c,v 1.3.2.1 2000/11/20 11:39:53 bouyer 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 /* #define EX_DEBUG 4 */ /* define to report infomation for debugging */
40
41 #define EX_POWER_STATIC /* do not use enable/disable functions */
42 /* I'm waiting elinkxl.c uses
43 sc->enable and sc->disable
44 functions. */
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/mbuf.h>
49 #include <sys/socket.h>
50 #include <sys/ioctl.h>
51 #include <sys/errno.h>
52 #include <sys/syslog.h>
53 #include <sys/select.h>
54 #include <sys/device.h>
55
56 #include <net/if.h>
57 #include <net/if_dl.h>
58 #include <net/if_ether.h>
59 #include <net/if_media.h>
60
61 #include <machine/cpu.h>
62 #include <machine/bus.h>
63
64 #include <dev/cardbus/cardbusvar.h>
65 #include <dev/cardbus/cardbusdevs.h>
66
67 #include <dev/mii/miivar.h>
68
69 #include <dev/ic/elink3var.h>
70 #include <dev/ic/elink3reg.h>
71 #include <dev/ic/elinkxlreg.h>
72 #include <dev/ic/elinkxlvar.h>
73
74 #if defined DEBUG && !defined EX_DEBUG
75 #define EX_DEBUG
76 #endif
77
78 #if defined EX_DEBUG
79 #define DPRINTF(a) printf a
80 #else
81 #define DPRINTF(a)
82 #endif
83
84 #define CARDBUS_3C575BTX_FUNCSTAT_PCIREG CARDBUS_BASE2_REG /* means 0x18 */
85 #define EX_CB_INTR 4 /* intr acknowledge reg. CardBus only */
86 #define EX_CB_INTR_ACK 0x8000 /* intr acknowledge bit */
87
88 int ex_cardbus_match __P((struct device *, struct cfdata *, void *));
89 void ex_cardbus_attach __P((struct device *, struct device *,void *));
90 int ex_cardbus_detach __P((struct device *, int));
91 void ex_cardbus_intr_ack __P((struct ex_softc *));
92
93 #if !defined EX_POWER_STATIC
94 int ex_cardbus_enable __P((struct ex_softc *sc));
95 void ex_cardbus_disable __P((struct ex_softc *sc));
96 #endif /* !defined EX_POWER_STATIC */
97
98 struct ex_cardbus_softc {
99 struct ex_softc sc_softc;
100
101 cardbus_devfunc_t sc_ct;
102 int sc_intrline;
103 u_int8_t sc_cardbus_flags;
104 #define EX_REATTACH 0x01
105 #define EX_ABSENT 0x02
106 u_int8_t sc_cardtype;
107 #define EX_CB_BOOMERANG 1
108 #define EX_CB_CYCLONE 2
109
110 /* CardBus function status space. 575B requests it. */
111 bus_space_tag_t sc_funct;
112 bus_space_handle_t sc_funch;
113 bus_size_t sc_funcsize;
114
115 bus_size_t sc_mapsize; /* the size of mapped bus space region */
116 };
117
118 struct cfattach ex_cardbus_ca = {
119 sizeof(struct ex_cardbus_softc), ex_cardbus_match,
120 ex_cardbus_attach, ex_cardbus_detach, ex_activate
121 };
122
123 const struct ex_cardbus_product {
124 u_int32_t ecp_prodid; /* CardBus product ID */
125 int ecp_flags; /* initial softc flags */
126 pcireg_t ecp_csr; /* PCI CSR flags */
127 int ecp_cardtype; /* card type */
128 const char *ecp_name; /* device name */
129 } ex_cardbus_products[] = {
130 { CARDBUS_PRODUCT_3COM_3C575TX,
131 EX_CONF_MII | EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
132 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MASTER_ENABLE,
133 EX_CB_BOOMERANG,
134 "3c575-TX Ethernet" },
135
136 { CARDBUS_PRODUCT_3COM_3C575BTX,
137 EX_CONF_90XB|EX_CONF_MII|EX_CONF_INV_LED_POLARITY |
138 EX_CONF_EEPROM_OFF | EX_CONF_EEPROM_8BIT,
139 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
140 CARDBUS_COMMAND_MASTER_ENABLE,
141 EX_CB_CYCLONE,
142 "3c575B-TX Ethernet" },
143
144 { CARDBUS_PRODUCT_3COM_3C575CTX,
145 EX_CONF_90XB | EX_CONF_PHY_POWER | EX_CONF_EEPROM_OFF |
146 EX_CONF_EEPROM_8BIT,
147 CARDBUS_COMMAND_IO_ENABLE | CARDBUS_COMMAND_MEM_ENABLE |
148 CARDBUS_COMMAND_MASTER_ENABLE,
149 EX_CB_CYCLONE,
150 "3c575CT Ethernet" },
151
152 { 0,
153 0,
154 0,
155 0,
156 NULL },
157 };
158
159 const struct ex_cardbus_product *ex_cardbus_lookup
160 __P((const struct cardbus_attach_args *));
161
162 const struct ex_cardbus_product *
163 ex_cardbus_lookup(ca)
164 const struct cardbus_attach_args *ca;
165 {
166 const struct ex_cardbus_product *ecp;
167
168 if (CARDBUS_VENDOR(ca->ca_id) != CARDBUS_VENDOR_3COM)
169 return (NULL);
170
171 for (ecp = ex_cardbus_products; ecp->ecp_name != NULL; ecp++)
172 if (CARDBUS_PRODUCT(ca->ca_id) == ecp->ecp_prodid)
173 return (ecp);
174 return (NULL);
175 }
176
177 int
178 ex_cardbus_match(parent, cf, aux)
179 struct device *parent;
180 struct cfdata *cf;
181 void *aux;
182 {
183 struct cardbus_attach_args *ca = aux;
184
185 if (ex_cardbus_lookup(ca) != NULL)
186 return (1);
187
188 return (0);
189 }
190
191 void
192 ex_cardbus_attach(parent, self, aux)
193 struct device *parent;
194 struct device *self;
195 void *aux;
196 {
197 struct ex_cardbus_softc *csc = (void *)self;
198 struct ex_softc *sc = &csc->sc_softc;
199 struct cardbus_attach_args *ca = aux;
200 cardbus_devfunc_t ct = ca->ca_ct;
201 cardbus_chipset_tag_t cc = ct->ct_cc;
202 cardbus_function_tag_t cf = ct->ct_cf;
203 cardbusreg_t iob, command, bhlc;
204 const struct ex_cardbus_product *ecp;
205 bus_space_handle_t ioh;
206 bus_addr_t adr;
207
208 if (Cardbus_mapreg_map(ct, CARDBUS_BASE0_REG, CARDBUS_MAPREG_TYPE_IO, 0,
209 &sc->sc_iot, &ioh, &adr, &csc->sc_mapsize)) {
210 printf(": can't map i/o space\n");
211 return;
212 }
213
214 ecp = ex_cardbus_lookup(ca);
215 if (ecp == NULL) {
216 printf("\n");
217 panic("ex_cardbus_attach: impossible");
218 }
219
220 printf(": 3Com %s\n", ecp->ecp_name);
221
222 #if !defined EX_POWER_STATIC
223 sc->enable = ex_cardbus_enable;
224 sc->disable = ex_cardbus_disable;
225 #else
226 sc->enable = NULL;
227 sc->disable = NULL;
228 #endif
229 sc->enabled = 1;
230
231 sc->sc_dmat = ca->ca_dmat;
232
233 sc->ex_bustype = EX_BUS_CARDBUS;
234 sc->ex_conf = ecp->ecp_flags;
235
236 iob = adr;
237 sc->sc_ioh = ioh;
238
239 #if rbus
240 #else
241 (ct->ct_cf->cardbus_io_open)(cc, 0, iob, iob + 0x40);
242 #endif
243 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_IO_ENABLE);
244
245 command = cardbus_conf_read(cc, cf, ca->ca_tag,
246 CARDBUS_COMMAND_STATUS_REG);
247 command |= ecp->ecp_csr;
248 csc->sc_cardtype = ecp->ecp_cardtype;
249
250 if (csc->sc_cardtype == EX_CB_CYCLONE) {
251 /* Map CardBus function status window. */
252 if (Cardbus_mapreg_map(ct, CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
253 CARDBUS_MAPREG_TYPE_MEM, 0, &csc->sc_funct,
254 &csc->sc_funch, 0, &csc->sc_funcsize)) {
255 printf("%s: unable to map function status window\n",
256 self->dv_xname);
257 return;
258 }
259
260 /*
261 * Make sure CardBus brigde can access memory space. Usually
262 * memory access is enabled by BIOS, but some BIOSes do not
263 * enable it.
264 */
265 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_MEM_ENABLE);
266
267 /* Setup interrupt acknowledge hook */
268 sc->intr_ack = ex_cardbus_intr_ack;
269 }
270
271 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
272 cardbus_conf_write(cc, cf, ca->ca_tag, CARDBUS_COMMAND_STATUS_REG,
273 command);
274
275 /*
276 * set latency timmer
277 */
278 bhlc = cardbus_conf_read(cc, cf, ca->ca_tag, CARDBUS_BHLC_REG);
279 if (CARDBUS_LATTIMER(bhlc) < 0x20) {
280 /* at least the value of latency timer should 0x20. */
281 DPRINTF(("if_ex_cardbus: lattimer 0x%x -> 0x20\n",
282 CARDBUS_LATTIMER(bhlc)));
283 bhlc &= ~(CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT);
284 bhlc |= (0x20 << CARDBUS_LATTIMER_SHIFT);
285 cardbus_conf_write(cc, cf, ca->ca_tag, CARDBUS_BHLC_REG, bhlc);
286 }
287
288 csc->sc_ct = ca->ca_ct;
289 csc->sc_intrline = ca->ca_intrline;
290
291 #if defined EX_POWER_STATIC
292 /* Map and establish the interrupt. */
293
294 sc->sc_ih = cardbus_intr_establish(cc, cf, ca->ca_intrline, IPL_NET,
295 ex_intr, csc);
296 if (sc->sc_ih == NULL) {
297 printf("%s: couldn't establish interrupt",
298 sc->sc_dev.dv_xname);
299 printf(" at %d", ca->ca_intrline);
300 printf("\n");
301 return;
302 }
303 printf("%s: interrupting at %d\n", sc->sc_dev.dv_xname,
304 ca->ca_intrline);
305 #endif
306
307 ex_config(sc);
308
309 if (csc->sc_cardtype == EX_CB_CYCLONE)
310 bus_space_write_4(csc->sc_funct, csc->sc_funch,
311 EX_CB_INTR, EX_CB_INTR_ACK);
312
313 #if !defined EX_POWER_STATIC
314 cardbus_function_disable(csc->sc_ct);
315 sc->enabled = 0;
316 #endif
317 }
318
319 void
320 ex_cardbus_intr_ack(sc)
321 struct ex_softc *sc;
322 {
323 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
324
325 bus_space_write_4(csc->sc_funct, csc->sc_funch, EX_CB_INTR,
326 EX_CB_INTR_ACK);
327 }
328
329 int
330 ex_cardbus_detach(self, arg)
331 struct device *self;
332 int arg;
333 {
334 struct ex_cardbus_softc *csc = (void *)self;
335 struct ex_softc *sc = &csc->sc_softc;
336 struct cardbus_devfunc *ct = csc->sc_ct;
337 int rv;
338
339 #if defined(DIAGNOSTIC)
340 if (ct == NULL) {
341 panic("%s: data structure lacks\n", sc->sc_dev.dv_xname);
342 }
343 #endif
344
345 rv = ex_detach(sc);
346 if (rv == 0) {
347 /*
348 * Unhook the interrupt handler.
349 */
350 cardbus_intr_disestablish(ct->ct_cc, ct->ct_cf, sc->sc_ih);
351
352 if (csc->sc_cardtype == EX_CB_CYCLONE) {
353 Cardbus_mapreg_unmap(ct,
354 CARDBUS_3C575BTX_FUNCSTAT_PCIREG,
355 csc->sc_funct, csc->sc_funch, csc->sc_funcsize);
356 }
357
358 Cardbus_mapreg_unmap(ct, CARDBUS_BASE0_REG, sc->sc_iot,
359 sc->sc_ioh, csc->sc_mapsize);
360 }
361 return (rv);
362 }
363
364 #if !defined EX_POWER_STATIC
365 int
366 ex_cardbus_enable(sc)
367 struct ex_softc *sc;
368 {
369 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
370 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
371 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
372
373 Cardbus_function_enable(csc->sc_ct);
374 cardbus_restore_bar(csc->sc_ct);
375
376 sc->sc_ih = cardbus_intr_establish(cc, cf, csc->sc_intrline,
377 IPL_NET, ex_intr, sc);
378 if (NULL == sc->sc_ih) {
379 printf("%s: couldn't establish interrupt\n",
380 sc->sc_dev.dv_xname);
381 return (1);
382 }
383
384 return (0);
385 }
386
387 void
388 ex_cardbus_disable(sc)
389 struct ex_softc *sc;
390 {
391 struct ex_cardbus_softc *csc = (struct ex_cardbus_softc *)sc;
392 cardbus_function_tag_t cf = csc->sc_ct->ct_cf;
393 cardbus_chipset_tag_t cc = csc->sc_ct->ct_cc;
394
395 cardbus_save_bar(csc->sc_ct);
396
397 Cardbus_function_disable(csc->sc_ct);
398
399 cardbus_intr_disestablish(cc, cf, sc->sc_ih);
400 }
401 #endif /* EX_POWER_STATIC */
402