hw/usb-hub.c

   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          = 0,
 131         .idProduct         = 0,
 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_dev_descriptor[] = {
 142         0x12,       /*  u8 bLength; */
 143         0x01,       /*  u8 bDescriptorType; Device */
 144         0x10, 0x01, /*  u16 bcdUSB; v1.1 */
 145
 146         0x09,       /*  u8  bDeviceClass; HUB_CLASSCODE */
 147         0x00,       /*  u8  bDeviceSubClass; */
 148         0x00,       /*  u8  bDeviceProtocol; [ low/full speeds only ] */
 149         0x08,       /*  u8  bMaxPacketSize0; 8 Bytes */
 150
 151         0x00, 0x00, /*  u16 idVendor; */
 152         0x00, 0x00, /*  u16 idProduct; */
 153         0x01, 0x01, /*  u16 bcdDevice */
 154
 155         0x03,       /*  u8  iManufacturer; */
 156         0x02,       /*  u8  iProduct; */
 157         0x01,       /*  u8  iSerialNumber; */
 158         0x01        /*  u8  bNumConfigurations; */
 159 };
 160
 161 /* XXX: patch interrupt size */
 162 static const uint8_t qemu_hub_config_descriptor[] = {
 163
 164         /* one configuration */
 165         0x09,       /*  u8  bLength; */
 166         0x02,       /*  u8  bDescriptorType; Configuration */
 167         0x19, 0x00, /*  u16 wTotalLength; */
 168         0x01,       /*  u8  bNumInterfaces; (1) */
 169         0x01,       /*  u8  bConfigurationValue; */
 170         0x00,       /*  u8  iConfiguration; */
 171         0xe0,       /*  u8  bmAttributes;
 172                                  Bit 7: must be set,
 173                                      6: Self-powered,
 174                                      5: Remote wakeup,
 175                                      4..0: resvd */
 176         0x00,       /*  u8  MaxPower; */
 177
 178         /* USB 1.1:
 179          * USB 2.0, single TT organization (mandatory):
 180          *      one interface, protocol 0
 181          *
 182          * USB 2.0, multiple TT organization (optional):
 183          *      two interfaces, protocols 1 (like single TT)
 184          *      and 2 (multiple TT mode) ... config is
 185          *      sometimes settable
 186          *      NOT IMPLEMENTED
 187          */
 188
 189         /* one interface */
 190         0x09,       /*  u8  if_bLength; */
 191         0x04,       /*  u8  if_bDescriptorType; Interface */
 192         0x00,       /*  u8  if_bInterfaceNumber; */
 193         0x00,       /*  u8  if_bAlternateSetting; */
 194         0x01,       /*  u8  if_bNumEndpoints; */
 195         0x09,       /*  u8  if_bInterfaceClass; HUB_CLASSCODE */
 196         0x00,       /*  u8  if_bInterfaceSubClass; */
 197         0x00,       /*  u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
 198         0x00,       /*  u8  if_iInterface; */
 199
 200         /* one endpoint (status change endpoint) */
 201         0x07,       /*  u8  ep_bLength; */
 202         0x05,       /*  u8  ep_bDescriptorType; Endpoint */
 203         0x81,       /*  u8  ep_bEndpointAddress; IN Endpoint 1 */
 204         0x03,       /*  u8  ep_bmAttributes; Interrupt */
 205         0x02, 0x00, /*  u16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
 206         0xff        /*  u8  ep_bInterval; (255ms -- usb 2.0 spec) */
 207 };
 208
 209 static const uint8_t qemu_hub_hub_descriptor[] =
 210 {
 211         0x00,                   /*  u8  bLength; patched in later */
 212         0x29,                   /*  u8  bDescriptorType; Hub-descriptor */
 213         0x00,                   /*  u8  bNbrPorts; (patched later) */
 214         0x0a,                   /* u16  wHubCharacteristics; */
 215         0x00,                   /*   (per-port OC, no power switching) */
 216         0x01,                   /*  u8  bPwrOn2pwrGood; 2ms */
 217         0x00                    /*  u8  bHubContrCurrent; 0 mA */
 218
 219         /* DeviceRemovable and PortPwrCtrlMask patched in later */
 220 };
 221
 222 static void usb_hub_attach(USBPort *port1)
 223 {
 224     USBHubState *s = port1->opaque;
 225     USBHubPort *port = &s->ports[port1->index];
 226
 227     port->wPortStatus |= PORT_STAT_CONNECTION;
 228     port->wPortChange |= PORT_STAT_C_CONNECTION;
 229     if (port->port.dev->speed == USB_SPEED_LOW) {
 230         port->wPortStatus |= PORT_STAT_LOW_SPEED;
 231     } else {
 232         port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
 233     }
 234 }
 235
 236 static void usb_hub_detach(USBPort *port1)
 237 {
 238     USBHubState *s = port1->opaque;
 239     USBHubPort *port = &s->ports[port1->index];
 240
 241     port->wPortStatus &= ~PORT_STAT_CONNECTION;
 242     port->wPortChange |= PORT_STAT_C_CONNECTION;
 243     if (port->wPortStatus & PORT_STAT_ENABLE) {
 244         port->wPortStatus &= ~PORT_STAT_ENABLE;
 245         port->wPortChange |= PORT_STAT_C_ENABLE;
 246     }
 247 }
 248
 249 static void usb_hub_wakeup(USBDevice *dev)
 250 {
 251     USBHubState *s = dev->port->opaque;
 252     USBHubPort *port = &s->ports[dev->port->index];
 253
 254     if (port->wPortStatus & PORT_STAT_SUSPEND) {
 255         port->wPortChange |= PORT_STAT_C_SUSPEND;
 256         usb_wakeup(&s->dev);
 257     }
 258 }
 259
 260 static void usb_hub_complete(USBDevice *dev, USBPacket *packet)
 261 {
 262     USBHubState *s = dev->port->opaque;
 263
 264     /*
 265      * Just pass it along upstream for now.
 266      *
 267      * If we ever inplement usb 2.0 split transactions this will
 268      * become a little more complicated ...
 269      */
 270     usb_packet_complete(&s->dev, packet);
 271 }
 272
 273 static void usb_hub_handle_attach(USBDevice *dev)
 274 {
 275     USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
 276     int i;
 277
 278     for (i = 0; i < NUM_PORTS; i++) {
 279         usb_port_location(&s->ports[i].port, dev->port, i+1);
 280     }
 281 }
 282
 283 static void usb_hub_handle_reset(USBDevice *dev)
 284 {
 285     /* XXX: do it */
 286 }
 287
 288 static int usb_hub_handle_control(USBDevice *dev, USBPacket *p,
 289                int request, int value, int index, int length, uint8_t *data)
 290 {
 291     USBHubState *s = (USBHubState *)dev;
 292     int ret;
 293
 294     ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
 295     if (ret >= 0) {
 296         return ret;
 297     }
 298
 299     switch(request) {
 300     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 301         if (value == 0 && index != 0x81) { /* clear ep halt */
 302             goto fail;
 303         }
 304         ret = 0;
 305         break;
 306     case DeviceRequest | USB_REQ_GET_INTERFACE:
 307         data[0] = 0;
 308         ret = 1;
 309         break;
 310     case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 311         ret = 0;
 312         break;
 313         /* usb specific requests */
 314     case GetHubStatus:
 315         data[0] = 0;
 316         data[1] = 0;
 317         data[2] = 0;
 318         data[3] = 0;
 319         ret = 4;
 320         break;
 321     case GetPortStatus:
 322         {
 323             unsigned int n = index - 1;
 324             USBHubPort *port;
 325             if (n >= NUM_PORTS) {
 326                 goto fail;
 327             }
 328             port = &s->ports[n];
 329             data[0] = port->wPortStatus;
 330             data[1] = port->wPortStatus >> 8;
 331             data[2] = port->wPortChange;
 332             data[3] = port->wPortChange >> 8;
 333             ret = 4;
 334         }
 335         break;
 336     case SetHubFeature:
 337     case ClearHubFeature:
 338         if (value == 0 || value == 1) {
 339         } else {
 340             goto fail;
 341         }
 342         ret = 0;
 343         break;
 344     case SetPortFeature:
 345         {
 346             unsigned int n = index - 1;
 347             USBHubPort *port;
 348             USBDevice *dev;
 349             if (n >= NUM_PORTS) {
 350                 goto fail;
 351             }
 352             port = &s->ports[n];
 353             dev = port->port.dev;
 354             switch(value) {
 355             case PORT_SUSPEND:
 356                 port->wPortStatus |= PORT_STAT_SUSPEND;
 357                 break;
 358             case PORT_RESET:
 359                 if (dev) {
 360                     usb_send_msg(dev, USB_MSG_RESET);
 361                     port->wPortChange |= PORT_STAT_C_RESET;
 362                     /* set enable bit */
 363                     port->wPortStatus |= PORT_STAT_ENABLE;
 364                 }
 365                 break;
 366             case PORT_POWER:
 367                 break;
 368             default:
 369                 goto fail;
 370             }
 371             ret = 0;
 372         }
 373         break;
 374     case ClearPortFeature:
 375         {
 376             unsigned int n = index - 1;
 377             USBHubPort *port;
 378
 379             if (n >= NUM_PORTS) {
 380                 goto fail;
 381             }
 382             port = &s->ports[n];
 383             switch(value) {
 384             case PORT_ENABLE:
 385                 port->wPortStatus &= ~PORT_STAT_ENABLE;
 386                 break;
 387             case PORT_C_ENABLE:
 388                 port->wPortChange &= ~PORT_STAT_C_ENABLE;
 389                 break;
 390             case PORT_SUSPEND:
 391                 port->wPortStatus &= ~PORT_STAT_SUSPEND;
 392                 break;
 393             case PORT_C_SUSPEND:
 394                 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
 395                 break;
 396             case PORT_C_CONNECTION:
 397                 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
 398                 break;
 399             case PORT_C_OVERCURRENT:
 400                 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
 401                 break;
 402             case PORT_C_RESET:
 403                 port->wPortChange &= ~PORT_STAT_C_RESET;
 404                 break;
 405             default:
 406                 goto fail;
 407             }
 408             ret = 0;
 409         }
 410         break;
 411     case GetHubDescriptor:
 412         {
 413             unsigned int n, limit, var_hub_size = 0;
 414             memcpy(data, qemu_hub_hub_descriptor,
 415                    sizeof(qemu_hub_hub_descriptor));
 416             data[2] = NUM_PORTS;
 417
 418             /* fill DeviceRemovable bits */
 419             limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
 420             for (n = 7; n < limit; n++) {
 421                 data[n] = 0x00;
 422                 var_hub_size++;
 423             }
 424
 425             /* fill PortPwrCtrlMask bits */
 426             limit = limit + ((NUM_PORTS + 7) / 8);
 427             for (;n < limit; n++) {
 428                 data[n] = 0xff;
 429                 var_hub_size++;
 430             }
 431
 432             ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
 433             data[0] = ret;
 434             break;
 435         }
 436     default:
 437     fail:
 438         ret = USB_RET_STALL;
 439         break;
 440     }
 441     return ret;
 442 }
 443
 444 static int usb_hub_handle_data(USBDevice *dev, USBPacket *p)
 445 {
 446     USBHubState *s = (USBHubState *)dev;
 447     int ret;
 448
 449     switch(p->pid) {
 450     case USB_TOKEN_IN:
 451         if (p->devep == 1) {
 452             USBHubPort *port;
 453             unsigned int status;
 454             int i, n;
 455             n = (NUM_PORTS + 1 + 7) / 8;
 456             if (p->len == 1) { /* FreeBSD workaround */
 457                 n = 1;
 458             } else if (n > p->len) {
 459                 return USB_RET_BABBLE;
 460             }
 461             status = 0;
 462             for(i = 0; i < NUM_PORTS; i++) {
 463                 port = &s->ports[i];
 464                 if (port->wPortChange)
 465                     status |= (1 << (i + 1));
 466             }
 467             if (status != 0) {
 468                 for(i = 0; i < n; i++) {
 469                     p->data[i] = status >> (8 * i);
 470                 }
 471                 ret = n;
 472             } else {
 473                 ret = USB_RET_NAK; /* usb11 11.13.1 */
 474             }
 475         } else {
 476             goto fail;
 477         }
 478         break;
 479     case USB_TOKEN_OUT:
 480     default:
 481     fail:
 482         ret = USB_RET_STALL;
 483         break;
 484     }
 485     return ret;
 486 }
 487
 488 static int usb_hub_broadcast_packet(USBHubState *s, USBPacket *p)
 489 {
 490     USBHubPort *port;
 491     USBDevice *dev;
 492     int i, ret;
 493
 494     for(i = 0; i < NUM_PORTS; i++) {
 495         port = &s->ports[i];
 496         dev = port->port.dev;
 497         if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
 498             ret = usb_handle_packet(dev, p);
 499             if (ret != USB_RET_NODEV) {
 500                 return ret;
 501             }
 502         }
 503     }
 504     return USB_RET_NODEV;
 505 }
 506
 507 static int usb_hub_handle_packet(USBDevice *dev, USBPacket *p)
 508 {
 509     USBHubState *s = (USBHubState *)dev;
 510
 511 #if defined(DEBUG) && 0
 512     printf("usb_hub: pid=0x%x\n", pid);
 513 #endif
 514     if (dev->state == USB_STATE_DEFAULT &&
 515         dev->addr != 0 &&
 516         p->devaddr != dev->addr &&
 517         (p->pid == USB_TOKEN_SETUP ||
 518          p->pid == USB_TOKEN_OUT ||
 519          p->pid == USB_TOKEN_IN)) {
 520         /* broadcast the packet to the devices */
 521         return usb_hub_broadcast_packet(s, p);
 522     }
 523     return usb_generic_handle_packet(dev, p);
 524 }
 525
 526 static void usb_hub_handle_destroy(USBDevice *dev)
 527 {
 528     USBHubState *s = (USBHubState *)dev;
 529     int i;
 530
 531     for (i = 0; i < NUM_PORTS; i++) {
 532         usb_unregister_port(usb_bus_from_device(dev),
 533                             &s->ports[i].port);
 534     }
 535 }
 536
 537 static USBPortOps usb_hub_port_ops = {
 538     .attach = usb_hub_attach,
 539     .detach = usb_hub_detach,
 540     .wakeup = usb_hub_wakeup,
 541     .complete = usb_hub_complete,
 542 };
 543
 544 static int usb_hub_initfn(USBDevice *dev)
 545 {
 546     USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
 547     USBHubPort *port;
 548     int i;
 549
 550     usb_desc_init(dev);
 551     for (i = 0; i < NUM_PORTS; i++) {
 552         port = &s->ports[i];
 553         usb_register_port(usb_bus_from_device(dev),
 554                           &port->port, s, i, &usb_hub_port_ops,
 555                           USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
 556         port->wPortStatus = PORT_STAT_POWER;
 557         port->wPortChange = 0;
 558     }
 559     return 0;
 560 }
 561
 562 static const VMStateDescription vmstate_usb_hub_port = {
 563     .name = "usb-hub-port",
 564     .version_id = 1,
 565     .minimum_version_id = 1,
 566     .fields = (VMStateField []) {
 567         VMSTATE_UINT16(wPortStatus, USBHubPort),
 568         VMSTATE_UINT16(wPortChange, USBHubPort),
 569         VMSTATE_END_OF_LIST()
 570     }
 571 };
 572
 573 static const VMStateDescription vmstate_usb_hub = {
 574     .name = "usb-hub",
 575     .version_id = 1,
 576     .minimum_version_id = 1,
 577     .fields = (VMStateField []) {
 578         VMSTATE_USB_DEVICE(dev, USBHubState),
 579         VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
 580                              vmstate_usb_hub_port, USBHubPort),
 581         VMSTATE_END_OF_LIST()
 582     }
 583 };
 584
 585 static struct USBDeviceInfo hub_info = {
 586     .product_desc   = "QEMU USB Hub",
 587     .qdev.name      = "usb-hub",
 588     .qdev.fw_name    = "hub",
 589     .qdev.size      = sizeof(USBHubState),
 590     .qdev.vmsd      = &vmstate_usb_hub,
 591     .usb_desc       = &desc_hub,
 592     .init           = usb_hub_initfn,
 593     .handle_packet  = usb_hub_handle_packet,
 594     .handle_attach  = usb_hub_handle_attach,
 595     .handle_reset   = usb_hub_handle_reset,
 596     .handle_control = usb_hub_handle_control,
 597     .handle_data    = usb_hub_handle_data,
 598     .handle_destroy = usb_hub_handle_destroy,
 599 };
 600
 601 static void usb_hub_register_devices(void)
 602 {
 603     usb_qdev_register(&hub_info);
 604 }
 605 device_init(usb_hub_register_devices)