qemu/usb-linux.c

   1 /*
   2  * Linux host USB redirector
   3  *
   4  * Copyright (c) 2005 Fabrice Bellard
   5  *
   6  * Copyright (c) 2008 Max Krasnyansky
   7  *      Support for host device auto connect & disconnect
   8  *      Major rewrite to support fully async operation
   9  *
  10  * Copyright 2008 TJ <linux@tjworld.net>
  11  *      Added flexible support for /dev/bus/usb /sys/bus/usb/devices in addition
  12  *      to the legacy /proc/bus/usb USB device discovery and handling
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a copy
  15  * of this software and associated documentation files (the "Software"), to deal
  16  * in the Software without restriction, including without limitation the rights
  17  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  18  * copies of the Software, and to permit persons to whom the Software is
  19  * furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  27  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  29  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  30  * THE SOFTWARE.
  31  */
  32
  33 #include "qemu-common.h"
  34 #include "qemu-timer.h"
  35 #include "console.h"
  36
  37 #if defined(__linux__)
  38 #define __user
  39 #endif
  40
  41 #include <dirent.h>
  42 #include <sys/ioctl.h>
  43 #include <signal.h>
  44
  45 #include <linux/usbdevice_fs.h>
  46 #include <linux/version.h>
  47 #include "hw/usb.h"
  48
  49 /* We redefine it to avoid version problems */
  50 struct usb_ctrltransfer {
  51     uint8_t  bRequestType;
  52     uint8_t  bRequest;
  53     uint16_t wValue;
  54     uint16_t wIndex;
  55     uint16_t wLength;
  56     uint32_t timeout;
  57     void *data;
  58 };
  59
  60 struct usb_ctrlrequest {
  61     uint8_t bRequestType;
  62     uint8_t bRequest;
  63     uint16_t wValue;
  64     uint16_t wIndex;
  65     uint16_t wLength;
  66 };
  67
  68 typedef int USBScanFunc(void *opaque, int bus_num, int addr, int class_id,
  69                         int vendor_id, int product_id,
  70                         const char *product_name, int speed);
  71 static int usb_host_find_device(int *pbus_num, int *paddr,
  72                                 char *product_name, int product_name_size,
  73                                 const char *devname);
  74 //#define DEBUG
  75
  76 #ifdef DEBUG
  77 #define dprintf printf
  78 #else
  79 #define dprintf(...)
  80 #endif
  81
  82 #define USBDBG_DEVOPENED "husb: opened %s/devices\n"
  83
  84 #define USBPROCBUS_PATH "/proc/bus/usb"
  85 #define PRODUCT_NAME_SZ 32
  86 #define MAX_ENDPOINTS 16
  87 #define USBDEVBUS_PATH "/dev/bus/usb"
  88 #define USBSYSBUS_PATH "/sys/bus/usb"
  89
  90 static char *usb_host_device_path;
  91
  92 #define USB_FS_NONE 0
  93 #define USB_FS_PROC 1
  94 #define USB_FS_DEV 2
  95 #define USB_FS_SYS 3
  96
  97 static int usb_fs_type;
  98
  99 /* endpoint association data */
 100 struct endp_data {
 101     uint8_t type;
 102     uint8_t halted;
 103 };
 104
 105 enum {
 106     CTRL_STATE_IDLE = 0,
 107     CTRL_STATE_SETUP,
 108     CTRL_STATE_DATA,
 109     CTRL_STATE_ACK
 110 };
 111
 112 /*
 113  * Control transfer state.
 114  * Note that 'buffer' _must_ follow 'req' field because
 115  * we need contigious buffer when we submit control URB.
 116  */
 117 struct ctrl_struct {
 118     uint16_t len;
 119     uint16_t offset;
 120     uint8_t  state;
 121     struct   usb_ctrlrequest req;
 122     uint8_t  buffer[1024];
 123 };
 124
 125 typedef struct USBHostDevice {
 126     USBDevice dev;
 127     int       fd;
 128
 129     uint8_t   descr[1024];
 130     int       descr_len;
 131     int       configuration;
 132     int       ninterfaces;
 133     int       closing;
 134
 135     struct ctrl_struct ctrl;
 136     struct endp_data endp_table[MAX_ENDPOINTS];
 137
 138     /* Host side address */
 139     int bus_num;
 140     int addr;
 141
 142     struct USBHostDevice *next;
 143 } USBHostDevice;
 144
 145 static int is_isoc(USBHostDevice *s, int ep)
 146 {
 147     return s->endp_table[ep - 1].type == USBDEVFS_URB_TYPE_ISO;
 148 }
 149
 150 static int is_halted(USBHostDevice *s, int ep)
 151 {
 152     return s->endp_table[ep - 1].halted;
 153 }
 154
 155 static void clear_halt(USBHostDevice *s, int ep)
 156 {
 157     s->endp_table[ep - 1].halted = 0;
 158 }
 159
 160 static void set_halt(USBHostDevice *s, int ep)
 161 {
 162     s->endp_table[ep - 1].halted = 1;
 163 }
 164
 165 static USBHostDevice *hostdev_list;
 166
 167 static void hostdev_link(USBHostDevice *dev)
 168 {
 169     dev->next = hostdev_list;
 170     hostdev_list = dev;
 171 }
 172
 173 static void hostdev_unlink(USBHostDevice *dev)
 174 {
 175     USBHostDevice *pdev = hostdev_list;
 176     USBHostDevice **prev = &hostdev_list;
 177
 178     while (pdev) {
 179         if (pdev == dev) {
 180             *prev = dev->next;
 181             return;
 182         }
 183
 184         prev = &pdev->next;
 185         pdev = pdev->next;
 186     }
 187 }
 188
 189 static USBHostDevice *hostdev_find(int bus_num, int addr)
 190 {
 191     USBHostDevice *s = hostdev_list;
 192     while (s) {
 193         if (s->bus_num == bus_num && s->addr == addr)
 194             return s;
 195         s = s->next;
 196     }
 197     return NULL;
 198 }
 199
 200 /*
 201  * Async URB state.
 202  * We always allocate one isoc descriptor even for bulk transfers
 203  * to simplify allocation and casts.
 204  */
 205 typedef struct AsyncURB
 206 {
 207     struct usbdevfs_urb urb;
 208     struct usbdevfs_iso_packet_desc isocpd;
 209
 210     USBPacket     *packet;
 211     USBHostDevice *hdev;
 212 } AsyncURB;
 213
 214 static AsyncURB *async_alloc(void)
 215 {
 216     return (AsyncURB *) qemu_mallocz(sizeof(AsyncURB));
 217 }
 218
 219 static void async_free(AsyncURB *aurb)
 220 {
 221     qemu_free(aurb);
 222 }
 223
 224 static void async_complete_ctrl(USBHostDevice *s, USBPacket *p)
 225 {
 226     switch(s->ctrl.state) {
 227     case CTRL_STATE_SETUP:
 228         if (p->len < s->ctrl.len)
 229             s->ctrl.len = p->len;
 230         s->ctrl.state = CTRL_STATE_DATA;
 231         p->len = 8;
 232         break;
 233
 234     case CTRL_STATE_ACK:
 235         s->ctrl.state = CTRL_STATE_IDLE;
 236         p->len = 0;
 237         break;
 238
 239     default:
 240         break;
 241     }
 242 }
 243
 244 static void async_complete(void *opaque)
 245 {
 246     USBHostDevice *s = opaque;
 247     AsyncURB *aurb;
 248
 249     while (1) {
 250         USBPacket *p;
 251
 252         int r = ioctl(s->fd, USBDEVFS_REAPURBNDELAY, &aurb);
 253         if (r < 0) {
 254             if (errno == EAGAIN)
 255                 return;
 256
 257             if (errno == ENODEV && !s->closing) {
 258                 printf("husb: device %d.%d disconnected\n", s->bus_num, s->addr);
 259                 usb_device_del_addr(0, s->dev.addr);
 260                 return;
 261             }
 262
 263             dprintf("husb: async. reap urb failed errno %d\n", errno);
 264             return;
 265         }
 266
 267         p = aurb->packet;
 268
 269         dprintf("husb: async completed. aurb %p status %d alen %d\n",
 270                 aurb, aurb->urb.status, aurb->urb.actual_length);
 271
 272         if (p) {
 273             switch (aurb->urb.status) {
 274             case 0:
 275                 p->len = aurb->urb.actual_length;
 276                 if (aurb->urb.type == USBDEVFS_URB_TYPE_CONTROL)
 277                     async_complete_ctrl(s, p);
 278                 break;
 279
 280             case -EPIPE:
 281                 set_halt(s, p->devep);
 282                 /* fall through */
 283             default:
 284                 p->len = USB_RET_NAK;
 285                 break;
 286             }
 287
 288             usb_packet_complete(p);
 289         }
 290
 291         async_free(aurb);
 292     }
 293 }
 294
 295 static void async_cancel(USBPacket *unused, void *opaque)
 296 {
 297     AsyncURB *aurb = opaque;
 298     USBHostDevice *s = aurb->hdev;
 299
 300     dprintf("husb: async cancel. aurb %p\n", aurb);
 301
 302     /* Mark it as dead (see async_complete above) */
 303     aurb->packet = NULL;
 304
 305     int r = ioctl(s->fd, USBDEVFS_DISCARDURB, aurb);
 306     if (r < 0) {
 307         dprintf("husb: async. discard urb failed errno %d\n", errno);
 308     }
 309 }
 310
 311 static int usb_host_claim_interfaces(USBHostDevice *dev, int configuration)
 312 {
 313     int dev_descr_len, config_descr_len;
 314     int interface, nb_interfaces, nb_configurations;
 315     int ret, i;
 316
 317     if (configuration == 0) /* address state - ignore */
 318         return 1;
 319
 320     dprintf("husb: claiming interfaces. config %d\n", configuration);
 321
 322     i = 0;
 323     dev_descr_len = dev->descr[0];
 324     if (dev_descr_len > dev->descr_len)
 325         goto fail;
 326     nb_configurations = dev->descr[17];
 327
 328     i += dev_descr_len;
 329     while (i < dev->descr_len) {
 330         dprintf("husb: i is %d, descr_len is %d, dl %d, dt %d\n", i, dev->descr_len,
 331                dev->descr[i], dev->descr[i+1]);
 332
 333         if (dev->descr[i+1] != USB_DT_CONFIG) {
 334             i += dev->descr[i];
 335             continue;
 336         }
 337         config_descr_len = dev->descr[i];
 338
 339         printf("husb: config #%d need %d\n", dev->descr[i + 5], configuration);
 340
 341         if (configuration < 0 || configuration == dev->descr[i + 5]) {
 342             configuration = dev->descr[i + 5];
 343             break;
 344         }
 345
 346         i += config_descr_len;
 347     }
 348
 349     if (i >= dev->descr_len) {
 350         fprintf(stderr, "husb: update iface failed. no matching configuration\n");
 351         goto fail;
 352     }
 353     nb_interfaces = dev->descr[i + 4];
 354
 355 #ifdef USBDEVFS_DISCONNECT
 356     /* earlier Linux 2.4 do not support that */
 357     {
 358         struct usbdevfs_ioctl ctrl;
 359         for (interface = 0; interface < nb_interfaces; interface++) {
 360             ctrl.ioctl_code = USBDEVFS_DISCONNECT;
 361             ctrl.ifno = interface;
 362             ret = ioctl(dev->fd, USBDEVFS_IOCTL, &ctrl);
 363             if (ret < 0 && errno != ENODATA) {
 364                 perror("USBDEVFS_DISCONNECT");
 365                 goto fail;
 366             }
 367         }
 368     }
 369 #endif
 370
 371     /* XXX: only grab if all interfaces are free */
 372     for (interface = 0; interface < nb_interfaces; interface++) {
 373         ret = ioctl(dev->fd, USBDEVFS_CLAIMINTERFACE, &interface);
 374         if (ret < 0) {
 375             if (errno == EBUSY) {
 376                 printf("husb: update iface. device already grabbed\n");
 377             } else {
 378                 perror("husb: failed to claim interface");
 379             }
 380         fail:
 381             return 0;
 382         }
 383     }
 384
 385     printf("husb: %d interfaces claimed for configuration %d\n",
 386            nb_interfaces, configuration);
 387
 388     dev->ninterfaces   = nb_interfaces;
 389     dev->configuration = configuration;
 390     return 1;
 391 }
 392
 393 static int usb_host_release_interfaces(USBHostDevice *s)
 394 {
 395     int ret, i;
 396
 397     dprintf("husb: releasing interfaces\n");
 398
 399     for (i = 0; i < s->ninterfaces; i++) {
 400         ret = ioctl(s->fd, USBDEVFS_RELEASEINTERFACE, &i);
 401         if (ret < 0) {
 402             perror("husb: failed to release interface");
 403             return 0;
 404         }
 405     }
 406
 407     return 1;
 408 }
 409
 410 static void usb_host_handle_reset(USBDevice *dev)
 411 {
 412     USBHostDevice *s = (USBHostDevice *) dev;
 413
 414     dprintf("husb: reset device %u.%u\n", s->bus_num, s->addr);
 415
 416     ioctl(s->fd, USBDEVFS_RESET);
 417
 418     usb_host_claim_interfaces(s, s->configuration);
 419 }
 420
 421 static void usb_host_handle_destroy(USBDevice *dev)
 422 {
 423     USBHostDevice *s = (USBHostDevice *)dev;
 424
 425     s->closing = 1;
 426
 427     qemu_set_fd_handler(s->fd, NULL, NULL, NULL);
 428
 429     hostdev_unlink(s);
 430
 431     async_complete(s);
 432
 433     if (s->fd >= 0)
 434         close(s->fd);
 435
 436     qemu_free(s);
 437 }
 438
 439 static int usb_linux_update_endp_table(USBHostDevice *s);
 440
 441 static int usb_host_handle_data(USBHostDevice *s, USBPacket *p)
 442 {
 443     struct usbdevfs_urb *urb;
 444     AsyncURB *aurb;
 445     int ret;
 446
 447     aurb = async_alloc();
 448     aurb->hdev   = s;
 449     aurb->packet = p;
 450
 451     urb = &aurb->urb;
 452
 453     if (p->pid == USB_TOKEN_IN)
 454         urb->endpoint = p->devep | 0x80;
 455     else
 456         urb->endpoint = p->devep;
 457
 458     if (is_halted(s, p->devep)) {
 459         ret = ioctl(s->fd, USBDEVFS_CLEAR_HALT, &urb->endpoint);
 460         if (ret < 0) {
 461             dprintf("husb: failed to clear halt. ep 0x%x errno %d\n",
 462                    urb->endpoint, errno);
 463             return USB_RET_NAK;
 464         }
 465         clear_halt(s, p->devep);
 466     }
 467
 468     urb->buffer        = p->data;
 469     urb->buffer_length = p->len;
 470
 471     if (is_isoc(s, p->devep)) {
 472         /* Setup ISOC transfer */
 473         urb->type     = USBDEVFS_URB_TYPE_ISO;
 474         urb->flags    = USBDEVFS_URB_ISO_ASAP;
 475         urb->number_of_packets = 1;
 476         urb->iso_frame_desc[0].length = p->len;
 477     } else {
 478         /* Setup bulk transfer */
 479         urb->type     = USBDEVFS_URB_TYPE_BULK;
 480     }
 481
 482     urb->usercontext = s;
 483
 484     ret = ioctl(s->fd, USBDEVFS_SUBMITURB, urb);
 485
 486     dprintf("husb: data submit. ep 0x%x len %u aurb %p\n", urb->endpoint, p->len, aurb);
 487
 488     if (ret < 0) {
 489         dprintf("husb: submit failed. errno %d\n", errno);
 490         async_free(aurb);
 491
 492         switch(errno) {
 493         case ETIMEDOUT:
 494             return USB_RET_NAK;
 495         case EPIPE:
 496         default:
 497             return USB_RET_STALL;
 498         }
 499     }
 500
 501     usb_defer_packet(p, async_cancel, aurb);
 502     return USB_RET_ASYNC;
 503 }
 504
 505 static int ctrl_error(void)
 506 {
 507     if (errno == ETIMEDOUT)
 508         return USB_RET_NAK;
 509     else
 510         return USB_RET_STALL;
 511 }
 512
 513 static int usb_host_set_address(USBHostDevice *s, int addr)
 514 {
 515     dprintf("husb: ctrl set addr %u\n", addr);
 516     s->dev.addr = addr;
 517     return 0;
 518 }
 519
 520 static int usb_host_set_config(USBHostDevice *s, int config)
 521 {
 522     usb_host_release_interfaces(s);
 523
 524     int ret = ioctl(s->fd, USBDEVFS_SETCONFIGURATION, &config);
 525
 526     dprintf("husb: ctrl set config %d ret %d errno %d\n", config, ret, errno);
 527
 528     if (ret < 0)
 529         return ctrl_error();
 530
 531     usb_host_claim_interfaces(s, config);
 532     return 0;
 533 }
 534
 535 static int usb_host_set_interface(USBHostDevice *s, int iface, int alt)
 536 {
 537     struct usbdevfs_setinterface si;
 538     int ret;
 539
 540     si.interface  = iface;
 541     si.altsetting = alt;
 542     ret = ioctl(s->fd, USBDEVFS_SETINTERFACE, &si);
 543
 544     dprintf("husb: ctrl set iface %d altset %d ret %d errno %d\n",
 545         iface, alt, ret, errno);
 546
 547     if (ret < 0)
 548         return ctrl_error();
 549
 550     usb_linux_update_endp_table(s);
 551     return 0;
 552 }
 553
 554 static int usb_host_handle_control(USBHostDevice *s, USBPacket *p)
 555 {
 556     struct usbdevfs_urb *urb;
 557     AsyncURB *aurb;
 558     int ret, value, index;
 559
 560     /*
 561      * Process certain standard device requests.
 562      * These are infrequent and are processed synchronously.
 563      */
 564     value = le16_to_cpu(s->ctrl.req.wValue);
 565     index = le16_to_cpu(s->ctrl.req.wIndex);
 566
 567     dprintf("husb: ctrl type 0x%x req 0x%x val 0x%x index %u len %u\n",
 568         s->ctrl.req.bRequestType, s->ctrl.req.bRequest, value, index,
 569         s->ctrl.len);
 570
 571     if (s->ctrl.req.bRequestType == 0) {
 572         switch (s->ctrl.req.bRequest) {
 573         case USB_REQ_SET_ADDRESS:
 574             return usb_host_set_address(s, value);
 575
 576         case USB_REQ_SET_CONFIGURATION:
 577             return usb_host_set_config(s, value & 0xff);
 578         }
 579     }
 580
 581     if (s->ctrl.req.bRequestType == 1 &&
 582                   s->ctrl.req.bRequest == USB_REQ_SET_INTERFACE)
 583         return usb_host_set_interface(s, index, value);
 584
 585     /* The rest are asynchronous */
 586
 587     aurb = async_alloc();
 588     aurb->hdev   = s;
 589     aurb->packet = p;
 590
 591     /*
 592      * Setup ctrl transfer.
 593      *
 594      * s->ctrl is layed out such that data buffer immediately follows
 595      * 'req' struct which is exactly what usbdevfs expects.
 596      */
 597     urb = &aurb->urb;
 598
 599     urb->type     = USBDEVFS_URB_TYPE_CONTROL;
 600     urb->endpoint = p->devep;
 601
 602     urb->buffer        = &s->ctrl.req;
 603     urb->buffer_length = 8 + s->ctrl.len;
 604
 605     urb->usercontext = s;
 606
 607     ret = ioctl(s->fd, USBDEVFS_SUBMITURB, urb);
 608
 609     dprintf("husb: submit ctrl. len %u aurb %p\n", urb->buffer_length, aurb);
 610
 611     if (ret < 0) {
 612         dprintf("husb: submit failed. errno %d\n", errno);
 613         async_free(aurb);
 614
 615         switch(errno) {
 616         case ETIMEDOUT:
 617             return USB_RET_NAK;
 618         case EPIPE:
 619         default:
 620             return USB_RET_STALL;
 621         }
 622     }
 623
 624     usb_defer_packet(p, async_cancel, aurb);
 625     return USB_RET_ASYNC;
 626 }
 627
 628 static int do_token_setup(USBDevice *dev, USBPacket *p)
 629 {
 630     USBHostDevice *s = (USBHostDevice *) dev;
 631     int ret = 0;
 632
 633     if (p->len != 8)
 634         return USB_RET_STALL;
 635
 636     memcpy(&s->ctrl.req, p->data, 8);
 637     s->ctrl.len    = le16_to_cpu(s->ctrl.req.wLength);
 638     s->ctrl.offset = 0;
 639     s->ctrl.state  = CTRL_STATE_SETUP;
 640
 641     if (s->ctrl.req.bRequestType & USB_DIR_IN) {
 642         ret = usb_host_handle_control(s, p);
 643         if (ret < 0)
 644             return ret;
 645
 646         if (ret < s->ctrl.len)
 647             s->ctrl.len = ret;
 648         s->ctrl.state = CTRL_STATE_DATA;
 649     } else {
 650         if (s->ctrl.len == 0)
 651             s->ctrl.state = CTRL_STATE_ACK;
 652         else
 653             s->ctrl.state = CTRL_STATE_DATA;
 654     }
 655
 656     return ret;
 657 }
 658
 659 static int do_token_in(USBDevice *dev, USBPacket *p)
 660 {
 661     USBHostDevice *s = (USBHostDevice *) dev;
 662     int ret = 0;
 663
 664     if (p->devep != 0)
 665         return usb_host_handle_data(s, p);
 666
 667     switch(s->ctrl.state) {
 668     case CTRL_STATE_ACK:
 669         if (!(s->ctrl.req.bRequestType & USB_DIR_IN)) {
 670             ret = usb_host_handle_control(s, p);
 671             if (ret == USB_RET_ASYNC)
 672                 return USB_RET_ASYNC;
 673
 674             s->ctrl.state = CTRL_STATE_IDLE;
 675             return ret > 0 ? 0 : ret;
 676         }
 677
 678         return 0;
 679
 680     case CTRL_STATE_DATA:
 681         if (s->ctrl.req.bRequestType & USB_DIR_IN) {
 682             int len = s->ctrl.len - s->ctrl.offset;
 683             if (len > p->len)
 684                 len = p->len;
 685             memcpy(p->data, s->ctrl.buffer + s->ctrl.offset, len);
 686             s->ctrl.offset += len;
 687             if (s->ctrl.offset >= s->ctrl.len)
 688                 s->ctrl.state = CTRL_STATE_ACK;
 689             return len;
 690         }
 691
 692         s->ctrl.state = CTRL_STATE_IDLE;
 693         return USB_RET_STALL;
 694
 695     default:
 696         return USB_RET_STALL;
 697     }
 698 }
 699
 700 static int do_token_out(USBDevice *dev, USBPacket *p)
 701 {
 702     USBHostDevice *s = (USBHostDevice *) dev;
 703
 704     if (p->devep != 0)
 705         return usb_host_handle_data(s, p);
 706
 707     switch(s->ctrl.state) {
 708     case CTRL_STATE_ACK:
 709         if (s->ctrl.req.bRequestType & USB_DIR_IN) {
 710             s->ctrl.state = CTRL_STATE_IDLE;
 711             /* transfer OK */
 712         } else {
 713             /* ignore additional output */
 714         }
 715         return 0;
 716
 717     case CTRL_STATE_DATA:
 718         if (!(s->ctrl.req.bRequestType & USB_DIR_IN)) {
 719             int len = s->ctrl.len - s->ctrl.offset;
 720             if (len > p->len)
 721                 len = p->len;
 722             memcpy(s->ctrl.buffer + s->ctrl.offset, p->data, len);
 723             s->ctrl.offset += len;
 724             if (s->ctrl.offset >= s->ctrl.len)
 725                 s->ctrl.state = CTRL_STATE_ACK;
 726             return len;
 727         }
 728
 729         s->ctrl.state = CTRL_STATE_IDLE;
 730         return USB_RET_STALL;
 731
 732     default:
 733         return USB_RET_STALL;
 734     }
 735 }
 736
 737 /*
 738  * Packet handler.
 739  * Called by the HC (host controller).
 740  *
 741  * Returns length of the transaction or one of the USB_RET_XXX codes.
 742  */
 743 static int usb_host_handle_packet(USBDevice *s, USBPacket *p)
 744 {
 745     switch(p->pid) {
 746     case USB_MSG_ATTACH:
 747         s->state = USB_STATE_ATTACHED;
 748         return 0;
 749
 750     case USB_MSG_DETACH:
 751         s->state = USB_STATE_NOTATTACHED;
 752         return 0;
 753
 754     case USB_MSG_RESET:
 755         s->remote_wakeup = 0;
 756         s->addr = 0;
 757         s->state = USB_STATE_DEFAULT;
 758         s->handle_reset(s);
 759         return 0;
 760     }
 761
 762     /* Rest of the PIDs must match our address */
 763     if (s->state < USB_STATE_DEFAULT || p->devaddr != s->addr)
 764         return USB_RET_NODEV;
 765
 766     switch (p->pid) {
 767     case USB_TOKEN_SETUP:
 768         return do_token_setup(s, p);
 769
 770     case USB_TOKEN_IN:
 771         return do_token_in(s, p);
 772
 773     case USB_TOKEN_OUT:
 774         return do_token_out(s, p);
 775
 776     default:
 777         return USB_RET_STALL;
 778     }
 779 }
 780
 781 /* returns 1 on problem encountered or 0 for success */
 782 static int usb_linux_update_endp_table(USBHostDevice *s)
 783 {
 784     uint8_t *descriptors;
 785     uint8_t devep, type, configuration, alt_interface;
 786     struct usb_ctrltransfer ct;
 787     int interface, ret, length, i;
 788
 789     ct.bRequestType = USB_DIR_IN;
 790     ct.bRequest = USB_REQ_GET_CONFIGURATION;
 791     ct.wValue = 0;
 792     ct.wIndex = 0;
 793     ct.wLength = 1;
 794     ct.data = &configuration;
 795     ct.timeout = 50;
 796
 797     ret = ioctl(s->fd, USBDEVFS_CONTROL, &ct);
 798     if (ret < 0) {
 799         perror("usb_linux_update_endp_table");
 800         return 1;
 801     }
 802
 803     /* in address state */
 804     if (configuration == 0)
 805         return 1;
 806
 807     /* get the desired configuration, interface, and endpoint descriptors
 808      * from device description */
 809     descriptors = &s->descr[18];
 810     length = s->descr_len - 18;
 811     i = 0;
 812
 813     if (descriptors[i + 1] != USB_DT_CONFIG ||
 814         descriptors[i + 5] != configuration) {
 815         dprintf("invalid descriptor data - configuration\n");
 816         return 1;
 817     }
 818     i += descriptors[i];
 819
 820     while (i < length) {
 821         if (descriptors[i + 1] != USB_DT_INTERFACE ||
 822             (descriptors[i + 1] == USB_DT_INTERFACE &&
 823              descriptors[i + 4] == 0)) {
 824             i += descriptors[i];
 825             continue;
 826         }
 827
 828         interface = descriptors[i + 2];
 829
 830         ct.bRequestType = USB_DIR_IN | USB_RECIP_INTERFACE;
 831         ct.bRequest = USB_REQ_GET_INTERFACE;
 832         ct.wValue = 0;
 833         ct.wIndex = interface;
 834         ct.wLength = 1;
 835         ct.data = &alt_interface;
 836         ct.timeout = 50;
 837
 838         ret = ioctl(s->fd, USBDEVFS_CONTROL, &ct);
 839         if (ret < 0) {
 840             perror("usb_linux_update_endp_table");
 841             return 1;
 842         }
 843
 844         /* the current interface descriptor is the active interface
 845          * and has endpoints */
 846         if (descriptors[i + 3] != alt_interface) {
 847             i += descriptors[i];
 848             continue;
 849         }
 850
 851         /* advance to the endpoints */
 852         while (i < length && descriptors[i +1] != USB_DT_ENDPOINT)
 853             i += descriptors[i];
 854
 855         if (i >= length)
 856             break;
 857
 858         while (i < length) {
 859             if (descriptors[i + 1] != USB_DT_ENDPOINT)
 860                 break;
 861
 862             devep = descriptors[i + 2];
 863             switch (descriptors[i + 3] & 0x3) {
 864             case 0x00:
 865                 type = USBDEVFS_URB_TYPE_CONTROL;
 866                 break;
 867             case 0x01:
 868                 type = USBDEVFS_URB_TYPE_ISO;
 869                 break;
 870             case 0x02:
 871                 type = USBDEVFS_URB_TYPE_BULK;
 872                 break;
 873             case 0x03:
 874                 type = USBDEVFS_URB_TYPE_INTERRUPT;
 875                 break;
 876             default:
 877                 dprintf("usb_host: malformed endpoint type\n");
 878                 type = USBDEVFS_URB_TYPE_BULK;
 879             }
 880             s->endp_table[(devep & 0xf) - 1].type = type;
 881             s->endp_table[(devep & 0xf) - 1].halted = 0;
 882
 883             i += descriptors[i];
 884         }
 885     }
 886     return 0;
 887 }
 888
 889 static USBDevice *usb_host_device_open_addr(int bus_num, int addr, const char *prod_name)
 890 {
 891     int fd = -1, ret;
 892     USBHostDevice *dev = NULL;
 893     struct usbdevfs_connectinfo ci;
 894     char buf[1024];
 895
 896     dev = qemu_mallocz(sizeof(USBHostDevice));
 897
 898     dev->bus_num = bus_num;
 899     dev->addr = addr;
 900
 901     printf("husb: open device %d.%d\n", bus_num, addr);
 902
 903     if (!usb_host_device_path) {
 904         perror("husb: USB Host Device Path not set");
 905         goto fail;
 906     }
 907     snprintf(buf, sizeof(buf), "%s/%03d/%03d", usb_host_device_path,
 908              bus_num, addr);
 909     fd = open(buf, O_RDWR | O_NONBLOCK);
 910     if (fd < 0) {
 911         perror(buf);
 912         goto fail;
 913     }
 914     dprintf("husb: opened %s\n", buf);
 915
 916     /* read the device description */
 917     dev->descr_len = read(fd, dev->descr, sizeof(dev->descr));
 918     if (dev->descr_len <= 0) {
 919         perror("husb: reading device data failed");
 920         goto fail;
 921     }
 922
 923 #ifdef DEBUG
 924     {
 925         int x;
 926         printf("=== begin dumping device descriptor data ===\n");
 927         for (x = 0; x < dev->descr_len; x++)
 928             printf("%02x ", dev->descr[x]);
 929         printf("\n=== end dumping device descriptor data ===\n");
 930     }
 931 #endif
 932
 933     dev->fd = fd;
 934
 935     /*
 936      * Initial configuration is -1 which makes us claim first
 937      * available config. We used to start with 1, which does not
 938      * always work. I've seen devices where first config starts
 939      * with 2.
 940      */
 941     if (!usb_host_claim_interfaces(dev, -1))
 942         goto fail;
 943
 944     ret = ioctl(fd, USBDEVFS_CONNECTINFO, &ci);
 945     if (ret < 0) {
 946         perror("usb_host_device_open: USBDEVFS_CONNECTINFO");
 947         goto fail;
 948     }
 949
 950     printf("husb: grabbed usb device %d.%d\n", bus_num, addr);
 951
 952     ret = usb_linux_update_endp_table(dev);
 953     if (ret)
 954         goto fail;
 955
 956     if (ci.slow)
 957         dev->dev.speed = USB_SPEED_LOW;
 958     else
 959         dev->dev.speed = USB_SPEED_HIGH;
 960
 961     dev->dev.handle_packet  = usb_host_handle_packet;
 962     dev->dev.handle_reset   = usb_host_handle_reset;
 963     dev->dev.handle_destroy = usb_host_handle_destroy;
 964
 965     if (!prod_name || prod_name[0] == '\0')
 966         snprintf(dev->dev.devname, sizeof(dev->dev.devname),
 967                  "host:%d.%d", bus_num, addr);
 968     else
 969         pstrcpy(dev->dev.devname, sizeof(dev->dev.devname),
 970                 prod_name);
 971
 972     /* USB devio uses 'write' flag to check for async completions */
 973     qemu_set_fd_handler(dev->fd, NULL, async_complete, dev);
 974
 975     hostdev_link(dev);
 976
 977     return (USBDevice *) dev;
 978
 979 fail:
 980     if (dev)
 981         qemu_free(dev);
 982
 983     close(fd);
 984     return NULL;
 985 }
 986
 987 static int usb_host_auto_add(const char *spec);
 988 static int usb_host_auto_del(const char *spec);
 989
 990 USBDevice *usb_host_device_open(const char *devname)
 991 {
 992     int bus_num, addr;
 993     char product_name[PRODUCT_NAME_SZ];
 994
 995     if (strstr(devname, "auto:")) {
 996         usb_host_auto_add(devname);
 997         return NULL;
 998     }
 999
1000     if (usb_host_find_device(&bus_num, &addr, product_name, sizeof(product_name),
1001                              devname) < 0)
1002         return NULL;
1003
1004     if (hostdev_find(bus_num, addr)) {
1005        term_printf("husb: host usb device %d.%d is already open\n", bus_num, addr);
1006        return NULL;
1007     }
1008
1009     return usb_host_device_open_addr(bus_num, addr, product_name);
1010 }
1011
1012 int usb_host_device_close(const char *devname)
1013 {
1014     char product_name[PRODUCT_NAME_SZ];
1015     int bus_num, addr;
1016     USBHostDevice *s;
1017
1018     if (strstr(devname, "auto:"))
1019         return usb_host_auto_del(devname);
1020
1021     if (usb_host_find_device(&bus_num, &addr, product_name, sizeof(product_name),
1022                              devname) < 0)
1023         return -1;
1024
1025     s = hostdev_find(bus_num, addr);
1026     if (s) {
1027         usb_device_del_addr(0, s->dev.addr);
1028         return 0;
1029     }
1030
1031     return -1;
1032 }
1033
1034 static int get_tag_value(char *buf, int buf_size,
1035                          const char *str, const char *tag,
1036                          const char *stopchars)
1037 {
1038     const char *p;
1039     char *q;
1040     p = strstr(str, tag);
1041     if (!p)
1042         return -1;
1043     p += strlen(tag);
1044     while (qemu_isspace(*p))
1045         p++;
1046     q = buf;
1047     while (*p != '\0' && !strchr(stopchars, *p)) {
1048         if ((q - buf) < (buf_size - 1))
1049             *q++ = *p;
1050         p++;
1051     }
1052     *q = '\0';
1053     return q - buf;
1054 }
1055
1056 /*
1057  * Use /proc/bus/usb/devices or /dev/bus/usb/devices file to determine
1058  * host's USB devices. This is legacy support since many distributions
1059  * are moving to /sys/bus/usb
1060  */
1061 static int usb_host_scan_dev(void *opaque, USBScanFunc *func)
1062 {
1063     FILE *f = 0;
1064     char line[1024];
1065     char buf[1024];
1066     int bus_num, addr, speed, device_count, class_id, product_id, vendor_id;
1067     char product_name[512];
1068     int ret = 0;
1069
1070     if (!usb_host_device_path) {
1071         perror("husb: USB Host Device Path not set");
1072         goto the_end;
1073     }
1074     snprintf(line, sizeof(line), "%s/devices", usb_host_device_path);
1075     f = fopen(line, "r");
1076     if (!f) {
1077         perror("husb: cannot open devices file");
1078         goto the_end;
1079     }
1080
1081     device_count = 0;
1082     bus_num = addr = speed = class_id = product_id = vendor_id = 0;
1083     for(;;) {
1084         if (fgets(line, sizeof(line), f) == NULL)
1085             break;
1086         if (strlen(line) > 0)
1087             line[strlen(line) - 1] = '\0';
1088         if (line[0] == 'T' && line[1] == ':') {
1089             if (device_count && (vendor_id || product_id)) {
1090                 /* New device.  Add the previously discovered device.  */
1091                 ret = func(opaque, bus_num, addr, class_id, vendor_id,
1092                            product_id, product_name, speed);
1093                 if (ret)
1094                     goto the_end;
1095             }
1096             if (get_tag_value(buf, sizeof(buf), line, "Bus=", " ") < 0)
1097                 goto fail;
1098             bus_num = atoi(buf);
1099             if (get_tag_value(buf, sizeof(buf), line, "Dev#=", " ") < 0)
1100                 goto fail;
1101             addr = atoi(buf);
1102             if (get_tag_value(buf, sizeof(buf), line, "Spd=", " ") < 0)
1103                 goto fail;
1104             if (!strcmp(buf, "480"))
1105                 speed = USB_SPEED_HIGH;
1106             else if (!strcmp(buf, "1.5"))
1107                 speed = USB_SPEED_LOW;
1108             else
1109                 speed = USB_SPEED_FULL;
1110             product_name[0] = '\0';
1111             class_id = 0xff;
1112             device_count++;
1113             product_id = 0;
1114             vendor_id = 0;
1115         } else if (line[0] == 'P' && line[1] == ':') {
1116             if (get_tag_value(buf, sizeof(buf), line, "Vendor=", " ") < 0)
1117                 goto fail;
1118             vendor_id = strtoul(buf, NULL, 16);
1119             if (get_tag_value(buf, sizeof(buf), line, "ProdID=", " ") < 0)
1120                 goto fail;
1121             product_id = strtoul(buf, NULL, 16);
1122         } else if (line[0] == 'S' && line[1] == ':') {
1123             if (get_tag_value(buf, sizeof(buf), line, "Product=", "") < 0)
1124                 goto fail;
1125             pstrcpy(product_name, sizeof(product_name), buf);
1126         } else if (line[0] == 'D' && line[1] == ':') {
1127             if (get_tag_value(buf, sizeof(buf), line, "Cls=", " (") < 0)
1128                 goto fail;
1129             class_id = strtoul(buf, NULL, 16);
1130         }
1131     fail: ;
1132     }
1133     if (device_count && (vendor_id || product_id)) {
1134         /* Add the last device.  */
1135         ret = func(opaque, bus_num, addr, class_id, vendor_id,
1136                    product_id, product_name, speed);
1137     }
1138  the_end:
1139     if (f)
1140         fclose(f);
1141     return ret;
1142 }
1143
1144 /*
1145  * Read sys file-system device file
1146  *
1147  * @line address of buffer to put file contents in
1148  * @line_size size of line
1149  * @device_file path to device file (printf format string)
1150  * @device_name device being opened (inserted into device_file)
1151  *
1152  * @return 0 failed, 1 succeeded ('line' contains data)
1153  */
1154 static int usb_host_read_file(char *line, size_t line_size, const char *device_file, const char *device_name)
1155 {
1156     FILE *f;
1157     int ret = 0;
1158     char filename[PATH_MAX];
1159
1160     snprintf(filename, PATH_MAX, USBSYSBUS_PATH "/devices/%s/%s", device_name,
1161              device_file);
1162     f = fopen(filename, "r");
1163     if (f) {
1164         fgets(line, line_size, f);
1165         fclose(f);
1166         ret = 1;
1167     } else {
1168         term_printf("husb: could not open %s\n", filename);
1169     }
1170
1171     return ret;
1172 }
1173
1174 /*
1175  * Use /sys/bus/usb/devices/ directory to determine host's USB
1176  * devices.
1177  *
1178  * This code is based on Robert Schiele's original patches posted to
1179  * the Novell bug-tracker https://bugzilla.novell.com/show_bug.cgi?id=241950
1180  */
1181 static int usb_host_scan_sys(void *opaque, USBScanFunc *func)
1182 {
1183     DIR *dir = 0;
1184     char line[1024];
1185     int bus_num, addr, speed, class_id, product_id, vendor_id;
1186     int ret = 0;
1187     char product_name[512];
1188     struct dirent *de;
1189
1190     dir = opendir(USBSYSBUS_PATH "/devices");
1191     if (!dir) {
1192         perror("husb: cannot open devices directory");
1193         goto the_end;
1194     }
1195
1196     while ((de = readdir(dir))) {
1197         if (de->d_name[0] != '.' && !strchr(de->d_name, ':')) {
1198             char *tmpstr = de->d_name;
1199             if (!strncmp(de->d_name, "usb", 3))
1200                 tmpstr += 3;
1201             bus_num = atoi(tmpstr);
1202
1203             if (!usb_host_read_file(line, sizeof(line), "devnum", de->d_name))
1204                 goto the_end;
1205             if (sscanf(line, "%d", &addr) != 1)
1206                 goto the_end;
1207
1208             if (!usb_host_read_file(line, sizeof(line), "bDeviceClass",
1209                                     de->d_name))
1210                 goto the_end;
1211             if (sscanf(line, "%x", &class_id) != 1)
1212                 goto the_end;
1213
1214             if (!usb_host_read_file(line, sizeof(line), "idVendor", de->d_name))
1215                 goto the_end;
1216             if (sscanf(line, "%x", &vendor_id) != 1)
1217                 goto the_end;
1218
1219             if (!usb_host_read_file(line, sizeof(line), "idProduct",
1220                                     de->d_name))
1221                 goto the_end;
1222             if (sscanf(line, "%x", &product_id) != 1)
1223                 goto the_end;
1224
1225             if (!usb_host_read_file(line, sizeof(line), "product",
1226                                     de->d_name)) {
1227                 *product_name = 0;
1228             } else {
1229                 if (strlen(line) > 0)
1230                     line[strlen(line) - 1] = '\0';
1231                 pstrcpy(product_name, sizeof(product_name), line);
1232             }
1233
1234             if (!usb_host_read_file(line, sizeof(line), "speed", de->d_name))
1235                 goto the_end;
1236             if (!strcmp(line, "480\n"))
1237                 speed = USB_SPEED_HIGH;
1238             else if (!strcmp(line, "1.5\n"))
1239                 speed = USB_SPEED_LOW;
1240             else
1241                 speed = USB_SPEED_FULL;
1242
1243             ret = func(opaque, bus_num, addr, class_id, vendor_id,
1244                        product_id, product_name, speed);
1245             if (ret)
1246                 goto the_end;
1247         }
1248     }
1249  the_end:
1250     if (dir)
1251         closedir(dir);
1252     return ret;
1253 }
1254
1255 /*
1256  * Determine how to access the host's USB devices and call the
1257  * specific support function.
1258  */
1259 static int usb_host_scan(void *opaque, USBScanFunc *func)
1260 {
1261     FILE *f = 0;
1262     DIR *dir = 0;
1263     int ret = 0;
1264     const char *fs_type[] = {"unknown", "proc", "dev", "sys"};
1265     char devpath[PATH_MAX];
1266
1267     /* only check the host once */
1268     if (!usb_fs_type) {
1269         f = fopen(USBPROCBUS_PATH "/devices", "r");
1270         if (f) {
1271             /* devices found in /proc/bus/usb/ */
1272             strcpy(devpath, USBPROCBUS_PATH);
1273             usb_fs_type = USB_FS_PROC;
1274             fclose(f);
1275             dprintf(USBDBG_DEVOPENED, USBPROCBUS_PATH);
1276             goto found_devices;
1277         }
1278         /* try additional methods if an access method hasn't been found yet */
1279         f = fopen(USBDEVBUS_PATH "/devices", "r");
1280         if (f) {
1281             /* devices found in /dev/bus/usb/ */
1282             strcpy(devpath, USBDEVBUS_PATH);
1283             usb_fs_type = USB_FS_DEV;
1284             fclose(f);
1285             dprintf(USBDBG_DEVOPENED, USBDEVBUS_PATH);
1286             goto found_devices;
1287         }
1288         dir = opendir(USBSYSBUS_PATH "/devices");
1289         if (dir) {
1290             /* devices found in /dev/bus/usb/ (yes - not a mistake!) */
1291             strcpy(devpath, USBDEVBUS_PATH);
1292             usb_fs_type = USB_FS_SYS;
1293             closedir(dir);
1294             dprintf(USBDBG_DEVOPENED, USBSYSBUS_PATH);
1295             goto found_devices;
1296         }
1297     found_devices:
1298         if (!usb_fs_type) {
1299             term_printf("husb: unable to access USB devices\n");
1300             return -ENOENT;
1301         }
1302
1303         /* the module setting (used later for opening devices) */
1304         usb_host_device_path = qemu_mallocz(strlen(devpath)+1);
1305         strcpy(usb_host_device_path, devpath);
1306         term_printf("husb: using %s file-system with %s\n", fs_type[usb_fs_type], usb_host_device_path);
1307     }
1308
1309     switch (usb_fs_type) {
1310     case USB_FS_PROC:
1311     case USB_FS_DEV:
1312         ret = usb_host_scan_dev(opaque, func);
1313         break;
1314     case USB_FS_SYS:
1315         ret = usb_host_scan_sys(opaque, func);
1316         break;
1317     default:
1318         ret = -EINVAL;
1319         break;
1320     }
1321     return ret;
1322 }
1323
1324 struct USBAutoFilter {
1325     struct USBAutoFilter *next;
1326     int bus_num;
1327     int addr;
1328     int vendor_id;
1329     int product_id;
1330 };
1331
1332 static QEMUTimer *usb_auto_timer;
1333 static struct USBAutoFilter *usb_auto_filter;
1334
1335 static int usb_host_auto_scan(void *opaque, int bus_num, int addr,
1336                      int class_id, int vendor_id, int product_id,
1337                      const char *product_name, int speed)
1338 {
1339     struct USBAutoFilter *f;
1340     struct USBDevice *dev;
1341
1342     /* Ignore hubs */
1343     if (class_id == 9)
1344         return 0;
1345
1346     for (f = usb_auto_filter; f; f = f->next) {
1347         if (f->bus_num >= 0 && f->bus_num != bus_num)
1348             continue;
1349
1350         if (f->addr >= 0 && f->addr != addr)
1351             continue;
1352
1353         if (f->vendor_id >= 0 && f->vendor_id != vendor_id)
1354             continue;
1355
1356         if (f->product_id >= 0 && f->product_id != product_id)
1357             continue;
1358
1359         /* We got a match */
1360
1361         /* Allredy attached ? */
1362         if (hostdev_find(bus_num, addr))
1363             return 0;
1364
1365         dprintf("husb: auto open: bus_num %d addr %d\n", bus_num, addr);
1366
1367         dev = usb_host_device_open_addr(bus_num, addr, product_name);
1368         if (dev)
1369             usb_device_add_dev(dev);
1370     }
1371
1372     return 0;
1373 }
1374
1375 static void usb_host_auto_timer(void *unused)
1376 {
1377     usb_host_scan(NULL, usb_host_auto_scan);
1378     qemu_mod_timer(usb_auto_timer, qemu_get_clock(rt_clock) + 2000);
1379 }
1380
1381 /*
1382  * Autoconnect filter
1383  * Format:
1384  *    auto:bus:dev[:vid:pid]
1385  *    auto:bus.dev[:vid:pid]
1386  *
1387  *    bus  - bus number    (dec, * means any)
1388  *    dev  - device number (dec, * means any)
1389  *    vid  - vendor id     (hex, * means any)
1390  *    pid  - product id    (hex, * means any)
1391  *
1392  *    See 'lsusb' output.
1393  */
1394 static int parse_filter(const char *spec, struct USBAutoFilter *f)
1395 {
1396     enum { BUS, DEV, VID, PID, DONE };
1397     const char *p = spec;
1398     int i;
1399
1400     f->bus_num    = -1;
1401     f->addr       = -1;
1402     f->vendor_id  = -1;
1403     f->product_id = -1;
1404
1405     for (i = BUS; i < DONE; i++) {
1406         p = strpbrk(p, ":.");
1407         if (!p) break;
1408         p++;
1409
1410         if (*p == '*')
1411             continue;
1412
1413         switch(i) {
1414         case BUS: f->bus_num = strtol(p, NULL, 10);    break;
1415         case DEV: f->addr    = strtol(p, NULL, 10);    break;
1416         case VID: f->vendor_id  = strtol(p, NULL, 16); break;
1417         case PID: f->product_id = strtol(p, NULL, 16); break;
1418         }
1419     }
1420
1421     if (i < DEV) {
1422         fprintf(stderr, "husb: invalid auto filter spec %s\n", spec);
1423         return -1;
1424     }
1425
1426     return 0;
1427 }
1428
1429 static int match_filter(const struct USBAutoFilter *f1,
1430                         const struct USBAutoFilter *f2)
1431 {
1432     return f1->bus_num    == f2->bus_num &&
1433            f1->addr       == f2->addr &&
1434            f1->vendor_id  == f2->vendor_id &&
1435            f1->product_id == f2->product_id;
1436 }
1437
1438 static int usb_host_auto_add(const char *spec)
1439 {
1440     struct USBAutoFilter filter, *f;
1441
1442     if (parse_filter(spec, &filter) < 0)
1443         return -1;
1444
1445     f = qemu_mallocz(sizeof(*f));
1446
1447     *f = filter;
1448
1449     if (!usb_auto_filter) {
1450         /*
1451          * First entry. Init and start the monitor.
1452          * Right now we're using timer to check for new devices.
1453          * If this turns out to be too expensive we can move that into a
1454          * separate thread.
1455          */
1456         usb_auto_timer = qemu_new_timer(rt_clock, usb_host_auto_timer, NULL);
1457         if (!usb_auto_timer) {
1458             fprintf(stderr, "husb: failed to allocate auto scan timer\n");
1459             qemu_free(f);
1460             return -1;
1461         }
1462
1463         /* Check for new devices every two seconds */
1464         qemu_mod_timer(usb_auto_timer, qemu_get_clock(rt_clock) + 2000);
1465     }
1466
1467     dprintf("husb: added auto filter: bus_num %d addr %d vid %d pid %d\n",
1468         f->bus_num, f->addr, f->vendor_id, f->product_id);
1469
1470     f->next = usb_auto_filter;
1471     usb_auto_filter = f;
1472
1473     return 0;
1474 }
1475
1476 static int usb_host_auto_del(const char *spec)
1477 {
1478     struct USBAutoFilter *pf = usb_auto_filter;
1479     struct USBAutoFilter **prev = &usb_auto_filter;
1480     struct USBAutoFilter filter;
1481
1482     if (parse_filter(spec, &filter) < 0)
1483         return -1;
1484
1485     while (pf) {
1486         if (match_filter(pf, &filter)) {
1487             dprintf("husb: removed auto filter: bus_num %d addr %d vid %d pid %d\n",
1488                      pf->bus_num, pf->addr, pf->vendor_id, pf->product_id);
1489
1490             *prev = pf->next;
1491
1492             if (!usb_auto_filter) {
1493                 /* No more filters. Stop scanning. */
1494                 qemu_del_timer(usb_auto_timer);
1495                 qemu_free_timer(usb_auto_timer);
1496             }
1497
1498             return 0;
1499         }
1500
1501         prev = &pf->next;
1502         pf   = pf->next;
1503     }
1504
1505     return -1;
1506 }
1507
1508 typedef struct FindDeviceState {
1509     int vendor_id;
1510     int product_id;
1511     int bus_num;
1512     int addr;
1513     char product_name[PRODUCT_NAME_SZ];
1514 } FindDeviceState;
1515
1516 static int usb_host_find_device_scan(void *opaque, int bus_num, int addr,
1517                                      int class_id,
1518                                      int vendor_id, int product_id,
1519                                      const char *product_name, int speed)
1520 {
1521     FindDeviceState *s = opaque;
1522     if ((vendor_id == s->vendor_id &&
1523         product_id == s->product_id) ||
1524         (bus_num == s->bus_num &&
1525         addr == s->addr)) {
1526         pstrcpy(s->product_name, PRODUCT_NAME_SZ, product_name);
1527         s->bus_num = bus_num;
1528         s->addr = addr;
1529         return 1;
1530     } else {
1531         return 0;
1532     }
1533 }
1534
1535 /* the syntax is :
1536    'bus.addr' (decimal numbers) or
1537    'vendor_id:product_id' (hexa numbers) */
1538 static int usb_host_find_device(int *pbus_num, int *paddr,
1539                                 char *product_name, int product_name_size,
1540                                 const char *devname)
1541 {
1542     const char *p;
1543     int ret;
1544     FindDeviceState fs;
1545
1546     p = strchr(devname, '.');
1547     if (p) {
1548         *pbus_num = strtoul(devname, NULL, 0);
1549         *paddr = strtoul(p + 1, NULL, 0);
1550         fs.bus_num = *pbus_num;
1551         fs.addr = *paddr;
1552         ret = usb_host_scan(&fs, usb_host_find_device_scan);
1553         if (ret)
1554             pstrcpy(product_name, product_name_size, fs.product_name);
1555         return 0;
1556     }
1557
1558     p = strchr(devname, ':');
1559     if (p) {
1560         fs.vendor_id = strtoul(devname, NULL, 16);
1561         fs.product_id = strtoul(p + 1, NULL, 16);
1562         ret = usb_host_scan(&fs, usb_host_find_device_scan);
1563         if (ret) {
1564             *pbus_num = fs.bus_num;
1565             *paddr = fs.addr;
1566             pstrcpy(product_name, product_name_size, fs.product_name);
1567             return 0;
1568         }
1569     }
1570     return -1;
1571 }
1572
1573 /**********************/
1574 /* USB host device info */
1575
1576 struct usb_class_info {
1577     int class;
1578     const char *class_name;
1579 };
1580
1581 static const struct usb_class_info usb_class_info[] = {
1582     { USB_CLASS_AUDIO, "Audio"},
1583     { USB_CLASS_COMM, "Communication"},
1584     { USB_CLASS_HID, "HID"},
1585     { USB_CLASS_HUB, "Hub" },
1586     { USB_CLASS_PHYSICAL, "Physical" },
1587     { USB_CLASS_PRINTER, "Printer" },
1588     { USB_CLASS_MASS_STORAGE, "Storage" },
1589     { USB_CLASS_CDC_DATA, "Data" },
1590     { USB_CLASS_APP_SPEC, "Application Specific" },
1591     { USB_CLASS_VENDOR_SPEC, "Vendor Specific" },
1592     { USB_CLASS_STILL_IMAGE, "Still Image" },
1593     { USB_CLASS_CSCID, "Smart Card" },
1594     { USB_CLASS_CONTENT_SEC, "Content Security" },
1595     { -1, NULL }
1596 };
1597
1598 static const char *usb_class_str(uint8_t class)
1599 {
1600     const struct usb_class_info *p;
1601     for(p = usb_class_info; p->class != -1; p++) {
1602         if (p->class == class)
1603             break;
1604     }
1605     return p->class_name;
1606 }
1607
1608 static void usb_info_device(int bus_num, int addr, int class_id,
1609                             int vendor_id, int product_id,
1610                             const char *product_name,
1611                             int speed)
1612 {
1613     const char *class_str, *speed_str;
1614
1615     switch(speed) {
1616     case USB_SPEED_LOW:
1617         speed_str = "1.5";
1618         break;
1619     case USB_SPEED_FULL:
1620         speed_str = "12";
1621         break;
1622     case USB_SPEED_HIGH:
1623         speed_str = "480";
1624         break;
1625     default:
1626         speed_str = "?";
1627         break;
1628     }
1629
1630     term_printf("  Device %d.%d, speed %s Mb/s\n",
1631                 bus_num, addr, speed_str);
1632     class_str = usb_class_str(class_id);
1633     if (class_str)
1634         term_printf("    %s:", class_str);
1635     else
1636         term_printf("    Class %02x:", class_id);
1637     term_printf(" USB device %04x:%04x", vendor_id, product_id);
1638     if (product_name[0] != '\0')
1639         term_printf(", %s", product_name);
1640     term_printf("\n");
1641 }
1642
1643 static int usb_host_info_device(void *opaque, int bus_num, int addr,
1644                                 int class_id,
1645                                 int vendor_id, int product_id,
1646                                 const char *product_name,
1647                                 int speed)
1648 {
1649     usb_info_device(bus_num, addr, class_id, vendor_id, product_id,
1650                     product_name, speed);
1651     return 0;
1652 }
1653
1654 static void dec2str(int val, char *str, size_t size)
1655 {
1656     if (val == -1)
1657         snprintf(str, size, "*");
1658     else
1659         snprintf(str, size, "%d", val);
1660 }
1661
1662 static void hex2str(int val, char *str, size_t size)
1663 {
1664     if (val == -1)
1665         snprintf(str, size, "*");
1666     else
1667         snprintf(str, size, "%x", val);
1668 }
1669
1670 void usb_host_info(void)
1671 {
1672     struct USBAutoFilter *f;
1673
1674     usb_host_scan(NULL, usb_host_info_device);
1675
1676     if (usb_auto_filter)
1677         term_printf("  Auto filters:\n");
1678     for (f = usb_auto_filter; f; f = f->next) {
1679         char bus[10], addr[10], vid[10], pid[10];
1680         dec2str(f->bus_num, bus, sizeof(bus));
1681         dec2str(f->addr, addr, sizeof(addr));
1682         hex2str(f->vendor_id, vid, sizeof(vid));
1683         hex2str(f->product_id, pid, sizeof(pid));
1684         term_printf("    Device %s.%s ID %s:%s\n", bus, addr, vid, pid);
1685     }
1686 }