[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"

#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          = 0xe0,
            .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);
}

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);

    /* 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);
}

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);
    }
}

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);
                }
                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) {
                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 int usb_hub_initfn(USBDevice *dev)
{
    USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
    USBHubPort *port;
    int i;

    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);
    return 0;
}

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