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
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
28 #include "hw/usb/desc.h"
29 #include "qemu/error-report.h"
33 typedef struct USBHubPort
{
39 typedef struct USBHubState
{
42 USBHubPort ports
[NUM_PORTS
];
45 #define TYPE_USB_HUB "usb-hub"
46 #define USB_HUB(obj) OBJECT_CHECK(USBHubState, (obj), TYPE_USB_HUB)
48 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
49 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
50 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
51 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
52 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
53 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
54 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
56 #define PORT_STAT_CONNECTION 0x0001
57 #define PORT_STAT_ENABLE 0x0002
58 #define PORT_STAT_SUSPEND 0x0004
59 #define PORT_STAT_OVERCURRENT 0x0008
60 #define PORT_STAT_RESET 0x0010
61 #define PORT_STAT_POWER 0x0100
62 #define PORT_STAT_LOW_SPEED 0x0200
63 #define PORT_STAT_HIGH_SPEED 0x0400
64 #define PORT_STAT_TEST 0x0800
65 #define PORT_STAT_INDICATOR 0x1000
67 #define PORT_STAT_C_CONNECTION 0x0001
68 #define PORT_STAT_C_ENABLE 0x0002
69 #define PORT_STAT_C_SUSPEND 0x0004
70 #define PORT_STAT_C_OVERCURRENT 0x0008
71 #define PORT_STAT_C_RESET 0x0010
73 #define PORT_CONNECTION 0
75 #define PORT_SUSPEND 2
76 #define PORT_OVERCURRENT 3
79 #define PORT_LOWSPEED 9
80 #define PORT_HIGHSPEED 10
81 #define PORT_C_CONNECTION 16
82 #define PORT_C_ENABLE 17
83 #define PORT_C_SUSPEND 18
84 #define PORT_C_OVERCURRENT 19
85 #define PORT_C_RESET 20
87 #define PORT_INDICATOR 22
89 /* same as Linux kernel root hubs */
97 static const USBDescStrings desc_strings
= {
98 [STR_MANUFACTURER
] = "QEMU",
99 [STR_PRODUCT
] = "QEMU USB Hub",
100 [STR_SERIALNUMBER
] = "314159",
103 static const USBDescIface desc_iface_hub
= {
104 .bInterfaceNumber
= 0,
106 .bInterfaceClass
= USB_CLASS_HUB
,
107 .eps
= (USBDescEndpoint
[]) {
109 .bEndpointAddress
= USB_DIR_IN
| 0x01,
110 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
111 .wMaxPacketSize
= 1 + (NUM_PORTS
+ 7) / 8,
117 static const USBDescDevice desc_device_hub
= {
119 .bDeviceClass
= USB_CLASS_HUB
,
120 .bMaxPacketSize0
= 8,
121 .bNumConfigurations
= 1,
122 .confs
= (USBDescConfig
[]) {
125 .bConfigurationValue
= 1,
126 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_SELFPOWER
|
129 .ifs
= &desc_iface_hub
,
134 static const USBDesc desc_hub
= {
139 .iManufacturer
= STR_MANUFACTURER
,
140 .iProduct
= STR_PRODUCT
,
141 .iSerialNumber
= STR_SERIALNUMBER
,
143 .full
= &desc_device_hub
,
147 static const uint8_t qemu_hub_hub_descriptor
[] =
149 0x00, /* u8 bLength; patched in later */
150 0x29, /* u8 bDescriptorType; Hub-descriptor */
151 0x00, /* u8 bNbrPorts; (patched later) */
152 0x0a, /* u16 wHubCharacteristics; */
153 0x00, /* (per-port OC, no power switching) */
154 0x01, /* u8 bPwrOn2pwrGood; 2ms */
155 0x00 /* u8 bHubContrCurrent; 0 mA */
157 /* DeviceRemovable and PortPwrCtrlMask patched in later */
160 static void usb_hub_attach(USBPort
*port1
)
162 USBHubState
*s
= port1
->opaque
;
163 USBHubPort
*port
= &s
->ports
[port1
->index
];
165 trace_usb_hub_attach(s
->dev
.addr
, port1
->index
+ 1);
166 port
->wPortStatus
|= PORT_STAT_CONNECTION
;
167 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
168 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
169 port
->wPortStatus
|= PORT_STAT_LOW_SPEED
;
171 port
->wPortStatus
&= ~PORT_STAT_LOW_SPEED
;
173 usb_wakeup(s
->intr
, 0);
176 static void usb_hub_detach(USBPort
*port1
)
178 USBHubState
*s
= port1
->opaque
;
179 USBHubPort
*port
= &s
->ports
[port1
->index
];
181 trace_usb_hub_detach(s
->dev
.addr
, port1
->index
+ 1);
182 usb_wakeup(s
->intr
, 0);
184 /* Let upstream know the device on this port is gone */
185 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, port1
->dev
);
187 port
->wPortStatus
&= ~PORT_STAT_CONNECTION
;
188 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
189 if (port
->wPortStatus
& PORT_STAT_ENABLE
) {
190 port
->wPortStatus
&= ~PORT_STAT_ENABLE
;
191 port
->wPortChange
|= PORT_STAT_C_ENABLE
;
193 usb_wakeup(s
->intr
, 0);
196 static void usb_hub_child_detach(USBPort
*port1
, USBDevice
*child
)
198 USBHubState
*s
= port1
->opaque
;
200 /* Pass along upstream */
201 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, child
);
204 static void usb_hub_wakeup(USBPort
*port1
)
206 USBHubState
*s
= port1
->opaque
;
207 USBHubPort
*port
= &s
->ports
[port1
->index
];
209 if (port
->wPortStatus
& PORT_STAT_SUSPEND
) {
210 port
->wPortChange
|= PORT_STAT_C_SUSPEND
;
211 usb_wakeup(s
->intr
, 0);
215 static void usb_hub_complete(USBPort
*port
, USBPacket
*packet
)
217 USBHubState
*s
= port
->opaque
;
220 * Just pass it along upstream for now.
222 * If we ever implement usb 2.0 split transactions this will
223 * become a little more complicated ...
225 * Can't use usb_packet_complete() here because packet->owner is
226 * cleared already, go call the ->complete() callback directly
229 s
->dev
.port
->ops
->complete(s
->dev
.port
, packet
);
232 static USBDevice
*usb_hub_find_device(USBDevice
*dev
, uint8_t addr
)
234 USBHubState
*s
= USB_HUB(dev
);
236 USBDevice
*downstream
;
239 for (i
= 0; i
< NUM_PORTS
; i
++) {
241 if (!(port
->wPortStatus
& PORT_STAT_ENABLE
)) {
244 downstream
= usb_find_device(&port
->port
, addr
);
245 if (downstream
!= NULL
) {
252 static void usb_hub_handle_reset(USBDevice
*dev
)
254 USBHubState
*s
= USB_HUB(dev
);
258 trace_usb_hub_reset(s
->dev
.addr
);
259 for (i
= 0; i
< NUM_PORTS
; i
++) {
261 port
->wPortStatus
= PORT_STAT_POWER
;
262 port
->wPortChange
= 0;
263 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
264 port
->wPortStatus
|= PORT_STAT_CONNECTION
;
265 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
266 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
267 port
->wPortStatus
|= PORT_STAT_LOW_SPEED
;
273 static const char *feature_name(int feature
)
275 static const char *name
[] = {
276 [PORT_CONNECTION
] = "connection",
277 [PORT_ENABLE
] = "enable",
278 [PORT_SUSPEND
] = "suspend",
279 [PORT_OVERCURRENT
] = "overcurrent",
280 [PORT_RESET
] = "reset",
281 [PORT_POWER
] = "power",
282 [PORT_LOWSPEED
] = "lowspeed",
283 [PORT_HIGHSPEED
] = "highspeed",
284 [PORT_C_CONNECTION
] = "change connection",
285 [PORT_C_ENABLE
] = "change enable",
286 [PORT_C_SUSPEND
] = "change suspend",
287 [PORT_C_OVERCURRENT
] = "change overcurrent",
288 [PORT_C_RESET
] = "change reset",
289 [PORT_TEST
] = "test",
290 [PORT_INDICATOR
] = "indicator",
292 if (feature
< 0 || feature
>= ARRAY_SIZE(name
)) {
295 return name
[feature
] ?: "?";
298 static void usb_hub_handle_control(USBDevice
*dev
, USBPacket
*p
,
299 int request
, int value
, int index
, int length
, uint8_t *data
)
301 USBHubState
*s
= (USBHubState
*)dev
;
304 trace_usb_hub_control(s
->dev
.addr
, request
, value
, index
, length
);
306 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
312 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
313 if (value
== 0 && index
!= 0x81) { /* clear ep halt */
317 /* usb specific requests */
323 p
->actual_length
= 4;
327 unsigned int n
= index
- 1;
329 if (n
>= NUM_PORTS
) {
333 trace_usb_hub_get_port_status(s
->dev
.addr
, index
,
336 data
[0] = port
->wPortStatus
;
337 data
[1] = port
->wPortStatus
>> 8;
338 data
[2] = port
->wPortChange
;
339 data
[3] = port
->wPortChange
>> 8;
340 p
->actual_length
= 4;
344 case ClearHubFeature
:
345 if (value
!= 0 && value
!= 1) {
351 unsigned int n
= index
- 1;
355 trace_usb_hub_set_port_feature(s
->dev
.addr
, index
,
356 feature_name(value
));
358 if (n
>= NUM_PORTS
) {
362 dev
= port
->port
.dev
;
365 port
->wPortStatus
|= PORT_STAT_SUSPEND
;
368 if (dev
&& dev
->attached
) {
369 usb_device_reset(dev
);
370 port
->wPortChange
|= PORT_STAT_C_RESET
;
372 port
->wPortStatus
|= PORT_STAT_ENABLE
;
373 usb_wakeup(s
->intr
, 0);
383 case ClearPortFeature
:
385 unsigned int n
= index
- 1;
388 trace_usb_hub_clear_port_feature(s
->dev
.addr
, index
,
389 feature_name(value
));
391 if (n
>= NUM_PORTS
) {
397 port
->wPortStatus
&= ~PORT_STAT_ENABLE
;
400 port
->wPortChange
&= ~PORT_STAT_C_ENABLE
;
403 port
->wPortStatus
&= ~PORT_STAT_SUSPEND
;
406 port
->wPortChange
&= ~PORT_STAT_C_SUSPEND
;
408 case PORT_C_CONNECTION
:
409 port
->wPortChange
&= ~PORT_STAT_C_CONNECTION
;
411 case PORT_C_OVERCURRENT
:
412 port
->wPortChange
&= ~PORT_STAT_C_OVERCURRENT
;
415 port
->wPortChange
&= ~PORT_STAT_C_RESET
;
422 case GetHubDescriptor
:
424 unsigned int n
, limit
, var_hub_size
= 0;
425 memcpy(data
, qemu_hub_hub_descriptor
,
426 sizeof(qemu_hub_hub_descriptor
));
429 /* fill DeviceRemovable bits */
430 limit
= ((NUM_PORTS
+ 1 + 7) / 8) + 7;
431 for (n
= 7; n
< limit
; n
++) {
436 /* fill PortPwrCtrlMask bits */
437 limit
= limit
+ ((NUM_PORTS
+ 7) / 8);
438 for (;n
< limit
; n
++) {
443 p
->actual_length
= sizeof(qemu_hub_hub_descriptor
) + var_hub_size
;
444 data
[0] = p
->actual_length
;
449 p
->status
= USB_RET_STALL
;
454 static void usb_hub_handle_data(USBDevice
*dev
, USBPacket
*p
)
456 USBHubState
*s
= (USBHubState
*)dev
;
460 if (p
->ep
->nr
== 1) {
465 n
= (NUM_PORTS
+ 1 + 7) / 8;
466 if (p
->iov
.size
== 1) { /* FreeBSD workaround */
468 } else if (n
> p
->iov
.size
) {
469 p
->status
= USB_RET_BABBLE
;
473 for(i
= 0; i
< NUM_PORTS
; i
++) {
475 if (port
->wPortChange
)
476 status
|= (1 << (i
+ 1));
479 trace_usb_hub_status_report(s
->dev
.addr
, status
);
480 for(i
= 0; i
< n
; i
++) {
481 buf
[i
] = status
>> (8 * i
);
483 usb_packet_copy(p
, buf
, n
);
485 p
->status
= USB_RET_NAK
; /* usb11 11.13.1 */
494 p
->status
= USB_RET_STALL
;
499 static void usb_hub_handle_destroy(USBDevice
*dev
)
501 USBHubState
*s
= (USBHubState
*)dev
;
504 for (i
= 0; i
< NUM_PORTS
; i
++) {
505 usb_unregister_port(usb_bus_from_device(dev
),
510 static USBPortOps usb_hub_port_ops
= {
511 .attach
= usb_hub_attach
,
512 .detach
= usb_hub_detach
,
513 .child_detach
= usb_hub_child_detach
,
514 .wakeup
= usb_hub_wakeup
,
515 .complete
= usb_hub_complete
,
518 static void usb_hub_realize(USBDevice
*dev
, Error
**errp
)
520 USBHubState
*s
= USB_HUB(dev
);
524 if (dev
->port
->hubcount
== 5) {
525 error_setg(errp
, "usb hub chain too deep");
529 usb_desc_create_serial(dev
);
531 s
->intr
= usb_ep_get(dev
, USB_TOKEN_IN
, 1);
532 for (i
= 0; i
< NUM_PORTS
; i
++) {
534 usb_register_port(usb_bus_from_device(dev
),
535 &port
->port
, s
, i
, &usb_hub_port_ops
,
536 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
537 usb_port_location(&port
->port
, dev
->port
, i
+1);
539 usb_hub_handle_reset(dev
);
542 static const VMStateDescription vmstate_usb_hub_port
= {
543 .name
= "usb-hub-port",
545 .minimum_version_id
= 1,
546 .fields
= (VMStateField
[]) {
547 VMSTATE_UINT16(wPortStatus
, USBHubPort
),
548 VMSTATE_UINT16(wPortChange
, USBHubPort
),
549 VMSTATE_END_OF_LIST()
553 static const VMStateDescription vmstate_usb_hub
= {
556 .minimum_version_id
= 1,
557 .fields
= (VMStateField
[]) {
558 VMSTATE_USB_DEVICE(dev
, USBHubState
),
559 VMSTATE_STRUCT_ARRAY(ports
, USBHubState
, NUM_PORTS
, 0,
560 vmstate_usb_hub_port
, USBHubPort
),
561 VMSTATE_END_OF_LIST()
565 static void usb_hub_class_initfn(ObjectClass
*klass
, void *data
)
567 DeviceClass
*dc
= DEVICE_CLASS(klass
);
568 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
570 uc
->realize
= usb_hub_realize
;
571 uc
->product_desc
= "QEMU USB Hub";
572 uc
->usb_desc
= &desc_hub
;
573 uc
->find_device
= usb_hub_find_device
;
574 uc
->handle_reset
= usb_hub_handle_reset
;
575 uc
->handle_control
= usb_hub_handle_control
;
576 uc
->handle_data
= usb_hub_handle_data
;
577 uc
->handle_destroy
= usb_hub_handle_destroy
;
578 set_bit(DEVICE_CATEGORY_BRIDGE
, dc
->categories
);
580 dc
->vmsd
= &vmstate_usb_hub
;
583 static const TypeInfo hub_info
= {
584 .name
= TYPE_USB_HUB
,
585 .parent
= TYPE_USB_DEVICE
,
586 .instance_size
= sizeof(USBHubState
),
587 .class_init
= usb_hub_class_initfn
,
590 static void usb_hub_register_types(void)
592 type_register_static(&hub_info
);
595 type_init(usb_hub_register_types
)