hw/usb-bus.c

   1 #include "hw.h"
   2 #include "usb.h"
   3 #include "qdev.h"
   4 #include "sysemu.h"
   5 #include "monitor.h"
   6 #include "trace.h"
   7
   8 static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent);
   9
  10 static char *usb_get_dev_path(DeviceState *dev);
  11 static char *usb_get_fw_dev_path(DeviceState *qdev);
  12 static int usb_qdev_exit(DeviceState *qdev);
  13
  14 static struct BusInfo usb_bus_info = {
  15     .name      = "USB",
  16     .size      = sizeof(USBBus),
  17     .print_dev = usb_bus_dev_print,
  18     .get_dev_path = usb_get_dev_path,
  19     .get_fw_dev_path = usb_get_fw_dev_path,
  20     .props      = (Property[]) {
  21         DEFINE_PROP_STRING("port", USBDevice, port_path),
  22         DEFINE_PROP_END_OF_LIST()
  23     },
  24 };
  25 static int next_usb_bus = 0;
  26 static QTAILQ_HEAD(, USBBus) busses = QTAILQ_HEAD_INITIALIZER(busses);
  27
  28 const VMStateDescription vmstate_usb_device = {
  29     .name = "USBDevice",
  30     .version_id = 1,
  31     .minimum_version_id = 1,
  32     .fields = (VMStateField []) {
  33         VMSTATE_UINT8(addr, USBDevice),
  34         VMSTATE_INT32(state, USBDevice),
  35         VMSTATE_INT32(remote_wakeup, USBDevice),
  36         VMSTATE_INT32(setup_state, USBDevice),
  37         VMSTATE_INT32(setup_len, USBDevice),
  38         VMSTATE_INT32(setup_index, USBDevice),
  39         VMSTATE_UINT8_ARRAY(setup_buf, USBDevice, 8),
  40         VMSTATE_END_OF_LIST(),
  41     }
  42 };
  43
  44 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host)
  45 {
  46     qbus_create_inplace(&bus->qbus, &usb_bus_info, host, NULL);
  47     bus->ops = ops;
  48     bus->busnr = next_usb_bus++;
  49     bus->qbus.allow_hotplug = 1; /* Yes, we can */
  50     QTAILQ_INIT(&bus->free);
  51     QTAILQ_INIT(&bus->used);
  52     QTAILQ_INSERT_TAIL(&busses, bus, next);
  53 }
  54
  55 USBBus *usb_bus_find(int busnr)
  56 {
  57     USBBus *bus;
  58
  59     if (-1 == busnr)
  60         return QTAILQ_FIRST(&busses);
  61     QTAILQ_FOREACH(bus, &busses, next) {
  62         if (bus->busnr == busnr)
  63             return bus;
  64     }
  65     return NULL;
  66 }
  67
  68 static int usb_device_init(USBDevice *dev)
  69 {
  70     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
  71     if (klass->init) {
  72         return klass->init(dev);
  73     }
  74     return 0;
  75 }
  76
  77 USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr)
  78 {
  79     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
  80     if (klass->find_device) {
  81         return klass->find_device(dev, addr);
  82     }
  83     return NULL;
  84 }
  85
  86 static void usb_device_handle_destroy(USBDevice *dev)
  87 {
  88     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
  89     if (klass->handle_destroy) {
  90         klass->handle_destroy(dev);
  91     }
  92 }
  93
  94 int usb_device_handle_packet(USBDevice *dev, USBPacket *p)
  95 {
  96     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
  97     if (klass->handle_packet) {
  98         return klass->handle_packet(dev, p);
  99     }
 100     return -ENOSYS;
 101 }
 102
 103 void usb_device_cancel_packet(USBDevice *dev, USBPacket *p)
 104 {
 105     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 106     if (klass->cancel_packet) {
 107         klass->cancel_packet(dev, p);
 108     }
 109 }
 110
 111 void usb_device_handle_attach(USBDevice *dev)
 112 {
 113     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 114     if (klass->handle_attach) {
 115         klass->handle_attach(dev);
 116     }
 117 }
 118
 119 void usb_device_handle_reset(USBDevice *dev)
 120 {
 121     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 122     if (klass->handle_reset) {
 123         klass->handle_reset(dev);
 124     }
 125 }
 126
 127 int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
 128                               int value, int index, int length, uint8_t *data)
 129 {
 130     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 131     if (klass->handle_control) {
 132         return klass->handle_control(dev, p, request, value, index, length,
 133                                          data);
 134     }
 135     return -ENOSYS;
 136 }
 137
 138 int usb_device_handle_data(USBDevice *dev, USBPacket *p)
 139 {
 140     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 141     if (klass->handle_data) {
 142         return klass->handle_data(dev, p);
 143     }
 144     return -ENOSYS;
 145 }
 146
 147 const char *usb_device_get_product_desc(USBDevice *dev)
 148 {
 149     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 150     return klass->product_desc;
 151 }
 152
 153 const USBDesc *usb_device_get_usb_desc(USBDevice *dev)
 154 {
 155     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 156     return klass->usb_desc;
 157 }
 158
 159 void usb_device_set_interface(USBDevice *dev, int interface,
 160                               int alt_old, int alt_new)
 161 {
 162     USBDeviceClass *klass = USB_DEVICE_GET_CLASS(dev);
 163     if (klass->set_interface) {
 164         klass->set_interface(dev, interface, alt_old, alt_new);
 165     }
 166 }
 167
 168 static int usb_qdev_init(DeviceState *qdev)
 169 {
 170     USBDevice *dev = USB_DEVICE(qdev);
 171     int rc;
 172
 173     pstrcpy(dev->product_desc, sizeof(dev->product_desc),
 174             usb_device_get_product_desc(dev));
 175     dev->auto_attach = 1;
 176     QLIST_INIT(&dev->strings);
 177     usb_ep_init(dev);
 178     rc = usb_claim_port(dev);
 179     if (rc != 0) {
 180         return rc;
 181     }
 182     rc = usb_device_init(dev);
 183     if (rc != 0) {
 184         usb_release_port(dev);
 185         return rc;
 186     }
 187     if (dev->auto_attach) {
 188         rc = usb_device_attach(dev);
 189         if (rc != 0) {
 190             usb_qdev_exit(qdev);
 191             return rc;
 192         }
 193     }
 194     return 0;
 195 }
 196
 197 static int usb_qdev_exit(DeviceState *qdev)
 198 {
 199     USBDevice *dev = USB_DEVICE(qdev);
 200
 201     if (dev->attached) {
 202         usb_device_detach(dev);
 203     }
 204     usb_device_handle_destroy(dev);
 205     if (dev->port) {
 206         usb_release_port(dev);
 207     }
 208     return 0;
 209 }
 210
 211 typedef struct LegacyUSBFactory
 212 {
 213     const char *name;
 214     const char *usbdevice_name;
 215     USBDevice *(*usbdevice_init)(const char *params);
 216 } LegacyUSBFactory;
 217
 218 static GSList *legacy_usb_factory;
 219
 220 void usb_legacy_register(const char *typename, const char *usbdevice_name,
 221                          USBDevice *(*usbdevice_init)(const char *params))
 222 {
 223     if (usbdevice_name) {
 224         LegacyUSBFactory *f = g_malloc0(sizeof(*f));
 225         f->name = typename;
 226         f->usbdevice_name = usbdevice_name;
 227         f->usbdevice_init = usbdevice_init;
 228         legacy_usb_factory = g_slist_append(legacy_usb_factory, f);
 229     }
 230 }
 231
 232 USBDevice *usb_create(USBBus *bus, const char *name)
 233 {
 234     DeviceState *dev;
 235
 236 #if 1
 237     /* temporary stopgap until all usb is properly qdev-ified */
 238     if (!bus) {
 239         bus = usb_bus_find(-1);
 240         if (!bus)
 241             return NULL;
 242         error_report("%s: no bus specified, using \"%s\" for \"%s\"",
 243                 __FUNCTION__, bus->qbus.name, name);
 244     }
 245 #endif
 246
 247     dev = qdev_create(&bus->qbus, name);
 248     return USB_DEVICE(dev);
 249 }
 250
 251 USBDevice *usb_create_simple(USBBus *bus, const char *name)
 252 {
 253     USBDevice *dev = usb_create(bus, name);
 254     int rc;
 255
 256     if (!dev) {
 257         error_report("Failed to create USB device '%s'", name);
 258         return NULL;
 259     }
 260     rc = qdev_init(&dev->qdev);
 261     if (rc < 0) {
 262         error_report("Failed to initialize USB device '%s'", name);
 263         return NULL;
 264     }
 265     return dev;
 266 }
 267
 268 static void usb_fill_port(USBPort *port, void *opaque, int index,
 269                           USBPortOps *ops, int speedmask)
 270 {
 271     port->opaque = opaque;
 272     port->index = index;
 273     port->ops = ops;
 274     port->speedmask = speedmask;
 275     usb_port_location(port, NULL, index + 1);
 276 }
 277
 278 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 279                        USBPortOps *ops, int speedmask)
 280 {
 281     usb_fill_port(port, opaque, index, ops, speedmask);
 282     QTAILQ_INSERT_TAIL(&bus->free, port, next);
 283     bus->nfree++;
 284 }
 285
 286 int usb_register_companion(const char *masterbus, USBPort *ports[],
 287                            uint32_t portcount, uint32_t firstport,
 288                            void *opaque, USBPortOps *ops, int speedmask)
 289 {
 290     USBBus *bus;
 291     int i;
 292
 293     QTAILQ_FOREACH(bus, &busses, next) {
 294         if (strcmp(bus->qbus.name, masterbus) == 0) {
 295             break;
 296         }
 297     }
 298
 299     if (!bus || !bus->ops->register_companion) {
 300         qerror_report(QERR_INVALID_PARAMETER_VALUE, "masterbus",
 301                       "an USB masterbus");
 302         if (bus) {
 303             error_printf_unless_qmp(
 304                 "USB bus '%s' does not allow companion controllers\n",
 305                 masterbus);
 306         }
 307         return -1;
 308     }
 309
 310     for (i = 0; i < portcount; i++) {
 311         usb_fill_port(ports[i], opaque, i, ops, speedmask);
 312     }
 313
 314     return bus->ops->register_companion(bus, ports, portcount, firstport);
 315 }
 316
 317 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr)
 318 {
 319     if (upstream) {
 320         snprintf(downstream->path, sizeof(downstream->path), "%s.%d",
 321                  upstream->path, portnr);
 322     } else {
 323         snprintf(downstream->path, sizeof(downstream->path), "%d", portnr);
 324     }
 325 }
 326
 327 void usb_unregister_port(USBBus *bus, USBPort *port)
 328 {
 329     if (port->dev)
 330         qdev_free(&port->dev->qdev);
 331     QTAILQ_REMOVE(&bus->free, port, next);
 332     bus->nfree--;
 333 }
 334
 335 int usb_claim_port(USBDevice *dev)
 336 {
 337     USBBus *bus = usb_bus_from_device(dev);
 338     USBPort *port;
 339
 340     assert(dev->port == NULL);
 341
 342     if (dev->port_path) {
 343         QTAILQ_FOREACH(port, &bus->free, next) {
 344             if (strcmp(port->path, dev->port_path) == 0) {
 345                 break;
 346             }
 347         }
 348         if (port == NULL) {
 349             error_report("Error: usb port %s (bus %s) not found (in use?)",
 350                          dev->port_path, bus->qbus.name);
 351             return -1;
 352         }
 353     } else {
 354         if (bus->nfree == 1 && strcmp(object_get_typename(OBJECT(dev)), "usb-hub") != 0) {
 355             /* Create a new hub and chain it on */
 356             usb_create_simple(bus, "usb-hub");
 357         }
 358         if (bus->nfree == 0) {
 359             error_report("Error: tried to attach usb device %s to a bus "
 360                          "with no free ports", dev->product_desc);
 361             return -1;
 362         }
 363         port = QTAILQ_FIRST(&bus->free);
 364     }
 365     trace_usb_port_claim(bus->busnr, port->path);
 366
 367     QTAILQ_REMOVE(&bus->free, port, next);
 368     bus->nfree--;
 369
 370     dev->port = port;
 371     port->dev = dev;
 372
 373     QTAILQ_INSERT_TAIL(&bus->used, port, next);
 374     bus->nused++;
 375     return 0;
 376 }
 377
 378 void usb_release_port(USBDevice *dev)
 379 {
 380     USBBus *bus = usb_bus_from_device(dev);
 381     USBPort *port = dev->port;
 382
 383     assert(port != NULL);
 384     trace_usb_port_release(bus->busnr, port->path);
 385
 386     QTAILQ_REMOVE(&bus->used, port, next);
 387     bus->nused--;
 388
 389     dev->port = NULL;
 390     port->dev = NULL;
 391
 392     QTAILQ_INSERT_TAIL(&bus->free, port, next);
 393     bus->nfree++;
 394 }
 395
 396 int usb_device_attach(USBDevice *dev)
 397 {
 398     USBBus *bus = usb_bus_from_device(dev);
 399     USBPort *port = dev->port;
 400
 401     assert(port != NULL);
 402     assert(!dev->attached);
 403     trace_usb_port_attach(bus->busnr, port->path);
 404
 405     if (!(port->speedmask & dev->speedmask)) {
 406         error_report("Warning: speed mismatch trying to attach "
 407                      "usb device %s to bus %s",
 408                      dev->product_desc, bus->qbus.name);
 409         return -1;
 410     }
 411
 412     dev->attached++;
 413     usb_attach(port);
 414
 415     return 0;
 416 }
 417
 418 int usb_device_detach(USBDevice *dev)
 419 {
 420     USBBus *bus = usb_bus_from_device(dev);
 421     USBPort *port = dev->port;
 422
 423     assert(port != NULL);
 424     assert(dev->attached);
 425     trace_usb_port_detach(bus->busnr, port->path);
 426
 427     usb_detach(port);
 428     dev->attached--;
 429     return 0;
 430 }
 431
 432 int usb_device_delete_addr(int busnr, int addr)
 433 {
 434     USBBus *bus;
 435     USBPort *port;
 436     USBDevice *dev;
 437
 438     bus = usb_bus_find(busnr);
 439     if (!bus)
 440         return -1;
 441
 442     QTAILQ_FOREACH(port, &bus->used, next) {
 443         if (port->dev->addr == addr)
 444             break;
 445     }
 446     if (!port)
 447         return -1;
 448     dev = port->dev;
 449
 450     qdev_free(&dev->qdev);
 451     return 0;
 452 }
 453
 454 static const char *usb_speed(unsigned int speed)
 455 {
 456     static const char *txt[] = {
 457         [ USB_SPEED_LOW  ] = "1.5",
 458         [ USB_SPEED_FULL ] = "12",
 459         [ USB_SPEED_HIGH ] = "480",
 460         [ USB_SPEED_SUPER ] = "5000",
 461     };
 462     if (speed >= ARRAY_SIZE(txt))
 463         return "?";
 464     return txt[speed];
 465 }
 466
 467 static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent)
 468 {
 469     USBDevice *dev = USB_DEVICE(qdev);
 470     USBBus *bus = usb_bus_from_device(dev);
 471
 472     monitor_printf(mon, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
 473                    indent, "", bus->busnr, dev->addr,
 474                    dev->port ? dev->port->path : "-",
 475                    usb_speed(dev->speed), dev->product_desc,
 476                    dev->attached ? ", attached" : "");
 477 }
 478
 479 static char *usb_get_dev_path(DeviceState *qdev)
 480 {
 481     USBDevice *dev = USB_DEVICE(qdev);
 482     return g_strdup(dev->port->path);
 483 }
 484
 485 static char *usb_get_fw_dev_path(DeviceState *qdev)
 486 {
 487     USBDevice *dev = USB_DEVICE(qdev);
 488     char *fw_path, *in;
 489     ssize_t pos = 0, fw_len;
 490     long nr;
 491
 492     fw_len = 32 + strlen(dev->port->path) * 6;
 493     fw_path = g_malloc(fw_len);
 494     in = dev->port->path;
 495     while (fw_len - pos > 0) {
 496         nr = strtol(in, &in, 10);
 497         if (in[0] == '.') {
 498             /* some hub between root port and device */
 499             pos += snprintf(fw_path + pos, fw_len - pos, "hub@%ld/", nr);
 500             in++;
 501         } else {
 502             /* the device itself */
 503             pos += snprintf(fw_path + pos, fw_len - pos, "%s@%ld",
 504                             qdev_fw_name(qdev), nr);
 505             break;
 506         }
 507     }
 508     return fw_path;
 509 }
 510
 511 void usb_info(Monitor *mon)
 512 {
 513     USBBus *bus;
 514     USBDevice *dev;
 515     USBPort *port;
 516
 517     if (QTAILQ_EMPTY(&busses)) {
 518         monitor_printf(mon, "USB support not enabled\n");
 519         return;
 520     }
 521
 522     QTAILQ_FOREACH(bus, &busses, next) {
 523         QTAILQ_FOREACH(port, &bus->used, next) {
 524             dev = port->dev;
 525             if (!dev)
 526                 continue;
 527             monitor_printf(mon, "  Device %d.%d, Port %s, Speed %s Mb/s, Product %s\n",
 528                            bus->busnr, dev->addr, port->path, usb_speed(dev->speed),
 529                            dev->product_desc);
 530         }
 531     }
 532 }
 533
 534 /* handle legacy -usbdevice cmd line option */
 535 USBDevice *usbdevice_create(const char *cmdline)
 536 {
 537     USBBus *bus = usb_bus_find(-1 /* any */);
 538     LegacyUSBFactory *f = NULL;
 539     GSList *i;
 540     char driver[32];
 541     const char *params;
 542     int len;
 543
 544     params = strchr(cmdline,':');
 545     if (params) {
 546         params++;
 547         len = params - cmdline;
 548         if (len > sizeof(driver))
 549             len = sizeof(driver);
 550         pstrcpy(driver, len, cmdline);
 551     } else {
 552         params = "";
 553         pstrcpy(driver, sizeof(driver), cmdline);
 554     }
 555
 556     for (i = legacy_usb_factory; i; i = i->next) {
 557         f = i->data;
 558         if (strcmp(f->usbdevice_name, driver) == 0) {
 559             break;
 560         }
 561     }
 562     if (i == NULL) {
 563 #if 0
 564         /* no error because some drivers are not converted (yet) */
 565         error_report("usbdevice %s not found", driver);
 566 #endif
 567         return NULL;
 568     }
 569
 570     if (!f->usbdevice_init) {
 571         if (*params) {
 572             error_report("usbdevice %s accepts no params", driver);
 573             return NULL;
 574         }
 575         return usb_create_simple(bus, f->name);
 576     }
 577     return f->usbdevice_init(params);
 578 }
 579
 580 static void usb_device_class_init(ObjectClass *klass, void *data)
 581 {
 582     DeviceClass *k = DEVICE_CLASS(klass);
 583     k->bus_info = &usb_bus_info;
 584     k->init     = usb_qdev_init;
 585     k->unplug   = qdev_simple_unplug_cb;
 586     k->exit     = usb_qdev_exit;
 587 }
 588
 589 static TypeInfo usb_device_type_info = {
 590     .name = TYPE_USB_DEVICE,
 591     .parent = TYPE_DEVICE,
 592     .instance_size = sizeof(USBDevice),
 593     .abstract = true,
 594     .class_size = sizeof(USBDeviceClass),
 595     .class_init = usb_device_class_init,
 596 };
 597
 598 static void usb_register_devices(void)
 599 {
 600     type_register_static(&usb_device_type_info);
 601 }
 602
 603 device_init(usb_register_devices);