[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,
            .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, USBDevice *dev)
{
    USBHubState *s = port1->opaque;
    USBHubPort *port = &s->ports[port1->index];

    if (dev) {
        if (port->port.dev)
            usb_attach(port1, NULL);

        port->wPortStatus |= PORT_STAT_CONNECTION;
        port->wPortChange |= PORT_STAT_C_CONNECTION;
        if (dev->speed == USB_SPEED_LOW)
            port->wPortStatus |= PORT_STAT_LOW_SPEED;
        else
            port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
        port->port.dev = dev;
        /* send the attach message */
        usb_send_msg(dev, USB_MSG_ATTACH);
    } else {
        dev = port->port.dev;
        if (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;
            }
            /* send the detach message */
            usb_send_msg(dev, USB_MSG_DETACH);
            port->port.dev = NULL;
        }
    }
}

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

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

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

    switch(request) {
    case DeviceRequest | USB_REQ_GET_STATUS:
        data[0] = (1 << USB_DEVICE_SELF_POWERED) |
            (dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
        data[1] = 0x00;
        ret = 2;
        break;
    case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 0;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
        if (value == 0 && index != 0x81) { /* clear ep halt */
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 1;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceRequest | USB_REQ_GET_CONFIGURATION:
        data[0] = 1;
        ret = 1;
        break;
    case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
        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 = dev->info->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 int usb_hub_initfn(USBDevice *dev)
{
    USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
    USBHubPort *port;
    int i;

    s->dev.speed = USB_SPEED_FULL;
    for (i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        usb_register_port(usb_bus_from_device(dev),
                          &port->port, s, i, &s->dev, usb_hub_attach);
        port->wPortStatus = PORT_STAT_POWER;
        port->wPortChange = 0;
    }
    return 0;
}

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