blob: bc035316660416d1b357f60ee448ba948e4254f4 [file] [log] [blame]
bellard72899af2006-04-24 21:18:20 +00001/*
2 * QEMU USB HUB emulation
3 *
4 * Copyright (c) 2005 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellard72899af2006-04-24 21:18:20 +00006 * 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 */
pbrook87ecb682007-11-17 17:14:51 +000024#include "qemu-common.h"
Gerd Hoffmann529f8f92012-03-23 15:42:58 +010025#include "trace.h"
Gerd Hoffmannf1ae32a2012-03-07 14:55:18 +010026#include "hw/usb.h"
27#include "hw/usb/desc.h"
Gerd Hoffmannc24e4aa2013-03-20 11:40:02 +010028#include "qemu/error-report.h"
bellard72899af2006-04-24 21:18:20 +000029
Gerd Hoffmann062651c2010-11-26 13:13:22 +010030#define NUM_PORTS 8
bellard72899af2006-04-24 21:18:20 +000031
32typedef struct USBHubPort {
33 USBPort port;
34 uint16_t wPortStatus;
35 uint16_t wPortChange;
36} USBHubPort;
37
38typedef struct USBHubState {
39 USBDevice dev;
Gerd Hoffmann7567b512012-01-17 13:25:46 +010040 USBEndpoint *intr;
Gerd Hoffmann062651c2010-11-26 13:13:22 +010041 USBHubPort ports[NUM_PORTS];
bellard72899af2006-04-24 21:18:20 +000042} 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
Gerd Hoffmann062651c2010-11-26 13:13:22 +010087enum {
88 STR_MANUFACTURER = 1,
89 STR_PRODUCT,
90 STR_SERIALNUMBER,
91};
92
93static const USBDescStrings desc_strings = {
Crístian Viana93bfef42012-05-30 00:35:51 -030094 [STR_MANUFACTURER] = "QEMU",
Gerd Hoffmann062651c2010-11-26 13:13:22 +010095 [STR_PRODUCT] = "QEMU USB Hub",
96 [STR_SERIALNUMBER] = "314159",
97};
98
99static 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
113static 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,
Pantelis Koukousoulasbd939762013-12-16 09:42:49 +0200122 .bmAttributes = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
123 USB_CFG_ATT_WAKEUP,
Brad Hardsadd75082011-04-03 15:33:19 +1000124 .nif = 1,
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100125 .ifs = &desc_iface_hub,
126 },
127 },
128};
129
130static const USBDesc desc_hub = {
131 .id = {
Roy Tamdb803582011-09-15 11:25:47 +0800132 .idVendor = 0x0409,
133 .idProduct = 0x55aa,
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100134 .bcdDevice = 0x0101,
135 .iManufacturer = STR_MANUFACTURER,
136 .iProduct = STR_PRODUCT,
137 .iSerialNumber = STR_SERIALNUMBER,
138 },
139 .full = &desc_device_hub,
140 .str = desc_strings,
141};
142
bellard72899af2006-04-24 21:18:20 +0000143static const uint8_t qemu_hub_hub_descriptor[] =
144{
bellard67f36562006-05-05 20:05:35 +0000145 0x00, /* u8 bLength; patched in later */
bellard72899af2006-04-24 21:18:20 +0000146 0x29, /* u8 bDescriptorType; Hub-descriptor */
147 0x00, /* u8 bNbrPorts; (patched later) */
148 0x0a, /* u16 wHubCharacteristics; */
149 0x00, /* (per-port OC, no power switching) */
150 0x01, /* u8 bPwrOn2pwrGood; 2ms */
bellard985d1742006-04-30 21:53:59 +0000151 0x00 /* u8 bHubContrCurrent; 0 mA */
152
153 /* DeviceRemovable and PortPwrCtrlMask patched in later */
bellard72899af2006-04-24 21:18:20 +0000154};
155
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100156static void usb_hub_attach(USBPort *port1)
bellard72899af2006-04-24 21:18:20 +0000157{
158 USBHubState *s = port1->opaque;
159 USBHubPort *port = &s->ports[port1->index];
ths3b46e622007-09-17 08:09:54 +0000160
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100161 trace_usb_hub_attach(s->dev.addr, port1->index + 1);
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100162 port->wPortStatus |= PORT_STAT_CONNECTION;
163 port->wPortChange |= PORT_STAT_C_CONNECTION;
164 if (port->port.dev->speed == USB_SPEED_LOW) {
165 port->wPortStatus |= PORT_STAT_LOW_SPEED;
bellard72899af2006-04-24 21:18:20 +0000166 } else {
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100167 port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
168 }
Gerd Hoffmann8550a022013-01-29 12:44:35 +0100169 usb_wakeup(s->intr, 0);
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100170}
171
172static void usb_hub_detach(USBPort *port1)
173{
174 USBHubState *s = port1->opaque;
175 USBHubPort *port = &s->ports[port1->index];
176
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100177 trace_usb_hub_detach(s->dev.addr, port1->index + 1);
Gerd Hoffmann8550a022013-01-29 12:44:35 +0100178 usb_wakeup(s->intr, 0);
Gerd Hoffmannbe35cbb2011-11-22 13:20:14 +0100179
Hans de Goede4706ab62011-06-24 12:31:11 +0200180 /* Let upstream know the device on this port is gone */
181 s->dev.port->ops->child_detach(s->dev.port, port1->dev);
182
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100183 port->wPortStatus &= ~PORT_STAT_CONNECTION;
184 port->wPortChange |= PORT_STAT_C_CONNECTION;
185 if (port->wPortStatus & PORT_STAT_ENABLE) {
186 port->wPortStatus &= ~PORT_STAT_ENABLE;
187 port->wPortChange |= PORT_STAT_C_ENABLE;
bellard72899af2006-04-24 21:18:20 +0000188 }
Gerd Hoffmann8550a022013-01-29 12:44:35 +0100189 usb_wakeup(s->intr, 0);
bellard72899af2006-04-24 21:18:20 +0000190}
191
Hans de Goede4706ab62011-06-24 12:31:11 +0200192static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
193{
194 USBHubState *s = port1->opaque;
195
196 /* Pass along upstream */
197 s->dev.port->ops->child_detach(s->dev.port, child);
198}
199
Hans de Goeded47e59b2011-06-21 11:52:28 +0200200static void usb_hub_wakeup(USBPort *port1)
Gerd Hoffmann34239c72010-12-15 12:26:59 +0100201{
Hans de Goeded47e59b2011-06-21 11:52:28 +0200202 USBHubState *s = port1->opaque;
203 USBHubPort *port = &s->ports[port1->index];
Gerd Hoffmann34239c72010-12-15 12:26:59 +0100204
205 if (port->wPortStatus & PORT_STAT_SUSPEND) {
206 port->wPortChange |= PORT_STAT_C_SUSPEND;
Gerd Hoffmann8550a022013-01-29 12:44:35 +0100207 usb_wakeup(s->intr, 0);
Gerd Hoffmann34239c72010-12-15 12:26:59 +0100208 }
209}
210
Hans de Goeded47e59b2011-06-21 11:52:28 +0200211static void usb_hub_complete(USBPort *port, USBPacket *packet)
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100212{
Hans de Goeded47e59b2011-06-21 11:52:28 +0200213 USBHubState *s = port->opaque;
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100214
215 /*
216 * Just pass it along upstream for now.
217 *
Gerd Hoffmann80cf7cf2011-10-13 12:52:47 +0200218 * If we ever implement usb 2.0 split transactions this will
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100219 * become a little more complicated ...
Gerd Hoffmann80cf7cf2011-10-13 12:52:47 +0200220 *
221 * Can't use usb_packet_complete() here because packet->owner is
222 * cleared already, go call the ->complete() callback directly
223 * instead.
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100224 */
Gerd Hoffmann80cf7cf2011-10-13 12:52:47 +0200225 s->dev.port->ops->complete(s->dev.port, packet);
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100226}
227
Gerd Hoffmann06c75082012-01-10 17:08:13 +0100228static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr)
229{
230 USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
231 USBHubPort *port;
232 USBDevice *downstream;
233 int i;
234
235 for (i = 0; i < NUM_PORTS; i++) {
236 port = &s->ports[i];
237 if (!(port->wPortStatus & PORT_STAT_ENABLE)) {
238 continue;
239 }
240 downstream = usb_find_device(&port->port, addr);
241 if (downstream != NULL) {
242 return downstream;
243 }
244 }
245 return NULL;
246}
247
bellard059809e2006-07-19 18:06:15 +0000248static void usb_hub_handle_reset(USBDevice *dev)
bellard72899af2006-04-24 21:18:20 +0000249{
Gerd Hoffmann20d183b2011-11-23 13:31:08 +0100250 USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
251 USBHubPort *port;
252 int i;
253
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100254 trace_usb_hub_reset(s->dev.addr);
Gerd Hoffmann20d183b2011-11-23 13:31:08 +0100255 for (i = 0; i < NUM_PORTS; i++) {
256 port = s->ports + i;
257 port->wPortStatus = PORT_STAT_POWER;
258 port->wPortChange = 0;
259 if (port->port.dev && port->port.dev->attached) {
260 port->wPortStatus |= PORT_STAT_CONNECTION;
261 port->wPortChange |= PORT_STAT_C_CONNECTION;
262 if (port->port.dev->speed == USB_SPEED_LOW) {
263 port->wPortStatus |= PORT_STAT_LOW_SPEED;
264 }
265 }
266 }
bellard72899af2006-04-24 21:18:20 +0000267}
268
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100269static const char *feature_name(int feature)
270{
271 static const char *name[] = {
272 [PORT_CONNECTION] = "connection",
273 [PORT_ENABLE] = "enable",
274 [PORT_SUSPEND] = "suspend",
275 [PORT_OVERCURRENT] = "overcurrent",
276 [PORT_RESET] = "reset",
277 [PORT_POWER] = "power",
278 [PORT_LOWSPEED] = "lowspeed",
279 [PORT_HIGHSPEED] = "highspeed",
280 [PORT_C_CONNECTION] = "change connection",
281 [PORT_C_ENABLE] = "change enable",
282 [PORT_C_SUSPEND] = "change suspend",
283 [PORT_C_OVERCURRENT] = "change overcurrent",
284 [PORT_C_RESET] = "change reset",
285 [PORT_TEST] = "test",
286 [PORT_INDICATOR] = "indicator",
287 };
288 if (feature < 0 || feature >= ARRAY_SIZE(name)) {
289 return "?";
290 }
291 return name[feature] ?: "?";
292}
293
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100294static void usb_hub_handle_control(USBDevice *dev, USBPacket *p,
Hans de Goede007fd622011-02-02 16:33:13 +0100295 int request, int value, int index, int length, uint8_t *data)
bellard72899af2006-04-24 21:18:20 +0000296{
297 USBHubState *s = (USBHubState *)dev;
298 int ret;
299
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100300 trace_usb_hub_control(s->dev.addr, request, value, index, length);
301
Hans de Goede007fd622011-02-02 16:33:13 +0100302 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100303 if (ret >= 0) {
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100304 return;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100305 }
306
bellard72899af2006-04-24 21:18:20 +0000307 switch(request) {
bellard985d1742006-04-30 21:53:59 +0000308 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
309 if (value == 0 && index != 0x81) { /* clear ep halt */
310 goto fail;
311 }
bellard985d1742006-04-30 21:53:59 +0000312 break;
bellard72899af2006-04-24 21:18:20 +0000313 /* usb specific requests */
314 case GetHubStatus:
315 data[0] = 0;
316 data[1] = 0;
317 data[2] = 0;
318 data[3] = 0;
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100319 p->actual_length = 4;
bellard72899af2006-04-24 21:18:20 +0000320 break;
321 case GetPortStatus:
322 {
323 unsigned int n = index - 1;
324 USBHubPort *port;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100325 if (n >= NUM_PORTS) {
bellard72899af2006-04-24 21:18:20 +0000326 goto fail;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100327 }
bellard72899af2006-04-24 21:18:20 +0000328 port = &s->ports[n];
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100329 trace_usb_hub_get_port_status(s->dev.addr, index,
330 port->wPortStatus,
331 port->wPortChange);
bellard72899af2006-04-24 21:18:20 +0000332 data[0] = port->wPortStatus;
333 data[1] = port->wPortStatus >> 8;
334 data[2] = port->wPortChange;
335 data[3] = port->wPortChange >> 8;
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100336 p->actual_length = 4;
bellard72899af2006-04-24 21:18:20 +0000337 }
338 break;
339 case SetHubFeature:
340 case ClearHubFeature:
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100341 if (value != 0 && value != 1) {
bellard72899af2006-04-24 21:18:20 +0000342 goto fail;
343 }
bellard72899af2006-04-24 21:18:20 +0000344 break;
345 case SetPortFeature:
346 {
347 unsigned int n = index - 1;
348 USBHubPort *port;
349 USBDevice *dev;
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100350
351 trace_usb_hub_set_port_feature(s->dev.addr, index,
352 feature_name(value));
353
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100354 if (n >= NUM_PORTS) {
bellard72899af2006-04-24 21:18:20 +0000355 goto fail;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100356 }
bellard72899af2006-04-24 21:18:20 +0000357 port = &s->ports[n];
358 dev = port->port.dev;
359 switch(value) {
360 case PORT_SUSPEND:
361 port->wPortStatus |= PORT_STAT_SUSPEND;
362 break;
363 case PORT_RESET:
Gerd Hoffmann3393bc12011-09-15 09:20:02 +0200364 if (dev && dev->attached) {
Gerd Hoffmannd28f4e22012-01-06 15:23:10 +0100365 usb_device_reset(dev);
bellard72899af2006-04-24 21:18:20 +0000366 port->wPortChange |= PORT_STAT_C_RESET;
367 /* set enable bit */
bellard72899af2006-04-24 21:18:20 +0000368 port->wPortStatus |= PORT_STAT_ENABLE;
Gerd Hoffmann8550a022013-01-29 12:44:35 +0100369 usb_wakeup(s->intr, 0);
bellard72899af2006-04-24 21:18:20 +0000370 }
371 break;
372 case PORT_POWER:
373 break;
374 default:
375 goto fail;
376 }
bellard72899af2006-04-24 21:18:20 +0000377 }
378 break;
379 case ClearPortFeature:
380 {
381 unsigned int n = index - 1;
382 USBHubPort *port;
Blue Swirld4c4e6f2010-04-25 18:23:04 +0000383
Gerd Hoffmann529f8f92012-03-23 15:42:58 +0100384 trace_usb_hub_clear_port_feature(s->dev.addr, index,
385 feature_name(value));
386
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100387 if (n >= NUM_PORTS) {
bellard72899af2006-04-24 21:18:20 +0000388 goto fail;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100389 }
bellard72899af2006-04-24 21:18:20 +0000390 port = &s->ports[n];
bellard72899af2006-04-24 21:18:20 +0000391 switch(value) {
392 case PORT_ENABLE:
393 port->wPortStatus &= ~PORT_STAT_ENABLE;
394 break;
395 case PORT_C_ENABLE:
396 port->wPortChange &= ~PORT_STAT_C_ENABLE;
397 break;
398 case PORT_SUSPEND:
399 port->wPortStatus &= ~PORT_STAT_SUSPEND;
400 break;
401 case PORT_C_SUSPEND:
402 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
403 break;
404 case PORT_C_CONNECTION:
405 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
406 break;
407 case PORT_C_OVERCURRENT:
408 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
409 break;
410 case PORT_C_RESET:
411 port->wPortChange &= ~PORT_STAT_C_RESET;
412 break;
413 default:
414 goto fail;
415 }
bellard72899af2006-04-24 21:18:20 +0000416 }
417 break;
418 case GetHubDescriptor:
bellard985d1742006-04-30 21:53:59 +0000419 {
420 unsigned int n, limit, var_hub_size = 0;
ths5fafdf22007-09-16 21:08:06 +0000421 memcpy(data, qemu_hub_hub_descriptor,
bellard985d1742006-04-30 21:53:59 +0000422 sizeof(qemu_hub_hub_descriptor));
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100423 data[2] = NUM_PORTS;
bellard985d1742006-04-30 21:53:59 +0000424
425 /* fill DeviceRemovable bits */
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100426 limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
bellard985d1742006-04-30 21:53:59 +0000427 for (n = 7; n < limit; n++) {
428 data[n] = 0x00;
429 var_hub_size++;
430 }
431
432 /* fill PortPwrCtrlMask bits */
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100433 limit = limit + ((NUM_PORTS + 7) / 8);
bellard985d1742006-04-30 21:53:59 +0000434 for (;n < limit; n++) {
435 data[n] = 0xff;
436 var_hub_size++;
437 }
438
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100439 p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
440 data[0] = p->actual_length;
bellard985d1742006-04-30 21:53:59 +0000441 break;
442 }
bellard72899af2006-04-24 21:18:20 +0000443 default:
444 fail:
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100445 p->status = USB_RET_STALL;
bellard72899af2006-04-24 21:18:20 +0000446 break;
447 }
bellard72899af2006-04-24 21:18:20 +0000448}
449
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100450static void usb_hub_handle_data(USBDevice *dev, USBPacket *p)
bellard72899af2006-04-24 21:18:20 +0000451{
452 USBHubState *s = (USBHubState *)dev;
bellard72899af2006-04-24 21:18:20 +0000453
pbrook4d611c92006-08-12 01:04:27 +0000454 switch(p->pid) {
bellard72899af2006-04-24 21:18:20 +0000455 case USB_TOKEN_IN:
Gerd Hoffmann079d0b72012-01-12 13:23:01 +0100456 if (p->ep->nr == 1) {
bellard72899af2006-04-24 21:18:20 +0000457 USBHubPort *port;
458 unsigned int status;
Gerd Hoffmann4f4321c2011-07-12 15:22:25 +0200459 uint8_t buf[4];
bellard72899af2006-04-24 21:18:20 +0000460 int i, n;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100461 n = (NUM_PORTS + 1 + 7) / 8;
Gerd Hoffmann4f4321c2011-07-12 15:22:25 +0200462 if (p->iov.size == 1) { /* FreeBSD workaround */
bellard985d1742006-04-30 21:53:59 +0000463 n = 1;
Gerd Hoffmann4f4321c2011-07-12 15:22:25 +0200464 } else if (n > p->iov.size) {
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100465 p->status = USB_RET_BABBLE;
466 return;
bellard985d1742006-04-30 21:53:59 +0000467 }
bellard72899af2006-04-24 21:18:20 +0000468 status = 0;
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100469 for(i = 0; i < NUM_PORTS; i++) {
bellard72899af2006-04-24 21:18:20 +0000470 port = &s->ports[i];
Gerd Hoffmannbdebd6e2013-08-27 17:00:04 +0200471 if (port->wPortChange)
bellard72899af2006-04-24 21:18:20 +0000472 status |= (1 << (i + 1));
473 }
474 if (status != 0) {
Gerd Hoffmannb8cbc132013-08-27 16:59:37 +0200475 trace_usb_hub_status_report(s->dev.addr, status);
bellard72899af2006-04-24 21:18:20 +0000476 for(i = 0; i < n; i++) {
Gerd Hoffmann4f4321c2011-07-12 15:22:25 +0200477 buf[i] = status >> (8 * i);
bellard72899af2006-04-24 21:18:20 +0000478 }
Gerd Hoffmann4f4321c2011-07-12 15:22:25 +0200479 usb_packet_copy(p, buf, n);
bellard72899af2006-04-24 21:18:20 +0000480 } else {
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100481 p->status = USB_RET_NAK; /* usb11 11.13.1 */
bellard72899af2006-04-24 21:18:20 +0000482 }
483 } else {
484 goto fail;
485 }
486 break;
487 case USB_TOKEN_OUT:
488 default:
489 fail:
Hans de Goede9a77a0f2012-11-01 17:15:01 +0100490 p->status = USB_RET_STALL;
bellard72899af2006-04-24 21:18:20 +0000491 break;
492 }
bellard72899af2006-04-24 21:18:20 +0000493}
494
bellard059809e2006-07-19 18:06:15 +0000495static void usb_hub_handle_destroy(USBDevice *dev)
496{
497 USBHubState *s = (USBHubState *)dev;
Gerd Hoffmanna8e662b2009-09-25 21:42:39 +0200498 int i;
bellard059809e2006-07-19 18:06:15 +0000499
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100500 for (i = 0; i < NUM_PORTS; i++) {
Gerd Hoffmanna8e662b2009-09-25 21:42:39 +0200501 usb_unregister_port(usb_bus_from_device(dev),
502 &s->ports[i].port);
503 }
bellard059809e2006-07-19 18:06:15 +0000504}
505
Gerd Hoffmann0d86d2b2010-12-01 11:08:44 +0100506static USBPortOps usb_hub_port_ops = {
507 .attach = usb_hub_attach,
Gerd Hoffmann618c1692010-12-01 11:27:05 +0100508 .detach = usb_hub_detach,
Hans de Goede4706ab62011-06-24 12:31:11 +0200509 .child_detach = usb_hub_child_detach,
Gerd Hoffmann34239c72010-12-15 12:26:59 +0100510 .wakeup = usb_hub_wakeup,
Gerd Hoffmann13a9a0d2010-12-16 17:03:44 +0100511 .complete = usb_hub_complete,
Gerd Hoffmann0d86d2b2010-12-01 11:08:44 +0100512};
513
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200514static int usb_hub_initfn(USBDevice *dev)
bellard72899af2006-04-24 21:18:20 +0000515{
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200516 USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
bellard72899af2006-04-24 21:18:20 +0000517 USBHubPort *port;
518 int i;
519
Gerd Hoffmannc24e4aa2013-03-20 11:40:02 +0100520 if (dev->port->hubcount == 5) {
521 error_report("usb hub chain too deep");
522 return -1;
523 }
524
Gerd Hoffmann9d55d1a2012-04-20 12:33:30 +0200525 usb_desc_create_serial(dev);
Gerd Hoffmanna980a062010-11-26 20:20:41 +0100526 usb_desc_init(dev);
Gerd Hoffmann7567b512012-01-17 13:25:46 +0100527 s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
Gerd Hoffmann062651c2010-11-26 13:13:22 +0100528 for (i = 0; i < NUM_PORTS; i++) {
bellard72899af2006-04-24 21:18:20 +0000529 port = &s->ports[i];
Gerd Hoffmanna5d2f722009-08-31 14:24:00 +0200530 usb_register_port(usb_bus_from_device(dev),
Gerd Hoffmannace13182011-01-12 11:34:50 +0100531 &port->port, s, i, &usb_hub_port_ops,
Gerd Hoffmann843d4e02010-12-03 17:30:13 +0100532 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
Gerd Hoffmann891fb2c2011-09-01 13:56:37 +0200533 usb_port_location(&port->port, dev->port, i+1);
bellard72899af2006-04-24 21:18:20 +0000534 }
Gerd Hoffmann20d183b2011-11-23 13:31:08 +0100535 usb_hub_handle_reset(dev);
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200536 return 0;
bellard72899af2006-04-24 21:18:20 +0000537}
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200538
Gerd Hoffmannd1550092010-12-15 12:45:24 +0100539static const VMStateDescription vmstate_usb_hub_port = {
540 .name = "usb-hub-port",
541 .version_id = 1,
542 .minimum_version_id = 1,
543 .fields = (VMStateField []) {
544 VMSTATE_UINT16(wPortStatus, USBHubPort),
545 VMSTATE_UINT16(wPortChange, USBHubPort),
546 VMSTATE_END_OF_LIST()
547 }
548};
549
550static const VMStateDescription vmstate_usb_hub = {
551 .name = "usb-hub",
552 .version_id = 1,
553 .minimum_version_id = 1,
554 .fields = (VMStateField []) {
555 VMSTATE_USB_DEVICE(dev, USBHubState),
556 VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
557 vmstate_usb_hub_port, USBHubPort),
558 VMSTATE_END_OF_LIST()
559 }
560};
561
Anthony Liguori39bffca2011-12-07 21:34:16 -0600562static void usb_hub_class_initfn(ObjectClass *klass, void *data)
Anthony Liguori62aed762011-12-15 14:53:10 -0600563{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600564 DeviceClass *dc = DEVICE_CLASS(klass);
Anthony Liguori62aed762011-12-15 14:53:10 -0600565 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
566
567 uc->init = usb_hub_initfn;
568 uc->product_desc = "QEMU USB Hub";
569 uc->usb_desc = &desc_hub;
Gerd Hoffmann06c75082012-01-10 17:08:13 +0100570 uc->find_device = usb_hub_find_device;
Anthony Liguori62aed762011-12-15 14:53:10 -0600571 uc->handle_reset = usb_hub_handle_reset;
572 uc->handle_control = usb_hub_handle_control;
573 uc->handle_data = usb_hub_handle_data;
574 uc->handle_destroy = usb_hub_handle_destroy;
Marcel Apfelbaum125ee0e2013-07-29 17:17:45 +0300575 set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
Anthony Liguori39bffca2011-12-07 21:34:16 -0600576 dc->fw_name = "hub";
577 dc->vmsd = &vmstate_usb_hub;
Anthony Liguori62aed762011-12-15 14:53:10 -0600578}
579
Andreas Färber8c43a6f2013-01-10 16:19:07 +0100580static const TypeInfo hub_info = {
Anthony Liguori39bffca2011-12-07 21:34:16 -0600581 .name = "usb-hub",
582 .parent = TYPE_USB_DEVICE,
583 .instance_size = sizeof(USBHubState),
584 .class_init = usb_hub_class_initfn,
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200585};
586
Andreas Färber83f7d432012-02-09 15:20:55 +0100587static void usb_hub_register_types(void)
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200588{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600589 type_register_static(&hub_info);
Gerd Hoffmann806b6022009-08-31 14:23:59 +0200590}
Andreas Färber83f7d432012-02-09 15:20:55 +0100591
592type_init(usb_hub_register_types)