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_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 }
 167
 168 static void usb_hub_detach(USBPort *port1)
 169 {
 170     USBHubState *s = port1->opaque;
 171     USBHubPort *port = &s->ports[port1->index];
 172
 173     /* Let upstream know the device on this port is gone */
 174     s->dev.port->ops->child_detach(s->dev.port, port1->dev);
 175
 176     port->wPortStatus &= ~PORT_STAT_CONNECTION;
 177     port->wPortChange |= PORT_STAT_C_CONNECTION;
 178     if (port->wPortStatus & PORT_STAT_ENABLE) {
 179         port->wPortStatus &= ~PORT_STAT_ENABLE;
 180         port->wPortChange |= PORT_STAT_C_ENABLE;
 181     }
 182 }
 183
 184 static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
 185 {
 186     USBHubState *s = port1->opaque;
 187
 188     /* Pass along upstream */
 189     s->dev.port->ops->child_detach(s->dev.port, child);
 190 }
 191
 192 static void usb_hub_wakeup(USBPort *port1)
 193 {
 194     USBHubState *s = port1->opaque;
 195     USBHubPort *port = &s->ports[port1->index];
 196
 197     if (port->wPortStatus & PORT_STAT_SUSPEND) {
 198         port->wPortChange |= PORT_STAT_C_SUSPEND;
 199         usb_wakeup(&s->dev);
 200     }
 201 }
 202
 203 static void usb_hub_complete(USBPort *port, USBPacket *packet)
 204 {
 205     USBHubState *s = port->opaque;
 206
 207     /*
 208      * Just pass it along upstream for now.
 209      *
 210      * If we ever inplement usb 2.0 split transactions this will
 211      * become a little more complicated ...
 212      */
 213     usb_packet_complete(&s->dev, packet);
 214 }
 215
 216 static void usb_hub_handle_attach(USBDevice *dev)
 217 {
 218     USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
 219     int i;
 220
 221     for (i = 0; i < NUM_PORTS; i++) {
 222         usb_port_location(&s->ports[i].port, dev->port, i+1);
 223     }
 224 }
 225
 226 static void usb_hub_handle_reset(USBDevice *dev)
 227 {
 228     /* XXX: do it */
 229 }
 230
 231 static int usb_hub_handle_control(USBDevice *dev, USBPacket *p,
 232                int request, int value, int index, int length, uint8_t *data)
 233 {
 234     USBHubState *s = (USBHubState *)dev;
 235     int ret;
 236
 237     ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
 238     if (ret >= 0) {
 239         return ret;
 240     }
 241
 242     switch(request) {
 243     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
 244         if (value == 0 && index != 0x81) { /* clear ep halt */
 245             goto fail;
 246         }
 247         ret = 0;
 248         break;
 249     case DeviceRequest | USB_REQ_GET_INTERFACE:
 250         data[0] = 0;
 251         ret = 1;
 252         break;
 253     case DeviceOutRequest | USB_REQ_SET_INTERFACE:
 254         ret = 0;
 255         break;
 256         /* usb specific requests */
 257     case GetHubStatus:
 258         data[0] = 0;
 259         data[1] = 0;
 260         data[2] = 0;
 261         data[3] = 0;
 262         ret = 4;
 263         break;
 264     case GetPortStatus:
 265         {
 266             unsigned int n = index - 1;
 267             USBHubPort *port;
 268             if (n >= NUM_PORTS) {
 269                 goto fail;
 270             }
 271             port = &s->ports[n];
 272             data[0] = port->wPortStatus;
 273             data[1] = port->wPortStatus >> 8;
 274             data[2] = port->wPortChange;
 275             data[3] = port->wPortChange >> 8;
 276             ret = 4;
 277         }
 278         break;
 279     case SetHubFeature:
 280     case ClearHubFeature:
 281         if (value == 0 || value == 1) {
 282         } else {
 283             goto fail;
 284         }
 285         ret = 0;
 286         break;
 287     case SetPortFeature:
 288         {
 289             unsigned int n = index - 1;
 290             USBHubPort *port;
 291             USBDevice *dev;
 292             if (n >= NUM_PORTS) {
 293                 goto fail;
 294             }
 295             port = &s->ports[n];
 296             dev = port->port.dev;
 297             switch(value) {
 298             case PORT_SUSPEND:
 299                 port->wPortStatus |= PORT_STAT_SUSPEND;
 300                 break;
 301             case PORT_RESET:
 302                 if (dev) {
 303                     usb_send_msg(dev, USB_MSG_RESET);
 304                     port->wPortChange |= PORT_STAT_C_RESET;
 305                     /* set enable bit */
 306                     port->wPortStatus |= PORT_STAT_ENABLE;
 307                 }
 308                 break;
 309             case PORT_POWER:
 310                 break;
 311             default:
 312                 goto fail;
 313             }
 314             ret = 0;
 315         }
 316         break;
 317     case ClearPortFeature:
 318         {
 319             unsigned int n = index - 1;
 320             USBHubPort *port;
 321
 322             if (n >= NUM_PORTS) {
 323                 goto fail;
 324             }
 325             port = &s->ports[n];
 326             switch(value) {
 327             case PORT_ENABLE:
 328                 port->wPortStatus &= ~PORT_STAT_ENABLE;
 329                 break;
 330             case PORT_C_ENABLE:
 331                 port->wPortChange &= ~PORT_STAT_C_ENABLE;
 332                 break;
 333             case PORT_SUSPEND:
 334                 port->wPortStatus &= ~PORT_STAT_SUSPEND;
 335                 break;
 336             case PORT_C_SUSPEND:
 337                 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
 338                 break;
 339             case PORT_C_CONNECTION:
 340                 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
 341                 break;
 342             case PORT_C_OVERCURRENT:
 343                 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
 344                 break;
 345             case PORT_C_RESET:
 346                 port->wPortChange &= ~PORT_STAT_C_RESET;
 347                 break;
 348             default:
 349                 goto fail;
 350             }
 351             ret = 0;
 352         }
 353         break;
 354     case GetHubDescriptor:
 355         {
 356             unsigned int n, limit, var_hub_size = 0;
 357             memcpy(data, qemu_hub_hub_descriptor,
 358                    sizeof(qemu_hub_hub_descriptor));
 359             data[2] = NUM_PORTS;
 360
 361             /* fill DeviceRemovable bits */
 362             limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
 363             for (n = 7; n < limit; n++) {
 364                 data[n] = 0x00;
 365                 var_hub_size++;
 366             }
 367
 368             /* fill PortPwrCtrlMask bits */
 369             limit = limit + ((NUM_PORTS + 7) / 8);
 370             for (;n < limit; n++) {
 371                 data[n] = 0xff;
 372                 var_hub_size++;
 373             }
 374
 375             ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
 376             data[0] = ret;
 377             break;
 378         }
 379     default:
 380     fail:
 381         ret = USB_RET_STALL;
 382         break;
 383     }
 384     return ret;
 385 }
 386
 387 static int usb_hub_handle_data(USBDevice *dev, USBPacket *p)
 388 {
 389     USBHubState *s = (USBHubState *)dev;
 390     int ret;
 391
 392     switch(p->pid) {
 393     case USB_TOKEN_IN:
 394         if (p->devep == 1) {
 395             USBHubPort *port;
 396             unsigned int status;
 397             int i, n;
 398             n = (NUM_PORTS + 1 + 7) / 8;
 399             if (p->len == 1) { /* FreeBSD workaround */
 400                 n = 1;
 401             } else if (n > p->len) {
 402                 return USB_RET_BABBLE;
 403             }
 404             status = 0;
 405             for(i = 0; i < NUM_PORTS; i++) {
 406                 port = &s->ports[i];
 407                 if (port->wPortChange)
 408                     status |= (1 << (i + 1));
 409             }
 410             if (status != 0) {
 411                 for(i = 0; i < n; i++) {
 412                     p->data[i] = status >> (8 * i);
 413                 }
 414                 ret = n;
 415             } else {
 416                 ret = USB_RET_NAK; /* usb11 11.13.1 */
 417             }
 418         } else {
 419             goto fail;
 420         }
 421         break;
 422     case USB_TOKEN_OUT:
 423     default:
 424     fail:
 425         ret = USB_RET_STALL;
 426         break;
 427     }
 428     return ret;
 429 }
 430
 431 static int usb_hub_broadcast_packet(USBHubState *s, USBPacket *p)
 432 {
 433     USBHubPort *port;
 434     USBDevice *dev;
 435     int i, ret;
 436
 437     for(i = 0; i < NUM_PORTS; i++) {
 438         port = &s->ports[i];
 439         dev = port->port.dev;
 440         if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
 441             ret = usb_handle_packet(dev, p);
 442             if (ret != USB_RET_NODEV) {
 443                 return ret;
 444             }
 445         }
 446     }
 447     return USB_RET_NODEV;
 448 }
 449
 450 static int usb_hub_handle_packet(USBDevice *dev, USBPacket *p)
 451 {
 452     USBHubState *s = (USBHubState *)dev;
 453
 454 #if defined(DEBUG) && 0
 455     printf("usb_hub: pid=0x%x\n", pid);
 456 #endif
 457     if (dev->state == USB_STATE_DEFAULT &&
 458         dev->addr != 0 &&
 459         p->devaddr != dev->addr &&
 460         (p->pid == USB_TOKEN_SETUP ||
 461          p->pid == USB_TOKEN_OUT ||
 462          p->pid == USB_TOKEN_IN)) {
 463         /* broadcast the packet to the devices */
 464         return usb_hub_broadcast_packet(s, p);
 465     }
 466     return usb_generic_handle_packet(dev, p);
 467 }
 468
 469 static void usb_hub_handle_destroy(USBDevice *dev)
 470 {
 471     USBHubState *s = (USBHubState *)dev;
 472     int i;
 473
 474     for (i = 0; i < NUM_PORTS; i++) {
 475         usb_unregister_port(usb_bus_from_device(dev),
 476                             &s->ports[i].port);
 477     }
 478 }
 479
 480 static USBPortOps usb_hub_port_ops = {
 481     .attach = usb_hub_attach,
 482     .detach = usb_hub_detach,
 483     .child_detach = usb_hub_child_detach,
 484     .wakeup = usb_hub_wakeup,
 485     .complete = usb_hub_complete,
 486 };
 487
 488 static int usb_hub_initfn(USBDevice *dev)
 489 {
 490     USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
 491     USBHubPort *port;
 492     int i;
 493
 494     usb_desc_init(dev);
 495     for (i = 0; i < NUM_PORTS; i++) {
 496         port = &s->ports[i];
 497         usb_register_port(usb_bus_from_device(dev),
 498                           &port->port, s, i, &usb_hub_port_ops,
 499                           USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
 500         port->wPortStatus = PORT_STAT_POWER;
 501         port->wPortChange = 0;
 502     }
 503     return 0;
 504 }
 505
 506 static const VMStateDescription vmstate_usb_hub_port = {
 507     .name = "usb-hub-port",
 508     .version_id = 1,
 509     .minimum_version_id = 1,
 510     .fields = (VMStateField []) {
 511         VMSTATE_UINT16(wPortStatus, USBHubPort),
 512         VMSTATE_UINT16(wPortChange, USBHubPort),
 513         VMSTATE_END_OF_LIST()
 514     }
 515 };
 516
 517 static const VMStateDescription vmstate_usb_hub = {
 518     .name = "usb-hub",
 519     .version_id = 1,
 520     .minimum_version_id = 1,
 521     .fields = (VMStateField []) {
 522         VMSTATE_USB_DEVICE(dev, USBHubState),
 523         VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
 524                              vmstate_usb_hub_port, USBHubPort),
 525         VMSTATE_END_OF_LIST()
 526     }
 527 };
 528
 529 static struct USBDeviceInfo hub_info = {
 530     .product_desc   = "QEMU USB Hub",
 531     .qdev.name      = "usb-hub",
 532     .qdev.fw_name    = "hub",
 533     .qdev.size      = sizeof(USBHubState),
 534     .qdev.vmsd      = &vmstate_usb_hub,
 535     .usb_desc       = &desc_hub,
 536     .init           = usb_hub_initfn,
 537     .handle_packet  = usb_hub_handle_packet,
 538     .handle_attach  = usb_hub_handle_attach,
 539     .handle_reset   = usb_hub_handle_reset,
 540     .handle_control = usb_hub_handle_control,
 541     .handle_data    = usb_hub_handle_data,
 542     .handle_destroy = usb_hub_handle_destroy,
 543 };
 544
 545 static void usb_hub_register_devices(void)
 546 {
 547     usb_qdev_register(&hub_info);
 548 }
 549 device_init(usb_hub_register_devices)