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 int usb_qdev_exit(DeviceState
*qdev
);
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_END_OF_LIST()
22 static void usb_bus_class_init(ObjectClass
*klass
, void *data
)
24 BusClass
*k
= BUS_CLASS(klass
);
26 k
->print_dev
= usb_bus_dev_print
;
27 k
->get_dev_path
= usb_get_dev_path
;
28 k
->get_fw_dev_path
= usb_get_fw_dev_path
;
31 static const TypeInfo usb_bus_info
= {
34 .instance_size
= sizeof(USBBus
),
35 .class_init
= usb_bus_class_init
,
38 static int next_usb_bus
= 0;
39 static QTAILQ_HEAD(, USBBus
) busses
= QTAILQ_HEAD_INITIALIZER(busses
);
41 static int usb_device_post_load(void *opaque
, int version_id
)
43 USBDevice
*dev
= opaque
;
45 if (dev
->state
== USB_STATE_NOTATTACHED
) {
50 if (dev
->setup_index
>= sizeof(dev
->data_buf
) ||
51 dev
->setup_len
>= sizeof(dev
->data_buf
)) {
57 const VMStateDescription vmstate_usb_device
= {
60 .minimum_version_id
= 1,
61 .post_load
= usb_device_post_load
,
62 .fields
= (VMStateField
[]) {
63 VMSTATE_UINT8(addr
, USBDevice
),
64 VMSTATE_INT32(state
, USBDevice
),
65 VMSTATE_INT32(remote_wakeup
, USBDevice
),
66 VMSTATE_INT32(setup_state
, USBDevice
),
67 VMSTATE_INT32(setup_len
, USBDevice
),
68 VMSTATE_INT32(setup_index
, USBDevice
),
69 VMSTATE_UINT8_ARRAY(setup_buf
, USBDevice
, 8),
70 VMSTATE_END_OF_LIST(),
74 void usb_bus_new(USBBus
*bus
, size_t bus_size
,
75 USBBusOps
*ops
, DeviceState
*host
)
77 qbus_create_inplace(bus
, bus_size
, TYPE_USB_BUS
, host
, NULL
);
79 bus
->busnr
= next_usb_bus
++;
80 bus
->qbus
.allow_hotplug
= 1; /* Yes, we can */
81 QTAILQ_INIT(&bus
->free
);
82 QTAILQ_INIT(&bus
->used
);
83 QTAILQ_INSERT_TAIL(&busses
, bus
, next
);
86 USBBus
*usb_bus_find(int busnr
)
91 return QTAILQ_FIRST(&busses
);
92 QTAILQ_FOREACH(bus
, &busses
, next
) {
93 if (bus
->busnr
== busnr
)
99 static int usb_device_init(USBDevice
*dev
)
101 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
103 return klass
->init(dev
);
108 USBDevice
*usb_device_find_device(USBDevice
*dev
, uint8_t addr
)
110 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
111 if (klass
->find_device
) {
112 return klass
->find_device(dev
, addr
);
117 static void usb_device_handle_destroy(USBDevice
*dev
)
119 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
120 if (klass
->handle_destroy
) {
121 klass
->handle_destroy(dev
);
125 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
)
127 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
128 if (klass
->cancel_packet
) {
129 klass
->cancel_packet(dev
, p
);
133 void usb_device_handle_attach(USBDevice
*dev
)
135 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
136 if (klass
->handle_attach
) {
137 klass
->handle_attach(dev
);
141 void usb_device_handle_reset(USBDevice
*dev
)
143 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
144 if (klass
->handle_reset
) {
145 klass
->handle_reset(dev
);
149 void usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
,
150 int value
, int index
, int length
, uint8_t *data
)
152 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
153 if (klass
->handle_control
) {
154 klass
->handle_control(dev
, p
, request
, value
, index
, length
, data
);
158 void usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
)
160 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
161 if (klass
->handle_data
) {
162 klass
->handle_data(dev
, p
);
166 const char *usb_device_get_product_desc(USBDevice
*dev
)
168 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
169 return klass
->product_desc
;
172 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
)
174 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
176 return dev
->usb_desc
;
178 return klass
->usb_desc
;
181 void usb_device_set_interface(USBDevice
*dev
, int interface
,
182 int alt_old
, int alt_new
)
184 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
185 if (klass
->set_interface
) {
186 klass
->set_interface(dev
, interface
, alt_old
, alt_new
);
190 void usb_device_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
192 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
193 if (klass
->flush_ep_queue
) {
194 klass
->flush_ep_queue(dev
, ep
);
198 void usb_device_ep_stopped(USBDevice
*dev
, USBEndpoint
*ep
)
200 USBDeviceClass
*klass
= USB_DEVICE_GET_CLASS(dev
);
201 if (klass
->ep_stopped
) {
202 klass
->ep_stopped(dev
, ep
);
206 static int usb_qdev_init(DeviceState
*qdev
)
208 USBDevice
*dev
= USB_DEVICE(qdev
);
211 pstrcpy(dev
->product_desc
, sizeof(dev
->product_desc
),
212 usb_device_get_product_desc(dev
));
213 dev
->auto_attach
= 1;
214 QLIST_INIT(&dev
->strings
);
216 rc
= usb_claim_port(dev
);
220 rc
= usb_device_init(dev
);
222 usb_release_port(dev
);
225 if (dev
->auto_attach
) {
226 rc
= usb_device_attach(dev
);
235 static int usb_qdev_exit(DeviceState
*qdev
)
237 USBDevice
*dev
= USB_DEVICE(qdev
);
240 usb_device_detach(dev
);
242 usb_device_handle_destroy(dev
);
244 usb_release_port(dev
);
249 typedef struct LegacyUSBFactory
252 const char *usbdevice_name
;
253 USBDevice
*(*usbdevice_init
)(USBBus
*bus
, const char *params
);
256 static GSList
*legacy_usb_factory
;
258 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
259 USBDevice
*(*usbdevice_init
)(USBBus
*bus
,
262 if (usbdevice_name
) {
263 LegacyUSBFactory
*f
= g_malloc0(sizeof(*f
));
265 f
->usbdevice_name
= usbdevice_name
;
266 f
->usbdevice_init
= usbdevice_init
;
267 legacy_usb_factory
= g_slist_append(legacy_usb_factory
, f
);
271 USBDevice
*usb_create(USBBus
*bus
, const char *name
)
275 dev
= qdev_create(&bus
->qbus
, name
);
276 return USB_DEVICE(dev
);
279 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
)
281 USBDevice
*dev
= usb_create(bus
, name
);
285 error_report("Failed to create USB device '%s'", name
);
288 rc
= qdev_init(&dev
->qdev
);
290 error_report("Failed to initialize USB device '%s'", name
);
296 static void usb_fill_port(USBPort
*port
, void *opaque
, int index
,
297 USBPortOps
*ops
, int speedmask
)
299 port
->opaque
= opaque
;
302 port
->speedmask
= speedmask
;
303 usb_port_location(port
, NULL
, index
+ 1);
306 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
307 USBPortOps
*ops
, int speedmask
)
309 usb_fill_port(port
, opaque
, index
, ops
, speedmask
);
310 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
314 int usb_register_companion(const char *masterbus
, USBPort
*ports
[],
315 uint32_t portcount
, uint32_t firstport
,
316 void *opaque
, USBPortOps
*ops
, int speedmask
)
321 QTAILQ_FOREACH(bus
, &busses
, next
) {
322 if (strcmp(bus
->qbus
.name
, masterbus
) == 0) {
327 if (!bus
|| !bus
->ops
->register_companion
) {
328 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "masterbus",
331 error_printf_unless_qmp(
332 "USB bus '%s' does not allow companion controllers\n",
338 for (i
= 0; i
< portcount
; i
++) {
339 usb_fill_port(ports
[i
], opaque
, i
, ops
, speedmask
);
342 return bus
->ops
->register_companion(bus
, ports
, portcount
, firstport
);
345 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
)
348 snprintf(downstream
->path
, sizeof(downstream
->path
), "%s.%d",
349 upstream
->path
, portnr
);
350 downstream
->hubcount
= upstream
->hubcount
+ 1;
352 snprintf(downstream
->path
, sizeof(downstream
->path
), "%d", portnr
);
353 downstream
->hubcount
= 0;
357 void usb_unregister_port(USBBus
*bus
, USBPort
*port
)
360 qdev_free(&port
->dev
->qdev
);
361 QTAILQ_REMOVE(&bus
->free
, port
, next
);
365 int usb_claim_port(USBDevice
*dev
)
367 USBBus
*bus
= usb_bus_from_device(dev
);
370 assert(dev
->port
== NULL
);
372 if (dev
->port_path
) {
373 QTAILQ_FOREACH(port
, &bus
->free
, next
) {
374 if (strcmp(port
->path
, dev
->port_path
) == 0) {
379 error_report("Error: usb port %s (bus %s) not found (in use?)",
380 dev
->port_path
, bus
->qbus
.name
);
384 if (bus
->nfree
== 1 && strcmp(object_get_typename(OBJECT(dev
)), "usb-hub") != 0) {
385 /* Create a new hub and chain it on */
386 usb_create_simple(bus
, "usb-hub");
388 if (bus
->nfree
== 0) {
389 error_report("Error: tried to attach usb device %s to a bus "
390 "with no free ports", dev
->product_desc
);
393 port
= QTAILQ_FIRST(&bus
->free
);
395 trace_usb_port_claim(bus
->busnr
, port
->path
);
397 QTAILQ_REMOVE(&bus
->free
, port
, next
);
403 QTAILQ_INSERT_TAIL(&bus
->used
, port
, next
);
408 void usb_release_port(USBDevice
*dev
)
410 USBBus
*bus
= usb_bus_from_device(dev
);
411 USBPort
*port
= dev
->port
;
413 assert(port
!= NULL
);
414 trace_usb_port_release(bus
->busnr
, port
->path
);
416 QTAILQ_REMOVE(&bus
->used
, port
, next
);
422 QTAILQ_INSERT_TAIL(&bus
->free
, port
, next
);
426 static void usb_mask_to_str(char *dest
, size_t size
,
427 unsigned int speedmask
)
429 static const struct {
433 { .mask
= USB_SPEED_MASK_FULL
, .name
= "full" },
434 { .mask
= USB_SPEED_MASK_HIGH
, .name
= "high" },
435 { .mask
= USB_SPEED_MASK_SUPER
, .name
= "super" },
439 for (i
= 0; i
< ARRAY_SIZE(speeds
); i
++) {
440 if (speeds
[i
].mask
& speedmask
) {
441 pos
+= snprintf(dest
+ pos
, size
- pos
, "%s%s",
448 int usb_device_attach(USBDevice
*dev
)
450 USBBus
*bus
= usb_bus_from_device(dev
);
451 USBPort
*port
= dev
->port
;
452 char devspeed
[32], portspeed
[32];
454 assert(port
!= NULL
);
455 assert(!dev
->attached
);
456 usb_mask_to_str(devspeed
, sizeof(devspeed
), dev
->speedmask
);
457 usb_mask_to_str(portspeed
, sizeof(portspeed
), port
->speedmask
);
458 trace_usb_port_attach(bus
->busnr
, port
->path
,
459 devspeed
, portspeed
);
461 if (!(port
->speedmask
& dev
->speedmask
)) {
462 error_report("Warning: speed mismatch trying to attach"
463 " usb device \"%s\" (%s speed)"
464 " to bus \"%s\", port \"%s\" (%s speed)",
465 dev
->product_desc
, devspeed
,
466 bus
->qbus
.name
, port
->path
, portspeed
);
476 int usb_device_detach(USBDevice
*dev
)
478 USBBus
*bus
= usb_bus_from_device(dev
);
479 USBPort
*port
= dev
->port
;
481 assert(port
!= NULL
);
482 assert(dev
->attached
);
483 trace_usb_port_detach(bus
->busnr
, port
->path
);
490 int usb_device_delete_addr(int busnr
, int addr
)
496 bus
= usb_bus_find(busnr
);
500 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
501 if (port
->dev
->addr
== addr
)
508 qdev_free(&dev
->qdev
);
512 static const char *usb_speed(unsigned int speed
)
514 static const char *txt
[] = {
515 [ USB_SPEED_LOW
] = "1.5",
516 [ USB_SPEED_FULL
] = "12",
517 [ USB_SPEED_HIGH
] = "480",
518 [ USB_SPEED_SUPER
] = "5000",
520 if (speed
>= ARRAY_SIZE(txt
))
525 static void usb_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
527 USBDevice
*dev
= USB_DEVICE(qdev
);
528 USBBus
*bus
= usb_bus_from_device(dev
);
530 monitor_printf(mon
, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
531 indent
, "", bus
->busnr
, dev
->addr
,
532 dev
->port
? dev
->port
->path
: "-",
533 usb_speed(dev
->speed
), dev
->product_desc
,
534 dev
->attached
? ", attached" : "");
537 static char *usb_get_dev_path(DeviceState
*qdev
)
539 USBDevice
*dev
= USB_DEVICE(qdev
);
540 DeviceState
*hcd
= qdev
->parent_bus
->parent
;
543 if (dev
->flags
& (1 << USB_DEV_FLAG_FULL_PATH
)) {
544 id
= qdev_get_dev_path(hcd
);
547 char *ret
= g_strdup_printf("%s/%s", id
, dev
->port
->path
);
551 return g_strdup(dev
->port
->path
);
555 static char *usb_get_fw_dev_path(DeviceState
*qdev
)
557 USBDevice
*dev
= USB_DEVICE(qdev
);
559 ssize_t pos
= 0, fw_len
;
562 fw_len
= 32 + strlen(dev
->port
->path
) * 6;
563 fw_path
= g_malloc(fw_len
);
564 in
= dev
->port
->path
;
565 while (fw_len
- pos
> 0) {
566 nr
= strtol(in
, &in
, 10);
568 /* some hub between root port and device */
569 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "hub@%ld/", nr
);
572 /* the device itself */
573 pos
+= snprintf(fw_path
+ pos
, fw_len
- pos
, "%s@%ld",
574 qdev_fw_name(qdev
), nr
);
581 void usb_info(Monitor
*mon
, const QDict
*qdict
)
587 if (QTAILQ_EMPTY(&busses
)) {
588 monitor_printf(mon
, "USB support not enabled\n");
592 QTAILQ_FOREACH(bus
, &busses
, next
) {
593 QTAILQ_FOREACH(port
, &bus
->used
, next
) {
597 monitor_printf(mon
, " Device %d.%d, Port %s, Speed %s Mb/s, Product %s\n",
598 bus
->busnr
, dev
->addr
, port
->path
, usb_speed(dev
->speed
),
604 /* handle legacy -usbdevice cmd line option */
605 USBDevice
*usbdevice_create(const char *cmdline
)
607 USBBus
*bus
= usb_bus_find(-1 /* any */);
608 LegacyUSBFactory
*f
= NULL
;
614 params
= strchr(cmdline
,':');
617 len
= params
- cmdline
;
618 if (len
> sizeof(driver
))
619 len
= sizeof(driver
);
620 pstrcpy(driver
, len
, cmdline
);
623 pstrcpy(driver
, sizeof(driver
), cmdline
);
626 for (i
= legacy_usb_factory
; i
; i
= i
->next
) {
628 if (strcmp(f
->usbdevice_name
, driver
) == 0) {
634 /* no error because some drivers are not converted (yet) */
635 error_report("usbdevice %s not found", driver
);
641 error_report("Error: no usb bus to attach usbdevice %s, "
642 "please try -machine usb=on and check that "
643 "the machine model supports USB", driver
);
647 if (!f
->usbdevice_init
) {
649 error_report("usbdevice %s accepts no params", driver
);
652 return usb_create_simple(bus
, f
->name
);
654 return f
->usbdevice_init(bus
, params
);
657 static void usb_device_class_init(ObjectClass
*klass
, void *data
)
659 DeviceClass
*k
= DEVICE_CLASS(klass
);
660 k
->bus_type
= TYPE_USB_BUS
;
661 k
->init
= usb_qdev_init
;
662 k
->unplug
= qdev_simple_unplug_cb
;
663 k
->exit
= usb_qdev_exit
;
664 k
->props
= usb_props
;
667 static const TypeInfo usb_device_type_info
= {
668 .name
= TYPE_USB_DEVICE
,
669 .parent
= TYPE_DEVICE
,
670 .instance_size
= sizeof(USBDevice
),
672 .class_size
= sizeof(USBDeviceClass
),
673 .class_init
= usb_device_class_init
,
676 static void usb_register_types(void)
678 type_register_static(&usb_bus_info
);
679 type_register_static(&usb_device_type_info
);
682 type_init(usb_register_types
)