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 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD: stable/10/sys/dev/if_ndis/if_ndis_usb.c 227843 2011-11-22 21:28:20Z marius $");
35 
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/sockio.h>
39 #include <sys/module.h>
40 #include <sys/malloc.h>
41 #include <sys/kernel.h>
42 #include <sys/socket.h>
43 #include <sys/sysctl.h>
44 
45 #include <net/if.h>
46 #include <net/if_arp.h>
47 #include <net/ethernet.h>
48 #include <net/if_dl.h>
49 #include <net/if_media.h>
50 
51 #include <net/bpf.h>
52 
53 #include <sys/bus.h>
54 #include <machine/bus.h>
55 #include <dev/usb/usb.h>
56 #include <dev/usb/usbdi.h>
57 
58 #include <net80211/ieee80211_var.h>
59 
60 #include <compat/ndis/pe_var.h>
61 #include <compat/ndis/cfg_var.h>
62 #include <compat/ndis/resource_var.h>
63 #include <compat/ndis/ntoskrnl_var.h>
64 #include <compat/ndis/ndis_var.h>
65 #include <compat/ndis/usbd_var.h>
66 #include <dev/if_ndis/if_ndisvar.h>
67 
68 SYSCTL_NODE(_hw, OID_AUTO, ndisusb, CTLFLAG_RD, 0, "NDIS USB driver parameters");
69 
70 MODULE_DEPEND(ndis, usb, 1, 1, 1);
71 
72 static device_probe_t ndisusb_match;
73 static device_attach_t ndisusb_attach;
74 static device_detach_t ndisusb_detach;
75 static bus_get_resource_list_t ndis_get_resource_list;
76 
77 extern int ndisdrv_modevent     (module_t, int, void *);
78 extern int ndis_attach          (device_t);
79 extern int ndis_shutdown        (device_t);
80 extern int ndis_detach          (device_t);
81 extern int ndis_suspend         (device_t);
82 extern int ndis_resume          (device_t);
83 
84 extern unsigned char drv_data[];
85 
86 static device_method_t ndis_methods[] = {
87         /* Device interface */
88 	DEVMETHOD(device_probe,		ndisusb_match),
89 	DEVMETHOD(device_attach,	ndisusb_attach),
90 	DEVMETHOD(device_detach,	ndisusb_detach),
91 	DEVMETHOD(device_shutdown,	ndis_shutdown),
92 
93         /* bus interface */
94 	DEVMETHOD(bus_get_resource_list, ndis_get_resource_list),
95 
96 	DEVMETHOD_END
97 };
98 
99 static driver_t ndis_driver = {
100 	"ndis",
101 	ndis_methods,
102 	sizeof(struct ndis_softc)
103 };
104 
105 static devclass_t ndis_devclass;
106 
107 DRIVER_MODULE(ndis, uhub, ndis_driver, ndis_devclass, ndisdrv_modevent, 0);
108 
109 static int
ndisusb_devcompare(interface_type bustype,struct ndis_usb_type * t,device_t dev)110 ndisusb_devcompare(interface_type bustype, struct ndis_usb_type *t, device_t dev)
111 {
112 	struct usb_attach_arg *uaa;
113 
114 	if (bustype != PNPBus)
115 		return (FALSE);
116 
117 	uaa = device_get_ivars(dev);
118 
119 	while (t->ndis_name != NULL) {
120 		if ((uaa->info.idVendor == t->ndis_vid) &&
121 		    (uaa->info.idProduct == t->ndis_did)) {
122 			device_set_desc(dev, t->ndis_name);
123 			return (TRUE);
124 		}
125 		t++;
126 	}
127 
128 	return (FALSE);
129 }
130 
131 static int
ndisusb_match(device_t self)132 ndisusb_match(device_t self)
133 {
134 	struct drvdb_ent *db;
135 	struct usb_attach_arg *uaa = device_get_ivars(self);
136 
137 	if (uaa->usb_mode != USB_MODE_HOST)
138 		return (ENXIO);
139 	if (uaa->info.bConfigIndex != NDISUSB_CONFIG_NO)
140 		return (ENXIO);
141 	if (uaa->info.bIfaceIndex != NDISUSB_IFACE_INDEX)
142 		return (ENXIO);
143 
144 	if (windrv_lookup(0, "USB Bus") == NULL)
145 		return (ENXIO);
146 
147 	db = windrv_match((matchfuncptr)ndisusb_devcompare, self);
148 	if (db == NULL)
149 		return (ENXIO);
150 	uaa->driver_ivar = db;
151 
152 	return (0);
153 }
154 
155 static int
ndisusb_attach(device_t self)156 ndisusb_attach(device_t self)
157 {
158 	const struct drvdb_ent	*db;
159 	struct ndisusb_softc *dummy = device_get_softc(self);
160 	struct usb_attach_arg *uaa = device_get_ivars(self);
161 	struct ndis_softc	*sc;
162 	struct ndis_usb_type	*t;
163 	driver_object		*drv;
164 	int			devidx = 0;
165 
166 	device_set_usb_desc(self);
167 	db = uaa->driver_ivar;
168 	sc = (struct ndis_softc *)dummy;
169 	sc->ndis_dev = self;
170 	mtx_init(&sc->ndisusb_mtx, "NDIS USB", MTX_NETWORK_LOCK, MTX_DEF);
171 	sc->ndis_dobj = db->windrv_object;
172 	sc->ndis_regvals = db->windrv_regvals;
173 	sc->ndis_iftype = PNPBus;
174 	sc->ndisusb_dev = uaa->device;
175 
176 	/* Create PDO for this device instance */
177 
178 	drv = windrv_lookup(0, "USB Bus");
179 	windrv_create_pdo(drv, self);
180 
181 	/* Figure out exactly which device we matched. */
182 
183 	t = db->windrv_devlist;
184 
185 	while (t->ndis_name != NULL) {
186 		if ((uaa->info.idVendor == t->ndis_vid) &&
187 		    (uaa->info.idProduct == t->ndis_did)) {
188 			sc->ndis_devidx = devidx;
189 			break;
190 		}
191 		t++;
192 		devidx++;
193 	}
194 
195 	if (ndis_attach(self) != 0)
196 		return (ENXIO);
197 
198 	return (0);
199 }
200 
201 static int
ndisusb_detach(device_t self)202 ndisusb_detach(device_t self)
203 {
204 	int i;
205 	struct ndis_softc       *sc = device_get_softc(self);
206 	struct ndisusb_ep	*ne;
207 
208 	sc->ndisusb_status |= NDISUSB_STATUS_DETACH;
209 
210 	ndis_pnpevent_nic(self, NDIS_PNP_EVENT_SURPRISE_REMOVED);
211 
212 	if (sc->ndisusb_status & NDISUSB_STATUS_SETUP_EP) {
213 		usbd_transfer_unsetup(sc->ndisusb_dread_ep.ne_xfer, 1);
214 		usbd_transfer_unsetup(sc->ndisusb_dwrite_ep.ne_xfer, 1);
215 	}
216 	for (i = 0; i < NDISUSB_ENDPT_MAX; i++) {
217 		ne = &sc->ndisusb_ep[i];
218 		usbd_transfer_unsetup(ne->ne_xfer, 1);
219 	}
220 
221 	(void)ndis_detach(self);
222 
223 	mtx_destroy(&sc->ndisusb_mtx);
224 	return (0);
225 }
226 
227 static struct resource_list *
ndis_get_resource_list(device_t dev,device_t child)228 ndis_get_resource_list(device_t dev, device_t child)
229 {
230 	struct ndis_softc       *sc;
231 
232 	sc = device_get_softc(dev);
233 	return (BUS_GET_RESOURCE_LIST(device_get_parent(sc->ndis_dev), dev));
234 }
235