usb-bsd.c

   1 /*
   2  * BSD host USB redirector
   3  *
   4  * Copyright (c) 2006 Lonnie Mendez
   5  * Portions of code and concepts borrowed from
   6  * usb-linux.c and libusb's bsd.c and are copyright their respective owners.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24  * THE SOFTWARE.
  25  */
  26
  27 #include "qemu-common.h"
  28 #include "monitor.h"
  29 #include "hw/usb.h"
  30
  31 /* usb.h declares these */
  32 #undef USB_SPEED_HIGH
  33 #undef USB_SPEED_FULL
  34 #undef USB_SPEED_LOW
  35
  36 #include <sys/ioctl.h>
  37 #ifndef __DragonFly__
  38 #include <dev/usb/usb.h>
  39 #else
  40 #include <bus/usb/usb.h>
  41 #endif
  42 #include <signal.h>
  43
  44 /* This value has maximum potential at 16.
  45  * You should also set hw.usb.debug to gain
  46  * more detailed view.
  47  */
  48 //#define DEBUG
  49 #define UGEN_DEBUG_LEVEL 0
  50
  51
  52 typedef int USBScanFunc(void *opaque, int bus_num, int addr, int class_id,
  53                         int vendor_id, int product_id,
  54                         const char *product_name, int speed);
  55 static int usb_host_find_device(int *pbus_num, int *paddr,
  56                                 const char *devname);
  57
  58 typedef struct USBHostDevice {
  59     USBDevice dev;
  60     int ep_fd[USB_MAX_ENDPOINTS];
  61     int devfd;
  62     char devpath[32];
  63 } USBHostDevice;
  64
  65
  66 #if 0
  67 static int ensure_ep_open(USBHostDevice *dev, int ep, int mode)
  68 {
  69     char buf[32];
  70     int fd;
  71
  72     /* Get the address for this endpoint */
  73     ep = UE_GET_ADDR(ep);
  74
  75     if (dev->ep_fd[ep] < 0) {
  76 #if defined(__FreeBSD__) || defined(__DragonFly__)
  77         snprintf(buf, sizeof(buf) - 1, "%s.%d", dev->devpath, ep);
  78 #else
  79         snprintf(buf, sizeof(buf) - 1, "%s.%02d", dev->devpath, ep);
  80 #endif
  81         /* Try to open it O_RDWR first for those devices which have in and out
  82          * endpoints with the same address (eg 0x02 and 0x82)
  83          */
  84         fd = open(buf, O_RDWR);
  85         if (fd < 0 && errno == ENXIO)
  86             fd = open(buf, mode);
  87         if (fd < 0) {
  88 #ifdef DEBUG
  89             printf("ensure_ep_open: failed to open device endpoint %s: %s\n",
  90                    buf, strerror(errno));
  91 #endif
  92         }
  93         dev->ep_fd[ep] = fd;
  94     }
  95
  96     return dev->ep_fd[ep];
  97 }
  98
  99 static void ensure_eps_closed(USBHostDevice *dev)
 100 {
 101     int epnum = 1;
 102
 103     if (!dev)
 104         return;
 105
 106     while (epnum < USB_MAX_ENDPOINTS) {
 107         if (dev->ep_fd[epnum] >= 0) {
 108             close(dev->ep_fd[epnum]);
 109             dev->ep_fd[epnum] = -1;
 110         }
 111         epnum++;
 112     }
 113 }
 114 #endif
 115
 116 static void usb_host_handle_reset(USBDevice *dev)
 117 {
 118 #if 0
 119     USBHostDevice *s = (USBHostDevice *)dev;
 120 #endif
 121 }
 122
 123 #if 0
 124 /* XXX:
 125  * -check device states against transfer requests
 126  *  and return appropriate response
 127  */
 128 static int usb_host_handle_control(USBDevice *dev,
 129                                    int request,
 130                                    int value,
 131                                    int index,
 132                                    int length,
 133                                    uint8_t *data)
 134 {
 135     USBHostDevice *s = (USBHostDevice *)dev;
 136     struct usb_ctl_request req;
 137     struct usb_alt_interface aiface;
 138     int ret, timeout = 50;
 139
 140     if ((request >> 8) == UT_WRITE_DEVICE &&
 141         (request & 0xff) == UR_SET_ADDRESS) {
 142
 143         /* specific SET_ADDRESS support */
 144         dev->addr = value;
 145         return 0;
 146     } else if ((request >> 8) == UT_WRITE_DEVICE &&
 147                (request & 0xff) == UR_SET_CONFIG) {
 148
 149         ensure_eps_closed(s); /* can't do this without all eps closed */
 150
 151         ret = ioctl(s->devfd, USB_SET_CONFIG, &value);
 152         if (ret < 0) {
 153 #ifdef DEBUG
 154             printf("handle_control: failed to set configuration - %s\n",
 155                    strerror(errno));
 156 #endif
 157             return USB_RET_STALL;
 158         }
 159
 160         return 0;
 161     } else if ((request >> 8) == UT_WRITE_INTERFACE &&
 162                (request & 0xff) == UR_SET_INTERFACE) {
 163
 164         aiface.uai_interface_index = index;
 165         aiface.uai_alt_no = value;
 166
 167         ensure_eps_closed(s); /* can't do this without all eps closed */
 168         ret = ioctl(s->devfd, USB_SET_ALTINTERFACE, &aiface);
 169         if (ret < 0) {
 170 #ifdef DEBUG
 171             printf("handle_control: failed to set alternate interface - %s\n",
 172                    strerror(errno));
 173 #endif
 174             return USB_RET_STALL;
 175         }
 176
 177         return 0;
 178     } else {
 179         req.ucr_request.bmRequestType = request >> 8;
 180         req.ucr_request.bRequest = request & 0xff;
 181         USETW(req.ucr_request.wValue, value);
 182         USETW(req.ucr_request.wIndex, index);
 183         USETW(req.ucr_request.wLength, length);
 184         req.ucr_data = data;
 185         req.ucr_flags = USBD_SHORT_XFER_OK;
 186
 187         ret = ioctl(s->devfd, USB_SET_TIMEOUT, &timeout);
 188 #if defined(__NetBSD__) || defined(__OpenBSD__)
 189         if (ret < 0 && errno != EINVAL) {
 190 #else
 191         if (ret < 0) {
 192 #endif
 193 #ifdef DEBUG
 194             printf("handle_control: setting timeout failed - %s\n",
 195                    strerror(errno));
 196 #endif
 197         }
 198
 199         ret = ioctl(s->devfd, USB_DO_REQUEST, &req);
 200         /* ugen returns EIO for usbd_do_request_ no matter what
 201          * happens with the transfer */
 202         if (ret < 0) {
 203 #ifdef DEBUG
 204             printf("handle_control: error after request - %s\n",
 205                    strerror(errno));
 206 #endif
 207             return USB_RET_NAK; // STALL
 208         } else {
 209             return req.ucr_actlen;
 210         }
 211     }
 212 }
 213
 214 static int usb_host_handle_data(USBDevice *dev, USBPacket *p)
 215 {
 216     USBHostDevice *s = (USBHostDevice *)dev;
 217     int ret, fd, mode;
 218     int one = 1, shortpacket = 0, timeout = 50;
 219     sigset_t new_mask, old_mask;
 220     uint8_t devep = p->devep;
 221
 222     /* protect data transfers from SIGALRM signal */
 223     sigemptyset(&new_mask);
 224     sigaddset(&new_mask, SIGALRM);
 225     sigprocmask(SIG_BLOCK, &new_mask, &old_mask);
 226
 227     if (p->pid == USB_TOKEN_IN) {
 228         devep |= 0x80;
 229         mode = O_RDONLY;
 230         shortpacket = 1;
 231     } else {
 232         mode = O_WRONLY;
 233     }
 234
 235     fd = ensure_ep_open(s, devep, mode);
 236     if (fd < 0) {
 237         sigprocmask(SIG_SETMASK, &old_mask, NULL);
 238         return USB_RET_NODEV;
 239     }
 240
 241     if (ioctl(fd, USB_SET_TIMEOUT, &timeout) < 0) {
 242 #ifdef DEBUG
 243         printf("handle_data: failed to set timeout - %s\n",
 244                strerror(errno));
 245 #endif
 246     }
 247
 248     if (shortpacket) {
 249         if (ioctl(fd, USB_SET_SHORT_XFER, &one) < 0) {
 250 #ifdef DEBUG
 251             printf("handle_data: failed to set short xfer mode - %s\n",
 252                    strerror(errno));
 253 #endif
 254             sigprocmask(SIG_SETMASK, &old_mask, NULL);
 255         }
 256     }
 257
 258     if (p->pid == USB_TOKEN_IN)
 259         ret = read(fd, p->data, p->len);
 260     else
 261         ret = write(fd, p->data, p->len);
 262
 263     sigprocmask(SIG_SETMASK, &old_mask, NULL);
 264
 265     if (ret < 0) {
 266 #ifdef DEBUG
 267         printf("handle_data: error after %s data - %s\n",
 268                pid == USB_TOKEN_IN ? "reading" : "writing", strerror(errno));
 269 #endif
 270         switch(errno) {
 271         case ETIMEDOUT:
 272         case EINTR:
 273             return USB_RET_NAK;
 274         default:
 275             return USB_RET_STALL;
 276         }
 277     } else {
 278         return ret;
 279     }
 280 }
 281 #endif
 282
 283 static void usb_host_handle_destroy(USBDevice *opaque)
 284 {
 285     USBHostDevice *s = (USBHostDevice *)opaque;
 286     int i;
 287
 288     for (i = 0; i < USB_MAX_ENDPOINTS; i++)
 289         if (s->ep_fd[i] >= 0)
 290             close(s->ep_fd[i]);
 291
 292     if (s->devfd < 0)
 293         return;
 294
 295     close(s->devfd);
 296
 297     qemu_free(s);
 298 }
 299
 300 static int usb_host_initfn(USBDevice *dev)
 301 {
 302     return 0;
 303 }
 304
 305 USBDevice *usb_host_device_open(const char *devname)
 306 {
 307     struct usb_device_info bus_info, dev_info;
 308     USBDevice *d = NULL;
 309     USBHostDevice *dev;
 310     char ctlpath[PATH_MAX + 1];
 311     char buspath[PATH_MAX + 1];
 312     int bfd, dfd, bus, address, i;
 313     int ugendebug = UGEN_DEBUG_LEVEL;
 314
 315     if (usb_host_find_device(&bus, &address, devname) < 0)
 316         return NULL;
 317
 318     snprintf(buspath, PATH_MAX, "/dev/usb%d", bus);
 319
 320     bfd = open(buspath, O_RDWR);
 321     if (bfd < 0) {
 322 #ifdef DEBUG
 323         printf("usb_host_device_open: failed to open usb bus - %s\n",
 324                strerror(errno));
 325 #endif
 326         return NULL;
 327     }
 328
 329     bus_info.udi_addr = address;
 330     if (ioctl(bfd, USB_DEVICEINFO, &bus_info) < 0) {
 331 #ifdef DEBUG
 332         printf("usb_host_device_open: failed to grab bus information - %s\n",
 333                strerror(errno));
 334 #endif
 335         return NULL;
 336     }
 337
 338 #if defined(__FreeBSD__) || defined(__DragonFly__)
 339     snprintf(ctlpath, PATH_MAX, "/dev/%s", bus_info.udi_devnames[0]);
 340 #else
 341     snprintf(ctlpath, PATH_MAX, "/dev/%s.00", bus_info.udi_devnames[0]);
 342 #endif
 343
 344     dfd  = open(ctlpath, O_RDWR);
 345     if (dfd < 0) {
 346         dfd = open(ctlpath, O_RDONLY);
 347         if (dfd < 0) {
 348 #ifdef DEBUG
 349             printf("usb_host_device_open: failed to open usb device %s - %s\n",
 350                    ctlpath, strerror(errno));
 351 #endif
 352         }
 353     }
 354
 355     if (dfd >= 0) {
 356         if (ioctl(dfd, USB_GET_DEVICEINFO, &dev_info) < 0) {
 357 #ifdef DEBUG
 358             printf("usb_host_device_open: failed to grab device info - %s\n",
 359                    strerror(errno));
 360 #endif
 361             goto fail;
 362         }
 363
 364         d = usb_create(NULL /* FIXME */, "USB Host Device");
 365         dev = DO_UPCAST(USBHostDevice, dev, d);
 366
 367         if (dev_info.udi_speed == 1)
 368             dev->dev.speed = USB_SPEED_LOW - 1;
 369         else
 370             dev->dev.speed = USB_SPEED_FULL - 1;
 371
 372         if (strncmp(dev_info.udi_product, "product", 7) != 0)
 373             pstrcpy(dev->dev.devname, sizeof(dev->dev.devname),
 374                     dev_info.udi_product);
 375         else
 376             snprintf(dev->dev.devname, sizeof(dev->dev.devname),
 377                      "host:%s", devname);
 378
 379         pstrcpy(dev->devpath, sizeof(dev->devpath), "/dev/");
 380         pstrcat(dev->devpath, sizeof(dev->devpath), dev_info.udi_devnames[0]);
 381
 382         /* Mark the endpoints as not yet open */
 383         for (i = 0; i < USB_MAX_ENDPOINTS; i++)
 384            dev->ep_fd[i] = -1;
 385
 386         ioctl(dfd, USB_SETDEBUG, &ugendebug);
 387
 388         return (USBDevice *)dev;
 389     }
 390
 391 fail:
 392     return NULL;
 393 }
 394
 395 static struct USBDeviceInfo usb_host_dev_info = {
 396     .qdev.name      = "USB Host Device",
 397     .qdev.size      = sizeof(USBHostDevice),
 398     .init           = usb_host_initfn,
 399     .handle_packet  = usb_generic_handle_packet,
 400     .handle_reset   = usb_host_handle_reset,
 401 #if 0
 402     .handle_control = usb_host_handle_control,
 403     .handle_data    = usb_host_handle_data,
 404 #endif
 405     .handle_destroy = usb_host_handle_destroy,
 406 };
 407
 408 static void usb_host_register_devices(void)
 409 {
 410     usb_qdev_register(&usb_host_dev_info);
 411 }
 412 device_init(usb_host_register_devices)
 413
 414 static int usb_host_scan(void *opaque, USBScanFunc *func)
 415 {
 416     struct usb_device_info bus_info;
 417     struct usb_device_info dev_info;
 418     uint16_t vendor_id, product_id, class_id, speed;
 419     int bfd, dfd, bus, address;
 420     char busbuf[20], devbuf[20], product_name[256];
 421     int ret = 0;
 422
 423     for (bus = 0; bus < 10; bus++) {
 424
 425         snprintf(busbuf, sizeof(busbuf) - 1, "/dev/usb%d", bus);
 426         bfd = open(busbuf, O_RDWR);
 427         if (bfd < 0)
 428             continue;
 429
 430         for (address = 1; address < 127; address++) {
 431
 432             bus_info.udi_addr = address;
 433             if (ioctl(bfd, USB_DEVICEINFO, &bus_info) < 0)
 434                 continue;
 435
 436             /* only list devices that can be used by generic layer */
 437             if (strncmp(bus_info.udi_devnames[0], "ugen", 4) != 0)
 438                 continue;
 439
 440 #if defined(__FreeBSD__) || defined(__DragonFly__)
 441             snprintf(devbuf, sizeof(devbuf) - 1, "/dev/%s", bus_info.udi_devnames[0]);
 442 #else
 443             snprintf(devbuf, sizeof(devbuf) - 1, "/dev/%s.00", bus_info.udi_devnames[0]);
 444 #endif
 445
 446             dfd = open(devbuf, O_RDONLY);
 447             if (dfd < 0) {
 448 #ifdef DEBUG
 449                 printf("usb_host_scan: couldn't open device %s - %s\n", devbuf,
 450                        strerror(errno));
 451 #endif
 452                 continue;
 453             }
 454
 455             if (ioctl(dfd, USB_GET_DEVICEINFO, &dev_info) < 0)
 456                 printf("usb_host_scan: couldn't get device information for %s - %s\n",
 457                        devbuf, strerror(errno));
 458
 459             // XXX: might need to fixup endianess of word values before copying over
 460
 461             vendor_id = dev_info.udi_vendorNo;
 462             product_id = dev_info.udi_productNo;
 463             class_id = dev_info.udi_class;
 464             speed = dev_info.udi_speed;
 465
 466             if (strncmp(dev_info.udi_product, "product", 7) != 0)
 467                 pstrcpy(product_name, sizeof(product_name),
 468                         dev_info.udi_product);
 469             else
 470                 product_name[0] = '\0';
 471
 472             ret = func(opaque, bus, address, class_id, vendor_id,
 473                        product_id, product_name, speed);
 474
 475             close(dfd);
 476
 477             if (ret)
 478                 goto the_end;
 479         }
 480
 481         close(bfd);
 482     }
 483
 484 the_end:
 485     return ret;
 486 }
 487
 488 typedef struct FindDeviceState {
 489     int vendor_id;
 490     int product_id;
 491     int bus_num;
 492     int addr;
 493 } FindDeviceState;
 494
 495 static int usb_host_find_device_scan(void *opaque, int bus_num, int addr,
 496                                      int class_id,
 497                                      int vendor_id, int product_id,
 498                                      const char *product_name, int speed)
 499 {
 500     FindDeviceState *s = opaque;
 501     if (vendor_id == s->vendor_id &&
 502         product_id == s->product_id) {
 503         s->bus_num = bus_num;
 504         s->addr = addr;
 505         return 1;
 506      } else {
 507         return 0;
 508      }
 509 }
 510
 511
 512 /* the syntax is :
 513    'bus.addr' (decimal numbers) or
 514    'vendor_id:product_id' (hexa numbers) */
 515 static int usb_host_find_device(int *pbus_num, int *paddr,
 516                                 const char *devname)
 517 {
 518     const char *p;
 519     int ret;
 520     FindDeviceState fs;
 521
 522     p = strchr(devname, '.');
 523     if (p) {
 524         *pbus_num = strtoul(devname, NULL, 0);
 525         *paddr = strtoul(p + 1, NULL, 0);
 526         return 0;
 527     }
 528     p = strchr(devname, ':');
 529     if (p) {
 530         fs.vendor_id = strtoul(devname, NULL, 16);
 531         fs.product_id = strtoul(p + 1, NULL, 16);
 532         ret = usb_host_scan(&fs, usb_host_find_device_scan);
 533         if (ret) {
 534             *pbus_num = fs.bus_num;
 535             *paddr = fs.addr;
 536             return 0;
 537         }
 538      }
 539      return -1;
 540 }
 541
 542 /**********************/
 543 /* USB host device info */
 544
 545 struct usb_class_info {
 546     int class;
 547     const char *class_name;
 548 };
 549
 550 static const struct usb_class_info usb_class_info[] = {
 551     { USB_CLASS_AUDIO, "Audio"},
 552     { USB_CLASS_COMM, "Communication"},
 553     { USB_CLASS_HID, "HID"},
 554     { USB_CLASS_HUB, "Hub" },
 555     { USB_CLASS_PHYSICAL, "Physical" },
 556     { USB_CLASS_PRINTER, "Printer" },
 557     { USB_CLASS_MASS_STORAGE, "Storage" },
 558     { USB_CLASS_CDC_DATA, "Data" },
 559     { USB_CLASS_APP_SPEC, "Application Specific" },
 560     { USB_CLASS_VENDOR_SPEC, "Vendor Specific" },
 561     { USB_CLASS_STILL_IMAGE, "Still Image" },
 562     { USB_CLASS_CSCID, "Smart Card" },
 563     { USB_CLASS_CONTENT_SEC, "Content Security" },
 564     { -1, NULL }
 565 };
 566
 567 static const char *usb_class_str(uint8_t class)
 568 {
 569     const struct usb_class_info *p;
 570     for (p = usb_class_info; p->class != -1; p++) {
 571         if (p->class == class)
 572             break;
 573     }
 574     return p->class_name;
 575 }
 576
 577 static void usb_info_device(Monitor *mon, int bus_num, int addr, int class_id,
 578                             int vendor_id, int product_id,
 579                             const char *product_name,
 580                             int speed)
 581 {
 582     const char *class_str, *speed_str;
 583
 584     switch(speed) {
 585     case USB_SPEED_LOW:
 586         speed_str = "1.5";
 587         break;
 588     case USB_SPEED_FULL:
 589         speed_str = "12";
 590         break;
 591     case USB_SPEED_HIGH:
 592         speed_str = "480";
 593         break;
 594     default:
 595         speed_str = "?";
 596         break;
 597     }
 598
 599     monitor_printf(mon, "  Device %d.%d, speed %s Mb/s\n",
 600                    bus_num, addr, speed_str);
 601     class_str = usb_class_str(class_id);
 602     if (class_str)
 603         monitor_printf(mon, "    %s:", class_str);
 604     else
 605         monitor_printf(mon, "    Class %02x:", class_id);
 606     monitor_printf(mon, " USB device %04x:%04x", vendor_id, product_id);
 607     if (product_name[0] != '\0')
 608         monitor_printf(mon, ", %s", product_name);
 609     monitor_printf(mon, "\n");
 610 }
 611
 612 static int usb_host_info_device(void *opaque,
 613                                 int bus_num, int addr,
 614                                 int class_id,
 615                                 int vendor_id, int product_id,
 616                                 const char *product_name,
 617                                 int speed)
 618 {
 619     Monitor *mon = opaque;
 620
 621     usb_info_device(mon, bus_num, addr, class_id, vendor_id, product_id,
 622                     product_name, speed);
 623     return 0;
 624 }
 625
 626 void usb_host_info(Monitor *mon)
 627 {
 628     usb_host_scan(mon, usb_host_info_device);
 629 }
 630
 631 /* XXX add this */
 632 int usb_host_device_close(const char *devname)
 633 {
 634     return 0;
 635 }