3 * Copyright (c) 1990, 1991, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from the Stanford/CMU enet packet filter,
7 * (net/enet.c) distributed as part of 4.3BSD, and code contributed
8 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #ifdef USB_GLOBAL_INCLUDE_FILE
37 #include USB_GLOBAL_INCLUDE_FILE
39 #include <sys/param.h>
40 #include <sys/kernel.h>
42 #include <sys/fcntl.h>
43 #include <sys/malloc.h>
45 #include <sys/socket.h>
46 #include <sys/sockio.h>
48 #include <net/if_types.h>
49 #include <net/if_clone.h>
51 #include <sys/sysctl.h>
52 #include <net/route.h>
54 #include <dev/usb/usb.h>
55 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usb_busdma.h>
57 #include <dev/usb/usb_controller.h>
58 #include <dev/usb/usb_core.h>
59 #include <dev/usb/usb_process.h>
60 #include <dev/usb/usb_device.h>
61 #include <dev/usb/usb_bus.h>
62 #include <dev/usb/usb_pf.h>
63 #include <dev/usb/usb_transfer.h>
64 #endif /* USB_GLOBAL_INCLUDE_FILE */
66 static void usbpf_init(void *);
67 static void usbpf_uninit(void *);
68 static int usbpf_ioctl(struct ifnet *, u_long, caddr_t);
69 static int usbpf_clone_match(struct if_clone *, const char *);
70 static int usbpf_clone_create(struct if_clone *, char *, size_t, caddr_t);
71 static int usbpf_clone_destroy(struct if_clone *, struct ifnet *);
72 static struct usb_bus *usbpf_ifname2ubus(const char *);
73 static uint32_t usbpf_aggregate_xferflags(struct usb_xfer_flags *);
74 static uint32_t usbpf_aggregate_status(struct usb_xfer_flags_int *);
75 static int usbpf_xfer_frame_is_read(struct usb_xfer *, uint32_t);
76 static uint32_t usbpf_xfer_precompute_size(struct usb_xfer *, int);
78 static struct if_clone *usbpf_cloner;
79 static const char usbusname[] = "usbus";
81 SYSINIT(usbpf_init, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_init, NULL);
82 SYSUNINIT(usbpf_uninit, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_uninit, NULL);
88 usbpf_cloner = if_clone_advanced(usbusname, 0, usbpf_clone_match,
89 usbpf_clone_create, usbpf_clone_destroy);
93 usbpf_uninit(void *arg)
102 if_clone_detach(usbpf_cloner);
104 dc = devclass_find(usbusname);
107 error = devclass_get_devices(dc, &devlp, &devlcnt);
110 for (i = 0; i < devlcnt; i++) {
111 ubus = device_get_softc(devlp[i]);
112 if (ubus != NULL && ubus->ifp != NULL)
113 usbpf_clone_destroy(usbpf_cloner, ubus->ifp);
119 usbpf_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
122 /* No configuration allowed. */
126 static struct usb_bus *
127 usbpf_ifname2ubus(const char *ifname)
134 if (strncmp(ifname, usbusname, sizeof(usbusname) - 1) != 0)
136 error = ifc_name2unit(ifname, &unit);
137 if (error || unit < 0)
139 dc = devclass_find(usbusname);
142 dev = devclass_get_device(dc, unit);
146 return (device_get_softc(dev));
150 usbpf_clone_match(struct if_clone *ifc, const char *name)
152 struct usb_bus *ubus;
154 ubus = usbpf_ifname2ubus(name);
157 if (ubus->ifp != NULL)
164 usbpf_clone_create(struct if_clone *ifc, char *name, size_t len, caddr_t params)
169 struct usb_bus *ubus;
171 error = ifc_name2unit(name, &unit);
177 ubus = usbpf_ifname2ubus(name);
180 if (ubus->ifp != NULL)
183 error = ifc_alloc_unit(ifc, &unit);
185 device_printf(ubus->parent, "usbpf: Could not allocate "
189 ifp = ubus->ifp = if_alloc(IFT_USB);
191 ifc_free_unit(ifc, unit);
192 device_printf(ubus->parent, "usbpf: Could not allocate "
196 strlcpy(ifp->if_xname, name, sizeof(ifp->if_xname));
197 ifp->if_softc = ubus;
198 ifp->if_dname = usbusname;
199 ifp->if_dunit = unit;
200 ifp->if_ioctl = usbpf_ioctl;
202 ifp->if_flags |= IFF_UP;
205 * XXX According to the specification of DLT_USB, it indicates
206 * packets beginning with USB setup header. But not sure all
209 bpfattach(ifp, DLT_USB, USBPF_HDR_LEN);
215 usbpf_clone_destroy(struct if_clone *ifc, struct ifnet *ifp)
217 struct usb_bus *ubus;
220 ubus = ifp->if_softc;
221 unit = ifp->if_dunit;
224 * Lock USB before clearing the "ifp" pointer, to avoid
225 * clearing the pointer in the middle of a TAP operation:
229 USB_BUS_UNLOCK(ubus);
233 ifc_free_unit(ifc, unit);
239 usbpf_attach(struct usb_bus *ubus)
243 device_printf(ubus->parent, "usbpf: Attached\n");
247 usbpf_detach(struct usb_bus *ubus)
250 if (ubus->ifp != NULL)
251 usbpf_clone_destroy(usbpf_cloner, ubus->ifp);
253 device_printf(ubus->parent, "usbpf: Detached\n");
257 usbpf_aggregate_xferflags(struct usb_xfer_flags *flags)
261 if (flags->force_short_xfer == 1)
262 val |= USBPF_FLAG_FORCE_SHORT_XFER;
263 if (flags->short_xfer_ok == 1)
264 val |= USBPF_FLAG_SHORT_XFER_OK;
265 if (flags->short_frames_ok == 1)
266 val |= USBPF_FLAG_SHORT_FRAMES_OK;
267 if (flags->pipe_bof == 1)
268 val |= USBPF_FLAG_PIPE_BOF;
269 if (flags->proxy_buffer == 1)
270 val |= USBPF_FLAG_PROXY_BUFFER;
271 if (flags->ext_buffer == 1)
272 val |= USBPF_FLAG_EXT_BUFFER;
273 if (flags->manual_status == 1)
274 val |= USBPF_FLAG_MANUAL_STATUS;
275 if (flags->no_pipe_ok == 1)
276 val |= USBPF_FLAG_NO_PIPE_OK;
277 if (flags->stall_pipe == 1)
278 val |= USBPF_FLAG_STALL_PIPE;
283 usbpf_aggregate_status(struct usb_xfer_flags_int *flags)
287 if (flags->open == 1)
288 val |= USBPF_STATUS_OPEN;
289 if (flags->transferring == 1)
290 val |= USBPF_STATUS_TRANSFERRING;
291 if (flags->did_dma_delay == 1)
292 val |= USBPF_STATUS_DID_DMA_DELAY;
293 if (flags->did_close == 1)
294 val |= USBPF_STATUS_DID_CLOSE;
295 if (flags->draining == 1)
296 val |= USBPF_STATUS_DRAINING;
297 if (flags->started == 1)
298 val |= USBPF_STATUS_STARTED;
299 if (flags->bandwidth_reclaimed == 1)
300 val |= USBPF_STATUS_BW_RECLAIMED;
301 if (flags->control_xfr == 1)
302 val |= USBPF_STATUS_CONTROL_XFR;
303 if (flags->control_hdr == 1)
304 val |= USBPF_STATUS_CONTROL_HDR;
305 if (flags->control_act == 1)
306 val |= USBPF_STATUS_CONTROL_ACT;
307 if (flags->control_stall == 1)
308 val |= USBPF_STATUS_CONTROL_STALL;
309 if (flags->short_frames_ok == 1)
310 val |= USBPF_STATUS_SHORT_FRAMES_OK;
311 if (flags->short_xfer_ok == 1)
312 val |= USBPF_STATUS_SHORT_XFER_OK;
314 if (flags->bdma_enable == 1)
315 val |= USBPF_STATUS_BDMA_ENABLE;
316 if (flags->bdma_no_post_sync == 1)
317 val |= USBPF_STATUS_BDMA_NO_POST_SYNC;
318 if (flags->bdma_setup == 1)
319 val |= USBPF_STATUS_BDMA_SETUP;
321 if (flags->isochronous_xfr == 1)
322 val |= USBPF_STATUS_ISOCHRONOUS_XFR;
323 if (flags->curr_dma_set == 1)
324 val |= USBPF_STATUS_CURR_DMA_SET;
325 if (flags->can_cancel_immed == 1)
326 val |= USBPF_STATUS_CAN_CANCEL_IMMED;
327 if (flags->doing_callback == 1)
328 val |= USBPF_STATUS_DOING_CALLBACK;
334 usbpf_xfer_frame_is_read(struct usb_xfer *xfer, uint32_t frame)
338 if ((frame == 0) && (xfer->flags_int.control_xfr != 0) &&
339 (xfer->flags_int.control_hdr != 0)) {
341 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) {
342 /* The device controller writes to memory */
345 /* The host controller reads from memory */
349 isread = USB_GET_DATA_ISREAD(xfer);
355 usbpf_xfer_precompute_size(struct usb_xfer *xfer, int type)
361 if (type == USBPF_XFERTAP_SUBMIT)
362 nframes = xfer->nframes;
364 nframes = xfer->aframes;
366 totlen = USBPF_HDR_LEN + (USBPF_FRAME_HDR_LEN * nframes);
368 /* precompute all trace lengths */
369 for (x = 0; x != nframes; x++) {
370 if (usbpf_xfer_frame_is_read(xfer, x)) {
371 if (type != USBPF_XFERTAP_SUBMIT) {
372 totlen += USBPF_FRAME_ALIGN(
376 if (type == USBPF_XFERTAP_SUBMIT) {
377 totlen += USBPF_FRAME_ALIGN(
386 usbpf_xfertap(struct usb_xfer *xfer, int type)
389 struct usbpf_pkthdr *up;
390 struct usbpf_framehdr *uf;
391 usb_frlength_t offset;
400 bus = xfer->xroot->bus;
403 if (bus->ifp == NULL || bus->ifp->if_bpf == NULL)
405 if (!bpf_peers_present(bus->ifp->if_bpf))
408 totlen = usbpf_xfer_precompute_size(xfer, type);
410 if (type == USBPF_XFERTAP_SUBMIT)
411 nframes = xfer->nframes;
413 nframes = xfer->aframes;
418 * When BPF supports it we could pass a fragmented array of
419 * buffers avoiding the data copy operation here.
421 buf = ptr = malloc(totlen, M_TEMP, M_NOWAIT);
423 device_printf(bus->parent, "usbpf: Out of memory\n");
427 up = (struct usbpf_pkthdr *)ptr;
428 ptr += USBPF_HDR_LEN;
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;
438 up->up_mode = USBPF_MODE_HOST;
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);
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;
458 /* clear reserved area */
459 memset(up->up_reserved, 0, sizeof(up->up_reserved));
461 /* init offset and frame */
465 /* iterate all the USB frames and copy data, if any */
466 for (x = 0; x != nframes; x++) {
471 length = xfer->frlengths[x];
473 /* get frame header pointer */
474 uf = (struct usbpf_framehdr *)ptr;
475 ptr += USBPF_FRAME_HDR_LEN;
477 /* fill out packet header */
478 uf->length = htole32(length);
481 /* get information about data read/write */
482 isread = usbpf_xfer_frame_is_read(xfer, x);
484 /* check if we need to copy any data */
486 if (type == USBPF_XFERTAP_SUBMIT)
489 uf->flags |= htole32(
490 USBPF_FRAMEFLAG_DATA_FOLLOWS);
493 if (type != USBPF_XFERTAP_SUBMIT)
496 uf->flags |= htole32(
497 USBPF_FRAMEFLAG_DATA_FOLLOWS);
501 /* check if data is read direction */
503 uf->flags |= htole32(USBPF_FRAMEFLAG_READ);
505 /* copy USB data, if any */
508 usbd_copy_out(&xfer->frbuffers[frame],
509 offset, ptr, length);
512 temp = USBPF_FRAME_ALIGN(length);
516 memset(ptr + length, 0, temp - length);
521 if (xfer->flags_int.isochronous_xfr) {
522 offset += usbd_xfer_old_frame_length(xfer, x);
528 bpf_tap(bus->ifp->if_bpf, buf, totlen);