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 29 #define NUM_PORTS 8 30 31 typedef struct USBHubPort { 32 USBPort port; 33 uint16_t wPortStatus; 34 uint16_t wPortChange; 35 } USBHubPort; 36 37 typedef struct USBHubState { 38 USBDevice dev; 39 USBEndpoint *intr; 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", 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 trace_usb_hub_attach(s->dev.addr, port1->index + 1); 160 port->wPortStatus |= PORT_STAT_CONNECTION; 161 port->wPortChange |= PORT_STAT_C_CONNECTION; 162 if (port->port.dev->speed == USB_SPEED_LOW) { 163 port->wPortStatus |= PORT_STAT_LOW_SPEED; 164 } else { 165 port->wPortStatus &= ~PORT_STAT_LOW_SPEED; 166 } 167 usb_wakeup(s->intr); 168 } 169 170 static void usb_hub_detach(USBPort *port1) 171 { 172 USBHubState *s = port1->opaque; 173 USBHubPort *port = &s->ports[port1->index]; 174 175 trace_usb_hub_detach(s->dev.addr, port1->index + 1); 176 usb_wakeup(s->intr); 177 178 /* Let upstream know the device on this port is gone */ 179 s->dev.port->ops->child_detach(s->dev.port, port1->dev); 180 181 port->wPortStatus &= ~PORT_STAT_CONNECTION; 182 port->wPortChange |= PORT_STAT_C_CONNECTION; 183 if (port->wPortStatus & PORT_STAT_ENABLE) { 184 port->wPortStatus &= ~PORT_STAT_ENABLE; 185 port->wPortChange |= PORT_STAT_C_ENABLE; 186 } 187 } 188 189 static void usb_hub_child_detach(USBPort *port1, USBDevice *child) 190 { 191 USBHubState *s = port1->opaque; 192 193 /* Pass along upstream */ 194 s->dev.port->ops->child_detach(s->dev.port, child); 195 } 196 197 static void usb_hub_wakeup(USBPort *port1) 198 { 199 USBHubState *s = port1->opaque; 200 USBHubPort *port = &s->ports[port1->index]; 201 202 if (port->wPortStatus & PORT_STAT_SUSPEND) { 203 port->wPortChange |= PORT_STAT_C_SUSPEND; 204 usb_wakeup(s->intr); 205 } 206 } 207 208 static void usb_hub_complete(USBPort *port, USBPacket *packet) 209 { 210 USBHubState *s = port->opaque; 211 212 /* 213 * Just pass it along upstream for now. 214 * 215 * If we ever implement usb 2.0 split transactions this will 216 * become a little more complicated ... 217 * 218 * Can't use usb_packet_complete() here because packet->owner is 219 * cleared already, go call the ->complete() callback directly 220 * instead. 221 */ 222 s->dev.port->ops->complete(s->dev.port, packet); 223 } 224 225 static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr) 226 { 227 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 228 USBHubPort *port; 229 USBDevice *downstream; 230 int i; 231 232 for (i = 0; i < NUM_PORTS; i++) { 233 port = &s->ports[i]; 234 if (!(port->wPortStatus & PORT_STAT_ENABLE)) { 235 continue; 236 } 237 downstream = usb_find_device(&port->port, addr); 238 if (downstream != NULL) { 239 return downstream; 240 } 241 } 242 return NULL; 243 } 244 245 static void usb_hub_handle_reset(USBDevice *dev) 246 { 247 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 248 USBHubPort *port; 249 int i; 250 251 trace_usb_hub_reset(s->dev.addr); 252 for (i = 0; i < NUM_PORTS; i++) { 253 port = s->ports + i; 254 port->wPortStatus = PORT_STAT_POWER; 255 port->wPortChange = 0; 256 if (port->port.dev && port->port.dev->attached) { 257 port->wPortStatus |= PORT_STAT_CONNECTION; 258 port->wPortChange |= PORT_STAT_C_CONNECTION; 259 if (port->port.dev->speed == USB_SPEED_LOW) { 260 port->wPortStatus |= PORT_STAT_LOW_SPEED; 261 } 262 } 263 } 264 } 265 266 static const char *feature_name(int feature) 267 { 268 static const char *name[] = { 269 [PORT_CONNECTION] = "connection", 270 [PORT_ENABLE] = "enable", 271 [PORT_SUSPEND] = "suspend", 272 [PORT_OVERCURRENT] = "overcurrent", 273 [PORT_RESET] = "reset", 274 [PORT_POWER] = "power", 275 [PORT_LOWSPEED] = "lowspeed", 276 [PORT_HIGHSPEED] = "highspeed", 277 [PORT_C_CONNECTION] = "change connection", 278 [PORT_C_ENABLE] = "change enable", 279 [PORT_C_SUSPEND] = "change suspend", 280 [PORT_C_OVERCURRENT] = "change overcurrent", 281 [PORT_C_RESET] = "change reset", 282 [PORT_TEST] = "test", 283 [PORT_INDICATOR] = "indicator", 284 }; 285 if (feature < 0 || feature >= ARRAY_SIZE(name)) { 286 return "?"; 287 } 288 return name[feature] ?: "?"; 289 } 290 291 static void usb_hub_handle_control(USBDevice *dev, USBPacket *p, 292 int request, int value, int index, int length, uint8_t *data) 293 { 294 USBHubState *s = (USBHubState *)dev; 295 int ret; 296 297 trace_usb_hub_control(s->dev.addr, request, value, index, length); 298 299 ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 300 if (ret >= 0) { 301 return; 302 } 303 304 switch(request) { 305 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 306 if (value == 0 && index != 0x81) { /* clear ep halt */ 307 goto fail; 308 } 309 break; 310 /* usb specific requests */ 311 case GetHubStatus: 312 data[0] = 0; 313 data[1] = 0; 314 data[2] = 0; 315 data[3] = 0; 316 p->actual_length = 4; 317 break; 318 case GetPortStatus: 319 { 320 unsigned int n = index - 1; 321 USBHubPort *port; 322 if (n >= NUM_PORTS) { 323 goto fail; 324 } 325 port = &s->ports[n]; 326 trace_usb_hub_get_port_status(s->dev.addr, index, 327 port->wPortStatus, 328 port->wPortChange); 329 data[0] = port->wPortStatus; 330 data[1] = port->wPortStatus >> 8; 331 data[2] = port->wPortChange; 332 data[3] = port->wPortChange >> 8; 333 p->actual_length = 4; 334 } 335 break; 336 case SetHubFeature: 337 case ClearHubFeature: 338 if (value != 0 && value != 1) { 339 goto fail; 340 } 341 break; 342 case SetPortFeature: 343 { 344 unsigned int n = index - 1; 345 USBHubPort *port; 346 USBDevice *dev; 347 348 trace_usb_hub_set_port_feature(s->dev.addr, index, 349 feature_name(value)); 350 351 if (n >= NUM_PORTS) { 352 goto fail; 353 } 354 port = &s->ports[n]; 355 dev = port->port.dev; 356 switch(value) { 357 case PORT_SUSPEND: 358 port->wPortStatus |= PORT_STAT_SUSPEND; 359 break; 360 case PORT_RESET: 361 if (dev && dev->attached) { 362 usb_device_reset(dev); 363 port->wPortChange |= PORT_STAT_C_RESET; 364 /* set enable bit */ 365 port->wPortStatus |= PORT_STAT_ENABLE; 366 } 367 break; 368 case PORT_POWER: 369 break; 370 default: 371 goto fail; 372 } 373 } 374 break; 375 case ClearPortFeature: 376 { 377 unsigned int n = index - 1; 378 USBHubPort *port; 379 380 trace_usb_hub_clear_port_feature(s->dev.addr, index, 381 feature_name(value)); 382 383 if (n >= NUM_PORTS) { 384 goto fail; 385 } 386 port = &s->ports[n]; 387 switch(value) { 388 case PORT_ENABLE: 389 port->wPortStatus &= ~PORT_STAT_ENABLE; 390 break; 391 case PORT_C_ENABLE: 392 port->wPortChange &= ~PORT_STAT_C_ENABLE; 393 break; 394 case PORT_SUSPEND: 395 port->wPortStatus &= ~PORT_STAT_SUSPEND; 396 break; 397 case PORT_C_SUSPEND: 398 port->wPortChange &= ~PORT_STAT_C_SUSPEND; 399 break; 400 case PORT_C_CONNECTION: 401 port->wPortChange &= ~PORT_STAT_C_CONNECTION; 402 break; 403 case PORT_C_OVERCURRENT: 404 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT; 405 break; 406 case PORT_C_RESET: 407 port->wPortChange &= ~PORT_STAT_C_RESET; 408 break; 409 default: 410 goto fail; 411 } 412 } 413 break; 414 case GetHubDescriptor: 415 { 416 unsigned int n, limit, var_hub_size = 0; 417 memcpy(data, qemu_hub_hub_descriptor, 418 sizeof(qemu_hub_hub_descriptor)); 419 data[2] = NUM_PORTS; 420 421 /* fill DeviceRemovable bits */ 422 limit = ((NUM_PORTS + 1 + 7) / 8) + 7; 423 for (n = 7; n < limit; n++) { 424 data[n] = 0x00; 425 var_hub_size++; 426 } 427 428 /* fill PortPwrCtrlMask bits */ 429 limit = limit + ((NUM_PORTS + 7) / 8); 430 for (;n < limit; n++) { 431 data[n] = 0xff; 432 var_hub_size++; 433 } 434 435 p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size; 436 data[0] = p->actual_length; 437 break; 438 } 439 default: 440 fail: 441 p->status = USB_RET_STALL; 442 break; 443 } 444 } 445 446 static void usb_hub_handle_data(USBDevice *dev, USBPacket *p) 447 { 448 USBHubState *s = (USBHubState *)dev; 449 450 switch(p->pid) { 451 case USB_TOKEN_IN: 452 if (p->ep->nr == 1) { 453 USBHubPort *port; 454 unsigned int status; 455 uint8_t buf[4]; 456 int i, n; 457 n = (NUM_PORTS + 1 + 7) / 8; 458 if (p->iov.size == 1) { /* FreeBSD workaround */ 459 n = 1; 460 } else if (n > p->iov.size) { 461 p->status = USB_RET_BABBLE; 462 return; 463 } 464 status = 0; 465 for(i = 0; i < NUM_PORTS; i++) { 466 port = &s->ports[i]; 467 if (port->wPortChange) 468 status |= (1 << (i + 1)); 469 } 470 if (status != 0) { 471 for(i = 0; i < n; i++) { 472 buf[i] = status >> (8 * i); 473 } 474 usb_packet_copy(p, buf, n); 475 } else { 476 p->status = USB_RET_NAK; /* usb11 11.13.1 */ 477 } 478 } else { 479 goto fail; 480 } 481 break; 482 case USB_TOKEN_OUT: 483 default: 484 fail: 485 p->status = USB_RET_STALL; 486 break; 487 } 488 } 489 490 static void usb_hub_handle_destroy(USBDevice *dev) 491 { 492 USBHubState *s = (USBHubState *)dev; 493 int i; 494 495 for (i = 0; i < NUM_PORTS; i++) { 496 usb_unregister_port(usb_bus_from_device(dev), 497 &s->ports[i].port); 498 } 499 } 500 501 static USBPortOps usb_hub_port_ops = { 502 .attach = usb_hub_attach, 503 .detach = usb_hub_detach, 504 .child_detach = usb_hub_child_detach, 505 .wakeup = usb_hub_wakeup, 506 .complete = usb_hub_complete, 507 }; 508 509 static int usb_hub_initfn(USBDevice *dev) 510 { 511 USBHubState *s = DO_UPCAST(USBHubState, dev, dev); 512 USBHubPort *port; 513 int i; 514 515 usb_desc_create_serial(dev); 516 usb_desc_init(dev); 517 s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 518 for (i = 0; i < NUM_PORTS; i++) { 519 port = &s->ports[i]; 520 usb_register_port(usb_bus_from_device(dev), 521 &port->port, s, i, &usb_hub_port_ops, 522 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL); 523 usb_port_location(&port->port, dev->port, i+1); 524 } 525 usb_hub_handle_reset(dev); 526 return 0; 527 } 528 529 static const VMStateDescription vmstate_usb_hub_port = { 530 .name = "usb-hub-port", 531 .version_id = 1, 532 .minimum_version_id = 1, 533 .fields = (VMStateField []) { 534 VMSTATE_UINT16(wPortStatus, USBHubPort), 535 VMSTATE_UINT16(wPortChange, USBHubPort), 536 VMSTATE_END_OF_LIST() 537 } 538 }; 539 540 static const VMStateDescription vmstate_usb_hub = { 541 .name = "usb-hub", 542 .version_id = 1, 543 .minimum_version_id = 1, 544 .fields = (VMStateField []) { 545 VMSTATE_USB_DEVICE(dev, USBHubState), 546 VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0, 547 vmstate_usb_hub_port, USBHubPort), 548 VMSTATE_END_OF_LIST() 549 } 550 }; 551 552 static void usb_hub_class_initfn(ObjectClass *klass, void *data) 553 { 554 DeviceClass *dc = DEVICE_CLASS(klass); 555 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 556 557 uc->init = usb_hub_initfn; 558 uc->product_desc = "QEMU USB Hub"; 559 uc->usb_desc = &desc_hub; 560 uc->find_device = usb_hub_find_device; 561 uc->handle_reset = usb_hub_handle_reset; 562 uc->handle_control = usb_hub_handle_control; 563 uc->handle_data = usb_hub_handle_data; 564 uc->handle_destroy = usb_hub_handle_destroy; 565 dc->fw_name = "hub"; 566 dc->vmsd = &vmstate_usb_hub; 567 } 568 569 static TypeInfo hub_info = { 570 .name = "usb-hub", 571 .parent = TYPE_USB_DEVICE, 572 .instance_size = sizeof(USBHubState), 573 .class_init = usb_hub_class_initfn, 574 }; 575 576 static void usb_hub_register_types(void) 577 { 578 type_register_static(&hub_info); 579 } 580 581 type_init(usb_hub_register_types) 582