kernel: Use DEVMETHOD_END in the drivers.
[dragonfly.git] / sys / dev / netif / ndis / if_ndis_u4b.c
1 /*-
2  * Copyright (c) 2005
3  *      Bill Paul <wpaul@windriver.com>.  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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by Bill Paul.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $FreeBSD: src/sys/dev/if_ndis/if_ndis_usb.c,v 1.26 2012/11/17 01:51:54 svnexp Exp $
33  */
34
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/sockio.h>
38 #include <sys/module.h>
39 #include <sys/malloc.h>
40 #include <sys/kernel.h>
41 #include <sys/socket.h>
42 #include <sys/sysctl.h>
43
44 #include <net/if.h>
45 #include <net/if_arp.h>
46 #include <net/ethernet.h>
47 #include <net/if_dl.h>
48 #include <net/if_media.h>
49
50 #include <net/bpf.h>
51
52 #include <sys/bus.h>
53 #include <bus/u4b/usb.h>
54 #include <bus/u4b/usbdi.h>
55
56 #include <netproto/802_11/ieee80211_var.h>
57
58 #include <emulation/ndis/pe_var.h>
59 #include <emulation/ndis/cfg_var.h>
60 #include <emulation/ndis/resource_var.h>
61 #include <emulation/ndis/ntoskrnl_var.h>
62 #include <emulation/ndis/ndis_var.h>
63 #include <emulation/ndis/u4bd_var.h>
64 #include <dev/netif/ndis/if_ndisvar.h>
65
66 SYSCTL_NODE(_hw, OID_AUTO, ndisusb, CTLFLAG_RD, 0, "NDIS USB driver parameters");
67
68 MODULE_DEPEND(ndis, usb, 1, 1, 1);
69
70 static device_probe_t ndisusb_match;
71 static device_attach_t ndisusb_attach;
72 static device_detach_t ndisusb_detach;
73 static bus_get_resource_list_t ndis_get_resource_list;
74
75 extern int ndisdrv_modevent     (module_t, int, void *);
76 extern int ndis_attach          (device_t);
77 extern int ndis_shutdown        (device_t);
78 extern int ndis_detach          (device_t);
79 extern int ndis_suspend         (device_t);
80 extern int ndis_resume          (device_t);
81
82 extern unsigned char drv_data[];
83
84 static device_method_t ndis_methods[] = {
85         /* Device interface */
86         DEVMETHOD(device_probe,         ndisusb_match),
87         DEVMETHOD(device_attach,        ndisusb_attach),
88         DEVMETHOD(device_detach,        ndisusb_detach),
89         DEVMETHOD(device_shutdown,      ndis_shutdown),
90
91         /* bus interface */
92         DEVMETHOD(bus_get_resource_list, ndis_get_resource_list),
93
94         DEVMETHOD_END
95 };
96
97 static driver_t ndis_driver = {
98         "ndis",
99         ndis_methods,
100         sizeof(struct ndis_softc)
101 };
102
103 static devclass_t ndis_devclass;
104
105 DRIVER_MODULE(ndis, uhub, ndis_driver, ndis_devclass, ndisdrv_modevent, 0);
106
107 static int
108 ndisusb_devcompare(interface_type bustype, struct ndis_usb_type *t, device_t dev)
109 {
110         struct usb_attach_arg *uaa;
111
112         if (bustype != PNPBus)
113                 return (FALSE);
114
115         uaa = device_get_ivars(dev);
116
117         while (t->ndis_name != NULL) {
118                 if ((uaa->info.idVendor == t->ndis_vid) &&
119                     (uaa->info.idProduct == t->ndis_did)) {
120                         device_set_desc(dev, t->ndis_name);
121                         return (TRUE);
122                 }
123                 t++;
124         }
125
126         return (FALSE);
127 }
128
129 static int
130 ndisusb_match(device_t self)
131 {
132         struct drvdb_ent *db;
133         struct usb_attach_arg *uaa = device_get_ivars(self);
134
135         if (uaa->usb_mode != USB_MODE_HOST)
136                 return (ENXIO);
137         if (uaa->info.bConfigIndex != NDISUSB_CONFIG_NO)
138                 return (ENXIO);
139         if (uaa->info.bIfaceIndex != NDISUSB_IFACE_INDEX)
140                 return (ENXIO);
141
142         if (windrv_lookup(0, "USB Bus") == NULL)
143                 return (ENXIO);
144
145         db = windrv_match((matchfuncptr)ndisusb_devcompare, self);
146         if (db == NULL)
147                 return (ENXIO);
148         uaa->driver_ivar = db;
149
150         return (0);
151 }
152
153 static int
154 ndisusb_attach(device_t self)
155 {
156         const struct drvdb_ent  *db;
157         struct ndisusb_softc *dummy = device_get_softc(self);
158         struct usb_attach_arg *uaa = device_get_ivars(self);
159         struct ndis_softc       *sc;
160         struct ndis_usb_type    *t;
161         driver_object           *drv;
162         int                     devidx = 0;
163
164         device_set_usb_desc(self);
165         db = uaa->driver_ivar;
166         sc = (struct ndis_softc *)dummy;
167         sc->ndis_dev = self;
168         lockinit(&sc->ndisusb_lock, "NDIS USB", 0, LK_CANRECURSE);
169         sc->ndis_dobj = db->windrv_object;
170         sc->ndis_regvals = db->windrv_regvals;
171         sc->ndis_iftype = PNPBus;
172         sc->ndisusb_dev = uaa->device;
173
174         /* Create PDO for this device instance */
175
176         drv = windrv_lookup(0, "USB Bus");
177         windrv_create_pdo(drv, self);
178
179         /* Figure out exactly which device we matched. */
180
181         t = db->windrv_devlist;
182
183         while (t->ndis_name != NULL) {
184                 if ((uaa->info.idVendor == t->ndis_vid) &&
185                     (uaa->info.idProduct == t->ndis_did)) {
186                         sc->ndis_devidx = devidx;
187                         break;
188                 }
189                 t++;
190                 devidx++;
191         }
192
193         if (ndis_attach(self) != 0)
194                 return (ENXIO);
195
196         return (0);
197 }
198
199 static int
200 ndisusb_detach(device_t self)
201 {
202         int i;
203         struct ndis_softc       *sc = device_get_softc(self);
204         struct ndisusb_ep       *ne;
205
206         sc->ndisusb_status |= NDISUSB_STATUS_DETACH;
207
208         ndis_pnpevent_nic(self, NDIS_PNP_EVENT_SURPRISE_REMOVED);
209
210         if (sc->ndisusb_status & NDISUSB_STATUS_SETUP_EP) {
211                 usbd_transfer_unsetup(sc->ndisusb_dread_ep.ne_xfer, 1);
212                 usbd_transfer_unsetup(sc->ndisusb_dwrite_ep.ne_xfer, 1);
213         }
214         for (i = 0; i < NDISUSB_ENDPT_MAX; i++) {
215                 ne = &sc->ndisusb_ep[i];
216                 usbd_transfer_unsetup(ne->ne_xfer, 1);
217         }
218
219         (void)ndis_detach(self);
220
221         lockuninit(&sc->ndisusb_lock);
222         return (0);
223 }
224
225 static struct resource_list *
226 ndis_get_resource_list(device_t dev, device_t child)
227 {
228         struct ndis_softc       *sc;
229
230         sc = device_get_softc(dev);
231         return (BUS_GET_RESOURCE_LIST(device_get_parent(sc->ndis_dev), dev));
232 }