1f1ae32a1SGerd Hoffmann /* 2f1ae32a1SGerd Hoffmann * QEMU USB HUB emulation 3f1ae32a1SGerd Hoffmann * 4f1ae32a1SGerd Hoffmann * Copyright (c) 2005 Fabrice Bellard 5f1ae32a1SGerd Hoffmann * 6f1ae32a1SGerd Hoffmann * Permission is hereby granted, free of charge, to any person obtaining a copy 7f1ae32a1SGerd Hoffmann * of this software and associated documentation files (the "Software"), to deal 8f1ae32a1SGerd Hoffmann * in the Software without restriction, including without limitation the rights 9f1ae32a1SGerd Hoffmann * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10f1ae32a1SGerd Hoffmann * copies of the Software, and to permit persons to whom the Software is 11f1ae32a1SGerd Hoffmann * furnished to do so, subject to the following conditions: 12f1ae32a1SGerd Hoffmann * 13f1ae32a1SGerd Hoffmann * The above copyright notice and this permission notice shall be included in 14f1ae32a1SGerd Hoffmann * all copies or substantial portions of the Software. 15f1ae32a1SGerd Hoffmann * 16f1ae32a1SGerd Hoffmann * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17f1ae32a1SGerd Hoffmann * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18f1ae32a1SGerd Hoffmann * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19f1ae32a1SGerd Hoffmann * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20f1ae32a1SGerd Hoffmann * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21f1ae32a1SGerd Hoffmann * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22f1ae32a1SGerd Hoffmann * THE SOFTWARE. 23f1ae32a1SGerd Hoffmann */ 24e532b2e0SPeter Maydell #include "qemu/osdep.h" 25da34e65cSMarkus Armbruster #include "qapi/error.h" 26f1ae32a1SGerd Hoffmann #include "qemu-common.h" 27529f8f9fSGerd Hoffmann #include "trace.h" 28f1ae32a1SGerd Hoffmann #include "hw/usb.h" 29*463581a8SMichael S. Tsirkin #include "desc.h" 30c24e4aacSGerd Hoffmann #include "qemu/error-report.h" 31f1ae32a1SGerd Hoffmann 32f1ae32a1SGerd Hoffmann #define NUM_PORTS 8 33f1ae32a1SGerd Hoffmann 34f1ae32a1SGerd Hoffmann typedef struct USBHubPort { 35f1ae32a1SGerd Hoffmann USBPort port; 36f1ae32a1SGerd Hoffmann uint16_t wPortStatus; 37f1ae32a1SGerd Hoffmann uint16_t wPortChange; 38f1ae32a1SGerd Hoffmann } USBHubPort; 39f1ae32a1SGerd Hoffmann 40f1ae32a1SGerd Hoffmann typedef struct USBHubState { 41f1ae32a1SGerd Hoffmann USBDevice dev; 42f1ae32a1SGerd Hoffmann USBEndpoint *intr; 43f1ae32a1SGerd Hoffmann USBHubPort ports[NUM_PORTS]; 44f1ae32a1SGerd Hoffmann } USBHubState; 45f1ae32a1SGerd Hoffmann 46e81b13adSGonglei #define TYPE_USB_HUB "usb-hub" 47e81b13adSGonglei #define USB_HUB(obj) OBJECT_CHECK(USBHubState, (obj), TYPE_USB_HUB) 48e81b13adSGonglei 49f1ae32a1SGerd Hoffmann #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE) 50f1ae32a1SGerd Hoffmann #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE) 51f1ae32a1SGerd Hoffmann #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR) 52f1ae32a1SGerd Hoffmann #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS) 53f1ae32a1SGerd Hoffmann #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS) 54f1ae32a1SGerd Hoffmann #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE) 55f1ae32a1SGerd Hoffmann #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE) 56f1ae32a1SGerd Hoffmann 57f1ae32a1SGerd Hoffmann #define PORT_STAT_CONNECTION 0x0001 58f1ae32a1SGerd Hoffmann #define PORT_STAT_ENABLE 0x0002 59f1ae32a1SGerd Hoffmann #define PORT_STAT_SUSPEND 0x0004 60f1ae32a1SGerd Hoffmann #define PORT_STAT_OVERCURRENT 0x0008 61f1ae32a1SGerd Hoffmann #define PORT_STAT_RESET 0x0010 62f1ae32a1SGerd Hoffmann #define PORT_STAT_POWER 0x0100 63f1ae32a1SGerd Hoffmann #define PORT_STAT_LOW_SPEED 0x0200 64f1ae32a1SGerd Hoffmann #define PORT_STAT_HIGH_SPEED 0x0400 65f1ae32a1SGerd Hoffmann #define PORT_STAT_TEST 0x0800 66f1ae32a1SGerd Hoffmann #define PORT_STAT_INDICATOR 0x1000 67f1ae32a1SGerd Hoffmann 68f1ae32a1SGerd Hoffmann #define PORT_STAT_C_CONNECTION 0x0001 69f1ae32a1SGerd Hoffmann #define PORT_STAT_C_ENABLE 0x0002 70f1ae32a1SGerd Hoffmann #define PORT_STAT_C_SUSPEND 0x0004 71f1ae32a1SGerd Hoffmann #define PORT_STAT_C_OVERCURRENT 0x0008 72f1ae32a1SGerd Hoffmann #define PORT_STAT_C_RESET 0x0010 73f1ae32a1SGerd Hoffmann 74f1ae32a1SGerd Hoffmann #define PORT_CONNECTION 0 75f1ae32a1SGerd Hoffmann #define PORT_ENABLE 1 76f1ae32a1SGerd Hoffmann #define PORT_SUSPEND 2 77f1ae32a1SGerd Hoffmann #define PORT_OVERCURRENT 3 78f1ae32a1SGerd Hoffmann #define PORT_RESET 4 79f1ae32a1SGerd Hoffmann #define PORT_POWER 8 80f1ae32a1SGerd Hoffmann #define PORT_LOWSPEED 9 81f1ae32a1SGerd Hoffmann #define PORT_HIGHSPEED 10 82f1ae32a1SGerd Hoffmann #define PORT_C_CONNECTION 16 83f1ae32a1SGerd Hoffmann #define PORT_C_ENABLE 17 84f1ae32a1SGerd Hoffmann #define PORT_C_SUSPEND 18 85f1ae32a1SGerd Hoffmann #define PORT_C_OVERCURRENT 19 86f1ae32a1SGerd Hoffmann #define PORT_C_RESET 20 87f1ae32a1SGerd Hoffmann #define PORT_TEST 21 88f1ae32a1SGerd Hoffmann #define PORT_INDICATOR 22 89f1ae32a1SGerd Hoffmann 90f1ae32a1SGerd Hoffmann /* same as Linux kernel root hubs */ 91f1ae32a1SGerd Hoffmann 92f1ae32a1SGerd Hoffmann enum { 93f1ae32a1SGerd Hoffmann STR_MANUFACTURER = 1, 94f1ae32a1SGerd Hoffmann STR_PRODUCT, 95f1ae32a1SGerd Hoffmann STR_SERIALNUMBER, 96f1ae32a1SGerd Hoffmann }; 97f1ae32a1SGerd Hoffmann 98f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = { 9993bfef4cSCrístian Viana [STR_MANUFACTURER] = "QEMU", 100f1ae32a1SGerd Hoffmann [STR_PRODUCT] = "QEMU USB Hub", 101f1ae32a1SGerd Hoffmann [STR_SERIALNUMBER] = "314159", 102f1ae32a1SGerd Hoffmann }; 103f1ae32a1SGerd Hoffmann 104f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface_hub = { 105f1ae32a1SGerd Hoffmann .bInterfaceNumber = 0, 106f1ae32a1SGerd Hoffmann .bNumEndpoints = 1, 107f1ae32a1SGerd Hoffmann .bInterfaceClass = USB_CLASS_HUB, 108f1ae32a1SGerd Hoffmann .eps = (USBDescEndpoint[]) { 109f1ae32a1SGerd Hoffmann { 110f1ae32a1SGerd Hoffmann .bEndpointAddress = USB_DIR_IN | 0x01, 111f1ae32a1SGerd Hoffmann .bmAttributes = USB_ENDPOINT_XFER_INT, 11254ac85efSMarc-André Lureau .wMaxPacketSize = 1 + DIV_ROUND_UP(NUM_PORTS, 8), 113f1ae32a1SGerd Hoffmann .bInterval = 0xff, 114f1ae32a1SGerd Hoffmann }, 115f1ae32a1SGerd Hoffmann } 116f1ae32a1SGerd Hoffmann }; 117f1ae32a1SGerd Hoffmann 118f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device_hub = { 119f1ae32a1SGerd Hoffmann .bcdUSB = 0x0110, 120f1ae32a1SGerd Hoffmann .bDeviceClass = USB_CLASS_HUB, 121f1ae32a1SGerd Hoffmann .bMaxPacketSize0 = 8, 122f1ae32a1SGerd Hoffmann .bNumConfigurations = 1, 123f1ae32a1SGerd Hoffmann .confs = (USBDescConfig[]) { 124f1ae32a1SGerd Hoffmann { 125f1ae32a1SGerd Hoffmann .bNumInterfaces = 1, 126f1ae32a1SGerd Hoffmann .bConfigurationValue = 1, 127bd93976aSPantelis Koukousoulas .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER | 128bd93976aSPantelis Koukousoulas USB_CFG_ATT_WAKEUP, 129f1ae32a1SGerd Hoffmann .nif = 1, 130f1ae32a1SGerd Hoffmann .ifs = &desc_iface_hub, 131f1ae32a1SGerd Hoffmann }, 132f1ae32a1SGerd Hoffmann }, 133f1ae32a1SGerd Hoffmann }; 134f1ae32a1SGerd Hoffmann 135f1ae32a1SGerd Hoffmann static const USBDesc desc_hub = { 136f1ae32a1SGerd Hoffmann .id = { 137f1ae32a1SGerd Hoffmann .idVendor = 0x0409, 138f1ae32a1SGerd Hoffmann .idProduct = 0x55aa, 139f1ae32a1SGerd Hoffmann .bcdDevice = 0x0101, 140f1ae32a1SGerd Hoffmann .iManufacturer = STR_MANUFACTURER, 141f1ae32a1SGerd Hoffmann .iProduct = STR_PRODUCT, 142f1ae32a1SGerd Hoffmann .iSerialNumber = STR_SERIALNUMBER, 143f1ae32a1SGerd Hoffmann }, 144f1ae32a1SGerd Hoffmann .full = &desc_device_hub, 145f1ae32a1SGerd Hoffmann .str = desc_strings, 146f1ae32a1SGerd Hoffmann }; 147f1ae32a1SGerd Hoffmann 148f1ae32a1SGerd Hoffmann static const uint8_t qemu_hub_hub_descriptor[] = 149f1ae32a1SGerd Hoffmann { 150f1ae32a1SGerd Hoffmann 0x00, /* u8 bLength; patched in later */ 151f1ae32a1SGerd Hoffmann 0x29, /* u8 bDescriptorType; Hub-descriptor */ 152f1ae32a1SGerd Hoffmann 0x00, /* u8 bNbrPorts; (patched later) */ 153f1ae32a1SGerd Hoffmann 0x0a, /* u16 wHubCharacteristics; */ 154f1ae32a1SGerd Hoffmann 0x00, /* (per-port OC, no power switching) */ 155f1ae32a1SGerd Hoffmann 0x01, /* u8 bPwrOn2pwrGood; 2ms */ 156f1ae32a1SGerd Hoffmann 0x00 /* u8 bHubContrCurrent; 0 mA */ 157f1ae32a1SGerd Hoffmann 158f1ae32a1SGerd Hoffmann /* DeviceRemovable and PortPwrCtrlMask patched in later */ 159f1ae32a1SGerd Hoffmann }; 160f1ae32a1SGerd Hoffmann 161f1ae32a1SGerd Hoffmann static void usb_hub_attach(USBPort *port1) 162f1ae32a1SGerd Hoffmann { 163f1ae32a1SGerd Hoffmann USBHubState *s = port1->opaque; 164f1ae32a1SGerd Hoffmann USBHubPort *port = &s->ports[port1->index]; 165f1ae32a1SGerd Hoffmann 166529f8f9fSGerd Hoffmann trace_usb_hub_attach(s->dev.addr, port1->index + 1); 167f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_CONNECTION; 168f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_CONNECTION; 169f1ae32a1SGerd Hoffmann if (port->port.dev->speed == USB_SPEED_LOW) { 170f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_LOW_SPEED; 171f1ae32a1SGerd Hoffmann } else { 172f1ae32a1SGerd Hoffmann port->wPortStatus &= ~PORT_STAT_LOW_SPEED; 173f1ae32a1SGerd Hoffmann } 1748550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 175f1ae32a1SGerd Hoffmann } 176f1ae32a1SGerd Hoffmann 177f1ae32a1SGerd Hoffmann static void usb_hub_detach(USBPort *port1) 178f1ae32a1SGerd Hoffmann { 179f1ae32a1SGerd Hoffmann USBHubState *s = port1->opaque; 180f1ae32a1SGerd Hoffmann USBHubPort *port = &s->ports[port1->index]; 181f1ae32a1SGerd Hoffmann 182529f8f9fSGerd Hoffmann trace_usb_hub_detach(s->dev.addr, port1->index + 1); 1838550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 184f1ae32a1SGerd Hoffmann 185f1ae32a1SGerd Hoffmann /* Let upstream know the device on this port is gone */ 186f1ae32a1SGerd Hoffmann s->dev.port->ops->child_detach(s->dev.port, port1->dev); 187f1ae32a1SGerd Hoffmann 188f1ae32a1SGerd Hoffmann port->wPortStatus &= ~PORT_STAT_CONNECTION; 189f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_CONNECTION; 190f1ae32a1SGerd Hoffmann if (port->wPortStatus & PORT_STAT_ENABLE) { 191f1ae32a1SGerd Hoffmann port->wPortStatus &= ~PORT_STAT_ENABLE; 192f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_ENABLE; 193f1ae32a1SGerd Hoffmann } 1948550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 195f1ae32a1SGerd Hoffmann } 196f1ae32a1SGerd Hoffmann 197f1ae32a1SGerd Hoffmann static void usb_hub_child_detach(USBPort *port1, USBDevice *child) 198f1ae32a1SGerd Hoffmann { 199f1ae32a1SGerd Hoffmann USBHubState *s = port1->opaque; 200f1ae32a1SGerd Hoffmann 201f1ae32a1SGerd Hoffmann /* Pass along upstream */ 202f1ae32a1SGerd Hoffmann s->dev.port->ops->child_detach(s->dev.port, child); 203f1ae32a1SGerd Hoffmann } 204f1ae32a1SGerd Hoffmann 205f1ae32a1SGerd Hoffmann static void usb_hub_wakeup(USBPort *port1) 206f1ae32a1SGerd Hoffmann { 207f1ae32a1SGerd Hoffmann USBHubState *s = port1->opaque; 208f1ae32a1SGerd Hoffmann USBHubPort *port = &s->ports[port1->index]; 209f1ae32a1SGerd Hoffmann 210f1ae32a1SGerd Hoffmann if (port->wPortStatus & PORT_STAT_SUSPEND) { 21166849dcfSLadi Prosek port->wPortStatus &= ~PORT_STAT_SUSPEND; 212f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_SUSPEND; 2138550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 214f1ae32a1SGerd Hoffmann } 215f1ae32a1SGerd Hoffmann } 216f1ae32a1SGerd Hoffmann 217f1ae32a1SGerd Hoffmann static void usb_hub_complete(USBPort *port, USBPacket *packet) 218f1ae32a1SGerd Hoffmann { 219f1ae32a1SGerd Hoffmann USBHubState *s = port->opaque; 220f1ae32a1SGerd Hoffmann 221f1ae32a1SGerd Hoffmann /* 222f1ae32a1SGerd Hoffmann * Just pass it along upstream for now. 223f1ae32a1SGerd Hoffmann * 224f1ae32a1SGerd Hoffmann * If we ever implement usb 2.0 split transactions this will 225f1ae32a1SGerd Hoffmann * become a little more complicated ... 226f1ae32a1SGerd Hoffmann * 227f1ae32a1SGerd Hoffmann * Can't use usb_packet_complete() here because packet->owner is 228f1ae32a1SGerd Hoffmann * cleared already, go call the ->complete() callback directly 229f1ae32a1SGerd Hoffmann * instead. 230f1ae32a1SGerd Hoffmann */ 231f1ae32a1SGerd Hoffmann s->dev.port->ops->complete(s->dev.port, packet); 232f1ae32a1SGerd Hoffmann } 233f1ae32a1SGerd Hoffmann 234f1ae32a1SGerd Hoffmann static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr) 235f1ae32a1SGerd Hoffmann { 236e81b13adSGonglei USBHubState *s = USB_HUB(dev); 237f1ae32a1SGerd Hoffmann USBHubPort *port; 238f1ae32a1SGerd Hoffmann USBDevice *downstream; 239f1ae32a1SGerd Hoffmann int i; 240f1ae32a1SGerd Hoffmann 241f1ae32a1SGerd Hoffmann for (i = 0; i < NUM_PORTS; i++) { 242f1ae32a1SGerd Hoffmann port = &s->ports[i]; 243f1ae32a1SGerd Hoffmann if (!(port->wPortStatus & PORT_STAT_ENABLE)) { 244f1ae32a1SGerd Hoffmann continue; 245f1ae32a1SGerd Hoffmann } 246f1ae32a1SGerd Hoffmann downstream = usb_find_device(&port->port, addr); 247f1ae32a1SGerd Hoffmann if (downstream != NULL) { 248f1ae32a1SGerd Hoffmann return downstream; 249f1ae32a1SGerd Hoffmann } 250f1ae32a1SGerd Hoffmann } 251f1ae32a1SGerd Hoffmann return NULL; 252f1ae32a1SGerd Hoffmann } 253f1ae32a1SGerd Hoffmann 254f1ae32a1SGerd Hoffmann static void usb_hub_handle_reset(USBDevice *dev) 255f1ae32a1SGerd Hoffmann { 256e81b13adSGonglei USBHubState *s = USB_HUB(dev); 257f1ae32a1SGerd Hoffmann USBHubPort *port; 258f1ae32a1SGerd Hoffmann int i; 259f1ae32a1SGerd Hoffmann 260529f8f9fSGerd Hoffmann trace_usb_hub_reset(s->dev.addr); 261f1ae32a1SGerd Hoffmann for (i = 0; i < NUM_PORTS; i++) { 262f1ae32a1SGerd Hoffmann port = s->ports + i; 263f1ae32a1SGerd Hoffmann port->wPortStatus = PORT_STAT_POWER; 264f1ae32a1SGerd Hoffmann port->wPortChange = 0; 265f1ae32a1SGerd Hoffmann if (port->port.dev && port->port.dev->attached) { 266f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_CONNECTION; 267f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_CONNECTION; 268f1ae32a1SGerd Hoffmann if (port->port.dev->speed == USB_SPEED_LOW) { 269f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_LOW_SPEED; 270f1ae32a1SGerd Hoffmann } 271f1ae32a1SGerd Hoffmann } 272f1ae32a1SGerd Hoffmann } 273f1ae32a1SGerd Hoffmann } 274f1ae32a1SGerd Hoffmann 275529f8f9fSGerd Hoffmann static const char *feature_name(int feature) 276529f8f9fSGerd Hoffmann { 277529f8f9fSGerd Hoffmann static const char *name[] = { 278529f8f9fSGerd Hoffmann [PORT_CONNECTION] = "connection", 279529f8f9fSGerd Hoffmann [PORT_ENABLE] = "enable", 280529f8f9fSGerd Hoffmann [PORT_SUSPEND] = "suspend", 281529f8f9fSGerd Hoffmann [PORT_OVERCURRENT] = "overcurrent", 282529f8f9fSGerd Hoffmann [PORT_RESET] = "reset", 283529f8f9fSGerd Hoffmann [PORT_POWER] = "power", 284529f8f9fSGerd Hoffmann [PORT_LOWSPEED] = "lowspeed", 285529f8f9fSGerd Hoffmann [PORT_HIGHSPEED] = "highspeed", 286529f8f9fSGerd Hoffmann [PORT_C_CONNECTION] = "change connection", 287529f8f9fSGerd Hoffmann [PORT_C_ENABLE] = "change enable", 288529f8f9fSGerd Hoffmann [PORT_C_SUSPEND] = "change suspend", 289529f8f9fSGerd Hoffmann [PORT_C_OVERCURRENT] = "change overcurrent", 290529f8f9fSGerd Hoffmann [PORT_C_RESET] = "change reset", 291529f8f9fSGerd Hoffmann [PORT_TEST] = "test", 292529f8f9fSGerd Hoffmann [PORT_INDICATOR] = "indicator", 293529f8f9fSGerd Hoffmann }; 294529f8f9fSGerd Hoffmann if (feature < 0 || feature >= ARRAY_SIZE(name)) { 295529f8f9fSGerd Hoffmann return "?"; 296529f8f9fSGerd Hoffmann } 297529f8f9fSGerd Hoffmann return name[feature] ?: "?"; 298529f8f9fSGerd Hoffmann } 299529f8f9fSGerd Hoffmann 3009a77a0f5SHans de Goede static void usb_hub_handle_control(USBDevice *dev, USBPacket *p, 301f1ae32a1SGerd Hoffmann int request, int value, int index, int length, uint8_t *data) 302f1ae32a1SGerd Hoffmann { 303f1ae32a1SGerd Hoffmann USBHubState *s = (USBHubState *)dev; 304f1ae32a1SGerd Hoffmann int ret; 305f1ae32a1SGerd Hoffmann 306529f8f9fSGerd Hoffmann trace_usb_hub_control(s->dev.addr, request, value, index, length); 307529f8f9fSGerd Hoffmann 308f1ae32a1SGerd Hoffmann ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 309f1ae32a1SGerd Hoffmann if (ret >= 0) { 3109a77a0f5SHans de Goede return; 311f1ae32a1SGerd Hoffmann } 312f1ae32a1SGerd Hoffmann 313f1ae32a1SGerd Hoffmann switch(request) { 314f1ae32a1SGerd Hoffmann case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: 315f1ae32a1SGerd Hoffmann if (value == 0 && index != 0x81) { /* clear ep halt */ 316f1ae32a1SGerd Hoffmann goto fail; 317f1ae32a1SGerd Hoffmann } 318f1ae32a1SGerd Hoffmann break; 319f1ae32a1SGerd Hoffmann /* usb specific requests */ 320f1ae32a1SGerd Hoffmann case GetHubStatus: 321f1ae32a1SGerd Hoffmann data[0] = 0; 322f1ae32a1SGerd Hoffmann data[1] = 0; 323f1ae32a1SGerd Hoffmann data[2] = 0; 324f1ae32a1SGerd Hoffmann data[3] = 0; 3259a77a0f5SHans de Goede p->actual_length = 4; 326f1ae32a1SGerd Hoffmann break; 327f1ae32a1SGerd Hoffmann case GetPortStatus: 328f1ae32a1SGerd Hoffmann { 329f1ae32a1SGerd Hoffmann unsigned int n = index - 1; 330f1ae32a1SGerd Hoffmann USBHubPort *port; 331f1ae32a1SGerd Hoffmann if (n >= NUM_PORTS) { 332f1ae32a1SGerd Hoffmann goto fail; 333f1ae32a1SGerd Hoffmann } 334f1ae32a1SGerd Hoffmann port = &s->ports[n]; 335529f8f9fSGerd Hoffmann trace_usb_hub_get_port_status(s->dev.addr, index, 336529f8f9fSGerd Hoffmann port->wPortStatus, 337529f8f9fSGerd Hoffmann port->wPortChange); 338f1ae32a1SGerd Hoffmann data[0] = port->wPortStatus; 339f1ae32a1SGerd Hoffmann data[1] = port->wPortStatus >> 8; 340f1ae32a1SGerd Hoffmann data[2] = port->wPortChange; 341f1ae32a1SGerd Hoffmann data[3] = port->wPortChange >> 8; 3429a77a0f5SHans de Goede p->actual_length = 4; 343f1ae32a1SGerd Hoffmann } 344f1ae32a1SGerd Hoffmann break; 345f1ae32a1SGerd Hoffmann case SetHubFeature: 346f1ae32a1SGerd Hoffmann case ClearHubFeature: 3479a77a0f5SHans de Goede if (value != 0 && value != 1) { 348f1ae32a1SGerd Hoffmann goto fail; 349f1ae32a1SGerd Hoffmann } 350f1ae32a1SGerd Hoffmann break; 351f1ae32a1SGerd Hoffmann case SetPortFeature: 352f1ae32a1SGerd Hoffmann { 353f1ae32a1SGerd Hoffmann unsigned int n = index - 1; 354f1ae32a1SGerd Hoffmann USBHubPort *port; 355f1ae32a1SGerd Hoffmann USBDevice *dev; 356529f8f9fSGerd Hoffmann 357529f8f9fSGerd Hoffmann trace_usb_hub_set_port_feature(s->dev.addr, index, 358529f8f9fSGerd Hoffmann feature_name(value)); 359529f8f9fSGerd Hoffmann 360f1ae32a1SGerd Hoffmann if (n >= NUM_PORTS) { 361f1ae32a1SGerd Hoffmann goto fail; 362f1ae32a1SGerd Hoffmann } 363f1ae32a1SGerd Hoffmann port = &s->ports[n]; 364f1ae32a1SGerd Hoffmann dev = port->port.dev; 365f1ae32a1SGerd Hoffmann switch(value) { 366f1ae32a1SGerd Hoffmann case PORT_SUSPEND: 367f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_SUSPEND; 368f1ae32a1SGerd Hoffmann break; 369f1ae32a1SGerd Hoffmann case PORT_RESET: 370f1ae32a1SGerd Hoffmann if (dev && dev->attached) { 371f1ae32a1SGerd Hoffmann usb_device_reset(dev); 372f1ae32a1SGerd Hoffmann port->wPortChange |= PORT_STAT_C_RESET; 373f1ae32a1SGerd Hoffmann /* set enable bit */ 374f1ae32a1SGerd Hoffmann port->wPortStatus |= PORT_STAT_ENABLE; 3758550a02dSGerd Hoffmann usb_wakeup(s->intr, 0); 376f1ae32a1SGerd Hoffmann } 377f1ae32a1SGerd Hoffmann break; 378f1ae32a1SGerd Hoffmann case PORT_POWER: 379f1ae32a1SGerd Hoffmann break; 380f1ae32a1SGerd Hoffmann default: 381f1ae32a1SGerd Hoffmann goto fail; 382f1ae32a1SGerd Hoffmann } 383f1ae32a1SGerd Hoffmann } 384f1ae32a1SGerd Hoffmann break; 385f1ae32a1SGerd Hoffmann case ClearPortFeature: 386f1ae32a1SGerd Hoffmann { 387f1ae32a1SGerd Hoffmann unsigned int n = index - 1; 388f1ae32a1SGerd Hoffmann USBHubPort *port; 389f1ae32a1SGerd Hoffmann 390529f8f9fSGerd Hoffmann trace_usb_hub_clear_port_feature(s->dev.addr, index, 391529f8f9fSGerd Hoffmann feature_name(value)); 392529f8f9fSGerd Hoffmann 393f1ae32a1SGerd Hoffmann if (n >= NUM_PORTS) { 394f1ae32a1SGerd Hoffmann goto fail; 395f1ae32a1SGerd Hoffmann } 396f1ae32a1SGerd Hoffmann port = &s->ports[n]; 397f1ae32a1SGerd Hoffmann switch(value) { 398f1ae32a1SGerd Hoffmann case PORT_ENABLE: 399f1ae32a1SGerd Hoffmann port->wPortStatus &= ~PORT_STAT_ENABLE; 400f1ae32a1SGerd Hoffmann break; 401f1ae32a1SGerd Hoffmann case PORT_C_ENABLE: 402f1ae32a1SGerd Hoffmann port->wPortChange &= ~PORT_STAT_C_ENABLE; 403f1ae32a1SGerd Hoffmann break; 404f1ae32a1SGerd Hoffmann case PORT_SUSPEND: 4056361bbc7SLadi Prosek if (port->wPortStatus & PORT_STAT_SUSPEND) { 406f1ae32a1SGerd Hoffmann port->wPortStatus &= ~PORT_STAT_SUSPEND; 4076361bbc7SLadi Prosek 4086361bbc7SLadi Prosek /* 4096361bbc7SLadi Prosek * USB Spec rev2.0 11.24.2.7.2.3 C_PORT_SUSPEND 4106361bbc7SLadi Prosek * "This bit is set on the following transitions: 4116361bbc7SLadi Prosek * - On transition from the Resuming state to the 4126361bbc7SLadi Prosek * SendEOP [sic] state" 4136361bbc7SLadi Prosek * 4146361bbc7SLadi Prosek * Note that this includes both remote wake-up and 4156361bbc7SLadi Prosek * explicit ClearPortFeature(PORT_SUSPEND). 4166361bbc7SLadi Prosek */ 4176361bbc7SLadi Prosek port->wPortChange |= PORT_STAT_C_SUSPEND; 4186361bbc7SLadi Prosek } 419f1ae32a1SGerd Hoffmann break; 420f1ae32a1SGerd Hoffmann case PORT_C_SUSPEND: 421f1ae32a1SGerd Hoffmann port->wPortChange &= ~PORT_STAT_C_SUSPEND; 422f1ae32a1SGerd Hoffmann break; 423f1ae32a1SGerd Hoffmann case PORT_C_CONNECTION: 424f1ae32a1SGerd Hoffmann port->wPortChange &= ~PORT_STAT_C_CONNECTION; 425f1ae32a1SGerd Hoffmann break; 426f1ae32a1SGerd Hoffmann case PORT_C_OVERCURRENT: 427f1ae32a1SGerd Hoffmann port->wPortChange &= ~PORT_STAT_C_OVERCURRENT; 428f1ae32a1SGerd Hoffmann break; 429f1ae32a1SGerd Hoffmann case PORT_C_RESET: 430f1ae32a1SGerd Hoffmann port->wPortChange &= ~PORT_STAT_C_RESET; 431f1ae32a1SGerd Hoffmann break; 432f1ae32a1SGerd Hoffmann default: 433f1ae32a1SGerd Hoffmann goto fail; 434f1ae32a1SGerd Hoffmann } 435f1ae32a1SGerd Hoffmann } 436f1ae32a1SGerd Hoffmann break; 437f1ae32a1SGerd Hoffmann case GetHubDescriptor: 438f1ae32a1SGerd Hoffmann { 439f1ae32a1SGerd Hoffmann unsigned int n, limit, var_hub_size = 0; 440f1ae32a1SGerd Hoffmann memcpy(data, qemu_hub_hub_descriptor, 441f1ae32a1SGerd Hoffmann sizeof(qemu_hub_hub_descriptor)); 442f1ae32a1SGerd Hoffmann data[2] = NUM_PORTS; 443f1ae32a1SGerd Hoffmann 444f1ae32a1SGerd Hoffmann /* fill DeviceRemovable bits */ 44554ac85efSMarc-André Lureau limit = DIV_ROUND_UP(NUM_PORTS + 1, 8) + 7; 446f1ae32a1SGerd Hoffmann for (n = 7; n < limit; n++) { 447f1ae32a1SGerd Hoffmann data[n] = 0x00; 448f1ae32a1SGerd Hoffmann var_hub_size++; 449f1ae32a1SGerd Hoffmann } 450f1ae32a1SGerd Hoffmann 451f1ae32a1SGerd Hoffmann /* fill PortPwrCtrlMask bits */ 45254ac85efSMarc-André Lureau limit = limit + DIV_ROUND_UP(NUM_PORTS, 8); 453f1ae32a1SGerd Hoffmann for (;n < limit; n++) { 454f1ae32a1SGerd Hoffmann data[n] = 0xff; 455f1ae32a1SGerd Hoffmann var_hub_size++; 456f1ae32a1SGerd Hoffmann } 457f1ae32a1SGerd Hoffmann 4589a77a0f5SHans de Goede p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size; 4599a77a0f5SHans de Goede data[0] = p->actual_length; 460f1ae32a1SGerd Hoffmann break; 461f1ae32a1SGerd Hoffmann } 462f1ae32a1SGerd Hoffmann default: 463f1ae32a1SGerd Hoffmann fail: 4649a77a0f5SHans de Goede p->status = USB_RET_STALL; 465f1ae32a1SGerd Hoffmann break; 466f1ae32a1SGerd Hoffmann } 467f1ae32a1SGerd Hoffmann } 468f1ae32a1SGerd Hoffmann 4699a77a0f5SHans de Goede static void usb_hub_handle_data(USBDevice *dev, USBPacket *p) 470f1ae32a1SGerd Hoffmann { 471f1ae32a1SGerd Hoffmann USBHubState *s = (USBHubState *)dev; 472f1ae32a1SGerd Hoffmann 473f1ae32a1SGerd Hoffmann switch(p->pid) { 474f1ae32a1SGerd Hoffmann case USB_TOKEN_IN: 475f1ae32a1SGerd Hoffmann if (p->ep->nr == 1) { 476f1ae32a1SGerd Hoffmann USBHubPort *port; 477f1ae32a1SGerd Hoffmann unsigned int status; 478f1ae32a1SGerd Hoffmann uint8_t buf[4]; 479f1ae32a1SGerd Hoffmann int i, n; 48054ac85efSMarc-André Lureau n = DIV_ROUND_UP(NUM_PORTS + 1, 8); 481f1ae32a1SGerd Hoffmann if (p->iov.size == 1) { /* FreeBSD workaround */ 482f1ae32a1SGerd Hoffmann n = 1; 483f1ae32a1SGerd Hoffmann } else if (n > p->iov.size) { 4849a77a0f5SHans de Goede p->status = USB_RET_BABBLE; 4859a77a0f5SHans de Goede return; 486f1ae32a1SGerd Hoffmann } 487f1ae32a1SGerd Hoffmann status = 0; 488f1ae32a1SGerd Hoffmann for(i = 0; i < NUM_PORTS; i++) { 489f1ae32a1SGerd Hoffmann port = &s->ports[i]; 490bdebd6eeSGerd Hoffmann if (port->wPortChange) 491f1ae32a1SGerd Hoffmann status |= (1 << (i + 1)); 492f1ae32a1SGerd Hoffmann } 493f1ae32a1SGerd Hoffmann if (status != 0) { 494b8cbc137SGerd Hoffmann trace_usb_hub_status_report(s->dev.addr, status); 495f1ae32a1SGerd Hoffmann for(i = 0; i < n; i++) { 496f1ae32a1SGerd Hoffmann buf[i] = status >> (8 * i); 497f1ae32a1SGerd Hoffmann } 498f1ae32a1SGerd Hoffmann usb_packet_copy(p, buf, n); 499f1ae32a1SGerd Hoffmann } else { 5009a77a0f5SHans de Goede p->status = USB_RET_NAK; /* usb11 11.13.1 */ 501f1ae32a1SGerd Hoffmann } 502f1ae32a1SGerd Hoffmann } else { 503f1ae32a1SGerd Hoffmann goto fail; 504f1ae32a1SGerd Hoffmann } 505f1ae32a1SGerd Hoffmann break; 506f1ae32a1SGerd Hoffmann case USB_TOKEN_OUT: 507f1ae32a1SGerd Hoffmann default: 508f1ae32a1SGerd Hoffmann fail: 5099a77a0f5SHans de Goede p->status = USB_RET_STALL; 510f1ae32a1SGerd Hoffmann break; 511f1ae32a1SGerd Hoffmann } 512f1ae32a1SGerd Hoffmann } 513f1ae32a1SGerd Hoffmann 514c4fe9700SMarc-André Lureau static void usb_hub_unrealize(USBDevice *dev, Error **errp) 515f1ae32a1SGerd Hoffmann { 516f1ae32a1SGerd Hoffmann USBHubState *s = (USBHubState *)dev; 517f1ae32a1SGerd Hoffmann int i; 518f1ae32a1SGerd Hoffmann 519f1ae32a1SGerd Hoffmann for (i = 0; i < NUM_PORTS; i++) { 520f1ae32a1SGerd Hoffmann usb_unregister_port(usb_bus_from_device(dev), 521f1ae32a1SGerd Hoffmann &s->ports[i].port); 522f1ae32a1SGerd Hoffmann } 523f1ae32a1SGerd Hoffmann } 524f1ae32a1SGerd Hoffmann 525f1ae32a1SGerd Hoffmann static USBPortOps usb_hub_port_ops = { 526f1ae32a1SGerd Hoffmann .attach = usb_hub_attach, 527f1ae32a1SGerd Hoffmann .detach = usb_hub_detach, 528f1ae32a1SGerd Hoffmann .child_detach = usb_hub_child_detach, 529f1ae32a1SGerd Hoffmann .wakeup = usb_hub_wakeup, 530f1ae32a1SGerd Hoffmann .complete = usb_hub_complete, 531f1ae32a1SGerd Hoffmann }; 532f1ae32a1SGerd Hoffmann 533f3f8c459SGonglei static void usb_hub_realize(USBDevice *dev, Error **errp) 534f1ae32a1SGerd Hoffmann { 535e81b13adSGonglei USBHubState *s = USB_HUB(dev); 536f1ae32a1SGerd Hoffmann USBHubPort *port; 537f1ae32a1SGerd Hoffmann int i; 538f1ae32a1SGerd Hoffmann 539c24e4aacSGerd Hoffmann if (dev->port->hubcount == 5) { 540f3f8c459SGonglei error_setg(errp, "usb hub chain too deep"); 541f3f8c459SGonglei return; 542c24e4aacSGerd Hoffmann } 543c24e4aacSGerd Hoffmann 5449d55d1adSGerd Hoffmann usb_desc_create_serial(dev); 545f1ae32a1SGerd Hoffmann usb_desc_init(dev); 546f1ae32a1SGerd Hoffmann s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 547f1ae32a1SGerd Hoffmann for (i = 0; i < NUM_PORTS; i++) { 548f1ae32a1SGerd Hoffmann port = &s->ports[i]; 549f1ae32a1SGerd Hoffmann usb_register_port(usb_bus_from_device(dev), 550f1ae32a1SGerd Hoffmann &port->port, s, i, &usb_hub_port_ops, 551f1ae32a1SGerd Hoffmann USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL); 552f1ae32a1SGerd Hoffmann usb_port_location(&port->port, dev->port, i+1); 553f1ae32a1SGerd Hoffmann } 554f1ae32a1SGerd Hoffmann usb_hub_handle_reset(dev); 555f1ae32a1SGerd Hoffmann } 556f1ae32a1SGerd Hoffmann 557f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_hub_port = { 558f1ae32a1SGerd Hoffmann .name = "usb-hub-port", 559f1ae32a1SGerd Hoffmann .version_id = 1, 560f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 561f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 562f1ae32a1SGerd Hoffmann VMSTATE_UINT16(wPortStatus, USBHubPort), 563f1ae32a1SGerd Hoffmann VMSTATE_UINT16(wPortChange, USBHubPort), 564f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 565f1ae32a1SGerd Hoffmann } 566f1ae32a1SGerd Hoffmann }; 567f1ae32a1SGerd Hoffmann 568f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_hub = { 569f1ae32a1SGerd Hoffmann .name = "usb-hub", 570f1ae32a1SGerd Hoffmann .version_id = 1, 571f1ae32a1SGerd Hoffmann .minimum_version_id = 1, 572f1ae32a1SGerd Hoffmann .fields = (VMStateField[]) { 573f1ae32a1SGerd Hoffmann VMSTATE_USB_DEVICE(dev, USBHubState), 574f1ae32a1SGerd Hoffmann VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0, 575f1ae32a1SGerd Hoffmann vmstate_usb_hub_port, USBHubPort), 576f1ae32a1SGerd Hoffmann VMSTATE_END_OF_LIST() 577f1ae32a1SGerd Hoffmann } 578f1ae32a1SGerd Hoffmann }; 579f1ae32a1SGerd Hoffmann 580f1ae32a1SGerd Hoffmann static void usb_hub_class_initfn(ObjectClass *klass, void *data) 581f1ae32a1SGerd Hoffmann { 582f1ae32a1SGerd Hoffmann DeviceClass *dc = DEVICE_CLASS(klass); 583f1ae32a1SGerd Hoffmann USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 584f1ae32a1SGerd Hoffmann 585f3f8c459SGonglei uc->realize = usb_hub_realize; 586f1ae32a1SGerd Hoffmann uc->product_desc = "QEMU USB Hub"; 587f1ae32a1SGerd Hoffmann uc->usb_desc = &desc_hub; 588f1ae32a1SGerd Hoffmann uc->find_device = usb_hub_find_device; 589f1ae32a1SGerd Hoffmann uc->handle_reset = usb_hub_handle_reset; 590f1ae32a1SGerd Hoffmann uc->handle_control = usb_hub_handle_control; 591f1ae32a1SGerd Hoffmann uc->handle_data = usb_hub_handle_data; 592c4fe9700SMarc-André Lureau uc->unrealize = usb_hub_unrealize; 593125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories); 594f1ae32a1SGerd Hoffmann dc->fw_name = "hub"; 595f1ae32a1SGerd Hoffmann dc->vmsd = &vmstate_usb_hub; 596f1ae32a1SGerd Hoffmann } 597f1ae32a1SGerd Hoffmann 5988c43a6f0SAndreas Färber static const TypeInfo hub_info = { 599e81b13adSGonglei .name = TYPE_USB_HUB, 600f1ae32a1SGerd Hoffmann .parent = TYPE_USB_DEVICE, 601f1ae32a1SGerd Hoffmann .instance_size = sizeof(USBHubState), 602f1ae32a1SGerd Hoffmann .class_init = usb_hub_class_initfn, 603f1ae32a1SGerd Hoffmann }; 604f1ae32a1SGerd Hoffmann 605f1ae32a1SGerd Hoffmann static void usb_hub_register_types(void) 606f1ae32a1SGerd Hoffmann { 607f1ae32a1SGerd Hoffmann type_register_static(&hub_info); 608f1ae32a1SGerd Hoffmann } 609f1ae32a1SGerd Hoffmann 610f1ae32a1SGerd Hoffmann type_init(usb_hub_register_types) 611