1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1990, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from the Stanford/CMU enet packet filter,
8 * (net/enet.c) distributed as part of 4.3BSD, and code contributed
9 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
10 * Berkeley Laboratory.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 */
36
37 #ifdef USB_GLOBAL_INCLUDE_FILE
38 #include USB_GLOBAL_INCLUDE_FILE
39 #else
40 #include <sys/param.h>
41 #include <sys/kernel.h>
42 #include <sys/bus.h>
43 #include <sys/fcntl.h>
44 #include <sys/malloc.h>
45 #include <sys/proc.h>
46 #include <sys/socket.h>
47 #include <sys/sockio.h>
48 #include <net/if.h>
49 #include <net/if_var.h>
50 #include <net/if_types.h>
51 #include <net/if_clone.h>
52 #include <net/bpf.h>
53 #include <sys/sysctl.h>
54 #include <net/route.h>
55
56 #include <dev/usb/usb.h>
57 #include <dev/usb/usbdi.h>
58 #include <dev/usb/usb_busdma.h>
59 #include <dev/usb/usb_controller.h>
60 #include <dev/usb/usb_core.h>
61 #include <dev/usb/usb_process.h>
62 #include <dev/usb/usb_device.h>
63 #include <dev/usb/usb_bus.h>
64 #include <dev/usb/usb_pf.h>
65 #include <dev/usb/usb_transfer.h>
66 #endif /* USB_GLOBAL_INCLUDE_FILE */
67
68 static void usbpf_init(void *);
69 static void usbpf_uninit(void *);
70 static int usbpf_ioctl(if_t, u_long, caddr_t);
71 static int usbpf_clone_match(struct if_clone *, const char *);
72 static int usbpf_clone_create(struct if_clone *, char *, size_t,
73 struct ifc_data *, if_t *);
74 static int usbpf_clone_destroy(struct if_clone *, if_t, uint32_t);
75 static struct usb_bus *usbpf_ifname2ubus(const char *);
76 static uint32_t usbpf_aggregate_xferflags(struct usb_xfer_flags *);
77 static uint32_t usbpf_aggregate_status(struct usb_xfer_flags_int *);
78 static int usbpf_xfer_frame_is_read(struct usb_xfer *, uint32_t);
79 static uint32_t usbpf_xfer_precompute_size(struct usb_xfer *, int);
80
81 static struct if_clone *usbpf_cloner;
82 static const char usbusname[] = "usbus";
83
84 SYSINIT(usbpf_init, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_init, NULL);
85 SYSUNINIT(usbpf_uninit, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_uninit, NULL);
86
87 static void
usbpf_init(void * arg)88 usbpf_init(void *arg)
89 {
90 struct if_clone_addreq req = {
91 .match_f = usbpf_clone_match,
92 .create_f = usbpf_clone_create,
93 .destroy_f = usbpf_clone_destroy,
94 };
95
96 usbpf_cloner = ifc_attach_cloner(usbusname, &req);
97 }
98
99 static void
usbpf_uninit(void * arg)100 usbpf_uninit(void *arg)
101 {
102 int devlcnt;
103 device_t *devlp;
104 devclass_t dc;
105 struct usb_bus *ubus;
106 int error;
107 int i;
108
109 if_clone_detach(usbpf_cloner);
110
111 dc = devclass_find(usbusname);
112 if (dc == NULL)
113 return;
114 error = devclass_get_devices(dc, &devlp, &devlcnt);
115 if (error)
116 return;
117 for (i = 0; i < devlcnt; i++) {
118 ubus = device_get_softc(devlp[i]);
119 if (ubus != NULL && ubus->ifp != NULL)
120 usbpf_clone_destroy(usbpf_cloner, ubus->ifp, 0);
121 }
122 free(devlp, M_TEMP);
123 }
124
125 static int
usbpf_ioctl(if_t ifp,u_long cmd,caddr_t data)126 usbpf_ioctl(if_t ifp, u_long cmd, caddr_t data)
127 {
128
129 /* No configuration allowed. */
130 return (EINVAL);
131 }
132
133 static struct usb_bus *
usbpf_ifname2ubus(const char * ifname)134 usbpf_ifname2ubus(const char *ifname)
135 {
136 device_t dev;
137 devclass_t dc;
138 int unit;
139 int error;
140
141 if (strncmp(ifname, usbusname, sizeof(usbusname) - 1) != 0)
142 return (NULL);
143 error = ifc_name2unit(ifname, &unit);
144 if (error || unit < 0)
145 return (NULL);
146 dc = devclass_find(usbusname);
147 if (dc == NULL)
148 return (NULL);
149 dev = devclass_get_device(dc, unit);
150 if (dev == NULL)
151 return (NULL);
152
153 return (device_get_softc(dev));
154 }
155
156 static int
usbpf_clone_match(struct if_clone * ifc,const char * name)157 usbpf_clone_match(struct if_clone *ifc, const char *name)
158 {
159 struct usb_bus *ubus;
160
161 ubus = usbpf_ifname2ubus(name);
162 if (ubus == NULL)
163 return (0);
164 if (ubus->ifp != NULL)
165 return (0);
166
167 return (1);
168 }
169
170 static int
usbpf_clone_create(struct if_clone * ifc,char * name,size_t len,struct ifc_data * ifd,if_t * ifpp)171 usbpf_clone_create(struct if_clone *ifc, char *name, size_t len,
172 struct ifc_data *ifd, if_t *ifpp)
173 {
174 int error;
175 int unit;
176 if_t ifp;
177 struct usb_bus *ubus;
178
179 error = ifc_name2unit(name, &unit);
180 if (error)
181 return (error);
182 if (unit < 0)
183 return (EINVAL);
184
185 ubus = usbpf_ifname2ubus(name);
186 if (ubus == NULL)
187 return (1);
188 if (ubus->ifp != NULL)
189 return (1);
190
191 error = ifc_alloc_unit(ifc, &unit);
192 if (error) {
193 device_printf(ubus->parent, "usbpf: Could not allocate "
194 "instance\n");
195 return (error);
196 }
197 ifp = ubus->ifp = if_alloc(IFT_USB);
198 if_setsoftc(ifp, ubus);
199 if_initname(ifp, usbusname, unit);
200 if_setname(ifp, name);
201 if_setioctlfn(ifp, usbpf_ioctl);
202 if_attach(ifp);
203 if_setflagbits(ifp, IFF_UP, 0);
204 rt_ifmsg(ifp, IFF_UP);
205 /*
206 * XXX According to the specification of DLT_USB, it indicates
207 * packets beginning with USB setup header. But not sure all
208 * packets would be.
209 */
210 bpfattach(ifp, DLT_USB, USBPF_HDR_LEN);
211 *ifpp = ifp;
212
213 return (0);
214 }
215
216 static int
usbpf_clone_destroy(struct if_clone * ifc,if_t ifp,uint32_t flags)217 usbpf_clone_destroy(struct if_clone *ifc, if_t ifp, uint32_t flags)
218 {
219 struct usb_bus *ubus;
220 int unit;
221
222 ubus = if_getsoftc(ifp);
223 unit = if_getdunit(ifp);
224
225 /*
226 * Lock USB before clearing the "ifp" pointer, to avoid
227 * clearing the pointer in the middle of a TAP operation:
228 */
229 USB_BUS_LOCK(ubus);
230 ubus->ifp = NULL;
231 USB_BUS_UNLOCK(ubus);
232 bpfdetach(ifp);
233 if_detach(ifp);
234 if_free(ifp);
235 ifc_free_unit(ifc, unit);
236
237 return (0);
238 }
239
240 void
usbpf_attach(struct usb_bus * ubus)241 usbpf_attach(struct usb_bus *ubus)
242 {
243
244 if (bootverbose)
245 device_printf(ubus->parent, "usbpf: Attached\n");
246 }
247
248 void
usbpf_detach(struct usb_bus * ubus)249 usbpf_detach(struct usb_bus *ubus)
250 {
251
252 if (ubus->ifp != NULL)
253 usbpf_clone_destroy(usbpf_cloner, ubus->ifp, 0);
254 if (bootverbose)
255 device_printf(ubus->parent, "usbpf: Detached\n");
256 }
257
258 static uint32_t
usbpf_aggregate_xferflags(struct usb_xfer_flags * flags)259 usbpf_aggregate_xferflags(struct usb_xfer_flags *flags)
260 {
261 uint32_t val = 0;
262
263 if (flags->force_short_xfer == 1)
264 val |= USBPF_FLAG_FORCE_SHORT_XFER;
265 if (flags->short_xfer_ok == 1)
266 val |= USBPF_FLAG_SHORT_XFER_OK;
267 if (flags->short_frames_ok == 1)
268 val |= USBPF_FLAG_SHORT_FRAMES_OK;
269 if (flags->pipe_bof == 1)
270 val |= USBPF_FLAG_PIPE_BOF;
271 if (flags->proxy_buffer == 1)
272 val |= USBPF_FLAG_PROXY_BUFFER;
273 if (flags->ext_buffer == 1)
274 val |= USBPF_FLAG_EXT_BUFFER;
275 if (flags->manual_status == 1)
276 val |= USBPF_FLAG_MANUAL_STATUS;
277 if (flags->no_pipe_ok == 1)
278 val |= USBPF_FLAG_NO_PIPE_OK;
279 if (flags->stall_pipe == 1)
280 val |= USBPF_FLAG_STALL_PIPE;
281 return (val);
282 }
283
284 static uint32_t
usbpf_aggregate_status(struct usb_xfer_flags_int * flags)285 usbpf_aggregate_status(struct usb_xfer_flags_int *flags)
286 {
287 uint32_t val = 0;
288
289 if (flags->open == 1)
290 val |= USBPF_STATUS_OPEN;
291 if (flags->transferring == 1)
292 val |= USBPF_STATUS_TRANSFERRING;
293 if (flags->did_dma_delay == 1)
294 val |= USBPF_STATUS_DID_DMA_DELAY;
295 if (flags->did_close == 1)
296 val |= USBPF_STATUS_DID_CLOSE;
297 if (flags->draining == 1)
298 val |= USBPF_STATUS_DRAINING;
299 if (flags->started == 1)
300 val |= USBPF_STATUS_STARTED;
301 if (flags->bandwidth_reclaimed == 1)
302 val |= USBPF_STATUS_BW_RECLAIMED;
303 if (flags->control_xfr == 1)
304 val |= USBPF_STATUS_CONTROL_XFR;
305 if (flags->control_hdr == 1)
306 val |= USBPF_STATUS_CONTROL_HDR;
307 if (flags->control_act == 1)
308 val |= USBPF_STATUS_CONTROL_ACT;
309 if (flags->control_stall == 1)
310 val |= USBPF_STATUS_CONTROL_STALL;
311 if (flags->short_frames_ok == 1)
312 val |= USBPF_STATUS_SHORT_FRAMES_OK;
313 if (flags->short_xfer_ok == 1)
314 val |= USBPF_STATUS_SHORT_XFER_OK;
315 #if USB_HAVE_BUSDMA
316 if (flags->bdma_enable == 1)
317 val |= USBPF_STATUS_BDMA_ENABLE;
318 if (flags->bdma_no_post_sync == 1)
319 val |= USBPF_STATUS_BDMA_NO_POST_SYNC;
320 if (flags->bdma_setup == 1)
321 val |= USBPF_STATUS_BDMA_SETUP;
322 #endif
323 if (flags->isochronous_xfr == 1)
324 val |= USBPF_STATUS_ISOCHRONOUS_XFR;
325 if (flags->curr_dma_set == 1)
326 val |= USBPF_STATUS_CURR_DMA_SET;
327 if (flags->can_cancel_immed == 1)
328 val |= USBPF_STATUS_CAN_CANCEL_IMMED;
329 if (flags->doing_callback == 1)
330 val |= USBPF_STATUS_DOING_CALLBACK;
331
332 return (val);
333 }
334
335 static int
usbpf_xfer_frame_is_read(struct usb_xfer * xfer,uint32_t frame)336 usbpf_xfer_frame_is_read(struct usb_xfer *xfer, uint32_t frame)
337 {
338 int isread;
339
340 if ((frame == 0) && (xfer->flags_int.control_xfr != 0) &&
341 (xfer->flags_int.control_hdr != 0)) {
342 /* special case */
343 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) {
344 /* The device controller writes to memory */
345 isread = 1;
346 } else {
347 /* The host controller reads from memory */
348 isread = 0;
349 }
350 } else {
351 isread = USB_GET_DATA_ISREAD(xfer);
352 }
353 return (isread);
354 }
355
356 static uint32_t
usbpf_xfer_precompute_size(struct usb_xfer * xfer,int type)357 usbpf_xfer_precompute_size(struct usb_xfer *xfer, int type)
358 {
359 uint32_t totlen;
360 uint32_t x;
361 uint32_t nframes;
362
363 if (type == USBPF_XFERTAP_SUBMIT)
364 nframes = xfer->nframes;
365 else
366 nframes = xfer->aframes;
367
368 totlen = USBPF_HDR_LEN + (USBPF_FRAME_HDR_LEN * nframes);
369
370 /* precompute all trace lengths */
371 for (x = 0; x != nframes; x++) {
372 if (usbpf_xfer_frame_is_read(xfer, x)) {
373 if (type != USBPF_XFERTAP_SUBMIT) {
374 totlen += USBPF_FRAME_ALIGN(
375 xfer->frlengths[x]);
376 }
377 } else {
378 if (type == USBPF_XFERTAP_SUBMIT) {
379 totlen += USBPF_FRAME_ALIGN(
380 xfer->frlengths[x]);
381 }
382 }
383 }
384 return (totlen);
385 }
386
387 void
usbpf_xfertap(struct usb_xfer * xfer,int type)388 usbpf_xfertap(struct usb_xfer *xfer, int type)
389 {
390 struct usb_bus *bus;
391 struct usbpf_pkthdr *up;
392 struct usbpf_framehdr *uf;
393 usb_frlength_t offset;
394 uint32_t totlen;
395 uint32_t frame;
396 uint32_t temp;
397 uint32_t nframes;
398 uint32_t x;
399 uint8_t *buf;
400 uint8_t *ptr;
401
402 bus = xfer->xroot->bus;
403
404 /* sanity checks */
405 if (bus->ifp == NULL || !bpf_peers_present_if(bus->ifp))
406 return;
407
408 totlen = usbpf_xfer_precompute_size(xfer, type);
409
410 if (type == USBPF_XFERTAP_SUBMIT)
411 nframes = xfer->nframes;
412 else
413 nframes = xfer->aframes;
414
415 /*
416 * XXX TODO XXX
417 *
418 * When BPF supports it we could pass a fragmented array of
419 * buffers avoiding the data copy operation here.
420 */
421 buf = ptr = malloc(totlen, M_TEMP, M_NOWAIT);
422 if (buf == NULL) {
423 device_printf(bus->parent, "usbpf: Out of memory\n");
424 return;
425 }
426
427 up = (struct usbpf_pkthdr *)ptr;
428 ptr += USBPF_HDR_LEN;
429
430 /* fill out header */
431 temp = device_get_unit(bus->bdev);
432 up->up_totlen = htole32(totlen);
433 up->up_busunit = htole32(temp);
434 up->up_address = xfer->xroot->udev->device_index;
435 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE)
436 up->up_mode = USBPF_MODE_DEVICE;
437 else
438 up->up_mode = USBPF_MODE_HOST;
439 up->up_type = type;
440 up->up_xfertype = xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE;
441 temp = usbpf_aggregate_xferflags(&xfer->flags);
442 up->up_flags = htole32(temp);
443 temp = usbpf_aggregate_status(&xfer->flags_int);
444 up->up_status = htole32(temp);
445 temp = xfer->error;
446 up->up_error = htole32(temp);
447 temp = xfer->interval;
448 up->up_interval = htole32(temp);
449 up->up_frames = htole32(nframes);
450 temp = xfer->max_packet_size;
451 up->up_packet_size = htole32(temp);
452 temp = xfer->max_packet_count;
453 up->up_packet_count = htole32(temp);
454 temp = xfer->endpointno;
455 up->up_endpoint = htole32(temp);
456 up->up_speed = xfer->xroot->udev->speed;
457
458 /* clear reserved area */
459 memset(up->up_reserved, 0, sizeof(up->up_reserved));
460
461 /* init offset and frame */
462 offset = 0;
463 frame = 0;
464
465 /* iterate all the USB frames and copy data, if any */
466 for (x = 0; x != nframes; x++) {
467 uint32_t length;
468 int isread;
469
470 /* get length */
471 length = xfer->frlengths[x];
472
473 /* get frame header pointer */
474 uf = (struct usbpf_framehdr *)ptr;
475 ptr += USBPF_FRAME_HDR_LEN;
476
477 /* fill out packet header */
478 uf->length = htole32(length);
479 uf->flags = 0;
480
481 /* get information about data read/write */
482 isread = usbpf_xfer_frame_is_read(xfer, x);
483
484 /* check if we need to copy any data */
485 if (isread) {
486 if (type == USBPF_XFERTAP_SUBMIT)
487 length = 0;
488 else {
489 uf->flags |= htole32(
490 USBPF_FRAMEFLAG_DATA_FOLLOWS);
491 }
492 } else {
493 if (type != USBPF_XFERTAP_SUBMIT)
494 length = 0;
495 else {
496 uf->flags |= htole32(
497 USBPF_FRAMEFLAG_DATA_FOLLOWS);
498 }
499 }
500
501 /* check if data is read direction */
502 if (isread)
503 uf->flags |= htole32(USBPF_FRAMEFLAG_READ);
504
505 /* copy USB data, if any */
506 if (length != 0) {
507 /* copy data */
508 usbd_copy_out(&xfer->frbuffers[frame],
509 offset, ptr, length);
510
511 /* align length */
512 temp = USBPF_FRAME_ALIGN(length);
513
514 /* zero pad */
515 if (temp != length)
516 memset(ptr + length, 0, temp - length);
517
518 ptr += temp;
519 }
520
521 if (xfer->flags_int.isochronous_xfr) {
522 offset += usbd_xfer_old_frame_length(xfer, x);
523 } else {
524 frame ++;
525 }
526 }
527
528 bpf_tap_if(bus->ifp, buf, totlen);
529
530 free(buf, M_TEMP);
531 }
532