5d6a482c08c4fbea35cd8ee0791e6fda7e636308
[dragonfly.git] / sys / dev / netif / ral / if_ral_pci.c
1 /*
2  * Copyright (c) 2005, 2006
3  *      Damien Bergamini <damien.bergamini@free.fr>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  *
17  * $FreeBSD: src/sys/dev/ral/if_ral_pci.c,v 1.4 2006/03/05 23:27:51 silby Exp $
18  * $DragonFly: src/sys/dev/netif/ral/if_ral_pci.c,v 1.4 2007/04/01 13:59:40 sephe Exp $
19  */
20
21 /*
22  * PCI/Cardbus front-end for the Ralink RT2560/RT2561/RT2561S/RT2661 driver.
23  */
24
25 #include <sys/param.h>
26 #include <sys/sysctl.h>
27 #include <sys/sockio.h>
28 #include <sys/mbuf.h>
29 #include <sys/kernel.h>
30 #include <sys/socket.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
33 #include <sys/module.h>
34 #include <sys/bus.h>
35 #include <sys/rman.h>
36 #include <sys/endian.h>
37
38 #include <net/bpf.h>
39 #include <net/if.h>
40 #include <net/if_arp.h>
41 #include <net/ethernet.h>
42 #include <net/if_dl.h>
43 #include <net/if_media.h>
44 #include <net/if_types.h>
45
46 #include <netproto/802_11/ieee80211_var.h>
47 #include <netproto/802_11/ieee80211_radiotap.h>
48
49 #include <bus/pci/pcidevs.h>
50 #include <bus/pci/pcireg.h>
51 #include <bus/pci/pcivar.h>
52
53 #include <dev/netif/ral/if_ralrate.h>
54 #include <dev/netif/ral/rt2560var.h>
55 #include <dev/netif/ral/rt2661var.h>
56
57 struct ral_opns {
58         int     (*attach)(device_t, int);
59         int     (*detach)(void *);
60         void    (*shutdown)(void *);
61         void    (*suspend)(void *);
62         void    (*resume)(void *);
63 };
64
65 static const struct ral_opns ral_rt2560_opns = {
66         .attach         = rt2560_attach,
67         .detach         = rt2560_detach,
68         .shutdown       = rt2560_shutdown,
69         .suspend        = rt2560_suspend,
70         .resume         = rt2560_resume,
71 };
72
73 static const struct ral_opns ral_rt2661_opns = {
74         .attach         = rt2661_attach,
75         .detach         = rt2661_detach,
76         .shutdown       = rt2661_shutdown,
77         .suspend        = rt2661_suspend,
78         .resume         = rt2661_resume,
79 };
80
81 static const struct ral_pci_ident {
82         uint16_t                vendor;
83         uint16_t                device;
84         const char              *name;
85         const struct ral_opns   *opns;
86 } ral_pci_ids[] = {
87         { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2560,
88                 "Ralink Technology RT2560", &ral_rt2560_opns },
89         { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2561S,
90                 "Ralink Technology RT2561S", &ral_rt2661_opns },
91         { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2561,
92                 "Ralink Technology RT2561", &ral_rt2661_opns },
93         { PCI_VENDOR_RALINK, PCI_PRODUCT_RALINK_RT2661,
94                 "Ralink Technology RT2661", &ral_rt2661_opns },
95         { 0, 0, NULL, NULL }
96 };
97
98 struct ral_pci_softc {
99         /* XXX MUST be the first field */
100         union {
101                 struct rt2560_softc sc_rt2560;
102                 struct rt2661_softc sc_rt2661;
103         } u;
104
105         const struct ral_opns   *sc_opns;
106         int                     mem_rid;
107         struct resource         *mem;
108 };
109
110 static int ral_pci_probe(device_t);
111 static int ral_pci_attach(device_t);
112 static int ral_pci_detach(device_t);
113 static int ral_pci_shutdown(device_t);
114 static int ral_pci_suspend(device_t);
115 static int ral_pci_resume(device_t);
116
117 static device_method_t ral_pci_methods[] = {
118         /* Device interface */
119         DEVMETHOD(device_probe,         ral_pci_probe),
120         DEVMETHOD(device_attach,        ral_pci_attach),
121         DEVMETHOD(device_detach,        ral_pci_detach),
122         DEVMETHOD(device_shutdown,      ral_pci_shutdown),
123         DEVMETHOD(device_suspend,       ral_pci_suspend),
124         DEVMETHOD(device_resume,        ral_pci_resume),
125
126         { 0, 0 }
127 };
128
129 static driver_t ral_pci_driver = {
130         "ral",
131         ral_pci_methods,
132         sizeof (struct ral_pci_softc)
133 };
134
135 static devclass_t ral_devclass;
136
137 DRIVER_MODULE(ral, pci, ral_pci_driver, ral_devclass, 0, 0);
138 DRIVER_MODULE(ral, cardbus, ral_pci_driver, ral_devclass, 0, 0);
139
140 MODULE_DEPEND(ral, wlan, 1, 1, 1);
141 MODULE_DEPEND(ral, wlan_ratectl_onoe, 1, 1, 1);
142 MODULE_DEPEND(ral, wlan_ratectl_sample, 1, 1, 1);
143 MODULE_DEPEND(ral, pci, 1, 1, 1);
144 MODULE_DEPEND(ral, cardbus, 1, 1, 1);
145
146 static int
147 ral_pci_probe(device_t dev)
148 {
149         const struct ral_pci_ident *ident;
150         uint16_t vid, did;
151
152         vid = pci_get_vendor(dev);
153         did = pci_get_device(dev);
154         for (ident = ral_pci_ids; ident->name != NULL; ident++) {
155                 if (vid == ident->vendor && did == ident->device) {
156                         struct ral_pci_softc *psc = device_get_softc(dev);
157
158                         psc->sc_opns = ident->opns;
159                         device_set_desc(dev, ident->name);
160                         return 0;
161                 }
162         }
163         return ENXIO;
164 }
165
166 /* Base Address Register */
167 #define RAL_PCI_BAR0    0x10
168
169 static int
170 ral_pci_attach(device_t dev)
171 {
172         struct ral_pci_softc *psc = device_get_softc(dev);
173         struct rt2560_softc *sc = &psc->u.sc_rt2560;
174         int error;
175
176         /* Assign `dev' earlier, so that we can do possible error clean up */
177         sc->sc_dev = dev;
178
179         if (pci_get_powerstate(dev) != PCI_POWERSTATE_D0) {
180                 device_printf(dev, "chip is in D%d power mode "
181                     "-- setting to D0\n", pci_get_powerstate(dev));
182                 pci_set_powerstate(dev, PCI_POWERSTATE_D0);
183         }
184
185         /* enable bus-mastering */
186         pci_enable_busmaster(dev);
187
188         psc->mem_rid = RAL_PCI_BAR0;
189         psc->mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &psc->mem_rid,
190                                           RF_ACTIVE);
191         if (psc->mem == NULL) {
192                 device_printf(dev, "could not allocate memory resource\n");
193                 return ENXIO;
194         }
195         sc->sc_st = rman_get_bustag(psc->mem);
196         sc->sc_sh = rman_get_bushandle(psc->mem);
197
198         error = psc->sc_opns->attach(dev, pci_get_device(dev));
199         if (error != 0)
200                 ral_pci_detach(dev);
201
202         return error;
203 }
204
205 static int
206 ral_pci_detach(device_t dev)
207 {
208         struct ral_pci_softc *psc = device_get_softc(dev);
209
210         if (device_is_attached(dev))
211                 psc->sc_opns->detach(psc);
212
213         bus_generic_detach(dev);
214
215         if (psc->mem != NULL) {
216                 bus_release_resource(dev, SYS_RES_MEMORY, psc->mem_rid,
217                                      psc->mem);
218         }
219         return 0;
220 }
221
222 static int
223 ral_pci_shutdown(device_t dev)
224 {
225         struct ral_pci_softc *psc = device_get_softc(dev);
226
227         psc->sc_opns->shutdown(psc);
228         return 0;
229 }
230
231 static int
232 ral_pci_suspend(device_t dev)
233 {
234         struct ral_pci_softc *psc = device_get_softc(dev);
235
236         psc->sc_opns->suspend(psc);
237         return 0;
238 }
239
240 static int
241 ral_pci_resume(device_t dev)
242 {
243         struct ral_pci_softc *psc = device_get_softc(dev);
244
245         psc->sc_opns->resume(psc);
246         return 0;
247 }