root / hw / usb-hub.c @ db80358a
History | View | Annotate | Download (15.4 kB)
1 |
/*
|
---|---|
2 |
* QEMU USB HUB emulation
|
3 |
*
|
4 |
* Copyright (c) 2005 Fabrice Bellard
|
5 |
*
|
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:
|
12 |
*
|
13 |
* The above copyright notice and this permission notice shall be included in
|
14 |
* all copies or substantial portions of the Software.
|
15 |
*
|
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
|
22 |
* THE SOFTWARE.
|
23 |
*/
|
24 |
#include "qemu-common.h" |
25 |
#include "usb.h" |
26 |
#include "usb-desc.h" |
27 |
|
28 |
//#define DEBUG
|
29 |
|
30 |
#define NUM_PORTS 8 |
31 |
|
32 |
typedef struct USBHubPort { |
33 |
USBPort port; |
34 |
uint16_t wPortStatus; |
35 |
uint16_t wPortChange; |
36 |
} USBHubPort; |
37 |
|
38 |
typedef struct USBHubState { |
39 |
USBDevice dev; |
40 |
USBHubPort ports[NUM_PORTS]; |
41 |
} USBHubState; |
42 |
|
43 |
#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE) |
44 |
#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE) |
45 |
#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR) |
46 |
#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS) |
47 |
#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS) |
48 |
#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE) |
49 |
#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE) |
50 |
|
51 |
#define PORT_STAT_CONNECTION 0x0001 |
52 |
#define PORT_STAT_ENABLE 0x0002 |
53 |
#define PORT_STAT_SUSPEND 0x0004 |
54 |
#define PORT_STAT_OVERCURRENT 0x0008 |
55 |
#define PORT_STAT_RESET 0x0010 |
56 |
#define PORT_STAT_POWER 0x0100 |
57 |
#define PORT_STAT_LOW_SPEED 0x0200 |
58 |
#define PORT_STAT_HIGH_SPEED 0x0400 |
59 |
#define PORT_STAT_TEST 0x0800 |
60 |
#define PORT_STAT_INDICATOR 0x1000 |
61 |
|
62 |
#define PORT_STAT_C_CONNECTION 0x0001 |
63 |
#define PORT_STAT_C_ENABLE 0x0002 |
64 |
#define PORT_STAT_C_SUSPEND 0x0004 |
65 |
#define PORT_STAT_C_OVERCURRENT 0x0008 |
66 |
#define PORT_STAT_C_RESET 0x0010 |
67 |
|
68 |
#define PORT_CONNECTION 0 |
69 |
#define PORT_ENABLE 1 |
70 |
#define PORT_SUSPEND 2 |
71 |
#define PORT_OVERCURRENT 3 |
72 |
#define PORT_RESET 4 |
73 |
#define PORT_POWER 8 |
74 |
#define PORT_LOWSPEED 9 |
75 |
#define PORT_HIGHSPEED 10 |
76 |
#define PORT_C_CONNECTION 16 |
77 |
#define PORT_C_ENABLE 17 |
78 |
#define PORT_C_SUSPEND 18 |
79 |
#define PORT_C_OVERCURRENT 19 |
80 |
#define PORT_C_RESET 20 |
81 |
#define PORT_TEST 21 |
82 |
#define PORT_INDICATOR 22 |
83 |
|
84 |
/* same as Linux kernel root hubs */
|
85 |
|
86 |
enum {
|
87 |
STR_MANUFACTURER = 1,
|
88 |
STR_PRODUCT, |
89 |
STR_SERIALNUMBER, |
90 |
}; |
91 |
|
92 |
static const USBDescStrings desc_strings = { |
93 |
[STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
|
94 |
[STR_PRODUCT] = "QEMU USB Hub",
|
95 |
[STR_SERIALNUMBER] = "314159",
|
96 |
}; |
97 |
|
98 |
static const USBDescIface desc_iface_hub = { |
99 |
.bInterfaceNumber = 0,
|
100 |
.bNumEndpoints = 1,
|
101 |
.bInterfaceClass = USB_CLASS_HUB, |
102 |
.eps = (USBDescEndpoint[]) { |
103 |
{ |
104 |
.bEndpointAddress = USB_DIR_IN | 0x01,
|
105 |
.bmAttributes = USB_ENDPOINT_XFER_INT, |
106 |
.wMaxPacketSize = 1 + (NUM_PORTS + 7) / 8, |
107 |
.bInterval = 0xff,
|
108 |
}, |
109 |
} |
110 |
}; |
111 |
|
112 |
static const USBDescDevice desc_device_hub = { |
113 |
.bcdUSB = 0x0110,
|
114 |
.bDeviceClass = USB_CLASS_HUB, |
115 |
.bMaxPacketSize0 = 8,
|
116 |
.bNumConfigurations = 1,
|
117 |
.confs = (USBDescConfig[]) { |
118 |
{ |
119 |
.bNumInterfaces = 1,
|
120 |
.bConfigurationValue = 1,
|
121 |
.bmAttributes = 0xe0,
|
122 |
.nif = 1,
|
123 |
.ifs = &desc_iface_hub, |
124 |
}, |
125 |
}, |
126 |
}; |
127 |
|
128 |
static const USBDesc desc_hub = { |
129 |
.id = { |
130 |
.idVendor = 0x0409,
|
131 |
.idProduct = 0x55aa,
|
132 |
.bcdDevice = 0x0101,
|
133 |
.iManufacturer = STR_MANUFACTURER, |
134 |
.iProduct = STR_PRODUCT, |
135 |
.iSerialNumber = STR_SERIALNUMBER, |
136 |
}, |
137 |
.full = &desc_device_hub, |
138 |
.str = desc_strings, |
139 |
}; |
140 |
|
141 |
static const uint8_t qemu_hub_hub_descriptor[] = |
142 |
{ |
143 |
0x00, /* u8 bLength; patched in later */ |
144 |
0x29, /* u8 bDescriptorType; Hub-descriptor */ |
145 |
0x00, /* u8 bNbrPorts; (patched later) */ |
146 |
0x0a, /* u16 wHubCharacteristics; */ |
147 |
0x00, /* (per-port OC, no power switching) */ |
148 |
0x01, /* u8 bPwrOn2pwrGood; 2ms */ |
149 |
0x00 /* u8 bHubContrCurrent; 0 mA */ |
150 |
|
151 |
/* DeviceRemovable and PortPwrCtrlMask patched in later */
|
152 |
}; |
153 |
|
154 |
static void usb_hub_attach(USBPort *port1) |
155 |
{ |
156 |
USBHubState *s = port1->opaque; |
157 |
USBHubPort *port = &s->ports[port1->index]; |
158 |
|
159 |
port->wPortStatus |= PORT_STAT_CONNECTION; |
160 |
port->wPortChange |= PORT_STAT_C_CONNECTION; |
161 |
if (port->port.dev->speed == USB_SPEED_LOW) {
|
162 |
port->wPortStatus |= PORT_STAT_LOW_SPEED; |
163 |
} else {
|
164 |
port->wPortStatus &= ~PORT_STAT_LOW_SPEED; |
165 |
} |
166 |
usb_wakeup(&s->dev); |
167 |
} |
168 |
|
169 |
static void usb_hub_detach(USBPort *port1) |
170 |
{ |
171 |
USBHubState *s = port1->opaque; |
172 |
USBHubPort *port = &s->ports[port1->index]; |
173 |
|
174 |
/* Let upstream know the device on this port is gone */
|
175 |
s->dev.port->ops->child_detach(s->dev.port, port1->dev); |
176 |
|
177 |
port->wPortStatus &= ~PORT_STAT_CONNECTION; |
178 |
port->wPortChange |= PORT_STAT_C_CONNECTION; |
179 |
if (port->wPortStatus & PORT_STAT_ENABLE) {
|
180 |
port->wPortStatus &= ~PORT_STAT_ENABLE; |
181 |
port->wPortChange |= PORT_STAT_C_ENABLE; |
182 |
} |
183 |
} |
184 |
|
185 |
static void usb_hub_child_detach(USBPort *port1, USBDevice *child) |
186 |
{ |
187 |
USBHubState *s = port1->opaque; |
188 |
|
189 |
/* Pass along upstream */
|
190 |
s->dev.port->ops->child_detach(s->dev.port, child); |
191 |
} |
192 |
|
193 |
static void usb_hub_wakeup(USBPort *port1) |
194 |
{ |
195 |
USBHubState *s = port1->opaque; |
196 |
USBHubPort *port = &s->ports[port1->index]; |
197 |
|
198 |
if (port->wPortStatus & PORT_STAT_SUSPEND) {
|
199 |
port->wPortChange |= PORT_STAT_C_SUSPEND; |
200 |
usb_wakeup(&s->dev); |
201 |
} |
202 |
} |
203 |
|
204 |
static void usb_hub_complete(USBPort *port, USBPacket *packet) |
205 |
{ |
206 |
USBHubState *s = port->opaque; |
207 |
|
208 |
/*
|
209 |
* Just pass it along upstream for now.
|
210 |
*
|
211 |
* If we ever implement usb 2.0 split transactions this will
|
212 |
* become a little more complicated ...
|
213 |
*
|
214 |
* Can't use usb_packet_complete() here because packet->owner is
|
215 |
* cleared already, go call the ->complete() callback directly
|
216 |
* instead.
|
217 |
*/
|
218 |
s->dev.port->ops->complete(s->dev.port, packet); |
219 |
} |
220 |
|
221 |
static void usb_hub_handle_reset(USBDevice *dev) |
222 |
{ |
223 |
/* XXX: do it */
|
224 |
} |
225 |
|
226 |
static int usb_hub_handle_control(USBDevice *dev, USBPacket *p, |
227 |
int request, int value, int index, int length, uint8_t *data) |
228 |
{ |
229 |
USBHubState *s = (USBHubState *)dev; |
230 |
int ret;
|
231 |
|
232 |
ret = usb_desc_handle_control(dev, p, request, value, index, length, data); |
233 |
if (ret >= 0) { |
234 |
return ret;
|
235 |
} |
236 |
|
237 |
switch(request) {
|
238 |
case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
|
239 |
if (value == 0 && index != 0x81) { /* clear ep halt */ |
240 |
goto fail;
|
241 |
} |
242 |
ret = 0;
|
243 |
break;
|
244 |
case DeviceRequest | USB_REQ_GET_INTERFACE:
|
245 |
data[0] = 0; |
246 |
ret = 1;
|
247 |
break;
|
248 |
case DeviceOutRequest | USB_REQ_SET_INTERFACE:
|
249 |
ret = 0;
|
250 |
break;
|
251 |
/* usb specific requests */
|
252 |
case GetHubStatus:
|
253 |
data[0] = 0; |
254 |
data[1] = 0; |
255 |
data[2] = 0; |
256 |
data[3] = 0; |
257 |
ret = 4;
|
258 |
break;
|
259 |
case GetPortStatus:
|
260 |
{ |
261 |
unsigned int n = index - 1; |
262 |
USBHubPort *port; |
263 |
if (n >= NUM_PORTS) {
|
264 |
goto fail;
|
265 |
} |
266 |
port = &s->ports[n]; |
267 |
data[0] = port->wPortStatus;
|
268 |
data[1] = port->wPortStatus >> 8; |
269 |
data[2] = port->wPortChange;
|
270 |
data[3] = port->wPortChange >> 8; |
271 |
ret = 4;
|
272 |
} |
273 |
break;
|
274 |
case SetHubFeature:
|
275 |
case ClearHubFeature:
|
276 |
if (value == 0 || value == 1) { |
277 |
} else {
|
278 |
goto fail;
|
279 |
} |
280 |
ret = 0;
|
281 |
break;
|
282 |
case SetPortFeature:
|
283 |
{ |
284 |
unsigned int n = index - 1; |
285 |
USBHubPort *port; |
286 |
USBDevice *dev; |
287 |
if (n >= NUM_PORTS) {
|
288 |
goto fail;
|
289 |
} |
290 |
port = &s->ports[n]; |
291 |
dev = port->port.dev; |
292 |
switch(value) {
|
293 |
case PORT_SUSPEND:
|
294 |
port->wPortStatus |= PORT_STAT_SUSPEND; |
295 |
break;
|
296 |
case PORT_RESET:
|
297 |
if (dev && dev->attached) {
|
298 |
usb_send_msg(dev, USB_MSG_RESET); |
299 |
port->wPortChange |= PORT_STAT_C_RESET; |
300 |
/* set enable bit */
|
301 |
port->wPortStatus |= PORT_STAT_ENABLE; |
302 |
} |
303 |
break;
|
304 |
case PORT_POWER:
|
305 |
break;
|
306 |
default:
|
307 |
goto fail;
|
308 |
} |
309 |
ret = 0;
|
310 |
} |
311 |
break;
|
312 |
case ClearPortFeature:
|
313 |
{ |
314 |
unsigned int n = index - 1; |
315 |
USBHubPort *port; |
316 |
|
317 |
if (n >= NUM_PORTS) {
|
318 |
goto fail;
|
319 |
} |
320 |
port = &s->ports[n]; |
321 |
switch(value) {
|
322 |
case PORT_ENABLE:
|
323 |
port->wPortStatus &= ~PORT_STAT_ENABLE; |
324 |
break;
|
325 |
case PORT_C_ENABLE:
|
326 |
port->wPortChange &= ~PORT_STAT_C_ENABLE; |
327 |
break;
|
328 |
case PORT_SUSPEND:
|
329 |
port->wPortStatus &= ~PORT_STAT_SUSPEND; |
330 |
break;
|
331 |
case PORT_C_SUSPEND:
|
332 |
port->wPortChange &= ~PORT_STAT_C_SUSPEND; |
333 |
break;
|
334 |
case PORT_C_CONNECTION:
|
335 |
port->wPortChange &= ~PORT_STAT_C_CONNECTION; |
336 |
break;
|
337 |
case PORT_C_OVERCURRENT:
|
338 |
port->wPortChange &= ~PORT_STAT_C_OVERCURRENT; |
339 |
break;
|
340 |
case PORT_C_RESET:
|
341 |
port->wPortChange &= ~PORT_STAT_C_RESET; |
342 |
break;
|
343 |
default:
|
344 |
goto fail;
|
345 |
} |
346 |
ret = 0;
|
347 |
} |
348 |
break;
|
349 |
case GetHubDescriptor:
|
350 |
{ |
351 |
unsigned int n, limit, var_hub_size = 0; |
352 |
memcpy(data, qemu_hub_hub_descriptor, |
353 |
sizeof(qemu_hub_hub_descriptor));
|
354 |
data[2] = NUM_PORTS;
|
355 |
|
356 |
/* fill DeviceRemovable bits */
|
357 |
limit = ((NUM_PORTS + 1 + 7) / 8) + 7; |
358 |
for (n = 7; n < limit; n++) { |
359 |
data[n] = 0x00;
|
360 |
var_hub_size++; |
361 |
} |
362 |
|
363 |
/* fill PortPwrCtrlMask bits */
|
364 |
limit = limit + ((NUM_PORTS + 7) / 8); |
365 |
for (;n < limit; n++) {
|
366 |
data[n] = 0xff;
|
367 |
var_hub_size++; |
368 |
} |
369 |
|
370 |
ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
|
371 |
data[0] = ret;
|
372 |
break;
|
373 |
} |
374 |
default:
|
375 |
fail:
|
376 |
ret = USB_RET_STALL; |
377 |
break;
|
378 |
} |
379 |
return ret;
|
380 |
} |
381 |
|
382 |
static int usb_hub_handle_data(USBDevice *dev, USBPacket *p) |
383 |
{ |
384 |
USBHubState *s = (USBHubState *)dev; |
385 |
int ret;
|
386 |
|
387 |
switch(p->pid) {
|
388 |
case USB_TOKEN_IN:
|
389 |
if (p->devep == 1) { |
390 |
USBHubPort *port; |
391 |
unsigned int status; |
392 |
uint8_t buf[4];
|
393 |
int i, n;
|
394 |
n = (NUM_PORTS + 1 + 7) / 8; |
395 |
if (p->iov.size == 1) { /* FreeBSD workaround */ |
396 |
n = 1;
|
397 |
} else if (n > p->iov.size) { |
398 |
return USB_RET_BABBLE;
|
399 |
} |
400 |
status = 0;
|
401 |
for(i = 0; i < NUM_PORTS; i++) { |
402 |
port = &s->ports[i]; |
403 |
if (port->wPortChange)
|
404 |
status |= (1 << (i + 1)); |
405 |
} |
406 |
if (status != 0) { |
407 |
for(i = 0; i < n; i++) { |
408 |
buf[i] = status >> (8 * i);
|
409 |
} |
410 |
usb_packet_copy(p, buf, n); |
411 |
ret = n; |
412 |
} else {
|
413 |
ret = USB_RET_NAK; /* usb11 11.13.1 */
|
414 |
} |
415 |
} else {
|
416 |
goto fail;
|
417 |
} |
418 |
break;
|
419 |
case USB_TOKEN_OUT:
|
420 |
default:
|
421 |
fail:
|
422 |
ret = USB_RET_STALL; |
423 |
break;
|
424 |
} |
425 |
return ret;
|
426 |
} |
427 |
|
428 |
static int usb_hub_broadcast_packet(USBHubState *s, USBPacket *p) |
429 |
{ |
430 |
USBHubPort *port; |
431 |
USBDevice *dev; |
432 |
int i, ret;
|
433 |
|
434 |
for(i = 0; i < NUM_PORTS; i++) { |
435 |
port = &s->ports[i]; |
436 |
dev = port->port.dev; |
437 |
if (dev && dev->attached && (port->wPortStatus & PORT_STAT_ENABLE)) {
|
438 |
ret = usb_handle_packet(dev, p); |
439 |
if (ret != USB_RET_NODEV) {
|
440 |
return ret;
|
441 |
} |
442 |
} |
443 |
} |
444 |
return USB_RET_NODEV;
|
445 |
} |
446 |
|
447 |
static int usb_hub_handle_packet(USBDevice *dev, USBPacket *p) |
448 |
{ |
449 |
USBHubState *s = (USBHubState *)dev; |
450 |
|
451 |
#if defined(DEBUG) && 0 |
452 |
printf("usb_hub: pid=0x%x\n", pid);
|
453 |
#endif
|
454 |
if (dev->state == USB_STATE_DEFAULT &&
|
455 |
dev->addr != 0 &&
|
456 |
p->devaddr != dev->addr && |
457 |
(p->pid == USB_TOKEN_SETUP || |
458 |
p->pid == USB_TOKEN_OUT || |
459 |
p->pid == USB_TOKEN_IN)) { |
460 |
/* broadcast the packet to the devices */
|
461 |
return usb_hub_broadcast_packet(s, p);
|
462 |
} |
463 |
return usb_generic_handle_packet(dev, p);
|
464 |
} |
465 |
|
466 |
static void usb_hub_handle_destroy(USBDevice *dev) |
467 |
{ |
468 |
USBHubState *s = (USBHubState *)dev; |
469 |
int i;
|
470 |
|
471 |
for (i = 0; i < NUM_PORTS; i++) { |
472 |
usb_unregister_port(usb_bus_from_device(dev), |
473 |
&s->ports[i].port); |
474 |
} |
475 |
} |
476 |
|
477 |
static USBPortOps usb_hub_port_ops = {
|
478 |
.attach = usb_hub_attach, |
479 |
.detach = usb_hub_detach, |
480 |
.child_detach = usb_hub_child_detach, |
481 |
.wakeup = usb_hub_wakeup, |
482 |
.complete = usb_hub_complete, |
483 |
}; |
484 |
|
485 |
static int usb_hub_initfn(USBDevice *dev) |
486 |
{ |
487 |
USBHubState *s = DO_UPCAST(USBHubState, dev, dev); |
488 |
USBHubPort *port; |
489 |
int i;
|
490 |
|
491 |
usb_desc_init(dev); |
492 |
for (i = 0; i < NUM_PORTS; i++) { |
493 |
port = &s->ports[i]; |
494 |
usb_register_port(usb_bus_from_device(dev), |
495 |
&port->port, s, i, &usb_hub_port_ops, |
496 |
USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL); |
497 |
usb_port_location(&port->port, dev->port, i+1);
|
498 |
port->wPortStatus = PORT_STAT_POWER; |
499 |
port->wPortChange = 0;
|
500 |
} |
501 |
return 0; |
502 |
} |
503 |
|
504 |
static const VMStateDescription vmstate_usb_hub_port = { |
505 |
.name = "usb-hub-port",
|
506 |
.version_id = 1,
|
507 |
.minimum_version_id = 1,
|
508 |
.fields = (VMStateField []) { |
509 |
VMSTATE_UINT16(wPortStatus, USBHubPort), |
510 |
VMSTATE_UINT16(wPortChange, USBHubPort), |
511 |
VMSTATE_END_OF_LIST() |
512 |
} |
513 |
}; |
514 |
|
515 |
static const VMStateDescription vmstate_usb_hub = { |
516 |
.name = "usb-hub",
|
517 |
.version_id = 1,
|
518 |
.minimum_version_id = 1,
|
519 |
.fields = (VMStateField []) { |
520 |
VMSTATE_USB_DEVICE(dev, USBHubState), |
521 |
VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
|
522 |
vmstate_usb_hub_port, USBHubPort), |
523 |
VMSTATE_END_OF_LIST() |
524 |
} |
525 |
}; |
526 |
|
527 |
static struct USBDeviceInfo hub_info = { |
528 |
.product_desc = "QEMU USB Hub",
|
529 |
.qdev.name = "usb-hub",
|
530 |
.qdev.fw_name = "hub",
|
531 |
.qdev.size = sizeof(USBHubState),
|
532 |
.qdev.vmsd = &vmstate_usb_hub, |
533 |
.usb_desc = &desc_hub, |
534 |
.init = usb_hub_initfn, |
535 |
.handle_packet = usb_hub_handle_packet, |
536 |
.handle_reset = usb_hub_handle_reset, |
537 |
.handle_control = usb_hub_handle_control, |
538 |
.handle_data = usb_hub_handle_data, |
539 |
.handle_destroy = usb_hub_handle_destroy, |
540 |
}; |
541 |
|
542 |
static void usb_hub_register_devices(void) |
543 |
{ |
544 |
usb_qdev_register(&hub_info); |
545 |
} |
546 |
device_init(usb_hub_register_devices) |