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
30 #include "hw/pci/pci.h"
31 #include "qemu/timer.h"
33 #include "sysemu/dma.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 256
78 /* Must be large enough to handle 10 frame delay for initial isoc requests */
81 #define MAX_FRAMES_PER_TICK (QH_VALID / 2)
86 TD_RESULT_STOP_FRAME
= 10,
89 TD_RESULT_ASYNC_START
,
93 typedef struct UHCIState UHCIState
;
94 typedef struct UHCIAsync UHCIAsync
;
95 typedef struct UHCIQueue UHCIQueue
;
96 typedef struct UHCIInfo UHCIInfo
;
97 typedef struct UHCIPCIDeviceClass UHCIPCIDeviceClass
;
105 int (*initfn
)(PCIDevice
*dev
);
109 struct UHCIPCIDeviceClass
{
110 PCIDeviceClass parent_class
;
115 * Pending async transaction.
116 * 'packet' must be the first field because completion
117 * handler does "(UHCIAsync *) pkt" cast.
124 QTAILQ_ENTRY(UHCIAsync
) next
;
134 QTAILQ_ENTRY(UHCIQueue
) next
;
135 QTAILQ_HEAD(asyncs_head
, UHCIAsync
) asyncs
;
139 typedef struct UHCIPort
{
147 USBBus bus
; /* Note unused when we're a companion controller */
148 uint16_t cmd
; /* cmd register */
150 uint16_t intr
; /* interrupt enable register */
151 uint16_t frnum
; /* frame number */
152 uint32_t fl_base_addr
; /* frame list base address */
154 uint8_t status2
; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
156 QEMUTimer
*frame_timer
;
158 uint32_t frame_bytes
;
159 uint32_t frame_bandwidth
;
160 bool completions_only
;
161 UHCIPort ports
[NB_PORTS
];
163 /* Interrupts that should be raised at the end of the current frame. */
164 uint32_t pending_int_mask
;
168 QTAILQ_HEAD(, UHCIQueue
) queues
;
169 uint8_t num_ports_vmstate
;
177 typedef struct UHCI_TD
{
179 uint32_t ctrl
; /* see TD_CTRL_xxx */
184 typedef struct UHCI_QH
{
189 static void uhci_async_cancel(UHCIAsync
*async
);
190 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
);
192 static inline int32_t uhci_queue_token(UHCI_TD
*td
)
194 if ((td
->token
& (0xf << 15)) == 0) {
195 /* ctrl ep, cover ep and dev, not pid! */
196 return td
->token
& 0x7ff00;
198 /* covers ep, dev, pid -> identifies the endpoint */
199 return td
->token
& 0x7ffff;
203 static UHCIQueue
*uhci_queue_new(UHCIState
*s
, uint32_t qh_addr
, UHCI_TD
*td
,
208 queue
= g_new0(UHCIQueue
, 1);
210 queue
->qh_addr
= qh_addr
;
211 queue
->token
= uhci_queue_token(td
);
213 QTAILQ_INIT(&queue
->asyncs
);
214 QTAILQ_INSERT_HEAD(&s
->queues
, queue
, next
);
215 queue
->valid
= QH_VALID
;
216 trace_usb_uhci_queue_add(queue
->token
);
220 static void uhci_queue_free(UHCIQueue
*queue
, const char *reason
)
222 UHCIState
*s
= queue
->uhci
;
225 while (!QTAILQ_EMPTY(&queue
->asyncs
)) {
226 async
= QTAILQ_FIRST(&queue
->asyncs
);
227 uhci_async_cancel(async
);
229 usb_device_ep_stopped(queue
->ep
->dev
, queue
->ep
);
231 trace_usb_uhci_queue_del(queue
->token
, reason
);
232 QTAILQ_REMOVE(&s
->queues
, queue
, next
);
236 static UHCIQueue
*uhci_queue_find(UHCIState
*s
, UHCI_TD
*td
)
238 uint32_t token
= uhci_queue_token(td
);
241 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
242 if (queue
->token
== token
) {
249 static bool uhci_queue_verify(UHCIQueue
*queue
, uint32_t qh_addr
, UHCI_TD
*td
,
250 uint32_t td_addr
, bool queuing
)
252 UHCIAsync
*first
= QTAILQ_FIRST(&queue
->asyncs
);
254 return queue
->qh_addr
== qh_addr
&&
255 queue
->token
== uhci_queue_token(td
) &&
256 (queuing
|| !(td
->ctrl
& TD_CTRL_ACTIVE
) || first
== NULL
||
257 first
->td_addr
== td_addr
);
260 static UHCIAsync
*uhci_async_alloc(UHCIQueue
*queue
, uint32_t td_addr
)
262 UHCIAsync
*async
= g_new0(UHCIAsync
, 1);
264 async
->queue
= queue
;
265 async
->td_addr
= td_addr
;
266 usb_packet_init(&async
->packet
);
267 pci_dma_sglist_init(&async
->sgl
, &queue
->uhci
->dev
, 1);
268 trace_usb_uhci_packet_add(async
->queue
->token
, async
->td_addr
);
273 static void uhci_async_free(UHCIAsync
*async
)
275 trace_usb_uhci_packet_del(async
->queue
->token
, async
->td_addr
);
276 usb_packet_cleanup(&async
->packet
);
277 qemu_sglist_destroy(&async
->sgl
);
281 static void uhci_async_link(UHCIAsync
*async
)
283 UHCIQueue
*queue
= async
->queue
;
284 QTAILQ_INSERT_TAIL(&queue
->asyncs
, async
, next
);
285 trace_usb_uhci_packet_link_async(async
->queue
->token
, async
->td_addr
);
288 static void uhci_async_unlink(UHCIAsync
*async
)
290 UHCIQueue
*queue
= async
->queue
;
291 QTAILQ_REMOVE(&queue
->asyncs
, async
, next
);
292 trace_usb_uhci_packet_unlink_async(async
->queue
->token
, async
->td_addr
);
295 static void uhci_async_cancel(UHCIAsync
*async
)
297 uhci_async_unlink(async
);
298 trace_usb_uhci_packet_cancel(async
->queue
->token
, async
->td_addr
,
301 usb_cancel_packet(&async
->packet
);
302 usb_packet_unmap(&async
->packet
, &async
->sgl
);
303 uhci_async_free(async
);
307 * Mark all outstanding async packets as invalid.
308 * This is used for canceling them when TDs are removed by the HCD.
310 static void uhci_async_validate_begin(UHCIState
*s
)
314 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
320 * Cancel async packets that are no longer valid
322 static void uhci_async_validate_end(UHCIState
*s
)
324 UHCIQueue
*queue
, *n
;
326 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
328 uhci_queue_free(queue
, "validate-end");
333 static void uhci_async_cancel_device(UHCIState
*s
, USBDevice
*dev
)
335 UHCIQueue
*queue
, *n
;
337 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
338 if (queue
->ep
->dev
== dev
) {
339 uhci_queue_free(queue
, "cancel-device");
344 static void uhci_async_cancel_all(UHCIState
*s
)
346 UHCIQueue
*queue
, *nq
;
348 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, nq
) {
349 uhci_queue_free(queue
, "cancel-all");
353 static UHCIAsync
*uhci_async_find_td(UHCIState
*s
, uint32_t td_addr
)
358 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
359 QTAILQ_FOREACH(async
, &queue
->asyncs
, next
) {
360 if (async
->td_addr
== td_addr
) {
368 static void uhci_update_irq(UHCIState
*s
)
371 if (((s
->status2
& 1) && (s
->intr
& (1 << 2))) ||
372 ((s
->status2
& 2) && (s
->intr
& (1 << 3))) ||
373 ((s
->status
& UHCI_STS_USBERR
) && (s
->intr
& (1 << 0))) ||
374 ((s
->status
& UHCI_STS_RD
) && (s
->intr
& (1 << 1))) ||
375 (s
->status
& UHCI_STS_HSERR
) ||
376 (s
->status
& UHCI_STS_HCPERR
)) {
381 qemu_set_irq(s
->dev
.irq
[s
->irq_pin
], level
);
384 static void uhci_reset(void *opaque
)
386 UHCIState
*s
= opaque
;
391 trace_usb_uhci_reset();
393 pci_conf
= s
->dev
.config
;
395 pci_conf
[0x6a] = 0x01; /* usb clock */
396 pci_conf
[0x6b] = 0x00;
404 for(i
= 0; i
< NB_PORTS
; i
++) {
407 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
408 usb_port_reset(&port
->port
);
412 uhci_async_cancel_all(s
);
413 qemu_bh_cancel(s
->bh
);
417 static const VMStateDescription vmstate_uhci_port
= {
420 .minimum_version_id
= 1,
421 .minimum_version_id_old
= 1,
422 .fields
= (VMStateField
[]) {
423 VMSTATE_UINT16(ctrl
, UHCIPort
),
424 VMSTATE_END_OF_LIST()
428 static int uhci_post_load(void *opaque
, int version_id
)
430 UHCIState
*s
= opaque
;
432 if (version_id
< 2) {
433 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
434 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
439 static const VMStateDescription vmstate_uhci
= {
442 .minimum_version_id
= 1,
443 .minimum_version_id_old
= 1,
444 .post_load
= uhci_post_load
,
445 .fields
= (VMStateField
[]) {
446 VMSTATE_PCI_DEVICE(dev
, UHCIState
),
447 VMSTATE_UINT8_EQUAL(num_ports_vmstate
, UHCIState
),
448 VMSTATE_STRUCT_ARRAY(ports
, UHCIState
, NB_PORTS
, 1,
449 vmstate_uhci_port
, UHCIPort
),
450 VMSTATE_UINT16(cmd
, UHCIState
),
451 VMSTATE_UINT16(status
, UHCIState
),
452 VMSTATE_UINT16(intr
, UHCIState
),
453 VMSTATE_UINT16(frnum
, UHCIState
),
454 VMSTATE_UINT32(fl_base_addr
, UHCIState
),
455 VMSTATE_UINT8(sof_timing
, UHCIState
),
456 VMSTATE_UINT8(status2
, UHCIState
),
457 VMSTATE_TIMER(frame_timer
, UHCIState
),
458 VMSTATE_INT64_V(expire_time
, UHCIState
, 2),
459 VMSTATE_UINT32_V(pending_int_mask
, UHCIState
, 3),
460 VMSTATE_END_OF_LIST()
464 static void uhci_port_write(void *opaque
, hwaddr addr
,
465 uint64_t val
, unsigned size
)
467 UHCIState
*s
= opaque
;
469 trace_usb_uhci_mmio_writew(addr
, val
);
473 if ((val
& UHCI_CMD_RS
) && !(s
->cmd
& UHCI_CMD_RS
)) {
474 /* start frame processing */
475 trace_usb_uhci_schedule_start();
476 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
477 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
478 qemu_mod_timer(s
->frame_timer
, s
->expire_time
);
479 s
->status
&= ~UHCI_STS_HCHALTED
;
480 } else if (!(val
& UHCI_CMD_RS
)) {
481 s
->status
|= UHCI_STS_HCHALTED
;
483 if (val
& UHCI_CMD_GRESET
) {
487 /* send reset on the USB bus */
488 for(i
= 0; i
< NB_PORTS
; i
++) {
490 usb_device_reset(port
->port
.dev
);
495 if (val
& UHCI_CMD_HCRESET
) {
503 /* XXX: the chip spec is not coherent, so we add a hidden
504 register to distinguish between IOC and SPD */
505 if (val
& UHCI_STS_USBINT
)
514 if (s
->status
& UHCI_STS_HCHALTED
)
515 s
->frnum
= val
& 0x7ff;
518 s
->fl_base_addr
&= 0xffff0000;
519 s
->fl_base_addr
|= val
& ~0xfff;
522 s
->fl_base_addr
&= 0x0000ffff;
523 s
->fl_base_addr
|= (val
<< 16);
526 s
->sof_timing
= val
& 0xff;
538 dev
= port
->port
.dev
;
539 if (dev
&& dev
->attached
) {
541 if ( (val
& UHCI_PORT_RESET
) &&
542 !(port
->ctrl
& UHCI_PORT_RESET
) ) {
543 usb_device_reset(dev
);
546 port
->ctrl
&= UHCI_PORT_READ_ONLY
;
547 /* enabled may only be set if a device is connected */
548 if (!(port
->ctrl
& UHCI_PORT_CCS
)) {
549 val
&= ~UHCI_PORT_EN
;
551 port
->ctrl
|= (val
& ~UHCI_PORT_READ_ONLY
);
552 /* some bits are reset when a '1' is written to them */
553 port
->ctrl
&= ~(val
& UHCI_PORT_WRITE_CLEAR
);
559 static uint64_t uhci_port_read(void *opaque
, hwaddr addr
, unsigned size
)
561 UHCIState
*s
= opaque
;
578 val
= s
->fl_base_addr
& 0xffff;
581 val
= (s
->fl_base_addr
>> 16) & 0xffff;
599 val
= 0xff7f; /* disabled port */
603 trace_usb_uhci_mmio_readw(addr
, val
);
608 /* signal resume if controller suspended */
609 static void uhci_resume (void *opaque
)
611 UHCIState
*s
= (UHCIState
*)opaque
;
616 if (s
->cmd
& UHCI_CMD_EGSM
) {
617 s
->cmd
|= UHCI_CMD_FGR
;
618 s
->status
|= UHCI_STS_RD
;
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
;
632 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
633 port
->ctrl
|= UHCI_PORT_LSDA
;
635 port
->ctrl
&= ~UHCI_PORT_LSDA
;
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
;
654 if (port
->ctrl
& UHCI_PORT_EN
) {
655 port
->ctrl
&= ~UHCI_PORT_EN
;
656 port
->ctrl
|= UHCI_PORT_ENC
;
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
;
680 static USBDevice
*uhci_find_device(UHCIState
*s
, uint8_t addr
)
685 for (i
= 0; i
< NB_PORTS
; i
++) {
686 UHCIPort
*port
= &s
->ports
[i
];
687 if (!(port
->ctrl
& UHCI_PORT_EN
)) {
690 dev
= usb_find_device(&port
->port
, addr
);
698 static void uhci_read_td(UHCIState
*s
, UHCI_TD
*td
, uint32_t link
)
700 pci_dma_read(&s
->dev
, link
& ~0xf, td
, sizeof(*td
));
701 le32_to_cpus(&td
->link
);
702 le32_to_cpus(&td
->ctrl
);
703 le32_to_cpus(&td
->token
);
704 le32_to_cpus(&td
->buffer
);
707 static int uhci_handle_td_error(UHCIState
*s
, UHCI_TD
*td
, uint32_t td_addr
,
708 int status
, uint32_t *int_mask
)
710 uint32_t queue_token
= uhci_queue_token(td
);
715 td
->ctrl
|= TD_CTRL_NAK
;
716 return TD_RESULT_NEXT_QH
;
719 td
->ctrl
|= TD_CTRL_STALL
;
720 trace_usb_uhci_packet_complete_stall(queue_token
, td_addr
);
721 ret
= TD_RESULT_NEXT_QH
;
725 td
->ctrl
|= TD_CTRL_BABBLE
| TD_CTRL_STALL
;
726 /* frame interrupted */
727 trace_usb_uhci_packet_complete_babble(queue_token
, td_addr
);
728 ret
= TD_RESULT_STOP_FRAME
;
731 case USB_RET_IOERROR
:
734 td
->ctrl
|= TD_CTRL_TIMEOUT
;
735 td
->ctrl
&= ~(3 << TD_CTRL_ERROR_SHIFT
);
736 trace_usb_uhci_packet_complete_error(queue_token
, td_addr
);
737 ret
= TD_RESULT_NEXT_QH
;
741 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
742 s
->status
|= UHCI_STS_USBERR
;
743 if (td
->ctrl
& TD_CTRL_IOC
) {
750 static int uhci_complete_td(UHCIState
*s
, UHCI_TD
*td
, UHCIAsync
*async
, uint32_t *int_mask
)
752 int len
= 0, max_len
;
755 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
756 pid
= td
->token
& 0xff;
758 if (td
->ctrl
& TD_CTRL_IOS
)
759 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
761 if (async
->packet
.status
!= USB_RET_SUCCESS
) {
762 return uhci_handle_td_error(s
, td
, async
->td_addr
,
763 async
->packet
.status
, int_mask
);
766 len
= async
->packet
.actual_length
;
767 td
->ctrl
= (td
->ctrl
& ~0x7ff) | ((len
- 1) & 0x7ff);
769 /* The NAK bit may have been set by a previous frame, so clear it
770 here. The docs are somewhat unclear, but win2k relies on this
772 td
->ctrl
&= ~(TD_CTRL_ACTIVE
| TD_CTRL_NAK
);
773 if (td
->ctrl
& TD_CTRL_IOC
)
776 if (pid
== USB_TOKEN_IN
) {
777 if ((td
->ctrl
& TD_CTRL_SPD
) && len
< max_len
) {
779 /* short packet: do not update QH */
780 trace_usb_uhci_packet_complete_shortxfer(async
->queue
->token
,
782 return TD_RESULT_NEXT_QH
;
787 trace_usb_uhci_packet_complete_success(async
->queue
->token
,
789 return TD_RESULT_COMPLETE
;
792 static int uhci_handle_td(UHCIState
*s
, UHCIQueue
*q
, uint32_t qh_addr
,
793 UHCI_TD
*td
, uint32_t td_addr
, uint32_t *int_mask
)
797 bool queuing
= (q
!= NULL
);
798 uint8_t pid
= td
->token
& 0xff;
799 UHCIAsync
*async
= uhci_async_find_td(s
, td_addr
);
802 if (uhci_queue_verify(async
->queue
, qh_addr
, td
, td_addr
, queuing
)) {
803 assert(q
== NULL
|| q
== async
->queue
);
806 uhci_queue_free(async
->queue
, "guest re-used pending td");
812 q
= uhci_queue_find(s
, td
);
813 if (q
&& !uhci_queue_verify(q
, qh_addr
, td
, td_addr
, queuing
)) {
814 uhci_queue_free(q
, "guest re-used qh");
824 if (!(td
->ctrl
& TD_CTRL_ACTIVE
)) {
826 /* Guest marked a pending td non-active, cancel the queue */
827 uhci_queue_free(async
->queue
, "pending td non-active");
830 * ehci11d spec page 22: "Even if the Active bit in the TD is already
831 * cleared when the TD is fetched ... an IOC interrupt is generated"
833 if (td
->ctrl
& TD_CTRL_IOC
) {
836 return TD_RESULT_NEXT_QH
;
841 /* we are busy filling the queue, we are not prepared
842 to consume completed packages then, just leave them
844 return TD_RESULT_ASYNC_CONT
;
848 UHCIAsync
*last
= QTAILQ_LAST(&async
->queue
->asyncs
, asyncs_head
);
850 * While we are waiting for the current td to complete, the guest
851 * may have added more tds to the queue. Note we re-read the td
852 * rather then caching it, as we want to see guest made changes!
854 uhci_read_td(s
, &last_td
, last
->td_addr
);
855 uhci_queue_fill(async
->queue
, &last_td
);
857 return TD_RESULT_ASYNC_CONT
;
859 uhci_async_unlink(async
);
863 if (s
->completions_only
) {
864 return TD_RESULT_ASYNC_CONT
;
867 /* Allocate new packet */
869 USBDevice
*dev
= uhci_find_device(s
, (td
->token
>> 8) & 0x7f);
870 USBEndpoint
*ep
= usb_ep_get(dev
, pid
, (td
->token
>> 15) & 0xf);
873 return uhci_handle_td_error(s
, td
, td_addr
, USB_RET_NODEV
,
876 q
= uhci_queue_new(s
, qh_addr
, td
, ep
);
878 async
= uhci_async_alloc(q
, td_addr
);
880 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
881 spd
= (pid
== USB_TOKEN_IN
&& (td
->ctrl
& TD_CTRL_SPD
) != 0);
882 usb_packet_setup(&async
->packet
, pid
, q
->ep
, 0, td_addr
, spd
,
883 (td
->ctrl
& TD_CTRL_IOC
) != 0);
884 qemu_sglist_add(&async
->sgl
, td
->buffer
, max_len
);
885 usb_packet_map(&async
->packet
, &async
->sgl
);
889 case USB_TOKEN_SETUP
:
890 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
891 if (async
->packet
.status
== USB_RET_SUCCESS
) {
892 async
->packet
.actual_length
= max_len
;
897 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
901 /* invalid pid : frame interrupted */
902 usb_packet_unmap(&async
->packet
, &async
->sgl
);
903 uhci_async_free(async
);
904 s
->status
|= UHCI_STS_HCPERR
;
906 return TD_RESULT_STOP_FRAME
;
909 if (async
->packet
.status
== USB_RET_ASYNC
) {
910 uhci_async_link(async
);
912 uhci_queue_fill(q
, td
);
914 return TD_RESULT_ASYNC_START
;
918 ret
= uhci_complete_td(s
, td
, async
, int_mask
);
919 usb_packet_unmap(&async
->packet
, &async
->sgl
);
920 uhci_async_free(async
);
924 static void uhci_async_complete(USBPort
*port
, USBPacket
*packet
)
926 UHCIAsync
*async
= container_of(packet
, UHCIAsync
, packet
);
927 UHCIState
*s
= async
->queue
->uhci
;
929 if (packet
->status
== USB_RET_REMOVE_FROM_QUEUE
) {
930 uhci_async_cancel(async
);
935 /* Force processing of this packet *now*, needed for migration */
936 s
->completions_only
= true;
937 qemu_bh_schedule(s
->bh
);
940 static int is_valid(uint32_t link
)
942 return (link
& 1) == 0;
945 static int is_qh(uint32_t link
)
947 return (link
& 2) != 0;
950 static int depth_first(uint32_t link
)
952 return (link
& 4) != 0;
955 /* QH DB used for detecting QH loops */
956 #define UHCI_MAX_QUEUES 128
958 uint32_t addr
[UHCI_MAX_QUEUES
];
962 static void qhdb_reset(QhDb
*db
)
967 /* Add QH to DB. Returns 1 if already present or DB is full. */
968 static int qhdb_insert(QhDb
*db
, uint32_t addr
)
971 for (i
= 0; i
< db
->count
; i
++)
972 if (db
->addr
[i
] == addr
)
975 if (db
->count
>= UHCI_MAX_QUEUES
)
978 db
->addr
[db
->count
++] = addr
;
982 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
)
984 uint32_t int_mask
= 0;
985 uint32_t plink
= td
->link
;
989 while (is_valid(plink
)) {
990 uhci_read_td(q
->uhci
, &ptd
, plink
);
991 if (!(ptd
.ctrl
& TD_CTRL_ACTIVE
)) {
994 if (uhci_queue_token(&ptd
) != q
->token
) {
997 trace_usb_uhci_td_queue(plink
& ~0xf, ptd
.ctrl
, ptd
.token
);
998 ret
= uhci_handle_td(q
->uhci
, q
, q
->qh_addr
, &ptd
, plink
, &int_mask
);
999 if (ret
== TD_RESULT_ASYNC_CONT
) {
1002 assert(ret
== TD_RESULT_ASYNC_START
);
1003 assert(int_mask
== 0);
1006 usb_device_flush_ep_queue(q
->ep
->dev
, q
->ep
);
1009 static void uhci_process_frame(UHCIState
*s
)
1011 uint32_t frame_addr
, link
, old_td_ctrl
, val
, int_mask
;
1012 uint32_t curr_qh
, td_count
= 0;
1018 frame_addr
= s
->fl_base_addr
+ ((s
->frnum
& 0x3ff) << 2);
1020 pci_dma_read(&s
->dev
, frame_addr
, &link
, 4);
1021 le32_to_cpus(&link
);
1028 for (cnt
= FRAME_MAX_LOOPS
; is_valid(link
) && cnt
; cnt
--) {
1029 if (!s
->completions_only
&& s
->frame_bytes
>= s
->frame_bandwidth
) {
1030 /* We've reached the usb 1.1 bandwidth, which is
1031 1280 bytes/frame, stop processing */
1032 trace_usb_uhci_frame_stop_bandwidth();
1037 trace_usb_uhci_qh_load(link
& ~0xf);
1039 if (qhdb_insert(&qhdb
, link
)) {
1041 * We're going in circles. Which is not a bug because
1042 * HCD is allowed to do that as part of the BW management.
1044 * Stop processing here if no transaction has been done
1045 * since we've been here last time.
1047 if (td_count
== 0) {
1048 trace_usb_uhci_frame_loop_stop_idle();
1051 trace_usb_uhci_frame_loop_continue();
1054 qhdb_insert(&qhdb
, link
);
1058 pci_dma_read(&s
->dev
, link
& ~0xf, &qh
, sizeof(qh
));
1059 le32_to_cpus(&qh
.link
);
1060 le32_to_cpus(&qh
.el_link
);
1062 if (!is_valid(qh
.el_link
)) {
1063 /* QH w/o elements */
1067 /* QH with elements */
1075 uhci_read_td(s
, &td
, link
);
1076 trace_usb_uhci_td_load(curr_qh
& ~0xf, link
& ~0xf, td
.ctrl
, td
.token
);
1078 old_td_ctrl
= td
.ctrl
;
1079 ret
= uhci_handle_td(s
, NULL
, curr_qh
, &td
, link
, &int_mask
);
1080 if (old_td_ctrl
!= td
.ctrl
) {
1081 /* update the status bits of the TD */
1082 val
= cpu_to_le32(td
.ctrl
);
1083 pci_dma_write(&s
->dev
, (link
& ~0xf) + 4, &val
, sizeof(val
));
1087 case TD_RESULT_STOP_FRAME
: /* interrupted frame */
1090 case TD_RESULT_NEXT_QH
:
1091 case TD_RESULT_ASYNC_CONT
:
1092 trace_usb_uhci_td_nextqh(curr_qh
& ~0xf, link
& ~0xf);
1093 link
= curr_qh
? qh
.link
: td
.link
;
1096 case TD_RESULT_ASYNC_START
:
1097 trace_usb_uhci_td_async(curr_qh
& ~0xf, link
& ~0xf);
1098 link
= curr_qh
? qh
.link
: td
.link
;
1101 case TD_RESULT_COMPLETE
:
1102 trace_usb_uhci_td_complete(curr_qh
& ~0xf, link
& ~0xf);
1105 s
->frame_bytes
+= (td
.ctrl
& 0x7ff) + 1;
1108 /* update QH element link */
1110 val
= cpu_to_le32(qh
.el_link
);
1111 pci_dma_write(&s
->dev
, (curr_qh
& ~0xf) + 4, &val
, sizeof(val
));
1113 if (!depth_first(link
)) {
1114 /* done with this QH */
1122 assert(!"unknown return code");
1125 /* go to the next entry */
1129 s
->pending_int_mask
|= int_mask
;
1132 static void uhci_bh(void *opaque
)
1134 UHCIState
*s
= opaque
;
1135 uhci_process_frame(s
);
1138 static void uhci_frame_timer(void *opaque
)
1140 UHCIState
*s
= opaque
;
1141 uint64_t t_now
, t_last_run
;
1143 const uint64_t frame_t
= get_ticks_per_sec() / FRAME_TIMER_FREQ
;
1145 s
->completions_only
= false;
1146 qemu_bh_cancel(s
->bh
);
1148 if (!(s
->cmd
& UHCI_CMD_RS
)) {
1150 trace_usb_uhci_schedule_stop();
1151 qemu_del_timer(s
->frame_timer
);
1152 uhci_async_cancel_all(s
);
1153 /* set hchalted bit in status - UHCI11D 2.1.2 */
1154 s
->status
|= UHCI_STS_HCHALTED
;
1158 /* We still store expire_time in our state, for migration */
1159 t_last_run
= s
->expire_time
- frame_t
;
1160 t_now
= qemu_get_clock_ns(vm_clock
);
1162 /* Process up to MAX_FRAMES_PER_TICK frames */
1163 frames
= (t_now
- t_last_run
) / frame_t
;
1164 if (frames
> s
->maxframes
) {
1165 int skipped
= frames
- s
->maxframes
;
1166 s
->expire_time
+= skipped
* frame_t
;
1167 s
->frnum
= (s
->frnum
+ skipped
) & 0x7ff;
1170 if (frames
> MAX_FRAMES_PER_TICK
) {
1171 frames
= MAX_FRAMES_PER_TICK
;
1174 for (i
= 0; i
< frames
; i
++) {
1176 trace_usb_uhci_frame_start(s
->frnum
);
1177 uhci_async_validate_begin(s
);
1178 uhci_process_frame(s
);
1179 uhci_async_validate_end(s
);
1180 /* The spec says frnum is the frame currently being processed, and
1181 * the guest must look at frnum - 1 on interrupt, so inc frnum now */
1182 s
->frnum
= (s
->frnum
+ 1) & 0x7ff;
1183 s
->expire_time
+= frame_t
;
1186 /* Complete the previous frame(s) */
1187 if (s
->pending_int_mask
) {
1188 s
->status2
|= s
->pending_int_mask
;
1189 s
->status
|= UHCI_STS_USBINT
;
1192 s
->pending_int_mask
= 0;
1194 qemu_mod_timer(s
->frame_timer
, t_now
+ frame_t
);
1197 static const MemoryRegionOps uhci_ioport_ops
= {
1198 .read
= uhci_port_read
,
1199 .write
= uhci_port_write
,
1200 .valid
.min_access_size
= 1,
1201 .valid
.max_access_size
= 4,
1202 .impl
.min_access_size
= 2,
1203 .impl
.max_access_size
= 2,
1204 .endianness
= DEVICE_LITTLE_ENDIAN
,
1207 static USBPortOps uhci_port_ops
= {
1208 .attach
= uhci_attach
,
1209 .detach
= uhci_detach
,
1210 .child_detach
= uhci_child_detach
,
1211 .wakeup
= uhci_wakeup
,
1212 .complete
= uhci_async_complete
,
1215 static USBBusOps uhci_bus_ops
= {
1218 static int usb_uhci_common_initfn(PCIDevice
*dev
)
1220 PCIDeviceClass
*pc
= PCI_DEVICE_GET_CLASS(dev
);
1221 UHCIPCIDeviceClass
*u
= container_of(pc
, UHCIPCIDeviceClass
, parent_class
);
1222 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1223 uint8_t *pci_conf
= s
->dev
.config
;
1226 pci_conf
[PCI_CLASS_PROG
] = 0x00;
1227 /* TODO: reset value should be 0. */
1228 pci_conf
[USB_SBRN
] = USB_RELEASE_1
; // release number
1230 s
->irq_pin
= u
->info
.irq_pin
;
1231 pci_config_set_interrupt_pin(pci_conf
, s
->irq_pin
+ 1);
1234 USBPort
*ports
[NB_PORTS
];
1235 for(i
= 0; i
< NB_PORTS
; i
++) {
1236 ports
[i
] = &s
->ports
[i
].port
;
1238 if (usb_register_companion(s
->masterbus
, ports
, NB_PORTS
,
1239 s
->firstport
, s
, &uhci_port_ops
,
1240 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
) != 0) {
1244 usb_bus_new(&s
->bus
, &uhci_bus_ops
, &s
->dev
.qdev
);
1245 for (i
= 0; i
< NB_PORTS
; i
++) {
1246 usb_register_port(&s
->bus
, &s
->ports
[i
].port
, s
, i
, &uhci_port_ops
,
1247 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
1250 s
->bh
= qemu_bh_new(uhci_bh
, s
);
1251 s
->frame_timer
= qemu_new_timer_ns(vm_clock
, uhci_frame_timer
, s
);
1252 s
->num_ports_vmstate
= NB_PORTS
;
1253 QTAILQ_INIT(&s
->queues
);
1255 qemu_register_reset(uhci_reset
, s
);
1257 memory_region_init_io(&s
->io_bar
, &uhci_ioport_ops
, s
, "uhci", 0x20);
1258 /* Use region 4 for consistency with real hardware. BSD guests seem
1260 pci_register_bar(&s
->dev
, 4, PCI_BASE_ADDRESS_SPACE_IO
, &s
->io_bar
);
1265 static int usb_uhci_vt82c686b_initfn(PCIDevice
*dev
)
1267 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1268 uint8_t *pci_conf
= s
->dev
.config
;
1270 /* USB misc control 1/2 */
1271 pci_set_long(pci_conf
+ 0x40,0x00001000);
1273 pci_set_long(pci_conf
+ 0x80,0x00020001);
1274 /* USB legacy support */
1275 pci_set_long(pci_conf
+ 0xc0,0x00002000);
1277 return usb_uhci_common_initfn(dev
);
1280 static void usb_uhci_exit(PCIDevice
*dev
)
1282 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1284 memory_region_destroy(&s
->io_bar
);
1287 static Property uhci_properties
[] = {
1288 DEFINE_PROP_STRING("masterbus", UHCIState
, masterbus
),
1289 DEFINE_PROP_UINT32("firstport", UHCIState
, firstport
, 0),
1290 DEFINE_PROP_UINT32("bandwidth", UHCIState
, frame_bandwidth
, 1280),
1291 DEFINE_PROP_UINT32("maxframes", UHCIState
, maxframes
, 128),
1292 DEFINE_PROP_END_OF_LIST(),
1295 static void uhci_class_init(ObjectClass
*klass
, void *data
)
1297 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1298 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1299 UHCIPCIDeviceClass
*u
= container_of(k
, UHCIPCIDeviceClass
, parent_class
);
1300 UHCIInfo
*info
= data
;
1302 k
->init
= info
->initfn
? info
->initfn
: usb_uhci_common_initfn
;
1303 k
->exit
= info
->unplug
? usb_uhci_exit
: NULL
;
1304 k
->vendor_id
= info
->vendor_id
;
1305 k
->device_id
= info
->device_id
;
1306 k
->revision
= info
->revision
;
1307 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1309 dc
->vmsd
= &vmstate_uhci
;
1310 dc
->props
= uhci_properties
;
1314 static UHCIInfo uhci_info
[] = {
1316 .name
= "piix3-usb-uhci",
1317 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1318 .device_id
= PCI_DEVICE_ID_INTEL_82371SB_2
,
1323 .name
= "piix4-usb-uhci",
1324 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1325 .device_id
= PCI_DEVICE_ID_INTEL_82371AB_2
,
1330 .name
= "vt82c686b-usb-uhci",
1331 .vendor_id
= PCI_VENDOR_ID_VIA
,
1332 .device_id
= PCI_DEVICE_ID_VIA_UHCI
,
1335 .initfn
= usb_uhci_vt82c686b_initfn
,
1338 .name
= "ich9-usb-uhci1", /* 00:1d.0 */
1339 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1340 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI1
,
1345 .name
= "ich9-usb-uhci2", /* 00:1d.1 */
1346 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1347 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI2
,
1352 .name
= "ich9-usb-uhci3", /* 00:1d.2 */
1353 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1354 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI3
,
1359 .name
= "ich9-usb-uhci4", /* 00:1a.0 */
1360 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1361 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI4
,
1366 .name
= "ich9-usb-uhci5", /* 00:1a.1 */
1367 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1368 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI5
,
1373 .name
= "ich9-usb-uhci6", /* 00:1a.2 */
1374 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1375 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI6
,
1382 static void uhci_register_types(void)
1384 TypeInfo uhci_type_info
= {
1385 .parent
= TYPE_PCI_DEVICE
,
1386 .instance_size
= sizeof(UHCIState
),
1387 .class_size
= sizeof(UHCIPCIDeviceClass
),
1388 .class_init
= uhci_class_init
,
1392 for (i
= 0; i
< ARRAY_SIZE(uhci_info
); i
++) {
1393 uhci_type_info
.name
= uhci_info
[i
].name
;
1394 uhci_type_info
.class_data
= uhci_info
+ i
;
1395 type_register(&uhci_type_info
);
1399 type_init(uhci_register_types
)