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/11/sys/dev/if_ndis/if_ndis_usb.c 368650 2020-12-14 22:53:19Z brooks $");
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_var.h>
47#include <net/if_arp.h>
48#include <net/ethernet.h>
49#include <net/if_dl.h>
50#include <net/if_media.h>
51
52#include <net/bpf.h>
53
54#include <sys/bus.h>
55#include <machine/bus.h>
56#include <dev/usb/usb.h>
57#include <dev/usb/usbdi.h>
58
59#include <net80211/ieee80211_var.h>
60
61#include <compat/ndis/pe_var.h>
62#include <compat/ndis/cfg_var.h>
63#include <compat/ndis/resource_var.h>
64#include <compat/ndis/ntoskrnl_var.h>
65#include <compat/ndis/ndis_var.h>
66#include <compat/ndis/usbd_var.h>
67#include <dev/if_ndis/if_ndisvar.h>
68
69SYSCTL_NODE(_hw, OID_AUTO, ndisusb, CTLFLAG_RD, 0, "NDIS USB driver parameters");
70
71MODULE_DEPEND(ndis, usb, 1, 1, 1);
72
73static device_probe_t ndisusb_match;
74static device_attach_t ndisusb_attach;
75static device_detach_t ndisusb_detach;
76static bus_get_resource_list_t ndis_get_resource_list;
77
78extern int ndisdrv_modevent     (module_t, int, void *);
79extern int ndis_attach          (device_t);
80extern int ndis_shutdown        (device_t);
81extern int ndis_detach          (device_t);
82extern int ndis_suspend         (device_t);
83extern int ndis_resume          (device_t);
84
85extern unsigned char drv_data[];
86
87static device_method_t ndis_methods[] = {
88        /* Device interface */
89	DEVMETHOD(device_probe,		ndisusb_match),
90	DEVMETHOD(device_attach,	ndisusb_attach),
91	DEVMETHOD(device_detach,	ndisusb_detach),
92	DEVMETHOD(device_shutdown,	ndis_shutdown),
93
94        /* bus interface */
95	DEVMETHOD(bus_get_resource_list, ndis_get_resource_list),
96
97	DEVMETHOD_END
98};
99
100static driver_t ndis_driver = {
101	"ndis",
102	ndis_methods,
103	sizeof(struct ndis_softc)
104};
105
106static devclass_t ndis_devclass;
107
108DRIVER_MODULE(ndis, uhub, ndis_driver, ndis_devclass, ndisdrv_modevent, 0);
109
110static int
111ndisusb_devcompare(interface_type bustype, struct ndis_usb_type *t, device_t dev)
112{
113	struct usb_attach_arg *uaa;
114
115	if (bustype != PNPBus)
116		return (FALSE);
117
118	uaa = device_get_ivars(dev);
119
120	while (t->ndis_name != NULL) {
121		if ((uaa->info.idVendor == t->ndis_vid) &&
122		    (uaa->info.idProduct == t->ndis_did)) {
123			device_set_desc(dev, t->ndis_name);
124			return (TRUE);
125		}
126		t++;
127	}
128
129	return (FALSE);
130}
131
132static int
133ndisusb_match(device_t self)
134{
135	struct drvdb_ent *db;
136	struct usb_attach_arg *uaa = device_get_ivars(self);
137
138	if (uaa->usb_mode != USB_MODE_HOST)
139		return (ENXIO);
140	if (uaa->info.bConfigIndex != NDISUSB_CONFIG_NO)
141		return (ENXIO);
142	if (uaa->info.bIfaceIndex != NDISUSB_IFACE_INDEX)
143		return (ENXIO);
144
145	if (windrv_lookup(0, "USB Bus") == NULL)
146		return (ENXIO);
147
148	db = windrv_match((matchfuncptr)ndisusb_devcompare, self);
149	if (db == NULL)
150		return (ENXIO);
151	uaa->driver_ivar = db;
152
153	return (0);
154}
155
156static int
157ndisusb_attach(device_t self)
158{
159	const struct drvdb_ent	*db;
160	struct ndisusb_softc *dummy = device_get_softc(self);
161	struct usb_attach_arg *uaa = device_get_ivars(self);
162	struct ndis_softc	*sc;
163	struct ndis_usb_type	*t;
164	driver_object		*drv;
165	int			devidx = 0;
166
167	device_set_usb_desc(self);
168	db = uaa->driver_ivar;
169	sc = (struct ndis_softc *)dummy;
170	sc->ndis_dev = self;
171	mtx_init(&sc->ndisusb_mtx, "NDIS USB", MTX_NETWORK_LOCK, MTX_DEF);
172	sc->ndis_dobj = db->windrv_object;
173	sc->ndis_regvals = db->windrv_regvals;
174	sc->ndis_iftype = PNPBus;
175	sc->ndisusb_dev = uaa->device;
176
177	/* Create PDO for this device instance */
178
179	drv = windrv_lookup(0, "USB Bus");
180	windrv_create_pdo(drv, self);
181
182	/* Figure out exactly which device we matched. */
183
184	t = db->windrv_devlist;
185
186	while (t->ndis_name != NULL) {
187		if ((uaa->info.idVendor == t->ndis_vid) &&
188		    (uaa->info.idProduct == t->ndis_did)) {
189			sc->ndis_devidx = devidx;
190			break;
191		}
192		t++;
193		devidx++;
194	}
195
196	if (ndis_attach(self) != 0)
197		return (ENXIO);
198
199	gone_in_dev(self, 13, "ndis removed");
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