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 "trace.h" 26 #include "hw/usb.h" 27 #include "hw/usb/desc.h" 28 #include "qemu/error-report.h" 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 USBEndpoint *intr; 41 USBHubPort ports[NUM_PORTS]; 42 } USBHubState; 43 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) 51 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 62 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 68 69 #define PORT_CONNECTION 0 70 #define PORT_ENABLE 1 71 #define PORT_SUSPEND 2 72 #define PORT_OVERCURRENT 3 73 #define PORT_RESET 4 74 #define PORT_POWER 8 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 82 #define PORT_TEST 21 83 #define PORT_INDICATOR 22 84 85 /* same as Linux kernel root hubs */ 86 87 enum { 88 STR_MANUFACTURER = 1, 89 STR_PRODUCT, 90 STR_SERIALNUMBER, 91 }; 92 93 static const USBDescStrings desc_strings = { 94 [STR_MANUFACTURER] = "QEMU", 95 [STR_PRODUCT] = "QEMU USB Hub", 96 [STR_SERIALNUMBER] = "314159", 97 }; 98 99 static const USBDescIface desc_iface_hub = { 100 .bInterfaceNumber = 0, 101 .bNumEndpoints = 1, 102 .bInterfaceClass = USB_CLASS_HUB, 103 .eps = (USBDescEndpoint[]) { 104 { 105 .bEndpointAddress = USB_DIR_IN | 0x01, 106 .bmAttributes = USB_ENDPOINT_XFER_INT, 107 .wMaxPacketSize = 1 + (NUM_PORTS + 7) / 8, 108 .bInterval = 0xff, 109 }, 110 } 111 }; 112 113 static const USBDescDevice desc_device_hub = { 114 .bcdUSB = 0x0110, 115 .bDeviceClass = USB_CLASS_HUB, 116 .bMaxPacketSize0 = 8, 117 .bNumConfigurations = 1, 118 .confs = (USBDescConfig[]) { 119 { 120 .bNumInterfaces = 1, 121 .bConfigurationValue = 1, 122 .bmAttributes = 0xe0, 123 .nif = 1, 124 .ifs = &desc_iface_hub, 125 }, 126 }, 127 }; 128 129 static const USBDesc desc_hub = { 130 .id = { 131 .idVendor = 0x0409, 132 .idProduct = 0x55aa, 133 .bcdDevice = 0x0101, 134 .iManufacturer = STR_MANUFACTURER, 135 .iProduct = STR_PRODUCT, 136 .iSerialNumber = STR_SERIALNUMBER, 137 }, 138 .full = &desc_device_hub, 139 .str = desc_strings, 140 }; 141 142 static const uint8_t qemu_hub_hub_descriptor[] = 143 { 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 */ 151 152 /* DeviceRemovable and PortPwrCtrlMask patched in later */ 153 }; 154 155 static void usb_hub_attach(USBPort *port1) 156 { 157 USBHubState *s = port1->opaque; 158 USBHubPort *port = &s->ports[port1->index]; 159 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; 165 } else { 166 port->wPortStatus &= ~PORT_STAT_LOW_SPEED; 167 } 168 usb_wakeup(s->intr, 0); 169 } 170 171 static void usb_hub_detach(USBPort *port1) 172 { 173 USBHubState *s = port1->opaque; 174 USBHubPort *port = &s->ports[port1->index]; 175 176 trace_usb_hub_detach(s->dev.addr, port1->index + 1); 177 usb_wakeup(s->intr, 0); 178 179 /* Let upstream know the device on this port is gone */ 180 s->dev.port->ops->child_detach(s->dev.port, port1->dev); 181 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; 187 } 188 usb_wakeup(s->intr, 0); 189 } 190 191 static void usb_hub_child_detach(USBPort *port1, USBDevice *child) 192 { 193 USBHubState *s = port1->opaque; 194 195 /* Pass along upstream */ 196 s->dev.port->ops->child_detach(s->dev.port, child); 197 } 198 199 static void usb_hub_wakeup(USBPort *port1) 200 { 201 USBHubState *s = port1->opaque; 202 USBHubPort *port = &s->ports[port1->index]; 203 204 if (port->wPortStatus & PORT_STAT_SUSPEND) { 205 port->wPortChange |= PORT_STAT_C_SUSPEND; 206 usb_wakeup(s->intr, 0); 207 } 208 } 209 210 static void usb_hub_complete(USBPort *port, USBPacket *packet) 211 { 212 USBHubState *s = port->opaque; 213 214 /* 215 * Just pass it along upstream for now. 216 * 217 * If we ever implement usb 2.0 split transactions this will 218 * become a little more complicated ... 219 * 220 * Can't use usb_packet_complete() here because packet->owner is 221 * cleared already, go call the ->complete() callback directly 222 * instead. 223 */ 224 s->dev.port->ops->complete(s->dev.port, packet); 225 } 226 227 static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr) 228 { 229 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 230 USBHubPort *port; 231 USBDevice *downstream; 232 int i; 233 234 for (i = 0; i < NUM_PORTS; i++) { 235 port = &s->ports[i]; 236 if (!(port->wPortStatus & PORT_STAT_ENABLE)) { 237 continue; 238 } 239 downstream = usb_find_device(&port->port, addr); 240 if (downstream != NULL) { 241 return downstream; 242 } 243 } 244 return NULL; 245 } 246 247 static void usb_hub_handle_reset(USBDevice *dev) 248 { 249 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 250 USBHubPort *port; 251 int i; 252 253 trace_usb_hub_reset(s->dev.addr); 254 for (i = 0; i < NUM_PORTS; i++) { 255 port = s->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; 263 } 264 } 265 } 266 } 267 268 static const char *feature_name(int feature) 269 { 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", 286 }; 287 if (feature < 0 || feature >= ARRAY_SIZE(name)) { 288 return "?"; 289 } 290 return name[feature] ?: "?"; 291 } 292 293 static void usb_hub_handle_control(USBDevice *dev, USBPacket *p, 294 int request, int value, int index, int length, uint8_t *data) 295 { 296 USBHubState *s = (USBHubState *)dev; 297 int ret; 298 299 trace_usb_hub_control(s->dev.addr, request, value, index, length); 300 301 ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 302 if (ret >= 0) { 303 return; 304 } 305 306 switch(request) { 307 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 308 if (value == 0 && index != 0x81) { /* clear ep halt */ 309 goto fail; 310 } 311 break; 312 /* usb specific requests */ 313 case GetHubStatus: 314 data[0] = 0; 315 data[1] = 0; 316 data[2] = 0; 317 data[3] = 0; 318 p->actual_length = 4; 319 break; 320 case GetPortStatus: 321 { 322 unsigned int n = index - 1; 323 USBHubPort *port; 324 if (n >= NUM_PORTS) { 325 goto fail; 326 } 327 port = &s->ports[n]; 328 trace_usb_hub_get_port_status(s->dev.addr, index, 329 port->wPortStatus, 330 port->wPortChange); 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; 336 } 337 break; 338 case SetHubFeature: 339 case ClearHubFeature: 340 if (value != 0 && value != 1) { 341 goto fail; 342 } 343 break; 344 case SetPortFeature: 345 { 346 unsigned int n = index - 1; 347 USBHubPort *port; 348 USBDevice *dev; 349 350 trace_usb_hub_set_port_feature(s->dev.addr, index, 351 feature_name(value)); 352 353 if (n >= NUM_PORTS) { 354 goto fail; 355 } 356 port = &s->ports[n]; 357 dev = port->port.dev; 358 switch(value) { 359 case PORT_SUSPEND: 360 port->wPortStatus |= PORT_STAT_SUSPEND; 361 break; 362 case PORT_RESET: 363 if (dev && dev->attached) { 364 usb_device_reset(dev); 365 port->wPortChange |= PORT_STAT_C_RESET; 366 /* set enable bit */ 367 port->wPortStatus |= PORT_STAT_ENABLE; 368 usb_wakeup(s->intr, 0); 369 } 370 break; 371 case PORT_POWER: 372 break; 373 default: 374 goto fail; 375 } 376 } 377 break; 378 case ClearPortFeature: 379 { 380 unsigned int n = index - 1; 381 USBHubPort *port; 382 383 trace_usb_hub_clear_port_feature(s->dev.addr, index, 384 feature_name(value)); 385 386 if (n >= NUM_PORTS) { 387 goto fail; 388 } 389 port = &s->ports[n]; 390 switch(value) { 391 case PORT_ENABLE: 392 port->wPortStatus &= ~PORT_STAT_ENABLE; 393 break; 394 case PORT_C_ENABLE: 395 port->wPortChange &= ~PORT_STAT_C_ENABLE; 396 break; 397 case PORT_SUSPEND: 398 port->wPortStatus &= ~PORT_STAT_SUSPEND; 399 break; 400 case PORT_C_SUSPEND: 401 port->wPortChange &= ~PORT_STAT_C_SUSPEND; 402 break; 403 case PORT_C_CONNECTION: 404 port->wPortChange &= ~PORT_STAT_C_CONNECTION; 405 break; 406 case PORT_C_OVERCURRENT: 407 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT; 408 break; 409 case PORT_C_RESET: 410 port->wPortChange &= ~PORT_STAT_C_RESET; 411 break; 412 default: 413 goto fail; 414 } 415 } 416 break; 417 case GetHubDescriptor: 418 { 419 unsigned int n, limit, var_hub_size = 0; 420 memcpy(data, qemu_hub_hub_descriptor, 421 sizeof(qemu_hub_hub_descriptor)); 422 data[2] = NUM_PORTS; 423 424 /* fill DeviceRemovable bits */ 425 limit = ((NUM_PORTS + 1 + 7) / 8) + 7; 426 for (n = 7; n < limit; n++) { 427 data[n] = 0x00; 428 var_hub_size++; 429 } 430 431 /* fill PortPwrCtrlMask bits */ 432 limit = limit + ((NUM_PORTS + 7) / 8); 433 for (;n < limit; n++) { 434 data[n] = 0xff; 435 var_hub_size++; 436 } 437 438 p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size; 439 data[0] = p->actual_length; 440 break; 441 } 442 default: 443 fail: 444 p->status = USB_RET_STALL; 445 break; 446 } 447 } 448 449 static void usb_hub_handle_data(USBDevice *dev, USBPacket *p) 450 { 451 USBHubState *s = (USBHubState *)dev; 452 453 switch(p->pid) { 454 case USB_TOKEN_IN: 455 if (p->ep->nr == 1) { 456 USBHubPort *port; 457 unsigned int status; 458 uint8_t buf[4]; 459 int i, n; 460 n = (NUM_PORTS + 1 + 7) / 8; 461 if (p->iov.size == 1) { /* FreeBSD workaround */ 462 n = 1; 463 } else if (n > p->iov.size) { 464 p->status = USB_RET_BABBLE; 465 return; 466 } 467 status = 0; 468 for(i = 0; i < NUM_PORTS; i++) { 469 port = &s->ports[i]; 470 if (port->wPortChange) 471 status |= (1 << (i + 1)); 472 } 473 if (status != 0) { 474 trace_usb_hub_status_report(s->dev.addr, status); 475 for(i = 0; i < n; i++) { 476 buf[i] = status >> (8 * i); 477 } 478 usb_packet_copy(p, buf, n); 479 } else { 480 p->status = USB_RET_NAK; /* usb11 11.13.1 */ 481 } 482 } else { 483 goto fail; 484 } 485 break; 486 case USB_TOKEN_OUT: 487 default: 488 fail: 489 p->status = USB_RET_STALL; 490 break; 491 } 492 } 493 494 static void usb_hub_handle_destroy(USBDevice *dev) 495 { 496 USBHubState *s = (USBHubState *)dev; 497 int i; 498 499 for (i = 0; i < NUM_PORTS; i++) { 500 usb_unregister_port(usb_bus_from_device(dev), 501 &s->ports[i].port); 502 } 503 } 504 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, 511 }; 512 513 static int usb_hub_initfn(USBDevice *dev) 514 { 515 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 516 USBHubPort *port; 517 int i; 518 519 if (dev->port->hubcount == 5) { 520 error_report("usb hub chain too deep"); 521 return -1; 522 } 523 524 usb_desc_create_serial(dev); 525 usb_desc_init(dev); 526 s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 527 for (i = 0; i < NUM_PORTS; i++) { 528 port = &s->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); 533 } 534 usb_hub_handle_reset(dev); 535 return 0; 536 } 537 538 static const VMStateDescription vmstate_usb_hub_port = { 539 .name = "usb-hub-port", 540 .version_id = 1, 541 .minimum_version_id = 1, 542 .fields = (VMStateField []) { 543 VMSTATE_UINT16(wPortStatus, USBHubPort), 544 VMSTATE_UINT16(wPortChange, USBHubPort), 545 VMSTATE_END_OF_LIST() 546 } 547 }; 548 549 static const VMStateDescription vmstate_usb_hub = { 550 .name = "usb-hub", 551 .version_id = 1, 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() 558 } 559 }; 560 561 static void usb_hub_class_initfn(ObjectClass *klass, void *data) 562 { 563 DeviceClass *dc = DEVICE_CLASS(klass); 564 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 565 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); 575 dc->fw_name = "hub"; 576 dc->vmsd = &vmstate_usb_hub; 577 } 578 579 static const TypeInfo hub_info = { 580 .name = "usb-hub", 581 .parent = TYPE_USB_DEVICE, 582 .instance_size = sizeof(USBHubState), 583 .class_init = usb_hub_class_initfn, 584 }; 585 586 static void usb_hub_register_types(void) 587 { 588 type_register_static(&hub_info); 589 } 590 591 type_init(usb_hub_register_types) 592