[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 "vl.h"

//#define DEBUG

#define MAX_PORTS 8

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

typedef struct USBHubState {
    USBDevice dev;
    int nb_ports;
    USBHubPort ports[MAX_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 */

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; */
	0xc0,       /*  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[] =
{
	0x09,			/*  u8  bLength; */
	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 */
	0x00,			/*  u8  DeviceRemovable; *** 7 Ports max *** */
	0xff			/*  u8  PortPwrCtrlMask; *** 7 ports max *** */
};

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

    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 DeviceOutRequest | USB_REQ_SET_FEATURE:
        if (value == USB_DEVICE_REMOTE_WAKEUP) {
            dev->remote_wakeup = 1;
        } else {
            goto fail;
        }
        ret = 0;
        break;
    case DeviceOutRequest | USB_REQ_SET_ADDRESS:
        dev->addr = value;
        ret = 0;
        break;
    case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
        switch(value >> 8) {
        case USB_DT_DEVICE:
            memcpy(data, qemu_hub_dev_descriptor, 
                   sizeof(qemu_hub_dev_descriptor));
            ret = sizeof(qemu_hub_dev_descriptor);
            break;
        case USB_DT_CONFIG:
            memcpy(data, qemu_hub_config_descriptor, 
                   sizeof(qemu_hub_config_descriptor));
            ret = sizeof(qemu_hub_config_descriptor);
            break;
        case USB_DT_STRING:
            switch(value & 0xff) {
            case 0:
                /* language ids */
                data[0] = 4;
                data[1] = 3;
                data[2] = 0x09;
                data[3] = 0x04;
                ret = 4;
                break;
            case 1:
                /* serial number */
                ret = set_usb_string(data, "314159");
                break;
            case 2:
                /* product description */
                ret = set_usb_string(data, "QEMU USB Hub");
                break;
            case 3:
                /* vendor description */
                ret = set_usb_string(data, "QEMU " QEMU_VERSION);
                break;
            default:
                goto fail;
            }
            break;
        default:
            goto fail;
        }
        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 >= s->nb_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 >= s->nb_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->handle_packet(dev, 
                                       USB_MSG_RESET, 0, 0, NULL, 0);
                    port->wPortChange |= PORT_STAT_C_RESET;
                    /* set enable bit */
                    port->wPortChange |= PORT_STAT_C_ENABLE;
                    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;
            USBDevice *dev;
            if (n >= s->nb_ports)
                goto fail;
            port = &s->ports[n];
            dev = port->port.dev;
            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:
        memcpy(data, qemu_hub_hub_descriptor, 
               sizeof(qemu_hub_hub_descriptor));
        data[2] = s->nb_ports;
        ret = sizeof(qemu_hub_hub_descriptor);
        break;
    default:
    fail:
        ret = USB_RET_STALL;
        break;
    }
    return ret;
}

static int usb_hub_handle_data(USBDevice *dev, int pid, 
                               uint8_t devep, uint8_t *data, int len)
{
    USBHubState *s = (USBHubState *)dev;
    int ret;

    switch(pid) {
    case USB_TOKEN_IN:
        if (devep == 1) {
            USBHubPort *port;
            unsigned int status;
            int i, n;
            n = (s->nb_ports + 1 + 7) / 8;
            if (n > len)
                return USB_RET_BABBLE;
            status = 0;
            for(i = 0; i < s->nb_ports; i++) {
                port = &s->ports[i];
                if (port->wPortChange)
                    status |= (1 << (i + 1));
            }
            if (status != 0) {
                for(i = 0; i < n; i++) {
                    data[i] = status >> (8 * i);
                }
                ret = n;
            } else {
                ret = 0;
            }
        } 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, int pid, 
                                    uint8_t devaddr, uint8_t devep,
                                    uint8_t *data, int len)
{
    USBHubPort *port;
    USBDevice *dev;
    int i, ret;

    for(i = 0; i < s->nb_ports; i++) {
        port = &s->ports[i];
        dev = port->port.dev;
        if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
            ret = dev->handle_packet(dev, pid, 
                                     devaddr, devep,
                                     data, len);
            if (ret != USB_RET_NODEV) {
                return ret;
            }
        }
    }
    return USB_RET_NODEV;
}

static int usb_hub_handle_packet(USBDevice *dev, int pid, 
                                 uint8_t devaddr, uint8_t devep,
                                 uint8_t *data, int len)
{
    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 &&
        devaddr != dev->addr &&
        (pid == USB_TOKEN_SETUP || 
         pid == USB_TOKEN_OUT || 
         pid == USB_TOKEN_IN)) {
        /* broadcast the packet to the devices */
        return usb_hub_broadcast_packet(s, pid, devaddr, devep, data, len);
    }
    return usb_generic_handle_packet(dev, pid, devaddr, devep, data, len);
}

USBDevice *usb_hub_init(USBPort **usb_ports, int nb_ports)
{
    USBHubState *s;
    USBHubPort *port;
    int i;

    if (nb_ports > MAX_PORTS)
        return NULL;
    s = qemu_mallocz(sizeof(USBHubState));
    if (!s)
        return NULL;
    s->dev.speed = USB_SPEED_FULL;
    s->dev.handle_packet = usb_hub_handle_packet;

    /* generic USB device init */
    s->dev.handle_reset = usb_hub_handle_reset;
    s->dev.handle_control = usb_hub_handle_control;
    s->dev.handle_data = usb_hub_handle_data;

    s->nb_ports = nb_ports;
    for(i = 0; i < s->nb_ports; i++) {
        port = &s->ports[i];
        port->wPortStatus = PORT_STAT_POWER;
        port->wPortChange = 0;
        port->port.attach = usb_hub_attach;
        port->port.opaque = s;
        port->port.index = i;
        usb_ports[i] = &port->port;
    }
    return (USBDevice *)s;
}
Commit	Line	Data
72899afc FB	1	/*
	2	* QEMU USB HUB emulation
	3	*
	4	* Copyright (c) 2005 Fabrice Bellard
	5	*
	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	*/
	24	#include "vl.h"
	25
	26	//#define DEBUG
	27
	28	#define MAX_PORTS 8
	29
	30	typedef struct USBHubPort {
	31	USBPort port;
	32	uint16_t wPortStatus;
	33	uint16_t wPortChange;
	34	} USBHubPort;
	35
	36	typedef struct USBHubState {
	37	USBDevice dev;
	38	int nb_ports;
	39	USBHubPort ports[MAX_PORTS];
	40	} USBHubState;
	41
	42	#define ClearHubFeature (0x2000 \| USB_REQ_CLEAR_FEATURE)
	43	#define ClearPortFeature (0x2300 \| USB_REQ_CLEAR_FEATURE)
	44	#define GetHubDescriptor (0xa000 \| USB_REQ_GET_DESCRIPTOR)
	45	#define GetHubStatus (0xa000 \| USB_REQ_GET_STATUS)
	46	#define GetPortStatus (0xa300 \| USB_REQ_GET_STATUS)
	47	#define SetHubFeature (0x2000 \| USB_REQ_SET_FEATURE)
	48	#define SetPortFeature (0x2300 \| USB_REQ_SET_FEATURE)
	49
	50	#define PORT_STAT_CONNECTION 0x0001
	51	#define PORT_STAT_ENABLE 0x0002
	52	#define PORT_STAT_SUSPEND 0x0004
	53	#define PORT_STAT_OVERCURRENT 0x0008
	54	#define PORT_STAT_RESET 0x0010
	55	#define PORT_STAT_POWER 0x0100
	56	#define PORT_STAT_LOW_SPEED 0x0200
	57	#define PORT_STAT_HIGH_SPEED 0x0400
	58	#define PORT_STAT_TEST 0x0800
	59	#define PORT_STAT_INDICATOR 0x1000
	60
	61	#define PORT_STAT_C_CONNECTION 0x0001
	62	#define PORT_STAT_C_ENABLE 0x0002
	63	#define PORT_STAT_C_SUSPEND 0x0004
	64	#define PORT_STAT_C_OVERCURRENT 0x0008
65	#define PORT_STAT_C_RESET 0x0010
66
67	#define PORT_CONNECTION 0
68	#define PORT_ENABLE 1
69	#define PORT_SUSPEND 2
70	#define PORT_OVERCURRENT 3
71	#define PORT_RESET 4
72	#define PORT_POWER 8
73	#define PORT_LOWSPEED 9
74	#define PORT_HIGHSPEED 10
75	#define PORT_C_CONNECTION 16
76	#define PORT_C_ENABLE 17
77	#define PORT_C_SUSPEND 18
78	#define PORT_C_OVERCURRENT 19
79	#define PORT_C_RESET 20
80	#define PORT_TEST 21
81	#define PORT_INDICATOR 22
82
83	/* same as Linux kernel root hubs */
84
85	static const uint8_t qemu_hub_dev_descriptor[] = {
86	0x12, /* u8 bLength; */
87	0x01, /* u8 bDescriptorType; Device */
88	0x10, 0x01, /* u16 bcdUSB; v1.1 */
89
90	0x09, /* u8 bDeviceClass; HUB_CLASSCODE */
91	0x00, /* u8 bDeviceSubClass; */
92	0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
93	0x08, /* u8 bMaxPacketSize0; 8 Bytes */
94
95	0x00, 0x00, /* u16 idVendor; */
96	0x00, 0x00, /* u16 idProduct; */
97	0x01, 0x01, /* u16 bcdDevice */
98
99	0x03, /* u8 iManufacturer; */
100	0x02, /* u8 iProduct; */
101	0x01, /* u8 iSerialNumber; */
102	0x01 /* u8 bNumConfigurations; */
103	};
104
105	/* XXX: patch interrupt size */
106	static const uint8_t qemu_hub_config_descriptor[] = {
107
108	/* one configuration */
109	0x09, /* u8 bLength; */
110	0x02, /* u8 bDescriptorType; Configuration */
111	0x19, 0x00, /* u16 wTotalLength; */
112	0x01, /* u8 bNumInterfaces; (1) */
113	0x01, /* u8 bConfigurationValue; */
114	0x00, /* u8 iConfiguration; */
115	0xc0, /* u8 bmAttributes;
116	Bit 7: must be set,
117	6: Self-powered,
118	5: Remote wakeup,
119	4..0: resvd */
120	0x00, /* u8 MaxPower; */
121
122	/* USB 1.1:
123	* USB 2.0, single TT organization (mandatory):
124	* one interface, protocol 0
125	*
126	* USB 2.0, multiple TT organization (optional):
127	* two interfaces, protocols 1 (like single TT)
128	* and 2 (multiple TT mode) ... config is
129	* sometimes settable
130	* NOT IMPLEMENTED
131	*/
132
133	/* one interface */
134	0x09, /* u8 if_bLength; */
135	0x04, /* u8 if_bDescriptorType; Interface */
136	0x00, /* u8 if_bInterfaceNumber; */
137	0x00, /* u8 if_bAlternateSetting; */
138	0x01, /* u8 if_bNumEndpoints; */
139	0x09, /* u8 if_bInterfaceClass; HUB_CLASSCODE */
140	0x00, /* u8 if_bInterfaceSubClass; */
141	0x00, /* u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
142	0x00, /* u8 if_iInterface; */
143
144	/* one endpoint (status change endpoint) */
145	0x07, /* u8 ep_bLength; */
146	0x05, /* u8 ep_bDescriptorType; Endpoint */
147	0x81, /* u8 ep_bEndpointAddress; IN Endpoint 1 */
148	0x03, /* u8 ep_bmAttributes; Interrupt */
149	0x02, 0x00, /* u16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
150	0xff /* u8 ep_bInterval; (255ms -- usb 2.0 spec) */
151	};
152
153	static const uint8_t qemu_hub_hub_descriptor[] =
154	{
155	0x09, /* u8 bLength; */
156	0x29, /* u8 bDescriptorType; Hub-descriptor */
157	0x00, /* u8 bNbrPorts; (patched later) */
158	0x0a, /* u16 wHubCharacteristics; */
159	0x00, /* (per-port OC, no power switching) */
160	0x01, /* u8 bPwrOn2pwrGood; 2ms */
161	0x00, /* u8 bHubContrCurrent; 0 mA */
162	0x00, /* u8 DeviceRemovable; * 7 Ports max * */
163	0xff /* u8 PortPwrCtrlMask; * 7 ports max * */
164	};
165
166	static void usb_hub_attach(USBPort port1, USBDevice dev)
167	{
168	USBHubState *s = port1->opaque;
169	USBHubPort *port = &s->ports[port1->index];
170
171	if (dev) {
172	if (port->port.dev)
173	usb_attach(port1, NULL);
174
175	port->wPortStatus \|= PORT_STAT_CONNECTION;
176	port->wPortChange \|= PORT_STAT_C_CONNECTION;
177	if (dev->speed == USB_SPEED_LOW)
178	port->wPortStatus \|= PORT_STAT_LOW_SPEED;
179	else
180	port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
181	port->port.dev = dev;
182	} else {
183	dev = port->port.dev;
184	if (dev) {
185	port->wPortStatus &= ~PORT_STAT_CONNECTION;
186	port->wPortChange \|= PORT_STAT_C_CONNECTION;
187	if (port->wPortStatus & PORT_STAT_ENABLE) {
188	port->wPortStatus &= ~PORT_STAT_ENABLE;
189	port->wPortChange \|= PORT_STAT_C_ENABLE;
190	}
191	port->port.dev = NULL;
192	}
193	}
194	}
195
196	static void usb_hub_handle_reset(USBDevice *dev)
197	{
198	/* XXX: do it */
199	}
200
201	static int usb_hub_handle_control(USBDevice *dev, int request, int value,
202	int index, int length, uint8_t *data)
203	{
204	USBHubState s = (USBHubState )dev;
205	int ret;
206
207	switch(request) {
208	case DeviceRequest \| USB_REQ_GET_STATUS:
209	data[0] = (1 << USB_DEVICE_SELF_POWERED) \|
210	(dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
211	data[1] = 0x00;
212	ret = 2;
213	break;
214	case DeviceOutRequest \| USB_REQ_CLEAR_FEATURE:
215	if (value == USB_DEVICE_REMOTE_WAKEUP) {
216	dev->remote_wakeup = 0;
217	} else {
218	goto fail;
219	}
220	ret = 0;
221	break;
222	case DeviceOutRequest \| USB_REQ_SET_FEATURE:
223	if (value == USB_DEVICE_REMOTE_WAKEUP) {
224	dev->remote_wakeup = 1;
225	} else {
226	goto fail;
227	}
228	ret = 0;
229	break;
230	case DeviceOutRequest \| USB_REQ_SET_ADDRESS:
231	dev->addr = value;
232	ret = 0;
233	break;
234	case DeviceRequest \| USB_REQ_GET_DESCRIPTOR:
235	switch(value >> 8) {
236	case USB_DT_DEVICE:
237	memcpy(data, qemu_hub_dev_descriptor,
238	sizeof(qemu_hub_dev_descriptor));
239	ret = sizeof(qemu_hub_dev_descriptor);
240	break;
241	case USB_DT_CONFIG:
242	memcpy(data, qemu_hub_config_descriptor,
243	sizeof(qemu_hub_config_descriptor));
244	ret = sizeof(qemu_hub_config_descriptor);
245	break;
246	case USB_DT_STRING:
247	switch(value & 0xff) {
248	case 0:
249	/* language ids */
250	data[0] = 4;
251	data[1] = 3;
252	data[2] = 0x09;
253	data[3] = 0x04;
254	ret = 4;
255	break;
256	case 1:
257	/* serial number */
258	ret = set_usb_string(data, "314159");
259	break;
260	case 2:
261	/* product description */
262	ret = set_usb_string(data, "QEMU USB Hub");
263	break;
264	case 3:
265	/* vendor description */
266	ret = set_usb_string(data, "QEMU " QEMU_VERSION);
267	break;
268	default:
269	goto fail;
270	}
271	break;
272	default:
273	goto fail;
274	}
275	break;
276	case DeviceRequest \| USB_REQ_GET_CONFIGURATION:
277	data[0] = 1;
278	ret = 1;
279	break;
280	case DeviceOutRequest \| USB_REQ_SET_CONFIGURATION:
281	ret = 0;
282	break;
283	case DeviceRequest \| USB_REQ_GET_INTERFACE:
284	data[0] = 0;
285	ret = 1;
286	break;
287	case DeviceOutRequest \| USB_REQ_SET_INTERFACE:
288	ret = 0;
289	break;
290	/* usb specific requests */
291	case GetHubStatus:
292	data[0] = 0;
293	data[1] = 0;
294	data[2] = 0;
295	data[3] = 0;
296	ret = 4;
297	break;
298	case GetPortStatus:
299	{
300	unsigned int n = index - 1;
301	USBHubPort *port;
302	if (n >= s->nb_ports)
303	goto fail;
304	port = &s->ports[n];
305	data[0] = port->wPortStatus;
306	data[1] = port->wPortStatus >> 8;
307	data[2] = port->wPortChange;
308	data[3] = port->wPortChange >> 8;
309	ret = 4;
310	}
311	break;
312	case SetHubFeature:
313	case ClearHubFeature:
314	if (value == 0 \|\| value == 1) {
315	} else {
316	goto fail;
317	}
318	ret = 0;
319	break;
320	case SetPortFeature:
321	{
322	unsigned int n = index - 1;
323	USBHubPort *port;
324	USBDevice *dev;
325	if (n >= s->nb_ports)
326	goto fail;
327	port = &s->ports[n];
328	dev = port->port.dev;
329	switch(value) {
330	case PORT_SUSPEND:
331	port->wPortStatus \|= PORT_STAT_SUSPEND;
332	break;
333	case PORT_RESET:
334	if (dev) {
335	dev->handle_packet(dev,
336	USB_MSG_RESET, 0, 0, NULL, 0);
337	port->wPortChange \|= PORT_STAT_C_RESET;
338	/* set enable bit */
339	port->wPortChange \|= PORT_STAT_C_ENABLE;
340	port->wPortStatus \|= PORT_STAT_ENABLE;
341	}
342	break;
343	case PORT_POWER:
344	break;
345	default:
346	goto fail;
347	}
348	ret = 0;
349	}
350	break;
351	case ClearPortFeature:
352	{
353	unsigned int n = index - 1;
354	USBHubPort *port;
355	USBDevice *dev;
356	if (n >= s->nb_ports)
357	goto fail;
358	port = &s->ports[n];
359	dev = port->port.dev;
360	switch(value) {
361	case PORT_ENABLE:
362	port->wPortStatus &= ~PORT_STAT_ENABLE;
363	break;
364	case PORT_C_ENABLE:
365	port->wPortChange &= ~PORT_STAT_C_ENABLE;
366	break;
367	case PORT_SUSPEND:
368	port->wPortStatus &= ~PORT_STAT_SUSPEND;
369	break;
370	case PORT_C_SUSPEND:
371	port->wPortChange &= ~PORT_STAT_C_SUSPEND;
372	break;
373	case PORT_C_CONNECTION:
374	port->wPortChange &= ~PORT_STAT_C_CONNECTION;
375	break;
376	case PORT_C_OVERCURRENT:
377	port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
378	break;
379	case PORT_C_RESET:
380	port->wPortChange &= ~PORT_STAT_C_RESET;
381	break;
382	default:
383	goto fail;
384	}
385	ret = 0;
386	}
387	break;
388	case GetHubDescriptor:
389	memcpy(data, qemu_hub_hub_descriptor,
390	sizeof(qemu_hub_hub_descriptor));
391	data[2] = s->nb_ports;
392	ret = sizeof(qemu_hub_hub_descriptor);
393	break;
394	default:
395	fail:
396	ret = USB_RET_STALL;
397	break;
398	}
399	return ret;
400	}
401
402	static int usb_hub_handle_data(USBDevice *dev, int pid,
403	uint8_t devep, uint8_t *data, int len)
404	{
405	USBHubState s = (USBHubState )dev;
406	int ret;
407
408	switch(pid) {
409	case USB_TOKEN_IN:
410	if (devep == 1) {
411	USBHubPort *port;
412	unsigned int status;
413	int i, n;
414	n = (s->nb_ports + 1 + 7) / 8;
415	if (n > len)
416	return USB_RET_BABBLE;
417	status = 0;
418	for(i = 0; i < s->nb_ports; i++) {
419	port = &s->ports[i];
420	if (port->wPortChange)
421	status \|= (1 << (i + 1));
422	}
423	if (status != 0) {
424	for(i = 0; i < n; i++) {
425	data[i] = status >> (8 * i);
426	}
427	ret = n;
428	} else {
429	ret = 0;
430	}
431	} else {
432	goto fail;
433	}
434	break;
435	case USB_TOKEN_OUT:
436	default:
437	fail:
438	ret = USB_RET_STALL;
439	break;
440	}
441	return ret;
442	}
443
444	static int usb_hub_broadcast_packet(USBHubState *s, int pid,
445	uint8_t devaddr, uint8_t devep,
446	uint8_t *data, int len)
447	{
448	USBHubPort *port;
449	USBDevice *dev;
450	int i, ret;
451
452	for(i = 0; i < s->nb_ports; i++) {
453	port = &s->ports[i];
454	dev = port->port.dev;
455	if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
456	ret = dev->handle_packet(dev, pid,
457	devaddr, devep,
458	data, len);
459	if (ret != USB_RET_NODEV) {
460	return ret;
461	}
462	}
463	}
464	return USB_RET_NODEV;
465	}
466
467	static int usb_hub_handle_packet(USBDevice *dev, int pid,
468	uint8_t devaddr, uint8_t devep,
469	uint8_t *data, int len)
470	{
471	USBHubState s = (USBHubState )dev;
472
473	#if defined(DEBUG) && 0
474	printf("usb_hub: pid=0x%x\n", pid);
475	#endif
476	if (dev->state == USB_STATE_DEFAULT &&
477	dev->addr != 0 &&
478	devaddr != dev->addr &&
479	(pid == USB_TOKEN_SETUP \|\|
480	pid == USB_TOKEN_OUT \|\|
481	pid == USB_TOKEN_IN)) {
482	/* broadcast the packet to the devices */
483	return usb_hub_broadcast_packet(s, pid, devaddr, devep, data, len);
484	}
485	return usb_generic_handle_packet(dev, pid, devaddr, devep, data, len);
486	}
487
488	USBDevice usb_hub_init(USBPort *usb_ports, int nb_ports)
489	{
490	USBHubState *s;
491	USBHubPort *port;
492	int i;
493
494	if (nb_ports > MAX_PORTS)
495	return NULL;
496	s = qemu_mallocz(sizeof(USBHubState));
497	if (!s)
498	return NULL;
499	s->dev.speed = USB_SPEED_FULL;
500	s->dev.handle_packet = usb_hub_handle_packet;
501
502	/* generic USB device init */
503	s->dev.handle_reset = usb_hub_handle_reset;
504	s->dev.handle_control = usb_hub_handle_control;
505	s->dev.handle_data = usb_hub_handle_data;
506
507	s->nb_ports = nb_ports;
508	for(i = 0; i < s->nb_ports; i++) {
509	port = &s->ports[i];
510	port->wPortStatus = PORT_STAT_POWER;
511	port->wPortChange = 0;
512	port->port.attach = usb_hub_attach;
513	port->port.opaque = s;
514	port->port.index = i;
515	usb_ports[i] = &port->port;
516	}
517	return (USBDevice *)s;
518	}