1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause 4 * 5 * Copyright (c) 2006-2023 Hans Petter Selasky 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 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * 29 * usb_dev.c - An abstraction layer for creating devices under /dev/... 30 */ 31 32 #ifdef USB_GLOBAL_INCLUDE_FILE 33 #include USB_GLOBAL_INCLUDE_FILE 34 #else 35 #ifdef COMPAT_FREEBSD32 36 #include <sys/abi_compat.h> 37 #endif 38 #include <sys/stdint.h> 39 #include <sys/stddef.h> 40 #include <sys/param.h> 41 #include <sys/queue.h> 42 #include <sys/types.h> 43 #include <sys/systm.h> 44 #include <sys/kernel.h> 45 #include <sys/bus.h> 46 #include <sys/module.h> 47 #include <sys/lock.h> 48 #include <sys/mutex.h> 49 #include <sys/condvar.h> 50 #include <sys/sysctl.h> 51 #include <sys/sx.h> 52 #include <sys/unistd.h> 53 #include <sys/callout.h> 54 #include <sys/malloc.h> 55 #include <sys/priv.h> 56 #include <sys/vnode.h> 57 #include <sys/conf.h> 58 #include <sys/fcntl.h> 59 60 #include <dev/usb/usb.h> 61 #include <dev/usb/usb_ioctl.h> 62 #include <dev/usb/usbdi.h> 63 #include <dev/usb/usbdi_util.h> 64 65 #define USB_DEBUG_VAR usb_fifo_debug 66 67 #include <dev/usb/usb_core.h> 68 #include <dev/usb/usb_dev.h> 69 #include <dev/usb/usb_mbuf.h> 70 #include <dev/usb/usb_process.h> 71 #include <dev/usb/usb_device.h> 72 #include <dev/usb/usb_debug.h> 73 #include <dev/usb/usb_busdma.h> 74 #include <dev/usb/usb_generic.h> 75 #include <dev/usb/usb_dynamic.h> 76 #include <dev/usb/usb_util.h> 77 78 #include <dev/usb/usb_controller.h> 79 #include <dev/usb/usb_bus.h> 80 81 #include <sys/filio.h> 82 #include <sys/ttycom.h> 83 #include <sys/syscallsubr.h> 84 85 #include <machine/stdarg.h> 86 #endif /* USB_GLOBAL_INCLUDE_FILE */ 87 88 #if USB_HAVE_UGEN 89 90 #ifdef USB_DEBUG 91 static int usb_fifo_debug = 0; 92 93 static SYSCTL_NODE(_hw_usb, OID_AUTO, dev, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 94 "USB device"); 95 SYSCTL_INT(_hw_usb_dev, OID_AUTO, debug, CTLFLAG_RWTUN, 96 &usb_fifo_debug, 0, "Debug Level"); 97 #endif 98 99 #define USB_UCRED struct ucred *ucred, 100 101 /* prototypes */ 102 103 static int usb_fifo_open(struct usb_cdev_privdata *, 104 struct usb_fifo *, int); 105 static void usb_fifo_close(struct usb_fifo *, int); 106 static void usb_dev_init(void *); 107 static void usb_dev_init_post(void *); 108 static void usb_dev_uninit(void *); 109 static int usb_fifo_uiomove(struct usb_fifo *, void *, int, 110 struct uio *); 111 static void usb_fifo_check_methods(struct usb_fifo_methods *); 112 static struct usb_fifo *usb_fifo_alloc(struct mtx *); 113 static struct usb_endpoint *usb_dev_get_ep(struct usb_device *, uint8_t, 114 uint8_t); 115 static void usb_loc_fill(struct usb_fs_privdata *, 116 struct usb_cdev_privdata *); 117 static void usb_close(void *); 118 static usb_error_t usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *, int); 119 static usb_error_t usb_usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *); 120 static void usb_unref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *); 121 122 static d_open_t usb_open; 123 static d_ioctl_t usb_ioctl; 124 static d_read_t usb_read; 125 static d_write_t usb_write; 126 static d_poll_t usb_poll; 127 static d_kqfilter_t usb_kqfilter; 128 129 static d_ioctl_t usb_static_ioctl; 130 131 static usb_fifo_open_t usb_fifo_dummy_open; 132 static usb_fifo_close_t usb_fifo_dummy_close; 133 static usb_fifo_ioctl_t usb_fifo_dummy_ioctl; 134 static usb_fifo_cmd_t usb_fifo_dummy_cmd; 135 136 /* character device structure used for devices (/dev/ugenX.Y and /dev/uXXX) */ 137 struct cdevsw usb_devsw = { 138 .d_version = D_VERSION, 139 .d_open = usb_open, 140 .d_ioctl = usb_ioctl, 141 .d_name = "usbdev", 142 .d_flags = D_TRACKCLOSE, 143 .d_read = usb_read, 144 .d_write = usb_write, 145 .d_poll = usb_poll, 146 .d_kqfilter = usb_kqfilter, 147 }; 148 149 static struct cdev* usb_dev = NULL; 150 151 /* character device structure used for /dev/usb */ 152 static struct cdevsw usb_static_devsw = { 153 .d_version = D_VERSION, 154 .d_ioctl = usb_static_ioctl, 155 .d_name = "usb" 156 }; 157 158 static TAILQ_HEAD(, usb_symlink) usb_sym_head; 159 static struct sx usb_sym_lock; 160 161 struct mtx usb_ref_lock; 162 163 /*------------------------------------------------------------------------* 164 * usb_loc_fill 165 * 166 * This is used to fill out a usb_cdev_privdata structure based on the 167 * device's address as contained in usb_fs_privdata. 168 *------------------------------------------------------------------------*/ 169 static void 170 usb_loc_fill(struct usb_fs_privdata* pd, struct usb_cdev_privdata *cpd) 171 { 172 cpd->bus_index = pd->bus_index; 173 cpd->dev_index = pd->dev_index; 174 cpd->ep_addr = pd->ep_addr; 175 cpd->fifo_index = pd->fifo_index; 176 } 177 178 /*------------------------------------------------------------------------* 179 * usb_ref_device 180 * 181 * This function is used to atomically refer an USB device by its 182 * device location. If this function returns success the USB device 183 * will not disappear until the USB device is unreferenced. 184 * 185 * Return values: 186 * 0: Success, refcount incremented on the given USB device. 187 * Else: Failure. 188 *------------------------------------------------------------------------*/ 189 static usb_error_t 190 usb_ref_device(struct usb_cdev_privdata *cpd, 191 struct usb_cdev_refdata *crd, int need_uref) 192 { 193 struct usb_fifo **ppf; 194 struct usb_fifo *f; 195 196 DPRINTFN(2, "cpd=%p need uref=%d\n", cpd, need_uref); 197 198 /* clear all refs */ 199 memset(crd, 0, sizeof(*crd)); 200 201 mtx_lock(&usb_ref_lock); 202 cpd->bus = devclass_get_softc(usb_devclass_ptr, cpd->bus_index); 203 if (cpd->bus == NULL) { 204 DPRINTFN(2, "no bus at %u\n", cpd->bus_index); 205 goto error; 206 } 207 cpd->udev = cpd->bus->devices[cpd->dev_index]; 208 if (cpd->udev == NULL) { 209 DPRINTFN(2, "no device at %u\n", cpd->dev_index); 210 goto error; 211 } 212 if (cpd->udev->state == USB_STATE_DETACHED && 213 (need_uref != 2)) { 214 DPRINTFN(2, "device is detached\n"); 215 goto error; 216 } 217 if (need_uref) { 218 DPRINTFN(2, "ref udev - needed\n"); 219 220 if (cpd->udev->refcount == USB_DEV_REF_MAX) { 221 DPRINTFN(2, "no dev ref\n"); 222 goto error; 223 } 224 cpd->udev->refcount++; 225 226 mtx_unlock(&usb_ref_lock); 227 228 /* 229 * We need to grab the enumeration SX-lock before 230 * grabbing the FIFO refs to avoid deadlock at detach! 231 */ 232 crd->do_unlock = usbd_enum_lock_sig(cpd->udev); 233 234 mtx_lock(&usb_ref_lock); 235 236 /* 237 * Set "is_uref" after grabbing the default SX lock 238 */ 239 crd->is_uref = 1; 240 241 /* check for signal */ 242 if (crd->do_unlock > 1) { 243 crd->do_unlock = 0; 244 goto error; 245 } 246 } 247 248 /* check if we are doing an open */ 249 if (cpd->fflags == 0) { 250 /* use zero defaults */ 251 } else { 252 /* check for write */ 253 if (cpd->fflags & FWRITE) { 254 ppf = cpd->udev->fifo; 255 f = ppf[cpd->fifo_index + USB_FIFO_TX]; 256 crd->txfifo = f; 257 crd->is_write = 1; /* ref */ 258 if (f == NULL || f->refcount == USB_FIFO_REF_MAX) 259 goto error; 260 if (f->curr_cpd != cpd) 261 goto error; 262 /* check if USB-FS is active */ 263 if (f->fs_ep_max != 0) { 264 crd->is_usbfs = 1; 265 } 266 } 267 268 /* check for read */ 269 if (cpd->fflags & FREAD) { 270 ppf = cpd->udev->fifo; 271 f = ppf[cpd->fifo_index + USB_FIFO_RX]; 272 crd->rxfifo = f; 273 crd->is_read = 1; /* ref */ 274 if (f == NULL || f->refcount == USB_FIFO_REF_MAX) 275 goto error; 276 if (f->curr_cpd != cpd) 277 goto error; 278 /* check if USB-FS is active */ 279 if (f->fs_ep_max != 0) { 280 crd->is_usbfs = 1; 281 } 282 } 283 } 284 285 /* when everything is OK we increment the refcounts */ 286 if (crd->is_write) { 287 DPRINTFN(2, "ref write\n"); 288 crd->txfifo->refcount++; 289 } 290 if (crd->is_read) { 291 DPRINTFN(2, "ref read\n"); 292 crd->rxfifo->refcount++; 293 } 294 mtx_unlock(&usb_ref_lock); 295 296 return (0); 297 298 error: 299 if (crd->do_unlock) 300 usbd_enum_unlock(cpd->udev); 301 302 if (crd->is_uref) { 303 if (--(cpd->udev->refcount) == 0) 304 cv_broadcast(&cpd->udev->ref_cv); 305 } 306 mtx_unlock(&usb_ref_lock); 307 DPRINTFN(2, "fail\n"); 308 309 /* clear all refs */ 310 memset(crd, 0, sizeof(*crd)); 311 312 return (USB_ERR_INVAL); 313 } 314 315 /*------------------------------------------------------------------------* 316 * usb_usb_ref_device 317 * 318 * This function is used to upgrade an USB reference to include the 319 * USB device reference on a USB location. 320 * 321 * Return values: 322 * 0: Success, refcount incremented on the given USB device. 323 * Else: Failure. 324 *------------------------------------------------------------------------*/ 325 static usb_error_t 326 usb_usb_ref_device(struct usb_cdev_privdata *cpd, 327 struct usb_cdev_refdata *crd) 328 { 329 /* 330 * Check if we already got an USB reference on this location: 331 */ 332 if (crd->is_uref) 333 return (0); /* success */ 334 335 /* 336 * To avoid deadlock at detach we need to drop the FIFO ref 337 * and re-acquire a new ref! 338 */ 339 usb_unref_device(cpd, crd); 340 341 return (usb_ref_device(cpd, crd, 1 /* need uref */)); 342 } 343 344 /*------------------------------------------------------------------------* 345 * usb_unref_device 346 * 347 * This function will release the reference count by one unit for the 348 * given USB device. 349 *------------------------------------------------------------------------*/ 350 static void 351 usb_unref_device(struct usb_cdev_privdata *cpd, 352 struct usb_cdev_refdata *crd) 353 { 354 355 DPRINTFN(2, "cpd=%p is_uref=%d\n", cpd, crd->is_uref); 356 357 if (crd->do_unlock) 358 usbd_enum_unlock(cpd->udev); 359 360 mtx_lock(&usb_ref_lock); 361 if (crd->is_read) { 362 if (--(crd->rxfifo->refcount) == 0) { 363 cv_signal(&crd->rxfifo->cv_drain); 364 } 365 crd->is_read = 0; 366 } 367 if (crd->is_write) { 368 if (--(crd->txfifo->refcount) == 0) { 369 cv_signal(&crd->txfifo->cv_drain); 370 } 371 crd->is_write = 0; 372 } 373 if (crd->is_uref) { 374 crd->is_uref = 0; 375 if (--(cpd->udev->refcount) == 0) 376 cv_broadcast(&cpd->udev->ref_cv); 377 } 378 mtx_unlock(&usb_ref_lock); 379 } 380 381 static struct usb_fifo * 382 usb_fifo_alloc(struct mtx *mtx) 383 { 384 struct usb_fifo *f; 385 386 f = malloc(sizeof(*f), M_USBDEV, M_WAITOK | M_ZERO); 387 cv_init(&f->cv_io, "FIFO-IO"); 388 cv_init(&f->cv_drain, "FIFO-DRAIN"); 389 sx_init(&f->fs_fastpath_lock, "FIFO-FP"); 390 f->priv_mtx = mtx; 391 f->refcount = 1; 392 knlist_init_mtx(&f->selinfo.si_note, mtx); 393 return (f); 394 } 395 396 /*------------------------------------------------------------------------* 397 * usb_fifo_create 398 *------------------------------------------------------------------------*/ 399 static int 400 usb_fifo_create(struct usb_cdev_privdata *cpd, 401 struct usb_cdev_refdata *crd) 402 { 403 struct usb_device *udev = cpd->udev; 404 struct usb_fifo *f; 405 struct usb_endpoint *ep; 406 uint8_t n; 407 uint8_t is_tx; 408 uint8_t is_rx; 409 uint8_t no_null; 410 uint8_t is_busy; 411 int e = cpd->ep_addr; 412 413 is_tx = (cpd->fflags & FWRITE) ? 1 : 0; 414 is_rx = (cpd->fflags & FREAD) ? 1 : 0; 415 no_null = 1; 416 is_busy = 0; 417 418 /* Preallocated FIFO */ 419 if (e < 0) { 420 DPRINTFN(5, "Preallocated FIFO\n"); 421 if (is_tx) { 422 f = udev->fifo[cpd->fifo_index + USB_FIFO_TX]; 423 if (f == NULL) 424 return (EINVAL); 425 crd->txfifo = f; 426 } 427 if (is_rx) { 428 f = udev->fifo[cpd->fifo_index + USB_FIFO_RX]; 429 if (f == NULL) 430 return (EINVAL); 431 crd->rxfifo = f; 432 } 433 return (0); 434 } 435 436 KASSERT(e >= 0 && e <= 15, ("endpoint %d out of range", e)); 437 438 /* search for a free FIFO slot */ 439 DPRINTFN(5, "Endpoint device, searching for 0x%02x\n", e); 440 for (n = 0;; n += 2) { 441 if (n == USB_FIFO_MAX) { 442 if (no_null) { 443 no_null = 0; 444 n = 0; 445 } else { 446 /* end of FIFOs reached */ 447 DPRINTFN(5, "out of FIFOs\n"); 448 return (ENOMEM); 449 } 450 } 451 /* Check for TX FIFO */ 452 if (is_tx) { 453 f = udev->fifo[n + USB_FIFO_TX]; 454 if (f != NULL) { 455 if (f->dev_ep_index != e) { 456 /* wrong endpoint index */ 457 continue; 458 } 459 if (f->curr_cpd != NULL) { 460 /* FIFO is opened */ 461 is_busy = 1; 462 continue; 463 } 464 } else if (no_null) { 465 continue; 466 } 467 } 468 /* Check for RX FIFO */ 469 if (is_rx) { 470 f = udev->fifo[n + USB_FIFO_RX]; 471 if (f != NULL) { 472 if (f->dev_ep_index != e) { 473 /* wrong endpoint index */ 474 continue; 475 } 476 if (f->curr_cpd != NULL) { 477 /* FIFO is opened */ 478 is_busy = 1; 479 continue; 480 } 481 } else if (no_null) { 482 continue; 483 } 484 } 485 break; 486 } 487 488 if (no_null == 0) { 489 if (e >= (USB_EP_MAX / 2)) { 490 /* we don't create any endpoints in this range */ 491 DPRINTFN(5, "ep out of range\n"); 492 return (is_busy ? EBUSY : EINVAL); 493 } 494 } 495 496 if ((e != 0) && is_busy) { 497 /* 498 * Only the default control endpoint is allowed to be 499 * opened multiple times! 500 */ 501 DPRINTFN(5, "busy\n"); 502 return (EBUSY); 503 } 504 505 /* Check TX FIFO */ 506 if (is_tx && 507 (udev->fifo[n + USB_FIFO_TX] == NULL)) { 508 ep = usb_dev_get_ep(udev, e, USB_FIFO_TX); 509 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_TX); 510 if (ep == NULL) { 511 DPRINTFN(5, "dev_get_endpoint returned NULL\n"); 512 return (EINVAL); 513 } 514 f = usb_fifo_alloc(&udev->device_mtx); 515 if (f == NULL) { 516 DPRINTFN(5, "could not alloc tx fifo\n"); 517 return (ENOMEM); 518 } 519 /* update some fields */ 520 f->fifo_index = n + USB_FIFO_TX; 521 f->dev_ep_index = e; 522 f->priv_sc0 = ep; 523 f->methods = &usb_ugen_methods; 524 f->iface_index = ep->iface_index; 525 f->udev = udev; 526 mtx_lock(&usb_ref_lock); 527 udev->fifo[n + USB_FIFO_TX] = f; 528 mtx_unlock(&usb_ref_lock); 529 } 530 /* Check RX FIFO */ 531 if (is_rx && 532 (udev->fifo[n + USB_FIFO_RX] == NULL)) { 533 ep = usb_dev_get_ep(udev, e, USB_FIFO_RX); 534 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_RX); 535 if (ep == NULL) { 536 DPRINTFN(5, "dev_get_endpoint returned NULL\n"); 537 return (EINVAL); 538 } 539 f = usb_fifo_alloc(&udev->device_mtx); 540 if (f == NULL) { 541 DPRINTFN(5, "could not alloc rx fifo\n"); 542 return (ENOMEM); 543 } 544 /* update some fields */ 545 f->fifo_index = n + USB_FIFO_RX; 546 f->dev_ep_index = e; 547 f->priv_sc0 = ep; 548 f->methods = &usb_ugen_methods; 549 f->iface_index = ep->iface_index; 550 f->udev = udev; 551 mtx_lock(&usb_ref_lock); 552 udev->fifo[n + USB_FIFO_RX] = f; 553 mtx_unlock(&usb_ref_lock); 554 } 555 if (is_tx) { 556 crd->txfifo = udev->fifo[n + USB_FIFO_TX]; 557 } 558 if (is_rx) { 559 crd->rxfifo = udev->fifo[n + USB_FIFO_RX]; 560 } 561 /* fill out fifo index */ 562 DPRINTFN(5, "fifo index = %d\n", n); 563 cpd->fifo_index = n; 564 565 /* complete */ 566 567 return (0); 568 } 569 570 void 571 usb_fifo_free(struct usb_fifo *f) 572 { 573 uint8_t n; 574 575 if (f == NULL) { 576 /* be NULL safe */ 577 return; 578 } 579 /* destroy symlink devices, if any */ 580 for (n = 0; n != 2; n++) { 581 if (f->symlink[n]) { 582 usb_free_symlink(f->symlink[n]); 583 f->symlink[n] = NULL; 584 } 585 } 586 mtx_lock(&usb_ref_lock); 587 588 /* delink ourselves to stop calls from userland */ 589 if ((f->fifo_index < USB_FIFO_MAX) && 590 (f->udev != NULL) && 591 (f->udev->fifo[f->fifo_index] == f)) { 592 f->udev->fifo[f->fifo_index] = NULL; 593 } else { 594 DPRINTFN(0, "USB FIFO %p has not been linked\n", f); 595 } 596 597 /* decrease refcount */ 598 f->refcount--; 599 /* need to wait until all callers have exited */ 600 while (f->refcount != 0) { 601 mtx_unlock(&usb_ref_lock); /* avoid LOR */ 602 mtx_lock(f->priv_mtx); 603 /* prevent write flush, if any */ 604 f->flag_iserror = 1; 605 /* get I/O thread out of any sleep state */ 606 if (f->flag_sleeping) { 607 f->flag_sleeping = 0; 608 cv_broadcast(&f->cv_io); 609 } 610 mtx_unlock(f->priv_mtx); 611 mtx_lock(&usb_ref_lock); 612 613 /* 614 * Check if the "f->refcount" variable reached zero 615 * during the unlocked time before entering wait: 616 */ 617 if (f->refcount == 0) 618 break; 619 620 /* wait for sync */ 621 cv_wait(&f->cv_drain, &usb_ref_lock); 622 } 623 mtx_unlock(&usb_ref_lock); 624 625 /* take care of closing the device here, if any */ 626 usb_fifo_close(f, 0); 627 628 cv_destroy(&f->cv_io); 629 cv_destroy(&f->cv_drain); 630 sx_destroy(&f->fs_fastpath_lock); 631 632 knlist_clear(&f->selinfo.si_note, 0); 633 seldrain(&f->selinfo); 634 knlist_destroy(&f->selinfo.si_note); 635 636 free(f, M_USBDEV); 637 } 638 639 static struct usb_endpoint * 640 usb_dev_get_ep(struct usb_device *udev, uint8_t ep_index, uint8_t dir) 641 { 642 struct usb_endpoint *ep; 643 uint8_t ep_dir; 644 645 if (ep_index == 0) { 646 ep = &udev->ctrl_ep; 647 } else { 648 if (dir == USB_FIFO_RX) { 649 if (udev->flags.usb_mode == USB_MODE_HOST) { 650 ep_dir = UE_DIR_IN; 651 } else { 652 ep_dir = UE_DIR_OUT; 653 } 654 } else { 655 if (udev->flags.usb_mode == USB_MODE_HOST) { 656 ep_dir = UE_DIR_OUT; 657 } else { 658 ep_dir = UE_DIR_IN; 659 } 660 } 661 ep = usbd_get_ep_by_addr(udev, ep_index | ep_dir); 662 } 663 664 if (ep == NULL) { 665 /* if the endpoint does not exist then return */ 666 return (NULL); 667 } 668 if (ep->edesc == NULL) { 669 /* invalid endpoint */ 670 return (NULL); 671 } 672 return (ep); /* success */ 673 } 674 675 /*------------------------------------------------------------------------* 676 * usb_fifo_open 677 * 678 * Returns: 679 * 0: Success 680 * Else: Failure 681 *------------------------------------------------------------------------*/ 682 static int 683 usb_fifo_open(struct usb_cdev_privdata *cpd, 684 struct usb_fifo *f, int fflags) 685 { 686 int err; 687 688 if (f == NULL) { 689 /* no FIFO there */ 690 DPRINTFN(2, "no FIFO\n"); 691 return (ENXIO); 692 } 693 /* remove FWRITE and FREAD flags */ 694 fflags &= ~(FWRITE | FREAD); 695 696 /* set correct file flags */ 697 if ((f->fifo_index & 1) == USB_FIFO_TX) { 698 fflags |= FWRITE; 699 } else { 700 fflags |= FREAD; 701 } 702 703 /* check if we are already opened */ 704 /* we don't need any locks when checking this variable */ 705 if (f->curr_cpd != NULL) { 706 err = EBUSY; 707 goto done; 708 } 709 710 /* reset short flag before open */ 711 f->flag_short = 0; 712 713 /* call open method */ 714 err = (f->methods->f_open) (f, fflags); 715 if (err) { 716 goto done; 717 } 718 mtx_lock(f->priv_mtx); 719 720 /* reset sleep flag */ 721 f->flag_sleeping = 0; 722 723 /* reset error flag */ 724 f->flag_iserror = 0; 725 726 /* reset complete flag */ 727 f->flag_iscomplete = 0; 728 729 /* reset select flag */ 730 f->flag_isselect = 0; 731 732 /* reset flushing flag */ 733 f->flag_flushing = 0; 734 735 /* reset ASYNC proc flag */ 736 f->async_p = NULL; 737 738 mtx_lock(&usb_ref_lock); 739 /* flag the fifo as opened to prevent others */ 740 f->curr_cpd = cpd; 741 mtx_unlock(&usb_ref_lock); 742 743 /* reset queue */ 744 usb_fifo_reset(f); 745 746 mtx_unlock(f->priv_mtx); 747 done: 748 return (err); 749 } 750 751 /*------------------------------------------------------------------------* 752 * usb_fifo_reset 753 *------------------------------------------------------------------------*/ 754 void 755 usb_fifo_reset(struct usb_fifo *f) 756 { 757 struct usb_mbuf *m; 758 759 if (f == NULL) { 760 return; 761 } 762 while (1) { 763 USB_IF_DEQUEUE(&f->used_q, m); 764 if (m) { 765 USB_IF_ENQUEUE(&f->free_q, m); 766 } else { 767 break; 768 } 769 } 770 /* reset have fragment flag */ 771 f->flag_have_fragment = 0; 772 } 773 774 /*------------------------------------------------------------------------* 775 * usb_fifo_close 776 *------------------------------------------------------------------------*/ 777 static void 778 usb_fifo_close(struct usb_fifo *f, int fflags) 779 { 780 int err; 781 782 /* check if we are not opened */ 783 if (f->curr_cpd == NULL) { 784 /* nothing to do - already closed */ 785 return; 786 } 787 mtx_lock(f->priv_mtx); 788 789 /* clear current cdev private data pointer */ 790 mtx_lock(&usb_ref_lock); 791 f->curr_cpd = NULL; 792 mtx_unlock(&usb_ref_lock); 793 794 /* check if we are watched by kevent */ 795 KNOTE_LOCKED(&f->selinfo.si_note, 0); 796 797 /* check if we are selected */ 798 if (f->flag_isselect) { 799 selwakeup(&f->selinfo); 800 f->flag_isselect = 0; 801 } 802 /* check if a thread wants SIGIO */ 803 if (f->async_p != NULL) { 804 PROC_LOCK(f->async_p); 805 kern_psignal(f->async_p, SIGIO); 806 PROC_UNLOCK(f->async_p); 807 f->async_p = NULL; 808 } 809 /* remove FWRITE and FREAD flags */ 810 fflags &= ~(FWRITE | FREAD); 811 812 /* flush written data, if any */ 813 if ((f->fifo_index & 1) == USB_FIFO_TX) { 814 if (!f->flag_iserror) { 815 /* set flushing flag */ 816 f->flag_flushing = 1; 817 818 /* get the last packet in */ 819 if (f->flag_have_fragment) { 820 struct usb_mbuf *m; 821 f->flag_have_fragment = 0; 822 USB_IF_DEQUEUE(&f->free_q, m); 823 if (m) { 824 USB_IF_ENQUEUE(&f->used_q, m); 825 } 826 } 827 828 /* start write transfer, if not already started */ 829 (f->methods->f_start_write) (f); 830 831 /* check if flushed already */ 832 while (f->flag_flushing && 833 (!f->flag_iserror)) { 834 /* wait until all data has been written */ 835 f->flag_sleeping = 1; 836 err = cv_timedwait_sig(&f->cv_io, f->priv_mtx, 837 USB_MS_TO_TICKS(USB_DEFAULT_TIMEOUT)); 838 if (err) { 839 DPRINTF("signal received\n"); 840 break; 841 } 842 } 843 } 844 fflags |= FWRITE; 845 846 /* stop write transfer, if not already stopped */ 847 (f->methods->f_stop_write) (f); 848 } else { 849 fflags |= FREAD; 850 851 /* stop write transfer, if not already stopped */ 852 (f->methods->f_stop_read) (f); 853 } 854 855 /* check if we are sleeping */ 856 if (f->flag_sleeping) { 857 DPRINTFN(2, "Sleeping at close!\n"); 858 } 859 mtx_unlock(f->priv_mtx); 860 861 /* call close method */ 862 (f->methods->f_close) (f, fflags); 863 864 DPRINTF("closed\n"); 865 } 866 867 /*------------------------------------------------------------------------* 868 * usb_open - cdev callback 869 *------------------------------------------------------------------------*/ 870 static int 871 usb_open(struct cdev *dev, int fflags, int devtype, struct thread *td) 872 { 873 struct usb_fs_privdata* pd = (struct usb_fs_privdata*)dev->si_drv1; 874 struct usb_cdev_refdata refs; 875 struct usb_cdev_privdata *cpd; 876 int err; 877 878 DPRINTFN(2, "%s fflags=0x%08x\n", devtoname(dev), fflags); 879 880 KASSERT(fflags & (FREAD|FWRITE), ("invalid open flags")); 881 if (((fflags & FREAD) && !(pd->mode & FREAD)) || 882 ((fflags & FWRITE) && !(pd->mode & FWRITE))) { 883 DPRINTFN(2, "access mode not supported\n"); 884 return (EPERM); 885 } 886 887 cpd = malloc(sizeof(*cpd), M_USBDEV, M_WAITOK | M_ZERO); 888 889 usb_loc_fill(pd, cpd); 890 err = usb_ref_device(cpd, &refs, 1); 891 if (err) { 892 DPRINTFN(2, "cannot ref device\n"); 893 free(cpd, M_USBDEV); 894 return (ENXIO); 895 } 896 cpd->fflags = fflags; /* access mode for open lifetime */ 897 898 /* create FIFOs, if any */ 899 err = usb_fifo_create(cpd, &refs); 900 /* check for error */ 901 if (err) { 902 DPRINTFN(2, "cannot create fifo\n"); 903 usb_unref_device(cpd, &refs); 904 free(cpd, M_USBDEV); 905 return (err); 906 } 907 if (fflags & FREAD) { 908 err = usb_fifo_open(cpd, refs.rxfifo, fflags); 909 if (err) { 910 DPRINTFN(2, "read open failed\n"); 911 usb_unref_device(cpd, &refs); 912 free(cpd, M_USBDEV); 913 return (err); 914 } 915 } 916 if (fflags & FWRITE) { 917 err = usb_fifo_open(cpd, refs.txfifo, fflags); 918 if (err) { 919 DPRINTFN(2, "write open failed\n"); 920 if (fflags & FREAD) { 921 usb_fifo_close(refs.rxfifo, fflags); 922 } 923 usb_unref_device(cpd, &refs); 924 free(cpd, M_USBDEV); 925 return (err); 926 } 927 } 928 usb_unref_device(cpd, &refs); 929 devfs_set_cdevpriv(cpd, usb_close); 930 931 return (0); 932 } 933 934 /*------------------------------------------------------------------------* 935 * usb_close - cdev callback 936 *------------------------------------------------------------------------*/ 937 static void 938 usb_close(void *arg) 939 { 940 struct usb_cdev_refdata refs; 941 struct usb_cdev_privdata *cpd = arg; 942 int err; 943 944 DPRINTFN(2, "cpd=%p\n", cpd); 945 946 err = usb_ref_device(cpd, &refs, 947 2 /* uref and allow detached state */); 948 if (err) { 949 DPRINTFN(2, "Cannot grab USB reference when " 950 "closing USB file handle\n"); 951 goto done; 952 } 953 if (cpd->fflags & FREAD) { 954 usb_fifo_close(refs.rxfifo, cpd->fflags); 955 } 956 if (cpd->fflags & FWRITE) { 957 usb_fifo_close(refs.txfifo, cpd->fflags); 958 } 959 usb_unref_device(cpd, &refs); 960 done: 961 free(cpd, M_USBDEV); 962 } 963 964 static void 965 usb_dev_init(void *arg) 966 { 967 mtx_init(&usb_ref_lock, "USB ref mutex", NULL, MTX_DEF); 968 sx_init(&usb_sym_lock, "USB sym mutex"); 969 TAILQ_INIT(&usb_sym_head); 970 971 /* check the UGEN methods */ 972 usb_fifo_check_methods(&usb_ugen_methods); 973 } 974 975 SYSINIT(usb_dev_init, SI_SUB_KLD, SI_ORDER_FIRST, usb_dev_init, NULL); 976 977 static void 978 usb_dev_init_post(void *arg) 979 { 980 /* 981 * Create /dev/usb - this is needed for usbconfig(8), which 982 * needs a well-known device name to access. 983 */ 984 usb_dev = make_dev(&usb_static_devsw, 0, UID_ROOT, GID_OPERATOR, 985 0644, USB_DEVICE_NAME); 986 if (usb_dev == NULL) { 987 DPRINTFN(0, "Could not create usb bus device\n"); 988 } 989 } 990 991 SYSINIT(usb_dev_init_post, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, usb_dev_init_post, NULL); 992 993 static void 994 usb_dev_uninit(void *arg) 995 { 996 if (usb_dev != NULL) { 997 destroy_dev(usb_dev); 998 usb_dev = NULL; 999 } 1000 mtx_destroy(&usb_ref_lock); 1001 sx_destroy(&usb_sym_lock); 1002 } 1003 1004 SYSUNINIT(usb_dev_uninit, SI_SUB_KICK_SCHEDULER, SI_ORDER_ANY, usb_dev_uninit, NULL); 1005 1006 static int 1007 usb_ioctl_f_sub(struct usb_fifo *f, u_long cmd, void *addr, 1008 struct thread *td) 1009 { 1010 int error = 0; 1011 1012 switch (cmd) { 1013 case FIODTYPE: 1014 *(int *)addr = 0; /* character device */ 1015 break; 1016 1017 case FIONBIO: 1018 /* handled by upper FS layer */ 1019 break; 1020 1021 case FIOASYNC: 1022 if (*(int *)addr) { 1023 if (f->async_p != NULL) { 1024 error = EBUSY; 1025 break; 1026 } 1027 f->async_p = USB_TD_GET_PROC(td); 1028 } else { 1029 f->async_p = NULL; 1030 } 1031 break; 1032 1033 /* XXX this is not the most general solution */ 1034 case TIOCSPGRP: 1035 if (f->async_p == NULL) { 1036 error = EINVAL; 1037 break; 1038 } 1039 if (*(int *)addr != USB_PROC_GET_GID(f->async_p)) { 1040 error = EPERM; 1041 break; 1042 } 1043 break; 1044 default: 1045 return (ENOIOCTL); 1046 } 1047 DPRINTFN(3, "cmd 0x%lx = %d\n", cmd, error); 1048 return (error); 1049 } 1050 1051 /*------------------------------------------------------------------------* 1052 * usb_ioctl - cdev callback 1053 *------------------------------------------------------------------------*/ 1054 static int 1055 usb_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int fflag, struct thread* td) 1056 { 1057 struct usb_cdev_refdata refs; 1058 struct usb_cdev_privdata* cpd; 1059 struct usb_fifo *f; 1060 int fflags; 1061 int err; 1062 1063 DPRINTFN(2, "cmd=0x%lx\n", cmd); 1064 1065 err = devfs_get_cdevpriv((void **)&cpd); 1066 if (err != 0) 1067 return (err); 1068 1069 /* 1070 * Performance optimisation: We try to check for IOCTL's that 1071 * don't need the USB reference first. Then we grab the USB 1072 * reference if we need it! 1073 */ 1074 err = usb_ref_device(cpd, &refs, 0 /* no uref */ ); 1075 if (err) 1076 return (ENXIO); 1077 1078 fflags = cpd->fflags; 1079 1080 f = NULL; /* set default value */ 1081 err = ENOIOCTL; /* set default value */ 1082 1083 if (fflags & FWRITE) { 1084 f = refs.txfifo; 1085 err = usb_ioctl_f_sub(f, cmd, addr, td); 1086 } 1087 if (fflags & FREAD) { 1088 f = refs.rxfifo; 1089 err = usb_ioctl_f_sub(f, cmd, addr, td); 1090 } 1091 KASSERT(f != NULL, ("fifo not found")); 1092 if (err != ENOIOCTL) 1093 goto done; 1094 1095 err = (f->methods->f_ioctl) (f, cmd, addr, fflags); 1096 1097 DPRINTFN(2, "f_ioctl cmd 0x%lx = %d\n", cmd, err); 1098 1099 if (err != ENOIOCTL) 1100 goto done; 1101 1102 if (usb_usb_ref_device(cpd, &refs)) { 1103 /* we lost the reference */ 1104 return (ENXIO); 1105 } 1106 1107 err = (f->methods->f_ioctl_post) (f, cmd, addr, fflags); 1108 1109 DPRINTFN(2, "f_ioctl_post cmd 0x%lx = %d\n", cmd, err); 1110 1111 if (err == ENOIOCTL) 1112 err = ENOTTY; 1113 1114 if (err) 1115 goto done; 1116 1117 /* Wait for re-enumeration, if any */ 1118 1119 while (f->udev->re_enumerate_wait != USB_RE_ENUM_DONE) { 1120 usb_unref_device(cpd, &refs); 1121 1122 usb_pause_mtx(NULL, hz / 128); 1123 1124 while (usb_ref_device(cpd, &refs, 1 /* need uref */)) { 1125 if (usb_ref_device(cpd, &refs, 0)) { 1126 /* device no longer exists */ 1127 return (ENXIO); 1128 } 1129 usb_unref_device(cpd, &refs); 1130 usb_pause_mtx(NULL, hz / 128); 1131 } 1132 } 1133 1134 done: 1135 usb_unref_device(cpd, &refs); 1136 return (err); 1137 } 1138 1139 static void 1140 usb_filter_detach(struct knote *kn) 1141 { 1142 struct usb_fifo *f = kn->kn_hook; 1143 knlist_remove(&f->selinfo.si_note, kn, 0); 1144 } 1145 1146 static int 1147 usb_filter_write(struct knote *kn, long hint) 1148 { 1149 struct usb_cdev_privdata* cpd; 1150 struct usb_fifo *f; 1151 struct usb_mbuf *m; 1152 1153 DPRINTFN(2, "\n"); 1154 1155 f = kn->kn_hook; 1156 1157 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED); 1158 1159 cpd = f->curr_cpd; 1160 if (cpd == NULL) { 1161 m = (void *)1; 1162 } else if (f->fs_ep_max == 0) { 1163 if (f->flag_iserror) { 1164 /* we got an error */ 1165 m = (void *)1; 1166 } else { 1167 if (f->queue_data == NULL) { 1168 /* 1169 * start write transfer, if not 1170 * already started 1171 */ 1172 (f->methods->f_start_write) (f); 1173 } 1174 /* check if any packets are available */ 1175 USB_IF_POLL(&f->free_q, m); 1176 } 1177 } else { 1178 if (f->flag_iscomplete) { 1179 m = (void *)1; 1180 } else { 1181 m = NULL; 1182 } 1183 } 1184 return (m ? 1 : 0); 1185 } 1186 1187 static int 1188 usb_filter_read(struct knote *kn, long hint) 1189 { 1190 struct usb_cdev_privdata* cpd; 1191 struct usb_fifo *f; 1192 struct usb_mbuf *m; 1193 1194 DPRINTFN(2, "\n"); 1195 1196 f = kn->kn_hook; 1197 1198 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED); 1199 1200 cpd = f->curr_cpd; 1201 if (cpd == NULL) { 1202 m = (void *)1; 1203 } else if (f->fs_ep_max == 0) { 1204 if (f->flag_iserror) { 1205 /* we have an error */ 1206 m = (void *)1; 1207 } else { 1208 if (f->queue_data == NULL) { 1209 /* 1210 * start read transfer, if not 1211 * already started 1212 */ 1213 (f->methods->f_start_read) (f); 1214 } 1215 /* check if any packets are available */ 1216 USB_IF_POLL(&f->used_q, m); 1217 1218 /* start reading data, if any */ 1219 if (m == NULL) 1220 (f->methods->f_start_read) (f); 1221 } 1222 } else { 1223 if (f->flag_iscomplete) { 1224 m = (void *)1; 1225 } else { 1226 m = NULL; 1227 } 1228 } 1229 return (m ? 1 : 0); 1230 } 1231 1232 static struct filterops usb_filtops_write = { 1233 .f_isfd = 1, 1234 .f_detach = usb_filter_detach, 1235 .f_event = usb_filter_write, 1236 }; 1237 1238 static struct filterops usb_filtops_read = { 1239 .f_isfd = 1, 1240 .f_detach = usb_filter_detach, 1241 .f_event = usb_filter_read, 1242 }; 1243 1244 /* ARGSUSED */ 1245 static int 1246 usb_kqfilter(struct cdev* dev, struct knote *kn) 1247 { 1248 struct usb_cdev_refdata refs; 1249 struct usb_cdev_privdata* cpd; 1250 struct usb_fifo *f; 1251 int fflags; 1252 int err = EINVAL; 1253 1254 DPRINTFN(2, "\n"); 1255 1256 if (devfs_get_cdevpriv((void **)&cpd) != 0 || 1257 usb_ref_device(cpd, &refs, 0) != 0) 1258 return (ENXIO); 1259 1260 fflags = cpd->fflags; 1261 1262 /* Figure out who needs service */ 1263 switch (kn->kn_filter) { 1264 case EVFILT_WRITE: 1265 if (fflags & FWRITE) { 1266 f = refs.txfifo; 1267 kn->kn_fop = &usb_filtops_write; 1268 err = 0; 1269 } 1270 break; 1271 case EVFILT_READ: 1272 if (fflags & FREAD) { 1273 f = refs.rxfifo; 1274 kn->kn_fop = &usb_filtops_read; 1275 err = 0; 1276 } 1277 break; 1278 default: 1279 err = EOPNOTSUPP; 1280 break; 1281 } 1282 1283 if (err == 0) { 1284 kn->kn_hook = f; 1285 mtx_lock(f->priv_mtx); 1286 knlist_add(&f->selinfo.si_note, kn, 1); 1287 mtx_unlock(f->priv_mtx); 1288 } 1289 1290 usb_unref_device(cpd, &refs); 1291 return (err); 1292 } 1293 1294 /* ARGSUSED */ 1295 static int 1296 usb_poll(struct cdev* dev, int events, struct thread* td) 1297 { 1298 struct usb_cdev_refdata refs; 1299 struct usb_cdev_privdata* cpd; 1300 struct usb_fifo *f; 1301 struct usb_mbuf *m; 1302 int fflags, revents; 1303 1304 if (devfs_get_cdevpriv((void **)&cpd) != 0 || 1305 usb_ref_device(cpd, &refs, 0) != 0) 1306 return (events & 1307 (POLLHUP|POLLIN|POLLRDNORM|POLLOUT|POLLWRNORM)); 1308 1309 fflags = cpd->fflags; 1310 1311 /* Figure out who needs service */ 1312 revents = 0; 1313 if ((events & (POLLOUT | POLLWRNORM)) && 1314 (fflags & FWRITE)) { 1315 f = refs.txfifo; 1316 1317 mtx_lock(f->priv_mtx); 1318 1319 if (!refs.is_usbfs) { 1320 if (f->flag_iserror) { 1321 /* we got an error */ 1322 m = (void *)1; 1323 } else { 1324 if (f->queue_data == NULL) { 1325 /* 1326 * start write transfer, if not 1327 * already started 1328 */ 1329 (f->methods->f_start_write) (f); 1330 } 1331 /* check if any packets are available */ 1332 USB_IF_POLL(&f->free_q, m); 1333 } 1334 } else { 1335 if (f->flag_iscomplete) { 1336 m = (void *)1; 1337 } else { 1338 m = NULL; 1339 } 1340 } 1341 1342 if (m) { 1343 revents |= events & (POLLOUT | POLLWRNORM); 1344 } else { 1345 f->flag_isselect = 1; 1346 selrecord(td, &f->selinfo); 1347 } 1348 1349 mtx_unlock(f->priv_mtx); 1350 } 1351 if ((events & (POLLIN | POLLRDNORM)) && 1352 (fflags & FREAD)) { 1353 f = refs.rxfifo; 1354 1355 mtx_lock(f->priv_mtx); 1356 1357 if (!refs.is_usbfs) { 1358 if (f->flag_iserror) { 1359 /* we have an error */ 1360 m = (void *)1; 1361 } else { 1362 if (f->queue_data == NULL) { 1363 /* 1364 * start read transfer, if not 1365 * already started 1366 */ 1367 (f->methods->f_start_read) (f); 1368 } 1369 /* check if any packets are available */ 1370 USB_IF_POLL(&f->used_q, m); 1371 } 1372 } else { 1373 if (f->flag_iscomplete) { 1374 m = (void *)1; 1375 } else { 1376 m = NULL; 1377 } 1378 } 1379 1380 if (m) { 1381 revents |= events & (POLLIN | POLLRDNORM); 1382 } else { 1383 f->flag_isselect = 1; 1384 selrecord(td, &f->selinfo); 1385 1386 if (!refs.is_usbfs) { 1387 /* start reading data */ 1388 (f->methods->f_start_read) (f); 1389 } 1390 } 1391 1392 mtx_unlock(f->priv_mtx); 1393 } 1394 usb_unref_device(cpd, &refs); 1395 return (revents); 1396 } 1397 1398 static int 1399 usb_read(struct cdev *dev, struct uio *uio, int ioflag) 1400 { 1401 struct usb_cdev_refdata refs; 1402 struct usb_cdev_privdata* cpd; 1403 struct usb_fifo *f; 1404 struct usb_mbuf *m; 1405 int io_len; 1406 int err; 1407 uint8_t tr_data = 0; 1408 1409 err = devfs_get_cdevpriv((void **)&cpd); 1410 if (err != 0) 1411 return (err); 1412 1413 err = usb_ref_device(cpd, &refs, 0 /* no uref */ ); 1414 if (err) 1415 return (ENXIO); 1416 1417 f = refs.rxfifo; 1418 if (f == NULL) { 1419 /* should not happen */ 1420 usb_unref_device(cpd, &refs); 1421 return (EPERM); 1422 } 1423 1424 mtx_lock(f->priv_mtx); 1425 1426 /* check for permanent read error */ 1427 if (f->flag_iserror) { 1428 err = EIO; 1429 goto done; 1430 } 1431 /* check if USB-FS interface is active */ 1432 if (refs.is_usbfs) { 1433 /* 1434 * The queue is used for events that should be 1435 * retrieved using the "USB_FS_COMPLETE" ioctl. 1436 */ 1437 err = EINVAL; 1438 goto done; 1439 } 1440 while (uio->uio_resid > 0) { 1441 USB_IF_DEQUEUE(&f->used_q, m); 1442 1443 if (m == NULL) { 1444 /* start read transfer, if not already started */ 1445 1446 (f->methods->f_start_read) (f); 1447 1448 if (ioflag & IO_NDELAY) { 1449 if (tr_data) { 1450 /* return length before error */ 1451 break; 1452 } 1453 err = EWOULDBLOCK; 1454 break; 1455 } 1456 DPRINTF("sleeping\n"); 1457 1458 err = usb_fifo_wait(f); 1459 if (err) { 1460 break; 1461 } 1462 continue; 1463 } 1464 if (f->methods->f_filter_read) { 1465 /* 1466 * Sometimes it is convenient to process data at the 1467 * expense of a userland process instead of a kernel 1468 * process. 1469 */ 1470 (f->methods->f_filter_read) (f, m); 1471 } 1472 tr_data = 1; 1473 1474 io_len = MIN(m->cur_data_len, uio->uio_resid); 1475 1476 DPRINTFN(2, "transfer %d bytes from %p\n", 1477 io_len, m->cur_data_ptr); 1478 1479 err = usb_fifo_uiomove(f, 1480 m->cur_data_ptr, io_len, uio); 1481 1482 m->cur_data_len -= io_len; 1483 m->cur_data_ptr += io_len; 1484 1485 if (m->cur_data_len == 0) { 1486 uint8_t last_packet; 1487 1488 last_packet = m->last_packet; 1489 1490 USB_IF_ENQUEUE(&f->free_q, m); 1491 1492 if (last_packet) { 1493 /* keep framing */ 1494 break; 1495 } 1496 } else { 1497 USB_IF_PREPEND(&f->used_q, m); 1498 } 1499 1500 if (err) { 1501 break; 1502 } 1503 } 1504 done: 1505 mtx_unlock(f->priv_mtx); 1506 1507 usb_unref_device(cpd, &refs); 1508 1509 return (err); 1510 } 1511 1512 static int 1513 usb_write(struct cdev *dev, struct uio *uio, int ioflag) 1514 { 1515 struct usb_cdev_refdata refs; 1516 struct usb_cdev_privdata* cpd; 1517 struct usb_fifo *f; 1518 struct usb_mbuf *m; 1519 uint8_t *pdata; 1520 int io_len; 1521 int err; 1522 uint8_t tr_data = 0; 1523 1524 DPRINTFN(2, "\n"); 1525 1526 err = devfs_get_cdevpriv((void **)&cpd); 1527 if (err != 0) 1528 return (err); 1529 1530 err = usb_ref_device(cpd, &refs, 0 /* no uref */ ); 1531 if (err) 1532 return (ENXIO); 1533 1534 f = refs.txfifo; 1535 if (f == NULL) { 1536 /* should not happen */ 1537 usb_unref_device(cpd, &refs); 1538 return (EPERM); 1539 } 1540 1541 mtx_lock(f->priv_mtx); 1542 1543 /* check for permanent write error */ 1544 if (f->flag_iserror) { 1545 err = EIO; 1546 goto done; 1547 } 1548 /* check if USB-FS interface is active */ 1549 if (refs.is_usbfs) { 1550 /* 1551 * The queue is used for events that should be 1552 * retrieved using the "USB_FS_COMPLETE" ioctl. 1553 */ 1554 err = EINVAL; 1555 goto done; 1556 } 1557 if (f->queue_data == NULL) { 1558 /* start write transfer, if not already started */ 1559 (f->methods->f_start_write) (f); 1560 } 1561 /* we allow writing zero length data */ 1562 do { 1563 USB_IF_DEQUEUE(&f->free_q, m); 1564 1565 if (m == NULL) { 1566 if (ioflag & IO_NDELAY) { 1567 if (tr_data) { 1568 /* return length before error */ 1569 break; 1570 } 1571 err = EWOULDBLOCK; 1572 break; 1573 } 1574 DPRINTF("sleeping\n"); 1575 1576 err = usb_fifo_wait(f); 1577 if (err) { 1578 break; 1579 } 1580 continue; 1581 } 1582 tr_data = 1; 1583 1584 if (f->flag_have_fragment == 0) { 1585 USB_MBUF_RESET(m); 1586 io_len = m->cur_data_len; 1587 pdata = m->cur_data_ptr; 1588 if (io_len > uio->uio_resid) 1589 io_len = uio->uio_resid; 1590 m->cur_data_len = io_len; 1591 } else { 1592 io_len = m->max_data_len - m->cur_data_len; 1593 pdata = m->cur_data_ptr + m->cur_data_len; 1594 if (io_len > uio->uio_resid) 1595 io_len = uio->uio_resid; 1596 m->cur_data_len += io_len; 1597 } 1598 1599 DPRINTFN(2, "transfer %d bytes to %p\n", 1600 io_len, pdata); 1601 1602 err = usb_fifo_uiomove(f, pdata, io_len, uio); 1603 1604 if (err) { 1605 f->flag_have_fragment = 0; 1606 USB_IF_ENQUEUE(&f->free_q, m); 1607 break; 1608 } 1609 1610 /* check if the buffer is ready to be transmitted */ 1611 1612 if ((f->flag_write_defrag == 0) || 1613 (m->cur_data_len == m->max_data_len)) { 1614 f->flag_have_fragment = 0; 1615 1616 /* 1617 * Check for write filter: 1618 * 1619 * Sometimes it is convenient to process data 1620 * at the expense of a userland process 1621 * instead of a kernel process. 1622 */ 1623 if (f->methods->f_filter_write) { 1624 (f->methods->f_filter_write) (f, m); 1625 } 1626 1627 /* Put USB mbuf in the used queue */ 1628 USB_IF_ENQUEUE(&f->used_q, m); 1629 1630 /* Start writing data, if not already started */ 1631 (f->methods->f_start_write) (f); 1632 } else { 1633 /* Wait for more data or close */ 1634 f->flag_have_fragment = 1; 1635 USB_IF_PREPEND(&f->free_q, m); 1636 } 1637 1638 } while (uio->uio_resid > 0); 1639 done: 1640 mtx_unlock(f->priv_mtx); 1641 1642 usb_unref_device(cpd, &refs); 1643 1644 return (err); 1645 } 1646 1647 int 1648 usb_static_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, 1649 struct thread *td) 1650 { 1651 union { 1652 struct usb_read_dir *urd; 1653 #ifdef COMPAT_FREEBSD32 1654 struct usb_read_dir32 *urd32; 1655 #endif 1656 void* data; 1657 } u; 1658 int err; 1659 1660 u.data = data; 1661 switch (cmd) { 1662 case USB_READ_DIR: 1663 err = usb_read_symlink(u.urd->urd_data, 1664 u.urd->urd_startentry, u.urd->urd_maxlen); 1665 break; 1666 #ifdef COMPAT_FREEBSD32 1667 case USB_READ_DIR32: 1668 err = usb_read_symlink(PTRIN(u.urd32->urd_data), 1669 u.urd32->urd_startentry, u.urd32->urd_maxlen); 1670 break; 1671 #endif 1672 case USB_DEV_QUIRK_GET: 1673 case USB_QUIRK_NAME_GET: 1674 case USB_DEV_QUIRK_ADD: 1675 case USB_DEV_QUIRK_REMOVE: 1676 err = usb_quirk_ioctl_p(cmd, data, fflag, td); 1677 break; 1678 case USB_GET_TEMPLATE: 1679 *(int *)data = usb_template; 1680 err = 0; 1681 break; 1682 case USB_SET_TEMPLATE: 1683 err = priv_check(curthread, PRIV_DRIVER); 1684 if (err) 1685 break; 1686 usb_template = *(int *)data; 1687 break; 1688 default: 1689 err = ENOTTY; 1690 break; 1691 } 1692 return (err); 1693 } 1694 1695 static int 1696 usb_fifo_uiomove(struct usb_fifo *f, void *cp, 1697 int n, struct uio *uio) 1698 { 1699 int error; 1700 1701 mtx_unlock(f->priv_mtx); 1702 1703 /* 1704 * "uiomove()" can sleep so one needs to make a wrapper, 1705 * exiting the mutex and checking things: 1706 */ 1707 error = uiomove(cp, n, uio); 1708 1709 mtx_lock(f->priv_mtx); 1710 1711 return (error); 1712 } 1713 1714 int 1715 usb_fifo_wait(struct usb_fifo *f) 1716 { 1717 int err; 1718 1719 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED); 1720 1721 if (f->flag_iserror) { 1722 /* we are gone */ 1723 return (EIO); 1724 } 1725 f->flag_sleeping = 1; 1726 1727 err = cv_wait_sig(&f->cv_io, f->priv_mtx); 1728 1729 if (f->flag_iserror) { 1730 /* we are gone */ 1731 err = EIO; 1732 } 1733 return (err); 1734 } 1735 1736 void 1737 usb_fifo_signal(struct usb_fifo *f) 1738 { 1739 if (f->flag_sleeping) { 1740 f->flag_sleeping = 0; 1741 cv_broadcast(&f->cv_io); 1742 } 1743 } 1744 1745 void 1746 usb_fifo_wakeup(struct usb_fifo *f) 1747 { 1748 usb_fifo_signal(f); 1749 1750 KNOTE_LOCKED(&f->selinfo.si_note, 0); 1751 1752 if (f->flag_isselect) { 1753 selwakeup(&f->selinfo); 1754 f->flag_isselect = 0; 1755 } 1756 if (f->async_p != NULL) { 1757 PROC_LOCK(f->async_p); 1758 kern_psignal(f->async_p, SIGIO); 1759 PROC_UNLOCK(f->async_p); 1760 } 1761 } 1762 1763 static int 1764 usb_fifo_dummy_open(struct usb_fifo *fifo, int fflags) 1765 { 1766 return (0); 1767 } 1768 1769 static void 1770 usb_fifo_dummy_close(struct usb_fifo *fifo, int fflags) 1771 { 1772 return; 1773 } 1774 1775 static int 1776 usb_fifo_dummy_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags) 1777 { 1778 return (ENOIOCTL); 1779 } 1780 1781 static void 1782 usb_fifo_dummy_cmd(struct usb_fifo *fifo) 1783 { 1784 fifo->flag_flushing = 0; /* not flushing */ 1785 } 1786 1787 static void 1788 usb_fifo_check_methods(struct usb_fifo_methods *pm) 1789 { 1790 /* check that all callback functions are OK */ 1791 1792 if (pm->f_open == NULL) 1793 pm->f_open = &usb_fifo_dummy_open; 1794 1795 if (pm->f_close == NULL) 1796 pm->f_close = &usb_fifo_dummy_close; 1797 1798 if (pm->f_ioctl == NULL) 1799 pm->f_ioctl = &usb_fifo_dummy_ioctl; 1800 1801 if (pm->f_ioctl_post == NULL) 1802 pm->f_ioctl_post = &usb_fifo_dummy_ioctl; 1803 1804 if (pm->f_start_read == NULL) 1805 pm->f_start_read = &usb_fifo_dummy_cmd; 1806 1807 if (pm->f_stop_read == NULL) 1808 pm->f_stop_read = &usb_fifo_dummy_cmd; 1809 1810 if (pm->f_start_write == NULL) 1811 pm->f_start_write = &usb_fifo_dummy_cmd; 1812 1813 if (pm->f_stop_write == NULL) 1814 pm->f_stop_write = &usb_fifo_dummy_cmd; 1815 } 1816 1817 /*------------------------------------------------------------------------* 1818 * usb_fifo_attach 1819 * 1820 * The following function will create a duplex FIFO. 1821 * 1822 * Return values: 1823 * 0: Success. 1824 * Else: Failure. 1825 *------------------------------------------------------------------------*/ 1826 int 1827 usb_fifo_attach(struct usb_device *udev, void *priv_sc, 1828 struct mtx *priv_mtx, struct usb_fifo_methods *pm, 1829 struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit, 1830 uint8_t iface_index, uid_t uid, gid_t gid, int mode) 1831 { 1832 struct usb_fifo *f_tx; 1833 struct usb_fifo *f_rx; 1834 char devname[32]; 1835 uint8_t n; 1836 1837 f_sc->fp[USB_FIFO_TX] = NULL; 1838 f_sc->fp[USB_FIFO_RX] = NULL; 1839 1840 if (pm == NULL) 1841 return (EINVAL); 1842 1843 /* check the methods */ 1844 usb_fifo_check_methods(pm); 1845 1846 if (priv_mtx == NULL) 1847 priv_mtx = &Giant; 1848 1849 /* search for a free FIFO slot */ 1850 for (n = 0;; n += 2) { 1851 if (n == USB_FIFO_MAX) { 1852 /* end of FIFOs reached */ 1853 return (ENOMEM); 1854 } 1855 /* Check for TX FIFO */ 1856 if (udev->fifo[n + USB_FIFO_TX] != NULL) { 1857 continue; 1858 } 1859 /* Check for RX FIFO */ 1860 if (udev->fifo[n + USB_FIFO_RX] != NULL) { 1861 continue; 1862 } 1863 break; 1864 } 1865 1866 f_tx = usb_fifo_alloc(priv_mtx); 1867 f_rx = usb_fifo_alloc(priv_mtx); 1868 1869 if ((f_tx == NULL) || (f_rx == NULL)) { 1870 usb_fifo_free(f_tx); 1871 usb_fifo_free(f_rx); 1872 return (ENOMEM); 1873 } 1874 /* initialise FIFO structures */ 1875 1876 f_tx->fifo_index = n + USB_FIFO_TX; 1877 f_tx->dev_ep_index = -1; 1878 f_tx->priv_sc0 = priv_sc; 1879 f_tx->methods = pm; 1880 f_tx->iface_index = iface_index; 1881 f_tx->udev = udev; 1882 1883 f_rx->fifo_index = n + USB_FIFO_RX; 1884 f_rx->dev_ep_index = -1; 1885 f_rx->priv_sc0 = priv_sc; 1886 f_rx->methods = pm; 1887 f_rx->iface_index = iface_index; 1888 f_rx->udev = udev; 1889 1890 f_sc->fp[USB_FIFO_TX] = f_tx; 1891 f_sc->fp[USB_FIFO_RX] = f_rx; 1892 1893 mtx_lock(&usb_ref_lock); 1894 udev->fifo[f_tx->fifo_index] = f_tx; 1895 udev->fifo[f_rx->fifo_index] = f_rx; 1896 mtx_unlock(&usb_ref_lock); 1897 1898 for (n = 0; n != 4; n++) { 1899 if (pm->basename[n] == NULL) { 1900 continue; 1901 } 1902 if (subunit < 0) { 1903 if (snprintf(devname, sizeof(devname), 1904 "%s%u%s", pm->basename[n], 1905 unit, pm->postfix[n] ? 1906 pm->postfix[n] : "")) { 1907 /* ignore */ 1908 } 1909 } else { 1910 if (snprintf(devname, sizeof(devname), 1911 "%s%u.%d%s", pm->basename[n], 1912 unit, subunit, pm->postfix[n] ? 1913 pm->postfix[n] : "")) { 1914 /* ignore */ 1915 } 1916 } 1917 1918 /* 1919 * Distribute the symbolic links into two FIFO structures: 1920 */ 1921 if (n & 1) { 1922 f_rx->symlink[n / 2] = 1923 usb_alloc_symlink(devname); 1924 } else { 1925 f_tx->symlink[n / 2] = 1926 usb_alloc_symlink(devname); 1927 } 1928 1929 /* Create the device */ 1930 f_sc->dev = usb_make_dev(udev, devname, -1, 1931 f_tx->fifo_index & f_rx->fifo_index, 1932 FREAD|FWRITE, uid, gid, mode); 1933 } 1934 1935 DPRINTFN(2, "attached %p/%p\n", f_tx, f_rx); 1936 return (0); 1937 } 1938 1939 /*------------------------------------------------------------------------* 1940 * usb_fifo_alloc_buffer 1941 * 1942 * Return values: 1943 * 0: Success 1944 * Else failure 1945 *------------------------------------------------------------------------*/ 1946 int 1947 usb_fifo_alloc_buffer(struct usb_fifo *f, usb_size_t bufsize, 1948 uint16_t nbuf) 1949 { 1950 struct usb_ifqueue temp_q = {}; 1951 void *queue_data; 1952 1953 usb_fifo_free_buffer(f); 1954 1955 temp_q.ifq_maxlen = nbuf; 1956 1957 queue_data = usb_alloc_mbufs( 1958 M_USBDEV, &temp_q, bufsize, nbuf); 1959 1960 if (queue_data == NULL && bufsize != 0 && nbuf != 0) 1961 return (ENOMEM); 1962 1963 mtx_lock(f->priv_mtx); 1964 1965 /* 1966 * Setup queues and sizes under lock to avoid early use by 1967 * concurrent FIFO access: 1968 */ 1969 f->free_q = temp_q; 1970 f->used_q.ifq_maxlen = nbuf; 1971 f->queue_data = queue_data; 1972 mtx_unlock(f->priv_mtx); 1973 1974 return (0); /* success */ 1975 } 1976 1977 /*------------------------------------------------------------------------* 1978 * usb_fifo_free_buffer 1979 * 1980 * This function will free the buffers associated with a FIFO. This 1981 * function can be called multiple times in a row. 1982 *------------------------------------------------------------------------*/ 1983 void 1984 usb_fifo_free_buffer(struct usb_fifo *f) 1985 { 1986 void *queue_data; 1987 1988 mtx_lock(f->priv_mtx); 1989 1990 /* Get and clear pointer to free, if any. */ 1991 queue_data = f->queue_data; 1992 f->queue_data = NULL; 1993 1994 /* 1995 * Reset queues under lock to avoid use of freed buffers by 1996 * concurrent FIFO activity: 1997 */ 1998 memset(&f->free_q, 0, sizeof(f->free_q)); 1999 memset(&f->used_q, 0, sizeof(f->used_q)); 2000 mtx_unlock(f->priv_mtx); 2001 2002 /* Free old buffer, if any. */ 2003 free(queue_data, M_USBDEV); 2004 } 2005 2006 void 2007 usb_fifo_detach(struct usb_fifo_sc *f_sc) 2008 { 2009 if (f_sc == NULL) { 2010 return; 2011 } 2012 usb_fifo_free(f_sc->fp[USB_FIFO_TX]); 2013 usb_fifo_free(f_sc->fp[USB_FIFO_RX]); 2014 2015 f_sc->fp[USB_FIFO_TX] = NULL; 2016 f_sc->fp[USB_FIFO_RX] = NULL; 2017 2018 usb_destroy_dev(f_sc->dev); 2019 2020 f_sc->dev = NULL; 2021 2022 DPRINTFN(2, "detached %p\n", f_sc); 2023 } 2024 2025 usb_size_t 2026 usb_fifo_put_bytes_max(struct usb_fifo *f) 2027 { 2028 struct usb_mbuf *m; 2029 usb_size_t len; 2030 2031 USB_IF_POLL(&f->free_q, m); 2032 2033 if (m) { 2034 len = m->max_data_len; 2035 } else { 2036 len = 0; 2037 } 2038 return (len); 2039 } 2040 2041 /*------------------------------------------------------------------------* 2042 * usb_fifo_put_data 2043 * 2044 * what: 2045 * 0 - normal operation 2046 * 1 - set last packet flag to enforce framing 2047 *------------------------------------------------------------------------*/ 2048 void 2049 usb_fifo_put_data(struct usb_fifo *f, struct usb_page_cache *pc, 2050 usb_frlength_t offset, usb_frlength_t len, uint8_t what) 2051 { 2052 struct usb_mbuf *m; 2053 usb_frlength_t io_len; 2054 2055 while (len || (what == 1)) { 2056 USB_IF_DEQUEUE(&f->free_q, m); 2057 2058 if (m) { 2059 USB_MBUF_RESET(m); 2060 2061 io_len = MIN(len, m->cur_data_len); 2062 2063 usbd_copy_out(pc, offset, m->cur_data_ptr, io_len); 2064 2065 m->cur_data_len = io_len; 2066 offset += io_len; 2067 len -= io_len; 2068 2069 if ((len == 0) && (what == 1)) { 2070 m->last_packet = 1; 2071 } 2072 USB_IF_ENQUEUE(&f->used_q, m); 2073 2074 usb_fifo_wakeup(f); 2075 2076 if ((len == 0) || (what == 1)) { 2077 break; 2078 } 2079 } else { 2080 break; 2081 } 2082 } 2083 } 2084 2085 void 2086 usb_fifo_put_data_linear(struct usb_fifo *f, void *ptr, 2087 usb_size_t len, uint8_t what) 2088 { 2089 struct usb_mbuf *m; 2090 usb_size_t io_len; 2091 2092 while (len || (what == 1)) { 2093 USB_IF_DEQUEUE(&f->free_q, m); 2094 2095 if (m) { 2096 USB_MBUF_RESET(m); 2097 2098 io_len = MIN(len, m->cur_data_len); 2099 2100 memcpy(m->cur_data_ptr, ptr, io_len); 2101 2102 m->cur_data_len = io_len; 2103 ptr = USB_ADD_BYTES(ptr, io_len); 2104 len -= io_len; 2105 2106 if ((len == 0) && (what == 1)) { 2107 m->last_packet = 1; 2108 } 2109 USB_IF_ENQUEUE(&f->used_q, m); 2110 2111 usb_fifo_wakeup(f); 2112 2113 if ((len == 0) || (what == 1)) { 2114 break; 2115 } 2116 } else { 2117 break; 2118 } 2119 } 2120 } 2121 2122 uint8_t 2123 usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len) 2124 { 2125 struct usb_mbuf *m; 2126 2127 USB_IF_DEQUEUE(&f->free_q, m); 2128 2129 if (m) { 2130 m->cur_data_len = len; 2131 m->cur_data_ptr = ptr; 2132 USB_IF_ENQUEUE(&f->used_q, m); 2133 usb_fifo_wakeup(f); 2134 return (1); 2135 } 2136 return (0); 2137 } 2138 2139 void 2140 usb_fifo_put_data_error(struct usb_fifo *f) 2141 { 2142 f->flag_iserror = 1; 2143 usb_fifo_wakeup(f); 2144 } 2145 2146 /*------------------------------------------------------------------------* 2147 * usb_fifo_get_data 2148 * 2149 * what: 2150 * 0 - normal operation 2151 * 1 - only get one "usb_mbuf" 2152 * 2153 * returns: 2154 * 0 - no more data 2155 * 1 - data in buffer 2156 *------------------------------------------------------------------------*/ 2157 uint8_t 2158 usb_fifo_get_data(struct usb_fifo *f, struct usb_page_cache *pc, 2159 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen, 2160 uint8_t what) 2161 { 2162 struct usb_mbuf *m; 2163 usb_frlength_t io_len; 2164 uint8_t tr_data = 0; 2165 2166 actlen[0] = 0; 2167 2168 while (1) { 2169 USB_IF_DEQUEUE(&f->used_q, m); 2170 2171 if (m) { 2172 tr_data = 1; 2173 2174 io_len = MIN(len, m->cur_data_len); 2175 2176 usbd_copy_in(pc, offset, m->cur_data_ptr, io_len); 2177 2178 len -= io_len; 2179 offset += io_len; 2180 actlen[0] += io_len; 2181 m->cur_data_ptr += io_len; 2182 m->cur_data_len -= io_len; 2183 2184 if ((m->cur_data_len == 0) || (what == 1)) { 2185 USB_IF_ENQUEUE(&f->free_q, m); 2186 2187 usb_fifo_wakeup(f); 2188 2189 if (what == 1) { 2190 break; 2191 } 2192 } else { 2193 USB_IF_PREPEND(&f->used_q, m); 2194 } 2195 } else { 2196 if (tr_data) { 2197 /* wait for data to be written out */ 2198 break; 2199 } 2200 if (f->flag_flushing) { 2201 /* check if we should send a short packet */ 2202 if (f->flag_short != 0) { 2203 f->flag_short = 0; 2204 tr_data = 1; 2205 break; 2206 } 2207 /* flushing complete */ 2208 f->flag_flushing = 0; 2209 usb_fifo_wakeup(f); 2210 } 2211 break; 2212 } 2213 if (len == 0) { 2214 break; 2215 } 2216 } 2217 return (tr_data); 2218 } 2219 2220 uint8_t 2221 usb_fifo_get_data_linear(struct usb_fifo *f, void *ptr, 2222 usb_size_t len, usb_size_t *actlen, uint8_t what) 2223 { 2224 struct usb_mbuf *m; 2225 usb_size_t io_len; 2226 uint8_t tr_data = 0; 2227 2228 actlen[0] = 0; 2229 2230 while (1) { 2231 USB_IF_DEQUEUE(&f->used_q, m); 2232 2233 if (m) { 2234 tr_data = 1; 2235 2236 io_len = MIN(len, m->cur_data_len); 2237 2238 memcpy(ptr, m->cur_data_ptr, io_len); 2239 2240 len -= io_len; 2241 ptr = USB_ADD_BYTES(ptr, io_len); 2242 actlen[0] += io_len; 2243 m->cur_data_ptr += io_len; 2244 m->cur_data_len -= io_len; 2245 2246 if ((m->cur_data_len == 0) || (what == 1)) { 2247 USB_IF_ENQUEUE(&f->free_q, m); 2248 2249 usb_fifo_wakeup(f); 2250 2251 if (what == 1) { 2252 break; 2253 } 2254 } else { 2255 USB_IF_PREPEND(&f->used_q, m); 2256 } 2257 } else { 2258 if (tr_data) { 2259 /* wait for data to be written out */ 2260 break; 2261 } 2262 if (f->flag_flushing) { 2263 /* check if we should send a short packet */ 2264 if (f->flag_short != 0) { 2265 f->flag_short = 0; 2266 tr_data = 1; 2267 break; 2268 } 2269 /* flushing complete */ 2270 f->flag_flushing = 0; 2271 usb_fifo_wakeup(f); 2272 } 2273 break; 2274 } 2275 if (len == 0) { 2276 break; 2277 } 2278 } 2279 return (tr_data); 2280 } 2281 2282 uint8_t 2283 usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr, usb_size_t *plen) 2284 { 2285 struct usb_mbuf *m; 2286 2287 USB_IF_POLL(&f->used_q, m); 2288 2289 if (m) { 2290 *plen = m->cur_data_len; 2291 *pptr = m->cur_data_ptr; 2292 2293 return (1); 2294 } 2295 return (0); 2296 } 2297 2298 void 2299 usb_fifo_get_data_error(struct usb_fifo *f) 2300 { 2301 f->flag_iserror = 1; 2302 usb_fifo_wakeup(f); 2303 } 2304 2305 /*------------------------------------------------------------------------* 2306 * usb_alloc_symlink 2307 * 2308 * Return values: 2309 * NULL: Failure 2310 * Else: Pointer to symlink entry 2311 *------------------------------------------------------------------------*/ 2312 struct usb_symlink * 2313 usb_alloc_symlink(const char *target) 2314 { 2315 struct usb_symlink *ps; 2316 2317 ps = malloc(sizeof(*ps), M_USBDEV, M_WAITOK); 2318 /* XXX no longer needed */ 2319 strlcpy(ps->src_path, target, sizeof(ps->src_path)); 2320 ps->src_len = strlen(ps->src_path); 2321 strlcpy(ps->dst_path, target, sizeof(ps->dst_path)); 2322 ps->dst_len = strlen(ps->dst_path); 2323 2324 sx_xlock(&usb_sym_lock); 2325 TAILQ_INSERT_TAIL(&usb_sym_head, ps, sym_entry); 2326 sx_unlock(&usb_sym_lock); 2327 return (ps); 2328 } 2329 2330 /*------------------------------------------------------------------------* 2331 * usb_free_symlink 2332 *------------------------------------------------------------------------*/ 2333 void 2334 usb_free_symlink(struct usb_symlink *ps) 2335 { 2336 if (ps == NULL) { 2337 return; 2338 } 2339 sx_xlock(&usb_sym_lock); 2340 TAILQ_REMOVE(&usb_sym_head, ps, sym_entry); 2341 sx_unlock(&usb_sym_lock); 2342 2343 free(ps, M_USBDEV); 2344 } 2345 2346 /*------------------------------------------------------------------------* 2347 * usb_read_symlink 2348 * 2349 * Return value: 2350 * 0: Success 2351 * Else: Failure 2352 *------------------------------------------------------------------------*/ 2353 int 2354 usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, uint32_t user_len) 2355 { 2356 struct usb_symlink *ps; 2357 uint32_t temp; 2358 uint32_t delta = 0; 2359 uint8_t len; 2360 int error = 0; 2361 2362 sx_xlock(&usb_sym_lock); 2363 2364 TAILQ_FOREACH(ps, &usb_sym_head, sym_entry) { 2365 /* 2366 * Compute total length of source and destination symlink 2367 * strings pluss one length byte and two NUL bytes: 2368 */ 2369 temp = ps->src_len + ps->dst_len + 3; 2370 2371 if (temp > 255) { 2372 /* 2373 * Skip entry because this length cannot fit 2374 * into one byte: 2375 */ 2376 continue; 2377 } 2378 if (startentry != 0) { 2379 /* decrement read offset */ 2380 startentry--; 2381 continue; 2382 } 2383 if (temp > user_len) { 2384 /* out of buffer space */ 2385 break; 2386 } 2387 len = temp; 2388 2389 /* copy out total length */ 2390 2391 error = copyout(&len, 2392 USB_ADD_BYTES(user_ptr, delta), 1); 2393 if (error) { 2394 break; 2395 } 2396 delta += 1; 2397 2398 /* copy out source string */ 2399 2400 error = copyout(ps->src_path, 2401 USB_ADD_BYTES(user_ptr, delta), ps->src_len); 2402 if (error) { 2403 break; 2404 } 2405 len = 0; 2406 delta += ps->src_len; 2407 error = copyout(&len, 2408 USB_ADD_BYTES(user_ptr, delta), 1); 2409 if (error) { 2410 break; 2411 } 2412 delta += 1; 2413 2414 /* copy out destination string */ 2415 2416 error = copyout(ps->dst_path, 2417 USB_ADD_BYTES(user_ptr, delta), ps->dst_len); 2418 if (error) { 2419 break; 2420 } 2421 len = 0; 2422 delta += ps->dst_len; 2423 error = copyout(&len, 2424 USB_ADD_BYTES(user_ptr, delta), 1); 2425 if (error) { 2426 break; 2427 } 2428 delta += 1; 2429 2430 user_len -= temp; 2431 } 2432 2433 /* a zero length entry indicates the end */ 2434 2435 if ((user_len != 0) && (error == 0)) { 2436 len = 0; 2437 2438 error = copyout(&len, 2439 USB_ADD_BYTES(user_ptr, delta), 1); 2440 } 2441 sx_unlock(&usb_sym_lock); 2442 return (error); 2443 } 2444 2445 void 2446 usb_fifo_set_close_zlp(struct usb_fifo *f, uint8_t onoff) 2447 { 2448 if (f == NULL) 2449 return; 2450 2451 /* send a Zero Length Packet, ZLP, before close */ 2452 f->flag_short = onoff; 2453 } 2454 2455 void 2456 usb_fifo_set_write_defrag(struct usb_fifo *f, uint8_t onoff) 2457 { 2458 if (f == NULL) 2459 return; 2460 2461 /* defrag written data */ 2462 f->flag_write_defrag = onoff; 2463 /* reset defrag state */ 2464 f->flag_have_fragment = 0; 2465 } 2466 2467 void * 2468 usb_fifo_softc(struct usb_fifo *f) 2469 { 2470 return (f->priv_sc0); 2471 } 2472 #endif /* USB_HAVE_UGEN */ 2473