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.
122 uint8_t static_buf
[64]; /* 64 bytes is enough, except for isoc packets */
125 QTAILQ_ENTRY(UHCIAsync
) next
;
135 QTAILQ_ENTRY(UHCIQueue
) next
;
136 QTAILQ_HEAD(asyncs_head
, UHCIAsync
) asyncs
;
140 typedef struct UHCIPort
{
148 USBBus bus
; /* Note unused when we're a companion controller */
149 uint16_t cmd
; /* cmd register */
151 uint16_t intr
; /* interrupt enable register */
152 uint16_t frnum
; /* frame number */
153 uint32_t fl_base_addr
; /* frame list base address */
155 uint8_t status2
; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
157 QEMUTimer
*frame_timer
;
159 uint32_t frame_bytes
;
160 uint32_t frame_bandwidth
;
161 bool completions_only
;
162 UHCIPort ports
[NB_PORTS
];
164 /* Interrupts that should be raised at the end of the current frame. */
165 uint32_t pending_int_mask
;
169 QTAILQ_HEAD(, UHCIQueue
) queues
;
170 uint8_t num_ports_vmstate
;
178 typedef struct UHCI_TD
{
180 uint32_t ctrl
; /* see TD_CTRL_xxx */
185 typedef struct UHCI_QH
{
190 static void uhci_async_cancel(UHCIAsync
*async
);
191 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
);
193 static inline int32_t uhci_queue_token(UHCI_TD
*td
)
195 if ((td
->token
& (0xf << 15)) == 0) {
196 /* ctrl ep, cover ep and dev, not pid! */
197 return td
->token
& 0x7ff00;
199 /* covers ep, dev, pid -> identifies the endpoint */
200 return td
->token
& 0x7ffff;
204 static UHCIQueue
*uhci_queue_new(UHCIState
*s
, uint32_t qh_addr
, UHCI_TD
*td
,
209 queue
= g_new0(UHCIQueue
, 1);
211 queue
->qh_addr
= qh_addr
;
212 queue
->token
= uhci_queue_token(td
);
214 QTAILQ_INIT(&queue
->asyncs
);
215 QTAILQ_INSERT_HEAD(&s
->queues
, queue
, next
);
216 queue
->valid
= QH_VALID
;
217 trace_usb_uhci_queue_add(queue
->token
);
221 static void uhci_queue_free(UHCIQueue
*queue
, const char *reason
)
223 UHCIState
*s
= queue
->uhci
;
226 while (!QTAILQ_EMPTY(&queue
->asyncs
)) {
227 async
= QTAILQ_FIRST(&queue
->asyncs
);
228 uhci_async_cancel(async
);
230 usb_device_ep_stopped(queue
->ep
->dev
, queue
->ep
);
232 trace_usb_uhci_queue_del(queue
->token
, reason
);
233 QTAILQ_REMOVE(&s
->queues
, queue
, next
);
237 static UHCIQueue
*uhci_queue_find(UHCIState
*s
, UHCI_TD
*td
)
239 uint32_t token
= uhci_queue_token(td
);
242 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
243 if (queue
->token
== token
) {
250 static bool uhci_queue_verify(UHCIQueue
*queue
, uint32_t qh_addr
, UHCI_TD
*td
,
251 uint32_t td_addr
, bool queuing
)
253 UHCIAsync
*first
= QTAILQ_FIRST(&queue
->asyncs
);
255 return queue
->qh_addr
== qh_addr
&&
256 queue
->token
== uhci_queue_token(td
) &&
257 (queuing
|| !(td
->ctrl
& TD_CTRL_ACTIVE
) || first
== NULL
||
258 first
->td_addr
== td_addr
);
261 static UHCIAsync
*uhci_async_alloc(UHCIQueue
*queue
, uint32_t td_addr
)
263 UHCIAsync
*async
= g_new0(UHCIAsync
, 1);
265 async
->queue
= queue
;
266 async
->td_addr
= td_addr
;
267 usb_packet_init(&async
->packet
);
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 if (async
->buf
!= async
->static_buf
) {
283 static void uhci_async_link(UHCIAsync
*async
)
285 UHCIQueue
*queue
= async
->queue
;
286 QTAILQ_INSERT_TAIL(&queue
->asyncs
, async
, next
);
287 trace_usb_uhci_packet_link_async(async
->queue
->token
, async
->td_addr
);
290 static void uhci_async_unlink(UHCIAsync
*async
)
292 UHCIQueue
*queue
= async
->queue
;
293 QTAILQ_REMOVE(&queue
->asyncs
, async
, next
);
294 trace_usb_uhci_packet_unlink_async(async
->queue
->token
, async
->td_addr
);
297 static void uhci_async_cancel(UHCIAsync
*async
)
299 uhci_async_unlink(async
);
300 trace_usb_uhci_packet_cancel(async
->queue
->token
, async
->td_addr
,
303 usb_cancel_packet(&async
->packet
);
304 uhci_async_free(async
);
308 * Mark all outstanding async packets as invalid.
309 * This is used for canceling them when TDs are removed by the HCD.
311 static void uhci_async_validate_begin(UHCIState
*s
)
315 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
321 * Cancel async packets that are no longer valid
323 static void uhci_async_validate_end(UHCIState
*s
)
325 UHCIQueue
*queue
, *n
;
327 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
329 uhci_queue_free(queue
, "validate-end");
334 static void uhci_async_cancel_device(UHCIState
*s
, USBDevice
*dev
)
336 UHCIQueue
*queue
, *n
;
338 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
339 if (queue
->ep
->dev
== dev
) {
340 uhci_queue_free(queue
, "cancel-device");
345 static void uhci_async_cancel_all(UHCIState
*s
)
347 UHCIQueue
*queue
, *nq
;
349 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, nq
) {
350 uhci_queue_free(queue
, "cancel-all");
354 static UHCIAsync
*uhci_async_find_td(UHCIState
*s
, uint32_t td_addr
)
359 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
360 QTAILQ_FOREACH(async
, &queue
->asyncs
, next
) {
361 if (async
->td_addr
== td_addr
) {
369 static void uhci_update_irq(UHCIState
*s
)
372 if (((s
->status2
& 1) && (s
->intr
& (1 << 2))) ||
373 ((s
->status2
& 2) && (s
->intr
& (1 << 3))) ||
374 ((s
->status
& UHCI_STS_USBERR
) && (s
->intr
& (1 << 0))) ||
375 ((s
->status
& UHCI_STS_RD
) && (s
->intr
& (1 << 1))) ||
376 (s
->status
& UHCI_STS_HSERR
) ||
377 (s
->status
& UHCI_STS_HCPERR
)) {
382 qemu_set_irq(s
->dev
.irq
[s
->irq_pin
], level
);
385 static void uhci_reset(void *opaque
)
387 UHCIState
*s
= opaque
;
392 trace_usb_uhci_reset();
394 pci_conf
= s
->dev
.config
;
396 pci_conf
[0x6a] = 0x01; /* usb clock */
397 pci_conf
[0x6b] = 0x00;
405 for(i
= 0; i
< NB_PORTS
; i
++) {
408 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
409 usb_port_reset(&port
->port
);
413 uhci_async_cancel_all(s
);
414 qemu_bh_cancel(s
->bh
);
418 static const VMStateDescription vmstate_uhci_port
= {
421 .minimum_version_id
= 1,
422 .minimum_version_id_old
= 1,
423 .fields
= (VMStateField
[]) {
424 VMSTATE_UINT16(ctrl
, UHCIPort
),
425 VMSTATE_END_OF_LIST()
429 static int uhci_post_load(void *opaque
, int version_id
)
431 UHCIState
*s
= opaque
;
433 if (version_id
< 2) {
434 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
435 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
440 static const VMStateDescription vmstate_uhci
= {
443 .minimum_version_id
= 1,
444 .minimum_version_id_old
= 1,
445 .post_load
= uhci_post_load
,
446 .fields
= (VMStateField
[]) {
447 VMSTATE_PCI_DEVICE(dev
, UHCIState
),
448 VMSTATE_UINT8_EQUAL(num_ports_vmstate
, UHCIState
),
449 VMSTATE_STRUCT_ARRAY(ports
, UHCIState
, NB_PORTS
, 1,
450 vmstate_uhci_port
, UHCIPort
),
451 VMSTATE_UINT16(cmd
, UHCIState
),
452 VMSTATE_UINT16(status
, UHCIState
),
453 VMSTATE_UINT16(intr
, UHCIState
),
454 VMSTATE_UINT16(frnum
, UHCIState
),
455 VMSTATE_UINT32(fl_base_addr
, UHCIState
),
456 VMSTATE_UINT8(sof_timing
, UHCIState
),
457 VMSTATE_UINT8(status2
, UHCIState
),
458 VMSTATE_TIMER(frame_timer
, UHCIState
),
459 VMSTATE_INT64_V(expire_time
, UHCIState
, 2),
460 VMSTATE_UINT32_V(pending_int_mask
, UHCIState
, 3),
461 VMSTATE_END_OF_LIST()
465 static void uhci_port_write(void *opaque
, hwaddr addr
,
466 uint64_t val
, unsigned size
)
468 UHCIState
*s
= opaque
;
470 trace_usb_uhci_mmio_writew(addr
, val
);
474 if ((val
& UHCI_CMD_RS
) && !(s
->cmd
& UHCI_CMD_RS
)) {
475 /* start frame processing */
476 trace_usb_uhci_schedule_start();
477 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
478 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
479 qemu_mod_timer(s
->frame_timer
, s
->expire_time
);
480 s
->status
&= ~UHCI_STS_HCHALTED
;
481 } else if (!(val
& UHCI_CMD_RS
)) {
482 s
->status
|= UHCI_STS_HCHALTED
;
484 if (val
& UHCI_CMD_GRESET
) {
488 /* send reset on the USB bus */
489 for(i
= 0; i
< NB_PORTS
; i
++) {
491 usb_device_reset(port
->port
.dev
);
496 if (val
& UHCI_CMD_HCRESET
) {
504 /* XXX: the chip spec is not coherent, so we add a hidden
505 register to distinguish between IOC and SPD */
506 if (val
& UHCI_STS_USBINT
)
515 if (s
->status
& UHCI_STS_HCHALTED
)
516 s
->frnum
= val
& 0x7ff;
519 s
->fl_base_addr
&= 0xffff0000;
520 s
->fl_base_addr
|= val
& ~0xfff;
523 s
->fl_base_addr
&= 0x0000ffff;
524 s
->fl_base_addr
|= (val
<< 16);
527 s
->sof_timing
= val
& 0xff;
539 dev
= port
->port
.dev
;
540 if (dev
&& dev
->attached
) {
542 if ( (val
& UHCI_PORT_RESET
) &&
543 !(port
->ctrl
& UHCI_PORT_RESET
) ) {
544 usb_device_reset(dev
);
547 port
->ctrl
&= UHCI_PORT_READ_ONLY
;
548 /* enabled may only be set if a device is connected */
549 if (!(port
->ctrl
& UHCI_PORT_CCS
)) {
550 val
&= ~UHCI_PORT_EN
;
552 port
->ctrl
|= (val
& ~UHCI_PORT_READ_ONLY
);
553 /* some bits are reset when a '1' is written to them */
554 port
->ctrl
&= ~(val
& UHCI_PORT_WRITE_CLEAR
);
560 static uint64_t uhci_port_read(void *opaque
, hwaddr addr
, unsigned size
)
562 UHCIState
*s
= opaque
;
579 val
= s
->fl_base_addr
& 0xffff;
582 val
= (s
->fl_base_addr
>> 16) & 0xffff;
600 val
= 0xff7f; /* disabled port */
604 trace_usb_uhci_mmio_readw(addr
, val
);
609 /* signal resume if controller suspended */
610 static void uhci_resume (void *opaque
)
612 UHCIState
*s
= (UHCIState
*)opaque
;
617 if (s
->cmd
& UHCI_CMD_EGSM
) {
618 s
->cmd
|= UHCI_CMD_FGR
;
619 s
->status
|= UHCI_STS_RD
;
624 static void uhci_attach(USBPort
*port1
)
626 UHCIState
*s
= port1
->opaque
;
627 UHCIPort
*port
= &s
->ports
[port1
->index
];
629 /* set connect status */
630 port
->ctrl
|= UHCI_PORT_CCS
| UHCI_PORT_CSC
;
633 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
634 port
->ctrl
|= UHCI_PORT_LSDA
;
636 port
->ctrl
&= ~UHCI_PORT_LSDA
;
642 static void uhci_detach(USBPort
*port1
)
644 UHCIState
*s
= port1
->opaque
;
645 UHCIPort
*port
= &s
->ports
[port1
->index
];
647 uhci_async_cancel_device(s
, port1
->dev
);
649 /* set connect status */
650 if (port
->ctrl
& UHCI_PORT_CCS
) {
651 port
->ctrl
&= ~UHCI_PORT_CCS
;
652 port
->ctrl
|= UHCI_PORT_CSC
;
655 if (port
->ctrl
& UHCI_PORT_EN
) {
656 port
->ctrl
&= ~UHCI_PORT_EN
;
657 port
->ctrl
|= UHCI_PORT_ENC
;
663 static void uhci_child_detach(USBPort
*port1
, USBDevice
*child
)
665 UHCIState
*s
= port1
->opaque
;
667 uhci_async_cancel_device(s
, child
);
670 static void uhci_wakeup(USBPort
*port1
)
672 UHCIState
*s
= port1
->opaque
;
673 UHCIPort
*port
= &s
->ports
[port1
->index
];
675 if (port
->ctrl
& UHCI_PORT_SUSPEND
&& !(port
->ctrl
& UHCI_PORT_RD
)) {
676 port
->ctrl
|= UHCI_PORT_RD
;
681 static USBDevice
*uhci_find_device(UHCIState
*s
, uint8_t addr
)
686 for (i
= 0; i
< NB_PORTS
; i
++) {
687 UHCIPort
*port
= &s
->ports
[i
];
688 if (!(port
->ctrl
& UHCI_PORT_EN
)) {
691 dev
= usb_find_device(&port
->port
, addr
);
699 static void uhci_read_td(UHCIState
*s
, UHCI_TD
*td
, uint32_t link
)
701 pci_dma_read(&s
->dev
, link
& ~0xf, td
, sizeof(*td
));
702 le32_to_cpus(&td
->link
);
703 le32_to_cpus(&td
->ctrl
);
704 le32_to_cpus(&td
->token
);
705 le32_to_cpus(&td
->buffer
);
708 static int uhci_handle_td_error(UHCIState
*s
, UHCI_TD
*td
, uint32_t td_addr
,
709 int status
, uint32_t *int_mask
)
711 uint32_t queue_token
= uhci_queue_token(td
);
716 td
->ctrl
|= TD_CTRL_NAK
;
717 return TD_RESULT_NEXT_QH
;
720 td
->ctrl
|= TD_CTRL_STALL
;
721 trace_usb_uhci_packet_complete_stall(queue_token
, td_addr
);
722 ret
= TD_RESULT_NEXT_QH
;
726 td
->ctrl
|= TD_CTRL_BABBLE
| TD_CTRL_STALL
;
727 /* frame interrupted */
728 trace_usb_uhci_packet_complete_babble(queue_token
, td_addr
);
729 ret
= TD_RESULT_STOP_FRAME
;
732 case USB_RET_IOERROR
:
735 td
->ctrl
|= TD_CTRL_TIMEOUT
;
736 td
->ctrl
&= ~(3 << TD_CTRL_ERROR_SHIFT
);
737 trace_usb_uhci_packet_complete_error(queue_token
, td_addr
);
738 ret
= TD_RESULT_NEXT_QH
;
742 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
743 s
->status
|= UHCI_STS_USBERR
;
744 if (td
->ctrl
& TD_CTRL_IOC
) {
751 static int uhci_complete_td(UHCIState
*s
, UHCI_TD
*td
, UHCIAsync
*async
, uint32_t *int_mask
)
753 int len
= 0, max_len
;
756 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
757 pid
= td
->token
& 0xff;
759 if (td
->ctrl
& TD_CTRL_IOS
)
760 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
762 if (async
->packet
.status
!= USB_RET_SUCCESS
) {
763 return uhci_handle_td_error(s
, td
, async
->td_addr
,
764 async
->packet
.status
, int_mask
);
767 len
= async
->packet
.actual_length
;
768 td
->ctrl
= (td
->ctrl
& ~0x7ff) | ((len
- 1) & 0x7ff);
770 /* The NAK bit may have been set by a previous frame, so clear it
771 here. The docs are somewhat unclear, but win2k relies on this
773 td
->ctrl
&= ~(TD_CTRL_ACTIVE
| TD_CTRL_NAK
);
774 if (td
->ctrl
& TD_CTRL_IOC
)
777 if (pid
== USB_TOKEN_IN
) {
778 pci_dma_write(&s
->dev
, td
->buffer
, async
->buf
, len
);
779 if ((td
->ctrl
& TD_CTRL_SPD
) && len
< max_len
) {
781 /* short packet: do not update QH */
782 trace_usb_uhci_packet_complete_shortxfer(async
->queue
->token
,
784 return TD_RESULT_NEXT_QH
;
789 trace_usb_uhci_packet_complete_success(async
->queue
->token
,
791 return TD_RESULT_COMPLETE
;
794 static int uhci_handle_td(UHCIState
*s
, UHCIQueue
*q
, uint32_t qh_addr
,
795 UHCI_TD
*td
, uint32_t td_addr
, uint32_t *int_mask
)
799 bool queuing
= (q
!= NULL
);
800 uint8_t pid
= td
->token
& 0xff;
801 UHCIAsync
*async
= uhci_async_find_td(s
, td_addr
);
804 if (uhci_queue_verify(async
->queue
, qh_addr
, td
, td_addr
, queuing
)) {
805 assert(q
== NULL
|| q
== async
->queue
);
808 uhci_queue_free(async
->queue
, "guest re-used pending td");
814 q
= uhci_queue_find(s
, td
);
815 if (q
&& !uhci_queue_verify(q
, qh_addr
, td
, td_addr
, queuing
)) {
816 uhci_queue_free(q
, "guest re-used qh");
826 if (!(td
->ctrl
& TD_CTRL_ACTIVE
)) {
828 /* Guest marked a pending td non-active, cancel the queue */
829 uhci_queue_free(async
->queue
, "pending td non-active");
832 * ehci11d spec page 22: "Even if the Active bit in the TD is already
833 * cleared when the TD is fetched ... an IOC interrupt is generated"
835 if (td
->ctrl
& TD_CTRL_IOC
) {
838 return TD_RESULT_NEXT_QH
;
843 /* we are busy filling the queue, we are not prepared
844 to consume completed packages then, just leave them
846 return TD_RESULT_ASYNC_CONT
;
850 UHCIAsync
*last
= QTAILQ_LAST(&async
->queue
->asyncs
, asyncs_head
);
852 * While we are waiting for the current td to complete, the guest
853 * may have added more tds to the queue. Note we re-read the td
854 * rather then caching it, as we want to see guest made changes!
856 uhci_read_td(s
, &last_td
, last
->td_addr
);
857 uhci_queue_fill(async
->queue
, &last_td
);
859 return TD_RESULT_ASYNC_CONT
;
861 uhci_async_unlink(async
);
865 if (s
->completions_only
) {
866 return TD_RESULT_ASYNC_CONT
;
869 /* Allocate new packet */
871 USBDevice
*dev
= uhci_find_device(s
, (td
->token
>> 8) & 0x7f);
872 USBEndpoint
*ep
= usb_ep_get(dev
, pid
, (td
->token
>> 15) & 0xf);
875 return uhci_handle_td_error(s
, td
, td_addr
, USB_RET_NODEV
,
878 q
= uhci_queue_new(s
, qh_addr
, td
, ep
);
880 async
= uhci_async_alloc(q
, td_addr
);
882 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
883 spd
= (pid
== USB_TOKEN_IN
&& (td
->ctrl
& TD_CTRL_SPD
) != 0);
884 usb_packet_setup(&async
->packet
, pid
, q
->ep
, 0, td_addr
, spd
,
885 (td
->ctrl
& TD_CTRL_IOC
) != 0);
886 if (max_len
<= sizeof(async
->static_buf
)) {
887 async
->buf
= async
->static_buf
;
889 async
->buf
= g_malloc(max_len
);
891 usb_packet_addbuf(&async
->packet
, async
->buf
, max_len
);
895 case USB_TOKEN_SETUP
:
896 pci_dma_read(&s
->dev
, td
->buffer
, async
->buf
, max_len
);
897 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
898 if (async
->packet
.status
== USB_RET_SUCCESS
) {
899 async
->packet
.actual_length
= max_len
;
904 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
908 /* invalid pid : frame interrupted */
909 uhci_async_free(async
);
910 s
->status
|= UHCI_STS_HCPERR
;
912 return TD_RESULT_STOP_FRAME
;
915 if (async
->packet
.status
== USB_RET_ASYNC
) {
916 uhci_async_link(async
);
918 uhci_queue_fill(q
, td
);
920 return TD_RESULT_ASYNC_START
;
924 ret
= uhci_complete_td(s
, td
, async
, int_mask
);
925 uhci_async_free(async
);
929 static void uhci_async_complete(USBPort
*port
, USBPacket
*packet
)
931 UHCIAsync
*async
= container_of(packet
, UHCIAsync
, packet
);
932 UHCIState
*s
= async
->queue
->uhci
;
934 if (packet
->status
== USB_RET_REMOVE_FROM_QUEUE
) {
935 uhci_async_cancel(async
);
940 /* Force processing of this packet *now*, needed for migration */
941 s
->completions_only
= true;
942 qemu_bh_schedule(s
->bh
);
945 static int is_valid(uint32_t link
)
947 return (link
& 1) == 0;
950 static int is_qh(uint32_t link
)
952 return (link
& 2) != 0;
955 static int depth_first(uint32_t link
)
957 return (link
& 4) != 0;
960 /* QH DB used for detecting QH loops */
961 #define UHCI_MAX_QUEUES 128
963 uint32_t addr
[UHCI_MAX_QUEUES
];
967 static void qhdb_reset(QhDb
*db
)
972 /* Add QH to DB. Returns 1 if already present or DB is full. */
973 static int qhdb_insert(QhDb
*db
, uint32_t addr
)
976 for (i
= 0; i
< db
->count
; i
++)
977 if (db
->addr
[i
] == addr
)
980 if (db
->count
>= UHCI_MAX_QUEUES
)
983 db
->addr
[db
->count
++] = addr
;
987 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
)
989 uint32_t int_mask
= 0;
990 uint32_t plink
= td
->link
;
994 while (is_valid(plink
)) {
995 uhci_read_td(q
->uhci
, &ptd
, plink
);
996 if (!(ptd
.ctrl
& TD_CTRL_ACTIVE
)) {
999 if (uhci_queue_token(&ptd
) != q
->token
) {
1002 trace_usb_uhci_td_queue(plink
& ~0xf, ptd
.ctrl
, ptd
.token
);
1003 ret
= uhci_handle_td(q
->uhci
, q
, q
->qh_addr
, &ptd
, plink
, &int_mask
);
1004 if (ret
== TD_RESULT_ASYNC_CONT
) {
1007 assert(ret
== TD_RESULT_ASYNC_START
);
1008 assert(int_mask
== 0);
1011 usb_device_flush_ep_queue(q
->ep
->dev
, q
->ep
);
1014 static void uhci_process_frame(UHCIState
*s
)
1016 uint32_t frame_addr
, link
, old_td_ctrl
, val
, int_mask
;
1017 uint32_t curr_qh
, td_count
= 0;
1023 frame_addr
= s
->fl_base_addr
+ ((s
->frnum
& 0x3ff) << 2);
1025 pci_dma_read(&s
->dev
, frame_addr
, &link
, 4);
1026 le32_to_cpus(&link
);
1033 for (cnt
= FRAME_MAX_LOOPS
; is_valid(link
) && cnt
; cnt
--) {
1034 if (!s
->completions_only
&& s
->frame_bytes
>= s
->frame_bandwidth
) {
1035 /* We've reached the usb 1.1 bandwidth, which is
1036 1280 bytes/frame, stop processing */
1037 trace_usb_uhci_frame_stop_bandwidth();
1042 trace_usb_uhci_qh_load(link
& ~0xf);
1044 if (qhdb_insert(&qhdb
, link
)) {
1046 * We're going in circles. Which is not a bug because
1047 * HCD is allowed to do that as part of the BW management.
1049 * Stop processing here if no transaction has been done
1050 * since we've been here last time.
1052 if (td_count
== 0) {
1053 trace_usb_uhci_frame_loop_stop_idle();
1056 trace_usb_uhci_frame_loop_continue();
1059 qhdb_insert(&qhdb
, link
);
1063 pci_dma_read(&s
->dev
, link
& ~0xf, &qh
, sizeof(qh
));
1064 le32_to_cpus(&qh
.link
);
1065 le32_to_cpus(&qh
.el_link
);
1067 if (!is_valid(qh
.el_link
)) {
1068 /* QH w/o elements */
1072 /* QH with elements */
1080 uhci_read_td(s
, &td
, link
);
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
, NULL
, curr_qh
, &td
, link
, &int_mask
);
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
));
1092 case TD_RESULT_STOP_FRAME
: /* interrupted frame */
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
;
1101 case TD_RESULT_ASYNC_START
:
1102 trace_usb_uhci_td_async(curr_qh
& ~0xf, link
& ~0xf);
1103 link
= curr_qh
? qh
.link
: td
.link
;
1106 case TD_RESULT_COMPLETE
:
1107 trace_usb_uhci_td_complete(curr_qh
& ~0xf, link
& ~0xf);
1110 s
->frame_bytes
+= (td
.ctrl
& 0x7ff) + 1;
1113 /* update QH element link */
1115 val
= cpu_to_le32(qh
.el_link
);
1116 pci_dma_write(&s
->dev
, (curr_qh
& ~0xf) + 4, &val
, sizeof(val
));
1118 if (!depth_first(link
)) {
1119 /* done with this QH */
1127 assert(!"unknown return code");
1130 /* go to the next entry */
1134 s
->pending_int_mask
|= int_mask
;
1137 static void uhci_bh(void *opaque
)
1139 UHCIState
*s
= opaque
;
1140 uhci_process_frame(s
);
1143 static void uhci_frame_timer(void *opaque
)
1145 UHCIState
*s
= opaque
;
1146 uint64_t t_now
, t_last_run
;
1148 const uint64_t frame_t
= get_ticks_per_sec() / FRAME_TIMER_FREQ
;
1150 s
->completions_only
= false;
1151 qemu_bh_cancel(s
->bh
);
1153 if (!(s
->cmd
& UHCI_CMD_RS
)) {
1155 trace_usb_uhci_schedule_stop();
1156 qemu_del_timer(s
->frame_timer
);
1157 uhci_async_cancel_all(s
);
1158 /* set hchalted bit in status - UHCI11D 2.1.2 */
1159 s
->status
|= UHCI_STS_HCHALTED
;
1163 /* We still store expire_time in our state, for migration */
1164 t_last_run
= s
->expire_time
- frame_t
;
1165 t_now
= qemu_get_clock_ns(vm_clock
);
1167 /* Process up to MAX_FRAMES_PER_TICK frames */
1168 frames
= (t_now
- t_last_run
) / frame_t
;
1169 if (frames
> s
->maxframes
) {
1170 int skipped
= frames
- s
->maxframes
;
1171 s
->expire_time
+= skipped
* frame_t
;
1172 s
->frnum
= (s
->frnum
+ skipped
) & 0x7ff;
1175 if (frames
> MAX_FRAMES_PER_TICK
) {
1176 frames
= MAX_FRAMES_PER_TICK
;
1179 for (i
= 0; i
< frames
; i
++) {
1181 trace_usb_uhci_frame_start(s
->frnum
);
1182 uhci_async_validate_begin(s
);
1183 uhci_process_frame(s
);
1184 uhci_async_validate_end(s
);
1185 /* The spec says frnum is the frame currently being processed, and
1186 * the guest must look at frnum - 1 on interrupt, so inc frnum now */
1187 s
->frnum
= (s
->frnum
+ 1) & 0x7ff;
1188 s
->expire_time
+= frame_t
;
1191 /* Complete the previous frame(s) */
1192 if (s
->pending_int_mask
) {
1193 s
->status2
|= s
->pending_int_mask
;
1194 s
->status
|= UHCI_STS_USBINT
;
1197 s
->pending_int_mask
= 0;
1199 qemu_mod_timer(s
->frame_timer
, t_now
+ frame_t
);
1202 static const MemoryRegionOps uhci_ioport_ops
= {
1203 .read
= uhci_port_read
,
1204 .write
= uhci_port_write
,
1205 .valid
.min_access_size
= 1,
1206 .valid
.max_access_size
= 4,
1207 .impl
.min_access_size
= 2,
1208 .impl
.max_access_size
= 2,
1209 .endianness
= DEVICE_LITTLE_ENDIAN
,
1212 static USBPortOps uhci_port_ops
= {
1213 .attach
= uhci_attach
,
1214 .detach
= uhci_detach
,
1215 .child_detach
= uhci_child_detach
,
1216 .wakeup
= uhci_wakeup
,
1217 .complete
= uhci_async_complete
,
1220 static USBBusOps uhci_bus_ops
= {
1223 static int usb_uhci_common_initfn(PCIDevice
*dev
)
1225 PCIDeviceClass
*pc
= PCI_DEVICE_GET_CLASS(dev
);
1226 UHCIPCIDeviceClass
*u
= container_of(pc
, UHCIPCIDeviceClass
, parent_class
);
1227 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1228 uint8_t *pci_conf
= s
->dev
.config
;
1231 pci_conf
[PCI_CLASS_PROG
] = 0x00;
1232 /* TODO: reset value should be 0. */
1233 pci_conf
[USB_SBRN
] = USB_RELEASE_1
; // release number
1235 s
->irq_pin
= u
->info
.irq_pin
;
1236 pci_config_set_interrupt_pin(pci_conf
, s
->irq_pin
+ 1);
1239 USBPort
*ports
[NB_PORTS
];
1240 for(i
= 0; i
< NB_PORTS
; i
++) {
1241 ports
[i
] = &s
->ports
[i
].port
;
1243 if (usb_register_companion(s
->masterbus
, ports
, NB_PORTS
,
1244 s
->firstport
, s
, &uhci_port_ops
,
1245 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
) != 0) {
1249 usb_bus_new(&s
->bus
, &uhci_bus_ops
, &s
->dev
.qdev
);
1250 for (i
= 0; i
< NB_PORTS
; i
++) {
1251 usb_register_port(&s
->bus
, &s
->ports
[i
].port
, s
, i
, &uhci_port_ops
,
1252 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
1255 s
->bh
= qemu_bh_new(uhci_bh
, s
);
1256 s
->frame_timer
= qemu_new_timer_ns(vm_clock
, uhci_frame_timer
, s
);
1257 s
->num_ports_vmstate
= NB_PORTS
;
1258 QTAILQ_INIT(&s
->queues
);
1260 qemu_register_reset(uhci_reset
, s
);
1262 memory_region_init_io(&s
->io_bar
, &uhci_ioport_ops
, s
, "uhci", 0x20);
1263 /* Use region 4 for consistency with real hardware. BSD guests seem
1265 pci_register_bar(&s
->dev
, 4, PCI_BASE_ADDRESS_SPACE_IO
, &s
->io_bar
);
1270 static int usb_uhci_vt82c686b_initfn(PCIDevice
*dev
)
1272 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1273 uint8_t *pci_conf
= s
->dev
.config
;
1275 /* USB misc control 1/2 */
1276 pci_set_long(pci_conf
+ 0x40,0x00001000);
1278 pci_set_long(pci_conf
+ 0x80,0x00020001);
1279 /* USB legacy support */
1280 pci_set_long(pci_conf
+ 0xc0,0x00002000);
1282 return usb_uhci_common_initfn(dev
);
1285 static void usb_uhci_exit(PCIDevice
*dev
)
1287 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1289 memory_region_destroy(&s
->io_bar
);
1292 static Property uhci_properties
[] = {
1293 DEFINE_PROP_STRING("masterbus", UHCIState
, masterbus
),
1294 DEFINE_PROP_UINT32("firstport", UHCIState
, firstport
, 0),
1295 DEFINE_PROP_UINT32("bandwidth", UHCIState
, frame_bandwidth
, 1280),
1296 DEFINE_PROP_UINT32("maxframes", UHCIState
, maxframes
, 128),
1297 DEFINE_PROP_END_OF_LIST(),
1300 static void uhci_class_init(ObjectClass
*klass
, void *data
)
1302 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1303 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1304 UHCIPCIDeviceClass
*u
= container_of(k
, UHCIPCIDeviceClass
, parent_class
);
1305 UHCIInfo
*info
= data
;
1307 k
->init
= info
->initfn
? info
->initfn
: usb_uhci_common_initfn
;
1308 k
->exit
= info
->unplug
? usb_uhci_exit
: NULL
;
1309 k
->vendor_id
= info
->vendor_id
;
1310 k
->device_id
= info
->device_id
;
1311 k
->revision
= info
->revision
;
1312 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1314 dc
->vmsd
= &vmstate_uhci
;
1315 dc
->props
= uhci_properties
;
1319 static UHCIInfo uhci_info
[] = {
1321 .name
= "piix3-usb-uhci",
1322 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1323 .device_id
= PCI_DEVICE_ID_INTEL_82371SB_2
,
1328 .name
= "piix4-usb-uhci",
1329 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1330 .device_id
= PCI_DEVICE_ID_INTEL_82371AB_2
,
1335 .name
= "vt82c686b-usb-uhci",
1336 .vendor_id
= PCI_VENDOR_ID_VIA
,
1337 .device_id
= PCI_DEVICE_ID_VIA_UHCI
,
1340 .initfn
= usb_uhci_vt82c686b_initfn
,
1343 .name
= "ich9-usb-uhci1", /* 00:1d.0 */
1344 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1345 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI1
,
1350 .name
= "ich9-usb-uhci2", /* 00:1d.1 */
1351 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1352 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI2
,
1357 .name
= "ich9-usb-uhci3", /* 00:1d.2 */
1358 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1359 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI3
,
1364 .name
= "ich9-usb-uhci4", /* 00:1a.0 */
1365 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1366 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI4
,
1371 .name
= "ich9-usb-uhci5", /* 00:1a.1 */
1372 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1373 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI5
,
1378 .name
= "ich9-usb-uhci6", /* 00:1a.2 */
1379 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1380 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI6
,
1387 static void uhci_register_types(void)
1389 TypeInfo uhci_type_info
= {
1390 .parent
= TYPE_PCI_DEVICE
,
1391 .instance_size
= sizeof(UHCIState
),
1392 .class_size
= sizeof(UHCIPCIDeviceClass
),
1393 .class_init
= uhci_class_init
,
1397 for (i
= 0; i
< ARRAY_SIZE(uhci_info
); i
++) {
1398 uhci_type_info
.name
= uhci_info
[i
].name
;
1399 uhci_type_info
.class_data
= uhci_info
+ i
;
1400 type_register(&uhci_type_info
);
1404 type_init(uhci_register_types
)