PPC: e500mc: add missing IVORs to bitmap
[qemu.git] / hw / usb-hub.c
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 "qemu-common.h"
25 #include "usb.h"
26 #include "usb-desc.h"
27
28 //#define DEBUG
29
30 #define NUM_PORTS 8
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;
40 USBHubPort ports[NUM_PORTS];
41 } USBHubState;
42
43 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
44 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
45 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
46 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
47 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
48 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
49 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
50
51 #define PORT_STAT_CONNECTION 0x0001
52 #define PORT_STAT_ENABLE 0x0002
53 #define PORT_STAT_SUSPEND 0x0004
54 #define PORT_STAT_OVERCURRENT 0x0008
55 #define PORT_STAT_RESET 0x0010
56 #define PORT_STAT_POWER 0x0100
57 #define PORT_STAT_LOW_SPEED 0x0200
58 #define PORT_STAT_HIGH_SPEED 0x0400
59 #define PORT_STAT_TEST 0x0800
60 #define PORT_STAT_INDICATOR 0x1000
61
62 #define PORT_STAT_C_CONNECTION 0x0001
63 #define PORT_STAT_C_ENABLE 0x0002
64 #define PORT_STAT_C_SUSPEND 0x0004
65 #define PORT_STAT_C_OVERCURRENT 0x0008
66 #define PORT_STAT_C_RESET 0x0010
67
68 #define PORT_CONNECTION 0
69 #define PORT_ENABLE 1
70 #define PORT_SUSPEND 2
71 #define PORT_OVERCURRENT 3
72 #define PORT_RESET 4
73 #define PORT_POWER 8
74 #define PORT_LOWSPEED 9
75 #define PORT_HIGHSPEED 10
76 #define PORT_C_CONNECTION 16
77 #define PORT_C_ENABLE 17
78 #define PORT_C_SUSPEND 18
79 #define PORT_C_OVERCURRENT 19
80 #define PORT_C_RESET 20
81 #define PORT_TEST 21
82 #define PORT_INDICATOR 22
83
84 /* same as Linux kernel root hubs */
85
86 enum {
87 STR_MANUFACTURER = 1,
88 STR_PRODUCT,
89 STR_SERIALNUMBER,
90 };
91
92 static const USBDescStrings desc_strings = {
93 [STR_MANUFACTURER] = "QEMU " QEMU_VERSION,
94 [STR_PRODUCT] = "QEMU USB Hub",
95 [STR_SERIALNUMBER] = "314159",
96 };
97
98 static const USBDescIface desc_iface_hub = {
99 .bInterfaceNumber = 0,
100 .bNumEndpoints = 1,
101 .bInterfaceClass = USB_CLASS_HUB,
102 .eps = (USBDescEndpoint[]) {
103 {
104 .bEndpointAddress = USB_DIR_IN | 0x01,
105 .bmAttributes = USB_ENDPOINT_XFER_INT,
106 .wMaxPacketSize = 1 + (NUM_PORTS + 7) / 8,
107 .bInterval = 0xff,
108 },
109 }
110 };
111
112 static const USBDescDevice desc_device_hub = {
113 .bcdUSB = 0x0110,
114 .bDeviceClass = USB_CLASS_HUB,
115 .bMaxPacketSize0 = 8,
116 .bNumConfigurations = 1,
117 .confs = (USBDescConfig[]) {
118 {
119 .bNumInterfaces = 1,
120 .bConfigurationValue = 1,
121 .bmAttributes = 0xe0,
122 .nif = 1,
123 .ifs = &desc_iface_hub,
124 },
125 },
126 };
127
128 static const USBDesc desc_hub = {
129 .id = {
130 .idVendor = 0x0409,
131 .idProduct = 0x55aa,
132 .bcdDevice = 0x0101,
133 .iManufacturer = STR_MANUFACTURER,
134 .iProduct = STR_PRODUCT,
135 .iSerialNumber = STR_SERIALNUMBER,
136 },
137 .full = &desc_device_hub,
138 .str = desc_strings,
139 };
140
141 static const uint8_t qemu_hub_hub_descriptor[] =
142 {
143 0x00, /* u8 bLength; patched in later */
144 0x29, /* u8 bDescriptorType; Hub-descriptor */
145 0x00, /* u8 bNbrPorts; (patched later) */
146 0x0a, /* u16 wHubCharacteristics; */
147 0x00, /* (per-port OC, no power switching) */
148 0x01, /* u8 bPwrOn2pwrGood; 2ms */
149 0x00 /* u8 bHubContrCurrent; 0 mA */
150
151 /* DeviceRemovable and PortPwrCtrlMask patched in later */
152 };
153
154 static void usb_hub_attach(USBPort *port1)
155 {
156 USBHubState *s = port1->opaque;
157 USBHubPort *port = &s->ports[port1->index];
158
159 port->wPortStatus |= PORT_STAT_CONNECTION;
160 port->wPortChange |= PORT_STAT_C_CONNECTION;
161 if (port->port.dev->speed == USB_SPEED_LOW) {
162 port->wPortStatus |= PORT_STAT_LOW_SPEED;
163 } else {
164 port->wPortStatus &= ~PORT_STAT_LOW_SPEED;
165 }
166 usb_wakeup(&s->dev);
167 }
168
169 static void usb_hub_detach(USBPort *port1)
170 {
171 USBHubState *s = port1->opaque;
172 USBHubPort *port = &s->ports[port1->index];
173
174 usb_wakeup(&s->dev);
175
176 /* Let upstream know the device on this port is gone */
177 s->dev.port->ops->child_detach(s->dev.port, port1->dev);
178
179 port->wPortStatus &= ~PORT_STAT_CONNECTION;
180 port->wPortChange |= PORT_STAT_C_CONNECTION;
181 if (port->wPortStatus & PORT_STAT_ENABLE) {
182 port->wPortStatus &= ~PORT_STAT_ENABLE;
183 port->wPortChange |= PORT_STAT_C_ENABLE;
184 }
185 }
186
187 static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
188 {
189 USBHubState *s = port1->opaque;
190
191 /* Pass along upstream */
192 s->dev.port->ops->child_detach(s->dev.port, child);
193 }
194
195 static void usb_hub_wakeup(USBPort *port1)
196 {
197 USBHubState *s = port1->opaque;
198 USBHubPort *port = &s->ports[port1->index];
199
200 if (port->wPortStatus & PORT_STAT_SUSPEND) {
201 port->wPortChange |= PORT_STAT_C_SUSPEND;
202 usb_wakeup(&s->dev);
203 }
204 }
205
206 static void usb_hub_complete(USBPort *port, USBPacket *packet)
207 {
208 USBHubState *s = port->opaque;
209
210 /*
211 * Just pass it along upstream for now.
212 *
213 * If we ever implement usb 2.0 split transactions this will
214 * become a little more complicated ...
215 *
216 * Can't use usb_packet_complete() here because packet->owner is
217 * cleared already, go call the ->complete() callback directly
218 * instead.
219 */
220 s->dev.port->ops->complete(s->dev.port, packet);
221 }
222
223 static void usb_hub_handle_reset(USBDevice *dev)
224 {
225 USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
226 USBHubPort *port;
227 int i;
228
229 for (i = 0; i < NUM_PORTS; i++) {
230 port = s->ports + i;
231 port->wPortStatus = PORT_STAT_POWER;
232 port->wPortChange = 0;
233 if (port->port.dev && port->port.dev->attached) {
234 port->wPortStatus |= PORT_STAT_CONNECTION;
235 port->wPortChange |= PORT_STAT_C_CONNECTION;
236 if (port->port.dev->speed == USB_SPEED_LOW) {
237 port->wPortStatus |= PORT_STAT_LOW_SPEED;
238 }
239 }
240 }
241 }
242
243 static int usb_hub_handle_control(USBDevice *dev, USBPacket *p,
244 int request, int value, int index, int length, uint8_t *data)
245 {
246 USBHubState *s = (USBHubState *)dev;
247 int ret;
248
249 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
250 if (ret >= 0) {
251 return ret;
252 }
253
254 switch(request) {
255 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
256 if (value == 0 && index != 0x81) { /* clear ep halt */
257 goto fail;
258 }
259 ret = 0;
260 break;
261 /* usb specific requests */
262 case GetHubStatus:
263 data[0] = 0;
264 data[1] = 0;
265 data[2] = 0;
266 data[3] = 0;
267 ret = 4;
268 break;
269 case GetPortStatus:
270 {
271 unsigned int n = index - 1;
272 USBHubPort *port;
273 if (n >= NUM_PORTS) {
274 goto fail;
275 }
276 port = &s->ports[n];
277 data[0] = port->wPortStatus;
278 data[1] = port->wPortStatus >> 8;
279 data[2] = port->wPortChange;
280 data[3] = port->wPortChange >> 8;
281 ret = 4;
282 }
283 break;
284 case SetHubFeature:
285 case ClearHubFeature:
286 if (value == 0 || value == 1) {
287 } else {
288 goto fail;
289 }
290 ret = 0;
291 break;
292 case SetPortFeature:
293 {
294 unsigned int n = index - 1;
295 USBHubPort *port;
296 USBDevice *dev;
297 if (n >= NUM_PORTS) {
298 goto fail;
299 }
300 port = &s->ports[n];
301 dev = port->port.dev;
302 switch(value) {
303 case PORT_SUSPEND:
304 port->wPortStatus |= PORT_STAT_SUSPEND;
305 break;
306 case PORT_RESET:
307 if (dev && dev->attached) {
308 usb_send_msg(dev, USB_MSG_RESET);
309 port->wPortChange |= PORT_STAT_C_RESET;
310 /* set enable bit */
311 port->wPortStatus |= PORT_STAT_ENABLE;
312 }
313 break;
314 case PORT_POWER:
315 break;
316 default:
317 goto fail;
318 }
319 ret = 0;
320 }
321 break;
322 case ClearPortFeature:
323 {
324 unsigned int n = index - 1;
325 USBHubPort *port;
326
327 if (n >= NUM_PORTS) {
328 goto fail;
329 }
330 port = &s->ports[n];
331 switch(value) {
332 case PORT_ENABLE:
333 port->wPortStatus &= ~PORT_STAT_ENABLE;
334 break;
335 case PORT_C_ENABLE:
336 port->wPortChange &= ~PORT_STAT_C_ENABLE;
337 break;
338 case PORT_SUSPEND:
339 port->wPortStatus &= ~PORT_STAT_SUSPEND;
340 break;
341 case PORT_C_SUSPEND:
342 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
343 break;
344 case PORT_C_CONNECTION:
345 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
346 break;
347 case PORT_C_OVERCURRENT:
348 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
349 break;
350 case PORT_C_RESET:
351 port->wPortChange &= ~PORT_STAT_C_RESET;
352 break;
353 default:
354 goto fail;
355 }
356 ret = 0;
357 }
358 break;
359 case GetHubDescriptor:
360 {
361 unsigned int n, limit, var_hub_size = 0;
362 memcpy(data, qemu_hub_hub_descriptor,
363 sizeof(qemu_hub_hub_descriptor));
364 data[2] = NUM_PORTS;
365
366 /* fill DeviceRemovable bits */
367 limit = ((NUM_PORTS + 1 + 7) / 8) + 7;
368 for (n = 7; n < limit; n++) {
369 data[n] = 0x00;
370 var_hub_size++;
371 }
372
373 /* fill PortPwrCtrlMask bits */
374 limit = limit + ((NUM_PORTS + 7) / 8);
375 for (;n < limit; n++) {
376 data[n] = 0xff;
377 var_hub_size++;
378 }
379
380 ret = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
381 data[0] = ret;
382 break;
383 }
384 default:
385 fail:
386 ret = USB_RET_STALL;
387 break;
388 }
389 return ret;
390 }
391
392 static int usb_hub_handle_data(USBDevice *dev, USBPacket *p)
393 {
394 USBHubState *s = (USBHubState *)dev;
395 int ret;
396
397 switch(p->pid) {
398 case USB_TOKEN_IN:
399 if (p->devep == 1) {
400 USBHubPort *port;
401 unsigned int status;
402 uint8_t buf[4];
403 int i, n;
404 n = (NUM_PORTS + 1 + 7) / 8;
405 if (p->iov.size == 1) { /* FreeBSD workaround */
406 n = 1;
407 } else if (n > p->iov.size) {
408 return USB_RET_BABBLE;
409 }
410 status = 0;
411 for(i = 0; i < NUM_PORTS; i++) {
412 port = &s->ports[i];
413 if (port->wPortChange)
414 status |= (1 << (i + 1));
415 }
416 if (status != 0) {
417 for(i = 0; i < n; i++) {
418 buf[i] = status >> (8 * i);
419 }
420 usb_packet_copy(p, buf, n);
421 ret = n;
422 } else {
423 ret = USB_RET_NAK; /* usb11 11.13.1 */
424 }
425 } else {
426 goto fail;
427 }
428 break;
429 case USB_TOKEN_OUT:
430 default:
431 fail:
432 ret = USB_RET_STALL;
433 break;
434 }
435 return ret;
436 }
437
438 static int usb_hub_broadcast_packet(USBHubState *s, USBPacket *p)
439 {
440 USBHubPort *port;
441 USBDevice *dev;
442 int i, ret;
443
444 for(i = 0; i < NUM_PORTS; i++) {
445 port = &s->ports[i];
446 dev = port->port.dev;
447 if (dev && dev->attached && (port->wPortStatus & PORT_STAT_ENABLE)) {
448 ret = usb_handle_packet(dev, p);
449 if (ret != USB_RET_NODEV) {
450 return ret;
451 }
452 }
453 }
454 return USB_RET_NODEV;
455 }
456
457 static int usb_hub_handle_packet(USBDevice *dev, USBPacket *p)
458 {
459 USBHubState *s = (USBHubState *)dev;
460
461 #if defined(DEBUG) && 0
462 printf("usb_hub: pid=0x%x\n", pid);
463 #endif
464 if (dev->state == USB_STATE_DEFAULT &&
465 dev->addr != 0 &&
466 p->devaddr != dev->addr &&
467 (p->pid == USB_TOKEN_SETUP ||
468 p->pid == USB_TOKEN_OUT ||
469 p->pid == USB_TOKEN_IN)) {
470 /* broadcast the packet to the devices */
471 return usb_hub_broadcast_packet(s, p);
472 }
473 return usb_generic_handle_packet(dev, p);
474 }
475
476 static void usb_hub_handle_destroy(USBDevice *dev)
477 {
478 USBHubState *s = (USBHubState *)dev;
479 int i;
480
481 for (i = 0; i < NUM_PORTS; i++) {
482 usb_unregister_port(usb_bus_from_device(dev),
483 &s->ports[i].port);
484 }
485 }
486
487 static USBPortOps usb_hub_port_ops = {
488 .attach = usb_hub_attach,
489 .detach = usb_hub_detach,
490 .child_detach = usb_hub_child_detach,
491 .wakeup = usb_hub_wakeup,
492 .complete = usb_hub_complete,
493 };
494
495 static int usb_hub_initfn(USBDevice *dev)
496 {
497 USBHubState *s = DO_UPCAST(USBHubState, dev, dev);
498 USBHubPort *port;
499 int i;
500
501 usb_desc_init(dev);
502 for (i = 0; i < NUM_PORTS; i++) {
503 port = &s->ports[i];
504 usb_register_port(usb_bus_from_device(dev),
505 &port->port, s, i, &usb_hub_port_ops,
506 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
507 usb_port_location(&port->port, dev->port, i+1);
508 }
509 usb_hub_handle_reset(dev);
510 return 0;
511 }
512
513 static const VMStateDescription vmstate_usb_hub_port = {
514 .name = "usb-hub-port",
515 .version_id = 1,
516 .minimum_version_id = 1,
517 .fields = (VMStateField []) {
518 VMSTATE_UINT16(wPortStatus, USBHubPort),
519 VMSTATE_UINT16(wPortChange, USBHubPort),
520 VMSTATE_END_OF_LIST()
521 }
522 };
523
524 static const VMStateDescription vmstate_usb_hub = {
525 .name = "usb-hub",
526 .version_id = 1,
527 .minimum_version_id = 1,
528 .fields = (VMStateField []) {
529 VMSTATE_USB_DEVICE(dev, USBHubState),
530 VMSTATE_STRUCT_ARRAY(ports, USBHubState, NUM_PORTS, 0,
531 vmstate_usb_hub_port, USBHubPort),
532 VMSTATE_END_OF_LIST()
533 }
534 };
535
536 static void usb_hub_class_initfn(ObjectClass *klass, void *data)
537 {
538 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
539
540 uc->init = usb_hub_initfn;
541 uc->product_desc = "QEMU USB Hub";
542 uc->usb_desc = &desc_hub;
543 uc->handle_packet = usb_hub_handle_packet;
544 uc->handle_reset = usb_hub_handle_reset;
545 uc->handle_control = usb_hub_handle_control;
546 uc->handle_data = usb_hub_handle_data;
547 uc->handle_destroy = usb_hub_handle_destroy;
548 }
549
550 static struct DeviceInfo hub_info = {
551 .name = "usb-hub",
552 .fw_name = "hub",
553 .size = sizeof(USBHubState),
554 .vmsd = &vmstate_usb_hub,
555 .class_init= usb_hub_class_initfn,
556 };
557
558 static void usb_hub_register_devices(void)
559 {
560 usb_qdev_register(&hub_info, NULL, NULL);
561 }
562 device_init(usb_hub_register_devices)