[qemu.git] / hw / usb-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 "usb.h"
#include "usb-desc.h"

//#define DEBUG

#define NUM_PORTS 8

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

typedef struct USBHubState {
    USBDevice dev;
    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 " QEMU_VERSION,
    [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];

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

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

    usb_wakeup(&s->dev);

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

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

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

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

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

    switch(request) {
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == 0 && index != 0x81) { /* clear ep halt */
            goto fail;
        }
        ret = 0;
        break;
        /* usb specific requests */
    case GetHubStatus:
        data[0] = 0;
        data[1] = 0;
        data[2] = 0;
        data[3] = 0;
        ret = 4;
        break;
    case GetPortStatus:
        {
            unsigned int n = index - 1;
            USBHubPort *port;
            if (n >= NUM_PORTS) {
                goto fail;
            }
            port = &s->ports[n];
            data[0] = port->wPortStatus;
            data[1] = port->wPortStatus >> 8;
            data[2] = port->wPortChange;
            data[3] = port->wPortChange >> 8;
            ret = 4;
        }
        break;
    case SetHubFeature:
    case ClearHubFeature:
        if (value == 0 || value == 1) {
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case SetPortFeature:
        {
            unsigned int n = index - 1;
            USBHubPort *port;
            USBDevice *dev;
            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;
                }
                break;
            case PORT_POWER:
                break;
            default:
                goto fail;
            }
            ret = 0;
        }
        break;
    case ClearPortFeature:
        {
            unsigned int n = index - 1;
            USBHubPort *port;

            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;
            }
            ret = 0;
        }
        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++;
            }

            ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
            data[0] = ret;
            break;
        }
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

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

    switch(p->pid) {
    case USB_TOKEN_IN:
        if (p->devep == 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) {
                return USB_RET_BABBLE;
            }
            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);
                ret = n;
            } else {
                ret = USB_RET_NAK; /* usb11 11.13.1 */
            }
        } else {
            goto fail;
        }
        break;
    case USB_TOKEN_OUT:
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static int usb_hub_broadcast_packet(USBHubState *s, USBPacket *p)
{
    USBHubPort *port;
    USBDevice *dev;
    int i, ret;

    for(i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        dev = port->port.dev;
        if (dev && dev->attached && (port->wPortStatus & PORT_STAT_ENABLE)) {
            ret = usb_handle_packet(dev, p);
            if (ret != USB_RET_NODEV) {
                return ret;
            }
        }
    }
    return USB_RET_NODEV;
}

static int usb_hub_handle_packet(USBDevice *dev, USBPacket *p)
{
    USBHubState *s = (USBHubState *)dev;

#if defined(DEBUG) && 0
    printf("usb_hub: pid=0x%x\n", pid);
#endif
    if (dev->state == USB_STATE_DEFAULT &&
        dev->addr != 0 &&
        p->devaddr != dev->addr &&
        (p->pid == USB_TOKEN_SETUP ||
         p->pid == USB_TOKEN_OUT ||
         p->pid == USB_TOKEN_IN)) {
        /* broadcast the packet to the devices */
        return usb_hub_broadcast_packet(s, p);
    }
    return usb_generic_handle_packet(dev, p);
}

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_init(dev);
    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->handle_packet  = usb_hub_handle_packet;
    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 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_devices(void)
{
    type_register_static(&hub_info);
}
device_init(usb_hub_register_devices)
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 PB	24	#include "qemu-common.h"
87ecb68b PB	25	#include "usb.h"
062651c7	26	#include "usb-desc.h"
72899afc FB	27
	28	//#define DEBUG
	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;
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 = {
	93	[STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
	94	[STR_PRODUCT] = "QEMU USB Hub",
	95	[STR_SERIALNUMBER] = "314159",
	96	};
	97
	98	static const USBDescIface desc_iface_hub = {
	99	.bInterfaceNumber = 0,
	100	.bNumEndpoints = 1,
	101	.bInterfaceClass = USB_CLASS_HUB,
	102	.eps = (USBDescEndpoint[]) {
	103	{
	104	.bEndpointAddress = USB_DIR_IN \| 0x01,
	105	.bmAttributes = USB_ENDPOINT_XFER_INT,
	106	.wMaxPacketSize = 1 + (NUM_PORTS + 7) / 8,
	107	.bInterval = 0xff,
	108	},
	109	}
	110	};
	111
	112	static const USBDescDevice desc_device_hub = {
	113	.bcdUSB = 0x0110,
	114	.bDeviceClass = USB_CLASS_HUB,
	115	.bMaxPacketSize0 = 8,
	116	.bNumConfigurations = 1,
	117	.confs = (USBDescConfig[]) {
	118	{
	119	.bNumInterfaces = 1,
	120	.bConfigurationValue = 1,
	121	.bmAttributes = 0xe0,
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
618c169b GH	159	port->wPortStatus \|= PORT_STAT_CONNECTION;
	160	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	161	if (port->port.dev->speed == USB_SPEED_LOW) {
	162	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
72899afc	163	} else {
618c169b GH	164	port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
618c169b GH	165	}
4a33a9ea	166	usb_wakeup(&s->dev);
618c169b GH	167	}
	168
	169	static void usb_hub_detach(USBPort *port1)
	170	{
	171	USBHubState *s = port1->opaque;
	172	USBHubPort *port = &s->ports[port1->index];
	173
be35cbbc GH	174	usb_wakeup(&s->dev);
be35cbbc GH	175
4706ab6c HG	176	/* Let upstream know the device on this port is gone */
	177	s->dev.port->ops->child_detach(s->dev.port, port1->dev);
	178
618c169b GH	179	port->wPortStatus &= ~PORT_STAT_CONNECTION;
	180	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	181	if (port->wPortStatus & PORT_STAT_ENABLE) {
	182	port->wPortStatus &= ~PORT_STAT_ENABLE;
	183	port->wPortChange \|= PORT_STAT_C_ENABLE;
72899afc FB	184	}
	185	}
	186
4706ab6c HG	187	static void usb_hub_child_detach(USBPort port1, USBDevice child)
	188	{
	189	USBHubState *s = port1->opaque;
	190
	191	/* Pass along upstream */
	192	s->dev.port->ops->child_detach(s->dev.port, child);
	193	}
	194
d47e59b8	195	static void usb_hub_wakeup(USBPort *port1)
34239c7b	196	{
d47e59b8 HG	197	USBHubState *s = port1->opaque;
d47e59b8 HG	198	USBHubPort *port = &s->ports[port1->index];
34239c7b GH	199
	200	if (port->wPortStatus & PORT_STAT_SUSPEND) {
	201	port->wPortChange \|= PORT_STAT_C_SUSPEND;
	202	usb_wakeup(&s->dev);
	203	}
	204	}
	205
d47e59b8	206	static void usb_hub_complete(USBPort port, USBPacket packet)
13a9a0d3	207	{
d47e59b8	208	USBHubState *s = port->opaque;
13a9a0d3 GH	209
	210	/*
	211	* Just pass it along upstream for now.
	212	*
80cf7cf7	213	* If we ever implement usb 2.0 split transactions this will
13a9a0d3	214	* become a little more complicated ...
80cf7cf7 GH	215	*
	216	* Can't use usb_packet_complete() here because packet->owner is
	217	* cleared already, go call the ->complete() callback directly
	218	* instead.
13a9a0d3	219	*/
80cf7cf7	220	s->dev.port->ops->complete(s->dev.port, packet);
13a9a0d3 GH	221	}
13a9a0d3 GH	222
059809e4	223	static void usb_hub_handle_reset(USBDevice *dev)
72899afc	224	{
20d183b6 GH	225	USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
	226	USBHubPort *port;
	227	int i;
	228
	229	for (i = 0; i < NUM_PORTS; i++) {
	230	port = s->ports + i;
	231	port->wPortStatus = PORT_STAT_POWER;
	232	port->wPortChange = 0;
	233	if (port->port.dev && port->port.dev->attached) {
	234	port->wPortStatus \|= PORT_STAT_CONNECTION;
	235	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	236	if (port->port.dev->speed == USB_SPEED_LOW) {
	237	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
	238	}
	239	}
	240	}
72899afc FB	241	}
72899afc FB	242
007fd62f HG	243	static int usb_hub_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	244	int request, int value, int index, int length, uint8_t *data)
72899afc FB	245	{
	246	USBHubState s = (USBHubState )dev;
	247	int ret;
	248
007fd62f	249	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
062651c7 GH	250	if (ret >= 0) {
	251	return ret;
	252	}
	253
72899afc	254	switch(request) {
985d1742 FB	255	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
	256	if (value == 0 && index != 0x81) { /* clear ep halt */
	257	goto fail;
	258	}
	259	ret = 0;
	260	break;
72899afc FB	261	/* usb specific requests */
	262	case GetHubStatus:
	263	data[0] = 0;
	264	data[1] = 0;
	265	data[2] = 0;
	266	data[3] = 0;
	267	ret = 4;
	268	break;
	269	case GetPortStatus:
	270	{
	271	unsigned int n = index - 1;
	272	USBHubPort *port;
062651c7	273	if (n >= NUM_PORTS) {
72899afc	274	goto fail;
062651c7	275	}
72899afc FB	276	port = &s->ports[n];
	277	data[0] = port->wPortStatus;
	278	data[1] = port->wPortStatus >> 8;
	279	data[2] = port->wPortChange;
	280	data[3] = port->wPortChange >> 8;
	281	ret = 4;
	282	}
	283	break;
	284	case SetHubFeature:
	285	case ClearHubFeature:
	286	if (value == 0 \|\| value == 1) {
	287	} else {
	288	goto fail;
	289	}
	290	ret = 0;
	291	break;
	292	case SetPortFeature:
	293	{
	294	unsigned int n = index - 1;
	295	USBHubPort *port;
	296	USBDevice *dev;
062651c7	297	if (n >= NUM_PORTS) {
72899afc	298	goto fail;
062651c7	299	}
72899afc FB	300	port = &s->ports[n];
	301	dev = port->port.dev;
	302	switch(value) {
	303	case PORT_SUSPEND:
	304	port->wPortStatus \|= PORT_STAT_SUSPEND;
	305	break;
	306	case PORT_RESET:
3393bc10	307	if (dev && dev->attached) {
d28f4e2d	308	usb_device_reset(dev);
72899afc FB	309	port->wPortChange \|= PORT_STAT_C_RESET;
72899afc FB	310	/* set enable bit */
72899afc FB	311	port->wPortStatus \|= PORT_STAT_ENABLE;
	312	}
	313	break;
	314	case PORT_POWER:
	315	break;
	316	default:
	317	goto fail;
	318	}
	319	ret = 0;
	320	}
	321	break;
	322	case ClearPortFeature:
	323	{
	324	unsigned int n = index - 1;
	325	USBHubPort *port;
d4c4e6fd	326
062651c7	327	if (n >= NUM_PORTS) {
72899afc	328	goto fail;
062651c7	329	}
72899afc	330	port = &s->ports[n];
72899afc FB	331	switch(value) {
	332	case PORT_ENABLE:
	333	port->wPortStatus &= ~PORT_STAT_ENABLE;
	334	break;
	335	case PORT_C_ENABLE:
	336	port->wPortChange &= ~PORT_STAT_C_ENABLE;
	337	break;
	338	case PORT_SUSPEND:
	339	port->wPortStatus &= ~PORT_STAT_SUSPEND;
	340	break;
	341	case PORT_C_SUSPEND:
	342	port->wPortChange &= ~PORT_STAT_C_SUSPEND;
	343	break;
	344	case PORT_C_CONNECTION:
	345	port->wPortChange &= ~PORT_STAT_C_CONNECTION;
	346	break;
	347	case PORT_C_OVERCURRENT:
	348	port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
	349	break;
	350	case PORT_C_RESET:
	351	port->wPortChange &= ~PORT_STAT_C_RESET;
	352	break;
	353	default:
	354	goto fail;
	355	}
	356	ret = 0;
	357	}
	358	break;
	359	case GetHubDescriptor:
985d1742 FB	360	{
985d1742 FB	361	unsigned int n, limit, var_hub_size = 0;
5fafdf24	362	memcpy(data, qemu_hub_hub_descriptor,
985d1742	363	sizeof(qemu_hub_hub_descriptor));
062651c7	364	data[2] = NUM_PORTS;
985d1742 FB	365
985d1742 FB	366	/* fill DeviceRemovable bits */
062651c7	367	limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
985d1742 FB	368	for (n = 7; n < limit; n++) {
	369	data[n] = 0x00;
	370	var_hub_size++;
	371	}
	372
	373	/* fill PortPwrCtrlMask bits */
062651c7	374	limit = limit + ((NUM_PORTS + 7) / 8);
985d1742 FB	375	for (;n < limit; n++) {
	376	data[n] = 0xff;
	377	var_hub_size++;
	378	}
	379
	380	ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
67f36560	381	data[0] = ret;
985d1742 FB	382	break;
985d1742 FB	383	}
72899afc FB	384	default:
	385	fail:
	386	ret = USB_RET_STALL;
	387	break;
	388	}
	389	return ret;
	390	}
	391
4d611c9a	392	static int usb_hub_handle_data(USBDevice dev, USBPacket p)
72899afc FB	393	{
	394	USBHubState s = (USBHubState )dev;
	395	int ret;
	396
4d611c9a	397	switch(p->pid) {
72899afc	398	case USB_TOKEN_IN:
4d611c9a	399	if (p->devep == 1) {
72899afc FB	400	USBHubPort *port;
72899afc FB	401	unsigned int status;
4f4321c1	402	uint8_t buf[4];
72899afc	403	int i, n;
062651c7	404	n = (NUM_PORTS + 1 + 7) / 8;
4f4321c1	405	if (p->iov.size == 1) { /* FreeBSD workaround */
985d1742	406	n = 1;
4f4321c1	407	} else if (n > p->iov.size) {
72899afc	408	return USB_RET_BABBLE;
985d1742	409	}
72899afc	410	status = 0;
062651c7	411	for(i = 0; i < NUM_PORTS; i++) {
72899afc FB	412	port = &s->ports[i];
	413	if (port->wPortChange)
	414	status \|= (1 << (i + 1));
	415	}
	416	if (status != 0) {
	417	for(i = 0; i < n; i++) {
4f4321c1	418	buf[i] = status >> (8 * i);
72899afc	419	}
4f4321c1	420	usb_packet_copy(p, buf, n);
72899afc FB	421	ret = n;
72899afc FB	422	} else {
985d1742	423	ret = USB_RET_NAK; /* usb11 11.13.1 */
72899afc FB	424	}
	425	} else {
	426	goto fail;
	427	}
	428	break;
	429	case USB_TOKEN_OUT:
	430	default:
	431	fail:
	432	ret = USB_RET_STALL;
	433	break;
	434	}
	435	return ret;
	436	}
	437
4d611c9a	438	static int usb_hub_broadcast_packet(USBHubState s, USBPacket p)
72899afc FB	439	{
	440	USBHubPort *port;
	441	USBDevice *dev;
	442	int i, ret;
	443
062651c7	444	for(i = 0; i < NUM_PORTS; i++) {
72899afc FB	445	port = &s->ports[i];
72899afc FB	446	dev = port->port.dev;
3393bc10	447	if (dev && dev->attached && (port->wPortStatus & PORT_STAT_ENABLE)) {
53aa8c0e	448	ret = usb_handle_packet(dev, p);
72899afc FB	449	if (ret != USB_RET_NODEV) {
	450	return ret;
	451	}
	452	}
	453	}
	454	return USB_RET_NODEV;
	455	}
	456
4d611c9a	457	static int usb_hub_handle_packet(USBDevice dev, USBPacket p)
72899afc FB	458	{
	459	USBHubState s = (USBHubState )dev;
	460
	461	#if defined(DEBUG) && 0
	462	printf("usb_hub: pid=0x%x\n", pid);
	463	#endif
	464	if (dev->state == USB_STATE_DEFAULT &&
	465	dev->addr != 0 &&
4d611c9a	466	p->devaddr != dev->addr &&
5fafdf24 TS	467	(p->pid == USB_TOKEN_SETUP \|\|
5fafdf24 TS	468	p->pid == USB_TOKEN_OUT \|\|
4d611c9a	469	p->pid == USB_TOKEN_IN)) {
72899afc	470	/* broadcast the packet to the devices */
4d611c9a	471	return usb_hub_broadcast_packet(s, p);
72899afc	472	}
4d611c9a	473	return usb_generic_handle_packet(dev, p);
72899afc FB	474	}
72899afc FB	475
059809e4 FB	476	static void usb_hub_handle_destroy(USBDevice *dev)
	477	{
	478	USBHubState s = (USBHubState )dev;
a8e662b5	479	int i;
059809e4	480
062651c7	481	for (i = 0; i < NUM_PORTS; i++) {
a8e662b5 GH	482	usb_unregister_port(usb_bus_from_device(dev),
	483	&s->ports[i].port);
	484	}
059809e4 FB	485	}
059809e4 FB	486
0d86d2be GH	487	static USBPortOps usb_hub_port_ops = {
0d86d2be GH	488	.attach = usb_hub_attach,
618c169b	489	.detach = usb_hub_detach,
4706ab6c	490	.child_detach = usb_hub_child_detach,
34239c7b	491	.wakeup = usb_hub_wakeup,
13a9a0d3	492	.complete = usb_hub_complete,
0d86d2be GH	493	};
0d86d2be GH	494
806b6024	495	static int usb_hub_initfn(USBDevice *dev)
72899afc	496	{
806b6024	497	USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
72899afc FB	498	USBHubPort *port;
	499	int i;
	500
a980a065	501	usb_desc_init(dev);
062651c7	502	for (i = 0; i < NUM_PORTS; i++) {
72899afc	503	port = &s->ports[i];
a5d2f727	504	usb_register_port(usb_bus_from_device(dev),
ace1318b	505	&port->port, s, i, &usb_hub_port_ops,
843d4e0c	506	USB_SPEED_MASK_LOW \| USB_SPEED_MASK_FULL);
891fb2cd	507	usb_port_location(&port->port, dev->port, i+1);
72899afc	508	}
20d183b6	509	usb_hub_handle_reset(dev);
806b6024 GH	510	return 0;
	511	}
	512
d1550090 GH	513	static const VMStateDescription vmstate_usb_hub_port = {
	514	.name = "usb-hub-port",
	515	.version_id = 1,
	516	.minimum_version_id = 1,
	517	.fields = (VMStateField []) {
	518	VMSTATE_UINT16(wPortStatus, USBHubPort),
	519	VMSTATE_UINT16(wPortChange, USBHubPort),
	520	VMSTATE_END_OF_LIST()
	521	}
	522	};
	523
	524	static const VMStateDescription vmstate_usb_hub = {
	525	.name = "usb-hub",
	526	.version_id = 1,
	527	.minimum_version_id = 1,
	528	.fields = (VMStateField []) {
	529	VMSTATE_USB_DEVICE(dev, USBHubState),
	530	VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
	531	vmstate_usb_hub_port, USBHubPort),
	532	VMSTATE_END_OF_LIST()
	533	}
	534	};
	535
39bffca2	536	static void usb_hub_class_initfn(ObjectClass klass, void data)
62aed765	537	{
39bffca2	538	DeviceClass *dc = DEVICE_CLASS(klass);
62aed765 AL	539	USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
	540
	541	uc->init = usb_hub_initfn;
	542	uc->product_desc = "QEMU USB Hub";
	543	uc->usb_desc = &desc_hub;
	544	uc->handle_packet = usb_hub_handle_packet;
	545	uc->handle_reset = usb_hub_handle_reset;
	546	uc->handle_control = usb_hub_handle_control;
	547	uc->handle_data = usb_hub_handle_data;
	548	uc->handle_destroy = usb_hub_handle_destroy;
39bffca2 AL	549	dc->fw_name = "hub";
39bffca2 AL	550	dc->vmsd = &vmstate_usb_hub;
62aed765 AL	551	}
62aed765 AL	552
39bffca2 AL	553	static TypeInfo hub_info = {
	554	.name = "usb-hub",
	555	.parent = TYPE_USB_DEVICE,
	556	.instance_size = sizeof(USBHubState),
	557	.class_init = usb_hub_class_initfn,
806b6024 GH	558	};
	559
	560	static void usb_hub_register_devices(void)
	561	{
39bffca2	562	type_register_static(&hub_info);
72899afc	563	}
806b6024	564	device_init(usb_hub_register_devices)