if_ep_pcmcia.c revision 1.60 1 /* $NetBSD: if_ep_pcmcia.c,v 1.60 2008/04/05 21:31:23 cegger Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 2000, 2004 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, and by Charles M. Hannum.
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.60 2008/04/05 21:31:23 cegger 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 <sys/cpu.h>
88 #include <sys/bus.h>
89 #include <sys/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(struct device *, struct cfdata *, void *);
101 void ep_pcmcia_attach(struct device *, struct device *, void *);
102 int ep_pcmcia_detach(struct device *, int);
103
104 int ep_pcmcia_get_enaddr(struct pcmcia_tuple *, void *);
105 int ep_pcmcia_enable(struct ep_softc *);
106 void ep_pcmcia_disable(struct ep_softc *);
107
108 void ep_pcmcia_disable1(struct ep_softc *);
109
110 struct ep_pcmcia_softc {
111 struct ep_softc sc_ep; /* real "ep" softc */
112
113 /* PCMCIA-specific goo */
114 struct pcmcia_io_handle sc_pcioh; /* PCMCIA i/o space info */
115 int sc_io_window; /* our i/o window */
116 struct pcmcia_function *sc_pf; /* our PCMCIA function */
117
118 void *sc_powerhook; /* power management hook */
119 };
120
121 CFATTACH_DECL(ep_pcmcia, sizeof(struct ep_pcmcia_softc),
122 ep_pcmcia_match, ep_pcmcia_attach, ep_pcmcia_detach, ep_activate);
123
124 const struct ep_pcmcia_product {
125 struct pcmcia_product epp_product;
126 u_short epp_chipset; /* 3Com chipset used */
127 int epp_flags; /* initial softc flags */
128 } ep_pcmcia_products[] = {
129 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3C562,
130 PCMCIA_CIS_INVALID },
131 ELINK_CHIPSET_3C509, 0 },
132
133 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3C589,
134 PCMCIA_CIS_INVALID },
135 ELINK_CHIPSET_3C509, 0 },
136
137 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3CXEM556,
138 PCMCIA_CIS_INVALID },
139 ELINK_CHIPSET_3C509, 0 },
140
141 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3CXEM556INT,
142 PCMCIA_CIS_INVALID },
143 ELINK_CHIPSET_3C509, 0 },
144
145 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3C574,
146 PCMCIA_CIS_INVALID },
147 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
148
149 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3CCFEM556BI,
150 PCMCIA_CIS_INVALID },
151 ELINK_CHIPSET_ROADRUNNER, ELINK_FLAGS_MII },
152
153 { { PCMCIA_VENDOR_3COM, PCMCIA_PRODUCT_3COM_3C1,
154 PCMCIA_CIS_INVALID },
155 ELINK_CHIPSET_3C509, 0 },
156 };
157 const size_t ep_pcmcia_nproducts =
158 sizeof(ep_pcmcia_products) / sizeof(ep_pcmcia_products[0]);
159
160 int
161 ep_pcmcia_match(struct device *parent, struct cfdata *match,
162 void *aux)
163 {
164 struct pcmcia_attach_args *pa = aux;
165
166 /* This is to differentiate the serial function of some cards. */
167 if (pa->pf->function != PCMCIA_FUNCTION_NETWORK)
168 return (0);
169
170 if (pcmcia_product_lookup(pa, ep_pcmcia_products, ep_pcmcia_nproducts,
171 sizeof(ep_pcmcia_products[0]), NULL))
172 return (1);
173 return (0);
174 }
175
176 int
177 ep_pcmcia_enable(sc)
178 struct ep_softc *sc;
179 {
180 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
181 struct pcmcia_function *pf = psc->sc_pf;
182 int error;
183
184 /* establish the interrupt. */
185 sc->sc_ih = pcmcia_intr_establish(pf, IPL_NET, epintr, sc);
186 if (!sc->sc_ih)
187 return (EIO);
188
189 error = pcmcia_function_enable(pf);
190 if (error) {
191 pcmcia_intr_disestablish(pf, sc->sc_ih);
192 sc->sc_ih = 0;
193 return (error);
194 }
195
196 if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
197 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
198 (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
199 int reg;
200
201 /* turn off the serial-disable bit */
202
203 reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
204 if (reg & 0x08) {
205 reg &= ~0x08;
206 pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
207 }
208
209 }
210
211 return (0);
212 }
213
214 void
215 ep_pcmcia_disable(sc)
216 struct ep_softc *sc;
217 {
218 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *) sc;
219
220 pcmcia_function_disable(psc->sc_pf);
221 pcmcia_intr_disestablish(psc->sc_pf, sc->sc_ih);
222 sc->sc_ih = 0;
223 }
224
225 void
226 ep_pcmcia_attach(parent, self, aux)
227 struct device *parent, *self;
228 void *aux;
229 {
230 struct ep_pcmcia_softc *psc = (void *) self;
231 struct ep_softc *sc = &psc->sc_ep;
232 struct pcmcia_attach_args *pa = aux;
233 struct pcmcia_config_entry *cfe;
234 const struct ep_pcmcia_product *epp;
235 u_int8_t myla[ETHER_ADDR_LEN];
236 u_int8_t *enaddr = NULL;
237 int i;
238 int error;
239
240 psc->sc_pf = pa->pf;
241
242 SIMPLEQ_FOREACH(cfe, &pa->pf->cfe_head, cfe_list) {
243 if (cfe->num_memspace != 0)
244 continue;
245 if (cfe->num_iospace != 1)
246 continue;
247
248 if (pa->product == PCMCIA_PRODUCT_3COM_3C562) {
249 /*
250 * the 3c562 can only use 0x??00-0x??7f
251 * according to the Linux driver
252 */
253
254 /*
255 * 3c562 i/o may decodes address line not only A0-3
256 * but also A7. Anyway, we must sweep at most
257 * [0x0000, 0x0100). The address higher is given by a
258 * pcmcia bridge. But pcmcia bus-space allocation
259 * function implies cards will decode 10-bit address
260 * line. So we must search [0x0000, 0x0400).
261 *
262 * XXX: We must not check the bunch of I/O space range
263 * [0x400*n, 0x300 + 0x400*n) because they are
264 * reserved for legacy ISA devices and their alias
265 * images on PC/AT architecture.
266 */
267 for (i = 0x0300; i < 0x0380; i += 0x10) {
268 if (pcmcia_io_alloc(pa->pf, i,
269 cfe->iospace[0].length,
270 cfe->iospace[0].length,
271 &psc->sc_pcioh) == 0)
272 break;
273 }
274 if (i != 0x0380)
275 break;
276 } else {
277 if (pcmcia_io_alloc(pa->pf, cfe->iospace[0].start,
278 cfe->iospace[0].length, cfe->iospace[0].length,
279 &psc->sc_pcioh) == 0)
280 break;
281 }
282 }
283 if (!cfe) {
284 aprint_error_dev(self, "failed to allocate I/O space\n");
285 goto ioalloc_failed;
286 }
287
288 sc->sc_iot = psc->sc_pcioh.iot;
289 sc->sc_ioh = psc->sc_pcioh.ioh;
290
291 /* Enable the card. */
292 pcmcia_function_init(pa->pf, cfe);
293
294 if (pcmcia_io_map(pa->pf, ((cfe->flags & PCMCIA_CFE_IO16) ?
295 PCMCIA_WIDTH_AUTO : PCMCIA_WIDTH_IO8), &psc->sc_pcioh,
296 &psc->sc_io_window)) {
297 aprint_error_dev(self, "can't map i/o space\n");
298 goto iomap_failed;
299 }
300
301 error = ep_pcmcia_enable(sc);
302 if (error)
303 goto enable_failed;
304 sc->enabled = 1;
305
306 switch (pa->product) {
307 case PCMCIA_PRODUCT_3COM_3C562:
308 /*
309 * 3c562a-c use this; 3c562d does it in the regular way.
310 * we might want to check the revision and produce a warning
311 * in the future.
312 */
313 /* FALLTHROUGH */
314 case PCMCIA_PRODUCT_3COM_3C574:
315 case PCMCIA_PRODUCT_3COM_3CCFEM556BI:
316 /*
317 * Apparently, some 3c574s do it this way, as well.
318 */
319 if (pcmcia_scan_cis(parent, ep_pcmcia_get_enaddr, myla))
320 enaddr = myla;
321 break;
322 }
323
324 epp = pcmcia_product_lookup(pa, ep_pcmcia_products, ep_pcmcia_nproducts,
325 sizeof(ep_pcmcia_products[0]), NULL);
326 if (!epp)
327 panic("ep_pcmcia_attach: impossible");
328
329 sc->bustype = ELINK_BUS_PCMCIA;
330 sc->ep_flags = epp->epp_flags;
331
332 sc->enable = ep_pcmcia_enable;
333 sc->disable = ep_pcmcia_disable;
334
335 if (epconfig(sc, epp->epp_chipset, enaddr))
336 aprint_error_dev(self, "couldn't configure controller\n");
337
338 psc->sc_powerhook = powerhook_establish(device_xname(self), ep_power, sc);
339 if (psc->sc_powerhook == NULL)
340 aprint_error_dev(self, "WARNING: unable to establish power hook\n");
341
342 sc->enabled = 0;
343 ep_pcmcia_disable(sc);
344 return;
345
346 enable_failed:
347 pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
348 iomap_failed:
349 pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);
350 ioalloc_failed:
351 psc->sc_io_window = -1;
352 }
353
354 int
355 ep_pcmcia_detach(self, flags)
356 struct device *self;
357 int flags;
358 {
359 struct ep_pcmcia_softc *psc = (struct ep_pcmcia_softc *)self;
360 int rv;
361
362 if (psc->sc_io_window == -1)
363 /* Nothing to detach. */
364 return (0);
365
366 if (psc->sc_powerhook != NULL)
367 powerhook_disestablish(psc->sc_powerhook);
368
369 rv = ep_detach(self, flags);
370 if (rv != 0)
371 return (rv);
372
373 /* Unmap our i/o window. */
374 pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
375
376 /* Free our i/o space. */
377 pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);
378
379 return (0);
380 }
381
382 int
383 ep_pcmcia_get_enaddr(tuple, arg)
384 struct pcmcia_tuple *tuple;
385 void *arg;
386 {
387 u_int8_t *myla = arg;
388 int i;
389
390 /* this is 3c562a-c magic */
391 if (tuple->code == 0x88) {
392 if (tuple->length < ETHER_ADDR_LEN)
393 return (0);
394
395 for (i = 0; i < ETHER_ADDR_LEN; i += 2) {
396 myla[i] = pcmcia_tuple_read_1(tuple, i + 1);
397 myla[i + 1] = pcmcia_tuple_read_1(tuple, i);
398 }
399
400 return (1);
401 }
402 return (0);
403 }
404