1/* $FreeBSD$ */ 2/*- 3 * Copyright (c) 1990, 1991, 1993 4 * The Regents of the University of California. All rights reserved. 5 * 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 9 * Berkeley Laboratory. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 22 * 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 33 * SUCH DAMAGE. 34 */ 35 36#ifdef USB_GLOBAL_INCLUDE_FILE 37#include USB_GLOBAL_INCLUDE_FILE 38#else 39#include <sys/param.h> 40#include <sys/kernel.h> 41#include <sys/bus.h> 42#include <sys/fcntl.h> 43#include <sys/malloc.h> 44#include <sys/proc.h> 45#include <sys/socket.h> 46#include <sys/sockio.h> 47#include <net/if.h> 48#include <net/if_types.h> 49#include <net/if_clone.h> 50#include <net/bpf.h> 51#include <sys/sysctl.h> 52#include <net/route.h> 53 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 */ 65 66static void usbpf_init(void *); 67static void usbpf_uninit(void *); 68static int usbpf_ioctl(struct ifnet *, u_long, caddr_t); 69static int usbpf_clone_match(struct if_clone *, const char *); 70static int usbpf_clone_create(struct if_clone *, char *, size_t, caddr_t); 71static int usbpf_clone_destroy(struct if_clone *, struct ifnet *); 72static struct usb_bus *usbpf_ifname2ubus(const char *); 73static uint32_t usbpf_aggregate_xferflags(struct usb_xfer_flags *); 74static uint32_t usbpf_aggregate_status(struct usb_xfer_flags_int *); 75static int usbpf_xfer_frame_is_read(struct usb_xfer *, uint32_t); 76static uint32_t usbpf_xfer_precompute_size(struct usb_xfer *, int); 77 78static struct if_clone *usbpf_cloner; 79static const char usbusname[] = "usbus"; 80 81SYSINIT(usbpf_init, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_init, NULL); 82SYSUNINIT(usbpf_uninit, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, usbpf_uninit, NULL); 83 84static void 85usbpf_init(void *arg) 86{ 87 88 usbpf_cloner = if_clone_advanced(usbusname, 0, usbpf_clone_match, 89 usbpf_clone_create, usbpf_clone_destroy); 90} 91 92static void 93usbpf_uninit(void *arg) 94{ 95 int devlcnt; 96 device_t *devlp; 97 devclass_t dc; 98 struct usb_bus *ubus; 99 int error; 100 int i; 101 102 if_clone_detach(usbpf_cloner); 103 104 dc = devclass_find(usbusname); 105 if (dc == NULL) 106 return; 107 error = devclass_get_devices(dc, &devlp, &devlcnt); 108 if (error) 109 return; 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); 114 } 115 free(devlp, M_TEMP); 116} 117 118static int 119usbpf_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data) 120{ 121 122 /* No configuration allowed. */ 123 return (EINVAL); 124} 125 126static struct usb_bus * 127usbpf_ifname2ubus(const char *ifname) 128{ 129 device_t dev; 130 devclass_t dc; 131 int unit; 132 int error; 133 134 if (strncmp(ifname, usbusname, sizeof(usbusname) - 1) != 0) 135 return (NULL); 136 error = ifc_name2unit(ifname, &unit); 137 if (error || unit < 0) 138 return (NULL); 139 dc = devclass_find(usbusname); 140 if (dc == NULL) 141 return (NULL); 142 dev = devclass_get_device(dc, unit); 143 if (dev == NULL) 144 return (NULL); 145 146 return (device_get_softc(dev)); 147} 148 149static int 150usbpf_clone_match(struct if_clone *ifc, const char *name) 151{ 152 struct usb_bus *ubus; 153 154 ubus = usbpf_ifname2ubus(name); 155 if (ubus == NULL) 156 return (0); 157 if (ubus->ifp != NULL) 158 return (0); 159 160 return (1); 161} 162 163static int 164usbpf_clone_create(struct if_clone *ifc, char *name, size_t len, caddr_t params) 165{ 166 int error; 167 int unit; 168 struct ifnet *ifp; 169 struct usb_bus *ubus; 170 171 error = ifc_name2unit(name, &unit); 172 if (error) 173 return (error); 174 if (unit < 0) 175 return (EINVAL); 176 177 ubus = usbpf_ifname2ubus(name); 178 if (ubus == NULL) 179 return (1); 180 if (ubus->ifp != NULL) 181 return (1); 182 183 error = ifc_alloc_unit(ifc, &unit); 184 if (error) { 185 device_printf(ubus->parent, "usbpf: Could not allocate " 186 "instance\n"); 187 return (error); 188 } 189 ifp = ubus->ifp = if_alloc(IFT_USB); 190 if (ifp == NULL) { 191 ifc_free_unit(ifc, unit); 192 device_printf(ubus->parent, "usbpf: Could not allocate " 193 "instance\n"); 194 return (ENOSPC); 195 } 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; 201 if_attach(ifp); 202 ifp->if_flags |= IFF_UP; 203 rt_ifmsg(ifp); 204 /* 205 * XXX According to the specification of DLT_USB, it indicates 206 * packets beginning with USB setup header. But not sure all 207 * packets would be. 208 */ 209 bpfattach(ifp, DLT_USB, USBPF_HDR_LEN); 210 211 return (0); 212} 213 214static int 215usbpf_clone_destroy(struct if_clone *ifc, struct ifnet *ifp) 216{ 217 struct usb_bus *ubus; 218 int unit; 219 220 ubus = ifp->if_softc; 221 unit = ifp->if_dunit; 222 223 /* 224 * Lock USB before clearing the "ifp" pointer, to avoid 225 * clearing the pointer in the middle of a TAP operation: 226 */ 227 USB_BUS_LOCK(ubus); 228 ubus->ifp = NULL; 229 USB_BUS_UNLOCK(ubus); 230 bpfdetach(ifp); 231 if_detach(ifp); 232 if_free(ifp); 233 ifc_free_unit(ifc, unit); 234 235 return (0); 236} 237 238void 239usbpf_attach(struct usb_bus *ubus) 240{ 241 242 if (bootverbose) 243 device_printf(ubus->parent, "usbpf: Attached\n"); 244} 245 246void 247usbpf_detach(struct usb_bus *ubus) 248{ 249 250 if (ubus->ifp != NULL) 251 usbpf_clone_destroy(usbpf_cloner, ubus->ifp); 252 if (bootverbose) 253 device_printf(ubus->parent, "usbpf: Detached\n"); 254} 255 256static uint32_t 257usbpf_aggregate_xferflags(struct usb_xfer_flags *flags) 258{ 259 uint32_t val = 0; 260 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; 279 return (val); 280} 281 282static uint32_t 283usbpf_aggregate_status(struct usb_xfer_flags_int *flags) 284{ 285 uint32_t val = 0; 286 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; 313#if USB_HAVE_BUSDMA 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; 320#endif 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; 329 330 return (val); 331} 332 333static int 334usbpf_xfer_frame_is_read(struct usb_xfer *xfer, uint32_t frame) 335{ 336 int isread; 337 338 if ((frame == 0) && (xfer->flags_int.control_xfr != 0) && 339 (xfer->flags_int.control_hdr != 0)) { 340 /* special case */ 341 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 342 /* The device controller writes to memory */ 343 isread = 1; 344 } else { 345 /* The host controller reads from memory */ 346 isread = 0; 347 } 348 } else { 349 isread = USB_GET_DATA_ISREAD(xfer); 350 } 351 return (isread); 352} 353 354static uint32_t 355usbpf_xfer_precompute_size(struct usb_xfer *xfer, int type) 356{ 357 uint32_t totlen; 358 uint32_t x; 359 uint32_t nframes; 360 361 if (type == USBPF_XFERTAP_SUBMIT) 362 nframes = xfer->nframes; 363 else 364 nframes = xfer->aframes; 365 366 totlen = USBPF_HDR_LEN + (USBPF_FRAME_HDR_LEN * nframes); 367 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( 373 xfer->frlengths[x]); 374 } 375 } else { 376 if (type == USBPF_XFERTAP_SUBMIT) { 377 totlen += USBPF_FRAME_ALIGN( 378 xfer->frlengths[x]); 379 } 380 } 381 } 382 return (totlen); 383} 384 385void 386usbpf_xfertap(struct usb_xfer *xfer, int type) 387{ 388 struct usb_bus *bus; 389 struct usbpf_pkthdr *up; 390 struct usbpf_framehdr *uf; 391 usb_frlength_t offset; 392 uint32_t totlen; 393 uint32_t frame; 394 uint32_t temp; 395 uint32_t nframes; 396 uint32_t x; 397 uint8_t *buf; 398 uint8_t *ptr; 399 400 bus = xfer->xroot->bus; 401 402 /* sanity checks */ 403 if (bus->ifp == NULL || bus->ifp->if_bpf == NULL) 404 return; 405 if (!bpf_peers_present(bus->ifp->if_bpf)) 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(bus->ifp->if_bpf, buf, totlen); 529 530 free(buf, M_TEMP); 531} 532