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-common.h"
27 #include "hw/usb/desc.h"
28 #include "qemu/error-report.h"
32 typedef struct USBHubPort
{
38 typedef struct USBHubState
{
41 USBHubPort ports
[NUM_PORTS
];
44 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
45 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
46 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
47 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
48 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
49 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
50 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
52 #define PORT_STAT_CONNECTION 0x0001
53 #define PORT_STAT_ENABLE 0x0002
54 #define PORT_STAT_SUSPEND 0x0004
55 #define PORT_STAT_OVERCURRENT 0x0008
56 #define PORT_STAT_RESET 0x0010
57 #define PORT_STAT_POWER 0x0100
58 #define PORT_STAT_LOW_SPEED 0x0200
59 #define PORT_STAT_HIGH_SPEED 0x0400
60 #define PORT_STAT_TEST 0x0800
61 #define PORT_STAT_INDICATOR 0x1000
63 #define PORT_STAT_C_CONNECTION 0x0001
64 #define PORT_STAT_C_ENABLE 0x0002
65 #define PORT_STAT_C_SUSPEND 0x0004
66 #define PORT_STAT_C_OVERCURRENT 0x0008
67 #define PORT_STAT_C_RESET 0x0010
69 #define PORT_CONNECTION 0
71 #define PORT_SUSPEND 2
72 #define PORT_OVERCURRENT 3
75 #define PORT_LOWSPEED 9
76 #define PORT_HIGHSPEED 10
77 #define PORT_C_CONNECTION 16
78 #define PORT_C_ENABLE 17
79 #define PORT_C_SUSPEND 18
80 #define PORT_C_OVERCURRENT 19
81 #define PORT_C_RESET 20
83 #define PORT_INDICATOR 22
85 /* same as Linux kernel root hubs */
93 static const USBDescStrings desc_strings
= {
94 [STR_MANUFACTURER
] = "QEMU",
95 [STR_PRODUCT
] = "QEMU USB Hub",
96 [STR_SERIALNUMBER
] = "314159",
99 static const USBDescIface desc_iface_hub
= {
100 .bInterfaceNumber
= 0,
102 .bInterfaceClass
= USB_CLASS_HUB
,
103 .eps
= (USBDescEndpoint
[]) {
105 .bEndpointAddress
= USB_DIR_IN
| 0x01,
106 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
107 .wMaxPacketSize
= 1 + (NUM_PORTS
+ 7) / 8,
113 static const USBDescDevice desc_device_hub
= {
115 .bDeviceClass
= USB_CLASS_HUB
,
116 .bMaxPacketSize0
= 8,
117 .bNumConfigurations
= 1,
118 .confs
= (USBDescConfig
[]) {
121 .bConfigurationValue
= 1,
122 .bmAttributes
= 0xe0,
124 .ifs
= &desc_iface_hub
,
129 static const USBDesc desc_hub
= {
134 .iManufacturer
= STR_MANUFACTURER
,
135 .iProduct
= STR_PRODUCT
,
136 .iSerialNumber
= STR_SERIALNUMBER
,
138 .full
= &desc_device_hub
,
142 static const uint8_t qemu_hub_hub_descriptor
[] =
144 0x00, /* u8 bLength; patched in later */
145 0x29, /* u8 bDescriptorType; Hub-descriptor */
146 0x00, /* u8 bNbrPorts; (patched later) */
147 0x0a, /* u16 wHubCharacteristics; */
148 0x00, /* (per-port OC, no power switching) */
149 0x01, /* u8 bPwrOn2pwrGood; 2ms */
150 0x00 /* u8 bHubContrCurrent; 0 mA */
152 /* DeviceRemovable and PortPwrCtrlMask patched in later */
155 static void usb_hub_attach(USBPort
*port1
)
157 USBHubState
*s
= port1
->opaque
;
158 USBHubPort
*port
= &s
->ports
[port1
->index
];
160 trace_usb_hub_attach(s
->dev
.addr
, port1
->index
+ 1);
161 port
->wPortStatus
|= PORT_STAT_CONNECTION
;
162 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
163 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
164 port
->wPortStatus
|= PORT_STAT_LOW_SPEED
;
166 port
->wPortStatus
&= ~PORT_STAT_LOW_SPEED
;
168 usb_wakeup(s
->intr
, 0);
171 static void usb_hub_detach(USBPort
*port1
)
173 USBHubState
*s
= port1
->opaque
;
174 USBHubPort
*port
= &s
->ports
[port1
->index
];
176 trace_usb_hub_detach(s
->dev
.addr
, port1
->index
+ 1);
177 usb_wakeup(s
->intr
, 0);
179 /* Let upstream know the device on this port is gone */
180 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, port1
->dev
);
182 port
->wPortStatus
&= ~PORT_STAT_CONNECTION
;
183 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
184 if (port
->wPortStatus
& PORT_STAT_ENABLE
) {
185 port
->wPortStatus
&= ~PORT_STAT_ENABLE
;
186 port
->wPortChange
|= PORT_STAT_C_ENABLE
;
188 usb_wakeup(s
->intr
, 0);
191 static void usb_hub_child_detach(USBPort
*port1
, USBDevice
*child
)
193 USBHubState
*s
= port1
->opaque
;
195 /* Pass along upstream */
196 s
->dev
.port
->ops
->child_detach(s
->dev
.port
, child
);
199 static void usb_hub_wakeup(USBPort
*port1
)
201 USBHubState
*s
= port1
->opaque
;
202 USBHubPort
*port
= &s
->ports
[port1
->index
];
204 if (port
->wPortStatus
& PORT_STAT_SUSPEND
) {
205 port
->wPortChange
|= PORT_STAT_C_SUSPEND
;
206 usb_wakeup(s
->intr
, 0);
210 static void usb_hub_complete(USBPort
*port
, USBPacket
*packet
)
212 USBHubState
*s
= port
->opaque
;
215 * Just pass it along upstream for now.
217 * If we ever implement usb 2.0 split transactions this will
218 * become a little more complicated ...
220 * Can't use usb_packet_complete() here because packet->owner is
221 * cleared already, go call the ->complete() callback directly
224 s
->dev
.port
->ops
->complete(s
->dev
.port
, packet
);
227 static USBDevice
*usb_hub_find_device(USBDevice
*dev
, uint8_t addr
)
229 USBHubState
*s
= DO_UPCAST(USBHubState
, dev
, dev
);
231 USBDevice
*downstream
;
234 for (i
= 0; i
< NUM_PORTS
; i
++) {
236 if (!(port
->wPortStatus
& PORT_STAT_ENABLE
)) {
239 downstream
= usb_find_device(&port
->port
, addr
);
240 if (downstream
!= NULL
) {
247 static void usb_hub_handle_reset(USBDevice
*dev
)
249 USBHubState
*s
= DO_UPCAST(USBHubState
, dev
, dev
);
253 trace_usb_hub_reset(s
->dev
.addr
);
254 for (i
= 0; i
< NUM_PORTS
; i
++) {
256 port
->wPortStatus
= PORT_STAT_POWER
;
257 port
->wPortChange
= 0;
258 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
259 port
->wPortStatus
|= PORT_STAT_CONNECTION
;
260 port
->wPortChange
|= PORT_STAT_C_CONNECTION
;
261 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
262 port
->wPortStatus
|= PORT_STAT_LOW_SPEED
;
268 static const char *feature_name(int feature
)
270 static const char *name
[] = {
271 [PORT_CONNECTION
] = "connection",
272 [PORT_ENABLE
] = "enable",
273 [PORT_SUSPEND
] = "suspend",
274 [PORT_OVERCURRENT
] = "overcurrent",
275 [PORT_RESET
] = "reset",
276 [PORT_POWER
] = "power",
277 [PORT_LOWSPEED
] = "lowspeed",
278 [PORT_HIGHSPEED
] = "highspeed",
279 [PORT_C_CONNECTION
] = "change connection",
280 [PORT_C_ENABLE
] = "change enable",
281 [PORT_C_SUSPEND
] = "change suspend",
282 [PORT_C_OVERCURRENT
] = "change overcurrent",
283 [PORT_C_RESET
] = "change reset",
284 [PORT_TEST
] = "test",
285 [PORT_INDICATOR
] = "indicator",
287 if (feature
< 0 || feature
>= ARRAY_SIZE(name
)) {
290 return name
[feature
] ?: "?";
293 static void usb_hub_handle_control(USBDevice
*dev
, USBPacket
*p
,
294 int request
, int value
, int index
, int length
, uint8_t *data
)
296 USBHubState
*s
= (USBHubState
*)dev
;
299 trace_usb_hub_control(s
->dev
.addr
, request
, value
, index
, length
);
301 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
307 case EndpointOutRequest
| USB_REQ_CLEAR_FEATURE
:
308 if (value
== 0 && index
!= 0x81) { /* clear ep halt */
312 /* usb specific requests */
318 p
->actual_length
= 4;
322 unsigned int n
= index
- 1;
324 if (n
>= NUM_PORTS
) {
328 trace_usb_hub_get_port_status(s
->dev
.addr
, index
,
331 data
[0] = port
->wPortStatus
;
332 data
[1] = port
->wPortStatus
>> 8;
333 data
[2] = port
->wPortChange
;
334 data
[3] = port
->wPortChange
>> 8;
335 p
->actual_length
= 4;
339 case ClearHubFeature
:
340 if (value
!= 0 && value
!= 1) {
346 unsigned int n
= index
- 1;
350 trace_usb_hub_set_port_feature(s
->dev
.addr
, index
,
351 feature_name(value
));
353 if (n
>= NUM_PORTS
) {
357 dev
= port
->port
.dev
;
360 port
->wPortStatus
|= PORT_STAT_SUSPEND
;
363 if (dev
&& dev
->attached
) {
364 usb_device_reset(dev
);
365 port
->wPortChange
|= PORT_STAT_C_RESET
;
367 port
->wPortStatus
|= PORT_STAT_ENABLE
;
368 usb_wakeup(s
->intr
, 0);
378 case ClearPortFeature
:
380 unsigned int n
= index
- 1;
383 trace_usb_hub_clear_port_feature(s
->dev
.addr
, index
,
384 feature_name(value
));
386 if (n
>= NUM_PORTS
) {
392 port
->wPortStatus
&= ~PORT_STAT_ENABLE
;
395 port
->wPortChange
&= ~PORT_STAT_C_ENABLE
;
398 port
->wPortStatus
&= ~PORT_STAT_SUSPEND
;
401 port
->wPortChange
&= ~PORT_STAT_C_SUSPEND
;
403 case PORT_C_CONNECTION
:
404 port
->wPortChange
&= ~PORT_STAT_C_CONNECTION
;
406 case PORT_C_OVERCURRENT
:
407 port
->wPortChange
&= ~PORT_STAT_C_OVERCURRENT
;
410 port
->wPortChange
&= ~PORT_STAT_C_RESET
;
417 case GetHubDescriptor
:
419 unsigned int n
, limit
, var_hub_size
= 0;
420 memcpy(data
, qemu_hub_hub_descriptor
,
421 sizeof(qemu_hub_hub_descriptor
));
424 /* fill DeviceRemovable bits */
425 limit
= ((NUM_PORTS
+ 1 + 7) / 8) + 7;
426 for (n
= 7; n
< limit
; n
++) {
431 /* fill PortPwrCtrlMask bits */
432 limit
= limit
+ ((NUM_PORTS
+ 7) / 8);
433 for (;n
< limit
; n
++) {
438 p
->actual_length
= sizeof(qemu_hub_hub_descriptor
) + var_hub_size
;
439 data
[0] = p
->actual_length
;
444 p
->status
= USB_RET_STALL
;
449 static void usb_hub_handle_data(USBDevice
*dev
, USBPacket
*p
)
451 USBHubState
*s
= (USBHubState
*)dev
;
455 if (p
->ep
->nr
== 1) {
460 n
= (NUM_PORTS
+ 1 + 7) / 8;
461 if (p
->iov
.size
== 1) { /* FreeBSD workaround */
463 } else if (n
> p
->iov
.size
) {
464 p
->status
= USB_RET_BABBLE
;
468 for(i
= 0; i
< NUM_PORTS
; i
++) {
470 if (port
->wPortChange
)
471 status
|= (1 << (i
+ 1));
474 trace_usb_hub_status_report(s
->dev
.addr
, status
);
475 for(i
= 0; i
< n
; i
++) {
476 buf
[i
] = status
>> (8 * i
);
478 usb_packet_copy(p
, buf
, n
);
480 p
->status
= USB_RET_NAK
; /* usb11 11.13.1 */
489 p
->status
= USB_RET_STALL
;
494 static void usb_hub_handle_destroy(USBDevice
*dev
)
496 USBHubState
*s
= (USBHubState
*)dev
;
499 for (i
= 0; i
< NUM_PORTS
; i
++) {
500 usb_unregister_port(usb_bus_from_device(dev
),
505 static USBPortOps usb_hub_port_ops
= {
506 .attach
= usb_hub_attach
,
507 .detach
= usb_hub_detach
,
508 .child_detach
= usb_hub_child_detach
,
509 .wakeup
= usb_hub_wakeup
,
510 .complete
= usb_hub_complete
,
513 static int usb_hub_initfn(USBDevice
*dev
)
515 USBHubState
*s
= DO_UPCAST(USBHubState
, dev
, dev
);
519 if (dev
->port
->hubcount
== 5) {
520 error_report("usb hub chain too deep");
524 usb_desc_create_serial(dev
);
526 s
->intr
= usb_ep_get(dev
, USB_TOKEN_IN
, 1);
527 for (i
= 0; i
< NUM_PORTS
; i
++) {
529 usb_register_port(usb_bus_from_device(dev
),
530 &port
->port
, s
, i
, &usb_hub_port_ops
,
531 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
532 usb_port_location(&port
->port
, dev
->port
, i
+1);
534 usb_hub_handle_reset(dev
);
538 static const VMStateDescription vmstate_usb_hub_port
= {
539 .name
= "usb-hub-port",
541 .minimum_version_id
= 1,
542 .fields
= (VMStateField
[]) {
543 VMSTATE_UINT16(wPortStatus
, USBHubPort
),
544 VMSTATE_UINT16(wPortChange
, USBHubPort
),
545 VMSTATE_END_OF_LIST()
549 static const VMStateDescription vmstate_usb_hub
= {
552 .minimum_version_id
= 1,
553 .fields
= (VMStateField
[]) {
554 VMSTATE_USB_DEVICE(dev
, USBHubState
),
555 VMSTATE_STRUCT_ARRAY(ports
, USBHubState
, NUM_PORTS
, 0,
556 vmstate_usb_hub_port
, USBHubPort
),
557 VMSTATE_END_OF_LIST()
561 static void usb_hub_class_initfn(ObjectClass
*klass
, void *data
)
563 DeviceClass
*dc
= DEVICE_CLASS(klass
);
564 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
566 uc
->init
= usb_hub_initfn
;
567 uc
->product_desc
= "QEMU USB Hub";
568 uc
->usb_desc
= &desc_hub
;
569 uc
->find_device
= usb_hub_find_device
;
570 uc
->handle_reset
= usb_hub_handle_reset
;
571 uc
->handle_control
= usb_hub_handle_control
;
572 uc
->handle_data
= usb_hub_handle_data
;
573 uc
->handle_destroy
= usb_hub_handle_destroy
;
574 set_bit(DEVICE_CATEGORY_BRIDGE
, dc
->categories
);
576 dc
->vmsd
= &vmstate_usb_hub
;
579 static const TypeInfo hub_info
= {
581 .parent
= TYPE_USB_DEVICE
,
582 .instance_size
= sizeof(USBHubState
),
583 .class_init
= usb_hub_class_initfn
,
586 static void usb_hub_register_types(void)
588 type_register_static(&hub_info
);
591 type_init(usb_hub_register_types
)