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