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