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
31 #include "qemu-timer.h"
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 100
81 #define DPRINTF printf
83 static const char *pid2str(int pid)
86 case USB_TOKEN_SETUP: return "SETUP";
87 case USB_TOKEN_IN: return "IN";
88 case USB_TOKEN_OUT: return "OUT";
97 #ifdef DEBUG_DUMP_DATA
98 static void dump_data(USBPacket *p, int ret)
100 iov_hexdump(p->iov.iov, p->iov.niov, stderr, "uhci", ret);
103 static void dump_data(USBPacket *p, int ret) {}
106 typedef struct UHCIState UHCIState;
109 * Pending async transaction.
110 * 'packet' must be the first field because completion
111 * handler does "(UHCIAsync *) pkt" cast.
113 typedef struct UHCIAsync {
117 QTAILQ_ENTRY(UHCIAsync) next;
125 typedef struct UHCIPort {
133 USBBus bus; /* Note unused when we're a companion controller */
134 uint16_t cmd; /* cmd register */
136 uint16_t intr; /* interrupt enable register */
137 uint16_t frnum; /* frame number */
138 uint32_t fl_base_addr; /* frame list base address */
140 uint8_t status2; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
142 QEMUTimer *frame_timer;
143 UHCIPort ports[NB_PORTS];
145 /* Interrupts that should be raised at the end of the current frame. */
146 uint32_t pending_int_mask;
149 QTAILQ_HEAD(,UHCIAsync) async_pending;
150 uint8_t num_ports_vmstate;
157 typedef struct UHCI_TD {
159 uint32_t ctrl; /* see TD_CTRL_xxx */
164 typedef struct UHCI_QH {
169 static UHCIAsync *uhci_async_alloc(UHCIState *s)
171 UHCIAsync *async = g_malloc(sizeof(UHCIAsync));
173 memset(&async->packet, 0, sizeof(async->packet));
180 usb_packet_init(&async->packet);
181 pci_dma_sglist_init(&async->sgl, &s->dev, 1);
186 static void uhci_async_free(UHCIState *s, UHCIAsync *async)
188 usb_packet_cleanup(&async->packet);
189 qemu_sglist_destroy(&async->sgl);
193 static void uhci_async_link(UHCIState *s, UHCIAsync *async)
195 QTAILQ_INSERT_HEAD(&s->async_pending, async, next);
198 static void uhci_async_unlink(UHCIState *s, UHCIAsync *async)
200 QTAILQ_REMOVE(&s->async_pending, async, next);
203 static void uhci_async_cancel(UHCIState *s, UHCIAsync *async)
205 DPRINTF("uhci: cancel td 0x%x token 0x%x done %u\n",
206 async->td, async->token, async->done);
209 usb_cancel_packet(&async->packet);
210 uhci_async_free(s, async);
214 * Mark all outstanding async packets as invalid.
215 * This is used for canceling them when TDs are removed by the HCD.
217 static UHCIAsync *uhci_async_validate_begin(UHCIState *s)
221 QTAILQ_FOREACH(async, &s->async_pending, next) {
228 * Cancel async packets that are no longer valid
230 static void uhci_async_validate_end(UHCIState *s)
234 QTAILQ_FOREACH_SAFE(curr, &s->async_pending, next, n) {
235 if (curr->valid > 0) {
238 uhci_async_unlink(s, curr);
239 uhci_async_cancel(s, curr);
243 static void uhci_async_cancel_device(UHCIState *s, USBDevice *dev)
247 QTAILQ_FOREACH_SAFE(curr, &s->async_pending, next, n) {
248 if (curr->packet.owner == NULL ||
249 curr->packet.owner->dev != dev) {
252 uhci_async_unlink(s, curr);
253 uhci_async_cancel(s, curr);
257 static void uhci_async_cancel_all(UHCIState *s)
261 QTAILQ_FOREACH_SAFE(curr, &s->async_pending, next, n) {
262 uhci_async_unlink(s, curr);
263 uhci_async_cancel(s, curr);
267 static UHCIAsync *uhci_async_find_td(UHCIState *s, uint32_t addr, uint32_t token)
270 UHCIAsync *match = NULL;
274 * We're looking for the best match here. ie both td addr and token.
275 * Otherwise we return last good match. ie just token.
276 * It's ok to match just token because it identifies the transaction
277 * rather well, token includes: device addr, endpoint, size, etc.
279 * Also since we queue async transactions in reverse order by returning
280 * last good match we restores the order.
282 * It's expected that we wont have a ton of outstanding transactions.
283 * If we ever do we'd want to optimize this algorithm.
286 QTAILQ_FOREACH(async, &s->async_pending, next) {
287 if (async->token == token) {
291 if (async->td == addr) {
300 fprintf(stderr, "uhci: warning lots of async transactions\n");
305 static void uhci_update_irq(UHCIState *s)
308 if (((s->status2 & 1) && (s->intr & (1 << 2))) ||
309 ((s->status2 & 2) && (s->intr & (1 << 3))) ||
310 ((s->status & UHCI_STS_USBERR) && (s->intr & (1 << 0))) ||
311 ((s->status & UHCI_STS_RD) && (s->intr & (1 << 1))) ||
312 (s->status & UHCI_STS_HSERR) ||
313 (s->status & UHCI_STS_HCPERR)) {
318 qemu_set_irq(s->dev.irq[3], level);
321 static void uhci_reset(void *opaque)
323 UHCIState *s = opaque;
328 DPRINTF("uhci: full reset\n");
330 pci_conf = s->dev.config;
332 pci_conf[0x6a] = 0x01; /* usb clock */
333 pci_conf[0x6b] = 0x00;
341 for(i = 0; i < NB_PORTS; i++) {
344 if (port->port.dev && port->port.dev->attached) {
345 usb_reset(&port->port);
349 uhci_async_cancel_all(s);
352 static void uhci_pre_save(void *opaque)
354 UHCIState *s = opaque;
356 uhci_async_cancel_all(s);
359 static const VMStateDescription vmstate_uhci_port = {
362 .minimum_version_id = 1,
363 .minimum_version_id_old = 1,
364 .fields = (VMStateField []) {
365 VMSTATE_UINT16(ctrl, UHCIPort),
366 VMSTATE_END_OF_LIST()
370 static const VMStateDescription vmstate_uhci = {
373 .minimum_version_id = 1,
374 .minimum_version_id_old = 1,
375 .pre_save = uhci_pre_save,
376 .fields = (VMStateField []) {
377 VMSTATE_PCI_DEVICE(dev, UHCIState),
378 VMSTATE_UINT8_EQUAL(num_ports_vmstate, UHCIState),
379 VMSTATE_STRUCT_ARRAY(ports, UHCIState, NB_PORTS, 1,
380 vmstate_uhci_port, UHCIPort),
381 VMSTATE_UINT16(cmd, UHCIState),
382 VMSTATE_UINT16(status, UHCIState),
383 VMSTATE_UINT16(intr, UHCIState),
384 VMSTATE_UINT16(frnum, UHCIState),
385 VMSTATE_UINT32(fl_base_addr, UHCIState),
386 VMSTATE_UINT8(sof_timing, UHCIState),
387 VMSTATE_UINT8(status2, UHCIState),
388 VMSTATE_TIMER(frame_timer, UHCIState),
389 VMSTATE_INT64_V(expire_time, UHCIState, 2),
390 VMSTATE_END_OF_LIST()
394 static void uhci_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
396 UHCIState *s = opaque;
406 static uint32_t uhci_ioport_readb(void *opaque, uint32_t addr)
408 UHCIState *s = opaque;
423 static void uhci_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
425 UHCIState *s = opaque;
428 DPRINTF("uhci: writew port=0x%04x val=0x%04x\n", addr, val);
432 if ((val & UHCI_CMD_RS) && !(s->cmd & UHCI_CMD_RS)) {
433 /* start frame processing */
434 s->expire_time = qemu_get_clock_ns(vm_clock) +
435 (get_ticks_per_sec() / FRAME_TIMER_FREQ);
436 qemu_mod_timer(s->frame_timer, qemu_get_clock_ns(vm_clock));
437 s->status &= ~UHCI_STS_HCHALTED;
438 } else if (!(val & UHCI_CMD_RS)) {
439 s->status |= UHCI_STS_HCHALTED;
441 if (val & UHCI_CMD_GRESET) {
446 /* send reset on the USB bus */
447 for(i = 0; i < NB_PORTS; i++) {
449 dev = port->port.dev;
450 if (dev && dev->attached) {
451 usb_send_msg(dev, USB_MSG_RESET);
457 if (val & UHCI_CMD_HCRESET) {
465 /* XXX: the chip spec is not coherent, so we add a hidden
466 register to distinguish between IOC and SPD */
467 if (val & UHCI_STS_USBINT)
476 if (s->status & UHCI_STS_HCHALTED)
477 s->frnum = val & 0x7ff;
489 dev = port->port.dev;
490 if (dev && dev->attached) {
492 if ( (val & UHCI_PORT_RESET) &&
493 !(port->ctrl & UHCI_PORT_RESET) ) {
494 usb_send_msg(dev, USB_MSG_RESET);
497 port->ctrl &= UHCI_PORT_READ_ONLY;
498 port->ctrl |= (val & ~UHCI_PORT_READ_ONLY);
499 /* some bits are reset when a '1' is written to them */
500 port->ctrl &= ~(val & UHCI_PORT_WRITE_CLEAR);
506 static uint32_t uhci_ioport_readw(void *opaque, uint32_t addr)
508 UHCIState *s = opaque;
538 val = 0xff7f; /* disabled port */
542 DPRINTF("uhci: readw port=0x%04x val=0x%04x\n", addr, val);
547 static void uhci_ioport_writel(void *opaque, uint32_t addr, uint32_t val)
549 UHCIState *s = opaque;
552 DPRINTF("uhci: writel port=0x%04x val=0x%08x\n", addr, val);
556 s->fl_base_addr = val & ~0xfff;
561 static uint32_t uhci_ioport_readl(void *opaque, uint32_t addr)
563 UHCIState *s = opaque;
569 val = s->fl_base_addr;
578 /* signal resume if controller suspended */
579 static void uhci_resume (void *opaque)
581 UHCIState *s = (UHCIState *)opaque;
586 if (s->cmd & UHCI_CMD_EGSM) {
587 s->cmd |= UHCI_CMD_FGR;
588 s->status |= UHCI_STS_RD;
593 static void uhci_attach(USBPort *port1)
595 UHCIState *s = port1->opaque;
596 UHCIPort *port = &s->ports[port1->index];
598 /* set connect status */
599 port->ctrl |= UHCI_PORT_CCS | UHCI_PORT_CSC;
602 if (port->port.dev->speed == USB_SPEED_LOW) {
603 port->ctrl |= UHCI_PORT_LSDA;
605 port->ctrl &= ~UHCI_PORT_LSDA;
611 static void uhci_detach(USBPort *port1)
613 UHCIState *s = port1->opaque;
614 UHCIPort *port = &s->ports[port1->index];
616 uhci_async_cancel_device(s, port1->dev);
618 /* set connect status */
619 if (port->ctrl & UHCI_PORT_CCS) {
620 port->ctrl &= ~UHCI_PORT_CCS;
621 port->ctrl |= UHCI_PORT_CSC;
624 if (port->ctrl & UHCI_PORT_EN) {
625 port->ctrl &= ~UHCI_PORT_EN;
626 port->ctrl |= UHCI_PORT_ENC;
632 static void uhci_child_detach(USBPort *port1, USBDevice *child)
634 UHCIState *s = port1->opaque;
636 uhci_async_cancel_device(s, child);
639 static void uhci_wakeup(USBPort *port1)
641 UHCIState *s = port1->opaque;
642 UHCIPort *port = &s->ports[port1->index];
644 if (port->ctrl & UHCI_PORT_SUSPEND && !(port->ctrl & UHCI_PORT_RD)) {
645 port->ctrl |= UHCI_PORT_RD;
650 static int uhci_broadcast_packet(UHCIState *s, USBPacket *p)
654 DPRINTF("uhci: packet enter. pid %s addr 0x%02x ep %d len %zd\n",
655 pid2str(p->pid), p->devaddr, p->devep, p->iov.size);
656 if (p->pid == USB_TOKEN_OUT || p->pid == USB_TOKEN_SETUP)
660 for (i = 0; i < NB_PORTS && ret == USB_RET_NODEV; i++) {
661 UHCIPort *port = &s->ports[i];
662 USBDevice *dev = port->port.dev;
664 if (dev && dev->attached && (port->ctrl & UHCI_PORT_EN)) {
665 ret = usb_handle_packet(dev, p);
669 DPRINTF("uhci: packet exit. ret %d len %zd\n", ret, p->iov.size);
670 if (p->pid == USB_TOKEN_IN && ret > 0)
676 static void uhci_async_complete(USBPort *port, USBPacket *packet);
677 static void uhci_process_frame(UHCIState *s);
679 /* return -1 if fatal error (frame must be stopped)
681 1 if TD unsuccessful or inactive
683 static int uhci_complete_td(UHCIState *s, UHCI_TD *td, UHCIAsync *async, uint32_t *int_mask)
685 int len = 0, max_len, err, ret;
688 max_len = ((td->token >> 21) + 1) & 0x7ff;
689 pid = td->token & 0xff;
691 ret = async->packet.result;
693 if (td->ctrl & TD_CTRL_IOS)
694 td->ctrl &= ~TD_CTRL_ACTIVE;
699 len = async->packet.result;
700 td->ctrl = (td->ctrl & ~0x7ff) | ((len - 1) & 0x7ff);
702 /* The NAK bit may have been set by a previous frame, so clear it
703 here. The docs are somewhat unclear, but win2k relies on this
705 td->ctrl &= ~(TD_CTRL_ACTIVE | TD_CTRL_NAK);
706 if (td->ctrl & TD_CTRL_IOC)
709 if (pid == USB_TOKEN_IN) {
711 ret = USB_RET_BABBLE;
715 if ((td->ctrl & TD_CTRL_SPD) && len < max_len) {
717 /* short packet: do not update QH */
718 DPRINTF("uhci: short packet. td 0x%x token 0x%x\n", async->td, async->token);
729 td->ctrl |= TD_CTRL_STALL;
730 td->ctrl &= ~TD_CTRL_ACTIVE;
731 s->status |= UHCI_STS_USBERR;
732 if (td->ctrl & TD_CTRL_IOC) {
739 td->ctrl |= TD_CTRL_BABBLE | TD_CTRL_STALL;
740 td->ctrl &= ~TD_CTRL_ACTIVE;
741 s->status |= UHCI_STS_USBERR;
742 if (td->ctrl & TD_CTRL_IOC) {
746 /* frame interrupted */
750 td->ctrl |= TD_CTRL_NAK;
751 if (pid == USB_TOKEN_SETUP)
760 /* Retry the TD if error count is not zero */
762 td->ctrl |= TD_CTRL_TIMEOUT;
763 err = (td->ctrl >> TD_CTRL_ERROR_SHIFT) & 3;
767 td->ctrl &= ~TD_CTRL_ACTIVE;
768 s->status |= UHCI_STS_USBERR;
769 if (td->ctrl & TD_CTRL_IOC)
774 td->ctrl = (td->ctrl & ~(3 << TD_CTRL_ERROR_SHIFT)) |
775 (err << TD_CTRL_ERROR_SHIFT);
779 static int uhci_handle_td(UHCIState *s, uint32_t addr, UHCI_TD *td, uint32_t *int_mask)
782 int len = 0, max_len;
787 if (!(td->ctrl & TD_CTRL_ACTIVE))
790 /* token field is not unique for isochronous requests,
791 * so use the destination buffer
793 if (td->ctrl & TD_CTRL_IOS) {
801 async = uhci_async_find_td(s, addr, token);
803 /* Already submitted */
809 uhci_async_unlink(s, async);
813 /* Allocate new packet */
814 async = uhci_async_alloc(s);
818 /* valid needs to be large enough to handle 10 frame delay
819 * for initial isochronous requests
823 async->token = token;
826 max_len = ((td->token >> 21) + 1) & 0x7ff;
827 pid = td->token & 0xff;
829 usb_packet_setup(&async->packet, pid, (td->token >> 8) & 0x7f,
830 (td->token >> 15) & 0xf);
831 qemu_sglist_add(&async->sgl, td->buffer, max_len);
832 usb_packet_map(&async->packet, &async->sgl);
836 case USB_TOKEN_SETUP:
837 len = uhci_broadcast_packet(s, &async->packet);
843 len = uhci_broadcast_packet(s, &async->packet);
847 /* invalid pid : frame interrupted */
848 uhci_async_free(s, async);
849 s->status |= UHCI_STS_HCPERR;
854 if (len == USB_RET_ASYNC) {
855 uhci_async_link(s, async);
859 async->packet.result = len;
862 len = uhci_complete_td(s, td, async, int_mask);
863 usb_packet_unmap(&async->packet);
864 uhci_async_free(s, async);
868 static void uhci_async_complete(USBPort *port, USBPacket *packet)
870 UHCIAsync *async = container_of(packet, UHCIAsync, packet);
871 UHCIState *s = async->uhci;
873 DPRINTF("uhci: async complete. td 0x%x token 0x%x\n", async->td, async->token);
877 uint32_t link = async->td;
878 uint32_t int_mask = 0, val;
880 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
881 le32_to_cpus(&td.link);
882 le32_to_cpus(&td.ctrl);
883 le32_to_cpus(&td.token);
884 le32_to_cpus(&td.buffer);
886 uhci_async_unlink(s, async);
887 uhci_complete_td(s, &td, async, &int_mask);
888 s->pending_int_mask |= int_mask;
890 /* update the status bits of the TD */
891 val = cpu_to_le32(td.ctrl);
892 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
893 uhci_async_free(s, async);
896 uhci_process_frame(s);
900 static int is_valid(uint32_t link)
902 return (link & 1) == 0;
905 static int is_qh(uint32_t link)
907 return (link & 2) != 0;
910 static int depth_first(uint32_t link)
912 return (link & 4) != 0;
915 /* QH DB used for detecting QH loops */
916 #define UHCI_MAX_QUEUES 128
918 uint32_t addr[UHCI_MAX_QUEUES];
922 static void qhdb_reset(QhDb *db)
927 /* Add QH to DB. Returns 1 if already present or DB is full. */
928 static int qhdb_insert(QhDb *db, uint32_t addr)
931 for (i = 0; i < db->count; i++)
932 if (db->addr[i] == addr)
935 if (db->count >= UHCI_MAX_QUEUES)
938 db->addr[db->count++] = addr;
942 static void uhci_process_frame(UHCIState *s)
944 uint32_t frame_addr, link, old_td_ctrl, val, int_mask;
951 frame_addr = s->fl_base_addr + ((s->frnum & 0x3ff) << 2);
953 DPRINTF("uhci: processing frame %d addr 0x%x\n" , s->frnum, frame_addr);
955 pci_dma_read(&s->dev, frame_addr, &link, 4);
963 for (cnt = FRAME_MAX_LOOPS; is_valid(link) && cnt; cnt--) {
967 if (qhdb_insert(&qhdb, link)) {
969 * We're going in circles. Which is not a bug because
970 * HCD is allowed to do that as part of the BW management.
971 * In our case though it makes no sense to spin here. Sync transations
972 * are already done, and async completion handler will re-process
973 * the frame when something is ready.
975 DPRINTF("uhci: detected loop. qh 0x%x\n", link);
979 pci_dma_read(&s->dev, link & ~0xf, &qh, sizeof(qh));
980 le32_to_cpus(&qh.link);
981 le32_to_cpus(&qh.el_link);
983 DPRINTF("uhci: QH 0x%x load. link 0x%x elink 0x%x\n",
984 link, qh.link, qh.el_link);
986 if (!is_valid(qh.el_link)) {
987 /* QH w/o elements */
991 /* QH with elements */
999 pci_dma_read(&s->dev, link & ~0xf, &td, sizeof(td));
1000 le32_to_cpus(&td.link);
1001 le32_to_cpus(&td.ctrl);
1002 le32_to_cpus(&td.token);
1003 le32_to_cpus(&td.buffer);
1005 DPRINTF("uhci: TD 0x%x load. link 0x%x ctrl 0x%x token 0x%x qh 0x%x\n",
1006 link, td.link, td.ctrl, td.token, curr_qh);
1008 old_td_ctrl = td.ctrl;
1009 ret = uhci_handle_td(s, link, &td, &int_mask);
1010 if (old_td_ctrl != td.ctrl) {
1011 /* update the status bits of the TD */
1012 val = cpu_to_le32(td.ctrl);
1013 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
1017 /* interrupted frame */
1021 if (ret == 2 || ret == 1) {
1022 DPRINTF("uhci: TD 0x%x %s. link 0x%x ctrl 0x%x token 0x%x qh 0x%x\n",
1023 link, ret == 2 ? "pend" : "skip",
1024 td.link, td.ctrl, td.token, curr_qh);
1026 link = curr_qh ? qh.link : td.link;
1032 DPRINTF("uhci: TD 0x%x done. link 0x%x ctrl 0x%x token 0x%x qh 0x%x\n",
1033 link, td.link, td.ctrl, td.token, curr_qh);
1038 /* update QH element link */
1040 val = cpu_to_le32(qh.el_link);
1041 pci_dma_write(&s->dev, (curr_qh & ~0xf) + 4, &val, sizeof(val));
1043 if (!depth_first(link)) {
1044 /* done with this QH */
1046 DPRINTF("uhci: QH 0x%x done. link 0x%x elink 0x%x\n",
1047 curr_qh, qh.link, qh.el_link);
1054 /* go to the next entry */
1057 s->pending_int_mask |= int_mask;
1060 static void uhci_frame_timer(void *opaque)
1062 UHCIState *s = opaque;
1064 /* prepare the timer for the next frame */
1065 s->expire_time += (get_ticks_per_sec() / FRAME_TIMER_FREQ);
1067 if (!(s->cmd & UHCI_CMD_RS)) {
1069 qemu_del_timer(s->frame_timer);
1070 /* set hchalted bit in status - UHCI11D 2.1.2 */
1071 s->status |= UHCI_STS_HCHALTED;
1073 DPRINTF("uhci: halted\n");
1077 /* Complete the previous frame */
1078 if (s->pending_int_mask) {
1079 s->status2 |= s->pending_int_mask;
1080 s->status |= UHCI_STS_USBINT;
1083 s->pending_int_mask = 0;
1085 /* Start new frame */
1086 s->frnum = (s->frnum + 1) & 0x7ff;
1088 DPRINTF("uhci: new frame #%u\n" , s->frnum);
1090 uhci_async_validate_begin(s);
1092 uhci_process_frame(s);
1094 uhci_async_validate_end(s);
1096 qemu_mod_timer(s->frame_timer, s->expire_time);
1099 static const MemoryRegionPortio uhci_portio[] = {
1100 { 0, 32, 2, .write = uhci_ioport_writew, },
1101 { 0, 32, 2, .read = uhci_ioport_readw, },
1102 { 0, 32, 4, .write = uhci_ioport_writel, },
1103 { 0, 32, 4, .read = uhci_ioport_readl, },
1104 { 0, 32, 1, .write = uhci_ioport_writeb, },
1105 { 0, 32, 1, .read = uhci_ioport_readb, },
1106 PORTIO_END_OF_LIST()
1109 static const MemoryRegionOps uhci_ioport_ops = {
1110 .old_portio = uhci_portio,
1113 static USBPortOps uhci_port_ops = {
1114 .attach = uhci_attach,
1115 .detach = uhci_detach,
1116 .child_detach = uhci_child_detach,
1117 .wakeup = uhci_wakeup,
1118 .complete = uhci_async_complete,
1121 static USBBusOps uhci_bus_ops = {
1124 static int usb_uhci_common_initfn(PCIDevice *dev)
1126 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1127 uint8_t *pci_conf = s->dev.config;
1130 pci_conf[PCI_CLASS_PROG] = 0x00;
1131 /* TODO: reset value should be 0. */
1132 pci_conf[PCI_INTERRUPT_PIN] = 4; /* interrupt pin D */
1133 pci_conf[USB_SBRN] = USB_RELEASE_1; // release number
1136 USBPort *ports[NB_PORTS];
1137 for(i = 0; i < NB_PORTS; i++) {
1138 ports[i] = &s->ports[i].port;
1140 if (usb_register_companion(s->masterbus, ports, NB_PORTS,
1141 s->firstport, s, &uhci_port_ops,
1142 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL) != 0) {
1146 usb_bus_new(&s->bus, &uhci_bus_ops, &s->dev.qdev);
1147 for (i = 0; i < NB_PORTS; i++) {
1148 usb_register_port(&s->bus, &s->ports[i].port, s, i, &uhci_port_ops,
1149 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
1152 s->frame_timer = qemu_new_timer_ns(vm_clock, uhci_frame_timer, s);
1153 s->num_ports_vmstate = NB_PORTS;
1154 QTAILQ_INIT(&s->async_pending);
1156 qemu_register_reset(uhci_reset, s);
1158 memory_region_init_io(&s->io_bar, &uhci_ioport_ops, s, "uhci", 0x20);
1159 /* Use region 4 for consistency with real hardware. BSD guests seem
1161 pci_register_bar(&s->dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &s->io_bar);
1166 static int usb_uhci_vt82c686b_initfn(PCIDevice *dev)
1168 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1169 uint8_t *pci_conf = s->dev.config;
1171 /* USB misc control 1/2 */
1172 pci_set_long(pci_conf + 0x40,0x00001000);
1174 pci_set_long(pci_conf + 0x80,0x00020001);
1175 /* USB legacy support */
1176 pci_set_long(pci_conf + 0xc0,0x00002000);
1178 return usb_uhci_common_initfn(dev);
1181 static int usb_uhci_exit(PCIDevice *dev)
1183 UHCIState *s = DO_UPCAST(UHCIState, dev, dev);
1185 memory_region_destroy(&s->io_bar);
1189 static Property uhci_properties[] = {
1190 DEFINE_PROP_STRING("masterbus", UHCIState, masterbus),
1191 DEFINE_PROP_UINT32("firstport", UHCIState, firstport, 0),
1192 DEFINE_PROP_END_OF_LIST(),
1195 static void piix3_uhci_class_init(ObjectClass *klass, void *data)
1197 DeviceClass *dc = DEVICE_CLASS(klass);
1198 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1200 k->init = usb_uhci_common_initfn;
1201 k->exit = usb_uhci_exit;
1202 k->vendor_id = PCI_VENDOR_ID_INTEL;
1203 k->device_id = PCI_DEVICE_ID_INTEL_82371SB_2;
1205 k->class_id = PCI_CLASS_SERIAL_USB;
1206 dc->vmsd = &vmstate_uhci;
1207 dc->props = uhci_properties;
1210 static TypeInfo piix3_uhci_info = {
1211 .name = "piix3-usb-uhci",
1212 .parent = TYPE_PCI_DEVICE,
1213 .instance_size = sizeof(UHCIState),
1214 .class_init = piix3_uhci_class_init,
1217 static void piix4_uhci_class_init(ObjectClass *klass, void *data)
1219 DeviceClass *dc = DEVICE_CLASS(klass);
1220 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1222 k->init = usb_uhci_common_initfn;
1223 k->exit = usb_uhci_exit;
1224 k->vendor_id = PCI_VENDOR_ID_INTEL;
1225 k->device_id = PCI_DEVICE_ID_INTEL_82371AB_2;
1227 k->class_id = PCI_CLASS_SERIAL_USB;
1228 dc->vmsd = &vmstate_uhci;
1229 dc->props = uhci_properties;
1232 static TypeInfo piix4_uhci_info = {
1233 .name = "piix4-usb-uhci",
1234 .parent = TYPE_PCI_DEVICE,
1235 .instance_size = sizeof(UHCIState),
1236 .class_init = piix4_uhci_class_init,
1239 static void vt82c686b_uhci_class_init(ObjectClass *klass, void *data)
1241 DeviceClass *dc = DEVICE_CLASS(klass);
1242 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1244 k->init = usb_uhci_vt82c686b_initfn;
1245 k->exit = usb_uhci_exit;
1246 k->vendor_id = PCI_VENDOR_ID_VIA;
1247 k->device_id = PCI_DEVICE_ID_VIA_UHCI;
1249 k->class_id = PCI_CLASS_SERIAL_USB;
1250 dc->vmsd = &vmstate_uhci;
1251 dc->props = uhci_properties;
1254 static TypeInfo vt82c686b_uhci_info = {
1255 .name = "vt82c686b-usb-uhci",
1256 .parent = TYPE_PCI_DEVICE,
1257 .instance_size = sizeof(UHCIState),
1258 .class_init = vt82c686b_uhci_class_init,
1261 static void ich9_uhci1_class_init(ObjectClass *klass, void *data)
1263 DeviceClass *dc = DEVICE_CLASS(klass);
1264 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1266 k->init = usb_uhci_common_initfn;
1267 k->vendor_id = PCI_VENDOR_ID_INTEL;
1268 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI1;
1270 k->class_id = PCI_CLASS_SERIAL_USB;
1271 dc->vmsd = &vmstate_uhci;
1272 dc->props = uhci_properties;
1275 static TypeInfo ich9_uhci1_info = {
1276 .name = "ich9-usb-uhci1",
1277 .parent = TYPE_PCI_DEVICE,
1278 .instance_size = sizeof(UHCIState),
1279 .class_init = ich9_uhci1_class_init,
1282 static void ich9_uhci2_class_init(ObjectClass *klass, void *data)
1284 DeviceClass *dc = DEVICE_CLASS(klass);
1285 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1287 k->init = usb_uhci_common_initfn;
1288 k->vendor_id = PCI_VENDOR_ID_INTEL;
1289 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI2;
1291 k->class_id = PCI_CLASS_SERIAL_USB;
1292 dc->vmsd = &vmstate_uhci;
1293 dc->props = uhci_properties;
1296 static TypeInfo ich9_uhci2_info = {
1297 .name = "ich9-usb-uhci2",
1298 .parent = TYPE_PCI_DEVICE,
1299 .instance_size = sizeof(UHCIState),
1300 .class_init = ich9_uhci2_class_init,
1303 static void ich9_uhci3_class_init(ObjectClass *klass, void *data)
1305 DeviceClass *dc = DEVICE_CLASS(klass);
1306 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1308 k->init = usb_uhci_common_initfn;
1309 k->vendor_id = PCI_VENDOR_ID_INTEL;
1310 k->device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI3;
1312 k->class_id = PCI_CLASS_SERIAL_USB;
1313 dc->vmsd = &vmstate_uhci;
1314 dc->props = uhci_properties;
1317 static TypeInfo ich9_uhci3_info = {
1318 .name = "ich9-usb-uhci3",
1319 .parent = TYPE_PCI_DEVICE,
1320 .instance_size = sizeof(UHCIState),
1321 .class_init = ich9_uhci3_class_init,
1324 static void uhci_register(void)
1326 type_register_static(&piix3_uhci_info);
1327 type_register_static(&piix4_uhci_info);
1328 type_register_static(&vt82c686b_uhci_info);
1329 type_register_static(&ich9_uhci1_info);
1330 type_register_static(&ich9_uhci2_info);
1331 type_register_static(&ich9_uhci3_info);
1333 device_init(uhci_register);
1335 void usb_uhci_piix3_init(PCIBus *bus, int devfn)
1337 pci_create_simple(bus, devfn, "piix3-usb-uhci");
1340 void usb_uhci_piix4_init(PCIBus *bus, int devfn)
1342 pci_create_simple(bus, devfn, "piix4-usb-uhci");
1345 void usb_uhci_vt82c686b_init(PCIBus *bus, int devfn)
1347 pci_create_simple(bus, devfn, "vt82c686b-usb-uhci");