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
   7 static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent);
   8
   9 static char *usb_get_dev_path(DeviceState *dev);
  10 static char *usb_get_fw_dev_path(DeviceState *qdev);
  11
  12 static struct BusInfo usb_bus_info = {
  13     .name      = "USB",
  14     .size      = sizeof(USBBus),
  15     .print_dev = usb_bus_dev_print,
  16     .get_dev_path = usb_get_dev_path,
  17     .get_fw_dev_path = usb_get_fw_dev_path,
  18     .props      = (Property[]) {
  19         DEFINE_PROP_STRING("port", USBDevice, port_path),
  20         DEFINE_PROP_END_OF_LIST()
  21     },
  22 };
  23 static int next_usb_bus = 0;
  24 static QTAILQ_HEAD(, USBBus) busses = QTAILQ_HEAD_INITIALIZER(busses);
  25
  26 const VMStateDescription vmstate_usb_device = {
  27     .name = "USBDevice",
  28     .version_id = 1,
  29     .minimum_version_id = 1,
  30     .fields = (VMStateField []) {
  31         VMSTATE_UINT8(addr, USBDevice),
  32         VMSTATE_INT32(state, USBDevice),
  33         VMSTATE_INT32(remote_wakeup, USBDevice),
  34         VMSTATE_INT32(setup_state, USBDevice),
  35         VMSTATE_INT32(setup_len, USBDevice),
  36         VMSTATE_INT32(setup_index, USBDevice),
  37         VMSTATE_UINT8_ARRAY(setup_buf, USBDevice, 8),
  38         VMSTATE_END_OF_LIST(),
  39     }
  40 };
  41
  42 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host)
  43 {
  44     qbus_create_inplace(&bus->qbus, &usb_bus_info, host, NULL);
  45     bus->ops = ops;
  46     bus->busnr = next_usb_bus++;
  47     bus->qbus.allow_hotplug = 1; /* Yes, we can */
  48     QTAILQ_INIT(&bus->free);
  49     QTAILQ_INIT(&bus->used);
  50     QTAILQ_INSERT_TAIL(&busses, bus, next);
  51 }
  52
  53 USBBus *usb_bus_find(int busnr)
  54 {
  55     USBBus *bus;
  56
  57     if (-1 == busnr)
  58         return QTAILQ_FIRST(&busses);
  59     QTAILQ_FOREACH(bus, &busses, next) {
  60         if (bus->busnr == busnr)
  61             return bus;
  62     }
  63     return NULL;
  64 }
  65
  66 static int usb_qdev_init(DeviceState *qdev, DeviceInfo *base)
  67 {
  68     USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
  69     USBDeviceInfo *info = DO_UPCAST(USBDeviceInfo, qdev, base);
  70     int rc;
  71
  72     pstrcpy(dev->product_desc, sizeof(dev->product_desc), info->product_desc);
  73     dev->info = info;
  74     dev->auto_attach = 1;
  75     QLIST_INIT(&dev->strings);
  76     rc = dev->info->init(dev);
  77     if (rc == 0 && dev->auto_attach)
  78         rc = usb_device_attach(dev);
  79     return rc;
  80 }
  81
  82 static int usb_qdev_exit(DeviceState *qdev)
  83 {
  84     USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
  85     USBBus *bus = usb_bus_from_device(dev);
  86
  87     if (dev->attached) {
  88         usb_device_detach(dev);
  89     }
  90     bus->ops->device_destroy(bus, dev);
  91     if (dev->info->handle_destroy) {
  92         dev->info->handle_destroy(dev);
  93     }
  94     return 0;
  95 }
  96
  97 void usb_qdev_register(USBDeviceInfo *info)
  98 {
  99     info->qdev.bus_info = &usb_bus_info;
 100     info->qdev.init     = usb_qdev_init;
 101     info->qdev.unplug   = qdev_simple_unplug_cb;
 102     info->qdev.exit     = usb_qdev_exit;
 103     qdev_register(&info->qdev);
 104 }
 105
 106 void usb_qdev_register_many(USBDeviceInfo *info)
 107 {
 108     while (info->qdev.name) {
 109         usb_qdev_register(info);
 110         info++;
 111     }
 112 }
 113
 114 USBDevice *usb_create(USBBus *bus, const char *name)
 115 {
 116     DeviceState *dev;
 117
 118 #if 1
 119     /* temporary stopgap until all usb is properly qdev-ified */
 120     if (!bus) {
 121         bus = usb_bus_find(-1);
 122         if (!bus)
 123             return NULL;
 124         error_report("%s: no bus specified, using \"%s\" for \"%s\"\n",
 125                 __FUNCTION__, bus->qbus.name, name);
 126     }
 127 #endif
 128
 129     dev = qdev_create(&bus->qbus, name);
 130     return DO_UPCAST(USBDevice, qdev, dev);
 131 }
 132
 133 USBDevice *usb_create_simple(USBBus *bus, const char *name)
 134 {
 135     USBDevice *dev = usb_create(bus, name);
 136     if (!dev) {
 137         hw_error("Failed to create USB device '%s'\n", name);
 138     }
 139     qdev_init_nofail(&dev->qdev);
 140     return dev;
 141 }
 142
 143 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 144                        USBPortOps *ops, int speedmask)
 145 {
 146     port->opaque = opaque;
 147     port->index = index;
 148     port->opaque = opaque;
 149     port->index = index;
 150     port->ops = ops;
 151     port->speedmask = speedmask;
 152     QTAILQ_INSERT_TAIL(&bus->free, port, next);
 153     bus->nfree++;
 154 }
 155
 156 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr)
 157 {
 158     if (upstream) {
 159         snprintf(downstream->path, sizeof(downstream->path), "%s.%d",
 160                  upstream->path, portnr);
 161     } else {
 162         snprintf(downstream->path, sizeof(downstream->path), "%d", portnr);
 163     }
 164 }
 165
 166 void usb_unregister_port(USBBus *bus, USBPort *port)
 167 {
 168     if (port->dev)
 169         qdev_free(&port->dev->qdev);
 170     QTAILQ_REMOVE(&bus->free, port, next);
 171     bus->nfree--;
 172 }
 173
 174 static int do_attach(USBDevice *dev)
 175 {
 176     USBBus *bus = usb_bus_from_device(dev);
 177     USBPort *port;
 178
 179     if (dev->attached) {
 180         error_report("Error: tried to attach usb device %s twice\n",
 181                 dev->product_desc);
 182         return -1;
 183     }
 184     if (bus->nfree == 0) {
 185         error_report("Error: tried to attach usb device %s to a bus with no free ports\n",
 186                 dev->product_desc);
 187         return -1;
 188     }
 189     if (dev->port_path) {
 190         QTAILQ_FOREACH(port, &bus->free, next) {
 191             if (strcmp(port->path, dev->port_path) == 0) {
 192                 break;
 193             }
 194         }
 195         if (port == NULL) {
 196             error_report("Error: usb port %s (bus %s) not found\n",
 197                     dev->port_path, bus->qbus.name);
 198             return -1;
 199         }
 200     } else {
 201         port = QTAILQ_FIRST(&bus->free);
 202     }
 203     if (!(port->speedmask & dev->speedmask)) {
 204         error_report("Warning: speed mismatch trying to attach usb device %s to bus %s\n",
 205                 dev->product_desc, bus->qbus.name);
 206         return -1;
 207     }
 208
 209     dev->attached++;
 210     QTAILQ_REMOVE(&bus->free, port, next);
 211     bus->nfree--;
 212
 213     usb_attach(port, dev);
 214
 215     QTAILQ_INSERT_TAIL(&bus->used, port, next);
 216     bus->nused++;
 217
 218     return 0;
 219 }
 220
 221 int usb_device_attach(USBDevice *dev)
 222 {
 223     USBBus *bus = usb_bus_from_device(dev);
 224
 225     if (bus->nfree == 1 && dev->port_path == NULL) {
 226         /* Create a new hub and chain it on
 227            (unless a physical port location is specified). */
 228         usb_create_simple(bus, "usb-hub");
 229     }
 230     return do_attach(dev);
 231 }
 232
 233 int usb_device_detach(USBDevice *dev)
 234 {
 235     USBBus *bus = usb_bus_from_device(dev);
 236     USBPort *port;
 237
 238     if (!dev->attached) {
 239         error_report("Error: tried to detach unattached usb device %s\n",
 240                 dev->product_desc);
 241         return -1;
 242     }
 243     dev->attached--;
 244
 245     QTAILQ_FOREACH(port, &bus->used, next) {
 246         if (port->dev == dev)
 247             break;
 248     }
 249     assert(port != NULL);
 250
 251     QTAILQ_REMOVE(&bus->used, port, next);
 252     bus->nused--;
 253
 254     usb_attach(port, NULL);
 255
 256     QTAILQ_INSERT_TAIL(&bus->free, port, next);
 257     bus->nfree++;
 258     return 0;
 259 }
 260
 261 int usb_device_delete_addr(int busnr, int addr)
 262 {
 263     USBBus *bus;
 264     USBPort *port;
 265     USBDevice *dev;
 266
 267     bus = usb_bus_find(busnr);
 268     if (!bus)
 269         return -1;
 270
 271     QTAILQ_FOREACH(port, &bus->used, next) {
 272         if (port->dev->addr == addr)
 273             break;
 274     }
 275     if (!port)
 276         return -1;
 277     dev = port->dev;
 278
 279     qdev_free(&dev->qdev);
 280     return 0;
 281 }
 282
 283 static const char *usb_speed(unsigned int speed)
 284 {
 285     static const char *txt[] = {
 286         [ USB_SPEED_LOW  ] = "1.5",
 287         [ USB_SPEED_FULL ] = "12",
 288         [ USB_SPEED_HIGH ] = "480",
 289         [ USB_SPEED_SUPER ] = "5000",
 290     };
 291     if (speed >= ARRAY_SIZE(txt))
 292         return "?";
 293     return txt[speed];
 294 }
 295
 296 static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent)
 297 {
 298     USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
 299     USBBus *bus = usb_bus_from_device(dev);
 300
 301     monitor_printf(mon, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
 302                    indent, "", bus->busnr, dev->addr,
 303                    dev->port ? dev->port->path : "-",
 304                    usb_speed(dev->speed), dev->product_desc,
 305                    dev->attached ? ", attached" : "");
 306 }
 307
 308 static char *usb_get_dev_path(DeviceState *qdev)
 309 {
 310     USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
 311     return qemu_strdup(dev->port->path);
 312 }
 313
 314 static char *usb_get_fw_dev_path(DeviceState *qdev)
 315 {
 316     USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
 317     char *fw_path, *in;
 318     ssize_t pos = 0, fw_len;
 319     long nr;
 320
 321     fw_len = 32 + strlen(dev->port->path) * 6;
 322     fw_path = qemu_malloc(fw_len);
 323     in = dev->port->path;
 324     while (fw_len - pos > 0) {
 325         nr = strtol(in, &in, 10);
 326         if (in[0] == '.') {
 327             /* some hub between root port and device */
 328             pos += snprintf(fw_path + pos, fw_len - pos, "hub@%ld/", nr);
 329             in++;
 330         } else {
 331             /* the device itself */
 332             pos += snprintf(fw_path + pos, fw_len - pos, "%s@%ld",
 333                             qdev_fw_name(qdev), nr);
 334             break;
 335         }
 336     }
 337     return fw_path;
 338 }
 339
 340 void usb_info(Monitor *mon)
 341 {
 342     USBBus *bus;
 343     USBDevice *dev;
 344     USBPort *port;
 345
 346     if (QTAILQ_EMPTY(&busses)) {
 347         monitor_printf(mon, "USB support not enabled\n");
 348         return;
 349     }
 350
 351     QTAILQ_FOREACH(bus, &busses, next) {
 352         QTAILQ_FOREACH(port, &bus->used, next) {
 353             dev = port->dev;
 354             if (!dev)
 355                 continue;
 356             monitor_printf(mon, "  Device %d.%d, Port %s, Speed %s Mb/s, Product %s\n",
 357                            bus->busnr, dev->addr, port->path, usb_speed(dev->speed),
 358                            dev->product_desc);
 359         }
 360     }
 361 }
 362
 363 /* handle legacy -usbdevice cmd line option */
 364 USBDevice *usbdevice_create(const char *cmdline)
 365 {
 366     USBBus *bus = usb_bus_find(-1 /* any */);
 367     DeviceInfo *info;
 368     USBDeviceInfo *usb;
 369     char driver[32];
 370     const char *params;
 371     int len;
 372
 373     params = strchr(cmdline,':');
 374     if (params) {
 375         params++;
 376         len = params - cmdline;
 377         if (len > sizeof(driver))
 378             len = sizeof(driver);
 379         pstrcpy(driver, len, cmdline);
 380     } else {
 381         params = "";
 382         pstrcpy(driver, sizeof(driver), cmdline);
 383     }
 384
 385     for (info = device_info_list; info != NULL; info = info->next) {
 386         if (info->bus_info != &usb_bus_info)
 387             continue;
 388         usb = DO_UPCAST(USBDeviceInfo, qdev, info);
 389         if (usb->usbdevice_name == NULL)
 390             continue;
 391         if (strcmp(usb->usbdevice_name, driver) != 0)
 392             continue;
 393         break;
 394     }
 395     if (info == NULL) {
 396 #if 0
 397         /* no error because some drivers are not converted (yet) */
 398         error_report("usbdevice %s not found", driver);
 399 #endif
 400         return NULL;
 401     }
 402
 403     if (!usb->usbdevice_init) {
 404         if (*params) {
 405             error_report("usbdevice %s accepts no params", driver);
 406             return NULL;
 407         }
 408         return usb_create_simple(bus, usb->qdev.name);
 409     }
 410     return usb->usbdevice_init(params);
 411 }