[mirror_qemu.git] / hw / usb / dev-hub.c

/*
 * QEMU USB HUB emulation
 *
 * Copyright (c) 2005 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include "qemu/osdep.h"
#include "qapi/error.h"
#include "qemu-common.h"
#include "trace.h"
#include "hw/usb.h"
#include "desc.h"
#include "qemu/error-report.h"

#define NUM_PORTS 8

typedef struct USBHubPort {
    USBPort port;
    uint16_t wPortStatus;
    uint16_t wPortChange;
} USBHubPort;

typedef struct USBHubState {
    USBDevice dev;
    USBEndpoint *intr;
    USBHubPort ports[NUM_PORTS];
} USBHubState;

#define TYPE_USB_HUB "usb-hub"
#define USB_HUB(obj) OBJECT_CHECK(USBHubState, (obj), TYPE_USB_HUB)

#define ClearHubFeature		(0x2000 | USB_REQ_CLEAR_FEATURE)
#define ClearPortFeature	(0x2300 | USB_REQ_CLEAR_FEATURE)
#define GetHubDescriptor	(0xa000 | USB_REQ_GET_DESCRIPTOR)
#define GetHubStatus		(0xa000 | USB_REQ_GET_STATUS)
#define GetPortStatus		(0xa300 | USB_REQ_GET_STATUS)
#define SetHubFeature		(0x2000 | USB_REQ_SET_FEATURE)
#define SetPortFeature		(0x2300 | USB_REQ_SET_FEATURE)

#define PORT_STAT_CONNECTION	0x0001
#define PORT_STAT_ENABLE	0x0002
#define PORT_STAT_SUSPEND	0x0004
#define PORT_STAT_OVERCURRENT	0x0008
#define PORT_STAT_RESET		0x0010
#define PORT_STAT_POWER		0x0100
#define PORT_STAT_LOW_SPEED	0x0200
#define PORT_STAT_HIGH_SPEED    0x0400
#define PORT_STAT_TEST          0x0800
#define PORT_STAT_INDICATOR     0x1000

#define PORT_STAT_C_CONNECTION	0x0001
#define PORT_STAT_C_ENABLE	0x0002
#define PORT_STAT_C_SUSPEND	0x0004
#define PORT_STAT_C_OVERCURRENT	0x0008
#define PORT_STAT_C_RESET	0x0010

#define PORT_CONNECTION	        0
#define PORT_ENABLE		1
#define PORT_SUSPEND		2
#define PORT_OVERCURRENT	3
#define PORT_RESET		4
#define PORT_POWER		8
#define PORT_LOWSPEED		9
#define PORT_HIGHSPEED		10
#define PORT_C_CONNECTION	16
#define PORT_C_ENABLE		17
#define PORT_C_SUSPEND		18
#define PORT_C_OVERCURRENT	19
#define PORT_C_RESET		20
#define PORT_TEST               21
#define PORT_INDICATOR          22

/* same as Linux kernel root hubs */

enum {
    STR_MANUFACTURER = 1,
    STR_PRODUCT,
    STR_SERIALNUMBER,
};

static const USBDescStrings desc_strings = {
    [STR_MANUFACTURER] = "QEMU",
    [STR_PRODUCT]      = "QEMU USB Hub",
    [STR_SERIALNUMBER] = "314159",
};

static const USBDescIface desc_iface_hub = {
    .bInterfaceNumber              = 0,
    .bNumEndpoints                 = 1,
    .bInterfaceClass               = USB_CLASS_HUB,
    .eps = (USBDescEndpoint[]) {
        {
            .bEndpointAddress      = USB_DIR_IN | 0x01,
            .bmAttributes          = USB_ENDPOINT_XFER_INT,
            .wMaxPacketSize        = 1 + DIV_ROUND_UP(NUM_PORTS, 8),
            .bInterval             = 0xff,
        },
    }
};

static const USBDescDevice desc_device_hub = {
    .bcdUSB                        = 0x0110,
    .bDeviceClass                  = USB_CLASS_HUB,
    .bMaxPacketSize0               = 8,
    .bNumConfigurations            = 1,
    .confs = (USBDescConfig[]) {
        {
            .bNumInterfaces        = 1,
            .bConfigurationValue   = 1,
            .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
                                     USB_CFG_ATT_WAKEUP,
            .nif = 1,
            .ifs = &desc_iface_hub,
        },
    },
};

static const USBDesc desc_hub = {
    .id = {
        .idVendor          = 0x0409,
        .idProduct         = 0x55aa,
        .bcdDevice         = 0x0101,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_hub,
    .str  = desc_strings,
};

static const uint8_t qemu_hub_hub_descriptor[] =
{
	0x00,			/*  u8  bLength; patched in later */
	0x29,			/*  u8  bDescriptorType; Hub-descriptor */
	0x00,			/*  u8  bNbrPorts; (patched later) */
	0x0a,			/* u16  wHubCharacteristics; */
	0x00,			/*   (per-port OC, no power switching) */
	0x01,			/*  u8  bPwrOn2pwrGood; 2ms */
	0x00			/*  u8  bHubContrCurrent; 0 mA */

        /* DeviceRemovable and PortPwrCtrlMask patched in later */
};

static void usb_hub_attach(USBPort *port1)
{
    USBHubState *s = port1->opaque;
    USBHubPort *port = &s->ports[port1->index];

    trace_usb_hub_attach(s->dev.addr, port1->index + 1);
    port->wPortStatus |= PORT_STAT_CONNECTION;
    port->wPortChange |= PORT_STAT_C_CONNECTION;
    if (port->port.dev->speed == USB_SPEED_LOW) {
        port->wPortStatus |= PORT_STAT_LOW_SPEED;
    } else {
        port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
    }
    usb_wakeup(s->intr, 0);
}

static void usb_hub_detach(USBPort *port1)
{
    USBHubState *s = port1->opaque;
    USBHubPort *port = &s->ports[port1->index];

    trace_usb_hub_detach(s->dev.addr, port1->index + 1);
    usb_wakeup(s->intr, 0);

    /* Let upstream know the device on this port is gone */
    s->dev.port->ops->child_detach(s->dev.port, port1->dev);

    port->wPortStatus &= ~PORT_STAT_CONNECTION;
    port->wPortChange |= PORT_STAT_C_CONNECTION;
    if (port->wPortStatus & PORT_STAT_ENABLE) {
        port->wPortStatus &= ~PORT_STAT_ENABLE;
        port->wPortChange |= PORT_STAT_C_ENABLE;
    }
    if (port->wPortStatus & PORT_STAT_SUSPEND) {
        port->wPortStatus &= ~PORT_STAT_SUSPEND;
        port->wPortChange |= PORT_STAT_C_SUSPEND;
    }
    usb_wakeup(s->intr, 0);
}

static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
{
    USBHubState *s = port1->opaque;

    /* Pass along upstream */
    s->dev.port->ops->child_detach(s->dev.port, child);
}

static void usb_hub_wakeup(USBPort *port1)
{
    USBHubState *s = port1->opaque;
    USBHubPort *port = &s->ports[port1->index];

    if (port->wPortStatus & PORT_STAT_SUSPEND) {
        port->wPortStatus &= ~PORT_STAT_SUSPEND;
        port->wPortChange |= PORT_STAT_C_SUSPEND;
        usb_wakeup(s->intr, 0);
    }
}

static void usb_hub_complete(USBPort *port, USBPacket *packet)
{
    USBHubState *s = port->opaque;

    /*
     * Just pass it along upstream for now.
     *
     * If we ever implement usb 2.0 split transactions this will
     * become a little more complicated ...
     *
     * Can't use usb_packet_complete() here because packet->owner is
     * cleared already, go call the ->complete() callback directly
     * instead.
     */
    s->dev.port->ops->complete(s->dev.port, packet);
}

static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr)
{
    USBHubState *s = USB_HUB(dev);
    USBHubPort *port;
    USBDevice *downstream;
    int i;

    for (i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        if (!(port->wPortStatus & PORT_STAT_ENABLE)) {
            continue;
        }
        downstream = usb_find_device(&port->port, addr);
        if (downstream != NULL) {
            return downstream;
        }
    }
    return NULL;
}

static void usb_hub_handle_reset(USBDevice *dev)
{
    USBHubState *s = USB_HUB(dev);
    USBHubPort *port;
    int i;

    trace_usb_hub_reset(s->dev.addr);
    for (i = 0; i < NUM_PORTS; i++) {
        port = s->ports + i;
        port->wPortStatus = PORT_STAT_POWER;
        port->wPortChange = 0;
        if (port->port.dev && port->port.dev->attached) {
            port->wPortStatus |= PORT_STAT_CONNECTION;
            port->wPortChange |= PORT_STAT_C_CONNECTION;
            if (port->port.dev->speed == USB_SPEED_LOW) {
                port->wPortStatus |= PORT_STAT_LOW_SPEED;
            }
        }
    }
}

static const char *feature_name(int feature)
{
    static const char *name[] = {
        [PORT_CONNECTION]    = "connection",
        [PORT_ENABLE]        = "enable",
        [PORT_SUSPEND]       = "suspend",
        [PORT_OVERCURRENT]   = "overcurrent",
        [PORT_RESET]         = "reset",
        [PORT_POWER]         = "power",
        [PORT_LOWSPEED]      = "lowspeed",
        [PORT_HIGHSPEED]     = "highspeed",
        [PORT_C_CONNECTION]  = "change connection",
        [PORT_C_ENABLE]      = "change enable",
        [PORT_C_SUSPEND]     = "change suspend",
        [PORT_C_OVERCURRENT] = "change overcurrent",
        [PORT_C_RESET]       = "change reset",
        [PORT_TEST]          = "test",
        [PORT_INDICATOR]     = "indicator",
    };
    if (feature < 0 || feature >= ARRAY_SIZE(name)) {
        return "?";
    }
    return name[feature] ?: "?";
}

static void usb_hub_handle_control(USBDevice *dev, USBPacket *p,
               int request, int value, int index, int length, uint8_t *data)
{
    USBHubState *s = (USBHubState *)dev;
    int ret;

    trace_usb_hub_control(s->dev.addr, request, value, index, length);

    ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
    if (ret >= 0) {
        return;
    }

    switch(request) {
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == 0 && index != 0x81) { /* clear ep halt */
            goto fail;
        }
        break;
        /* usb specific requests */
    case GetHubStatus:
        data[0] = 0;
        data[1] = 0;
        data[2] = 0;
        data[3] = 0;
        p->actual_length = 4;
        break;
    case GetPortStatus:
        {
            unsigned int n = index - 1;
            USBHubPort *port;
            if (n >= NUM_PORTS) {
                goto fail;
            }
            port = &s->ports[n];
            trace_usb_hub_get_port_status(s->dev.addr, index,
                                          port->wPortStatus,
                                          port->wPortChange);
            data[0] = port->wPortStatus;
            data[1] = port->wPortStatus >> 8;
            data[2] = port->wPortChange;
            data[3] = port->wPortChange >> 8;
            p->actual_length = 4;
        }
        break;
    case SetHubFeature:
    case ClearHubFeature:
        if (value != 0 && value != 1) {
            goto fail;
        }
        break;
    case SetPortFeature:
        {
            unsigned int n = index - 1;
            USBHubPort *port;
            USBDevice *dev;

            trace_usb_hub_set_port_feature(s->dev.addr, index,
                                           feature_name(value));

            if (n >= NUM_PORTS) {
                goto fail;
            }
            port = &s->ports[n];
            dev = port->port.dev;
            switch(value) {
            case PORT_SUSPEND:
                port->wPortStatus |= PORT_STAT_SUSPEND;
                break;
            case PORT_RESET:
                if (dev && dev->attached) {
                    usb_device_reset(dev);
                    port->wPortChange |= PORT_STAT_C_RESET;
                    /* set enable bit */
                    port->wPortStatus |= PORT_STAT_ENABLE;
                    usb_wakeup(s->intr, 0);
                }
                break;
            case PORT_POWER:
                break;
            default:
                goto fail;
            }
        }
        break;
    case ClearPortFeature:
        {
            unsigned int n = index - 1;
            USBHubPort *port;

            trace_usb_hub_clear_port_feature(s->dev.addr, index,
                                             feature_name(value));

            if (n >= NUM_PORTS) {
                goto fail;
            }
            port = &s->ports[n];
            switch(value) {
            case PORT_ENABLE:
                port->wPortStatus &= ~PORT_STAT_ENABLE;
                break;
            case PORT_C_ENABLE:
                port->wPortChange &= ~PORT_STAT_C_ENABLE;
                break;
            case PORT_SUSPEND:
                if (port->wPortStatus & PORT_STAT_SUSPEND) {
                    port->wPortStatus &= ~PORT_STAT_SUSPEND;

                    /*
                     * USB Spec rev2.0 11.24.2.7.2.3 C_PORT_SUSPEND
                     * "This bit is set on the following transitions:
                     *  - On transition from the Resuming state to the
                     *    SendEOP [sic] state"
                     *
                     * Note that this includes both remote wake-up and
                     * explicit ClearPortFeature(PORT_SUSPEND).
                     */
                    port->wPortChange |= PORT_STAT_C_SUSPEND;
                }
                break;
            case PORT_C_SUSPEND:
                port->wPortChange &= ~PORT_STAT_C_SUSPEND;
                break;
            case PORT_C_CONNECTION:
                port->wPortChange &= ~PORT_STAT_C_CONNECTION;
                break;
            case PORT_C_OVERCURRENT:
                port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
                break;
            case PORT_C_RESET:
                port->wPortChange &= ~PORT_STAT_C_RESET;
                break;
            default:
                goto fail;
            }
        }
        break;
    case GetHubDescriptor:
        {
            unsigned int n, limit, var_hub_size = 0;
            memcpy(data, qemu_hub_hub_descriptor,
                   sizeof(qemu_hub_hub_descriptor));
            data[2] = NUM_PORTS;

            /* fill DeviceRemovable bits */
            limit = DIV_ROUND_UP(NUM_PORTS + 1, 8) + 7;
            for (n = 7; n < limit; n++) {
                data[n] = 0x00;
                var_hub_size++;
            }

            /* fill PortPwrCtrlMask bits */
            limit = limit + DIV_ROUND_UP(NUM_PORTS, 8);
            for (;n < limit; n++) {
                data[n] = 0xff;
                var_hub_size++;
            }

            p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
            data[0] = p->actual_length;
            break;
        }
    default:
    fail:
        p->status = USB_RET_STALL;
        break;
    }
}

static void usb_hub_handle_data(USBDevice *dev, USBPacket *p)
{
    USBHubState *s = (USBHubState *)dev;

    switch(p->pid) {
    case USB_TOKEN_IN:
        if (p->ep->nr == 1) {
            USBHubPort *port;
            unsigned int status;
            uint8_t buf[4];
            int i, n;
            n = DIV_ROUND_UP(NUM_PORTS + 1, 8);
            if (p->iov.size == 1) { /* FreeBSD workaround */
                n = 1;
            } else if (n > p->iov.size) {
                p->status = USB_RET_BABBLE;
                return;
            }
            status = 0;
            for(i = 0; i < NUM_PORTS; i++) {
                port = &s->ports[i];
                if (port->wPortChange)
                    status |= (1 << (i + 1));
            }
            if (status != 0) {
                trace_usb_hub_status_report(s->dev.addr, status);
                for(i = 0; i < n; i++) {
                    buf[i] = status >> (8 * i);
                }
                usb_packet_copy(p, buf, n);
            } else {
                p->status = USB_RET_NAK; /* usb11 11.13.1 */
            }
        } else {
            goto fail;
        }
        break;
    case USB_TOKEN_OUT:
    default:
    fail:
        p->status = USB_RET_STALL;
        break;
    }
}

static void usb_hub_unrealize(USBDevice *dev, Error **errp)
{
    USBHubState *s = (USBHubState *)dev;
    int i;

    for (i = 0; i < NUM_PORTS; i++) {
        usb_unregister_port(usb_bus_from_device(dev),
                            &s->ports[i].port);
    }
}

static USBPortOps usb_hub_port_ops = {
    .attach = usb_hub_attach,
    .detach = usb_hub_detach,
    .child_detach = usb_hub_child_detach,
    .wakeup = usb_hub_wakeup,
    .complete = usb_hub_complete,
};

static void usb_hub_realize(USBDevice *dev, Error **errp)
{
    USBHubState *s = USB_HUB(dev);
    USBHubPort *port;
    int i;

    if (dev->port->hubcount == 5) {
        error_setg(errp, "usb hub chain too deep");
        return;
    }

    usb_desc_create_serial(dev);
    usb_desc_init(dev);
    s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
    for (i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        usb_register_port(usb_bus_from_device(dev),
                          &port->port, s, i, &usb_hub_port_ops,
                          USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
        usb_port_location(&port->port, dev->port, i+1);
    }
    usb_hub_handle_reset(dev);
}

static const VMStateDescription vmstate_usb_hub_port = {
    .name = "usb-hub-port",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField[]) {
        VMSTATE_UINT16(wPortStatus, USBHubPort),
        VMSTATE_UINT16(wPortChange, USBHubPort),
        VMSTATE_END_OF_LIST()
    }
};

static const VMStateDescription vmstate_usb_hub = {
    .name = "usb-hub",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField[]) {
        VMSTATE_USB_DEVICE(dev, USBHubState),
        VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
                             vmstate_usb_hub_port, USBHubPort),
        VMSTATE_END_OF_LIST()
    }
};

static void usb_hub_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->realize        = usb_hub_realize;
    uc->product_desc   = "QEMU USB Hub";
    uc->usb_desc       = &desc_hub;
    uc->find_device    = usb_hub_find_device;
    uc->handle_reset   = usb_hub_handle_reset;
    uc->handle_control = usb_hub_handle_control;
    uc->handle_data    = usb_hub_handle_data;
    uc->unrealize      = usb_hub_unrealize;
    set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
    dc->fw_name = "hub";
    dc->vmsd = &vmstate_usb_hub;
}

static const TypeInfo hub_info = {
    .name          = TYPE_USB_HUB,
    .parent        = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBHubState),
    .class_init    = usb_hub_class_initfn,
};

static void usb_hub_register_types(void)
{
    type_register_static(&hub_info);
}

type_init(usb_hub_register_types)
Commit	Line	Data
72899afc FB	1	/*
	2	* QEMU USB HUB emulation
	3	*
	4	* Copyright (c) 2005 Fabrice Bellard
5fafdf24	5	*
72899afc FB	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	*/
e532b2e0	24	#include "qemu/osdep.h"
da34e65c	25	#include "qapi/error.h"
87ecb68b	26	#include "qemu-common.h"
529f8f9f	27	#include "trace.h"
f1ae32a1	28	#include "hw/usb.h"
463581a8	29	#include "desc.h"
c24e4aac	30	#include "qemu/error-report.h"
72899afc	31
062651c7	32	#define NUM_PORTS 8
72899afc FB	33
	34	typedef struct USBHubPort {
	35	USBPort port;
	36	uint16_t wPortStatus;
	37	uint16_t wPortChange;
	38	} USBHubPort;
	39
	40	typedef struct USBHubState {
	41	USBDevice dev;
7567b51f	42	USBEndpoint *intr;
062651c7	43	USBHubPort ports[NUM_PORTS];
72899afc FB	44	} USBHubState;
72899afc FB	45
e81b13ad GA	46	#define TYPE_USB_HUB "usb-hub"
	47	#define USB_HUB(obj) OBJECT_CHECK(USBHubState, (obj), TYPE_USB_HUB)
	48
72899afc FB	49	#define ClearHubFeature (0x2000 \| USB_REQ_CLEAR_FEATURE)
	50	#define ClearPortFeature (0x2300 \| USB_REQ_CLEAR_FEATURE)
	51	#define GetHubDescriptor (0xa000 \| USB_REQ_GET_DESCRIPTOR)
	52	#define GetHubStatus (0xa000 \| USB_REQ_GET_STATUS)
	53	#define GetPortStatus (0xa300 \| USB_REQ_GET_STATUS)
	54	#define SetHubFeature (0x2000 \| USB_REQ_SET_FEATURE)
	55	#define SetPortFeature (0x2300 \| USB_REQ_SET_FEATURE)
	56
	57	#define PORT_STAT_CONNECTION 0x0001
	58	#define PORT_STAT_ENABLE 0x0002
	59	#define PORT_STAT_SUSPEND 0x0004
	60	#define PORT_STAT_OVERCURRENT 0x0008
	61	#define PORT_STAT_RESET 0x0010
	62	#define PORT_STAT_POWER 0x0100
	63	#define PORT_STAT_LOW_SPEED 0x0200
	64	#define PORT_STAT_HIGH_SPEED 0x0400
	65	#define PORT_STAT_TEST 0x0800
	66	#define PORT_STAT_INDICATOR 0x1000
	67
	68	#define PORT_STAT_C_CONNECTION 0x0001
	69	#define PORT_STAT_C_ENABLE 0x0002
	70	#define PORT_STAT_C_SUSPEND 0x0004
	71	#define PORT_STAT_C_OVERCURRENT 0x0008
	72	#define PORT_STAT_C_RESET 0x0010
	73
	74	#define PORT_CONNECTION 0
	75	#define PORT_ENABLE 1
	76	#define PORT_SUSPEND 2
	77	#define PORT_OVERCURRENT 3
	78	#define PORT_RESET 4
	79	#define PORT_POWER 8
	80	#define PORT_LOWSPEED 9
	81	#define PORT_HIGHSPEED 10
	82	#define PORT_C_CONNECTION 16
	83	#define PORT_C_ENABLE 17
	84	#define PORT_C_SUSPEND 18
	85	#define PORT_C_OVERCURRENT 19
	86	#define PORT_C_RESET 20
	87	#define PORT_TEST 21
	88	#define PORT_INDICATOR 22
	89
	90	/* same as Linux kernel root hubs */
	91
062651c7 GH	92	enum {
	93	STR_MANUFACTURER = 1,
	94	STR_PRODUCT,
	95	STR_SERIALNUMBER,
	96	};
	97
	98	static const USBDescStrings desc_strings = {
93bfef4c	99	[STR_MANUFACTURER] = "QEMU",
062651c7 GH	100	[STR_PRODUCT] = "QEMU USB Hub",
	101	[STR_SERIALNUMBER] = "314159",
	102	};
	103
	104	static const USBDescIface desc_iface_hub = {
	105	.bInterfaceNumber = 0,
	106	.bNumEndpoints = 1,
	107	.bInterfaceClass = USB_CLASS_HUB,
	108	.eps = (USBDescEndpoint[]) {
	109	{
	110	.bEndpointAddress = USB_DIR_IN \| 0x01,
	111	.bmAttributes = USB_ENDPOINT_XFER_INT,
54ac85ef	112	.wMaxPacketSize = 1 + DIV_ROUND_UP(NUM_PORTS, 8),
062651c7 GH	113	.bInterval = 0xff,
	114	},
	115	}
	116	};
	117
	118	static const USBDescDevice desc_device_hub = {
	119	.bcdUSB = 0x0110,
	120	.bDeviceClass = USB_CLASS_HUB,
	121	.bMaxPacketSize0 = 8,
	122	.bNumConfigurations = 1,
	123	.confs = (USBDescConfig[]) {
	124	{
	125	.bNumInterfaces = 1,
	126	.bConfigurationValue = 1,
bd93976a PK	127	.bmAttributes = USB_CFG_ATT_ONE \| USB_CFG_ATT_SELFPOWER \|
bd93976a PK	128	USB_CFG_ATT_WAKEUP,
add75088	129	.nif = 1,
062651c7 GH	130	.ifs = &desc_iface_hub,
	131	},
	132	},
	133	};
	134
	135	static const USBDesc desc_hub = {
	136	.id = {
db80358a RT	137	.idVendor = 0x0409,
db80358a RT	138	.idProduct = 0x55aa,
062651c7 GH	139	.bcdDevice = 0x0101,
	140	.iManufacturer = STR_MANUFACTURER,
	141	.iProduct = STR_PRODUCT,
	142	.iSerialNumber = STR_SERIALNUMBER,
	143	},
	144	.full = &desc_device_hub,
	145	.str = desc_strings,
	146	};
	147
72899afc FB	148	static const uint8_t qemu_hub_hub_descriptor[] =
72899afc FB	149	{
67f36560	150	0x00, /* u8 bLength; patched in later */
72899afc FB	151	0x29, /* u8 bDescriptorType; Hub-descriptor */
	152	0x00, /* u8 bNbrPorts; (patched later) */
	153	0x0a, /* u16 wHubCharacteristics; */
	154	0x00, /* (per-port OC, no power switching) */
	155	0x01, /* u8 bPwrOn2pwrGood; 2ms */
985d1742 FB	156	0x00 /* u8 bHubContrCurrent; 0 mA */
	157
	158	/* DeviceRemovable and PortPwrCtrlMask patched in later */
72899afc FB	159	};
72899afc FB	160
618c169b	161	static void usb_hub_attach(USBPort *port1)
72899afc FB	162	{
	163	USBHubState *s = port1->opaque;
	164	USBHubPort *port = &s->ports[port1->index];
3b46e624	165
529f8f9f	166	trace_usb_hub_attach(s->dev.addr, port1->index + 1);
618c169b GH	167	port->wPortStatus \|= PORT_STAT_CONNECTION;
	168	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	169	if (port->port.dev->speed == USB_SPEED_LOW) {
	170	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
72899afc	171	} else {
618c169b GH	172	port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
618c169b GH	173	}
8550a02d	174	usb_wakeup(s->intr, 0);
618c169b GH	175	}
	176
	177	static void usb_hub_detach(USBPort *port1)
	178	{
	179	USBHubState *s = port1->opaque;
	180	USBHubPort *port = &s->ports[port1->index];
	181
529f8f9f	182	trace_usb_hub_detach(s->dev.addr, port1->index + 1);
8550a02d	183	usb_wakeup(s->intr, 0);
be35cbbc	184
4706ab6c HG	185	/* Let upstream know the device on this port is gone */
	186	s->dev.port->ops->child_detach(s->dev.port, port1->dev);
	187
618c169b GH	188	port->wPortStatus &= ~PORT_STAT_CONNECTION;
	189	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	190	if (port->wPortStatus & PORT_STAT_ENABLE) {
	191	port->wPortStatus &= ~PORT_STAT_ENABLE;
	192	port->wPortChange \|= PORT_STAT_C_ENABLE;
72899afc	193	}
3e9191ac GH	194	if (port->wPortStatus & PORT_STAT_SUSPEND) {
	195	port->wPortStatus &= ~PORT_STAT_SUSPEND;
	196	port->wPortChange \|= PORT_STAT_C_SUSPEND;
	197	}
8550a02d	198	usb_wakeup(s->intr, 0);
72899afc FB	199	}
72899afc FB	200
4706ab6c HG	201	static void usb_hub_child_detach(USBPort port1, USBDevice child)
	202	{
	203	USBHubState *s = port1->opaque;
	204
	205	/* Pass along upstream */
	206	s->dev.port->ops->child_detach(s->dev.port, child);
	207	}
	208
d47e59b8	209	static void usb_hub_wakeup(USBPort *port1)
34239c7b	210	{
d47e59b8 HG	211	USBHubState *s = port1->opaque;
d47e59b8 HG	212	USBHubPort *port = &s->ports[port1->index];
34239c7b GH	213
34239c7b GH	214	if (port->wPortStatus & PORT_STAT_SUSPEND) {
66849dcf	215	port->wPortStatus &= ~PORT_STAT_SUSPEND;
34239c7b	216	port->wPortChange \|= PORT_STAT_C_SUSPEND;
8550a02d	217	usb_wakeup(s->intr, 0);
34239c7b GH	218	}
	219	}
	220
d47e59b8	221	static void usb_hub_complete(USBPort port, USBPacket packet)
13a9a0d3	222	{
d47e59b8	223	USBHubState *s = port->opaque;
13a9a0d3 GH	224
	225	/*
	226	* Just pass it along upstream for now.
	227	*
80cf7cf7	228	* If we ever implement usb 2.0 split transactions this will
13a9a0d3	229	* become a little more complicated ...
80cf7cf7 GH	230	*
	231	* Can't use usb_packet_complete() here because packet->owner is
	232	* cleared already, go call the ->complete() callback directly
	233	* instead.
13a9a0d3	234	*/
80cf7cf7	235	s->dev.port->ops->complete(s->dev.port, packet);
13a9a0d3 GH	236	}
13a9a0d3 GH	237
06c75088 GH	238	static USBDevice usb_hub_find_device(USBDevice dev, uint8_t addr)
06c75088 GH	239	{
e81b13ad	240	USBHubState *s = USB_HUB(dev);
06c75088 GH	241	USBHubPort *port;
	242	USBDevice *downstream;
	243	int i;
	244
	245	for (i = 0; i < NUM_PORTS; i++) {
	246	port = &s->ports[i];
	247	if (!(port->wPortStatus & PORT_STAT_ENABLE)) {
	248	continue;
	249	}
	250	downstream = usb_find_device(&port->port, addr);
	251	if (downstream != NULL) {
	252	return downstream;
	253	}
	254	}
	255	return NULL;
	256	}
	257
059809e4	258	static void usb_hub_handle_reset(USBDevice *dev)
72899afc	259	{
e81b13ad	260	USBHubState *s = USB_HUB(dev);
20d183b6 GH	261	USBHubPort *port;
	262	int i;
	263
529f8f9f	264	trace_usb_hub_reset(s->dev.addr);
20d183b6 GH	265	for (i = 0; i < NUM_PORTS; i++) {
	266	port = s->ports + i;
	267	port->wPortStatus = PORT_STAT_POWER;
	268	port->wPortChange = 0;
	269	if (port->port.dev && port->port.dev->attached) {
	270	port->wPortStatus \|= PORT_STAT_CONNECTION;
	271	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	272	if (port->port.dev->speed == USB_SPEED_LOW) {
	273	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
	274	}
	275	}
	276	}
72899afc FB	277	}
72899afc FB	278
529f8f9f GH	279	static const char *feature_name(int feature)
	280	{
	281	static const char *name[] = {
	282	[PORT_CONNECTION] = "connection",
	283	[PORT_ENABLE] = "enable",
	284	[PORT_SUSPEND] = "suspend",
	285	[PORT_OVERCURRENT] = "overcurrent",
	286	[PORT_RESET] = "reset",
	287	[PORT_POWER] = "power",
	288	[PORT_LOWSPEED] = "lowspeed",
	289	[PORT_HIGHSPEED] = "highspeed",
	290	[PORT_C_CONNECTION] = "change connection",
	291	[PORT_C_ENABLE] = "change enable",
	292	[PORT_C_SUSPEND] = "change suspend",
	293	[PORT_C_OVERCURRENT] = "change overcurrent",
	294	[PORT_C_RESET] = "change reset",
	295	[PORT_TEST] = "test",
	296	[PORT_INDICATOR] = "indicator",
	297	};
	298	if (feature < 0 \|\| feature >= ARRAY_SIZE(name)) {
	299	return "?";
	300	}
	301	return name[feature] ?: "?";
	302	}
	303
9a77a0f5	304	static void usb_hub_handle_control(USBDevice dev, USBPacket p,
007fd62f	305	int request, int value, int index, int length, uint8_t *data)
72899afc FB	306	{
	307	USBHubState s = (USBHubState )dev;
	308	int ret;
	309
529f8f9f GH	310	trace_usb_hub_control(s->dev.addr, request, value, index, length);
529f8f9f GH	311
007fd62f	312	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
062651c7	313	if (ret >= 0) {
9a77a0f5	314	return;
062651c7 GH	315	}
062651c7 GH	316
72899afc	317	switch(request) {
985d1742 FB	318	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
	319	if (value == 0 && index != 0x81) { /* clear ep halt */
	320	goto fail;
	321	}
985d1742	322	break;
72899afc FB	323	/* usb specific requests */
	324	case GetHubStatus:
	325	data[0] = 0;
	326	data[1] = 0;
	327	data[2] = 0;
	328	data[3] = 0;
9a77a0f5	329	p->actual_length = 4;
72899afc FB	330	break;
	331	case GetPortStatus:
	332	{
	333	unsigned int n = index - 1;
	334	USBHubPort *port;
062651c7	335	if (n >= NUM_PORTS) {
72899afc	336	goto fail;
062651c7	337	}
72899afc	338	port = &s->ports[n];
529f8f9f GH	339	trace_usb_hub_get_port_status(s->dev.addr, index,
	340	port->wPortStatus,
	341	port->wPortChange);
72899afc FB	342	data[0] = port->wPortStatus;
	343	data[1] = port->wPortStatus >> 8;
	344	data[2] = port->wPortChange;
	345	data[3] = port->wPortChange >> 8;
9a77a0f5	346	p->actual_length = 4;
72899afc FB	347	}
	348	break;
	349	case SetHubFeature:
	350	case ClearHubFeature:
9a77a0f5	351	if (value != 0 && value != 1) {
72899afc FB	352	goto fail;
72899afc FB	353	}
72899afc FB	354	break;
	355	case SetPortFeature:
	356	{
	357	unsigned int n = index - 1;
	358	USBHubPort *port;
	359	USBDevice *dev;
529f8f9f GH	360
	361	trace_usb_hub_set_port_feature(s->dev.addr, index,
	362	feature_name(value));
	363
062651c7	364	if (n >= NUM_PORTS) {
72899afc	365	goto fail;
062651c7	366	}
72899afc FB	367	port = &s->ports[n];
	368	dev = port->port.dev;
	369	switch(value) {
	370	case PORT_SUSPEND:
	371	port->wPortStatus \|= PORT_STAT_SUSPEND;
	372	break;
	373	case PORT_RESET:
3393bc10	374	if (dev && dev->attached) {
d28f4e2d	375	usb_device_reset(dev);
72899afc FB	376	port->wPortChange \|= PORT_STAT_C_RESET;
72899afc FB	377	/* set enable bit */
72899afc	378	port->wPortStatus \|= PORT_STAT_ENABLE;
8550a02d	379	usb_wakeup(s->intr, 0);
72899afc FB	380	}
	381	break;
	382	case PORT_POWER:
	383	break;
	384	default:
	385	goto fail;
	386	}
72899afc FB	387	}
	388	break;
	389	case ClearPortFeature:
	390	{
	391	unsigned int n = index - 1;
	392	USBHubPort *port;
d4c4e6fd	393
529f8f9f GH	394	trace_usb_hub_clear_port_feature(s->dev.addr, index,
	395	feature_name(value));
	396
062651c7	397	if (n >= NUM_PORTS) {
72899afc	398	goto fail;
062651c7	399	}
72899afc	400	port = &s->ports[n];
72899afc FB	401	switch(value) {
	402	case PORT_ENABLE:
	403	port->wPortStatus &= ~PORT_STAT_ENABLE;
	404	break;
	405	case PORT_C_ENABLE:
	406	port->wPortChange &= ~PORT_STAT_C_ENABLE;
	407	break;
	408	case PORT_SUSPEND:
6361bbc7 LP	409	if (port->wPortStatus & PORT_STAT_SUSPEND) {
	410	port->wPortStatus &= ~PORT_STAT_SUSPEND;
	411
	412	/*
	413	* USB Spec rev2.0 11.24.2.7.2.3 C_PORT_SUSPEND
	414	* "This bit is set on the following transitions:
	415	* - On transition from the Resuming state to the
	416	* SendEOP [sic] state"
	417	*
	418	* Note that this includes both remote wake-up and
	419	* explicit ClearPortFeature(PORT_SUSPEND).
	420	*/
	421	port->wPortChange \|= PORT_STAT_C_SUSPEND;
	422	}
72899afc FB	423	break;
	424	case PORT_C_SUSPEND:
	425	port->wPortChange &= ~PORT_STAT_C_SUSPEND;
	426	break;
	427	case PORT_C_CONNECTION:
	428	port->wPortChange &= ~PORT_STAT_C_CONNECTION;
	429	break;
	430	case PORT_C_OVERCURRENT:
	431	port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
	432	break;
	433	case PORT_C_RESET:
	434	port->wPortChange &= ~PORT_STAT_C_RESET;
	435	break;
	436	default:
	437	goto fail;
	438	}
72899afc FB	439	}
	440	break;
	441	case GetHubDescriptor:
985d1742 FB	442	{
985d1742 FB	443	unsigned int n, limit, var_hub_size = 0;
5fafdf24	444	memcpy(data, qemu_hub_hub_descriptor,
985d1742	445	sizeof(qemu_hub_hub_descriptor));
062651c7	446	data[2] = NUM_PORTS;
985d1742 FB	447
985d1742 FB	448	/* fill DeviceRemovable bits */
54ac85ef	449	limit = DIV_ROUND_UP(NUM_PORTS + 1, 8) + 7;
985d1742 FB	450	for (n = 7; n < limit; n++) {
	451	data[n] = 0x00;
	452	var_hub_size++;
	453	}
	454
	455	/* fill PortPwrCtrlMask bits */
54ac85ef	456	limit = limit + DIV_ROUND_UP(NUM_PORTS, 8);
985d1742 FB	457	for (;n < limit; n++) {
	458	data[n] = 0xff;
	459	var_hub_size++;
	460	}
	461
9a77a0f5 HG	462	p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
9a77a0f5 HG	463	data[0] = p->actual_length;
985d1742 FB	464	break;
985d1742 FB	465	}
72899afc FB	466	default:
72899afc FB	467	fail:
9a77a0f5	468	p->status = USB_RET_STALL;
72899afc FB	469	break;
72899afc FB	470	}
72899afc FB	471	}
72899afc FB	472
9a77a0f5	473	static void usb_hub_handle_data(USBDevice dev, USBPacket p)
72899afc FB	474	{
72899afc FB	475	USBHubState s = (USBHubState )dev;
72899afc	476
4d611c9a	477	switch(p->pid) {
72899afc	478	case USB_TOKEN_IN:
079d0b7f	479	if (p->ep->nr == 1) {
72899afc FB	480	USBHubPort *port;
72899afc FB	481	unsigned int status;
4f4321c1	482	uint8_t buf[4];
72899afc	483	int i, n;
54ac85ef	484	n = DIV_ROUND_UP(NUM_PORTS + 1, 8);
4f4321c1	485	if (p->iov.size == 1) { /* FreeBSD workaround */
985d1742	486	n = 1;
4f4321c1	487	} else if (n > p->iov.size) {
9a77a0f5 HG	488	p->status = USB_RET_BABBLE;
9a77a0f5 HG	489	return;
985d1742	490	}
72899afc	491	status = 0;
062651c7	492	for(i = 0; i < NUM_PORTS; i++) {
72899afc	493	port = &s->ports[i];
bdebd6ee	494	if (port->wPortChange)
72899afc FB	495	status \|= (1 << (i + 1));
	496	}
	497	if (status != 0) {
b8cbc137	498	trace_usb_hub_status_report(s->dev.addr, status);
72899afc	499	for(i = 0; i < n; i++) {
4f4321c1	500	buf[i] = status >> (8 * i);
72899afc	501	}
4f4321c1	502	usb_packet_copy(p, buf, n);
72899afc	503	} else {
9a77a0f5	504	p->status = USB_RET_NAK; /* usb11 11.13.1 */
72899afc FB	505	}
	506	} else {
	507	goto fail;
	508	}
	509	break;
	510	case USB_TOKEN_OUT:
	511	default:
	512	fail:
9a77a0f5	513	p->status = USB_RET_STALL;
72899afc FB	514	break;
72899afc FB	515	}
72899afc FB	516	}
72899afc FB	517
c4fe9700	518	static void usb_hub_unrealize(USBDevice dev, Error *errp)
059809e4 FB	519	{
059809e4 FB	520	USBHubState s = (USBHubState )dev;
a8e662b5	521	int i;
059809e4	522
062651c7	523	for (i = 0; i < NUM_PORTS; i++) {
a8e662b5 GH	524	usb_unregister_port(usb_bus_from_device(dev),
	525	&s->ports[i].port);
	526	}
059809e4 FB	527	}
059809e4 FB	528
0d86d2be GH	529	static USBPortOps usb_hub_port_ops = {
0d86d2be GH	530	.attach = usb_hub_attach,
618c169b	531	.detach = usb_hub_detach,
4706ab6c	532	.child_detach = usb_hub_child_detach,
34239c7b	533	.wakeup = usb_hub_wakeup,
13a9a0d3	534	.complete = usb_hub_complete,
0d86d2be GH	535	};
0d86d2be GH	536
f3f8c459	537	static void usb_hub_realize(USBDevice dev, Error *errp)
72899afc	538	{
e81b13ad	539	USBHubState *s = USB_HUB(dev);
72899afc FB	540	USBHubPort *port;
	541	int i;
	542
c24e4aac	543	if (dev->port->hubcount == 5) {
f3f8c459 GA	544	error_setg(errp, "usb hub chain too deep");
f3f8c459 GA	545	return;
c24e4aac GH	546	}
c24e4aac GH	547
9d55d1ad	548	usb_desc_create_serial(dev);
a980a065	549	usb_desc_init(dev);
7567b51f	550	s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
062651c7	551	for (i = 0; i < NUM_PORTS; i++) {
72899afc	552	port = &s->ports[i];
a5d2f727	553	usb_register_port(usb_bus_from_device(dev),
ace1318b	554	&port->port, s, i, &usb_hub_port_ops,
843d4e0c	555	USB_SPEED_MASK_LOW \| USB_SPEED_MASK_FULL);
891fb2cd	556	usb_port_location(&port->port, dev->port, i+1);
72899afc	557	}
20d183b6	558	usb_hub_handle_reset(dev);
806b6024 GH	559	}
806b6024 GH	560
d1550090 GH	561	static const VMStateDescription vmstate_usb_hub_port = {
	562	.name = "usb-hub-port",
	563	.version_id = 1,
	564	.minimum_version_id = 1,
6e3d652a	565	.fields = (VMStateField[]) {
d1550090 GH	566	VMSTATE_UINT16(wPortStatus, USBHubPort),
	567	VMSTATE_UINT16(wPortChange, USBHubPort),
	568	VMSTATE_END_OF_LIST()
	569	}
	570	};
	571
	572	static const VMStateDescription vmstate_usb_hub = {
	573	.name = "usb-hub",
	574	.version_id = 1,
	575	.minimum_version_id = 1,
6e3d652a	576	.fields = (VMStateField[]) {
d1550090 GH	577	VMSTATE_USB_DEVICE(dev, USBHubState),
	578	VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
	579	vmstate_usb_hub_port, USBHubPort),
	580	VMSTATE_END_OF_LIST()
	581	}
	582	};
	583
39bffca2	584	static void usb_hub_class_initfn(ObjectClass klass, void data)
62aed765	585	{
39bffca2	586	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	587	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765 AL	588
f3f8c459	589	uc->realize = usb_hub_realize;
62aed765 AL	590	uc->product_desc = "QEMU USB Hub";
62aed765 AL	591	uc->usb_desc = &desc_hub;
06c75088	592	uc->find_device = usb_hub_find_device;
62aed765 AL	593	uc->handle_reset = usb_hub_handle_reset;
	594	uc->handle_control = usb_hub_handle_control;
	595	uc->handle_data = usb_hub_handle_data;
c4fe9700	596	uc->unrealize = usb_hub_unrealize;
125ee0ed	597	set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
39bffca2 AL	598	dc->fw_name = "hub";
39bffca2 AL	599	dc->vmsd = &vmstate_usb_hub;
62aed765 AL	600	}
62aed765 AL	601
8c43a6f0	602	static const TypeInfo hub_info = {
e81b13ad	603	.name = TYPE_USB_HUB,
39bffca2 AL	604	.parent = TYPE_USB_DEVICE,
	605	.instance_size = sizeof(USBHubState),
	606	.class_init = usb_hub_class_initfn,
806b6024 GH	607	};
806b6024 GH	608
83f7d43a	609	static void usb_hub_register_types(void)
806b6024	610	{
39bffca2	611	type_register_static(&hub_info);
72899afc	612	}
83f7d43a AF	613
83f7d43a AF	614	type_init(usb_hub_register_types)