uhci: new uhci_handle_td return code for tds still in flight
[qemu/wangdongxu.git] / hw / usb / hcd-uhci.c
blob8e349618597bb764abd8288f07decda6456c8dee
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 UHCIPort ports[NB_PORTS];
136 /* Interrupts that should be raised at the end of the current frame. */
137 uint32_t pending_int_mask;
139 /* Active packets */
140 QTAILQ_HEAD(, UHCIQueue) queues;
141 uint8_t num_ports_vmstate;
143 /* Properties */
144 char *masterbus;
145 uint32_t firstport;
148 typedef struct UHCI_TD {
149 uint32_t link;
150 uint32_t ctrl; /* see TD_CTRL_xxx */
151 uint32_t token;
152 uint32_t buffer;
153 } UHCI_TD;
155 typedef struct UHCI_QH {
156 uint32_t link;
157 uint32_t el_link;
158 } UHCI_QH;
160 static inline int32_t uhci_queue_token(UHCI_TD *td)
162 /* covers ep, dev, pid -> identifies the endpoint */
163 return td->token & 0x7ffff;
166 static UHCIQueue *uhci_queue_get(UHCIState *s, UHCI_TD *td)
168 uint32_t token = uhci_queue_token(td);
169 UHCIQueue *queue;
171 QTAILQ_FOREACH(queue, &s->queues, next) {
172 if (queue->token == token) {
173 return queue;
177 queue = g_new0(UHCIQueue, 1);
178 queue->uhci = s;
179 queue->token = token;
180 QTAILQ_INIT(&queue->asyncs);
181 QTAILQ_INSERT_HEAD(&s->queues, queue, next);
182 trace_usb_uhci_queue_add(queue->token);
183 return queue;
186 static void uhci_queue_free(UHCIQueue *queue)
188 UHCIState *s = queue->uhci;
190 trace_usb_uhci_queue_del(queue->token);
191 QTAILQ_REMOVE(&s->queues, queue, next);
192 g_free(queue);
195 static UHCIAsync *uhci_async_alloc(UHCIQueue *queue, uint32_t addr)
197 UHCIAsync *async = g_new0(UHCIAsync, 1);
199 async->queue = queue;
200 async->td = addr;
201 usb_packet_init(&async->packet);
202 pci_dma_sglist_init(&async->sgl, &queue->uhci->dev, 1);
203 trace_usb_uhci_packet_add(async->queue->token, async->td);
205 return async;
208 static void uhci_async_free(UHCIAsync *async)
210 trace_usb_uhci_packet_del(async->queue->token, async->td);
211 usb_packet_cleanup(&async->packet);
212 qemu_sglist_destroy(&async->sgl);
213 g_free(async);
216 static void uhci_async_link(UHCIAsync *async)
218 UHCIQueue *queue = async->queue;
219 QTAILQ_INSERT_TAIL(&queue->asyncs, async, next);
220 trace_usb_uhci_packet_link_async(async->queue->token, async->td);
223 static void uhci_async_unlink(UHCIAsync *async)
225 UHCIQueue *queue = async->queue;
226 QTAILQ_REMOVE(&queue->asyncs, async, next);
227 trace_usb_uhci_packet_unlink_async(async->queue->token, async->td);
230 static void uhci_async_cancel(UHCIAsync *async)
232 trace_usb_uhci_packet_cancel(async->queue->token, async->td, async->done);
233 if (!async->done)
234 usb_cancel_packet(&async->packet);
235 uhci_async_free(async);
239 * Mark all outstanding async packets as invalid.
240 * This is used for canceling them when TDs are removed by the HCD.
242 static void uhci_async_validate_begin(UHCIState *s)
244 UHCIQueue *queue;
246 QTAILQ_FOREACH(queue, &s->queues, next) {
247 queue->valid--;
252 * Cancel async packets that are no longer valid
254 static void uhci_async_validate_end(UHCIState *s)
256 UHCIQueue *queue, *n;
257 UHCIAsync *async;
259 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, n) {
260 if (queue->valid > 0) {
261 continue;
263 while (!QTAILQ_EMPTY(&queue->asyncs)) {
264 async = QTAILQ_FIRST(&queue->asyncs);
265 uhci_async_unlink(async);
266 uhci_async_cancel(async);
268 uhci_queue_free(queue);
272 static void uhci_async_cancel_device(UHCIState *s, USBDevice *dev)
274 UHCIQueue *queue;
275 UHCIAsync *curr, *n;
277 QTAILQ_FOREACH(queue, &s->queues, next) {
278 QTAILQ_FOREACH_SAFE(curr, &queue->asyncs, next, n) {
279 if (!usb_packet_is_inflight(&curr->packet) ||
280 curr->packet.ep->dev != dev) {
281 continue;
283 uhci_async_unlink(curr);
284 uhci_async_cancel(curr);
289 static void uhci_async_cancel_all(UHCIState *s)
291 UHCIQueue *queue;
292 UHCIAsync *curr, *n;
294 QTAILQ_FOREACH(queue, &s->queues, next) {
295 QTAILQ_FOREACH_SAFE(curr, &queue->asyncs, next, n) {
296 uhci_async_unlink(curr);
297 uhci_async_cancel(curr);
299 uhci_queue_free(queue);
303 static UHCIAsync *uhci_async_find_td(UHCIState *s, uint32_t addr, UHCI_TD *td)
305 uint32_t token = uhci_queue_token(td);
306 UHCIQueue *queue;
307 UHCIAsync *async;
309 QTAILQ_FOREACH(queue, &s->queues, next) {
310 if (queue->token == token) {
311 break;
314 if (queue == NULL) {
315 return NULL;
318 QTAILQ_FOREACH(async, &queue->asyncs, next) {
319 if (async->td == addr) {
320 return async;
324 return NULL;
327 static void uhci_update_irq(UHCIState *s)
329 int level;
330 if (((s->status2 & 1) && (s->intr & (1 << 2))) ||
331 ((s->status2 & 2) && (s->intr & (1 << 3))) ||
332 ((s->status & UHCI_STS_USBERR) && (s->intr & (1 << 0))) ||
333 ((s->status & UHCI_STS_RD) && (s->intr & (1 << 1))) ||
334 (s->status & UHCI_STS_HSERR) ||
335 (s->status & UHCI_STS_HCPERR)) {
336 level = 1;
337 } else {
338 level = 0;
340 qemu_set_irq(s->dev.irq[3], level);
343 static void uhci_reset(void *opaque)
345 UHCIState *s = opaque;
346 uint8_t *pci_conf;
347 int i;
348 UHCIPort *port;
350 trace_usb_uhci_reset();
352 pci_conf = s->dev.config;
354 pci_conf[0x6a] = 0x01; /* usb clock */
355 pci_conf[0x6b] = 0x00;
356 s->cmd = 0;
357 s->status = 0;
358 s->status2 = 0;
359 s->intr = 0;
360 s->fl_base_addr = 0;
361 s->sof_timing = 64;
363 for(i = 0; i < NB_PORTS; i++) {
364 port = &s->ports[i];
365 port->ctrl = 0x0080;
366 if (port->port.dev && port->port.dev->attached) {
367 usb_port_reset(&port->port);
371 uhci_async_cancel_all(s);
374 static void uhci_pre_save(void *opaque)
376 UHCIState *s = opaque;
378 uhci_async_cancel_all(s);
381 static const VMStateDescription vmstate_uhci_port = {
382 .name = "uhci port",
383 .version_id = 1,
384 .minimum_version_id = 1,
385 .minimum_version_id_old = 1,
386 .fields = (VMStateField []) {
387 VMSTATE_UINT16(ctrl, UHCIPort),
388 VMSTATE_END_OF_LIST()
392 static const VMStateDescription vmstate_uhci = {
393 .name = "uhci",
394 .version_id = 2,
395 .minimum_version_id = 1,
396 .minimum_version_id_old = 1,
397 .pre_save = uhci_pre_save,
398 .fields = (VMStateField []) {
399 VMSTATE_PCI_DEVICE(dev, UHCIState),
400 VMSTATE_UINT8_EQUAL(num_ports_vmstate, UHCIState),
401 VMSTATE_STRUCT_ARRAY(ports, UHCIState, NB_PORTS, 1,
402 vmstate_uhci_port, UHCIPort),
403 VMSTATE_UINT16(cmd, UHCIState),
404 VMSTATE_UINT16(status, UHCIState),
405 VMSTATE_UINT16(intr, UHCIState),
406 VMSTATE_UINT16(frnum, UHCIState),
407 VMSTATE_UINT32(fl_base_addr, UHCIState),
408 VMSTATE_UINT8(sof_timing, UHCIState),
409 VMSTATE_UINT8(status2, UHCIState),
410 VMSTATE_TIMER(frame_timer, UHCIState),
411 VMSTATE_INT64_V(expire_time, UHCIState, 2),
412 VMSTATE_END_OF_LIST()
416 static void uhci_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
418 UHCIState *s = opaque;
420 addr &= 0x1f;
421 switch(addr) {
422 case 0x0c:
423 s->sof_timing = val;
424 break;
428 static uint32_t uhci_ioport_readb(void *opaque, uint32_t addr)
430 UHCIState *s = opaque;
431 uint32_t val;
433 addr &= 0x1f;
434 switch(addr) {
435 case 0x0c:
436 val = s->sof_timing;
437 break;
438 default:
439 val = 0xff;
440 break;
442 return val;
445 static void uhci_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
447 UHCIState *s = opaque;
449 addr &= 0x1f;
450 trace_usb_uhci_mmio_writew(addr, val);
452 switch(addr) {
453 case 0x00:
454 if ((val & UHCI_CMD_RS) && !(s->cmd & UHCI_CMD_RS)) {
455 /* start frame processing */
456 trace_usb_uhci_schedule_start();
457 s->expire_time = qemu_get_clock_ns(vm_clock) +
458 (get_ticks_per_sec() / FRAME_TIMER_FREQ);
459 qemu_mod_timer(s->frame_timer, qemu_get_clock_ns(vm_clock));
460 s->status &= ~UHCI_STS_HCHALTED;
461 } else if (!(val & UHCI_CMD_RS)) {
462 s->status |= UHCI_STS_HCHALTED;
464 if (val & UHCI_CMD_GRESET) {
465 UHCIPort *port;
466 int i;
468 /* send reset on the USB bus */
469 for(i = 0; i < NB_PORTS; i++) {
470 port = &s->ports[i];
471 usb_device_reset(port->port.dev);
473 uhci_reset(s);
474 return;
476 if (val & UHCI_CMD_HCRESET) {
477 uhci_reset(s);
478 return;
480 s->cmd = val;
481 break;
482 case 0x02:
483 s->status &= ~val;
484 /* XXX: the chip spec is not coherent, so we add a hidden
485 register to distinguish between IOC and SPD */
486 if (val & UHCI_STS_USBINT)
487 s->status2 = 0;
488 uhci_update_irq(s);
489 break;
490 case 0x04:
491 s->intr = val;
492 uhci_update_irq(s);
493 break;
494 case 0x06:
495 if (s->status & UHCI_STS_HCHALTED)
496 s->frnum = val & 0x7ff;
497 break;
498 case 0x10 ... 0x1f:
500 UHCIPort *port;
501 USBDevice *dev;
502 int n;
504 n = (addr >> 1) & 7;
505 if (n >= NB_PORTS)
506 return;
507 port = &s->ports[n];
508 dev = port->port.dev;
509 if (dev && dev->attached) {
510 /* port reset */
511 if ( (val & UHCI_PORT_RESET) &&
512 !(port->ctrl & UHCI_PORT_RESET) ) {
513 usb_device_reset(dev);
516 port->ctrl &= UHCI_PORT_READ_ONLY;
517 port->ctrl |= (val & ~UHCI_PORT_READ_ONLY);
518 /* some bits are reset when a '1' is written to them */
519 port->ctrl &= ~(val & UHCI_PORT_WRITE_CLEAR);
521 break;
525 static uint32_t uhci_ioport_readw(void *opaque, uint32_t addr)
527 UHCIState *s = opaque;
528 uint32_t val;
530 addr &= 0x1f;
531 switch(addr) {
532 case 0x00:
533 val = s->cmd;
534 break;
535 case 0x02:
536 val = s->status;
537 break;
538 case 0x04:
539 val = s->intr;
540 break;
541 case 0x06:
542 val = s->frnum;
543 break;
544 case 0x10 ... 0x1f:
546 UHCIPort *port;
547 int n;
548 n = (addr >> 1) & 7;
549 if (n >= NB_PORTS)
550 goto read_default;
551 port = &s->ports[n];
552 val = port->ctrl;
554 break;
555 default:
556 read_default:
557 val = 0xff7f; /* disabled port */
558 break;
561 trace_usb_uhci_mmio_readw(addr, val);
563 return val;
566 static void uhci_ioport_writel(void *opaque, uint32_t addr, uint32_t val)
568 UHCIState *s = opaque;
570 addr &= 0x1f;
571 trace_usb_uhci_mmio_writel(addr, val);
573 switch(addr) {
574 case 0x08:
575 s->fl_base_addr = val & ~0xfff;
576 break;
580 static uint32_t uhci_ioport_readl(void *opaque, uint32_t addr)
582 UHCIState *s = opaque;
583 uint32_t val;
585 addr &= 0x1f;
586 switch(addr) {
587 case 0x08:
588 val = s->fl_base_addr;
589 break;
590 default:
591 val = 0xffffffff;
592 break;
594 trace_usb_uhci_mmio_readl(addr, val);
595 return val;
598 /* signal resume if controller suspended */
599 static void uhci_resume (void *opaque)
601 UHCIState *s = (UHCIState *)opaque;
603 if (!s)
604 return;
606 if (s->cmd & UHCI_CMD_EGSM) {
607 s->cmd |= UHCI_CMD_FGR;
608 s->status |= UHCI_STS_RD;
609 uhci_update_irq(s);
613 static void uhci_attach(USBPort *port1)
615 UHCIState *s = port1->opaque;
616 UHCIPort *port = &s->ports[port1->index];
618 /* set connect status */
619 port->ctrl |= UHCI_PORT_CCS | UHCI_PORT_CSC;
621 /* update speed */
622 if (port->port.dev->speed == USB_SPEED_LOW) {
623 port->ctrl |= UHCI_PORT_LSDA;
624 } else {
625 port->ctrl &= ~UHCI_PORT_LSDA;
628 uhci_resume(s);
631 static void uhci_detach(USBPort *port1)
633 UHCIState *s = port1->opaque;
634 UHCIPort *port = &s->ports[port1->index];
636 uhci_async_cancel_device(s, port1->dev);
638 /* set connect status */
639 if (port->ctrl & UHCI_PORT_CCS) {
640 port->ctrl &= ~UHCI_PORT_CCS;
641 port->ctrl |= UHCI_PORT_CSC;
643 /* disable port */
644 if (port->ctrl & UHCI_PORT_EN) {
645 port->ctrl &= ~UHCI_PORT_EN;
646 port->ctrl |= UHCI_PORT_ENC;
649 uhci_resume(s);
652 static void uhci_child_detach(USBPort *port1, USBDevice *child)
654 UHCIState *s = port1->opaque;
656 uhci_async_cancel_device(s, child);
659 static void uhci_wakeup(USBPort *port1)
661 UHCIState *s = port1->opaque;
662 UHCIPort *port = &s->ports[port1->index];
664 if (port->ctrl & UHCI_PORT_SUSPEND && !(port->ctrl & UHCI_PORT_RD)) {
665 port->ctrl |= UHCI_PORT_RD;
666 uhci_resume(s);
670 static USBDevice *uhci_find_device(UHCIState *s, uint8_t addr)
672 USBDevice *dev;
673 int i;
675 for (i = 0; i < NB_PORTS; i++) {
676 UHCIPort *port = &s->ports[i];
677 if (!(port->ctrl & UHCI_PORT_EN)) {
678 continue;
680 dev = usb_find_device(&port->port, addr);
681 if (dev != NULL) {
682 return dev;
685 return NULL;
688 static void uhci_async_complete(USBPort *port, USBPacket *packet);
689 static void uhci_process_frame(UHCIState *s);
691 /* return -1 if fatal error (frame must be stopped)
692 0 if TD successful
693 1 if TD unsuccessful or inactive
695 static int uhci_complete_td(UHCIState *s, UHCI_TD *td, UHCIAsync *async, uint32_t *int_mask)
697 int len = 0, max_len, err, ret;
698 uint8_t pid;
700 max_len = ((td->token >> 21) + 1) & 0x7ff;
701 pid = td->token & 0xff;
703 ret = async->packet.result;
705 if (td->ctrl & TD_CTRL_IOS)
706 td->ctrl &= ~TD_CTRL_ACTIVE;
708 if (ret < 0)
709 goto out;
711 len = async->packet.result;
712 td->ctrl = (td->ctrl & ~0x7ff) | ((len - 1) & 0x7ff);
714 /* The NAK bit may have been set by a previous frame, so clear it
715 here. The docs are somewhat unclear, but win2k relies on this
716 behavior. */
717 td->ctrl &= ~(TD_CTRL_ACTIVE | TD_CTRL_NAK);
718 if (td->ctrl & TD_CTRL_IOC)
719 *int_mask |= 0x01;
721 if (pid == USB_TOKEN_IN) {
722 if (len > max_len) {
723 ret = USB_RET_BABBLE;
724 goto out;
727 if ((td->ctrl & TD_CTRL_SPD) && len < max_len) {
728 *int_mask |= 0x02;
729 /* short packet: do not update QH */
730 trace_usb_uhci_packet_complete_shortxfer(async->queue->token,
731 async->td);
732 return TD_RESULT_NEXT_QH;
736 /* success */
737 trace_usb_uhci_packet_complete_success(async->queue->token, async->td);
738 return TD_RESULT_COMPLETE;
740 out:
741 switch(ret) {
742 case USB_RET_STALL:
743 td->ctrl |= TD_CTRL_STALL;
744 td->ctrl &= ~TD_CTRL_ACTIVE;
745 s->status |= UHCI_STS_USBERR;
746 if (td->ctrl & TD_CTRL_IOC) {
747 *int_mask |= 0x01;
749 uhci_update_irq(s);
750 trace_usb_uhci_packet_complete_stall(async->queue->token, async->td);
751 return TD_RESULT_NEXT_QH;
753 case USB_RET_BABBLE:
754 td->ctrl |= TD_CTRL_BABBLE | TD_CTRL_STALL;
755 td->ctrl &= ~TD_CTRL_ACTIVE;
756 s->status |= UHCI_STS_USBERR;
757 if (td->ctrl & TD_CTRL_IOC) {
758 *int_mask |= 0x01;
760 uhci_update_irq(s);
761 /* frame interrupted */
762 trace_usb_uhci_packet_complete_babble(async->queue->token, async->td);
763 return TD_RESULT_STOP_FRAME;
765 case USB_RET_NAK:
766 td->ctrl |= TD_CTRL_NAK;
767 if (pid == USB_TOKEN_SETUP)
768 break;
769 return TD_RESULT_NEXT_QH;
771 case USB_RET_IOERROR:
772 case USB_RET_NODEV:
773 default:
774 break;
777 /* Retry the TD if error count is not zero */
779 td->ctrl |= TD_CTRL_TIMEOUT;
780 err = (td->ctrl >> TD_CTRL_ERROR_SHIFT) & 3;
781 if (err != 0) {
782 err--;
783 if (err == 0) {
784 td->ctrl &= ~TD_CTRL_ACTIVE;
785 s->status |= UHCI_STS_USBERR;
786 if (td->ctrl & TD_CTRL_IOC)
787 *int_mask |= 0x01;
788 uhci_update_irq(s);
789 trace_usb_uhci_packet_complete_error(async->queue->token,
790 async->td);
793 td->ctrl = (td->ctrl & ~(3 << TD_CTRL_ERROR_SHIFT)) |
794 (err << TD_CTRL_ERROR_SHIFT);
795 return TD_RESULT_NEXT_QH;
798 static int uhci_handle_td(UHCIState *s, uint32_t addr, UHCI_TD *td, uint32_t *int_mask)
800 UHCIAsync *async;
801 int len = 0, max_len;
802 uint8_t pid;
803 USBDevice *dev;
804 USBEndpoint *ep;
806 /* Is active ? */
807 if (!(td->ctrl & TD_CTRL_ACTIVE))
808 return TD_RESULT_NEXT_QH;
810 async = uhci_async_find_td(s, addr, td);
811 if (async) {
812 /* Already submitted */
813 async->queue->valid = 32;
815 if (!async->done)
816 return TD_RESULT_ASYNC_CONT;
818 uhci_async_unlink(async);
819 goto done;
822 /* Allocate new packet */
823 async = uhci_async_alloc(uhci_queue_get(s, td), addr);
824 if (!async)
825 return TD_RESULT_NEXT_QH;
827 /* valid needs to be large enough to handle 10 frame delay
828 * for initial isochronous requests
830 async->queue->valid = 32;
831 async->isoc = td->ctrl & TD_CTRL_IOS;
833 max_len = ((td->token >> 21) + 1) & 0x7ff;
834 pid = td->token & 0xff;
836 dev = uhci_find_device(s, (td->token >> 8) & 0x7f);
837 ep = usb_ep_get(dev, pid, (td->token >> 15) & 0xf);
838 usb_packet_setup(&async->packet, pid, ep);
839 qemu_sglist_add(&async->sgl, td->buffer, max_len);
840 usb_packet_map(&async->packet, &async->sgl);
842 switch(pid) {
843 case USB_TOKEN_OUT:
844 case USB_TOKEN_SETUP:
845 len = usb_handle_packet(dev, &async->packet);
846 if (len >= 0)
847 len = max_len;
848 break;
850 case USB_TOKEN_IN:
851 len = usb_handle_packet(dev, &async->packet);
852 break;
854 default:
855 /* invalid pid : frame interrupted */
856 uhci_async_free(async);
857 s->status |= UHCI_STS_HCPERR;
858 uhci_update_irq(s);
859 return TD_RESULT_STOP_FRAME;
862 if (len == USB_RET_ASYNC) {
863 uhci_async_link(async);
864 return TD_RESULT_ASYNC_START;
867 async->packet.result = len;
869 done:
870 len = uhci_complete_td(s, td, async, int_mask);
871 usb_packet_unmap(&async->packet);
872 uhci_async_free(async);
873 return len;
876 static void uhci_async_complete(USBPort *port, USBPacket *packet)
878 UHCIAsync *async = container_of(packet, UHCIAsync, packet);
879 UHCIState *s = async->queue->uhci;
881 if (async->isoc) {
882 UHCI_TD td;
883 uint32_t link = async->td;
884 uint32_t int_mask = 0, val;
886 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
887 le32_to_cpus(&td.link);
888 le32_to_cpus(&td.ctrl);
889 le32_to_cpus(&td.token);
890 le32_to_cpus(&td.buffer);
892 uhci_async_unlink(async);
893 uhci_complete_td(s, &td, async, &int_mask);
894 s->pending_int_mask |= int_mask;
896 /* update the status bits of the TD */
897 val = cpu_to_le32(td.ctrl);
898 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
899 uhci_async_free(async);
900 } else {
901 async->done = 1;
902 uhci_process_frame(s);
906 static int is_valid(uint32_t link)
908 return (link & 1) == 0;
911 static int is_qh(uint32_t link)
913 return (link & 2) != 0;
916 static int depth_first(uint32_t link)
918 return (link & 4) != 0;
921 /* QH DB used for detecting QH loops */
922 #define UHCI_MAX_QUEUES 128
923 typedef struct {
924 uint32_t addr[UHCI_MAX_QUEUES];
925 int count;
926 } QhDb;
928 static void qhdb_reset(QhDb *db)
930 db->count = 0;
933 /* Add QH to DB. Returns 1 if already present or DB is full. */
934 static int qhdb_insert(QhDb *db, uint32_t addr)
936 int i;
937 for (i = 0; i < db->count; i++)
938 if (db->addr[i] == addr)
939 return 1;
941 if (db->count >= UHCI_MAX_QUEUES)
942 return 1;
944 db->addr[db->count++] = addr;
945 return 0;
948 static void uhci_fill_queue(UHCIState *s, UHCI_TD *td)
950 uint32_t int_mask = 0;
951 uint32_t plink = td->link;
952 uint32_t token = uhci_queue_token(td);
953 UHCI_TD ptd;
954 int ret;
956 while (is_valid(plink)) {
957 pci_dma_read(&s->dev, plink & ~0xf, &ptd, sizeof(ptd));
958 le32_to_cpus(&ptd.link);
959 le32_to_cpus(&ptd.ctrl);
960 le32_to_cpus(&ptd.token);
961 le32_to_cpus(&ptd.buffer);
962 if (!(ptd.ctrl & TD_CTRL_ACTIVE)) {
963 break;
965 if (uhci_queue_token(&ptd) != token) {
966 break;
968 trace_usb_uhci_td_queue(plink & ~0xf, ptd.ctrl, ptd.token);
969 ret = uhci_handle_td(s, plink, &ptd, &int_mask);
970 assert(ret == TD_RESULT_ASYNC_START);
971 assert(int_mask == 0);
972 plink = ptd.link;
976 static void uhci_process_frame(UHCIState *s)
978 uint32_t frame_addr, link, old_td_ctrl, val, int_mask;
979 uint32_t curr_qh, td_count = 0, bytes_count = 0;
980 int cnt, ret;
981 UHCI_TD td;
982 UHCI_QH qh;
983 QhDb qhdb;
985 frame_addr = s->fl_base_addr + ((s->frnum & 0x3ff) << 2);
987 pci_dma_read(&s->dev, frame_addr, &link, 4);
988 le32_to_cpus(&link);
990 int_mask = 0;
991 curr_qh = 0;
993 qhdb_reset(&qhdb);
995 for (cnt = FRAME_MAX_LOOPS; is_valid(link) && cnt; cnt--) {
996 if (is_qh(link)) {
997 /* QH */
998 trace_usb_uhci_qh_load(link & ~0xf);
1000 if (qhdb_insert(&qhdb, link)) {
1002 * We're going in circles. Which is not a bug because
1003 * HCD is allowed to do that as part of the BW management.
1005 * Stop processing here if
1006 * (a) no transaction has been done since we've been
1007 * here last time, or
1008 * (b) we've reached the usb 1.1 bandwidth, which is
1009 * 1280 bytes/frame.
1011 if (td_count == 0) {
1012 trace_usb_uhci_frame_loop_stop_idle();
1013 break;
1014 } else if (bytes_count >= 1280) {
1015 trace_usb_uhci_frame_loop_stop_bandwidth();
1016 break;
1017 } else {
1018 trace_usb_uhci_frame_loop_continue();
1019 td_count = 0;
1020 qhdb_reset(&qhdb);
1021 qhdb_insert(&qhdb, link);
1025 pci_dma_read(&s->dev, link & ~0xf, &qh, sizeof(qh));
1026 le32_to_cpus(&qh.link);
1027 le32_to_cpus(&qh.el_link);
1029 if (!is_valid(qh.el_link)) {
1030 /* QH w/o elements */
1031 curr_qh = 0;
1032 link = qh.link;
1033 } else {
1034 /* QH with elements */
1035 curr_qh = link;
1036 link = qh.el_link;
1038 continue;
1041 /* TD */
1042 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
1043 le32_to_cpus(&td.link);
1044 le32_to_cpus(&td.ctrl);
1045 le32_to_cpus(&td.token);
1046 le32_to_cpus(&td.buffer);
1047 trace_usb_uhci_td_load(curr_qh & ~0xf, link & ~0xf, td.ctrl, td.token);
1049 old_td_ctrl = td.ctrl;
1050 ret = uhci_handle_td(s, link, &td, &int_mask);
1051 if (old_td_ctrl != td.ctrl) {
1052 /* update the status bits of the TD */
1053 val = cpu_to_le32(td.ctrl);
1054 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
1057 switch (ret) {
1058 case TD_RESULT_STOP_FRAME: /* interrupted frame */
1059 goto out;
1061 case TD_RESULT_NEXT_QH:
1062 case TD_RESULT_ASYNC_CONT:
1063 trace_usb_uhci_td_nextqh(curr_qh & ~0xf, link & ~0xf);
1064 link = curr_qh ? qh.link : td.link;
1065 continue;
1067 case TD_RESULT_ASYNC_START:
1068 trace_usb_uhci_td_async(curr_qh & ~0xf, link & ~0xf);
1069 if (is_valid(td.link)) {
1070 uhci_fill_queue(s, &td);
1072 link = curr_qh ? qh.link : td.link;
1073 continue;
1075 case TD_RESULT_COMPLETE:
1076 trace_usb_uhci_td_complete(curr_qh & ~0xf, link & ~0xf);
1077 link = td.link;
1078 td_count++;
1079 bytes_count += (td.ctrl & 0x7ff) + 1;
1081 if (curr_qh) {
1082 /* update QH element link */
1083 qh.el_link = link;
1084 val = cpu_to_le32(qh.el_link);
1085 pci_dma_write(&s->dev, (curr_qh & ~0xf) + 4, &val, sizeof(val));
1087 if (!depth_first(link)) {
1088 /* done with this QH */
1089 curr_qh = 0;
1090 link = qh.link;
1093 break;
1095 default:
1096 assert(!"unknown return code");
1099 /* go to the next entry */
1102 out:
1103 s->pending_int_mask |= int_mask;
1106 static void uhci_frame_timer(void *opaque)
1108 UHCIState *s = opaque;
1110 /* prepare the timer for the next frame */
1111 s->expire_time += (get_ticks_per_sec() / FRAME_TIMER_FREQ);
1113 if (!(s->cmd & UHCI_CMD_RS)) {
1114 /* Full stop */
1115 trace_usb_uhci_schedule_stop();
1116 qemu_del_timer(s->frame_timer);
1117 uhci_async_cancel_all(s);
1118 /* set hchalted bit in status - UHCI11D 2.1.2 */
1119 s->status |= UHCI_STS_HCHALTED;
1120 return;
1123 /* Complete the previous frame */
1124 if (s->pending_int_mask) {
1125 s->status2 |= s->pending_int_mask;
1126 s->status |= UHCI_STS_USBINT;
1127 uhci_update_irq(s);
1129 s->pending_int_mask = 0;
1131 /* Start new frame */
1132 s->frnum = (s->frnum + 1) & 0x7ff;
1134 trace_usb_uhci_frame_start(s->frnum);
1136 uhci_async_validate_begin(s);
1138 uhci_process_frame(s);
1140 uhci_async_validate_end(s);
1142 qemu_mod_timer(s->frame_timer, s->expire_time);
1145 static const MemoryRegionPortio uhci_portio[] = {
1146 { 0, 32, 2, .write = uhci_ioport_writew, },
1147 { 0, 32, 2, .read = uhci_ioport_readw, },
1148 { 0, 32, 4, .write = uhci_ioport_writel, },
1149 { 0, 32, 4, .read = uhci_ioport_readl, },
1150 { 0, 32, 1, .write = uhci_ioport_writeb, },
1151 { 0, 32, 1, .read = uhci_ioport_readb, },
1152 PORTIO_END_OF_LIST()
1155 static const MemoryRegionOps uhci_ioport_ops = {
1156 .old_portio = uhci_portio,
1159 static USBPortOps uhci_port_ops = {
1160 .attach = uhci_attach,
1161 .detach = uhci_detach,
1162 .child_detach = uhci_child_detach,
1163 .wakeup = uhci_wakeup,
1164 .complete = uhci_async_complete,
1167 static USBBusOps uhci_bus_ops = {
1170 static int usb_uhci_common_initfn(PCIDevice *dev)
1172 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1173 uint8_t *pci_conf = s->dev.config;
1174 int i;
1176 pci_conf[PCI_CLASS_PROG] = 0x00;
1177 /* TODO: reset value should be 0. */
1178 pci_conf[PCI_INTERRUPT_PIN] = 4; /* interrupt pin D */
1179 pci_conf[USB_SBRN] = USB_RELEASE_1; // release number
1181 if (s->masterbus) {
1182 USBPort *ports[NB_PORTS];
1183 for(i = 0; i < NB_PORTS; i++) {
1184 ports[i] = &s->ports[i].port;
1186 if (usb_register_companion(s->masterbus, ports, NB_PORTS,
1187 s->firstport, s, &uhci_port_ops,
1188 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL) != 0) {
1189 return -1;
1191 } else {
1192 usb_bus_new(&s->bus, &uhci_bus_ops, &s->dev.qdev);
1193 for (i = 0; i < NB_PORTS; i++) {
1194 usb_register_port(&s->bus, &s->ports[i].port, s, i, &uhci_port_ops,
1195 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
1198 s->frame_timer = qemu_new_timer_ns(vm_clock, uhci_frame_timer, s);
1199 s->num_ports_vmstate = NB_PORTS;
1200 QTAILQ_INIT(&s->queues);
1202 qemu_register_reset(uhci_reset, s);
1204 memory_region_init_io(&s->io_bar, &uhci_ioport_ops, s, "uhci", 0x20);
1205 /* Use region 4 for consistency with real hardware. BSD guests seem
1206 to rely on this. */
1207 pci_register_bar(&s->dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &s->io_bar);
1209 return 0;
1212 static int usb_uhci_vt82c686b_initfn(PCIDevice *dev)
1214 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1215 uint8_t *pci_conf = s->dev.config;
1217 /* USB misc control 1/2 */
1218 pci_set_long(pci_conf + 0x40,0x00001000);
1219 /* PM capability */
1220 pci_set_long(pci_conf + 0x80,0x00020001);
1221 /* USB legacy support */
1222 pci_set_long(pci_conf + 0xc0,0x00002000);
1224 return usb_uhci_common_initfn(dev);
1227 static int usb_uhci_exit(PCIDevice *dev)
1229 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1231 memory_region_destroy(&s->io_bar);
1232 return 0;
1235 static Property uhci_properties[] = {
1236 DEFINE_PROP_STRING("masterbus", UHCIState, masterbus),
1237 DEFINE_PROP_UINT32("firstport", UHCIState, firstport, 0),
1238 DEFINE_PROP_END_OF_LIST(),
1241 static void piix3_uhci_class_init(ObjectClass *klass, void *data)
1243 DeviceClass *dc = DEVICE_CLASS(klass);
1244 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1246 k->init = usb_uhci_common_initfn;
1247 k->exit = usb_uhci_exit;
1248 k->vendor_id = PCI_VENDOR_ID_INTEL;
1249 k->device_id = PCI_DEVICE_ID_INTEL_82371SB_2;
1250 k->revision = 0x01;
1251 k->class_id = PCI_CLASS_SERIAL_USB;
1252 dc->vmsd = &vmstate_uhci;
1253 dc->props = uhci_properties;
1256 static TypeInfo piix3_uhci_info = {
1257 .name = "piix3-usb-uhci",
1258 .parent = TYPE_PCI_DEVICE,
1259 .instance_size = sizeof(UHCIState),
1260 .class_init = piix3_uhci_class_init,
1263 static void piix4_uhci_class_init(ObjectClass *klass, void *data)
1265 DeviceClass *dc = DEVICE_CLASS(klass);
1266 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1268 k->init = usb_uhci_common_initfn;
1269 k->exit = usb_uhci_exit;
1270 k->vendor_id = PCI_VENDOR_ID_INTEL;
1271 k->device_id = PCI_DEVICE_ID_INTEL_82371AB_2;
1272 k->revision = 0x01;
1273 k->class_id = PCI_CLASS_SERIAL_USB;
1274 dc->vmsd = &vmstate_uhci;
1275 dc->props = uhci_properties;
1278 static TypeInfo piix4_uhci_info = {
1279 .name = "piix4-usb-uhci",
1280 .parent = TYPE_PCI_DEVICE,
1281 .instance_size = sizeof(UHCIState),
1282 .class_init = piix4_uhci_class_init,
1285 static void vt82c686b_uhci_class_init(ObjectClass *klass, void *data)
1287 DeviceClass *dc = DEVICE_CLASS(klass);
1288 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1290 k->init = usb_uhci_vt82c686b_initfn;
1291 k->exit = usb_uhci_exit;
1292 k->vendor_id = PCI_VENDOR_ID_VIA;
1293 k->device_id = PCI_DEVICE_ID_VIA_UHCI;
1294 k->revision = 0x01;
1295 k->class_id = PCI_CLASS_SERIAL_USB;
1296 dc->vmsd = &vmstate_uhci;
1297 dc->props = uhci_properties;
1300 static TypeInfo vt82c686b_uhci_info = {
1301 .name = "vt82c686b-usb-uhci",
1302 .parent = TYPE_PCI_DEVICE,
1303 .instance_size = sizeof(UHCIState),
1304 .class_init = vt82c686b_uhci_class_init,
1307 static void ich9_uhci1_class_init(ObjectClass *klass, void *data)
1309 DeviceClass *dc = DEVICE_CLASS(klass);
1310 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1312 k->init = usb_uhci_common_initfn;
1313 k->vendor_id = PCI_VENDOR_ID_INTEL;
1314 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI1;
1315 k->revision = 0x03;
1316 k->class_id = PCI_CLASS_SERIAL_USB;
1317 dc->vmsd = &vmstate_uhci;
1318 dc->props = uhci_properties;
1321 static TypeInfo ich9_uhci1_info = {
1322 .name = "ich9-usb-uhci1",
1323 .parent = TYPE_PCI_DEVICE,
1324 .instance_size = sizeof(UHCIState),
1325 .class_init = ich9_uhci1_class_init,
1328 static void ich9_uhci2_class_init(ObjectClass *klass, void *data)
1330 DeviceClass *dc = DEVICE_CLASS(klass);
1331 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1333 k->init = usb_uhci_common_initfn;
1334 k->vendor_id = PCI_VENDOR_ID_INTEL;
1335 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI2;
1336 k->revision = 0x03;
1337 k->class_id = PCI_CLASS_SERIAL_USB;
1338 dc->vmsd = &vmstate_uhci;
1339 dc->props = uhci_properties;
1342 static TypeInfo ich9_uhci2_info = {
1343 .name = "ich9-usb-uhci2",
1344 .parent = TYPE_PCI_DEVICE,
1345 .instance_size = sizeof(UHCIState),
1346 .class_init = ich9_uhci2_class_init,
1349 static void ich9_uhci3_class_init(ObjectClass *klass, void *data)
1351 DeviceClass *dc = DEVICE_CLASS(klass);
1352 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1354 k->init = usb_uhci_common_initfn;
1355 k->vendor_id = PCI_VENDOR_ID_INTEL;
1356 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI3;
1357 k->revision = 0x03;
1358 k->class_id = PCI_CLASS_SERIAL_USB;
1359 dc->vmsd = &vmstate_uhci;
1360 dc->props = uhci_properties;
1363 static TypeInfo ich9_uhci3_info = {
1364 .name = "ich9-usb-uhci3",
1365 .parent = TYPE_PCI_DEVICE,
1366 .instance_size = sizeof(UHCIState),
1367 .class_init = ich9_uhci3_class_init,
1370 static void uhci_register_types(void)
1372 type_register_static(&piix3_uhci_info);
1373 type_register_static(&piix4_uhci_info);
1374 type_register_static(&vt82c686b_uhci_info);
1375 type_register_static(&ich9_uhci1_info);
1376 type_register_static(&ich9_uhci2_info);
1377 type_register_static(&ich9_uhci3_info);
1380 type_init(uhci_register_types)