2 * QEMU USB HUB emulation
4 * Copyright (c) 2005 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
30 typedef struct USBHubPort {
36 typedef struct USBHubState {
39 USBHubPort ports[MAX_PORTS];
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)
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
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
67 #define PORT_CONNECTION 0
69 #define PORT_SUSPEND 2
70 #define PORT_OVERCURRENT 3
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
81 #define PORT_INDICATOR 22
83 /* same as Linux kernel root hubs */
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 */
90 0x09, /* u8 bDeviceClass; HUB_CLASSCODE */
91 0x00, /* u8 bDeviceSubClass; */
92 0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
93 0x08, /* u8 bMaxPacketSize0; 8 Bytes */
95 0x00, 0x00, /* u16 idVendor; */
96 0x00, 0x00, /* u16 idProduct; */
97 0x01, 0x01, /* u16 bcdDevice */
99 0x03, /* u8 iManufacturer; */
100 0x02, /* u8 iProduct; */
101 0x01, /* u8 iSerialNumber; */
102 0x01 /* u8 bNumConfigurations; */
105 /* XXX: patch interrupt size */
106 static const uint8_t qemu_hub_config_descriptor[] = {
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;
120 0x00, /* u8 MaxPower; */
123 * USB 2.0, single TT organization (mandatory):
124 * one interface, protocol 0
126 * USB 2.0, multiple TT organization (optional):
127 * two interfaces, protocols 1 (like single TT)
128 * and 2 (multiple TT mode) ... config is
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; */
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) */
153 static const uint8_t qemu_hub_hub_descriptor[] =
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 */
163 /* DeviceRemovable and PortPwrCtrlMask patched in later */
166 static void usb_hub_attach(USBPort *port1, USBDevice *dev)
168 USBHubState *s = port1->opaque;
169 USBHubPort *port = &s->ports[port1->index];
173 usb_attach(port1, NULL);
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;
180 port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
181 port->port.dev = dev;
183 dev = port->port.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;
191 port->port.dev = NULL;
196 static void usb_hub_handle_reset(USBDevice *dev)
201 static int usb_hub_handle_control(USBDevice *dev, int request, int value,
202 int index, int length, uint8_t *data)
204 USBHubState *s = (USBHubState *)dev;
208 case DeviceRequest | USB_REQ_GET_STATUS:
209 data[0] = (1 << USB_DEVICE_SELF_POWERED) |
210 (dev->remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
214 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
215 if (value == USB_DEVICE_REMOTE_WAKEUP) {
216 dev->remote_wakeup = 0;
222 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
223 if (value == 0 && index != 0x81) { /* clear ep halt */
228 case DeviceOutRequest | USB_REQ_SET_FEATURE:
229 if (value == USB_DEVICE_REMOTE_WAKEUP) {
230 dev->remote_wakeup = 1;
236 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
240 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
243 memcpy(data, qemu_hub_dev_descriptor,
244 sizeof(qemu_hub_dev_descriptor));
245 ret = sizeof(qemu_hub_dev_descriptor);
248 memcpy(data, qemu_hub_config_descriptor,
249 sizeof(qemu_hub_config_descriptor));
251 /* status change endpoint size based on number
253 data[22] = (s->nb_ports + 1 + 7) / 8;
255 ret = sizeof(qemu_hub_config_descriptor);
258 switch(value & 0xff) {
269 ret = set_usb_string(data, "314159");
272 /* product description */
273 ret = set_usb_string(data, "QEMU USB Hub");
276 /* vendor description */
277 ret = set_usb_string(data, "QEMU " QEMU_VERSION);
287 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
291 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
294 case DeviceRequest | USB_REQ_GET_INTERFACE:
298 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
301 /* usb specific requests */
311 unsigned int n = index - 1;
313 if (n >= s->nb_ports)
316 data[0] = port->wPortStatus;
317 data[1] = port->wPortStatus >> 8;
318 data[2] = port->wPortChange;
319 data[3] = port->wPortChange >> 8;
324 case ClearHubFeature:
325 if (value == 0 || value == 1) {
333 unsigned int n = index - 1;
336 if (n >= s->nb_ports)
339 dev = port->port.dev;
342 port->wPortStatus |= PORT_STAT_SUSPEND;
346 dev->handle_packet(dev,
347 USB_MSG_RESET, 0, 0, NULL, 0);
348 port->wPortChange |= PORT_STAT_C_RESET;
350 port->wPortStatus |= PORT_STAT_ENABLE;
361 case ClearPortFeature:
363 unsigned int n = index - 1;
366 if (n >= s->nb_ports)
369 dev = port->port.dev;
372 port->wPortStatus &= ~PORT_STAT_ENABLE;
375 port->wPortChange &= ~PORT_STAT_C_ENABLE;
378 port->wPortStatus &= ~PORT_STAT_SUSPEND;
381 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
383 case PORT_C_CONNECTION:
384 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
386 case PORT_C_OVERCURRENT:
387 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
390 port->wPortChange &= ~PORT_STAT_C_RESET;
398 case GetHubDescriptor:
400 unsigned int n, limit, var_hub_size = 0;
401 memcpy(data, qemu_hub_hub_descriptor,
402 sizeof(qemu_hub_hub_descriptor));
403 data[2] = s->nb_ports;
405 /* fill DeviceRemovable bits */
406 limit = ((s->nb_ports + 1 + 7) / 8) + 7;
407 for (n = 7; n < limit; n++) {
412 /* fill PortPwrCtrlMask bits */
413 limit = limit + ((s->nb_ports + 7) / 8);
414 for (;n < limit; n++) {
419 ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
430 static int usb_hub_handle_data(USBDevice *dev, int pid,
431 uint8_t devep, uint8_t *data, int len)
433 USBHubState *s = (USBHubState *)dev;
442 n = (s->nb_ports + 1 + 7) / 8;
443 if (len == 1) { /* FreeBSD workaround */
445 } else if (n > len) {
446 return USB_RET_BABBLE;
449 for(i = 0; i < s->nb_ports; i++) {
451 if (port->wPortChange)
452 status |= (1 << (i + 1));
455 for(i = 0; i < n; i++) {
456 data[i] = status >> (8 * i);
460 ret = USB_RET_NAK; /* usb11 11.13.1 */
475 static int usb_hub_broadcast_packet(USBHubState *s, int pid,
476 uint8_t devaddr, uint8_t devep,
477 uint8_t *data, int len)
483 for(i = 0; i < s->nb_ports; i++) {
485 dev = port->port.dev;
486 if (dev && (port->wPortStatus & PORT_STAT_ENABLE)) {
487 ret = dev->handle_packet(dev, pid,
490 if (ret != USB_RET_NODEV) {
495 return USB_RET_NODEV;
498 static int usb_hub_handle_packet(USBDevice *dev, int pid,
499 uint8_t devaddr, uint8_t devep,
500 uint8_t *data, int len)
502 USBHubState *s = (USBHubState *)dev;
504 #if defined(DEBUG) && 0
505 printf("usb_hub: pid=0x%x\n", pid);
507 if (dev->state == USB_STATE_DEFAULT &&
509 devaddr != dev->addr &&
510 (pid == USB_TOKEN_SETUP ||
511 pid == USB_TOKEN_OUT ||
512 pid == USB_TOKEN_IN)) {
513 /* broadcast the packet to the devices */
514 return usb_hub_broadcast_packet(s, pid, devaddr, devep, data, len);
516 return usb_generic_handle_packet(dev, pid, devaddr, devep, data, len);
519 USBDevice *usb_hub_init(USBPort **usb_ports, int nb_ports)
525 if (nb_ports > MAX_PORTS)
527 s = qemu_mallocz(sizeof(USBHubState));
530 s->dev.speed = USB_SPEED_FULL;
531 s->dev.handle_packet = usb_hub_handle_packet;
533 /* generic USB device init */
534 s->dev.handle_reset = usb_hub_handle_reset;
535 s->dev.handle_control = usb_hub_handle_control;
536 s->dev.handle_data = usb_hub_handle_data;
538 s->nb_ports = nb_ports;
539 for(i = 0; i < s->nb_ports; i++) {
541 port->wPortStatus = PORT_STAT_POWER;
542 port->wPortChange = 0;
543 port->port.attach = usb_hub_attach;
544 port->port.opaque = s;
545 port->port.index = i;
546 usb_ports[i] = &port->port;
548 return (USBDevice *)s;