1 #include "qemu/osdep.h"
5 #include "qapi/error.h"
6 #include "qemu/error-report.h"
7 #include "sysemu/sysemu.h"
8 #include "monitor/monitor.h"
11 static void usb_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
);
13 static char *usb_get_dev_path(DeviceState
*dev
);
14 static char *usb_get_fw_dev_path(DeviceState
*qdev
);
15 static void usb_qdev_unrealize(DeviceState
*qdev
, Error
**errp
);
17 static Property usb_props
[] = {
18 DEFINE_PROP_STRING("port", USBDevice
, port_path
),
19 DEFINE_PROP_STRING("serial", USBDevice
, serial
),
20 DEFINE_PROP_BIT("full-path", USBDevice
, flags
,
21 USB_DEV_FLAG_FULL_PATH
, true),
22 DEFINE_PROP_BIT("msos-desc", USBDevice
, flags
,
23 USB_DEV_FLAG_MSOS_DESC_ENABLE
, true),
24 DEFINE_PROP_END_OF_LIST()
27 static void usb_bus_class_init(ObjectClass
*klass
, void *data
)
29 BusClass
*k
= BUS_CLASS(klass
);
30 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
32 k
->print_dev
= usb_bus_dev_print
;
33 k
->get_dev_path
= usb_get_dev_path
;
34 k
->get_fw_dev_path
= usb_get_fw_dev_path
;
35 hc
->unplug
= qdev_simple_device_unplug_cb
;
38 static const TypeInfo usb_bus_info
= {
41 .instance_size
= sizeof(USBBus
),
42 .class_init
= usb_bus_class_init
,
43 .interfaces
= (InterfaceInfo
[]) {
44 { TYPE_HOTPLUG_HANDLER
},
49 static int next_usb_bus
= 0;
50 static QTAILQ_HEAD(, USBBus
) busses
= QTAILQ_HEAD_INITIALIZER(busses
);
52 static int usb_device_post_load(void *opaque
, int version_id
)
54 USBDevice
*dev
= opaque
;
56 if (dev
->state
== USB_STATE_NOTATTACHED
) {
61 if (dev
->setup_index
< 0 ||
63 dev
->setup_index
> dev
->setup_len
||
64 dev
->setup_len
> sizeof(dev
->data_buf
)) {
70 const VMStateDescription vmstate_usb_device
= {
73 .minimum_version_id
= 1,
74 .post_load
= usb_device_post_load
,
75 .fields
= (VMStateField
[]) {
76 VMSTATE_UINT8(addr
, USBDevice
),
77 VMSTATE_INT32(state
, USBDevice
),
78 VMSTATE_INT32(remote_wakeup
, USBDevice
),
79 VMSTATE_INT32(setup_state
, USBDevice
),
80 VMSTATE_INT32(setup_len
, USBDevice
),
81 VMSTATE_INT32(setup_index
, USBDevice
),
82 VMSTATE_UINT8_ARRAY(setup_buf
, USBDevice
, 8),
83 VMSTATE_END_OF_LIST(),
87 void usb_bus_new(USBBus
*bus
, size_t bus_size
,
88 USBBusOps
*ops
, DeviceState
*host
)
90 qbus_create_inplace(bus
, bus_size
, TYPE_USB_BUS
, host
, NULL
);
91 qbus_set_bus_hotplug_handler(BUS(bus
), &error_abort
);
93 bus
->busnr
= next_usb_bus
++;
94 QTAILQ_INIT(&bus
->free
);
95 QTAILQ_INIT(&bus
->used
);
96 QTAILQ_INSERT_TAIL(&busses
, bus
, next
);
99 void usb_bus_release(USBBus
*bus
)
101 assert(next_usb_bus
> 0);
103 QTAILQ_REMOVE(&busses
, bus
, next
);
106 USBBus
*usb_bus_find(int busnr
)
111 return QTAILQ_FIRST(&busses
);
112 QTAILQ_FOREACH(bus
, &busses
, next
) {
113 if (bus
->busnr
== busnr
)
119 static void usb_device_realize(USBDevice
*dev
, Error
**errp
)
121 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
123 if (klass
->realize
) {
124 klass
->realize(dev
, errp
);
128 USBDevice
*usb_device_find_device(USBDevice
*dev
, uint8_t addr
)
130 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
131 if (klass
->find_device
) {
132 return klass
->find_device(dev
, addr
);
137 static void usb_device_handle_destroy(USBDevice
*dev
)
139 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
140 if (klass
->handle_destroy
) {
141 klass
->handle_destroy(dev
);
145 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
147 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
148 if (klass
->cancel_packet
) {
149 klass
->cancel_packet(dev
, p
);
153 void usb_device_handle_attach(USBDevice
*dev
)
155 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
156 if (klass
->handle_attach
) {
157 klass
->handle_attach(dev
);
161 void usb_device_handle_reset(USBDevice
*dev
)
163 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
164 if (klass
->handle_reset
) {
165 klass
->handle_reset(dev
);
169 void usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
,
170 int value
, int index
, int length
, uint8_t *data
)
172 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
173 if (klass
->handle_control
) {
174 klass
->handle_control(dev
, p
, request
, value
, index
, length
, data
);
178 void usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
)
180 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
181 if (klass
->handle_data
) {
182 klass
->handle_data(dev
, p
);
186 const char *usb_device_get_product_desc(USBDevice
*dev
)
188 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
189 return klass
->product_desc
;
192 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
)
194 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
196 return dev
->usb_desc
;
198 return klass
->usb_desc
;
201 void usb_device_set_interface(USBDevice
*dev
, int interface
,
202 int alt_old
, int alt_new
)
204 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
205 if (klass
->set_interface
) {
206 klass
->set_interface(dev
, interface
, alt_old
, alt_new
);
210 void usb_device_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
212 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
213 if (klass
->flush_ep_queue
) {
214 klass
->flush_ep_queue(dev
, ep
);
218 void usb_device_ep_stopped(USBDevice
*dev
, USBEndpoint
*ep
)
220 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
221 if (klass
->ep_stopped
) {
222 klass
->ep_stopped(dev
, ep
);
226 int usb_device_alloc_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
229 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
230 if (klass
->alloc_streams
) {
231 return klass
->alloc_streams(dev
, eps
, nr_eps
, streams
);
236 void usb_device_free_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
)
238 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
239 if (klass
->free_streams
) {
240 klass
->free_streams(dev
, eps
, nr_eps
);
244 static void usb_qdev_realize(DeviceState
*qdev
, Error
**errp
)
246 USBDevice
*dev
= USB_DEVICE(qdev
);
247 Error
*local_err
= NULL
;
249 pstrcpy(dev
->product_desc
, sizeof(dev
->product_desc
),
250 usb_device_get_product_desc(dev
));
251 dev
->auto_attach
= 1;
252 QLIST_INIT(&dev
->strings
);
255 usb_claim_port(dev
, &local_err
);
257 error_propagate(errp
, local_err
);
261 usb_device_realize(dev
, &local_err
);
263 usb_release_port(dev
);
264 error_propagate(errp
, local_err
);
268 if (dev
->auto_attach
) {
269 usb_device_attach(dev
, &local_err
);
271 usb_qdev_unrealize(qdev
, NULL
);
272 error_propagate(errp
, local_err
);
278 static void usb_qdev_unrealize(DeviceState
*qdev
, Error
**errp
)
280 USBDevice
*dev
= USB_DEVICE(qdev
);
283 usb_device_detach(dev
);
285 usb_device_handle_destroy(dev
);
287 usb_release_port(dev
);
291 typedef struct LegacyUSBFactory
294 const char *usbdevice_name
;
295 USBDevice
*(*usbdevice_init
)(USBBus
*bus
, const char *params
);
298 static GSList
*legacy_usb_factory
;
300 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
301 USBDevice
*(*usbdevice_init
)(USBBus
*bus
,
304 if (usbdevice_name
) {
305 LegacyUSBFactory
*f
= g_malloc0(sizeof(*f
));
307 f
->usbdevice_name
= usbdevice_name
;
308 f
->usbdevice_init
= usbdevice_init
;
309 legacy_usb_factory
= g_slist_append(legacy_usb_factory
, f
);
313 USBDevice
*usb_create(USBBus
*bus
, const char *name
)
317 dev
= qdev_create(&bus
->qbus
, name
);
318 return USB_DEVICE(dev
);
321 static USBDevice
*usb_try_create_simple(USBBus
*bus
, const char *name
,
327 dev
= USB_DEVICE(qdev_try_create(&bus
->qbus
, name
));
329 error_setg(errp
, "Failed to create USB device '%s'", name
);
332 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
334 error_propagate(errp
, err
);
335 error_prepend(errp
, "Failed to initialize USB device '%s': ",
337 object_unparent(OBJECT(dev
));
343 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
)
345 return usb_try_create_simple(bus
, name
, &error_abort
);
348 static void usb_fill_port(USBPort
*port
, void *opaque
, int index
,
349 USBPortOps
*ops
, int speedmask
)
351 port
->opaque
= opaque
;
354 port
->speedmask
= speedmask
;
355 usb_port_location(port
, NULL
, index
+ 1);
358 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
359 USBPortOps
*ops
, int speedmask
)
361 usb_fill_port(port
, opaque
, index
, ops
, speedmask
);
362 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
366 void usb_register_companion(const char *masterbus
, USBPort
*ports
[],
367 uint32_t portcount
, uint32_t firstport
,
368 void *opaque
, USBPortOps
*ops
, int speedmask
,
374 QTAILQ_FOREACH(bus
, &busses
, next
) {
375 if (strcmp(bus
->qbus
.name
, masterbus
) == 0) {
381 error_setg(errp
, "USB bus '%s' not found", masterbus
);
384 if (!bus
->ops
->register_companion
) {
385 error_setg(errp
, "Can't use USB bus '%s' as masterbus,"
386 " it doesn't support companion controllers",
391 for (i
= 0; i
< portcount
; i
++) {
392 usb_fill_port(ports
[i
], opaque
, i
, ops
, speedmask
);
395 bus
->ops
->register_companion(bus
, ports
, portcount
, firstport
, errp
);
398 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
)
401 snprintf(downstream
->path
, sizeof(downstream
->path
), "%s.%d",
402 upstream
->path
, portnr
);
403 downstream
->hubcount
= upstream
->hubcount
+ 1;
405 snprintf(downstream
->path
, sizeof(downstream
->path
), "%d", portnr
);
406 downstream
->hubcount
= 0;
410 void usb_unregister_port(USBBus
*bus
, USBPort
*port
)
413 object_unparent(OBJECT(port
->dev
));
415 QTAILQ_REMOVE(&bus
->free
, port
, next
);
419 void usb_claim_port(USBDevice
*dev
, Error
**errp
)
421 USBBus
*bus
= usb_bus_from_device(dev
);
424 assert(dev
->port
== NULL
);
426 if (dev
->port_path
) {
427 QTAILQ_FOREACH(port
, &bus
->free
, next
) {
428 if (strcmp(port
->path
, dev
->port_path
) == 0) {
433 error_setg(errp
, "usb port %s (bus %s) not found (in use?)",
434 dev
->port_path
, bus
->qbus
.name
);
438 if (bus
->nfree
== 1 && strcmp(object_get_typename(OBJECT(dev
)), "usb-hub") != 0) {
439 /* Create a new hub and chain it on */
440 usb_try_create_simple(bus
, "usb-hub", NULL
);
442 if (bus
->nfree
== 0) {
443 error_setg(errp
, "tried to attach usb device %s to a bus "
444 "with no free ports", dev
->product_desc
);
447 port
= QTAILQ_FIRST(&bus
->free
);
449 trace_usb_port_claim(bus
->busnr
, port
->path
);
451 QTAILQ_REMOVE(&bus
->free
, port
, next
);
457 QTAILQ_INSERT_TAIL(&bus
->used
, port
, next
);
461 void usb_release_port(USBDevice
*dev
)
463 USBBus
*bus
= usb_bus_from_device(dev
);
464 USBPort
*port
= dev
->port
;
466 assert(port
!= NULL
);
467 trace_usb_port_release(bus
->busnr
, port
->path
);
469 QTAILQ_REMOVE(&bus
->used
, port
, next
);
475 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
479 static void usb_mask_to_str(char *dest
, size_t size
,
480 unsigned int speedmask
)
482 static const struct {
486 { .mask
= USB_SPEED_MASK_FULL
, .name
= "full" },
487 { .mask
= USB_SPEED_MASK_HIGH
, .name
= "high" },
488 { .mask
= USB_SPEED_MASK_SUPER
, .name
= "super" },
492 for (i
= 0; i
< ARRAY_SIZE(speeds
); i
++) {
493 if (speeds
[i
].mask
& speedmask
) {
494 pos
+= snprintf(dest
+ pos
, size
- pos
, "%s%s",
501 void usb_check_attach(USBDevice
*dev
, Error
**errp
)
503 USBBus
*bus
= usb_bus_from_device(dev
);
504 USBPort
*port
= dev
->port
;
505 char devspeed
[32], portspeed
[32];
507 assert(port
!= NULL
);
508 assert(!dev
->attached
);
509 usb_mask_to_str(devspeed
, sizeof(devspeed
), dev
->speedmask
);
510 usb_mask_to_str(portspeed
, sizeof(portspeed
), port
->speedmask
);
511 trace_usb_port_attach(bus
->busnr
, port
->path
,
512 devspeed
, portspeed
);
514 if (!(port
->speedmask
& dev
->speedmask
)) {
515 error_setg(errp
, "Warning: speed mismatch trying to attach"
516 " usb device \"%s\" (%s speed)"
517 " to bus \"%s\", port \"%s\" (%s speed)",
518 dev
->product_desc
, devspeed
,
519 bus
->qbus
.name
, port
->path
, portspeed
);
524 void usb_device_attach(USBDevice
*dev
, Error
**errp
)
526 USBPort
*port
= dev
->port
;
527 Error
*local_err
= NULL
;
529 usb_check_attach(dev
, &local_err
);
531 error_propagate(errp
, local_err
);
539 int usb_device_detach(USBDevice
*dev
)
541 USBBus
*bus
= usb_bus_from_device(dev
);
542 USBPort
*port
= dev
->port
;
544 assert(port
!= NULL
);
545 assert(dev
->attached
);
546 trace_usb_port_detach(bus
->busnr
, port
->path
);
553 int usb_device_delete_addr(int busnr
, int addr
)
559 bus
= usb_bus_find(busnr
);
563 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
564 if (port
->dev
->addr
== addr
)
571 object_unparent(OBJECT(dev
));
575 static const char *usb_speed(unsigned int speed
)
577 static const char *txt
[] = {
578 [ USB_SPEED_LOW
] = "1.5",
579 [ USB_SPEED_FULL
] = "12",
580 [ USB_SPEED_HIGH
] = "480",
581 [ USB_SPEED_SUPER
] = "5000",
583 if (speed
>= ARRAY_SIZE(txt
))
588 static void usb_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
590 USBDevice
*dev
= USB_DEVICE(qdev
);
591 USBBus
*bus
= usb_bus_from_device(dev
);
593 monitor_printf(mon
, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
594 indent
, "", bus
->busnr
, dev
->addr
,
595 dev
->port
? dev
->port
->path
: "-",
596 usb_speed(dev
->speed
), dev
->product_desc
,
597 dev
->attached
? ", attached" : "");
600 static char *usb_get_dev_path(DeviceState
*qdev
)
602 USBDevice
*dev
= USB_DEVICE(qdev
);
603 DeviceState
*hcd
= qdev
->parent_bus
->parent
;
606 if (dev
->flags
& (1 << USB_DEV_FLAG_FULL_PATH
)) {
607 id
= qdev_get_dev_path(hcd
);
610 char *ret
= g_strdup_printf("%s/%s", id
, dev
->port
->path
);
614 return g_strdup(dev
->port
->path
);
618 static char *usb_get_fw_dev_path(DeviceState
*qdev
)
620 USBDevice
*dev
= USB_DEVICE(qdev
);
622 ssize_t pos
= 0, fw_len
;
625 fw_len
= 32 + strlen(dev
->port
->path
) * 6;
626 fw_path
= g_malloc(fw_len
);
627 in
= dev
->port
->path
;
628 while (fw_len
- pos
> 0) {
629 nr
= strtol(in
, &in
, 10);
631 /* some hub between root port and device */
632 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "hub@%lx/", nr
);
635 /* the device itself */
636 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "%s@%lx",
637 qdev_fw_name(qdev
), nr
);
644 void hmp_info_usb(Monitor
*mon
, const QDict
*qdict
)
650 if (QTAILQ_EMPTY(&busses
)) {
651 monitor_printf(mon
, "USB support not enabled\n");
655 QTAILQ_FOREACH(bus
, &busses
, next
) {
656 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
660 monitor_printf(mon
, " Device %d.%d, Port %s, Speed %s Mb/s, "
662 bus
->busnr
, dev
->addr
, port
->path
,
663 usb_speed(dev
->speed
), dev
->product_desc
,
664 dev
->qdev
.id
? ", ID: " : "",
670 /* handle legacy -usbdevice cmd line option */
671 USBDevice
*usbdevice_create(const char *cmdline
)
673 USBBus
*bus
= usb_bus_find(-1 /* any */);
674 LegacyUSBFactory
*f
= NULL
;
682 params
= strchr(cmdline
,':');
685 len
= params
- cmdline
;
686 if (len
> sizeof(driver
))
687 len
= sizeof(driver
);
688 pstrcpy(driver
, len
, cmdline
);
691 pstrcpy(driver
, sizeof(driver
), cmdline
);
694 for (i
= legacy_usb_factory
; i
; i
= i
->next
) {
696 if (strcmp(f
->usbdevice_name
, driver
) == 0) {
702 /* no error because some drivers are not converted (yet) */
703 error_report("usbdevice %s not found", driver
);
709 error_report("Error: no usb bus to attach usbdevice %s, "
710 "please try -machine usb=on and check that "
711 "the machine model supports USB", driver
);
715 if (f
->usbdevice_init
) {
716 dev
= f
->usbdevice_init(bus
, params
);
719 error_report("usbdevice %s accepts no params", driver
);
722 dev
= usb_create(bus
, f
->name
);
725 error_report("Failed to create USB device '%s'", f
->name
);
728 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
730 error_reportf_err(err
, "Failed to initialize USB device '%s': ",
732 object_unparent(OBJECT(dev
));
738 static void usb_device_class_init(ObjectClass
*klass
, void *data
)
740 DeviceClass
*k
= DEVICE_CLASS(klass
);
741 k
->bus_type
= TYPE_USB_BUS
;
742 k
->realize
= usb_qdev_realize
;
743 k
->unrealize
= usb_qdev_unrealize
;
744 k
->props
= usb_props
;
747 static const TypeInfo usb_device_type_info
= {
748 .name
= TYPE_USB_DEVICE
,
749 .parent
= TYPE_DEVICE
,
750 .instance_size
= sizeof(USBDevice
),
752 .class_size
= sizeof(USBDeviceClass
),
753 .class_init
= usb_device_class_init
,
756 static void usb_register_types(void)
758 type_register_static(&usb_bus_info
);
759 type_register_static(&usb_device_type_info
);
762 type_init(usb_register_types
)