uhci: Don't queue up packets after one with the SPD flag set
[qemu.git] / hw / usb / hcd-uhci.c
blobcdc8bc3fbaa1366dcb0a680b7855de883bf47120
1 /*
2 * USB UHCI controller emulation
4 * Copyright (c) 2005 Fabrice Bellard
6 * Copyright (c) 2008 Max Krasnyansky
7 * Magor rewrite of the UHCI data structures parser and frame processor
8 * Support for fully async operation and multiple outstanding transactions
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 * THE SOFTWARE.
28 #include "hw/hw.h"
29 #include "hw/usb.h"
30 #include "hw/pci.h"
31 #include "qemu-timer.h"
32 #include "iov.h"
33 #include "dma.h"
34 #include "trace.h"
36 //#define DEBUG
37 //#define DEBUG_DUMP_DATA
39 #define UHCI_CMD_FGR (1 << 4)
40 #define UHCI_CMD_EGSM (1 << 3)
41 #define UHCI_CMD_GRESET (1 << 2)
42 #define UHCI_CMD_HCRESET (1 << 1)
43 #define UHCI_CMD_RS (1 << 0)
45 #define UHCI_STS_HCHALTED (1 << 5)
46 #define UHCI_STS_HCPERR (1 << 4)
47 #define UHCI_STS_HSERR (1 << 3)
48 #define UHCI_STS_RD (1 << 2)
49 #define UHCI_STS_USBERR (1 << 1)
50 #define UHCI_STS_USBINT (1 << 0)
52 #define TD_CTRL_SPD (1 << 29)
53 #define TD_CTRL_ERROR_SHIFT 27
54 #define TD_CTRL_IOS (1 << 25)
55 #define TD_CTRL_IOC (1 << 24)
56 #define TD_CTRL_ACTIVE (1 << 23)
57 #define TD_CTRL_STALL (1 << 22)
58 #define TD_CTRL_BABBLE (1 << 20)
59 #define TD_CTRL_NAK (1 << 19)
60 #define TD_CTRL_TIMEOUT (1 << 18)
62 #define UHCI_PORT_SUSPEND (1 << 12)
63 #define UHCI_PORT_RESET (1 << 9)
64 #define UHCI_PORT_LSDA (1 << 8)
65 #define UHCI_PORT_RD (1 << 6)
66 #define UHCI_PORT_ENC (1 << 3)
67 #define UHCI_PORT_EN (1 << 2)
68 #define UHCI_PORT_CSC (1 << 1)
69 #define UHCI_PORT_CCS (1 << 0)
71 #define UHCI_PORT_READ_ONLY (0x1bb)
72 #define UHCI_PORT_WRITE_CLEAR (UHCI_PORT_CSC | UHCI_PORT_ENC)
74 #define FRAME_TIMER_FREQ 1000
76 #define FRAME_MAX_LOOPS 256
78 #define NB_PORTS 2
80 enum {
81 TD_RESULT_STOP_FRAME = 10,
82 TD_RESULT_COMPLETE,
83 TD_RESULT_NEXT_QH,
84 TD_RESULT_ASYNC_START,
85 TD_RESULT_ASYNC_CONT,
88 typedef struct UHCIState UHCIState;
89 typedef struct UHCIAsync UHCIAsync;
90 typedef struct UHCIQueue UHCIQueue;
92 /*
93 * Pending async transaction.
94 * 'packet' must be the first field because completion
95 * handler does "(UHCIAsync *) pkt" cast.
98 struct UHCIAsync {
99 USBPacket packet;
100 QEMUSGList sgl;
101 UHCIQueue *queue;
102 QTAILQ_ENTRY(UHCIAsync) next;
103 uint32_t td;
104 uint8_t isoc;
105 uint8_t done;
108 struct UHCIQueue {
109 uint32_t token;
110 UHCIState *uhci;
111 QTAILQ_ENTRY(UHCIQueue) next;
112 QTAILQ_HEAD(, UHCIAsync) asyncs;
113 int8_t valid;
116 typedef struct UHCIPort {
117 USBPort port;
118 uint16_t ctrl;
119 } UHCIPort;
121 struct UHCIState {
122 PCIDevice dev;
123 MemoryRegion io_bar;
124 USBBus bus; /* Note unused when we're a companion controller */
125 uint16_t cmd; /* cmd register */
126 uint16_t status;
127 uint16_t intr; /* interrupt enable register */
128 uint16_t frnum; /* frame number */
129 uint32_t fl_base_addr; /* frame list base address */
130 uint8_t sof_timing;
131 uint8_t status2; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
132 int64_t expire_time;
133 QEMUTimer *frame_timer;
134 QEMUBH *bh;
135 uint32_t frame_bytes;
136 uint32_t frame_bandwidth;
137 UHCIPort ports[NB_PORTS];
139 /* Interrupts that should be raised at the end of the current frame. */
140 uint32_t pending_int_mask;
141 int irq_pin;
143 /* Active packets */
144 QTAILQ_HEAD(, UHCIQueue) queues;
145 uint8_t num_ports_vmstate;
147 /* Properties */
148 char *masterbus;
149 uint32_t firstport;
152 typedef struct UHCI_TD {
153 uint32_t link;
154 uint32_t ctrl; /* see TD_CTRL_xxx */
155 uint32_t token;
156 uint32_t buffer;
157 } UHCI_TD;
159 typedef struct UHCI_QH {
160 uint32_t link;
161 uint32_t el_link;
162 } UHCI_QH;
164 static inline int32_t uhci_queue_token(UHCI_TD *td)
166 /* covers ep, dev, pid -> identifies the endpoint */
167 return td->token & 0x7ffff;
170 static UHCIQueue *uhci_queue_get(UHCIState *s, UHCI_TD *td)
172 uint32_t token = uhci_queue_token(td);
173 UHCIQueue *queue;
175 QTAILQ_FOREACH(queue, &s->queues, next) {
176 if (queue->token == token) {
177 return queue;
181 queue = g_new0(UHCIQueue, 1);
182 queue->uhci = s;
183 queue->token = token;
184 QTAILQ_INIT(&queue->asyncs);
185 QTAILQ_INSERT_HEAD(&s->queues, queue, next);
186 trace_usb_uhci_queue_add(queue->token);
187 return queue;
190 static void uhci_queue_free(UHCIQueue *queue)
192 UHCIState *s = queue->uhci;
194 trace_usb_uhci_queue_del(queue->token);
195 QTAILQ_REMOVE(&s->queues, queue, next);
196 g_free(queue);
199 static UHCIAsync *uhci_async_alloc(UHCIQueue *queue, uint32_t addr)
201 UHCIAsync *async = g_new0(UHCIAsync, 1);
203 async->queue = queue;
204 async->td = addr;
205 usb_packet_init(&async->packet);
206 pci_dma_sglist_init(&async->sgl, &queue->uhci->dev, 1);
207 trace_usb_uhci_packet_add(async->queue->token, async->td);
209 return async;
212 static void uhci_async_free(UHCIAsync *async)
214 trace_usb_uhci_packet_del(async->queue->token, async->td);
215 usb_packet_cleanup(&async->packet);
216 qemu_sglist_destroy(&async->sgl);
217 g_free(async);
220 static void uhci_async_link(UHCIAsync *async)
222 UHCIQueue *queue = async->queue;
223 QTAILQ_INSERT_TAIL(&queue->asyncs, async, next);
224 trace_usb_uhci_packet_link_async(async->queue->token, async->td);
227 static void uhci_async_unlink(UHCIAsync *async)
229 UHCIQueue *queue = async->queue;
230 QTAILQ_REMOVE(&queue->asyncs, async, next);
231 trace_usb_uhci_packet_unlink_async(async->queue->token, async->td);
234 static void uhci_async_cancel(UHCIAsync *async)
236 trace_usb_uhci_packet_cancel(async->queue->token, async->td, async->done);
237 if (!async->done)
238 usb_cancel_packet(&async->packet);
239 uhci_async_free(async);
243 * Mark all outstanding async packets as invalid.
244 * This is used for canceling them when TDs are removed by the HCD.
246 static void uhci_async_validate_begin(UHCIState *s)
248 UHCIQueue *queue;
250 QTAILQ_FOREACH(queue, &s->queues, next) {
251 queue->valid--;
256 * Cancel async packets that are no longer valid
258 static void uhci_async_validate_end(UHCIState *s)
260 UHCIQueue *queue, *n;
261 UHCIAsync *async;
263 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, n) {
264 if (queue->valid > 0) {
265 continue;
267 while (!QTAILQ_EMPTY(&queue->asyncs)) {
268 async = QTAILQ_FIRST(&queue->asyncs);
269 uhci_async_unlink(async);
270 uhci_async_cancel(async);
272 uhci_queue_free(queue);
276 static void uhci_async_cancel_device(UHCIState *s, USBDevice *dev)
278 UHCIQueue *queue;
279 UHCIAsync *curr, *n;
281 QTAILQ_FOREACH(queue, &s->queues, next) {
282 QTAILQ_FOREACH_SAFE(curr, &queue->asyncs, next, n) {
283 if (!usb_packet_is_inflight(&curr->packet) ||
284 curr->packet.ep->dev != dev) {
285 continue;
287 uhci_async_unlink(curr);
288 uhci_async_cancel(curr);
293 static void uhci_async_cancel_all(UHCIState *s)
295 UHCIQueue *queue, *nq;
296 UHCIAsync *curr, *n;
298 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, nq) {
299 QTAILQ_FOREACH_SAFE(curr, &queue->asyncs, next, n) {
300 uhci_async_unlink(curr);
301 uhci_async_cancel(curr);
303 uhci_queue_free(queue);
307 static UHCIAsync *uhci_async_find_td(UHCIState *s, uint32_t addr, UHCI_TD *td)
309 uint32_t token = uhci_queue_token(td);
310 UHCIQueue *queue;
311 UHCIAsync *async;
313 QTAILQ_FOREACH(queue, &s->queues, next) {
314 if (queue->token == token) {
315 break;
318 if (queue == NULL) {
319 return NULL;
322 QTAILQ_FOREACH(async, &queue->asyncs, next) {
323 if (async->td == addr) {
324 return async;
328 return NULL;
331 static void uhci_update_irq(UHCIState *s)
333 int level;
334 if (((s->status2 & 1) && (s->intr & (1 << 2))) ||
335 ((s->status2 & 2) && (s->intr & (1 << 3))) ||
336 ((s->status & UHCI_STS_USBERR) && (s->intr & (1 << 0))) ||
337 ((s->status & UHCI_STS_RD) && (s->intr & (1 << 1))) ||
338 (s->status & UHCI_STS_HSERR) ||
339 (s->status & UHCI_STS_HCPERR)) {
340 level = 1;
341 } else {
342 level = 0;
344 qemu_set_irq(s->dev.irq[s->irq_pin], level);
347 static void uhci_reset(void *opaque)
349 UHCIState *s = opaque;
350 uint8_t *pci_conf;
351 int i;
352 UHCIPort *port;
354 trace_usb_uhci_reset();
356 pci_conf = s->dev.config;
358 pci_conf[0x6a] = 0x01; /* usb clock */
359 pci_conf[0x6b] = 0x00;
360 s->cmd = 0;
361 s->status = 0;
362 s->status2 = 0;
363 s->intr = 0;
364 s->fl_base_addr = 0;
365 s->sof_timing = 64;
367 for(i = 0; i < NB_PORTS; i++) {
368 port = &s->ports[i];
369 port->ctrl = 0x0080;
370 if (port->port.dev && port->port.dev->attached) {
371 usb_port_reset(&port->port);
375 uhci_async_cancel_all(s);
376 qemu_bh_cancel(s->bh);
377 uhci_update_irq(s);
380 static const VMStateDescription vmstate_uhci_port = {
381 .name = "uhci port",
382 .version_id = 1,
383 .minimum_version_id = 1,
384 .minimum_version_id_old = 1,
385 .fields = (VMStateField []) {
386 VMSTATE_UINT16(ctrl, UHCIPort),
387 VMSTATE_END_OF_LIST()
391 static int uhci_post_load(void *opaque, int version_id)
393 UHCIState *s = opaque;
395 if (version_id < 2) {
396 s->expire_time = qemu_get_clock_ns(vm_clock) +
397 (get_ticks_per_sec() / FRAME_TIMER_FREQ);
399 return 0;
402 static const VMStateDescription vmstate_uhci = {
403 .name = "uhci",
404 .version_id = 2,
405 .minimum_version_id = 1,
406 .minimum_version_id_old = 1,
407 .post_load = uhci_post_load,
408 .fields = (VMStateField []) {
409 VMSTATE_PCI_DEVICE(dev, UHCIState),
410 VMSTATE_UINT8_EQUAL(num_ports_vmstate, UHCIState),
411 VMSTATE_STRUCT_ARRAY(ports, UHCIState, NB_PORTS, 1,
412 vmstate_uhci_port, UHCIPort),
413 VMSTATE_UINT16(cmd, UHCIState),
414 VMSTATE_UINT16(status, UHCIState),
415 VMSTATE_UINT16(intr, UHCIState),
416 VMSTATE_UINT16(frnum, UHCIState),
417 VMSTATE_UINT32(fl_base_addr, UHCIState),
418 VMSTATE_UINT8(sof_timing, UHCIState),
419 VMSTATE_UINT8(status2, UHCIState),
420 VMSTATE_TIMER(frame_timer, UHCIState),
421 VMSTATE_INT64_V(expire_time, UHCIState, 2),
422 VMSTATE_END_OF_LIST()
426 static void uhci_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
428 UHCIState *s = opaque;
430 addr &= 0x1f;
431 switch(addr) {
432 case 0x0c:
433 s->sof_timing = val;
434 break;
438 static uint32_t uhci_ioport_readb(void *opaque, uint32_t addr)
440 UHCIState *s = opaque;
441 uint32_t val;
443 addr &= 0x1f;
444 switch(addr) {
445 case 0x0c:
446 val = s->sof_timing;
447 break;
448 default:
449 val = 0xff;
450 break;
452 return val;
455 static void uhci_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
457 UHCIState *s = opaque;
459 addr &= 0x1f;
460 trace_usb_uhci_mmio_writew(addr, val);
462 switch(addr) {
463 case 0x00:
464 if ((val & UHCI_CMD_RS) && !(s->cmd & UHCI_CMD_RS)) {
465 /* start frame processing */
466 trace_usb_uhci_schedule_start();
467 s->expire_time = qemu_get_clock_ns(vm_clock) +
468 (get_ticks_per_sec() / FRAME_TIMER_FREQ);
469 qemu_mod_timer(s->frame_timer, qemu_get_clock_ns(vm_clock));
470 s->status &= ~UHCI_STS_HCHALTED;
471 } else if (!(val & UHCI_CMD_RS)) {
472 s->status |= UHCI_STS_HCHALTED;
474 if (val & UHCI_CMD_GRESET) {
475 UHCIPort *port;
476 int i;
478 /* send reset on the USB bus */
479 for(i = 0; i < NB_PORTS; i++) {
480 port = &s->ports[i];
481 usb_device_reset(port->port.dev);
483 uhci_reset(s);
484 return;
486 if (val & UHCI_CMD_HCRESET) {
487 uhci_reset(s);
488 return;
490 s->cmd = val;
491 break;
492 case 0x02:
493 s->status &= ~val;
494 /* XXX: the chip spec is not coherent, so we add a hidden
495 register to distinguish between IOC and SPD */
496 if (val & UHCI_STS_USBINT)
497 s->status2 = 0;
498 uhci_update_irq(s);
499 break;
500 case 0x04:
501 s->intr = val;
502 uhci_update_irq(s);
503 break;
504 case 0x06:
505 if (s->status & UHCI_STS_HCHALTED)
506 s->frnum = val & 0x7ff;
507 break;
508 case 0x10 ... 0x1f:
510 UHCIPort *port;
511 USBDevice *dev;
512 int n;
514 n = (addr >> 1) & 7;
515 if (n >= NB_PORTS)
516 return;
517 port = &s->ports[n];
518 dev = port->port.dev;
519 if (dev && dev->attached) {
520 /* port reset */
521 if ( (val & UHCI_PORT_RESET) &&
522 !(port->ctrl & UHCI_PORT_RESET) ) {
523 usb_device_reset(dev);
526 port->ctrl &= UHCI_PORT_READ_ONLY;
527 port->ctrl |= (val & ~UHCI_PORT_READ_ONLY);
528 /* some bits are reset when a '1' is written to them */
529 port->ctrl &= ~(val & UHCI_PORT_WRITE_CLEAR);
531 break;
535 static uint32_t uhci_ioport_readw(void *opaque, uint32_t addr)
537 UHCIState *s = opaque;
538 uint32_t val;
540 addr &= 0x1f;
541 switch(addr) {
542 case 0x00:
543 val = s->cmd;
544 break;
545 case 0x02:
546 val = s->status;
547 break;
548 case 0x04:
549 val = s->intr;
550 break;
551 case 0x06:
552 val = s->frnum;
553 break;
554 case 0x10 ... 0x1f:
556 UHCIPort *port;
557 int n;
558 n = (addr >> 1) & 7;
559 if (n >= NB_PORTS)
560 goto read_default;
561 port = &s->ports[n];
562 val = port->ctrl;
564 break;
565 default:
566 read_default:
567 val = 0xff7f; /* disabled port */
568 break;
571 trace_usb_uhci_mmio_readw(addr, val);
573 return val;
576 static void uhci_ioport_writel(void *opaque, uint32_t addr, uint32_t val)
578 UHCIState *s = opaque;
580 addr &= 0x1f;
581 trace_usb_uhci_mmio_writel(addr, val);
583 switch(addr) {
584 case 0x08:
585 s->fl_base_addr = val & ~0xfff;
586 break;
590 static uint32_t uhci_ioport_readl(void *opaque, uint32_t addr)
592 UHCIState *s = opaque;
593 uint32_t val;
595 addr &= 0x1f;
596 switch(addr) {
597 case 0x08:
598 val = s->fl_base_addr;
599 break;
600 default:
601 val = 0xffffffff;
602 break;
604 trace_usb_uhci_mmio_readl(addr, val);
605 return val;
608 /* signal resume if controller suspended */
609 static void uhci_resume (void *opaque)
611 UHCIState *s = (UHCIState *)opaque;
613 if (!s)
614 return;
616 if (s->cmd & UHCI_CMD_EGSM) {
617 s->cmd |= UHCI_CMD_FGR;
618 s->status |= UHCI_STS_RD;
619 uhci_update_irq(s);
623 static void uhci_attach(USBPort *port1)
625 UHCIState *s = port1->opaque;
626 UHCIPort *port = &s->ports[port1->index];
628 /* set connect status */
629 port->ctrl |= UHCI_PORT_CCS | UHCI_PORT_CSC;
631 /* update speed */
632 if (port->port.dev->speed == USB_SPEED_LOW) {
633 port->ctrl |= UHCI_PORT_LSDA;
634 } else {
635 port->ctrl &= ~UHCI_PORT_LSDA;
638 uhci_resume(s);
641 static void uhci_detach(USBPort *port1)
643 UHCIState *s = port1->opaque;
644 UHCIPort *port = &s->ports[port1->index];
646 uhci_async_cancel_device(s, port1->dev);
648 /* set connect status */
649 if (port->ctrl & UHCI_PORT_CCS) {
650 port->ctrl &= ~UHCI_PORT_CCS;
651 port->ctrl |= UHCI_PORT_CSC;
653 /* disable port */
654 if (port->ctrl & UHCI_PORT_EN) {
655 port->ctrl &= ~UHCI_PORT_EN;
656 port->ctrl |= UHCI_PORT_ENC;
659 uhci_resume(s);
662 static void uhci_child_detach(USBPort *port1, USBDevice *child)
664 UHCIState *s = port1->opaque;
666 uhci_async_cancel_device(s, child);
669 static void uhci_wakeup(USBPort *port1)
671 UHCIState *s = port1->opaque;
672 UHCIPort *port = &s->ports[port1->index];
674 if (port->ctrl & UHCI_PORT_SUSPEND && !(port->ctrl & UHCI_PORT_RD)) {
675 port->ctrl |= UHCI_PORT_RD;
676 uhci_resume(s);
680 static USBDevice *uhci_find_device(UHCIState *s, uint8_t addr)
682 USBDevice *dev;
683 int i;
685 for (i = 0; i < NB_PORTS; i++) {
686 UHCIPort *port = &s->ports[i];
687 if (!(port->ctrl & UHCI_PORT_EN)) {
688 continue;
690 dev = usb_find_device(&port->port, addr);
691 if (dev != NULL) {
692 return dev;
695 return NULL;
698 static void uhci_async_complete(USBPort *port, USBPacket *packet);
699 static void uhci_process_frame(UHCIState *s);
701 /* return -1 if fatal error (frame must be stopped)
702 0 if TD successful
703 1 if TD unsuccessful or inactive
705 static int uhci_complete_td(UHCIState *s, UHCI_TD *td, UHCIAsync *async, uint32_t *int_mask)
707 int len = 0, max_len, err, ret;
708 uint8_t pid;
710 max_len = ((td->token >> 21) + 1) & 0x7ff;
711 pid = td->token & 0xff;
713 ret = async->packet.result;
715 if (td->ctrl & TD_CTRL_IOS)
716 td->ctrl &= ~TD_CTRL_ACTIVE;
718 if (ret < 0)
719 goto out;
721 len = async->packet.result;
722 td->ctrl = (td->ctrl & ~0x7ff) | ((len - 1) & 0x7ff);
724 /* The NAK bit may have been set by a previous frame, so clear it
725 here. The docs are somewhat unclear, but win2k relies on this
726 behavior. */
727 td->ctrl &= ~(TD_CTRL_ACTIVE | TD_CTRL_NAK);
728 if (td->ctrl & TD_CTRL_IOC)
729 *int_mask |= 0x01;
731 if (pid == USB_TOKEN_IN) {
732 if ((td->ctrl & TD_CTRL_SPD) && len < max_len) {
733 *int_mask |= 0x02;
734 /* short packet: do not update QH */
735 trace_usb_uhci_packet_complete_shortxfer(async->queue->token,
736 async->td);
737 return TD_RESULT_NEXT_QH;
741 /* success */
742 trace_usb_uhci_packet_complete_success(async->queue->token, async->td);
743 return TD_RESULT_COMPLETE;
745 out:
747 * We should not do any further processing on a queue with errors!
748 * This is esp. important for bulk endpoints with pipelining enabled
749 * (redirection to a real USB device), where we must cancel all the
750 * transfers after this one so that:
751 * 1) If they've completed already, they are not processed further
752 * causing more stalls, originating from the same failed transfer
753 * 2) If still in flight, they are cancelled before the guest does
754 * a clear stall, otherwise the guest and device can loose sync!
756 while (!QTAILQ_EMPTY(&async->queue->asyncs)) {
757 UHCIAsync *as = QTAILQ_FIRST(&async->queue->asyncs);
758 uhci_async_unlink(as);
759 uhci_async_cancel(as);
762 switch(ret) {
763 case USB_RET_STALL:
764 td->ctrl |= TD_CTRL_STALL;
765 td->ctrl &= ~TD_CTRL_ACTIVE;
766 s->status |= UHCI_STS_USBERR;
767 if (td->ctrl & TD_CTRL_IOC) {
768 *int_mask |= 0x01;
770 uhci_update_irq(s);
771 trace_usb_uhci_packet_complete_stall(async->queue->token, async->td);
772 return TD_RESULT_NEXT_QH;
774 case USB_RET_BABBLE:
775 td->ctrl |= TD_CTRL_BABBLE | TD_CTRL_STALL;
776 td->ctrl &= ~TD_CTRL_ACTIVE;
777 s->status |= UHCI_STS_USBERR;
778 if (td->ctrl & TD_CTRL_IOC) {
779 *int_mask |= 0x01;
781 uhci_update_irq(s);
782 /* frame interrupted */
783 trace_usb_uhci_packet_complete_babble(async->queue->token, async->td);
784 return TD_RESULT_STOP_FRAME;
786 case USB_RET_NAK:
787 td->ctrl |= TD_CTRL_NAK;
788 if (pid == USB_TOKEN_SETUP)
789 break;
790 return TD_RESULT_NEXT_QH;
792 case USB_RET_IOERROR:
793 case USB_RET_NODEV:
794 default:
795 break;
798 /* Retry the TD if error count is not zero */
800 td->ctrl |= TD_CTRL_TIMEOUT;
801 err = (td->ctrl >> TD_CTRL_ERROR_SHIFT) & 3;
802 if (err != 0) {
803 err--;
804 if (err == 0) {
805 td->ctrl &= ~TD_CTRL_ACTIVE;
806 s->status |= UHCI_STS_USBERR;
807 if (td->ctrl & TD_CTRL_IOC)
808 *int_mask |= 0x01;
809 uhci_update_irq(s);
810 trace_usb_uhci_packet_complete_error(async->queue->token,
811 async->td);
814 td->ctrl = (td->ctrl & ~(3 << TD_CTRL_ERROR_SHIFT)) |
815 (err << TD_CTRL_ERROR_SHIFT);
816 return TD_RESULT_NEXT_QH;
819 static int uhci_handle_td(UHCIState *s, uint32_t addr, UHCI_TD *td,
820 uint32_t *int_mask, bool queuing)
822 UHCIAsync *async;
823 int len = 0, max_len;
824 uint8_t pid;
825 USBDevice *dev;
826 USBEndpoint *ep;
828 /* Is active ? */
829 if (!(td->ctrl & TD_CTRL_ACTIVE))
830 return TD_RESULT_NEXT_QH;
832 async = uhci_async_find_td(s, addr, td);
833 if (async) {
834 /* Already submitted */
835 async->queue->valid = 32;
837 if (!async->done)
838 return TD_RESULT_ASYNC_CONT;
839 if (queuing) {
840 /* we are busy filling the queue, we are not prepared
841 to consume completed packages then, just leave them
842 in async state */
843 return TD_RESULT_ASYNC_CONT;
846 uhci_async_unlink(async);
847 goto done;
850 /* Allocate new packet */
851 async = uhci_async_alloc(uhci_queue_get(s, td), addr);
853 /* valid needs to be large enough to handle 10 frame delay
854 * for initial isochronous requests
856 async->queue->valid = 32;
857 async->isoc = td->ctrl & TD_CTRL_IOS;
859 max_len = ((td->token >> 21) + 1) & 0x7ff;
860 pid = td->token & 0xff;
862 dev = uhci_find_device(s, (td->token >> 8) & 0x7f);
863 ep = usb_ep_get(dev, pid, (td->token >> 15) & 0xf);
864 usb_packet_setup(&async->packet, pid, ep, addr);
865 qemu_sglist_add(&async->sgl, td->buffer, max_len);
866 usb_packet_map(&async->packet, &async->sgl);
868 switch(pid) {
869 case USB_TOKEN_OUT:
870 case USB_TOKEN_SETUP:
871 len = usb_handle_packet(dev, &async->packet);
872 if (len >= 0)
873 len = max_len;
874 break;
876 case USB_TOKEN_IN:
877 len = usb_handle_packet(dev, &async->packet);
878 break;
880 default:
881 /* invalid pid : frame interrupted */
882 uhci_async_free(async);
883 s->status |= UHCI_STS_HCPERR;
884 uhci_update_irq(s);
885 return TD_RESULT_STOP_FRAME;
888 if (len == USB_RET_ASYNC) {
889 uhci_async_link(async);
890 return TD_RESULT_ASYNC_START;
893 async->packet.result = len;
895 done:
896 len = uhci_complete_td(s, td, async, int_mask);
897 usb_packet_unmap(&async->packet, &async->sgl);
898 uhci_async_free(async);
899 return len;
902 static void uhci_async_complete(USBPort *port, USBPacket *packet)
904 UHCIAsync *async = container_of(packet, UHCIAsync, packet);
905 UHCIState *s = async->queue->uhci;
907 if (async->isoc) {
908 UHCI_TD td;
909 uint32_t link = async->td;
910 uint32_t int_mask = 0, val;
912 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
913 le32_to_cpus(&td.link);
914 le32_to_cpus(&td.ctrl);
915 le32_to_cpus(&td.token);
916 le32_to_cpus(&td.buffer);
918 uhci_async_unlink(async);
919 uhci_complete_td(s, &td, async, &int_mask);
920 s->pending_int_mask |= int_mask;
922 /* update the status bits of the TD */
923 val = cpu_to_le32(td.ctrl);
924 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
925 uhci_async_free(async);
926 } else {
927 async->done = 1;
928 if (s->frame_bytes < s->frame_bandwidth) {
929 qemu_bh_schedule(s->bh);
934 static int is_valid(uint32_t link)
936 return (link & 1) == 0;
939 static int is_qh(uint32_t link)
941 return (link & 2) != 0;
944 static int depth_first(uint32_t link)
946 return (link & 4) != 0;
949 /* QH DB used for detecting QH loops */
950 #define UHCI_MAX_QUEUES 128
951 typedef struct {
952 uint32_t addr[UHCI_MAX_QUEUES];
953 int count;
954 } QhDb;
956 static void qhdb_reset(QhDb *db)
958 db->count = 0;
961 /* Add QH to DB. Returns 1 if already present or DB is full. */
962 static int qhdb_insert(QhDb *db, uint32_t addr)
964 int i;
965 for (i = 0; i < db->count; i++)
966 if (db->addr[i] == addr)
967 return 1;
969 if (db->count >= UHCI_MAX_QUEUES)
970 return 1;
972 db->addr[db->count++] = addr;
973 return 0;
976 static void uhci_fill_queue(UHCIState *s, UHCI_TD *td)
978 uint32_t int_mask = 0;
979 uint32_t plink = td->link;
980 uint32_t token = uhci_queue_token(td);
981 UHCI_TD ptd;
982 int ret;
984 while (is_valid(plink)) {
985 pci_dma_read(&s->dev, plink & ~0xf, &ptd, sizeof(ptd));
986 le32_to_cpus(&ptd.link);
987 le32_to_cpus(&ptd.ctrl);
988 le32_to_cpus(&ptd.token);
989 le32_to_cpus(&ptd.buffer);
990 if (!(ptd.ctrl & TD_CTRL_ACTIVE)) {
991 break;
993 if (uhci_queue_token(&ptd) != token) {
994 break;
996 trace_usb_uhci_td_queue(plink & ~0xf, ptd.ctrl, ptd.token);
997 ret = uhci_handle_td(s, plink, &ptd, &int_mask, true);
998 if (ret == TD_RESULT_ASYNC_CONT) {
999 break;
1001 assert(ret == TD_RESULT_ASYNC_START);
1002 assert(int_mask == 0);
1003 if (ptd.ctrl & TD_CTRL_SPD) {
1004 break;
1006 plink = ptd.link;
1010 static void uhci_process_frame(UHCIState *s)
1012 uint32_t frame_addr, link, old_td_ctrl, val, int_mask;
1013 uint32_t curr_qh, td_count = 0;
1014 int cnt, ret;
1015 UHCI_TD td;
1016 UHCI_QH qh;
1017 QhDb qhdb;
1019 frame_addr = s->fl_base_addr + ((s->frnum & 0x3ff) << 2);
1021 pci_dma_read(&s->dev, frame_addr, &link, 4);
1022 le32_to_cpus(&link);
1024 int_mask = 0;
1025 curr_qh = 0;
1027 qhdb_reset(&qhdb);
1029 for (cnt = FRAME_MAX_LOOPS; is_valid(link) && cnt; cnt--) {
1030 if (s->frame_bytes >= s->frame_bandwidth) {
1031 /* We've reached the usb 1.1 bandwidth, which is
1032 1280 bytes/frame, stop processing */
1033 trace_usb_uhci_frame_stop_bandwidth();
1034 break;
1036 if (is_qh(link)) {
1037 /* QH */
1038 trace_usb_uhci_qh_load(link & ~0xf);
1040 if (qhdb_insert(&qhdb, link)) {
1042 * We're going in circles. Which is not a bug because
1043 * HCD is allowed to do that as part of the BW management.
1045 * Stop processing here if no transaction has been done
1046 * since we've been here last time.
1048 if (td_count == 0) {
1049 trace_usb_uhci_frame_loop_stop_idle();
1050 break;
1051 } else {
1052 trace_usb_uhci_frame_loop_continue();
1053 td_count = 0;
1054 qhdb_reset(&qhdb);
1055 qhdb_insert(&qhdb, link);
1059 pci_dma_read(&s->dev, link & ~0xf, &qh, sizeof(qh));
1060 le32_to_cpus(&qh.link);
1061 le32_to_cpus(&qh.el_link);
1063 if (!is_valid(qh.el_link)) {
1064 /* QH w/o elements */
1065 curr_qh = 0;
1066 link = qh.link;
1067 } else {
1068 /* QH with elements */
1069 curr_qh = link;
1070 link = qh.el_link;
1072 continue;
1075 /* TD */
1076 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
1077 le32_to_cpus(&td.link);
1078 le32_to_cpus(&td.ctrl);
1079 le32_to_cpus(&td.token);
1080 le32_to_cpus(&td.buffer);
1081 trace_usb_uhci_td_load(curr_qh & ~0xf, link & ~0xf, td.ctrl, td.token);
1083 old_td_ctrl = td.ctrl;
1084 ret = uhci_handle_td(s, link, &td, &int_mask, false);
1085 if (old_td_ctrl != td.ctrl) {
1086 /* update the status bits of the TD */
1087 val = cpu_to_le32(td.ctrl);
1088 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
1091 switch (ret) {
1092 case TD_RESULT_STOP_FRAME: /* interrupted frame */
1093 goto out;
1095 case TD_RESULT_NEXT_QH:
1096 case TD_RESULT_ASYNC_CONT:
1097 trace_usb_uhci_td_nextqh(curr_qh & ~0xf, link & ~0xf);
1098 link = curr_qh ? qh.link : td.link;
1099 continue;
1101 case TD_RESULT_ASYNC_START:
1102 trace_usb_uhci_td_async(curr_qh & ~0xf, link & ~0xf);
1103 if (is_valid(td.link) && !(td.ctrl & TD_CTRL_SPD)) {
1104 uhci_fill_queue(s, &td);
1106 link = curr_qh ? qh.link : td.link;
1107 continue;
1109 case TD_RESULT_COMPLETE:
1110 trace_usb_uhci_td_complete(curr_qh & ~0xf, link & ~0xf);
1111 link = td.link;
1112 td_count++;
1113 s->frame_bytes += (td.ctrl & 0x7ff) + 1;
1115 if (curr_qh) {
1116 /* update QH element link */
1117 qh.el_link = link;
1118 val = cpu_to_le32(qh.el_link);
1119 pci_dma_write(&s->dev, (curr_qh & ~0xf) + 4, &val, sizeof(val));
1121 if (!depth_first(link)) {
1122 /* done with this QH */
1123 curr_qh = 0;
1124 link = qh.link;
1127 break;
1129 default:
1130 assert(!"unknown return code");
1133 /* go to the next entry */
1136 out:
1137 s->pending_int_mask |= int_mask;
1140 static void uhci_bh(void *opaque)
1142 UHCIState *s = opaque;
1143 uhci_process_frame(s);
1146 static void uhci_frame_timer(void *opaque)
1148 UHCIState *s = opaque;
1150 /* prepare the timer for the next frame */
1151 s->expire_time += (get_ticks_per_sec() / FRAME_TIMER_FREQ);
1152 s->frame_bytes = 0;
1153 qemu_bh_cancel(s->bh);
1155 if (!(s->cmd & UHCI_CMD_RS)) {
1156 /* Full stop */
1157 trace_usb_uhci_schedule_stop();
1158 qemu_del_timer(s->frame_timer);
1159 uhci_async_cancel_all(s);
1160 /* set hchalted bit in status - UHCI11D 2.1.2 */
1161 s->status |= UHCI_STS_HCHALTED;
1162 return;
1165 /* Complete the previous frame */
1166 if (s->pending_int_mask) {
1167 s->status2 |= s->pending_int_mask;
1168 s->status |= UHCI_STS_USBINT;
1169 uhci_update_irq(s);
1171 s->pending_int_mask = 0;
1173 /* Start new frame */
1174 s->frnum = (s->frnum + 1) & 0x7ff;
1176 trace_usb_uhci_frame_start(s->frnum);
1178 uhci_async_validate_begin(s);
1180 uhci_process_frame(s);
1182 uhci_async_validate_end(s);
1184 qemu_mod_timer(s->frame_timer, s->expire_time);
1187 static const MemoryRegionPortio uhci_portio[] = {
1188 { 0, 32, 2, .write = uhci_ioport_writew, },
1189 { 0, 32, 2, .read = uhci_ioport_readw, },
1190 { 0, 32, 4, .write = uhci_ioport_writel, },
1191 { 0, 32, 4, .read = uhci_ioport_readl, },
1192 { 0, 32, 1, .write = uhci_ioport_writeb, },
1193 { 0, 32, 1, .read = uhci_ioport_readb, },
1194 PORTIO_END_OF_LIST()
1197 static const MemoryRegionOps uhci_ioport_ops = {
1198 .old_portio = uhci_portio,
1201 static USBPortOps uhci_port_ops = {
1202 .attach = uhci_attach,
1203 .detach = uhci_detach,
1204 .child_detach = uhci_child_detach,
1205 .wakeup = uhci_wakeup,
1206 .complete = uhci_async_complete,
1209 static USBBusOps uhci_bus_ops = {
1212 static int usb_uhci_common_initfn(PCIDevice *dev)
1214 PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(dev);
1215 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1216 uint8_t *pci_conf = s->dev.config;
1217 int i;
1219 pci_conf[PCI_CLASS_PROG] = 0x00;
1220 /* TODO: reset value should be 0. */
1221 pci_conf[USB_SBRN] = USB_RELEASE_1; // release number
1223 switch (pc->device_id) {
1224 case PCI_DEVICE_ID_INTEL_82801I_UHCI1:
1225 s->irq_pin = 0; /* A */
1226 break;
1227 case PCI_DEVICE_ID_INTEL_82801I_UHCI2:
1228 s->irq_pin = 1; /* B */
1229 break;
1230 case PCI_DEVICE_ID_INTEL_82801I_UHCI3:
1231 s->irq_pin = 2; /* C */
1232 break;
1233 default:
1234 s->irq_pin = 3; /* D */
1235 break;
1237 pci_config_set_interrupt_pin(pci_conf, s->irq_pin + 1);
1239 if (s->masterbus) {
1240 USBPort *ports[NB_PORTS];
1241 for(i = 0; i < NB_PORTS; i++) {
1242 ports[i] = &s->ports[i].port;
1244 if (usb_register_companion(s->masterbus, ports, NB_PORTS,
1245 s->firstport, s, &uhci_port_ops,
1246 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL) != 0) {
1247 return -1;
1249 } else {
1250 usb_bus_new(&s->bus, &uhci_bus_ops, &s->dev.qdev);
1251 for (i = 0; i < NB_PORTS; i++) {
1252 usb_register_port(&s->bus, &s->ports[i].port, s, i, &uhci_port_ops,
1253 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
1256 s->bh = qemu_bh_new(uhci_bh, s);
1257 s->frame_timer = qemu_new_timer_ns(vm_clock, uhci_frame_timer, s);
1258 s->num_ports_vmstate = NB_PORTS;
1259 QTAILQ_INIT(&s->queues);
1261 qemu_register_reset(uhci_reset, s);
1263 memory_region_init_io(&s->io_bar, &uhci_ioport_ops, s, "uhci", 0x20);
1264 /* Use region 4 for consistency with real hardware. BSD guests seem
1265 to rely on this. */
1266 pci_register_bar(&s->dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &s->io_bar);
1268 return 0;
1271 static int usb_uhci_vt82c686b_initfn(PCIDevice *dev)
1273 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1274 uint8_t *pci_conf = s->dev.config;
1276 /* USB misc control 1/2 */
1277 pci_set_long(pci_conf + 0x40,0x00001000);
1278 /* PM capability */
1279 pci_set_long(pci_conf + 0x80,0x00020001);
1280 /* USB legacy support */
1281 pci_set_long(pci_conf + 0xc0,0x00002000);
1283 return usb_uhci_common_initfn(dev);
1286 static void usb_uhci_exit(PCIDevice *dev)
1288 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1290 memory_region_destroy(&s->io_bar);
1293 static Property uhci_properties[] = {
1294 DEFINE_PROP_STRING("masterbus", UHCIState, masterbus),
1295 DEFINE_PROP_UINT32("firstport", UHCIState, firstport, 0),
1296 DEFINE_PROP_UINT32("bandwidth", UHCIState, frame_bandwidth, 1280),
1297 DEFINE_PROP_END_OF_LIST(),
1300 static void piix3_uhci_class_init(ObjectClass *klass, void *data)
1302 DeviceClass *dc = DEVICE_CLASS(klass);
1303 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1305 k->init = usb_uhci_common_initfn;
1306 k->exit = usb_uhci_exit;
1307 k->vendor_id = PCI_VENDOR_ID_INTEL;
1308 k->device_id = PCI_DEVICE_ID_INTEL_82371SB_2;
1309 k->revision = 0x01;
1310 k->class_id = PCI_CLASS_SERIAL_USB;
1311 dc->vmsd = &vmstate_uhci;
1312 dc->props = uhci_properties;
1315 static TypeInfo piix3_uhci_info = {
1316 .name = "piix3-usb-uhci",
1317 .parent = TYPE_PCI_DEVICE,
1318 .instance_size = sizeof(UHCIState),
1319 .class_init = piix3_uhci_class_init,
1322 static void piix4_uhci_class_init(ObjectClass *klass, void *data)
1324 DeviceClass *dc = DEVICE_CLASS(klass);
1325 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1327 k->init = usb_uhci_common_initfn;
1328 k->exit = usb_uhci_exit;
1329 k->vendor_id = PCI_VENDOR_ID_INTEL;
1330 k->device_id = PCI_DEVICE_ID_INTEL_82371AB_2;
1331 k->revision = 0x01;
1332 k->class_id = PCI_CLASS_SERIAL_USB;
1333 dc->vmsd = &vmstate_uhci;
1334 dc->props = uhci_properties;
1337 static TypeInfo piix4_uhci_info = {
1338 .name = "piix4-usb-uhci",
1339 .parent = TYPE_PCI_DEVICE,
1340 .instance_size = sizeof(UHCIState),
1341 .class_init = piix4_uhci_class_init,
1344 static void vt82c686b_uhci_class_init(ObjectClass *klass, void *data)
1346 DeviceClass *dc = DEVICE_CLASS(klass);
1347 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1349 k->init = usb_uhci_vt82c686b_initfn;
1350 k->exit = usb_uhci_exit;
1351 k->vendor_id = PCI_VENDOR_ID_VIA;
1352 k->device_id = PCI_DEVICE_ID_VIA_UHCI;
1353 k->revision = 0x01;
1354 k->class_id = PCI_CLASS_SERIAL_USB;
1355 dc->vmsd = &vmstate_uhci;
1356 dc->props = uhci_properties;
1359 static TypeInfo vt82c686b_uhci_info = {
1360 .name = "vt82c686b-usb-uhci",
1361 .parent = TYPE_PCI_DEVICE,
1362 .instance_size = sizeof(UHCIState),
1363 .class_init = vt82c686b_uhci_class_init,
1366 static void ich9_uhci1_class_init(ObjectClass *klass, void *data)
1368 DeviceClass *dc = DEVICE_CLASS(klass);
1369 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1371 k->init = usb_uhci_common_initfn;
1372 k->vendor_id = PCI_VENDOR_ID_INTEL;
1373 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI1;
1374 k->revision = 0x03;
1375 k->class_id = PCI_CLASS_SERIAL_USB;
1376 dc->vmsd = &vmstate_uhci;
1377 dc->props = uhci_properties;
1380 static TypeInfo ich9_uhci1_info = {
1381 .name = "ich9-usb-uhci1",
1382 .parent = TYPE_PCI_DEVICE,
1383 .instance_size = sizeof(UHCIState),
1384 .class_init = ich9_uhci1_class_init,
1387 static void ich9_uhci2_class_init(ObjectClass *klass, void *data)
1389 DeviceClass *dc = DEVICE_CLASS(klass);
1390 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1392 k->init = usb_uhci_common_initfn;
1393 k->vendor_id = PCI_VENDOR_ID_INTEL;
1394 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI2;
1395 k->revision = 0x03;
1396 k->class_id = PCI_CLASS_SERIAL_USB;
1397 dc->vmsd = &vmstate_uhci;
1398 dc->props = uhci_properties;
1401 static TypeInfo ich9_uhci2_info = {
1402 .name = "ich9-usb-uhci2",
1403 .parent = TYPE_PCI_DEVICE,
1404 .instance_size = sizeof(UHCIState),
1405 .class_init = ich9_uhci2_class_init,
1408 static void ich9_uhci3_class_init(ObjectClass *klass, void *data)
1410 DeviceClass *dc = DEVICE_CLASS(klass);
1411 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1413 k->init = usb_uhci_common_initfn;
1414 k->vendor_id = PCI_VENDOR_ID_INTEL;
1415 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI3;
1416 k->revision = 0x03;
1417 k->class_id = PCI_CLASS_SERIAL_USB;
1418 dc->vmsd = &vmstate_uhci;
1419 dc->props = uhci_properties;
1422 static TypeInfo ich9_uhci3_info = {
1423 .name = "ich9-usb-uhci3",
1424 .parent = TYPE_PCI_DEVICE,
1425 .instance_size = sizeof(UHCIState),
1426 .class_init = ich9_uhci3_class_init,
1429 static void uhci_register_types(void)
1431 type_register_static(&piix3_uhci_info);
1432 type_register_static(&piix4_uhci_info);
1433 type_register_static(&vt82c686b_uhci_info);
1434 type_register_static(&ich9_uhci1_info);
1435 type_register_static(&ich9_uhci2_info);
1436 type_register_static(&ich9_uhci3_info);
1439 type_init(uhci_register_types)