[mirror_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          = 0,
        .idProduct         = 0,
        .bcdDevice         = 0x0101,
        .iManufacturer     = STR_MANUFACTURER,
        .iProduct          = STR_PRODUCT,
        .iSerialNumber     = STR_SERIALNUMBER,
    },
    .full = &desc_device_hub,
    .str  = desc_strings,
};

static const uint8_t qemu_hub_dev_descriptor[] = {
	0x12,       /*  u8 bLength; */
	0x01,       /*  u8 bDescriptorType; Device */
	0x10, 0x01, /*  u16 bcdUSB; v1.1 */

	0x09,	    /*  u8  bDeviceClass; HUB_CLASSCODE */
	0x00,	    /*  u8  bDeviceSubClass; */
	0x00,       /*  u8  bDeviceProtocol; [ low/full speeds only ] */
	0x08,       /*  u8  bMaxPacketSize0; 8 Bytes */

	0x00, 0x00, /*  u16 idVendor; */
 	0x00, 0x00, /*  u16 idProduct; */
	0x01, 0x01, /*  u16 bcdDevice */

	0x03,       /*  u8  iManufacturer; */
	0x02,       /*  u8  iProduct; */
	0x01,       /*  u8  iSerialNumber; */
	0x01        /*  u8  bNumConfigurations; */
};

/* XXX: patch interrupt size */
static const uint8_t qemu_hub_config_descriptor[] = {

	/* one configuration */
	0x09,       /*  u8  bLength; */
	0x02,       /*  u8  bDescriptorType; Configuration */
	0x19, 0x00, /*  u16 wTotalLength; */
	0x01,       /*  u8  bNumInterfaces; (1) */
	0x01,       /*  u8  bConfigurationValue; */
	0x00,       /*  u8  iConfiguration; */
	0xe0,       /*  u8  bmAttributes;
				 Bit 7: must be set,
				     6: Self-powered,
				     5: Remote wakeup,
				     4..0: resvd */
	0x00,       /*  u8  MaxPower; */

	/* USB 1.1:
	 * USB 2.0, single TT organization (mandatory):
	 *	one interface, protocol 0
	 *
	 * USB 2.0, multiple TT organization (optional):
	 *	two interfaces, protocols 1 (like single TT)
	 *	and 2 (multiple TT mode) ... config is
	 *	sometimes settable
	 *	NOT IMPLEMENTED
	 */

	/* one interface */
	0x09,       /*  u8  if_bLength; */
	0x04,       /*  u8  if_bDescriptorType; Interface */
	0x00,       /*  u8  if_bInterfaceNumber; */
	0x00,       /*  u8  if_bAlternateSetting; */
	0x01,       /*  u8  if_bNumEndpoints; */
	0x09,       /*  u8  if_bInterfaceClass; HUB_CLASSCODE */
	0x00,       /*  u8  if_bInterfaceSubClass; */
	0x00,       /*  u8  if_bInterfaceProtocol; [usb1.1 or single tt] */
	0x00,       /*  u8  if_iInterface; */

	/* one endpoint (status change endpoint) */
	0x07,       /*  u8  ep_bLength; */
	0x05,       /*  u8  ep_bDescriptorType; Endpoint */
	0x81,       /*  u8  ep_bEndpointAddress; IN Endpoint 1 */
 	0x03,       /*  u8  ep_bmAttributes; Interrupt */
 	0x02, 0x00, /*  u16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
	0xff        /*  u8  ep_bInterval; (255ms -- usb 2.0 spec) */
};

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

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

    /* 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 inplement usb 2.0 split transactions this will
     * become a little more complicated ...
     */
    usb_packet_complete(&s->dev, packet);
}

static void usb_hub_handle_attach(USBDevice *dev)
{
    USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
    int i;

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

static void usb_hub_handle_reset(USBDevice *dev)
{
    /* XXX: do it */
}

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;
    case DeviceRequest | USB_REQ_GET_INTERFACE:
        data[0] = 0;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_INTERFACE:
        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) {
                    usb_send_msg(dev, USB_MSG_RESET);
                    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;
            int i, n;
            n = (NUM_PORTS + 1 + 7) / 8;
            if (p->len == 1) { /* FreeBSD workaround */
                n = 1;
            } else if (n > p->len) {
                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++) {
                    p->data[i] = status >> (8 * i);
                }
                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 && (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);
        port->wPortStatus = PORT_STAT_POWER;
        port->wPortChange = 0;
    }
    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 struct USBDeviceInfo hub_info = {
    .product_desc   = "QEMU USB Hub",
    .qdev.name      = "usb-hub",
    .qdev.fw_name    = "hub",
    .qdev.size      = sizeof(USBHubState),
    .qdev.vmsd      = &vmstate_usb_hub,
    .usb_desc       = &desc_hub,
    .init           = usb_hub_initfn,
    .handle_packet  = usb_hub_handle_packet,
    .handle_attach  = usb_hub_handle_attach,
    .handle_reset   = usb_hub_handle_reset,
    .handle_control = usb_hub_handle_control,
    .handle_data    = usb_hub_handle_data,
    .handle_destroy = usb_hub_handle_destroy,
};

static void usb_hub_register_devices(void)
{
    usb_qdev_register(&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 = {
	130	.idVendor = 0,
	131	.idProduct = 0,
	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_dev_descriptor[] = {
	142	0x12, /* u8 bLength; */
	143	0x01, /* u8 bDescriptorType; Device */
	144	0x10, 0x01, /* u16 bcdUSB; v1.1 */
	145
	146	0x09, /* u8 bDeviceClass; HUB_CLASSCODE */
	147	0x00, /* u8 bDeviceSubClass; */
	148	0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
	149	0x08, /* u8 bMaxPacketSize0; 8 Bytes */
	150
	151	0x00, 0x00, /* u16 idVendor; */
	152	0x00, 0x00, /* u16 idProduct; */
	153	0x01, 0x01, /* u16 bcdDevice */
	154
	155	0x03, /* u8 iManufacturer; */
	156	0x02, /* u8 iProduct; */
	157	0x01, /* u8 iSerialNumber; */
	158	0x01 /* u8 bNumConfigurations; */
	159	};
	160
	161	/* XXX: patch interrupt size */
	162	static const uint8_t qemu_hub_config_descriptor[] = {
	163
	164	/* one configuration */
	165	0x09, /* u8 bLength; */
	166	0x02, /* u8 bDescriptorType; Configuration */
	167	0x19, 0x00, /* u16 wTotalLength; */
	168	0x01, /* u8 bNumInterfaces; (1) */
	169	0x01, /* u8 bConfigurationValue; */
	170	0x00, /* u8 iConfiguration; */
659139d7	171	0xe0, /* u8 bmAttributes;
72899afc FB	172	Bit 7: must be set,
	173	6: Self-powered,
	174	5: Remote wakeup,
	175	4..0: resvd */
	176	0x00, /* u8 MaxPower; */
3b46e624	177
72899afc FB	178	/* USB 1.1:
	179	* USB 2.0, single TT organization (mandatory):
	180	* one interface, protocol 0
	181	*
	182	* USB 2.0, multiple TT organization (optional):
	183	* two interfaces, protocols 1 (like single TT)
	184	* and 2 (multiple TT mode) ... config is
	185	* sometimes settable
	186	* NOT IMPLEMENTED
	187	*/
	188
	189	/* one interface */
	190	0x09, /* u8 if_bLength; */
	191	0x04, /* u8 if_bDescriptorType; Interface */
	192	0x00, /* u8 if_bInterfaceNumber; */
	193	0x00, /* u8 if_bAlternateSetting; */
	194	0x01, /* u8 if_bNumEndpoints; */
	195	0x09, /* u8 if_bInterfaceClass; HUB_CLASSCODE */
	196	0x00, /* u8 if_bInterfaceSubClass; */
	197	0x00, /* u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
	198	0x00, /* u8 if_iInterface; */
3b46e624	199
72899afc FB	200	/* one endpoint (status change endpoint) */
	201	0x07, /* u8 ep_bLength; */
	202	0x05, /* u8 ep_bDescriptorType; Endpoint */
	203	0x81, /* u8 ep_bEndpointAddress; IN Endpoint 1 */
	204	0x03, /* u8 ep_bmAttributes; Interrupt */
	205	0x02, 0x00, /* u16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
	206	0xff /* u8 ep_bInterval; (255ms -- usb 2.0 spec) */
	207	};
	208
	209	static const uint8_t qemu_hub_hub_descriptor[] =
	210	{
67f36560	211	0x00, /* u8 bLength; patched in later */
72899afc FB	212	0x29, /* u8 bDescriptorType; Hub-descriptor */
	213	0x00, /* u8 bNbrPorts; (patched later) */
	214	0x0a, /* u16 wHubCharacteristics; */
	215	0x00, /* (per-port OC, no power switching) */
	216	0x01, /* u8 bPwrOn2pwrGood; 2ms */
985d1742 FB	217	0x00 /* u8 bHubContrCurrent; 0 mA */
	218
	219	/* DeviceRemovable and PortPwrCtrlMask patched in later */
72899afc FB	220	};
72899afc FB	221
618c169b	222	static void usb_hub_attach(USBPort *port1)
72899afc FB	223	{
	224	USBHubState *s = port1->opaque;
	225	USBHubPort *port = &s->ports[port1->index];
3b46e624	226
618c169b GH	227	port->wPortStatus \|= PORT_STAT_CONNECTION;
	228	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	229	if (port->port.dev->speed == USB_SPEED_LOW) {
	230	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
72899afc	231	} else {
618c169b GH	232	port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
	233	}
	234	}
	235
	236	static void usb_hub_detach(USBPort *port1)
	237	{
	238	USBHubState *s = port1->opaque;
	239	USBHubPort *port = &s->ports[port1->index];
	240
4706ab6c HG	241	/* Let upstream know the device on this port is gone */
	242	s->dev.port->ops->child_detach(s->dev.port, port1->dev);
	243
618c169b GH	244	port->wPortStatus &= ~PORT_STAT_CONNECTION;
	245	port->wPortChange \|= PORT_STAT_C_CONNECTION;
	246	if (port->wPortStatus & PORT_STAT_ENABLE) {
	247	port->wPortStatus &= ~PORT_STAT_ENABLE;
	248	port->wPortChange \|= PORT_STAT_C_ENABLE;
72899afc FB	249	}
	250	}
	251
4706ab6c HG	252	static void usb_hub_child_detach(USBPort port1, USBDevice child)
	253	{
	254	USBHubState *s = port1->opaque;
	255
	256	/* Pass along upstream */
	257	s->dev.port->ops->child_detach(s->dev.port, child);
	258	}
	259
d47e59b8	260	static void usb_hub_wakeup(USBPort *port1)
34239c7b	261	{
d47e59b8 HG	262	USBHubState *s = port1->opaque;
d47e59b8 HG	263	USBHubPort *port = &s->ports[port1->index];
34239c7b GH	264
	265	if (port->wPortStatus & PORT_STAT_SUSPEND) {
	266	port->wPortChange \|= PORT_STAT_C_SUSPEND;
	267	usb_wakeup(&s->dev);
	268	}
	269	}
	270
d47e59b8	271	static void usb_hub_complete(USBPort port, USBPacket packet)
13a9a0d3	272	{
d47e59b8	273	USBHubState *s = port->opaque;
13a9a0d3 GH	274
	275	/*
	276	* Just pass it along upstream for now.
	277	*
	278	* If we ever inplement usb 2.0 split transactions this will
	279	* become a little more complicated ...
	280	*/
	281	usb_packet_complete(&s->dev, packet);
	282	}
	283
c7a2196a GH	284	static void usb_hub_handle_attach(USBDevice *dev)
	285	{
	286	USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
	287	int i;
	288
	289	for (i = 0; i < NUM_PORTS; i++) {
	290	usb_port_location(&s->ports[i].port, dev->port, i+1);
	291	}
	292	}
	293
059809e4	294	static void usb_hub_handle_reset(USBDevice *dev)
72899afc FB	295	{
	296	/* XXX: do it */
	297	}
	298
007fd62f HG	299	static int usb_hub_handle_control(USBDevice dev, USBPacket p,
007fd62f HG	300	int request, int value, int index, int length, uint8_t *data)
72899afc FB	301	{
	302	USBHubState s = (USBHubState )dev;
	303	int ret;
	304
007fd62f	305	ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
062651c7 GH	306	if (ret >= 0) {
	307	return ret;
	308	}
	309
72899afc	310	switch(request) {
985d1742 FB	311	case EndpointOutRequest \| USB_REQ_CLEAR_FEATURE:
	312	if (value == 0 && index != 0x81) { /* clear ep halt */
	313	goto fail;
	314	}
	315	ret = 0;
	316	break;
72899afc FB	317	case DeviceRequest \| USB_REQ_GET_INTERFACE:
	318	data[0] = 0;
	319	ret = 1;
	320	break;
	321	case DeviceOutRequest \| USB_REQ_SET_INTERFACE:
	322	ret = 0;
	323	break;
	324	/* usb specific requests */
	325	case GetHubStatus:
	326	data[0] = 0;
	327	data[1] = 0;
	328	data[2] = 0;
	329	data[3] = 0;
	330	ret = 4;
	331	break;
	332	case GetPortStatus:
	333	{
	334	unsigned int n = index - 1;
	335	USBHubPort *port;
062651c7	336	if (n >= NUM_PORTS) {
72899afc	337	goto fail;
062651c7	338	}
72899afc FB	339	port = &s->ports[n];
	340	data[0] = port->wPortStatus;
	341	data[1] = port->wPortStatus >> 8;
	342	data[2] = port->wPortChange;
	343	data[3] = port->wPortChange >> 8;
	344	ret = 4;
	345	}
	346	break;
	347	case SetHubFeature:
	348	case ClearHubFeature:
	349	if (value == 0 \|\| value == 1) {
	350	} else {
	351	goto fail;
	352	}
	353	ret = 0;
	354	break;
	355	case SetPortFeature:
	356	{
	357	unsigned int n = index - 1;
	358	USBHubPort *port;
	359	USBDevice *dev;
062651c7	360	if (n >= NUM_PORTS) {
72899afc	361	goto fail;
062651c7	362	}
72899afc FB	363	port = &s->ports[n];
	364	dev = port->port.dev;
	365	switch(value) {
	366	case PORT_SUSPEND:
	367	port->wPortStatus \|= PORT_STAT_SUSPEND;
	368	break;
	369	case PORT_RESET:
	370	if (dev) {
4d611c9a	371	usb_send_msg(dev, USB_MSG_RESET);
72899afc FB	372	port->wPortChange \|= PORT_STAT_C_RESET;
72899afc FB	373	/* set enable bit */
72899afc FB	374	port->wPortStatus \|= PORT_STAT_ENABLE;
	375	}
	376	break;
	377	case PORT_POWER:
	378	break;
	379	default:
	380	goto fail;
	381	}
	382	ret = 0;
	383	}
	384	break;
	385	case ClearPortFeature:
	386	{
	387	unsigned int n = index - 1;
	388	USBHubPort *port;
d4c4e6fd	389
062651c7	390	if (n >= NUM_PORTS) {
72899afc	391	goto fail;
062651c7	392	}
72899afc	393	port = &s->ports[n];
72899afc FB	394	switch(value) {
	395	case PORT_ENABLE:
	396	port->wPortStatus &= ~PORT_STAT_ENABLE;
	397	break;
	398	case PORT_C_ENABLE:
	399	port->wPortChange &= ~PORT_STAT_C_ENABLE;
	400	break;
	401	case PORT_SUSPEND:
	402	port->wPortStatus &= ~PORT_STAT_SUSPEND;
	403	break;
	404	case PORT_C_SUSPEND:
	405	port->wPortChange &= ~PORT_STAT_C_SUSPEND;
	406	break;
	407	case PORT_C_CONNECTION:
	408	port->wPortChange &= ~PORT_STAT_C_CONNECTION;
	409	break;
	410	case PORT_C_OVERCURRENT:
	411	port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
	412	break;
	413	case PORT_C_RESET:
	414	port->wPortChange &= ~PORT_STAT_C_RESET;
	415	break;
	416	default:
	417	goto fail;
	418	}
	419	ret = 0;
	420	}
	421	break;
	422	case GetHubDescriptor:
985d1742 FB	423	{
985d1742 FB	424	unsigned int n, limit, var_hub_size = 0;
5fafdf24	425	memcpy(data, qemu_hub_hub_descriptor,
985d1742	426	sizeof(qemu_hub_hub_descriptor));
062651c7	427	data[2] = NUM_PORTS;
985d1742 FB	428
985d1742 FB	429	/* fill DeviceRemovable bits */
062651c7	430	limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
985d1742 FB	431	for (n = 7; n < limit; n++) {
	432	data[n] = 0x00;
	433	var_hub_size++;
	434	}
	435
	436	/* fill PortPwrCtrlMask bits */
062651c7	437	limit = limit + ((NUM_PORTS + 7) / 8);
985d1742 FB	438	for (;n < limit; n++) {
	439	data[n] = 0xff;
	440	var_hub_size++;
	441	}
	442
	443	ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
67f36560	444	data[0] = ret;
985d1742 FB	445	break;
985d1742 FB	446	}
72899afc FB	447	default:
	448	fail:
	449	ret = USB_RET_STALL;
	450	break;
	451	}
	452	return ret;
	453	}
	454
4d611c9a	455	static int usb_hub_handle_data(USBDevice dev, USBPacket p)
72899afc FB	456	{
	457	USBHubState s = (USBHubState )dev;
	458	int ret;
	459
4d611c9a	460	switch(p->pid) {
72899afc	461	case USB_TOKEN_IN:
4d611c9a	462	if (p->devep == 1) {
72899afc FB	463	USBHubPort *port;
	464	unsigned int status;
	465	int i, n;
062651c7	466	n = (NUM_PORTS + 1 + 7) / 8;
4d611c9a	467	if (p->len == 1) { /* FreeBSD workaround */
985d1742	468	n = 1;
4d611c9a	469	} else if (n > p->len) {
72899afc	470	return USB_RET_BABBLE;
985d1742	471	}
72899afc	472	status = 0;
062651c7	473	for(i = 0; i < NUM_PORTS; i++) {
72899afc FB	474	port = &s->ports[i];
	475	if (port->wPortChange)
	476	status \|= (1 << (i + 1));
	477	}
	478	if (status != 0) {
	479	for(i = 0; i < n; i++) {
4d611c9a	480	p->data[i] = status >> (8 * i);
72899afc FB	481	}
	482	ret = n;
	483	} else {
985d1742	484	ret = USB_RET_NAK; /* usb11 11.13.1 */
72899afc FB	485	}
	486	} else {
	487	goto fail;
	488	}
	489	break;
	490	case USB_TOKEN_OUT:
	491	default:
	492	fail:
	493	ret = USB_RET_STALL;
	494	break;
	495	}
	496	return ret;
	497	}
	498
4d611c9a	499	static int usb_hub_broadcast_packet(USBHubState s, USBPacket p)
72899afc FB	500	{
	501	USBHubPort *port;
	502	USBDevice *dev;
	503	int i, ret;
	504
062651c7	505	for(i = 0; i < NUM_PORTS; i++) {
72899afc FB	506	port = &s->ports[i];
	507	dev = port->port.dev;
	508	if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
53aa8c0e	509	ret = usb_handle_packet(dev, p);
72899afc FB	510	if (ret != USB_RET_NODEV) {
	511	return ret;
	512	}
	513	}
	514	}
	515	return USB_RET_NODEV;
	516	}
	517
4d611c9a	518	static int usb_hub_handle_packet(USBDevice dev, USBPacket p)
72899afc FB	519	{
	520	USBHubState s = (USBHubState )dev;
	521
	522	#if defined(DEBUG) && 0
	523	printf("usb_hub: pid=0x%x\n", pid);
	524	#endif
	525	if (dev->state == USB_STATE_DEFAULT &&
	526	dev->addr != 0 &&
4d611c9a	527	p->devaddr != dev->addr &&
5fafdf24 TS	528	(p->pid == USB_TOKEN_SETUP \|\|
5fafdf24 TS	529	p->pid == USB_TOKEN_OUT \|\|
4d611c9a	530	p->pid == USB_TOKEN_IN)) {
72899afc	531	/* broadcast the packet to the devices */
4d611c9a	532	return usb_hub_broadcast_packet(s, p);
72899afc	533	}
4d611c9a	534	return usb_generic_handle_packet(dev, p);
72899afc FB	535	}
72899afc FB	536
059809e4 FB	537	static void usb_hub_handle_destroy(USBDevice *dev)
	538	{
	539	USBHubState s = (USBHubState )dev;
a8e662b5	540	int i;
059809e4	541
062651c7	542	for (i = 0; i < NUM_PORTS; i++) {
a8e662b5 GH	543	usb_unregister_port(usb_bus_from_device(dev),
	544	&s->ports[i].port);
	545	}
059809e4 FB	546	}
059809e4 FB	547
0d86d2be GH	548	static USBPortOps usb_hub_port_ops = {
0d86d2be GH	549	.attach = usb_hub_attach,
618c169b	550	.detach = usb_hub_detach,
4706ab6c	551	.child_detach = usb_hub_child_detach,
34239c7b	552	.wakeup = usb_hub_wakeup,
13a9a0d3	553	.complete = usb_hub_complete,
0d86d2be GH	554	};
0d86d2be GH	555
806b6024	556	static int usb_hub_initfn(USBDevice *dev)
72899afc	557	{
806b6024	558	USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
72899afc FB	559	USBHubPort *port;
	560	int i;
	561
a980a065	562	usb_desc_init(dev);
062651c7	563	for (i = 0; i < NUM_PORTS; i++) {
72899afc	564	port = &s->ports[i];
a5d2f727	565	usb_register_port(usb_bus_from_device(dev),
ace1318b	566	&port->port, s, i, &usb_hub_port_ops,
843d4e0c	567	USB_SPEED_MASK_LOW \| USB_SPEED_MASK_FULL);
72899afc FB	568	port->wPortStatus = PORT_STAT_POWER;
72899afc FB	569	port->wPortChange = 0;
72899afc	570	}
806b6024 GH	571	return 0;
	572	}
	573
d1550090 GH	574	static const VMStateDescription vmstate_usb_hub_port = {
	575	.name = "usb-hub-port",
	576	.version_id = 1,
	577	.minimum_version_id = 1,
	578	.fields = (VMStateField []) {
	579	VMSTATE_UINT16(wPortStatus, USBHubPort),
	580	VMSTATE_UINT16(wPortChange, USBHubPort),
	581	VMSTATE_END_OF_LIST()
	582	}
	583	};
	584
	585	static const VMStateDescription vmstate_usb_hub = {
	586	.name = "usb-hub",
	587	.version_id = 1,
	588	.minimum_version_id = 1,
	589	.fields = (VMStateField []) {
	590	VMSTATE_USB_DEVICE(dev, USBHubState),
	591	VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
	592	vmstate_usb_hub_port, USBHubPort),
	593	VMSTATE_END_OF_LIST()
	594	}
	595	};
	596
806b6024	597	static struct USBDeviceInfo hub_info = {
06384698	598	.product_desc = "QEMU USB Hub",
556cd098	599	.qdev.name = "usb-hub",
779206de	600	.qdev.fw_name = "hub",
806b6024	601	.qdev.size = sizeof(USBHubState),
d1550090	602	.qdev.vmsd = &vmstate_usb_hub,
062651c7	603	.usb_desc = &desc_hub,
806b6024 GH	604	.init = usb_hub_initfn,
806b6024 GH	605	.handle_packet = usb_hub_handle_packet,
c7a2196a	606	.handle_attach = usb_hub_handle_attach,
806b6024 GH	607	.handle_reset = usb_hub_handle_reset,
	608	.handle_control = usb_hub_handle_control,
	609	.handle_data = usb_hub_handle_data,
	610	.handle_destroy = usb_hub_handle_destroy,
	611	};
	612
	613	static void usb_hub_register_devices(void)
	614	{
	615	usb_qdev_register(&hub_info);
72899afc	616	}
806b6024	617	device_init(usb_hub_register_devices)