2 * QEMU USB HUB emulation
4 * Copyright (c) 2005 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/timer.h"
29 #include "hw/qdev-properties.h"
31 #include "migration/vmstate.h"
33 #include "qemu/error-report.h"
34 #include "qemu/module.h"
38 typedef struct USBHubPort
{
44 typedef struct USBHubState
{
49 QEMUTimer
*port_timer
;
50 USBHubPort ports
[MAX_PORTS
];
53 #define TYPE_USB_HUB "usb-hub"
54 #define USB_HUB(obj) OBJECT_CHECK(USBHubState, (obj), TYPE_USB_HUB)
56 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
57 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
58 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
59 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
60 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
61 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
62 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
64 #define PORT_STAT_CONNECTION 0x0001
65 #define PORT_STAT_ENABLE 0x0002
66 #define PORT_STAT_SUSPEND 0x0004
67 #define PORT_STAT_OVERCURRENT 0x0008
68 #define PORT_STAT_RESET 0x0010
69 #define PORT_STAT_POWER 0x0100
70 #define PORT_STAT_LOW_SPEED 0x0200
71 #define PORT_STAT_HIGH_SPEED 0x0400
72 #define PORT_STAT_TEST 0x0800
73 #define PORT_STAT_INDICATOR 0x1000
75 #define PORT_STAT_C_CONNECTION 0x0001
76 #define PORT_STAT_C_ENABLE 0x0002
77 #define PORT_STAT_C_SUSPEND 0x0004
78 #define PORT_STAT_C_OVERCURRENT 0x0008
79 #define PORT_STAT_C_RESET 0x0010
81 #define PORT_CONNECTION 0
83 #define PORT_SUSPEND 2
84 #define PORT_OVERCURRENT 3
87 #define PORT_LOWSPEED 9
88 #define PORT_HIGHSPEED 10
89 #define PORT_C_CONNECTION 16
90 #define PORT_C_ENABLE 17
91 #define PORT_C_SUSPEND 18
92 #define PORT_C_OVERCURRENT 19
93 #define PORT_C_RESET 20
95 #define PORT_INDICATOR 22
97 /* same as Linux kernel root hubs */
100 STR_MANUFACTURER
= 1,
105 static const USBDescStrings desc_strings
= {
106 [STR_MANUFACTURER
] = "QEMU",
107 [STR_PRODUCT
] = "QEMU USB Hub",
108 [STR_SERIALNUMBER
] = "314159",
111 static const USBDescIface desc_iface_hub
= {
112 .bInterfaceNumber
= 0,
114 .bInterfaceClass
= USB_CLASS_HUB
,
115 .eps
= (USBDescEndpoint
[]) {
117 .bEndpointAddress
= USB_DIR_IN
| 0x01,
118 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
119 .wMaxPacketSize
= 1 + DIV_ROUND_UP(MAX_PORTS
, 8),
125 static const USBDescDevice desc_device_hub
= {
127 .bDeviceClass
= USB_CLASS_HUB
,
128 .bMaxPacketSize0
= 8,
129 .bNumConfigurations
= 1,
130 .confs
= (USBDescConfig
[]) {
133 .bConfigurationValue
= 1,
134 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_SELFPOWER
|
137 .ifs
= &desc_iface_hub
,
142 static const USBDesc desc_hub
= {
147 .iManufacturer
= STR_MANUFACTURER
,
148 .iProduct
= STR_PRODUCT
,
149 .iSerialNumber
= STR_SERIALNUMBER
,
151 .full
= &desc_device_hub
,
155 static const uint8_t qemu_hub_hub_descriptor
[] =
157 0x00, /* u8 bLength; patched in later */
158 0x29, /* u8 bDescriptorType; Hub-descriptor */
159 0x00, /* u8 bNbrPorts; (patched later) */
160 0x0a, /* u16 wHubCharacteristics; */
161 0x00, /* (per-port OC, no power switching) */
162 0x01, /* u8 bPwrOn2pwrGood; 2ms */
163 0x00 /* u8 bHubContrCurrent; 0 mA */
165 /* DeviceRemovable and PortPwrCtrlMask patched in later */
168 static bool usb_hub_port_change(USBHubPort
*port
, uint16_t status
)
173 port
->wPortChange
|= status
;
179 static bool usb_hub_port_set(USBHubPort
*port
, uint16_t status
)
181 if (port
->wPortStatus
& status
) {
184 port
->wPortStatus
|= status
;
185 return usb_hub_port_change(port
, status
);
188 static bool usb_hub_port_clear(USBHubPort
*port
, uint16_t status
)
190 if (!(port
->wPortStatus
& status
)) {
193 port
->wPortStatus
&= ~status
;
194 return usb_hub_port_change(port
, status
);
197 static bool usb_hub_port_update(USBHubPort
*port
)
201 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
202 notify
= usb_hub_port_set(port
, PORT_STAT_CONNECTION
);
203 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
204 usb_hub_port_set(port
, PORT_STAT_LOW_SPEED
);
206 usb_hub_port_clear(port
, PORT_STAT_LOW_SPEED
);
212 static void usb_hub_port_update_timer(void *opaque
)
214 USBHubState
*s
= opaque
;
218 for (i
= 0; i
< s
->num_ports
; i
++) {
219 notify
|= usb_hub_port_update(&s
->ports
[i
]);
222 usb_wakeup(s
->intr
, 0);
226 static void usb_hub_attach(USBPort
*port1
)
228 USBHubState
*s
= port1
->opaque
;
229 USBHubPort
*port
= &s
->ports
[port1
->index
];
231 trace_usb_hub_attach(s
->dev
.addr
, port1
->index
+ 1);
232 usb_hub_port_update(port
);
233 usb_wakeup(s
->intr
, 0);
236 static void usb_hub_detach(USBPort
*port1
)
238 USBHubState
*s
= port1
->opaque
;
239 USBHubPort
*port
= &s
->ports
[port1
->index
];
241 trace_usb_hub_detach(s
->dev
.addr
, port1
->index
+ 1);
242 usb_wakeup(s
->intr
, 0);
244 /* Let upstream know the device on this port is gone */
245 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, port1
->dev
);
247 usb_hub_port_clear(port
, PORT_STAT_CONNECTION
);
248 usb_hub_port_clear(port
, PORT_STAT_ENABLE
);
249 usb_hub_port_clear(port
, PORT_STAT_SUSPEND
);
250 usb_wakeup(s
->intr
, 0);
253 static void usb_hub_child_detach(USBPort
*port1
, USBDevice
*child
)
255 USBHubState
*s
= port1
->opaque
;
257 /* Pass along upstream */
258 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, child
);
261 static void usb_hub_wakeup(USBPort
*port1
)
263 USBHubState
*s
= port1
->opaque
;
264 USBHubPort
*port
= &s
->ports
[port1
->index
];
266 if (usb_hub_port_clear(port
, PORT_STAT_SUSPEND
)) {
267 usb_wakeup(s
->intr
, 0);
271 static void usb_hub_complete(USBPort
*port
, USBPacket
*packet
)
273 USBHubState
*s
= port
->opaque
;
276 * Just pass it along upstream for now.
278 * If we ever implement usb 2.0 split transactions this will
279 * become a little more complicated ...
281 * Can't use usb_packet_complete() here because packet->owner is
282 * cleared already, go call the ->complete() callback directly
285 s
->dev
.port
->ops
->complete(s
->dev
.port
, packet
);
288 static USBDevice
*usb_hub_find_device(USBDevice
*dev
, uint8_t addr
)
290 USBHubState
*s
= USB_HUB(dev
);
292 USBDevice
*downstream
;
295 for (i
= 0; i
< s
->num_ports
; i
++) {
297 if (!(port
->wPortStatus
& PORT_STAT_ENABLE
)) {
300 downstream
= usb_find_device(&port
->port
, addr
);
301 if (downstream
!= NULL
) {
308 static void usb_hub_handle_reset(USBDevice
*dev
)
310 USBHubState
*s
= USB_HUB(dev
);
314 trace_usb_hub_reset(s
->dev
.addr
);
315 for (i
= 0; i
< s
->num_ports
; i
++) {
317 port
->wPortStatus
= 0;
318 port
->wPortChange
= 0;
319 usb_hub_port_set(port
, PORT_STAT_POWER
);
320 usb_hub_port_update(port
);
324 static const char *feature_name(int feature
)
326 static const char *name
[] = {
327 [PORT_CONNECTION
] = "connection",
328 [PORT_ENABLE
] = "enable",
329 [PORT_SUSPEND
] = "suspend",
330 [PORT_OVERCURRENT
] = "overcurrent",
331 [PORT_RESET
] = "reset",
332 [PORT_POWER
] = "power",
333 [PORT_LOWSPEED
] = "lowspeed",
334 [PORT_HIGHSPEED
] = "highspeed",
335 [PORT_C_CONNECTION
] = "change-connection",
336 [PORT_C_ENABLE
] = "change-enable",
337 [PORT_C_SUSPEND
] = "change-suspend",
338 [PORT_C_OVERCURRENT
] = "change-overcurrent",
339 [PORT_C_RESET
] = "change-reset",
340 [PORT_TEST
] = "test",
341 [PORT_INDICATOR
] = "indicator",
343 if (feature
< 0 || feature
>= ARRAY_SIZE(name
)) {
346 return name
[feature
] ?: "?";
349 static void usb_hub_handle_control(USBDevice
*dev
, USBPacket
*p
,
350 int request
, int value
, int index
, int length
, uint8_t *data
)
352 USBHubState
*s
= (USBHubState
*)dev
;
355 trace_usb_hub_control(s
->dev
.addr
, request
, value
, index
, length
);
357 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
363 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
364 if (value
== 0 && index
!= 0x81) { /* clear ep halt */
368 /* usb specific requests */
374 p
->actual_length
= 4;
378 unsigned int n
= index
- 1;
380 if (n
>= s
->num_ports
) {
384 trace_usb_hub_get_port_status(s
->dev
.addr
, index
,
387 data
[0] = port
->wPortStatus
;
388 data
[1] = port
->wPortStatus
>> 8;
389 data
[2] = port
->wPortChange
;
390 data
[3] = port
->wPortChange
>> 8;
391 p
->actual_length
= 4;
395 case ClearHubFeature
:
396 if (value
!= 0 && value
!= 1) {
402 unsigned int n
= index
- 1;
406 trace_usb_hub_set_port_feature(s
->dev
.addr
, index
,
407 feature_name(value
));
409 if (n
>= s
->num_ports
) {
413 dev
= port
->port
.dev
;
416 port
->wPortStatus
|= PORT_STAT_SUSPEND
;
419 usb_hub_port_set(port
, PORT_STAT_RESET
);
420 usb_hub_port_clear(port
, PORT_STAT_RESET
);
421 if (dev
&& dev
->attached
) {
422 usb_device_reset(dev
);
423 usb_hub_port_set(port
, PORT_STAT_ENABLE
);
425 usb_wakeup(s
->intr
, 0);
429 int64_t now
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
430 usb_hub_port_set(port
, PORT_STAT_POWER
);
431 timer_mod(s
->port_timer
, now
+ 5000000); /* 5 ms */
439 case ClearPortFeature
:
441 unsigned int n
= index
- 1;
444 trace_usb_hub_clear_port_feature(s
->dev
.addr
, index
,
445 feature_name(value
));
447 if (n
>= s
->num_ports
) {
453 port
->wPortStatus
&= ~PORT_STAT_ENABLE
;
456 port
->wPortChange
&= ~PORT_STAT_C_ENABLE
;
459 usb_hub_port_clear(port
, PORT_STAT_SUSPEND
);
462 port
->wPortChange
&= ~PORT_STAT_C_SUSPEND
;
464 case PORT_C_CONNECTION
:
465 port
->wPortChange
&= ~PORT_STAT_C_CONNECTION
;
467 case PORT_C_OVERCURRENT
:
468 port
->wPortChange
&= ~PORT_STAT_C_OVERCURRENT
;
471 port
->wPortChange
&= ~PORT_STAT_C_RESET
;
475 usb_hub_port_clear(port
, PORT_STAT_POWER
);
476 usb_hub_port_clear(port
, PORT_STAT_CONNECTION
);
477 usb_hub_port_clear(port
, PORT_STAT_ENABLE
);
478 usb_hub_port_clear(port
, PORT_STAT_SUSPEND
);
479 port
->wPortChange
= 0;
486 case GetHubDescriptor
:
488 unsigned int n
, limit
, var_hub_size
= 0;
489 memcpy(data
, qemu_hub_hub_descriptor
,
490 sizeof(qemu_hub_hub_descriptor
));
491 data
[2] = s
->num_ports
;
498 /* fill DeviceRemovable bits */
499 limit
= DIV_ROUND_UP(s
->num_ports
+ 1, 8) + 7;
500 for (n
= 7; n
< limit
; n
++) {
505 /* fill PortPwrCtrlMask bits */
506 limit
= limit
+ DIV_ROUND_UP(s
->num_ports
, 8);
507 for (;n
< limit
; n
++) {
512 p
->actual_length
= sizeof(qemu_hub_hub_descriptor
) + var_hub_size
;
513 data
[0] = p
->actual_length
;
518 p
->status
= USB_RET_STALL
;
523 static void usb_hub_handle_data(USBDevice
*dev
, USBPacket
*p
)
525 USBHubState
*s
= (USBHubState
*)dev
;
529 if (p
->ep
->nr
== 1) {
534 n
= DIV_ROUND_UP(s
->num_ports
+ 1, 8);
535 if (p
->iov
.size
== 1) { /* FreeBSD workaround */
537 } else if (n
> p
->iov
.size
) {
538 p
->status
= USB_RET_BABBLE
;
542 for (i
= 0; i
< s
->num_ports
; i
++) {
544 if (port
->wPortChange
)
545 status
|= (1 << (i
+ 1));
548 trace_usb_hub_status_report(s
->dev
.addr
, status
);
549 for(i
= 0; i
< n
; i
++) {
550 buf
[i
] = status
>> (8 * i
);
552 usb_packet_copy(p
, buf
, n
);
554 p
->status
= USB_RET_NAK
; /* usb11 11.13.1 */
563 p
->status
= USB_RET_STALL
;
568 static void usb_hub_unrealize(USBDevice
*dev
, Error
**errp
)
570 USBHubState
*s
= (USBHubState
*)dev
;
573 for (i
= 0; i
< s
->num_ports
; i
++) {
574 usb_unregister_port(usb_bus_from_device(dev
),
578 timer_del(s
->port_timer
);
579 timer_free(s
->port_timer
);
582 static USBPortOps usb_hub_port_ops
= {
583 .attach
= usb_hub_attach
,
584 .detach
= usb_hub_detach
,
585 .child_detach
= usb_hub_child_detach
,
586 .wakeup
= usb_hub_wakeup
,
587 .complete
= usb_hub_complete
,
590 static void usb_hub_realize(USBDevice
*dev
, Error
**errp
)
592 USBHubState
*s
= USB_HUB(dev
);
596 if (s
->num_ports
< 1 || s
->num_ports
> MAX_PORTS
) {
597 error_setg(errp
, "num_ports (%d) out of range (1..%d)",
598 s
->num_ports
, MAX_PORTS
);
602 if (dev
->port
->hubcount
== 5) {
603 error_setg(errp
, "usb hub chain too deep");
607 usb_desc_create_serial(dev
);
609 s
->port_timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
,
610 usb_hub_port_update_timer
, s
);
611 s
->intr
= usb_ep_get(dev
, USB_TOKEN_IN
, 1);
612 for (i
= 0; i
< s
->num_ports
; i
++) {
614 usb_register_port(usb_bus_from_device(dev
),
615 &port
->port
, s
, i
, &usb_hub_port_ops
,
616 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
617 usb_port_location(&port
->port
, dev
->port
, i
+1);
619 usb_hub_handle_reset(dev
);
622 static const VMStateDescription vmstate_usb_hub_port
= {
623 .name
= "usb-hub-port",
625 .minimum_version_id
= 1,
626 .fields
= (VMStateField
[]) {
627 VMSTATE_UINT16(wPortStatus
, USBHubPort
),
628 VMSTATE_UINT16(wPortChange
, USBHubPort
),
629 VMSTATE_END_OF_LIST()
633 static bool usb_hub_port_timer_needed(void *opaque
)
635 USBHubState
*s
= opaque
;
637 return s
->port_power
;
640 static const VMStateDescription vmstate_usb_hub_port_timer
= {
641 .name
= "usb-hub/port-timer",
643 .minimum_version_id
= 1,
644 .needed
= usb_hub_port_timer_needed
,
645 .fields
= (VMStateField
[]) {
646 VMSTATE_TIMER_PTR(port_timer
, USBHubState
),
647 VMSTATE_END_OF_LIST()
651 static const VMStateDescription vmstate_usb_hub
= {
654 .minimum_version_id
= 1,
655 .fields
= (VMStateField
[]) {
656 VMSTATE_USB_DEVICE(dev
, USBHubState
),
657 VMSTATE_STRUCT_ARRAY(ports
, USBHubState
, MAX_PORTS
, 0,
658 vmstate_usb_hub_port
, USBHubPort
),
659 VMSTATE_END_OF_LIST()
661 .subsections
= (const VMStateDescription
* []) {
662 &vmstate_usb_hub_port_timer
,
667 static Property usb_hub_properties
[] = {
668 DEFINE_PROP_UINT32("ports", USBHubState
, num_ports
, 8),
669 DEFINE_PROP_BOOL("port-power", USBHubState
, port_power
, false),
670 DEFINE_PROP_END_OF_LIST(),
673 static void usb_hub_class_initfn(ObjectClass
*klass
, void *data
)
675 DeviceClass
*dc
= DEVICE_CLASS(klass
);
676 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
678 uc
->realize
= usb_hub_realize
;
679 uc
->product_desc
= "QEMU USB Hub";
680 uc
->usb_desc
= &desc_hub
;
681 uc
->find_device
= usb_hub_find_device
;
682 uc
->handle_reset
= usb_hub_handle_reset
;
683 uc
->handle_control
= usb_hub_handle_control
;
684 uc
->handle_data
= usb_hub_handle_data
;
685 uc
->unrealize
= usb_hub_unrealize
;
686 set_bit(DEVICE_CATEGORY_BRIDGE
, dc
->categories
);
688 dc
->vmsd
= &vmstate_usb_hub
;
689 device_class_set_props(dc
, usb_hub_properties
);
692 static const TypeInfo hub_info
= {
693 .name
= TYPE_USB_HUB
,
694 .parent
= TYPE_USB_DEVICE
,
695 .instance_size
= sizeof(USBHubState
),
696 .class_init
= usb_hub_class_initfn
,
699 static void usb_hub_register_types(void)
701 type_register_static(&hub_info
);
704 type_init(usb_hub_register_types
)