4 #include "sysemu/sysemu.h"
5 #include "monitor/monitor.h"
8 static void usb_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
);
10 static char *usb_get_dev_path(DeviceState
*dev
);
11 static char *usb_get_fw_dev_path(DeviceState
*qdev
);
12 static void usb_qdev_unrealize(DeviceState
*qdev
, Error
**errp
);
14 static Property usb_props
[] = {
15 DEFINE_PROP_STRING("port", USBDevice
, port_path
),
16 DEFINE_PROP_STRING("serial", USBDevice
, serial
),
17 DEFINE_PROP_BIT("full-path", USBDevice
, flags
,
18 USB_DEV_FLAG_FULL_PATH
, true),
19 DEFINE_PROP_BIT("msos-desc", USBDevice
, flags
,
20 USB_DEV_FLAG_MSOS_DESC_ENABLE
, true),
21 DEFINE_PROP_END_OF_LIST()
24 static void usb_bus_class_init(ObjectClass
*klass
, void *data
)
26 BusClass
*k
= BUS_CLASS(klass
);
28 k
->print_dev
= usb_bus_dev_print
;
29 k
->get_dev_path
= usb_get_dev_path
;
30 k
->get_fw_dev_path
= usb_get_fw_dev_path
;
33 static const TypeInfo usb_bus_info
= {
36 .instance_size
= sizeof(USBBus
),
37 .class_init
= usb_bus_class_init
,
40 static int next_usb_bus
= 0;
41 static QTAILQ_HEAD(, USBBus
) busses
= QTAILQ_HEAD_INITIALIZER(busses
);
43 static int usb_device_post_load(void *opaque
, int version_id
)
45 USBDevice
*dev
= opaque
;
47 if (dev
->state
== USB_STATE_NOTATTACHED
) {
52 if (dev
->setup_index
< 0 ||
54 dev
->setup_index
> dev
->setup_len
||
55 dev
->setup_len
> sizeof(dev
->data_buf
)) {
61 const VMStateDescription vmstate_usb_device
= {
64 .minimum_version_id
= 1,
65 .post_load
= usb_device_post_load
,
66 .fields
= (VMStateField
[]) {
67 VMSTATE_UINT8(addr
, USBDevice
),
68 VMSTATE_INT32(state
, USBDevice
),
69 VMSTATE_INT32(remote_wakeup
, USBDevice
),
70 VMSTATE_INT32(setup_state
, USBDevice
),
71 VMSTATE_INT32(setup_len
, USBDevice
),
72 VMSTATE_INT32(setup_index
, USBDevice
),
73 VMSTATE_UINT8_ARRAY(setup_buf
, USBDevice
, 8),
74 VMSTATE_END_OF_LIST(),
78 void usb_bus_new(USBBus
*bus
, size_t bus_size
,
79 USBBusOps
*ops
, DeviceState
*host
)
81 qbus_create_inplace(bus
, bus_size
, TYPE_USB_BUS
, host
, NULL
);
83 bus
->busnr
= next_usb_bus
++;
84 bus
->qbus
.allow_hotplug
= 1; /* Yes, we can */
85 QTAILQ_INIT(&bus
->free
);
86 QTAILQ_INIT(&bus
->used
);
87 QTAILQ_INSERT_TAIL(&busses
, bus
, next
);
90 void usb_bus_release(USBBus
*bus
)
92 assert(next_usb_bus
> 0);
94 QTAILQ_REMOVE(&busses
, bus
, next
);
97 USBBus
*usb_bus_find(int busnr
)
102 return QTAILQ_FIRST(&busses
);
103 QTAILQ_FOREACH(bus
, &busses
, next
) {
104 if (bus
->busnr
== busnr
)
110 static void usb_device_realize(USBDevice
*dev
, Error
**errp
)
112 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
114 if (klass
->realize
) {
115 klass
->realize(dev
, errp
);
119 USBDevice
*usb_device_find_device(USBDevice
*dev
, uint8_t addr
)
121 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
122 if (klass
->find_device
) {
123 return klass
->find_device(dev
, addr
);
128 static void usb_device_handle_destroy(USBDevice
*dev
)
130 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
131 if (klass
->handle_destroy
) {
132 klass
->handle_destroy(dev
);
136 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
138 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
139 if (klass
->cancel_packet
) {
140 klass
->cancel_packet(dev
, p
);
144 void usb_device_handle_attach(USBDevice
*dev
)
146 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
147 if (klass
->handle_attach
) {
148 klass
->handle_attach(dev
);
152 void usb_device_handle_reset(USBDevice
*dev
)
154 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
155 if (klass
->handle_reset
) {
156 klass
->handle_reset(dev
);
160 void usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
,
161 int value
, int index
, int length
, uint8_t *data
)
163 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
164 if (klass
->handle_control
) {
165 klass
->handle_control(dev
, p
, request
, value
, index
, length
, data
);
169 void usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
)
171 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
172 if (klass
->handle_data
) {
173 klass
->handle_data(dev
, p
);
177 const char *usb_device_get_product_desc(USBDevice
*dev
)
179 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
180 return klass
->product_desc
;
183 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
)
185 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
187 return dev
->usb_desc
;
189 return klass
->usb_desc
;
192 void usb_device_set_interface(USBDevice
*dev
, int interface
,
193 int alt_old
, int alt_new
)
195 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
196 if (klass
->set_interface
) {
197 klass
->set_interface(dev
, interface
, alt_old
, alt_new
);
201 void usb_device_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
203 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
204 if (klass
->flush_ep_queue
) {
205 klass
->flush_ep_queue(dev
, ep
);
209 void usb_device_ep_stopped(USBDevice
*dev
, USBEndpoint
*ep
)
211 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
212 if (klass
->ep_stopped
) {
213 klass
->ep_stopped(dev
, ep
);
217 int usb_device_alloc_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
220 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
221 if (klass
->alloc_streams
) {
222 return klass
->alloc_streams(dev
, eps
, nr_eps
, streams
);
227 void usb_device_free_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
)
229 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
230 if (klass
->free_streams
) {
231 klass
->free_streams(dev
, eps
, nr_eps
);
235 static void usb_qdev_realize(DeviceState
*qdev
, Error
**errp
)
237 USBDevice
*dev
= USB_DEVICE(qdev
);
238 Error
*local_err
= NULL
;
240 pstrcpy(dev
->product_desc
, sizeof(dev
->product_desc
),
241 usb_device_get_product_desc(dev
));
242 dev
->auto_attach
= 1;
243 QLIST_INIT(&dev
->strings
);
246 usb_claim_port(dev
, &local_err
);
248 error_propagate(errp
, local_err
);
252 usb_device_realize(dev
, &local_err
);
254 usb_release_port(dev
);
255 error_propagate(errp
, local_err
);
259 if (dev
->auto_attach
) {
260 usb_device_attach(dev
, &local_err
);
262 usb_qdev_unrealize(qdev
, NULL
);
263 error_propagate(errp
, local_err
);
269 static void usb_qdev_unrealize(DeviceState
*qdev
, Error
**errp
)
271 USBDevice
*dev
= USB_DEVICE(qdev
);
274 usb_device_detach(dev
);
276 usb_device_handle_destroy(dev
);
278 usb_release_port(dev
);
282 typedef struct LegacyUSBFactory
285 const char *usbdevice_name
;
286 USBDevice
*(*usbdevice_init
)(USBBus
*bus
, const char *params
);
289 static GSList
*legacy_usb_factory
;
291 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
292 USBDevice
*(*usbdevice_init
)(USBBus
*bus
,
295 if (usbdevice_name
) {
296 LegacyUSBFactory
*f
= g_malloc0(sizeof(*f
));
298 f
->usbdevice_name
= usbdevice_name
;
299 f
->usbdevice_init
= usbdevice_init
;
300 legacy_usb_factory
= g_slist_append(legacy_usb_factory
, f
);
304 USBDevice
*usb_create(USBBus
*bus
, const char *name
)
308 dev
= qdev_create(&bus
->qbus
, name
);
309 return USB_DEVICE(dev
);
312 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
)
314 USBDevice
*dev
= usb_create(bus
, name
);
318 error_report("Failed to create USB device '%s'", name
);
321 rc
= qdev_init(&dev
->qdev
);
323 error_report("Failed to initialize USB device '%s'", name
);
329 static void usb_fill_port(USBPort
*port
, void *opaque
, int index
,
330 USBPortOps
*ops
, int speedmask
)
332 port
->opaque
= opaque
;
335 port
->speedmask
= speedmask
;
336 usb_port_location(port
, NULL
, index
+ 1);
339 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
340 USBPortOps
*ops
, int speedmask
)
342 usb_fill_port(port
, opaque
, index
, ops
, speedmask
);
343 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
347 int usb_register_companion(const char *masterbus
, USBPort
*ports
[],
348 uint32_t portcount
, uint32_t firstport
,
349 void *opaque
, USBPortOps
*ops
, int speedmask
)
354 QTAILQ_FOREACH(bus
, &busses
, next
) {
355 if (strcmp(bus
->qbus
.name
, masterbus
) == 0) {
360 if (!bus
|| !bus
->ops
->register_companion
) {
361 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "masterbus",
364 error_printf_unless_qmp(
365 "USB bus '%s' does not allow companion controllers\n",
371 for (i
= 0; i
< portcount
; i
++) {
372 usb_fill_port(ports
[i
], opaque
, i
, ops
, speedmask
);
375 return bus
->ops
->register_companion(bus
, ports
, portcount
, firstport
);
378 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
)
381 snprintf(downstream
->path
, sizeof(downstream
->path
), "%s.%d",
382 upstream
->path
, portnr
);
383 downstream
->hubcount
= upstream
->hubcount
+ 1;
385 snprintf(downstream
->path
, sizeof(downstream
->path
), "%d", portnr
);
386 downstream
->hubcount
= 0;
390 void usb_unregister_port(USBBus
*bus
, USBPort
*port
)
393 object_unparent(OBJECT(port
->dev
));
395 QTAILQ_REMOVE(&bus
->free
, port
, next
);
399 void usb_claim_port(USBDevice
*dev
, Error
**errp
)
401 USBBus
*bus
= usb_bus_from_device(dev
);
404 assert(dev
->port
== NULL
);
406 if (dev
->port_path
) {
407 QTAILQ_FOREACH(port
, &bus
->free
, next
) {
408 if (strcmp(port
->path
, dev
->port_path
) == 0) {
413 error_setg(errp
, "Error: usb port %s (bus %s) not found (in use?)",
414 dev
->port_path
, bus
->qbus
.name
);
418 if (bus
->nfree
== 1 && strcmp(object_get_typename(OBJECT(dev
)), "usb-hub") != 0) {
419 /* Create a new hub and chain it on */
420 usb_create_simple(bus
, "usb-hub");
422 if (bus
->nfree
== 0) {
423 error_setg(errp
, "Error: tried to attach usb device %s to a bus "
424 "with no free ports", dev
->product_desc
);
427 port
= QTAILQ_FIRST(&bus
->free
);
429 trace_usb_port_claim(bus
->busnr
, port
->path
);
431 QTAILQ_REMOVE(&bus
->free
, port
, next
);
437 QTAILQ_INSERT_TAIL(&bus
->used
, port
, next
);
441 void usb_release_port(USBDevice
*dev
)
443 USBBus
*bus
= usb_bus_from_device(dev
);
444 USBPort
*port
= dev
->port
;
446 assert(port
!= NULL
);
447 trace_usb_port_release(bus
->busnr
, port
->path
);
449 QTAILQ_REMOVE(&bus
->used
, port
, next
);
455 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
459 static void usb_mask_to_str(char *dest
, size_t size
,
460 unsigned int speedmask
)
462 static const struct {
466 { .mask
= USB_SPEED_MASK_FULL
, .name
= "full" },
467 { .mask
= USB_SPEED_MASK_HIGH
, .name
= "high" },
468 { .mask
= USB_SPEED_MASK_SUPER
, .name
= "super" },
472 for (i
= 0; i
< ARRAY_SIZE(speeds
); i
++) {
473 if (speeds
[i
].mask
& speedmask
) {
474 pos
+= snprintf(dest
+ pos
, size
- pos
, "%s%s",
481 void usb_check_attach(USBDevice
*dev
, Error
**errp
)
483 USBBus
*bus
= usb_bus_from_device(dev
);
484 USBPort
*port
= dev
->port
;
485 char devspeed
[32], portspeed
[32];
487 assert(port
!= NULL
);
488 assert(!dev
->attached
);
489 usb_mask_to_str(devspeed
, sizeof(devspeed
), dev
->speedmask
);
490 usb_mask_to_str(portspeed
, sizeof(portspeed
), port
->speedmask
);
491 trace_usb_port_attach(bus
->busnr
, port
->path
,
492 devspeed
, portspeed
);
494 if (!(port
->speedmask
& dev
->speedmask
)) {
495 error_setg(errp
, "Warning: speed mismatch trying to attach"
496 " usb device \"%s\" (%s speed)"
497 " to bus \"%s\", port \"%s\" (%s speed)",
498 dev
->product_desc
, devspeed
,
499 bus
->qbus
.name
, port
->path
, portspeed
);
504 void usb_device_attach(USBDevice
*dev
, Error
**errp
)
506 USBPort
*port
= dev
->port
;
507 Error
*local_err
= NULL
;
509 usb_check_attach(dev
, &local_err
);
511 error_propagate(errp
, local_err
);
519 int usb_device_detach(USBDevice
*dev
)
521 USBBus
*bus
= usb_bus_from_device(dev
);
522 USBPort
*port
= dev
->port
;
524 assert(port
!= NULL
);
525 assert(dev
->attached
);
526 trace_usb_port_detach(bus
->busnr
, port
->path
);
533 int usb_device_delete_addr(int busnr
, int addr
)
539 bus
= usb_bus_find(busnr
);
543 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
544 if (port
->dev
->addr
== addr
)
551 object_unparent(OBJECT(dev
));
555 static const char *usb_speed(unsigned int speed
)
557 static const char *txt
[] = {
558 [ USB_SPEED_LOW
] = "1.5",
559 [ USB_SPEED_FULL
] = "12",
560 [ USB_SPEED_HIGH
] = "480",
561 [ USB_SPEED_SUPER
] = "5000",
563 if (speed
>= ARRAY_SIZE(txt
))
568 static void usb_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
570 USBDevice
*dev
= USB_DEVICE(qdev
);
571 USBBus
*bus
= usb_bus_from_device(dev
);
573 monitor_printf(mon
, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
574 indent
, "", bus
->busnr
, dev
->addr
,
575 dev
->port
? dev
->port
->path
: "-",
576 usb_speed(dev
->speed
), dev
->product_desc
,
577 dev
->attached
? ", attached" : "");
580 static char *usb_get_dev_path(DeviceState
*qdev
)
582 USBDevice
*dev
= USB_DEVICE(qdev
);
583 DeviceState
*hcd
= qdev
->parent_bus
->parent
;
586 if (dev
->flags
& (1 << USB_DEV_FLAG_FULL_PATH
)) {
587 id
= qdev_get_dev_path(hcd
);
590 char *ret
= g_strdup_printf("%s/%s", id
, dev
->port
->path
);
594 return g_strdup(dev
->port
->path
);
598 static char *usb_get_fw_dev_path(DeviceState
*qdev
)
600 USBDevice
*dev
= USB_DEVICE(qdev
);
602 ssize_t pos
= 0, fw_len
;
605 fw_len
= 32 + strlen(dev
->port
->path
) * 6;
606 fw_path
= g_malloc(fw_len
);
607 in
= dev
->port
->path
;
608 while (fw_len
- pos
> 0) {
609 nr
= strtol(in
, &in
, 10);
611 /* some hub between root port and device */
612 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "hub@%lx/", nr
);
615 /* the device itself */
616 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "%s@%lx",
617 qdev_fw_name(qdev
), nr
);
624 void usb_info(Monitor
*mon
, const QDict
*qdict
)
630 if (QTAILQ_EMPTY(&busses
)) {
631 monitor_printf(mon
, "USB support not enabled\n");
635 QTAILQ_FOREACH(bus
, &busses
, next
) {
636 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
640 monitor_printf(mon
, " Device %d.%d, Port %s, Speed %s Mb/s, Product %s\n",
641 bus
->busnr
, dev
->addr
, port
->path
, usb_speed(dev
->speed
),
647 /* handle legacy -usbdevice cmd line option */
648 USBDevice
*usbdevice_create(const char *cmdline
)
650 USBBus
*bus
= usb_bus_find(-1 /* any */);
651 LegacyUSBFactory
*f
= NULL
;
657 params
= strchr(cmdline
,':');
660 len
= params
- cmdline
;
661 if (len
> sizeof(driver
))
662 len
= sizeof(driver
);
663 pstrcpy(driver
, len
, cmdline
);
666 pstrcpy(driver
, sizeof(driver
), cmdline
);
669 for (i
= legacy_usb_factory
; i
; i
= i
->next
) {
671 if (strcmp(f
->usbdevice_name
, driver
) == 0) {
677 /* no error because some drivers are not converted (yet) */
678 error_report("usbdevice %s not found", driver
);
684 error_report("Error: no usb bus to attach usbdevice %s, "
685 "please try -machine usb=on and check that "
686 "the machine model supports USB", driver
);
690 if (!f
->usbdevice_init
) {
692 error_report("usbdevice %s accepts no params", driver
);
695 return usb_create_simple(bus
, f
->name
);
697 return f
->usbdevice_init(bus
, params
);
700 static void usb_device_class_init(ObjectClass
*klass
, void *data
)
702 DeviceClass
*k
= DEVICE_CLASS(klass
);
703 k
->bus_type
= TYPE_USB_BUS
;
704 k
->unplug
= qdev_simple_unplug_cb
;
705 k
->realize
= usb_qdev_realize
;
706 k
->unrealize
= usb_qdev_unrealize
;
707 k
->props
= usb_props
;
710 static const TypeInfo usb_device_type_info
= {
711 .name
= TYPE_USB_DEVICE
,
712 .parent
= TYPE_DEVICE
,
713 .instance_size
= sizeof(USBDevice
),
715 .class_size
= sizeof(USBDeviceClass
),
716 .class_init
= usb_device_class_init
,
719 static void usb_register_types(void)
721 type_register_static(&usb_bus_info
);
722 type_register_static(&usb_device_type_info
);
725 type_init(usb_register_types
)