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