Update cardbus/pccard support.
[dragonfly.git] / sys / dev / netif / fe / if_fe_pccard.c
1 /*
2  * All Rights Reserved, Copyright (C) Fujitsu Limited 1995
3  *
4  * This software may be used, modified, copied, distributed, and sold, in
5  * both source and binary form provided that the above copyright, these
6  * terms and the following disclaimer are retained.  The name of the author
7  * and/or the contributor may not be used to endorse or promote products
8  * derived from this software without specific prior written permission.
9  *
10  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
11  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
12  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
13  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
14  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
15  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
16  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION.
17  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
18  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
19  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
20  * SUCH DAMAGE.
21  *
22  * $FreeBSD: src/sys/dev/fe/if_fe_pccard.c,v 1.2.2.1 2000/09/22 10:01:47 nyan Exp $
23  * $DragonFly: src/sys/dev/netif/fe/if_fe_pccard.c,v 1.13 2007/07/05 12:08:53 sephe Exp $
24  */
25
26 #include "opt_fe.h"
27 #include "opt_inet.h"
28 #include "opt_ipx.h"
29
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/socket.h>
33 #include <sys/module.h>
34 #include <sys/bus.h>
35 #include <machine/clock.h>
36
37 #include <net/ethernet.h>
38 #include <net/if.h>
39 #include <net/if_mib.h>
40 #include <net/if_media.h>
41
42 #include <netinet/in.h>
43 #include <netinet/if_ether.h>
44
45 #include <machine_base/isa/ic/mb86960.h>
46 #include "if_fereg.h"
47 #include "if_fevar.h"
48
49 #include <bus/pccard/pccardvar.h>
50 #include <bus/pccard/pccarddevs.h>
51
52 #include "card_if.h"
53
54 /*
55  *      PC-Card (PCMCIA) specific code.
56  */
57 static int fe_pccard_probe(device_t);
58 static int fe_pccard_attach(device_t);
59 static int fe_pccard_detach(device_t);
60 static int fe_pccard_match(device_t);
61
62 static const struct fe_pccard_product {
63         struct pccard_product mpp_product;
64         u_int32_t mpp_ioalign;                  /* required alignment */
65         int mpp_enet_maddr;
66 } fe_pccard_products[] = {
67         { PCMCIA_CARD(TDK, LAK_CD021BX, 0), 0, -1 }, 
68         { PCMCIA_CARD(TDK, LAK_CF010, 0), 0, -1 }, 
69 #if 0 /* XXX 86960-based? */
70         { PCMCIA_CARD(TDK, LAK_DFL9610, 1), 0, -1 }, 
71 #endif
72         { PCMCIA_CARD(CONTEC, CNETPC, 0), 0, -1 },
73         { PCMCIA_CARD(FUJITSU, LA501, 0), 0x20, -1 },
74         { PCMCIA_CARD(FUJITSU, LA10S, 0), 0, -1 },
75         { PCMCIA_CARD(RATOC, REX_R280, 0), 0, 0x1fc },
76         { { NULL } }
77 };
78
79 static int
80 fe_pccard_match(device_t dev)
81 {
82         const struct pccard_product *pp;
83
84         if ((pp = pccard_product_lookup(dev,
85             (const struct pccard_product *)fe_pccard_products,
86             sizeof(fe_pccard_products[0]), NULL)) != NULL) {
87                 if (pp->pp_name != NULL)
88                         device_set_desc(dev, pp->pp_name);
89                 return 0;
90         }
91         return ENXIO;
92 }
93
94 static device_method_t fe_pccard_methods[] = {
95         /* Device interface */
96         DEVMETHOD(device_probe,         pccard_compat_probe),
97         DEVMETHOD(device_attach,        pccard_compat_attach),
98         DEVMETHOD(device_detach,        fe_pccard_detach),
99
100         /* Card interface */
101         DEVMETHOD(card_compat_match,    fe_pccard_match),
102         DEVMETHOD(card_compat_probe,    fe_pccard_probe),
103         DEVMETHOD(card_compat_attach,   fe_pccard_attach),
104
105         { 0, 0 }
106 };
107
108 static driver_t fe_pccard_driver = {
109         "fe",
110         fe_pccard_methods,
111         sizeof (struct fe_softc)
112 };
113
114 DRIVER_MODULE(if_fe, pccard, fe_pccard_driver, fe_devclass, 0, 0);
115
116
117 static int fe_probe_mbh(device_t);
118 static int fe_probe_tdk(device_t);
119
120 /*
121  *      Initialize the device - called from Slot manager.
122  */
123 static int
124 fe_pccard_probe(device_t dev)
125 {
126         struct fe_softc *sc;
127         int i, error;
128         uint8_t sum;
129         uint8_t *ether_addr;
130
131         /* Prepare for the device probe process.  */
132         sc = device_get_softc(dev);
133         sc->sc_unit = device_get_unit(dev);
134
135         ether_addr = pccard_get_ether(dev);
136         for (i = 0, sum = 0; i < ETHER_ADDR_LEN; i++)
137                 sum |= ether_addr[i];
138         if (sum)
139                 bcopy(ether_addr, sc->sc_enaddr, ETHER_ADDR_LEN);
140
141         /* Probe for supported cards.  */
142         if ((error = fe_probe_mbh(dev)) == 0)
143                 goto end;
144         fe_release_resource(dev);
145
146         if ((error = fe_probe_tdk(dev)) == 0)
147                 goto end;
148         fe_release_resource(dev);
149
150 end:
151         if (error == 0)
152                 error = fe_alloc_irq(dev, 0);
153
154         fe_release_resource(dev);
155         return (error);
156 }
157
158 static int
159 fe_pccard_attach(device_t dev)
160 {
161         struct fe_softc *sc = device_get_softc(dev);
162
163         if (sc->port_used)
164                 fe_alloc_port(dev, sc->port_used);
165         fe_alloc_irq(dev, 0);
166
167         return fe_attach(dev);
168 }
169
170 /*
171  *      feunload - unload the driver and clear the table.
172  *      XXX TODO:
173  *      This is usually called when the card is ejected, but
174  *      can be caused by a modunload of a controller driver.
175  *      The idea is to reset the driver's view of the device
176  *      and ensure that any driver entry points such as
177  *      read and write do not hang.
178  */
179 static int
180 fe_pccard_detach(device_t dev)
181 {
182         struct fe_softc *sc = device_get_softc(dev);
183         struct ifnet *ifp = &sc->arpcom.ac_if;
184
185         lwkt_serialize_enter(ifp->if_serializer);
186         fe_stop(sc);
187         bus_teardown_intr(dev, sc->irq_res, sc->irq_handle);
188         lwkt_serialize_exit(ifp->if_serializer);
189
190         ether_ifdetach(ifp);
191         fe_release_resource(dev);
192
193         return 0;
194 }
195
196
197 /*
198  * Probe and initialization for Fujitsu MBH10302 PCMCIA Ethernet interface.
199  * Note that this is for 10302 only; MBH10304 is handled by fe_probe_tdk().
200  */
201 static void
202 fe_init_mbh(struct fe_softc *sc)
203 {
204         /* Minimal initialization of 86960.  */
205         DELAY(200);
206         fe_outb(sc, FE_DLCR6, sc->proto_dlcr6 | FE_D6_DLC_DISABLE);
207         DELAY(200);
208
209         /* Disable all interrupts.  */
210         fe_outb(sc, FE_DLCR2, 0);
211         fe_outb(sc, FE_DLCR3, 0);
212
213         /* Enable master interrupt flag.  */
214         fe_outb(sc, FE_MBH0, FE_MBH0_MAGIC | FE_MBH0_INTR_ENABLE);
215 }
216
217 static int
218 fe_probe_mbh(device_t dev)
219 {
220         struct fe_softc *sc = device_get_softc(dev);
221
222         static struct fe_simple_probe_struct probe_table [] = {
223                 { FE_DLCR2, 0x58, 0x00 },
224                 { FE_DLCR4, 0x08, 0x00 },
225                 { FE_DLCR6, 0xFF, 0xB6 },
226                 { 0 }
227         };
228
229         /* MBH10302 occupies 32 I/O addresses. */
230         if (fe_alloc_port(dev, 32))
231                 return ENXIO;
232
233         /* Ethernet MAC address should *NOT* have been given by pccardd,
234            if this is a true MBH10302; i.e., Ethernet address must be
235            "all-zero" upon entry.  */
236         if (sc->sc_enaddr[0] || sc->sc_enaddr[1] || sc->sc_enaddr[2] ||
237             sc->sc_enaddr[3] || sc->sc_enaddr[4] || sc->sc_enaddr[5])
238                 return ENXIO;
239
240         /* Fill the softc struct with default values.  */
241         fe_softc_defaults(sc);
242
243         /*
244          * See if MBH10302 is on its address.
245          * I'm not sure the following probe code works.  FIXME.
246          */
247         if (!fe_simple_probe(sc, probe_table))
248                 return ENXIO;
249
250         /* Get our station address from EEPROM.  */
251         fe_inblk(sc, FE_MBH10, sc->sc_enaddr, ETHER_ADDR_LEN);
252
253         /* Make sure we got a valid station address.  */
254         if (!valid_Ether_p(sc->sc_enaddr, 0))
255                 return ENXIO;
256
257         /* Determine the card type.  */
258         sc->type = FE_TYPE_MBH;
259         sc->typestr = "MBH10302 (PCMCIA)";
260
261         /* We seems to need our own IDENT bits...  FIXME.  */
262         sc->proto_dlcr7 = FE_D7_BYTSWP_LH | FE_D7_IDENT_NICE;
263
264         /* Setup hooks.  We need a special initialization procedure.  */
265         sc->init = fe_init_mbh;
266
267         return 0;
268 }
269
270 /*
271  * Probe and initialization for TDK/CONTEC PCMCIA Ethernet interface.
272  * by MASUI Kenji <masui@cs.titech.ac.jp>
273  *
274  * (Contec uses TDK Ethenet chip -- hosokawa)
275  *
276  * This version of fe_probe_tdk has been rewrote to handle
277  * *generic* PC card implementation of Fujitsu MB8696x family.  The
278  * name _tdk is just for a historical reason. :-)
279  */
280 static int
281 fe_probe_tdk (device_t dev)
282 {
283         struct fe_softc *sc = device_get_softc(dev);
284
285         static struct fe_simple_probe_struct probe_table [] = {
286                 { FE_DLCR2, 0x50, 0x00 },
287                 { FE_DLCR4, 0x08, 0x00 },
288             /*  { FE_DLCR5, 0x80, 0x00 },       Does not work well.  */
289                 { 0 }
290         };
291
292         /* C-NET(PC)C occupies 16 I/O addresses. */
293         if (fe_alloc_port(dev, 16))
294                 return ENXIO;
295
296         /* Fill the softc struct with default values.  */
297         fe_softc_defaults(sc);
298
299         /*
300          * See if C-NET(PC)C is on its address.
301          */
302         if (!fe_simple_probe(sc, probe_table))
303                 return ENXIO;
304
305         /* Determine the card type.  */
306         sc->type = FE_TYPE_TDK;
307         sc->typestr = "Generic MB8696x/78Q837x Ethernet (PCMCIA)";
308
309         /* Make sure we got a valid station address.  */
310         if (!valid_Ether_p(sc->sc_enaddr, 0))
311                 return ENXIO;
312
313         return 0;
314 }