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