[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;
    USBEndpoint *intr;
    USBHubPort ports[NUM_PORTS];
} USBHubState;

#define ClearHubFeature		(0x2000 | USB_REQ_CLEAR_FEATURE)
#define ClearPortFeature	(0x2300 | USB_REQ_CLEAR_FEATURE)
#define GetHubDescriptor	(0xa000 | USB_REQ_GET_DESCRIPTOR)
#define GetHubStatus		(0xa000 | USB_REQ_GET_STATUS)
#define GetPortStatus		(0xa300 | USB_REQ_GET_STATUS)
#define SetHubFeature		(0x2000 | USB_REQ_SET_FEATURE)
#define SetPortFeature		(0x2300 | USB_REQ_SET_FEATURE)

#define PORT_STAT_CONNECTION	0x0001
#define PORT_STAT_ENABLE	0x0002
#define PORT_STAT_SUSPEND	0x0004
#define PORT_STAT_OVERCURRENT	0x0008
#define PORT_STAT_RESET		0x0010
#define PORT_STAT_POWER		0x0100
#define PORT_STAT_LOW_SPEED	0x0200
#define PORT_STAT_HIGH_SPEED    0x0400
#define PORT_STAT_TEST          0x0800
#define PORT_STAT_INDICATOR     0x1000

#define PORT_STAT_C_CONNECTION	0x0001
#define PORT_STAT_C_ENABLE	0x0002
#define PORT_STAT_C_SUSPEND	0x0004
#define PORT_STAT_C_OVERCURRENT	0x0008
#define PORT_STAT_C_RESET	0x0010

#define PORT_CONNECTION	        0
#define PORT_ENABLE		1
#define PORT_SUSPEND		2
#define PORT_OVERCURRENT	3
#define PORT_RESET		4
#define PORT_POWER		8
#define PORT_LOWSPEED		9
#define PORT_HIGHSPEED		10
#define PORT_C_CONNECTION	16
#define PORT_C_ENABLE		17
#define PORT_C_SUSPEND		18
#define PORT_C_OVERCURRENT	19
#define PORT_C_RESET		20
#define PORT_TEST               21
#define PORT_INDICATOR          22

/* same as Linux kernel root hubs */

enum {
    STR_MANUFACTURER = 1,
    STR_PRODUCT,
    STR_SERIALNUMBER,
};

static const USBDescStrings desc_strings = {
    [STR_MANUFACTURER] = "QEMU " 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->intr);
}

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

    usb_wakeup(s->intr);

    /* Let upstream know the device on this port is gone */
    s->dev.port->ops->child_detach(s->dev.port, port1->dev);

    port->wPortStatus &= ~PORT_STAT_CONNECTION;
    port->wPortChange |= PORT_STAT_C_CONNECTION;
    if (port->wPortStatus & PORT_STAT_ENABLE) {
        port->wPortStatus &= ~PORT_STAT_ENABLE;
        port->wPortChange |= PORT_STAT_C_ENABLE;
    }
}

static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
{
    USBHubState *s = port1->opaque;

    /* Pass along upstream */
    s->dev.port->ops->child_detach(s->dev.port, child);
}

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

    if (port->wPortStatus & PORT_STAT_SUSPEND) {
        port->wPortChange |= PORT_STAT_C_SUSPEND;
        usb_wakeup(s->intr);
    }
}

static void usb_hub_complete(USBPort *port, USBPacket *packet)
{
    USBHubState *s = port->opaque;

    /*
     * Just pass it along upstream for now.
     *
     * If we ever implement usb 2.0 split transactions this will
     * become a little more complicated ...
     *
     * Can't use usb_packet_complete() here because packet->owner is
     * cleared already, go call the ->complete() callback directly
     * instead.
     */
    s->dev.port->ops->complete(s->dev.port, packet);
}

static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr)
{
    USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
    USBHubPort *port;
    USBDevice *downstream;
    int i;

    for (i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        if (!(port->wPortStatus & PORT_STAT_ENABLE)) {
            continue;
        }
        downstream = usb_find_device(&port->port, addr);
        if (downstream != NULL) {
            return downstream;
        }
    }
    return NULL;
}

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

    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->ep->nr == 1) {
            USBHubPort *port;
            unsigned int status;
            uint8_t buf[4];
            int i, n;
            n = (NUM_PORTS + 1 + 7) / 8;
            if (p->iov.size == 1) { /* FreeBSD workaround */
                n = 1;
            } else if (n > p->iov.size) {
                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 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);
    s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
    for (i = 0; i < NUM_PORTS; i++) {
        port = &s->ports[i];
        usb_register_port(usb_bus_from_device(dev),
                          &port->port, s, i, &usb_hub_port_ops,
                          USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
        usb_port_location(&port->port, dev->port, i+1);
    }
    usb_hub_handle_reset(dev);
    return 0;
}

static const VMStateDescription vmstate_usb_hub_port = {
    .name = "usb-hub-port",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField []) {
        VMSTATE_UINT16(wPortStatus, USBHubPort),
        VMSTATE_UINT16(wPortChange, USBHubPort),
        VMSTATE_END_OF_LIST()
    }
};

static const VMStateDescription vmstate_usb_hub = {
    .name = "usb-hub",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField []) {
        VMSTATE_USB_DEVICE(dev, USBHubState),
        VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
                             vmstate_usb_hub_port, USBHubPort),
        VMSTATE_END_OF_LIST()
    }
};

static void usb_hub_class_initfn(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    USBDeviceClass *uc = USB_DEVICE_CLASS(klass);

    uc->init           = usb_hub_initfn;
    uc->product_desc   = "QEMU USB Hub";
    uc->usb_desc       = &desc_hub;
    uc->find_device    = usb_hub_find_device;
    uc->handle_reset   = usb_hub_handle_reset;
    uc->handle_control = usb_hub_handle_control;
    uc->handle_data    = usb_hub_handle_data;
    uc->handle_destroy = usb_hub_handle_destroy;
    dc->fw_name = "hub";
    dc->vmsd = &vmstate_usb_hub;
}

static TypeInfo hub_info = {
    .name          = "usb-hub",
    .parent        = TYPE_USB_DEVICE,
    .instance_size = sizeof(USBHubState),
    .class_init    = usb_hub_class_initfn,
};

static void usb_hub_register_types(void)
{
    type_register_static(&hub_info);
}

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