if_ep_pcmcia.c revision 1.38 1 /* $NetBSD: if_ep_pcmcia.c,v 1.38 2002/06/01 23:51:01 lukem Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 2000 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1997 Marc Horowitz. All rights reserved.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by Marc Horowitz.
54 * 4. The name of the author may not be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 */
68
69 #include <sys/cdefs.h>
70 __KERNEL_RCSID(0, "$NetBSD: if_ep_pcmcia.c,v 1.38 2002/06/01 23:51:01 lukem Exp $");
71
72 #include <sys/param.h>
73 #include <sys/systm.h>
74 #include <sys/mbuf.h>
75 #include <sys/socket.h>
76 #include <sys/ioctl.h>
77 #include <sys/errno.h>
78 #include <sys/syslog.h>
79 #include <sys/select.h>
80 #include <sys/device.h>
81
82 #include <net/if.h>
83 #include <net/if_dl.h>
84 #include <net/if_ether.h>
85 #include <net/if_media.h>
86
87 #include <machine/cpu.h>
88 #include <machine/bus.h>
89 #include <machine/intr.h>
90
91 #include <dev/mii/miivar.h>
92
93 #include <dev/ic/elink3var.h>
94 #include <dev/ic/elink3reg.h>
95
96 #include <dev/pcmcia/pcmciareg.h>
97 #include <dev/pcmcia/pcmciavar.h>
98 #include <dev/pcmcia/pcmciadevs.h>
99
100 int ep_pcmcia_match __P((struct device *, struct cfdata *, void *));
101 void ep_pcmcia_attach __P((struct device *, struct device *, void *));
102 int ep_pcmcia_detach __P((struct device *, int));
103
104 int ep_pcmcia_get_enaddr __P((struct pcmcia_tuple *, void *));
105 int ep_pcmcia_enable __P((struct ep_softc *));
106 void ep_pcmcia_disable __P((struct ep_softc *));
107
108 int ep_pcmcia_enable1 __P((struct ep_softc *));
109 void ep_pcmcia_disable1 __P((struct ep_softc *));
110
111 struct ep_pcmcia_softc {
112 struct ep_softc sc_ep; /* real "ep" softc */
113
114 /* PCMCIA-specific goo */
115 struct pcmcia_io_handle sc_pcioh; /* PCMCIA i/o space info */
116 int sc_io_window; /* our i/o window */
117 struct pcmcia_function *sc_pf; /* our PCMCIA function */
118 };
119
120 struct cfattach ep_pcmcia_ca = {
121 sizeof(struct ep_pcmcia_softc), ep_pcmcia_match, ep_pcmcia_attach,
122 ep_pcmcia_detach, ep_activate
123 };
124
125 const struct ep_pcmcia_product {
126 struct pcmcia_product epp_product;
127 u_short epp_chipset; /* 3Com chipset used */
128 int epp_flags; /* initial softc flags */
129 } ep_pcmcia_products[] = {
130 { { PCMCIA_STR_3COM_3C562, PCMCIA_VENDOR_3COM,
131 PCMCIA_PRODUCT_3COM_3C562, 0 },
132 ELINK_CHIPSET_3C509, 0 },
133
134 { { PCMCIA_STR_3COM_3C589, PCMCIA_VENDOR_3COM,
135 PCMCIA_PRODUCT_3COM_3C589, 0 },
136 ELINK_CHIPSET_3C509, 0 },
137
138 { { PCMCIA_STR_3COM_3CXEM556, PCMCIA_VENDOR_3COM,
139 PCMCIA_PRODUCT_3COM_3CXEM556, 0 },
140 ELINK_CHIPSET_3C509, 0 },
141
142 { { PCMCIA_STR_3COM_3CXEM556INT, PCMCIA_VENDOR_3COM,
143 PCMCIA_PRODUCT_3COM_3CXEM556INT, 0 },
144 ELINK_CHIPSET_3C509, 0 },
145
146 { { PCMCIA_STR_3COM_3C574, PCMCIA_VENDOR_3COM,
147 PCMCIA_PRODUCT_3COM_3C574, 0 },
148 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
149
150 { { PCMCIA_STR_3COM_3CCFEM556BI, PCMCIA_VENDOR_3COM,
151 PCMCIA_PRODUCT_3COM_3CCFEM556BI, 0 },
152 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
153
154 { { PCMCIA_STR_3COM_3C1, PCMCIA_VENDOR_3COM,
155 PCMCIA_PRODUCT_3COM_3C1, 0 },
156 ELINK_CHIPSET_3C509, 0 },
157
158 { { NULL } }
159 };
160
161 int
162 ep_pcmcia_match(parent, match, aux)
163 struct device *parent;
164 struct cfdata *match;
165 void *aux;
166 {
167 struct pcmcia_attach_args *pa = aux;
168
169 if (pcmcia_product_lookup(pa,
170 (const struct pcmcia_product *)ep_pcmcia_products,
171 sizeof ep_pcmcia_products[0], NULL) != NULL)
172 return (1);
173
174 return (0);
175 }
176
177 int
178 ep_pcmcia_enable(sc)
179 struct ep_softc *sc;
180 {
181 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
182 struct pcmcia_function *pf = psc->sc_pf;
183 int error;
184
185 if ((error = ep_pcmcia_enable1(sc)) != 0)
186 return error;
187
188 /* establish the interrupt. */
189 sc->sc_ih = pcmcia_intr_establish(pf, IPL_NET, epintr, sc);
190 if (sc->sc_ih == NULL) {
191 printf("%s: couldn't establish interrupt\n",
192 sc->sc_dev.dv_xname);
193 ep_pcmcia_disable1(sc);
194 return (1);
195 }
196
197 return 0;
198 }
199
200 int
201 ep_pcmcia_enable1(sc)
202 struct ep_softc *sc;
203 {
204 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
205 struct pcmcia_function *pf = psc->sc_pf;
206 int ret;
207
208 if ((ret = pcmcia_function_enable(pf)))
209 return (ret);
210
211 if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
212 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
213 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
214 int reg;
215
216 /* turn off the serial-disable bit */
217
218 reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
219 if (reg & 0x08) {
220 reg &= ~0x08;
221 pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
222 }
223
224 }
225
226 return (ret);
227 }
228
229 void
230 ep_pcmcia_disable(sc)
231 struct ep_softc *sc;
232 {
233 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
234
235 /*
236 * We must disestablish the interrupt before disabling the function,
237 * because on a multifunction card the interrupt disestablishment
238 * accesses CCR registers.
239 */
240 pcmcia_intr_disestablish(psc->sc_pf, sc->sc_ih);
241 ep_pcmcia_disable1(sc);
242 }
243
244 void
245 ep_pcmcia_disable1(sc)
246 struct ep_softc *sc;
247 {
248 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
249
250 pcmcia_function_disable(psc->sc_pf);
251 }
252
253 void
254 ep_pcmcia_attach(parent, self, aux)
255 struct device *parent, *self;
256 void *aux;
257 {
258 struct ep_pcmcia_softc *psc = (void *) self;
259 struct ep_softc *sc = &psc->sc_ep;
260 struct pcmcia_attach_args *pa = aux;
261 struct pcmcia_config_entry *cfe;
262 const struct ep_pcmcia_product *epp;
263 u_int8_t myla[ETHER_ADDR_LEN];
264 u_int8_t *enaddr = NULL;
265 int i;
266
267 psc->sc_pf = pa->pf;
268 cfe = SIMPLEQ_FIRST(&pa->pf->cfe_head);
269
270 /* Enable the card. */
271 pcmcia_function_init(pa->pf, cfe);
272 if (ep_pcmcia_enable1(sc)) {
273 printf(": function enable failed\n");
274 goto enable_failed;
275 }
276 sc->enabled = 1;
277
278 if (cfe->num_memspace != 0) {
279 printf(": unexpected number of memory spaces %d should be 0\n",
280 cfe->num_memspace);
281 goto ioalloc_failed;
282 }
283
284 if (cfe->num_iospace != 1) {
285 printf(": unexpected number of I/O spaces %d should be 1\n",
286 cfe->num_iospace);
287 goto ioalloc_failed;
288 }
289
290 if (pa->product == PCMCIA_PRODUCT_3COM_3C562) {
291 /*
292 * the 3c562 can only use 0x??00-0x??7f
293 * according to the Linux driver
294 */
295
296 /*
297 * 3c562 i/o may decodes address line not only A0-3
298 * but also A7. Anyway, we must sweep at most
299 * [0x0000, 0x0100). The address higher is given by a
300 * pcmcia bridge. But pcmcia bus-space allocation
301 * function implies cards will decode 10-bit address
302 * line. So we must search [0x0000, 0x0400).
303 *
304 * XXX: We must not check the bunch of I/O space range
305 * [0x400*n, 0x300 + 0x400*n) because they are
306 * reserved for legacy ISA devices and their alias
307 * images on PC/AT architecture.
308 */
309 for (i = 0x0300; i < 0x0380; i += 0x10) {
310 if (pcmcia_io_alloc(pa->pf, i, cfe->iospace[0].length,
311 0, &psc->sc_pcioh) == 0)
312 break;
313 }
314 if (i == 0x0380) {
315 printf(": can't allocate i/o space\n");
316 goto ioalloc_failed;
317 }
318 } else {
319 if (pcmcia_io_alloc(pa->pf, 0, cfe->iospace[0].length,
320 cfe->iospace[0].length, &psc->sc_pcioh)) {
321 printf(": can't allocate i/o space\n");
322 goto ioalloc_failed;
323 }
324 }
325
326 sc->sc_iot = psc->sc_pcioh.iot;
327 sc->sc_ioh = psc->sc_pcioh.ioh;
328
329 if (pcmcia_io_map(pa->pf, ((cfe->flags & PCMCIA_CFE_IO16) ?
330 PCMCIA_WIDTH_IO16 : PCMCIA_WIDTH_IO8), 0, cfe->iospace[0].length,
331 &psc->sc_pcioh, &psc->sc_io_window)) {
332 printf(": can't map i/o space\n");
333 goto iomap_failed;
334 }
335
336 switch (pa->product) {
337 case PCMCIA_PRODUCT_3COM_3C562:
338 /*
339 * 3c562a-c use this; 3c562d does it in the regular way.
340 * we might want to check the revision and produce a warning
341 * in the future.
342 */
343 /* FALLTHROUGH */
344 case PCMCIA_PRODUCT_3COM_3C574:
345 case PCMCIA_PRODUCT_3COM_3CCFEM556BI:
346 /*
347 * Apparently, some 3c574s do it this way, as well.
348 */
349 if (pcmcia_scan_cis(parent, ep_pcmcia_get_enaddr, myla))
350 enaddr = myla;
351 break;
352 }
353
354 epp = (const struct ep_pcmcia_product *)pcmcia_product_lookup(pa,
355 (const struct pcmcia_product *)ep_pcmcia_products,
356 sizeof ep_pcmcia_products[0], NULL);
357 if (epp == NULL)
358 panic("ep_pcmcia_attach: impossible");
359
360 printf(": %s\n", epp->epp_product.pp_name);
361
362 sc->bustype = ELINK_BUS_PCMCIA;
363 sc->ep_flags = epp->epp_flags;
364
365 sc->enable = ep_pcmcia_enable;
366 sc->disable = ep_pcmcia_disable;
367
368 if (epconfig(sc, epp->epp_chipset, enaddr)) {
369 printf("%s: couldn't configure controller\n",
370 sc->sc_dev.dv_xname);
371 goto config_failed;
372 }
373
374 sc->enabled = 0;
375 ep_pcmcia_disable1(sc);
376 return;
377
378 config_failed:
379 /* Unmap our i/o window. */
380 pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
381
382 iomap_failed:
383 /* Free our i/o space. */
384 pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);
385
386 ioalloc_failed:
387 sc->enabled = 0;
388 ep_pcmcia_disable1(sc);
389
390 enable_failed:
391 psc->sc_io_window = -1;
392 }
393
394 int
395 ep_pcmcia_detach(self, flags)
396 struct device *self;
397 int flags;
398 {
399 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *)self;
400 int rv;
401
402 if (psc->sc_io_window == -1)
403 /* Nothing to detach. */
404 return (0);
405
406 rv = ep_detach(self, flags);
407 if (rv != 0)
408 return (rv);
409
410 /* Unmap our i/o window. */
411 pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
412
413 /* Free our i/o space. */
414 pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);
415
416 return (0);
417 }
418
419 int
420 ep_pcmcia_get_enaddr(tuple, arg)
421 struct pcmcia_tuple *tuple;
422 void *arg;
423 {
424 u_int8_t *myla = arg;
425 int i;
426
427 /* this is 3c562a-c magic */
428 if (tuple->code == 0x88) {
429 if (tuple->length < ETHER_ADDR_LEN)
430 return (0);
431
432 for (i = 0; i < ETHER_ADDR_LEN; i += 2) {
433 myla[i] = pcmcia_tuple_read_1(tuple, i + 1);
434 myla[i + 1] = pcmcia_tuple_read_1(tuple, i);
435 }
436
437 return (1);
438 }
439 return (0);
440 }
441