bwn: Import from FreeBSD
[dragonfly.git] / sys / dev / netif / bwn / siba / siba_bwn.c
1 /*-
2  * Copyright (c) 2009-2010 Weongyo Jeong <weongyo@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD: head/sys/dev/siba/siba_bwn.c 257241 2013-10-28 07:29:16Z glebius $");
32
33 /*
34  * Sonics Silicon Backplane front-end for bwn(4).
35  */
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/kernel.h>
42 #include <sys/lock.h>
43 #include <sys/mutex.h>
44 #include <sys/errno.h>
45 #include <machine/bus.h>
46 #include <machine/resource.h>
47 #include <sys/bus.h>
48 #include <sys/rman.h>
49 #include <sys/socket.h>
50
51 #include <net/if.h>
52 #include <net/if_media.h>
53 #include <net/if_arp.h>
54
55 #include <dev/pci/pcivar.h>
56 #include <dev/pci/pcireg.h>
57
58 #include <dev/siba/siba_ids.h>
59 #include <dev/siba/sibareg.h>
60 #include <dev/siba/sibavar.h>
61
62 /*
63  * PCI glue.
64  */
65
66 struct siba_bwn_softc {
67         /* Child driver using MSI. */
68         device_t                        ssc_msi_child;
69         struct siba_softc               ssc_siba;
70 };
71
72 #define BS_BAR                          0x10
73 #define PCI_VENDOR_BROADCOM             0x14e4
74 #define N(a)                            (sizeof(a) / sizeof(a[0]))
75
76 static const struct siba_dev {
77         uint16_t        vid;
78         uint16_t        did;
79         const char      *desc;
80 } siba_devices[] = {
81         { PCI_VENDOR_BROADCOM, 0x4301, "Broadcom BCM4301 802.11b Wireless" },
82         { PCI_VENDOR_BROADCOM, 0x4306, "Unknown" },
83         { PCI_VENDOR_BROADCOM, 0x4307, "Broadcom BCM4307 802.11b Wireless" },
84         { PCI_VENDOR_BROADCOM, 0x4311, "Broadcom BCM4311 802.11b/g Wireless" },
85         { PCI_VENDOR_BROADCOM, 0x4312,
86           "Broadcom BCM4312 802.11a/b/g Wireless" },
87         { PCI_VENDOR_BROADCOM, 0x4315, "Broadcom BCM4312 802.11b/g Wireless" },
88         { PCI_VENDOR_BROADCOM, 0x4318, "Broadcom BCM4318 802.11b/g Wireless" },
89         { PCI_VENDOR_BROADCOM, 0x4319,
90           "Broadcom BCM4318 802.11a/b/g Wireless" },
91         { PCI_VENDOR_BROADCOM, 0x4320, "Broadcom BCM4306 802.11b/g Wireless" },
92         { PCI_VENDOR_BROADCOM, 0x4321, "Broadcom BCM4306 802.11a Wireless" },
93         { PCI_VENDOR_BROADCOM, 0x4324,
94           "Broadcom BCM4309 802.11a/b/g Wireless" },
95         { PCI_VENDOR_BROADCOM, 0x4325, "Broadcom BCM4306 802.11b/g Wireless" },
96         { PCI_VENDOR_BROADCOM, 0x4328, "Unknown" },
97         { PCI_VENDOR_BROADCOM, 0x4329, "Unknown" },
98         { PCI_VENDOR_BROADCOM, 0x432b, "Unknown" }
99 };
100
101 int             siba_core_attach(struct siba_softc *);
102 int             siba_core_detach(struct siba_softc *);
103 int             siba_core_suspend(struct siba_softc *);
104 int             siba_core_resume(struct siba_softc *);
105
106 static int
107 siba_bwn_probe(device_t dev)
108 {
109         int i;
110         uint16_t did, vid;
111
112         did = pci_get_device(dev);
113         vid = pci_get_vendor(dev);
114
115         for (i = 0; i < N(siba_devices); i++) {
116                 if (siba_devices[i].did == did && siba_devices[i].vid == vid) {
117                         device_set_desc(dev, siba_devices[i].desc);
118                         return (BUS_PROBE_DEFAULT);
119                 }
120         }
121         return (ENXIO);
122 }
123
124 static int
125 siba_bwn_attach(device_t dev)
126 {
127         struct siba_bwn_softc *ssc = device_get_softc(dev);
128         struct siba_softc *siba = &ssc->ssc_siba;
129
130         siba->siba_dev = dev;
131         siba->siba_type = SIBA_TYPE_PCI;
132
133         /*
134          * Enable bus mastering.
135          */
136         pci_enable_busmaster(dev);
137
138         /* 
139          * Setup memory-mapping of PCI registers.
140          */
141         siba->siba_mem_rid = SIBA_PCIR_BAR;
142         siba->siba_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
143                 &siba->siba_mem_rid, RF_ACTIVE);
144         if (siba->siba_mem_res == NULL) {
145                 device_printf(dev, "cannot map register space\n");
146                 return (ENXIO);
147         }
148         siba->siba_mem_bt = rman_get_bustag(siba->siba_mem_res);
149         siba->siba_mem_bh = rman_get_bushandle(siba->siba_mem_res);
150
151         /* Get more PCI information */
152         siba->siba_pci_did = pci_get_device(dev);
153         siba->siba_pci_vid = pci_get_vendor(dev);
154         siba->siba_pci_subvid = pci_get_subvendor(dev);
155         siba->siba_pci_subdid = pci_get_subdevice(dev);
156         siba->siba_pci_revid = pci_get_revid(dev);
157
158         return (siba_core_attach(siba));
159 }
160
161 static int
162 siba_bwn_detach(device_t dev)
163 {
164         struct siba_bwn_softc *ssc = device_get_softc(dev);
165         struct siba_softc *siba = &ssc->ssc_siba;
166
167         /* check if device was removed */
168         siba->siba_invalid = !bus_child_present(dev);
169
170         pci_disable_busmaster(dev);
171         bus_generic_detach(dev);
172         siba_core_detach(siba);
173
174         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR, siba->siba_mem_res);
175
176         return (0);
177 }
178
179 static int
180 siba_bwn_shutdown(device_t dev)
181 {
182         device_t *devlistp;
183         int devcnt, error = 0, i;
184
185         error = device_get_children(dev, &devlistp, &devcnt);
186         if (error != 0)
187                 return (error);
188
189         for (i = 0 ; i < devcnt ; i++)
190                 device_shutdown(devlistp[i]);
191         free(devlistp, M_TEMP);
192         return (0);
193 }
194
195 static int
196 siba_bwn_suspend(device_t dev)
197 {
198         struct siba_bwn_softc *ssc = device_get_softc(dev);
199         struct siba_softc *siba = &ssc->ssc_siba;
200         device_t *devlistp;
201         int devcnt, error = 0, i, j;
202
203         error = device_get_children(dev, &devlistp, &devcnt);
204         if (error != 0)
205                 return (error);
206
207         for (i = 0 ; i < devcnt ; i++) {
208                 error = DEVICE_SUSPEND(devlistp[i]);
209                 if (error) {
210                         for (j = 0; j < i; j++)
211                                 DEVICE_RESUME(devlistp[j]);
212                         free(devlistp, M_TEMP);
213                         return (error);
214                 }
215         }
216         free(devlistp, M_TEMP);
217         return (siba_core_suspend(siba));
218 }
219
220 static int
221 siba_bwn_resume(device_t dev)
222 {
223         struct siba_bwn_softc *ssc = device_get_softc(dev);
224         struct siba_softc *siba = &ssc->ssc_siba;
225         device_t *devlistp;
226         int devcnt, error = 0, i;
227
228         error = siba_core_resume(siba);
229         if (error != 0)
230                 return (error);
231
232         error = device_get_children(dev, &devlistp, &devcnt);
233         if (error != 0)
234                 return (error);
235
236         for (i = 0 ; i < devcnt ; i++)
237                 DEVICE_RESUME(devlistp[i]);
238         free(devlistp, M_TEMP);
239         return (0);
240 }
241
242 /* proxying to the parent */
243 static struct resource *
244 siba_bwn_alloc_resource(device_t dev, device_t child, int type, int *rid,
245     u_long start, u_long end, u_long count, u_int flags)
246 {
247
248         return (BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
249             type, rid, start, end, count, flags));
250 }
251
252 /* proxying to the parent */
253 static int
254 siba_bwn_release_resource(device_t dev, device_t child, int type,
255     int rid, struct resource *r)
256 {
257
258         return (BUS_RELEASE_RESOURCE(device_get_parent(dev), dev, type,
259             rid, r));
260 }
261
262 /* proxying to the parent */
263 static int
264 siba_bwn_setup_intr(device_t dev, device_t child, struct resource *irq,
265     int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
266     void **cookiep)
267 {
268
269         return (BUS_SETUP_INTR(device_get_parent(dev), dev, irq, flags,
270             filter, intr, arg, cookiep));
271 }
272
273 /* proxying to the parent */
274 static int
275 siba_bwn_teardown_intr(device_t dev, device_t child, struct resource *irq,
276     void *cookie)
277 {
278
279         return (BUS_TEARDOWN_INTR(device_get_parent(dev), dev, irq, cookie));
280 }
281
282 static int
283 siba_bwn_find_cap(device_t dev, device_t child, int capability,
284     int *capreg)
285 {
286
287         return (pci_find_cap(dev, capability, capreg));
288 }
289
290 static int
291 siba_bwn_find_extcap(device_t dev, device_t child, int capability,
292     int *capreg)
293 {
294
295         return (pci_find_extcap(dev, capability, capreg));
296 }
297
298 static int
299 siba_bwn_find_htcap(device_t dev, device_t child, int capability,
300     int *capreg)
301 {
302
303         return (pci_find_htcap(dev, capability, capreg));
304 }
305
306 static int
307 siba_bwn_alloc_msi(device_t dev, device_t child, int *count)
308 {
309         struct siba_bwn_softc *ssc;
310         int error;
311
312         ssc = device_get_softc(dev);
313         if (ssc->ssc_msi_child != NULL)
314                 return (EBUSY);
315         error = pci_alloc_msi(dev, count);
316         if (error == 0)
317                 ssc->ssc_msi_child = child;
318         return (error);
319 }
320
321 static int
322 siba_bwn_release_msi(device_t dev, device_t child)
323 {
324         struct siba_bwn_softc *ssc;
325         int error;
326
327         ssc = device_get_softc(dev);
328         if (ssc->ssc_msi_child != child)
329                 return (ENXIO);
330         error = pci_release_msi(dev);
331         if (error == 0)
332                 ssc->ssc_msi_child = NULL;
333         return (error);
334 }
335
336 static int
337 siba_bwn_msi_count(device_t dev, device_t child)
338 {
339
340         return (pci_msi_count(dev));
341 }
342
343 static int
344 siba_bwn_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
345 {
346         struct siba_dev_softc *sd;
347         struct siba_softc *siba;
348
349         sd = device_get_ivars(child);
350         siba = sd->sd_bus;
351
352         switch (which) {
353         case SIBA_IVAR_VENDOR:
354                 *result = sd->sd_id.sd_vendor;
355                 break;
356         case SIBA_IVAR_DEVICE:
357                 *result = sd->sd_id.sd_device;
358                 break;
359         case SIBA_IVAR_REVID:
360                 *result = sd->sd_id.sd_rev;
361                 break;
362         case SIBA_IVAR_PCI_VENDOR:
363                 *result = siba->siba_pci_vid;
364                 break;
365         case SIBA_IVAR_PCI_DEVICE:
366                 *result = siba->siba_pci_did;
367                 break;
368         case SIBA_IVAR_PCI_SUBVENDOR:
369                 *result = siba->siba_pci_subvid;
370                 break;
371         case SIBA_IVAR_PCI_SUBDEVICE:
372                 *result = siba->siba_pci_subdid;
373                 break;
374         case SIBA_IVAR_PCI_REVID:
375                 *result = siba->siba_pci_revid;
376                 break;
377         case SIBA_IVAR_CHIPID:
378                 *result = siba->siba_chipid;
379                 break;
380         case SIBA_IVAR_CHIPREV:
381                 *result = siba->siba_chiprev;
382                 break;
383         case SIBA_IVAR_CHIPPKG:
384                 *result = siba->siba_chippkg;
385                 break;
386         case SIBA_IVAR_TYPE:
387                 *result = siba->siba_type;
388                 break;
389         case SIBA_IVAR_CC_PMUFREQ:
390                 *result = siba->siba_cc.scc_pmu.freq;
391                 break;
392         case SIBA_IVAR_CC_CAPS:
393                 *result = siba->siba_cc.scc_caps;
394                 break;
395         case SIBA_IVAR_CC_POWERDELAY:
396                 *result = siba->siba_cc.scc_powerup_delay;
397                 break;
398         case SIBA_IVAR_PCICORE_REVID:
399                 *result = siba->siba_pci.spc_dev->sd_id.sd_rev;
400                 break;
401         default:
402                 return (ENOENT);
403         }
404
405         return (0);
406 }
407
408 static device_method_t siba_bwn_methods[] = {
409         /* Device interface */
410         DEVMETHOD(device_probe,         siba_bwn_probe),
411         DEVMETHOD(device_attach,        siba_bwn_attach),
412         DEVMETHOD(device_detach,        siba_bwn_detach),
413         DEVMETHOD(device_shutdown,      siba_bwn_shutdown),
414         DEVMETHOD(device_suspend,       siba_bwn_suspend),
415         DEVMETHOD(device_resume,        siba_bwn_resume),
416
417         /* Bus interface */
418         DEVMETHOD(bus_alloc_resource,   siba_bwn_alloc_resource),
419         DEVMETHOD(bus_release_resource, siba_bwn_release_resource),
420         DEVMETHOD(bus_read_ivar,        siba_bwn_read_ivar),
421         DEVMETHOD(bus_setup_intr,       siba_bwn_setup_intr),
422         DEVMETHOD(bus_teardown_intr,    siba_bwn_teardown_intr),
423
424         /* PCI interface */
425         DEVMETHOD(pci_find_cap,         siba_bwn_find_cap),
426         DEVMETHOD(pci_find_extcap,      siba_bwn_find_extcap),
427         DEVMETHOD(pci_find_htcap,       siba_bwn_find_htcap),
428         DEVMETHOD(pci_alloc_msi,        siba_bwn_alloc_msi),
429         DEVMETHOD(pci_release_msi,      siba_bwn_release_msi),
430         DEVMETHOD(pci_msi_count,        siba_bwn_msi_count),
431
432         DEVMETHOD_END
433 };
434 static driver_t siba_bwn_driver = {
435         "siba_bwn",
436         siba_bwn_methods,
437         sizeof(struct siba_bwn_softc)
438 };
439 static devclass_t siba_bwn_devclass;
440 DRIVER_MODULE(siba_bwn, pci, siba_bwn_driver, siba_bwn_devclass, 0, 0);
441 MODULE_VERSION(siba_bwn, 1);