if_ep_pcmcia.c revision 1.44 1 /* $NetBSD: if_ep_pcmcia.c,v 1.44 2004/08/09 15:40:56 mycroft 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.44 2004/08/09 15:40:56 mycroft 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 CFATTACH_DECL(ep_pcmcia, sizeof(struct ep_pcmcia_softc),
121 ep_pcmcia_match, ep_pcmcia_attach, ep_pcmcia_detach, ep_activate);
122
123 const struct ep_pcmcia_product {
124 struct pcmcia_product epp_product;
125 u_short epp_chipset; /* 3Com chipset used */
126 int epp_flags; /* initial softc flags */
127 } ep_pcmcia_products[] = {
128 { { "", PCMCIA_VENDOR_3COM,
129 PCMCIA_PRODUCT_3COM_3C562, 0 },
130 ELINK_CHIPSET_3C509, 0 },
131
132 { { "", PCMCIA_VENDOR_3COM,
133 PCMCIA_PRODUCT_3COM_3C589, 0 },
134 ELINK_CHIPSET_3C509, 0 },
135
136 { { "", PCMCIA_VENDOR_3COM,
137 PCMCIA_PRODUCT_3COM_3CXEM556, 0 },
138 ELINK_CHIPSET_3C509, 0 },
139
140 { { "", PCMCIA_VENDOR_3COM,
141 PCMCIA_PRODUCT_3COM_3CXEM556INT, 0 },
142 ELINK_CHIPSET_3C509, 0 },
143
144 { { "", PCMCIA_VENDOR_3COM,
145 PCMCIA_PRODUCT_3COM_3C574, 0 },
146 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
147
148 { { "", PCMCIA_VENDOR_3COM,
149 PCMCIA_PRODUCT_3COM_3CCFEM556BI, 0 },
150 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
151
152 { { "", PCMCIA_VENDOR_3COM,
153 PCMCIA_PRODUCT_3COM_3C1, 0 },
154 ELINK_CHIPSET_3C509, 0 },
155
156 { { NULL } }
157 };
158
159 int
160 ep_pcmcia_match(parent, match, aux)
161 struct device *parent;
162 struct cfdata *match;
163 void *aux;
164 {
165 struct pcmcia_attach_args *pa = aux;
166
167 if (pcmcia_product_lookup(pa,
168 (const struct pcmcia_product *)ep_pcmcia_products,
169 sizeof ep_pcmcia_products[0], NULL) != NULL)
170 return (1);
171
172 return (0);
173 }
174
175 int
176 ep_pcmcia_enable(sc)
177 struct ep_softc *sc;
178 {
179 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
180 struct pcmcia_function *pf = psc->sc_pf;
181 int error;
182
183 if ((error = ep_pcmcia_enable1(sc)) != 0)
184 return error;
185
186 /* establish the interrupt. */
187 sc->sc_ih = pcmcia_intr_establish(pf, IPL_NET, epintr, sc);
188 if (sc->sc_ih == NULL) {
189 printf("%s: couldn't establish interrupt\n",
190 sc->sc_dev.dv_xname);
191 ep_pcmcia_disable1(sc);
192 return (1);
193 }
194
195 return 0;
196 }
197
198 int
199 ep_pcmcia_enable1(sc)
200 struct ep_softc *sc;
201 {
202 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
203 struct pcmcia_function *pf = psc->sc_pf;
204 int ret;
205
206 if ((ret = pcmcia_function_enable(pf)))
207 return (ret);
208
209 if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
210 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
211 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
212 int reg;
213
214 /* turn off the serial-disable bit */
215
216 reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
217 if (reg & 0x08) {
218 reg &= ~0x08;
219 pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
220 }
221
222 }
223
224 return (ret);
225 }
226
227 void
228 ep_pcmcia_disable(sc)
229 struct ep_softc *sc;
230 {
231 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
232
233 /*
234 * We must disestablish the interrupt before disabling the function,
235 * because on a multifunction card the interrupt disestablishment
236 * accesses CCR registers.
237 */
238 pcmcia_intr_disestablish(psc->sc_pf, sc->sc_ih);
239 ep_pcmcia_disable1(sc);
240 }
241
242 void
243 ep_pcmcia_disable1(sc)
244 struct ep_softc *sc;
245 {
246 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
247
248 pcmcia_function_disable(psc->sc_pf);
249 }
250
251 void
252 ep_pcmcia_attach(parent, self, aux)
253 struct device *parent, *self;
254 void *aux;
255 {
256 struct ep_pcmcia_softc *psc = (void *) self;
257 struct ep_softc *sc = &psc->sc_ep;
258 struct pcmcia_attach_args *pa = aux;
259 struct pcmcia_config_entry *cfe;
260 const struct ep_pcmcia_product *epp;
261 u_int8_t myla[ETHER_ADDR_LEN];
262 u_int8_t *enaddr = NULL;
263 int i;
264
265 aprint_normal("\n");
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 aprint_error("%s: function enable failed\n", self->dv_xname);
274 goto enable_failed;
275 }
276 sc->enabled = 1;
277
278 if (cfe->num_memspace != 0) {
279 aprint_error("%s: unexpected number of memory spaces %d should be 0\n",
280 self->dv_xname, cfe->num_memspace);
281 goto ioalloc_failed;
282 }
283
284 if (cfe->num_iospace != 1) {
285 aprint_error("%s: unexpected number of I/O spaces %d should be 1\n",
286 self->dv_xname, 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 aprint_error("%s: can't allocate i/o space\n",
316 self->dv_xname);
317 goto ioalloc_failed;
318 }
319 } else {
320 if (pcmcia_io_alloc(pa->pf, 0, cfe->iospace[0].length,
321 cfe->iospace[0].length, &psc->sc_pcioh)) {
322 aprint_error("%s: can't allocate i/o space\n",
323 self->dv_xname);
324 goto ioalloc_failed;
325 }
326 }
327
328 sc->sc_iot = psc->sc_pcioh.iot;
329 sc->sc_ioh = psc->sc_pcioh.ioh;
330
331 if (pcmcia_io_map(pa->pf, ((cfe->flags & PCMCIA_CFE_IO16) ?
332 PCMCIA_WIDTH_AUTO : PCMCIA_WIDTH_IO8), &psc->sc_pcioh,
333 &psc->sc_io_window)) {
334 aprint_error("%s: can't map i/o space\n", self->dv_xname);
335 goto iomap_failed;
336 }
337
338 switch (pa->product) {
339 case PCMCIA_PRODUCT_3COM_3C562:
340 /*
341 * 3c562a-c use this; 3c562d does it in the regular way.
342 * we might want to check the revision and produce a warning
343 * in the future.
344 */
345 /* FALLTHROUGH */
346 case PCMCIA_PRODUCT_3COM_3C574:
347 case PCMCIA_PRODUCT_3COM_3CCFEM556BI:
348 /*
349 * Apparently, some 3c574s do it this way, as well.
350 */
351 if (pcmcia_scan_cis(parent, ep_pcmcia_get_enaddr, myla))
352 enaddr = myla;
353 break;
354 }
355
356 epp = (const struct ep_pcmcia_product *)pcmcia_product_lookup(pa,
357 (const struct pcmcia_product *)ep_pcmcia_products,
358 sizeof ep_pcmcia_products[0], NULL);
359 if (epp == NULL)
360 panic("ep_pcmcia_attach: impossible");
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 aprint_error("%s: couldn't configure controller\n",
370 self->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