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
29 #include "qemu/osdep.h"
31 #include "hw/usb/uhci-regs.h"
32 #include "migration/vmstate.h"
33 #include "hw/pci/pci.h"
34 #include "hw/qdev-properties.h"
35 #include "qapi/error.h"
36 #include "qemu/timer.h"
38 #include "sysemu/dma.h"
40 #include "qemu/main-loop.h"
41 #include "qemu/module.h"
42 #include "qom/object.h"
44 #define FRAME_TIMER_FREQ 1000
46 #define FRAME_MAX_LOOPS 256
48 /* Must be large enough to handle 10 frame delay for initial isoc requests */
51 #define MAX_FRAMES_PER_TICK (QH_VALID / 2)
56 TD_RESULT_STOP_FRAME
= 10,
59 TD_RESULT_ASYNC_START
,
63 typedef struct UHCIState UHCIState
;
64 typedef struct UHCIAsync UHCIAsync
;
65 typedef struct UHCIQueue UHCIQueue
;
66 typedef struct UHCIInfo UHCIInfo
;
67 typedef struct UHCIPCIDeviceClass UHCIPCIDeviceClass
;
75 void (*realize
)(PCIDevice
*dev
, Error
**errp
);
79 struct UHCIPCIDeviceClass
{
80 PCIDeviceClass parent_class
;
85 * Pending async transaction.
86 * 'packet' must be the first field because completion
87 * handler does "(UHCIAsync *) pkt" cast.
92 uint8_t static_buf
[64]; /* 64 bytes is enough, except for isoc packets */
95 QTAILQ_ENTRY(UHCIAsync
) next
;
105 QTAILQ_ENTRY(UHCIQueue
) next
;
106 QTAILQ_HEAD(, UHCIAsync
) asyncs
;
110 typedef struct UHCIPort
{
118 USBBus bus
; /* Note unused when we're a companion controller */
119 uint16_t cmd
; /* cmd register */
121 uint16_t intr
; /* interrupt enable register */
122 uint16_t frnum
; /* frame number */
123 uint32_t fl_base_addr
; /* frame list base address */
125 uint8_t status2
; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
127 QEMUTimer
*frame_timer
;
129 uint32_t frame_bytes
;
130 uint32_t frame_bandwidth
;
131 bool completions_only
;
132 UHCIPort ports
[NB_PORTS
];
134 /* Interrupts that should be raised at the end of the current frame. */
135 uint32_t pending_int_mask
;
138 QTAILQ_HEAD(, UHCIQueue
) queues
;
139 uint8_t num_ports_vmstate
;
147 typedef struct UHCI_TD
{
149 uint32_t ctrl
; /* see TD_CTRL_xxx */
154 typedef struct UHCI_QH
{
159 static void uhci_async_cancel(UHCIAsync
*async
);
160 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
);
161 static void uhci_resume(void *opaque
);
163 #define TYPE_UHCI "pci-uhci-usb"
164 DECLARE_INSTANCE_CHECKER(UHCIState
, UHCI
,
167 static inline int32_t uhci_queue_token(UHCI_TD
*td
)
169 if ((td
->token
& (0xf << 15)) == 0) {
170 /* ctrl ep, cover ep and dev, not pid! */
171 return td
->token
& 0x7ff00;
173 /* covers ep, dev, pid -> identifies the endpoint */
174 return td
->token
& 0x7ffff;
178 static UHCIQueue
*uhci_queue_new(UHCIState
*s
, uint32_t qh_addr
, UHCI_TD
*td
,
183 queue
= g_new0(UHCIQueue
, 1);
185 queue
->qh_addr
= qh_addr
;
186 queue
->token
= uhci_queue_token(td
);
188 QTAILQ_INIT(&queue
->asyncs
);
189 QTAILQ_INSERT_HEAD(&s
->queues
, queue
, next
);
190 queue
->valid
= QH_VALID
;
191 trace_usb_uhci_queue_add(queue
->token
);
195 static void uhci_queue_free(UHCIQueue
*queue
, const char *reason
)
197 UHCIState
*s
= queue
->uhci
;
200 while (!QTAILQ_EMPTY(&queue
->asyncs
)) {
201 async
= QTAILQ_FIRST(&queue
->asyncs
);
202 uhci_async_cancel(async
);
204 usb_device_ep_stopped(queue
->ep
->dev
, queue
->ep
);
206 trace_usb_uhci_queue_del(queue
->token
, reason
);
207 QTAILQ_REMOVE(&s
->queues
, queue
, next
);
211 static UHCIQueue
*uhci_queue_find(UHCIState
*s
, UHCI_TD
*td
)
213 uint32_t token
= uhci_queue_token(td
);
216 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
217 if (queue
->token
== token
) {
224 static bool uhci_queue_verify(UHCIQueue
*queue
, uint32_t qh_addr
, UHCI_TD
*td
,
225 uint32_t td_addr
, bool queuing
)
227 UHCIAsync
*first
= QTAILQ_FIRST(&queue
->asyncs
);
228 uint32_t queue_token_addr
= (queue
->token
>> 8) & 0x7f;
230 return queue
->qh_addr
== qh_addr
&&
231 queue
->token
== uhci_queue_token(td
) &&
232 queue_token_addr
== queue
->ep
->dev
->addr
&&
233 (queuing
|| !(td
->ctrl
& TD_CTRL_ACTIVE
) || first
== NULL
||
234 first
->td_addr
== td_addr
);
237 static UHCIAsync
*uhci_async_alloc(UHCIQueue
*queue
, uint32_t td_addr
)
239 UHCIAsync
*async
= g_new0(UHCIAsync
, 1);
241 async
->queue
= queue
;
242 async
->td_addr
= td_addr
;
243 usb_packet_init(&async
->packet
);
244 trace_usb_uhci_packet_add(async
->queue
->token
, async
->td_addr
);
249 static void uhci_async_free(UHCIAsync
*async
)
251 trace_usb_uhci_packet_del(async
->queue
->token
, async
->td_addr
);
252 usb_packet_cleanup(&async
->packet
);
253 if (async
->buf
!= async
->static_buf
) {
259 static void uhci_async_link(UHCIAsync
*async
)
261 UHCIQueue
*queue
= async
->queue
;
262 QTAILQ_INSERT_TAIL(&queue
->asyncs
, async
, next
);
263 trace_usb_uhci_packet_link_async(async
->queue
->token
, async
->td_addr
);
266 static void uhci_async_unlink(UHCIAsync
*async
)
268 UHCIQueue
*queue
= async
->queue
;
269 QTAILQ_REMOVE(&queue
->asyncs
, async
, next
);
270 trace_usb_uhci_packet_unlink_async(async
->queue
->token
, async
->td_addr
);
273 static void uhci_async_cancel(UHCIAsync
*async
)
275 uhci_async_unlink(async
);
276 trace_usb_uhci_packet_cancel(async
->queue
->token
, async
->td_addr
,
279 usb_cancel_packet(&async
->packet
);
280 uhci_async_free(async
);
284 * Mark all outstanding async packets as invalid.
285 * This is used for canceling them when TDs are removed by the HCD.
287 static void uhci_async_validate_begin(UHCIState
*s
)
291 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
297 * Cancel async packets that are no longer valid
299 static void uhci_async_validate_end(UHCIState
*s
)
301 UHCIQueue
*queue
, *n
;
303 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
305 uhci_queue_free(queue
, "validate-end");
310 static void uhci_async_cancel_device(UHCIState
*s
, USBDevice
*dev
)
312 UHCIQueue
*queue
, *n
;
314 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
315 if (queue
->ep
->dev
== dev
) {
316 uhci_queue_free(queue
, "cancel-device");
321 static void uhci_async_cancel_all(UHCIState
*s
)
323 UHCIQueue
*queue
, *nq
;
325 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, nq
) {
326 uhci_queue_free(queue
, "cancel-all");
330 static UHCIAsync
*uhci_async_find_td(UHCIState
*s
, uint32_t td_addr
)
335 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
336 QTAILQ_FOREACH(async
, &queue
->asyncs
, next
) {
337 if (async
->td_addr
== td_addr
) {
345 static void uhci_update_irq(UHCIState
*s
)
348 if (((s
->status2
& 1) && (s
->intr
& (1 << 2))) ||
349 ((s
->status2
& 2) && (s
->intr
& (1 << 3))) ||
350 ((s
->status
& UHCI_STS_USBERR
) && (s
->intr
& (1 << 0))) ||
351 ((s
->status
& UHCI_STS_RD
) && (s
->intr
& (1 << 1))) ||
352 (s
->status
& UHCI_STS_HSERR
) ||
353 (s
->status
& UHCI_STS_HCPERR
)) {
358 pci_set_irq(&s
->dev
, level
);
361 static void uhci_reset(DeviceState
*dev
)
363 PCIDevice
*d
= PCI_DEVICE(dev
);
364 UHCIState
*s
= UHCI(d
);
369 trace_usb_uhci_reset();
371 pci_conf
= s
->dev
.config
;
373 pci_conf
[0x6a] = 0x01; /* usb clock */
374 pci_conf
[0x6b] = 0x00;
376 s
->status
= UHCI_STS_HCHALTED
;
382 for(i
= 0; i
< NB_PORTS
; i
++) {
385 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
386 usb_port_reset(&port
->port
);
390 uhci_async_cancel_all(s
);
391 qemu_bh_cancel(s
->bh
);
395 static const VMStateDescription vmstate_uhci_port
= {
398 .minimum_version_id
= 1,
399 .fields
= (VMStateField
[]) {
400 VMSTATE_UINT16(ctrl
, UHCIPort
),
401 VMSTATE_END_OF_LIST()
405 static int uhci_post_load(void *opaque
, int version_id
)
407 UHCIState
*s
= opaque
;
409 if (version_id
< 2) {
410 s
->expire_time
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
411 (NANOSECONDS_PER_SECOND
/ FRAME_TIMER_FREQ
);
416 static const VMStateDescription vmstate_uhci
= {
419 .minimum_version_id
= 1,
420 .post_load
= uhci_post_load
,
421 .fields
= (VMStateField
[]) {
422 VMSTATE_PCI_DEVICE(dev
, UHCIState
),
423 VMSTATE_UINT8_EQUAL(num_ports_vmstate
, UHCIState
, NULL
),
424 VMSTATE_STRUCT_ARRAY(ports
, UHCIState
, NB_PORTS
, 1,
425 vmstate_uhci_port
, UHCIPort
),
426 VMSTATE_UINT16(cmd
, UHCIState
),
427 VMSTATE_UINT16(status
, UHCIState
),
428 VMSTATE_UINT16(intr
, UHCIState
),
429 VMSTATE_UINT16(frnum
, UHCIState
),
430 VMSTATE_UINT32(fl_base_addr
, UHCIState
),
431 VMSTATE_UINT8(sof_timing
, UHCIState
),
432 VMSTATE_UINT8(status2
, UHCIState
),
433 VMSTATE_TIMER_PTR(frame_timer
, UHCIState
),
434 VMSTATE_INT64_V(expire_time
, UHCIState
, 2),
435 VMSTATE_UINT32_V(pending_int_mask
, UHCIState
, 3),
436 VMSTATE_END_OF_LIST()
440 static void uhci_port_write(void *opaque
, hwaddr addr
,
441 uint64_t val
, unsigned size
)
443 UHCIState
*s
= opaque
;
445 trace_usb_uhci_mmio_writew(addr
, val
);
449 if ((val
& UHCI_CMD_RS
) && !(s
->cmd
& UHCI_CMD_RS
)) {
450 /* start frame processing */
451 trace_usb_uhci_schedule_start();
452 s
->expire_time
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) +
453 (NANOSECONDS_PER_SECOND
/ FRAME_TIMER_FREQ
);
454 timer_mod(s
->frame_timer
, s
->expire_time
);
455 s
->status
&= ~UHCI_STS_HCHALTED
;
456 } else if (!(val
& UHCI_CMD_RS
)) {
457 s
->status
|= UHCI_STS_HCHALTED
;
459 if (val
& UHCI_CMD_GRESET
) {
463 /* send reset on the USB bus */
464 for(i
= 0; i
< NB_PORTS
; i
++) {
466 usb_device_reset(port
->port
.dev
);
468 uhci_reset(DEVICE(s
));
471 if (val
& UHCI_CMD_HCRESET
) {
472 uhci_reset(DEVICE(s
));
476 if (val
& UHCI_CMD_EGSM
) {
477 if ((s
->ports
[0].ctrl
& UHCI_PORT_RD
) ||
478 (s
->ports
[1].ctrl
& UHCI_PORT_RD
)) {
485 /* XXX: the chip spec is not coherent, so we add a hidden
486 register to distinguish between IOC and SPD */
487 if (val
& UHCI_STS_USBINT
)
496 if (s
->status
& UHCI_STS_HCHALTED
)
497 s
->frnum
= val
& 0x7ff;
500 s
->fl_base_addr
&= 0xffff0000;
501 s
->fl_base_addr
|= val
& ~0xfff;
504 s
->fl_base_addr
&= 0x0000ffff;
505 s
->fl_base_addr
|= (val
<< 16);
508 s
->sof_timing
= val
& 0xff;
520 dev
= port
->port
.dev
;
521 if (dev
&& dev
->attached
) {
523 if ( (val
& UHCI_PORT_RESET
) &&
524 !(port
->ctrl
& UHCI_PORT_RESET
) ) {
525 usb_device_reset(dev
);
528 port
->ctrl
&= UHCI_PORT_READ_ONLY
;
529 /* enabled may only be set if a device is connected */
530 if (!(port
->ctrl
& UHCI_PORT_CCS
)) {
531 val
&= ~UHCI_PORT_EN
;
533 port
->ctrl
|= (val
& ~UHCI_PORT_READ_ONLY
);
534 /* some bits are reset when a '1' is written to them */
535 port
->ctrl
&= ~(val
& UHCI_PORT_WRITE_CLEAR
);
541 static uint64_t uhci_port_read(void *opaque
, hwaddr addr
, unsigned size
)
543 UHCIState
*s
= opaque
;
560 val
= s
->fl_base_addr
& 0xffff;
563 val
= (s
->fl_base_addr
>> 16) & 0xffff;
581 val
= 0xff7f; /* disabled port */
585 trace_usb_uhci_mmio_readw(addr
, val
);
590 /* signal resume if controller suspended */
591 static void uhci_resume (void *opaque
)
593 UHCIState
*s
= (UHCIState
*)opaque
;
598 if (s
->cmd
& UHCI_CMD_EGSM
) {
599 s
->cmd
|= UHCI_CMD_FGR
;
600 s
->status
|= UHCI_STS_RD
;
605 static void uhci_attach(USBPort
*port1
)
607 UHCIState
*s
= port1
->opaque
;
608 UHCIPort
*port
= &s
->ports
[port1
->index
];
610 /* set connect status */
611 port
->ctrl
|= UHCI_PORT_CCS
| UHCI_PORT_CSC
;
614 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
615 port
->ctrl
|= UHCI_PORT_LSDA
;
617 port
->ctrl
&= ~UHCI_PORT_LSDA
;
623 static void uhci_detach(USBPort
*port1
)
625 UHCIState
*s
= port1
->opaque
;
626 UHCIPort
*port
= &s
->ports
[port1
->index
];
628 uhci_async_cancel_device(s
, port1
->dev
);
630 /* set connect status */
631 if (port
->ctrl
& UHCI_PORT_CCS
) {
632 port
->ctrl
&= ~UHCI_PORT_CCS
;
633 port
->ctrl
|= UHCI_PORT_CSC
;
636 if (port
->ctrl
& UHCI_PORT_EN
) {
637 port
->ctrl
&= ~UHCI_PORT_EN
;
638 port
->ctrl
|= UHCI_PORT_ENC
;
644 static void uhci_child_detach(USBPort
*port1
, USBDevice
*child
)
646 UHCIState
*s
= port1
->opaque
;
648 uhci_async_cancel_device(s
, child
);
651 static void uhci_wakeup(USBPort
*port1
)
653 UHCIState
*s
= port1
->opaque
;
654 UHCIPort
*port
= &s
->ports
[port1
->index
];
656 if (port
->ctrl
& UHCI_PORT_SUSPEND
&& !(port
->ctrl
& UHCI_PORT_RD
)) {
657 port
->ctrl
|= UHCI_PORT_RD
;
662 static USBDevice
*uhci_find_device(UHCIState
*s
, uint8_t addr
)
667 for (i
= 0; i
< NB_PORTS
; i
++) {
668 UHCIPort
*port
= &s
->ports
[i
];
669 if (!(port
->ctrl
& UHCI_PORT_EN
)) {
672 dev
= usb_find_device(&port
->port
, addr
);
680 static void uhci_read_td(UHCIState
*s
, UHCI_TD
*td
, uint32_t link
)
682 pci_dma_read(&s
->dev
, link
& ~0xf, td
, sizeof(*td
));
683 le32_to_cpus(&td
->link
);
684 le32_to_cpus(&td
->ctrl
);
685 le32_to_cpus(&td
->token
);
686 le32_to_cpus(&td
->buffer
);
689 static int uhci_handle_td_error(UHCIState
*s
, UHCI_TD
*td
, uint32_t td_addr
,
690 int status
, uint32_t *int_mask
)
692 uint32_t queue_token
= uhci_queue_token(td
);
697 td
->ctrl
|= TD_CTRL_NAK
;
698 return TD_RESULT_NEXT_QH
;
701 td
->ctrl
|= TD_CTRL_STALL
;
702 trace_usb_uhci_packet_complete_stall(queue_token
, td_addr
);
703 ret
= TD_RESULT_NEXT_QH
;
707 td
->ctrl
|= TD_CTRL_BABBLE
| TD_CTRL_STALL
;
708 /* frame interrupted */
709 trace_usb_uhci_packet_complete_babble(queue_token
, td_addr
);
710 ret
= TD_RESULT_STOP_FRAME
;
713 case USB_RET_IOERROR
:
716 td
->ctrl
|= TD_CTRL_TIMEOUT
;
717 td
->ctrl
&= ~(3 << TD_CTRL_ERROR_SHIFT
);
718 trace_usb_uhci_packet_complete_error(queue_token
, td_addr
);
719 ret
= TD_RESULT_NEXT_QH
;
723 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
724 s
->status
|= UHCI_STS_USBERR
;
725 if (td
->ctrl
& TD_CTRL_IOC
) {
732 static int uhci_complete_td(UHCIState
*s
, UHCI_TD
*td
, UHCIAsync
*async
, uint32_t *int_mask
)
734 int len
= 0, max_len
;
737 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
738 pid
= td
->token
& 0xff;
740 if (td
->ctrl
& TD_CTRL_IOS
)
741 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
743 if (async
->packet
.status
!= USB_RET_SUCCESS
) {
744 return uhci_handle_td_error(s
, td
, async
->td_addr
,
745 async
->packet
.status
, int_mask
);
748 len
= async
->packet
.actual_length
;
749 td
->ctrl
= (td
->ctrl
& ~0x7ff) | ((len
- 1) & 0x7ff);
751 /* The NAK bit may have been set by a previous frame, so clear it
752 here. The docs are somewhat unclear, but win2k relies on this
754 td
->ctrl
&= ~(TD_CTRL_ACTIVE
| TD_CTRL_NAK
);
755 if (td
->ctrl
& TD_CTRL_IOC
)
758 if (pid
== USB_TOKEN_IN
) {
759 pci_dma_write(&s
->dev
, td
->buffer
, async
->buf
, len
);
760 if ((td
->ctrl
& TD_CTRL_SPD
) && len
< max_len
) {
762 /* short packet: do not update QH */
763 trace_usb_uhci_packet_complete_shortxfer(async
->queue
->token
,
765 return TD_RESULT_NEXT_QH
;
770 trace_usb_uhci_packet_complete_success(async
->queue
->token
,
772 return TD_RESULT_COMPLETE
;
775 static int uhci_handle_td(UHCIState
*s
, UHCIQueue
*q
, uint32_t qh_addr
,
776 UHCI_TD
*td
, uint32_t td_addr
, uint32_t *int_mask
)
780 bool queuing
= (q
!= NULL
);
781 uint8_t pid
= td
->token
& 0xff;
784 async
= uhci_async_find_td(s
, td_addr
);
786 if (uhci_queue_verify(async
->queue
, qh_addr
, td
, td_addr
, queuing
)) {
787 assert(q
== NULL
|| q
== async
->queue
);
790 uhci_queue_free(async
->queue
, "guest re-used pending td");
796 q
= uhci_queue_find(s
, td
);
797 if (q
&& !uhci_queue_verify(q
, qh_addr
, td
, td_addr
, queuing
)) {
798 uhci_queue_free(q
, "guest re-used qh");
808 if (!(td
->ctrl
& TD_CTRL_ACTIVE
)) {
810 /* Guest marked a pending td non-active, cancel the queue */
811 uhci_queue_free(async
->queue
, "pending td non-active");
814 * ehci11d spec page 22: "Even if the Active bit in the TD is already
815 * cleared when the TD is fetched ... an IOC interrupt is generated"
817 if (td
->ctrl
& TD_CTRL_IOC
) {
820 return TD_RESULT_NEXT_QH
;
825 case USB_TOKEN_SETUP
:
829 /* invalid pid : frame interrupted */
830 s
->status
|= UHCI_STS_HCPERR
;
831 s
->cmd
&= ~UHCI_CMD_RS
;
833 return TD_RESULT_STOP_FRAME
;
838 /* we are busy filling the queue, we are not prepared
839 to consume completed packages then, just leave them
841 return TD_RESULT_ASYNC_CONT
;
845 UHCIAsync
*last
= QTAILQ_LAST(&async
->queue
->asyncs
);
847 * While we are waiting for the current td to complete, the guest
848 * may have added more tds to the queue. Note we re-read the td
849 * rather then caching it, as we want to see guest made changes!
851 uhci_read_td(s
, &last_td
, last
->td_addr
);
852 uhci_queue_fill(async
->queue
, &last_td
);
854 return TD_RESULT_ASYNC_CONT
;
856 uhci_async_unlink(async
);
860 if (s
->completions_only
) {
861 return TD_RESULT_ASYNC_CONT
;
864 /* Allocate new packet */
869 dev
= uhci_find_device(s
, (td
->token
>> 8) & 0x7f);
871 return uhci_handle_td_error(s
, td
, td_addr
, USB_RET_NODEV
,
874 ep
= usb_ep_get(dev
, pid
, (td
->token
>> 15) & 0xf);
875 q
= uhci_queue_new(s
, qh_addr
, td
, ep
);
877 async
= uhci_async_alloc(q
, td_addr
);
879 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
880 spd
= (pid
== USB_TOKEN_IN
&& (td
->ctrl
& TD_CTRL_SPD
) != 0);
881 usb_packet_setup(&async
->packet
, pid
, q
->ep
, 0, td_addr
, spd
,
882 (td
->ctrl
& TD_CTRL_IOC
) != 0);
883 if (max_len
<= sizeof(async
->static_buf
)) {
884 async
->buf
= async
->static_buf
;
886 async
->buf
= g_malloc(max_len
);
888 usb_packet_addbuf(&async
->packet
, async
->buf
, max_len
);
892 case USB_TOKEN_SETUP
:
893 pci_dma_read(&s
->dev
, td
->buffer
, async
->buf
, max_len
);
894 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
895 if (async
->packet
.status
== USB_RET_SUCCESS
) {
896 async
->packet
.actual_length
= max_len
;
901 usb_handle_packet(q
->ep
->dev
, &async
->packet
);
905 abort(); /* Never to execute */
908 if (async
->packet
.status
== USB_RET_ASYNC
) {
909 uhci_async_link(async
);
911 uhci_queue_fill(q
, td
);
913 return TD_RESULT_ASYNC_START
;
917 ret
= uhci_complete_td(s
, td
, async
, int_mask
);
918 uhci_async_free(async
);
922 static void uhci_async_complete(USBPort
*port
, USBPacket
*packet
)
924 UHCIAsync
*async
= container_of(packet
, UHCIAsync
, packet
);
925 UHCIState
*s
= async
->queue
->uhci
;
927 if (packet
->status
== USB_RET_REMOVE_FROM_QUEUE
) {
928 uhci_async_cancel(async
);
933 /* Force processing of this packet *now*, needed for migration */
934 s
->completions_only
= true;
935 qemu_bh_schedule(s
->bh
);
938 static int is_valid(uint32_t link
)
940 return (link
& 1) == 0;
943 static int is_qh(uint32_t link
)
945 return (link
& 2) != 0;
948 static int depth_first(uint32_t link
)
950 return (link
& 4) != 0;
953 /* QH DB used for detecting QH loops */
954 #define UHCI_MAX_QUEUES 128
956 uint32_t addr
[UHCI_MAX_QUEUES
];
960 static void qhdb_reset(QhDb
*db
)
965 /* Add QH to DB. Returns 1 if already present or DB is full. */
966 static int qhdb_insert(QhDb
*db
, uint32_t addr
)
969 for (i
= 0; i
< db
->count
; i
++)
970 if (db
->addr
[i
] == addr
)
973 if (db
->count
>= UHCI_MAX_QUEUES
)
976 db
->addr
[db
->count
++] = addr
;
980 static void uhci_queue_fill(UHCIQueue
*q
, UHCI_TD
*td
)
982 uint32_t int_mask
= 0;
983 uint32_t plink
= td
->link
;
987 while (is_valid(plink
)) {
988 uhci_read_td(q
->uhci
, &ptd
, plink
);
989 if (!(ptd
.ctrl
& TD_CTRL_ACTIVE
)) {
992 if (uhci_queue_token(&ptd
) != q
->token
) {
995 trace_usb_uhci_td_queue(plink
& ~0xf, ptd
.ctrl
, ptd
.token
);
996 ret
= uhci_handle_td(q
->uhci
, q
, q
->qh_addr
, &ptd
, plink
, &int_mask
);
997 if (ret
== TD_RESULT_ASYNC_CONT
) {
1000 assert(ret
== TD_RESULT_ASYNC_START
);
1001 assert(int_mask
== 0);
1004 usb_device_flush_ep_queue(q
->ep
->dev
, q
->ep
);
1007 static void uhci_process_frame(UHCIState
*s
)
1009 uint32_t frame_addr
, link
, old_td_ctrl
, val
, int_mask
;
1010 uint32_t curr_qh
, td_count
= 0;
1016 frame_addr
= s
->fl_base_addr
+ ((s
->frnum
& 0x3ff) << 2);
1018 pci_dma_read(&s
->dev
, frame_addr
, &link
, 4);
1019 le32_to_cpus(&link
);
1026 for (cnt
= FRAME_MAX_LOOPS
; is_valid(link
) && cnt
; cnt
--) {
1027 if (!s
->completions_only
&& s
->frame_bytes
>= s
->frame_bandwidth
) {
1028 /* We've reached the usb 1.1 bandwidth, which is
1029 1280 bytes/frame, stop processing */
1030 trace_usb_uhci_frame_stop_bandwidth();
1035 trace_usb_uhci_qh_load(link
& ~0xf);
1037 if (qhdb_insert(&qhdb
, link
)) {
1039 * We're going in circles. Which is not a bug because
1040 * HCD is allowed to do that as part of the BW management.
1042 * Stop processing here if no transaction has been done
1043 * since we've been here last time.
1045 if (td_count
== 0) {
1046 trace_usb_uhci_frame_loop_stop_idle();
1049 trace_usb_uhci_frame_loop_continue();
1052 qhdb_insert(&qhdb
, link
);
1056 pci_dma_read(&s
->dev
, link
& ~0xf, &qh
, sizeof(qh
));
1057 le32_to_cpus(&qh
.link
);
1058 le32_to_cpus(&qh
.el_link
);
1060 if (!is_valid(qh
.el_link
)) {
1061 /* QH w/o elements */
1065 /* QH with elements */
1073 uhci_read_td(s
, &td
, link
);
1074 trace_usb_uhci_td_load(curr_qh
& ~0xf, link
& ~0xf, td
.ctrl
, td
.token
);
1076 old_td_ctrl
= td
.ctrl
;
1077 ret
= uhci_handle_td(s
, NULL
, curr_qh
, &td
, link
, &int_mask
);
1078 if (old_td_ctrl
!= td
.ctrl
) {
1079 /* update the status bits of the TD */
1080 val
= cpu_to_le32(td
.ctrl
);
1081 pci_dma_write(&s
->dev
, (link
& ~0xf) + 4, &val
, sizeof(val
));
1085 case TD_RESULT_STOP_FRAME
: /* interrupted frame */
1088 case TD_RESULT_NEXT_QH
:
1089 case TD_RESULT_ASYNC_CONT
:
1090 trace_usb_uhci_td_nextqh(curr_qh
& ~0xf, link
& ~0xf);
1091 link
= curr_qh
? qh
.link
: td
.link
;
1094 case TD_RESULT_ASYNC_START
:
1095 trace_usb_uhci_td_async(curr_qh
& ~0xf, link
& ~0xf);
1096 link
= curr_qh
? qh
.link
: td
.link
;
1099 case TD_RESULT_COMPLETE
:
1100 trace_usb_uhci_td_complete(curr_qh
& ~0xf, link
& ~0xf);
1103 s
->frame_bytes
+= (td
.ctrl
& 0x7ff) + 1;
1106 /* update QH element link */
1108 val
= cpu_to_le32(qh
.el_link
);
1109 pci_dma_write(&s
->dev
, (curr_qh
& ~0xf) + 4, &val
, sizeof(val
));
1111 if (!depth_first(link
)) {
1112 /* done with this QH */
1120 assert(!"unknown return code");
1123 /* go to the next entry */
1127 s
->pending_int_mask
|= int_mask
;
1130 static void uhci_bh(void *opaque
)
1132 UHCIState
*s
= opaque
;
1133 uhci_process_frame(s
);
1136 static void uhci_frame_timer(void *opaque
)
1138 UHCIState
*s
= opaque
;
1139 uint64_t t_now
, t_last_run
;
1141 const uint64_t frame_t
= NANOSECONDS_PER_SECOND
/ FRAME_TIMER_FREQ
;
1143 s
->completions_only
= false;
1144 qemu_bh_cancel(s
->bh
);
1146 if (!(s
->cmd
& UHCI_CMD_RS
)) {
1148 trace_usb_uhci_schedule_stop();
1149 timer_del(s
->frame_timer
);
1150 uhci_async_cancel_all(s
);
1151 /* set hchalted bit in status - UHCI11D 2.1.2 */
1152 s
->status
|= UHCI_STS_HCHALTED
;
1156 /* We still store expire_time in our state, for migration */
1157 t_last_run
= s
->expire_time
- frame_t
;
1158 t_now
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1160 /* Process up to MAX_FRAMES_PER_TICK frames */
1161 frames
= (t_now
- t_last_run
) / frame_t
;
1162 if (frames
> s
->maxframes
) {
1163 int skipped
= frames
- s
->maxframes
;
1164 s
->expire_time
+= skipped
* frame_t
;
1165 s
->frnum
= (s
->frnum
+ skipped
) & 0x7ff;
1168 if (frames
> MAX_FRAMES_PER_TICK
) {
1169 frames
= MAX_FRAMES_PER_TICK
;
1172 for (i
= 0; i
< frames
; i
++) {
1174 trace_usb_uhci_frame_start(s
->frnum
);
1175 uhci_async_validate_begin(s
);
1176 uhci_process_frame(s
);
1177 uhci_async_validate_end(s
);
1178 /* The spec says frnum is the frame currently being processed, and
1179 * the guest must look at frnum - 1 on interrupt, so inc frnum now */
1180 s
->frnum
= (s
->frnum
+ 1) & 0x7ff;
1181 s
->expire_time
+= frame_t
;
1184 /* Complete the previous frame(s) */
1185 if (s
->pending_int_mask
) {
1186 s
->status2
|= s
->pending_int_mask
;
1187 s
->status
|= UHCI_STS_USBINT
;
1190 s
->pending_int_mask
= 0;
1192 timer_mod(s
->frame_timer
, t_now
+ frame_t
);
1195 static const MemoryRegionOps uhci_ioport_ops
= {
1196 .read
= uhci_port_read
,
1197 .write
= uhci_port_write
,
1198 .valid
.min_access_size
= 1,
1199 .valid
.max_access_size
= 4,
1200 .impl
.min_access_size
= 2,
1201 .impl
.max_access_size
= 2,
1202 .endianness
= DEVICE_LITTLE_ENDIAN
,
1205 static USBPortOps uhci_port_ops
= {
1206 .attach
= uhci_attach
,
1207 .detach
= uhci_detach
,
1208 .child_detach
= uhci_child_detach
,
1209 .wakeup
= uhci_wakeup
,
1210 .complete
= uhci_async_complete
,
1213 static USBBusOps uhci_bus_ops
= {
1216 static void usb_uhci_common_realize(PCIDevice
*dev
, Error
**errp
)
1219 PCIDeviceClass
*pc
= PCI_DEVICE_GET_CLASS(dev
);
1220 UHCIPCIDeviceClass
*u
= container_of(pc
, UHCIPCIDeviceClass
, parent_class
);
1221 UHCIState
*s
= UHCI(dev
);
1222 uint8_t *pci_conf
= s
->dev
.config
;
1225 pci_conf
[PCI_CLASS_PROG
] = 0x00;
1226 /* TODO: reset value should be 0. */
1227 pci_conf
[USB_SBRN
] = USB_RELEASE_1
; // release number
1229 pci_config_set_interrupt_pin(pci_conf
, u
->info
.irq_pin
+ 1);
1232 USBPort
*ports
[NB_PORTS
];
1233 for(i
= 0; i
< NB_PORTS
; i
++) {
1234 ports
[i
] = &s
->ports
[i
].port
;
1236 usb_register_companion(s
->masterbus
, ports
, NB_PORTS
,
1237 s
->firstport
, s
, &uhci_port_ops
,
1238 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
,
1241 error_propagate(errp
, err
);
1245 usb_bus_new(&s
->bus
, sizeof(s
->bus
), &uhci_bus_ops
, DEVICE(dev
));
1246 for (i
= 0; i
< NB_PORTS
; i
++) {
1247 usb_register_port(&s
->bus
, &s
->ports
[i
].port
, s
, i
, &uhci_port_ops
,
1248 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
1251 s
->bh
= qemu_bh_new(uhci_bh
, s
);
1252 s
->frame_timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, uhci_frame_timer
, s
);
1253 s
->num_ports_vmstate
= NB_PORTS
;
1254 QTAILQ_INIT(&s
->queues
);
1256 memory_region_init_io(&s
->io_bar
, OBJECT(s
), &uhci_ioport_ops
, s
,
1259 /* Use region 4 for consistency with real hardware. BSD guests seem
1261 pci_register_bar(&s
->dev
, 4, PCI_BASE_ADDRESS_SPACE_IO
, &s
->io_bar
);
1264 static void usb_uhci_vt82c686b_realize(PCIDevice
*dev
, Error
**errp
)
1266 UHCIState
*s
= UHCI(dev
);
1267 uint8_t *pci_conf
= s
->dev
.config
;
1269 /* USB misc control 1/2 */
1270 pci_set_long(pci_conf
+ 0x40,0x00001000);
1272 pci_set_long(pci_conf
+ 0x80,0x00020001);
1273 /* USB legacy support */
1274 pci_set_long(pci_conf
+ 0xc0,0x00002000);
1276 usb_uhci_common_realize(dev
, errp
);
1279 static void usb_uhci_exit(PCIDevice
*dev
)
1281 UHCIState
*s
= UHCI(dev
);
1283 trace_usb_uhci_exit();
1285 if (s
->frame_timer
) {
1286 timer_del(s
->frame_timer
);
1287 timer_free(s
->frame_timer
);
1288 s
->frame_timer
= NULL
;
1292 qemu_bh_delete(s
->bh
);
1295 uhci_async_cancel_all(s
);
1297 if (!s
->masterbus
) {
1298 usb_bus_release(&s
->bus
);
1302 static Property uhci_properties_companion
[] = {
1303 DEFINE_PROP_STRING("masterbus", UHCIState
, masterbus
),
1304 DEFINE_PROP_UINT32("firstport", UHCIState
, firstport
, 0),
1305 DEFINE_PROP_UINT32("bandwidth", UHCIState
, frame_bandwidth
, 1280),
1306 DEFINE_PROP_UINT32("maxframes", UHCIState
, maxframes
, 128),
1307 DEFINE_PROP_END_OF_LIST(),
1309 static Property uhci_properties_standalone
[] = {
1310 DEFINE_PROP_UINT32("bandwidth", UHCIState
, frame_bandwidth
, 1280),
1311 DEFINE_PROP_UINT32("maxframes", UHCIState
, maxframes
, 128),
1312 DEFINE_PROP_END_OF_LIST(),
1315 static void uhci_class_init(ObjectClass
*klass
, void *data
)
1317 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1318 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1320 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1321 dc
->vmsd
= &vmstate_uhci
;
1322 dc
->reset
= uhci_reset
;
1323 set_bit(DEVICE_CATEGORY_USB
, dc
->categories
);
1326 static const TypeInfo uhci_pci_type_info
= {
1328 .parent
= TYPE_PCI_DEVICE
,
1329 .instance_size
= sizeof(UHCIState
),
1330 .class_size
= sizeof(UHCIPCIDeviceClass
),
1332 .class_init
= uhci_class_init
,
1333 .interfaces
= (InterfaceInfo
[]) {
1334 { INTERFACE_CONVENTIONAL_PCI_DEVICE
},
1339 static void uhci_data_class_init(ObjectClass
*klass
, void *data
)
1341 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1342 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1343 UHCIPCIDeviceClass
*u
= container_of(k
, UHCIPCIDeviceClass
, parent_class
);
1344 UHCIInfo
*info
= data
;
1346 k
->realize
= info
->realize
? info
->realize
: usb_uhci_common_realize
;
1347 k
->exit
= info
->unplug
? usb_uhci_exit
: NULL
;
1348 k
->vendor_id
= info
->vendor_id
;
1349 k
->device_id
= info
->device_id
;
1350 k
->revision
= info
->revision
;
1351 if (!info
->unplug
) {
1352 /* uhci controllers in companion setups can't be hotplugged */
1353 dc
->hotpluggable
= false;
1354 device_class_set_props(dc
, uhci_properties_companion
);
1356 device_class_set_props(dc
, uhci_properties_standalone
);
1361 static UHCIInfo uhci_info
[] = {
1363 .name
= "piix3-usb-uhci",
1364 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1365 .device_id
= PCI_DEVICE_ID_INTEL_82371SB_2
,
1370 .name
= "piix4-usb-uhci",
1371 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1372 .device_id
= PCI_DEVICE_ID_INTEL_82371AB_2
,
1377 .name
= "vt82c686b-usb-uhci",
1378 .vendor_id
= PCI_VENDOR_ID_VIA
,
1379 .device_id
= PCI_DEVICE_ID_VIA_UHCI
,
1382 .realize
= usb_uhci_vt82c686b_realize
,
1385 .name
= "ich9-usb-uhci1", /* 00:1d.0 */
1386 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1387 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI1
,
1392 .name
= "ich9-usb-uhci2", /* 00:1d.1 */
1393 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1394 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI2
,
1399 .name
= "ich9-usb-uhci3", /* 00:1d.2 */
1400 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1401 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI3
,
1406 .name
= "ich9-usb-uhci4", /* 00:1a.0 */
1407 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1408 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI4
,
1413 .name
= "ich9-usb-uhci5", /* 00:1a.1 */
1414 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1415 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI5
,
1420 .name
= "ich9-usb-uhci6", /* 00:1a.2 */
1421 .vendor_id
= PCI_VENDOR_ID_INTEL
,
1422 .device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI6
,
1429 static void uhci_register_types(void)
1431 TypeInfo uhci_type_info
= {
1432 .parent
= TYPE_UHCI
,
1433 .class_init
= uhci_data_class_init
,
1437 type_register_static(&uhci_pci_type_info
);
1439 for (i
= 0; i
< ARRAY_SIZE(uhci_info
); i
++) {
1440 uhci_type_info
.name
= uhci_info
[i
].name
;
1441 uhci_type_info
.class_data
= uhci_info
+ i
;
1442 type_register(&uhci_type_info
);
1446 type_init(uhci_register_types
)