[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-common.h"
#include "trace.h"
#include "hw/usb.h"
#include "hw/usb/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 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 + (NUM_PORTS + 7) / 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;
    }
    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->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 = DO_UPCAST(USBHubState, dev, 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 = DO_UPCAST(USBHubState, dev, 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:
                port->wPortStatus &= ~PORT_STAT_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 = ((NUM_PORTS + 1 + 7) / 8) + 7;
            for (n = 7; n < limit; n++) {
                data[n] = 0x00;
                var_hub_size++;
            }

            /* fill PortPwrCtrlMask bits */
            limit = limit + ((NUM_PORTS + 7) / 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 = (NUM_PORTS + 1 + 7) / 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_handle_destroy(USBDevice *dev)
{
    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 = DO_UPCAST(USBHubState, dev, 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->handle_destroy = usb_hub_handle_destroy;
    set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
    dc->fw_name = "hub";
    dc->vmsd = &vmstate_usb_hub;
}

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