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