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 256
81 TD_RESULT_STOP_FRAME
= 10,
84 TD_RESULT_ASYNC_START
,
88 typedef struct UHCIState UHCIState
;
89 typedef struct UHCIAsync UHCIAsync
;
90 typedef struct UHCIQueue UHCIQueue
;
93 * Pending async transaction.
94 * 'packet' must be the first field because completion
95 * handler does "(UHCIAsync *) pkt" cast.
102 QTAILQ_ENTRY(UHCIAsync
) next
;
110 QTAILQ_ENTRY(UHCIQueue
) next
;
111 QTAILQ_HEAD(, UHCIAsync
) asyncs
;
115 typedef struct UHCIPort
{
123 USBBus bus
; /* Note unused when we're a companion controller */
124 uint16_t cmd
; /* cmd register */
126 uint16_t intr
; /* interrupt enable register */
127 uint16_t frnum
; /* frame number */
128 uint32_t fl_base_addr
; /* frame list base address */
130 uint8_t status2
; /* bit 0 and 1 are used to generate UHCI_STS_USBINT */
132 QEMUTimer
*frame_timer
;
134 uint32_t frame_bytes
;
135 uint32_t frame_bandwidth
;
136 UHCIPort ports
[NB_PORTS
];
138 /* Interrupts that should be raised at the end of the current frame. */
139 uint32_t pending_int_mask
;
143 QTAILQ_HEAD(, UHCIQueue
) queues
;
144 uint8_t num_ports_vmstate
;
151 typedef struct UHCI_TD
{
153 uint32_t ctrl
; /* see TD_CTRL_xxx */
158 typedef struct UHCI_QH
{
163 static void uhci_async_cancel(UHCIAsync
*async
);
165 static inline int32_t uhci_queue_token(UHCI_TD
*td
)
167 /* covers ep, dev, pid -> identifies the endpoint */
168 return td
->token
& 0x7ffff;
171 static UHCIQueue
*uhci_queue_get(UHCIState
*s
, UHCI_TD
*td
)
173 uint32_t token
= uhci_queue_token(td
);
176 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
177 if (queue
->token
== token
) {
182 queue
= g_new0(UHCIQueue
, 1);
184 queue
->token
= token
;
185 QTAILQ_INIT(&queue
->asyncs
);
186 QTAILQ_INSERT_HEAD(&s
->queues
, queue
, next
);
187 trace_usb_uhci_queue_add(queue
->token
);
191 static void uhci_queue_free(UHCIQueue
*queue
)
193 UHCIState
*s
= queue
->uhci
;
196 while (!QTAILQ_EMPTY(&queue
->asyncs
)) {
197 async
= QTAILQ_FIRST(&queue
->asyncs
);
198 uhci_async_cancel(async
);
201 trace_usb_uhci_queue_del(queue
->token
);
202 QTAILQ_REMOVE(&s
->queues
, queue
, next
);
206 static UHCIAsync
*uhci_async_alloc(UHCIQueue
*queue
, uint32_t addr
)
208 UHCIAsync
*async
= g_new0(UHCIAsync
, 1);
210 async
->queue
= queue
;
212 usb_packet_init(&async
->packet
);
213 pci_dma_sglist_init(&async
->sgl
, &queue
->uhci
->dev
, 1);
214 trace_usb_uhci_packet_add(async
->queue
->token
, async
->td
);
219 static void uhci_async_free(UHCIAsync
*async
)
221 trace_usb_uhci_packet_del(async
->queue
->token
, async
->td
);
222 usb_packet_cleanup(&async
->packet
);
223 qemu_sglist_destroy(&async
->sgl
);
227 static void uhci_async_link(UHCIAsync
*async
)
229 UHCIQueue
*queue
= async
->queue
;
230 QTAILQ_INSERT_TAIL(&queue
->asyncs
, async
, next
);
231 trace_usb_uhci_packet_link_async(async
->queue
->token
, async
->td
);
234 static void uhci_async_unlink(UHCIAsync
*async
)
236 UHCIQueue
*queue
= async
->queue
;
237 QTAILQ_REMOVE(&queue
->asyncs
, async
, next
);
238 trace_usb_uhci_packet_unlink_async(async
->queue
->token
, async
->td
);
241 static void uhci_async_cancel(UHCIAsync
*async
)
243 uhci_async_unlink(async
);
244 trace_usb_uhci_packet_cancel(async
->queue
->token
, async
->td
, async
->done
);
246 usb_cancel_packet(&async
->packet
);
247 usb_packet_unmap(&async
->packet
, &async
->sgl
);
248 uhci_async_free(async
);
252 * Mark all outstanding async packets as invalid.
253 * This is used for canceling them when TDs are removed by the HCD.
255 static void uhci_async_validate_begin(UHCIState
*s
)
259 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
265 * Cancel async packets that are no longer valid
267 static void uhci_async_validate_end(UHCIState
*s
)
269 UHCIQueue
*queue
, *n
;
271 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, n
) {
273 uhci_queue_free(queue
);
278 static void uhci_async_cancel_device(UHCIState
*s
, USBDevice
*dev
)
283 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
284 QTAILQ_FOREACH_SAFE(curr
, &queue
->asyncs
, next
, n
) {
285 if (!usb_packet_is_inflight(&curr
->packet
) ||
286 curr
->packet
.ep
->dev
!= dev
) {
289 uhci_async_cancel(curr
);
294 static void uhci_async_cancel_all(UHCIState
*s
)
296 UHCIQueue
*queue
, *nq
;
298 QTAILQ_FOREACH_SAFE(queue
, &s
->queues
, next
, nq
) {
299 uhci_queue_free(queue
);
303 static UHCIAsync
*uhci_async_find_td(UHCIState
*s
, uint32_t addr
, UHCI_TD
*td
)
305 uint32_t token
= uhci_queue_token(td
);
309 QTAILQ_FOREACH(queue
, &s
->queues
, next
) {
310 if (queue
->token
== token
) {
318 QTAILQ_FOREACH(async
, &queue
->asyncs
, next
) {
319 if (async
->td
== addr
) {
327 static void uhci_update_irq(UHCIState
*s
)
330 if (((s
->status2
& 1) && (s
->intr
& (1 << 2))) ||
331 ((s
->status2
& 2) && (s
->intr
& (1 << 3))) ||
332 ((s
->status
& UHCI_STS_USBERR
) && (s
->intr
& (1 << 0))) ||
333 ((s
->status
& UHCI_STS_RD
) && (s
->intr
& (1 << 1))) ||
334 (s
->status
& UHCI_STS_HSERR
) ||
335 (s
->status
& UHCI_STS_HCPERR
)) {
340 qemu_set_irq(s
->dev
.irq
[s
->irq_pin
], level
);
343 static void uhci_reset(void *opaque
)
345 UHCIState
*s
= opaque
;
350 trace_usb_uhci_reset();
352 pci_conf
= s
->dev
.config
;
354 pci_conf
[0x6a] = 0x01; /* usb clock */
355 pci_conf
[0x6b] = 0x00;
363 for(i
= 0; i
< NB_PORTS
; i
++) {
366 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
367 usb_port_reset(&port
->port
);
371 uhci_async_cancel_all(s
);
372 qemu_bh_cancel(s
->bh
);
376 static const VMStateDescription vmstate_uhci_port
= {
379 .minimum_version_id
= 1,
380 .minimum_version_id_old
= 1,
381 .fields
= (VMStateField
[]) {
382 VMSTATE_UINT16(ctrl
, UHCIPort
),
383 VMSTATE_END_OF_LIST()
387 static int uhci_post_load(void *opaque
, int version_id
)
389 UHCIState
*s
= opaque
;
391 if (version_id
< 2) {
392 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
393 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
398 static const VMStateDescription vmstate_uhci
= {
401 .minimum_version_id
= 1,
402 .minimum_version_id_old
= 1,
403 .post_load
= uhci_post_load
,
404 .fields
= (VMStateField
[]) {
405 VMSTATE_PCI_DEVICE(dev
, UHCIState
),
406 VMSTATE_UINT8_EQUAL(num_ports_vmstate
, UHCIState
),
407 VMSTATE_STRUCT_ARRAY(ports
, UHCIState
, NB_PORTS
, 1,
408 vmstate_uhci_port
, UHCIPort
),
409 VMSTATE_UINT16(cmd
, UHCIState
),
410 VMSTATE_UINT16(status
, UHCIState
),
411 VMSTATE_UINT16(intr
, UHCIState
),
412 VMSTATE_UINT16(frnum
, UHCIState
),
413 VMSTATE_UINT32(fl_base_addr
, UHCIState
),
414 VMSTATE_UINT8(sof_timing
, UHCIState
),
415 VMSTATE_UINT8(status2
, UHCIState
),
416 VMSTATE_TIMER(frame_timer
, UHCIState
),
417 VMSTATE_INT64_V(expire_time
, UHCIState
, 2),
418 VMSTATE_END_OF_LIST()
422 static void uhci_ioport_writeb(void *opaque
, uint32_t addr
, uint32_t val
)
424 UHCIState
*s
= opaque
;
434 static uint32_t uhci_ioport_readb(void *opaque
, uint32_t addr
)
436 UHCIState
*s
= opaque
;
451 static void uhci_ioport_writew(void *opaque
, uint32_t addr
, uint32_t val
)
453 UHCIState
*s
= opaque
;
456 trace_usb_uhci_mmio_writew(addr
, val
);
460 if ((val
& UHCI_CMD_RS
) && !(s
->cmd
& UHCI_CMD_RS
)) {
461 /* start frame processing */
462 trace_usb_uhci_schedule_start();
463 s
->expire_time
= qemu_get_clock_ns(vm_clock
) +
464 (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
465 qemu_mod_timer(s
->frame_timer
, qemu_get_clock_ns(vm_clock
));
466 s
->status
&= ~UHCI_STS_HCHALTED
;
467 } else if (!(val
& UHCI_CMD_RS
)) {
468 s
->status
|= UHCI_STS_HCHALTED
;
470 if (val
& UHCI_CMD_GRESET
) {
474 /* send reset on the USB bus */
475 for(i
= 0; i
< NB_PORTS
; i
++) {
477 usb_device_reset(port
->port
.dev
);
482 if (val
& UHCI_CMD_HCRESET
) {
490 /* XXX: the chip spec is not coherent, so we add a hidden
491 register to distinguish between IOC and SPD */
492 if (val
& UHCI_STS_USBINT
)
501 if (s
->status
& UHCI_STS_HCHALTED
)
502 s
->frnum
= val
& 0x7ff;
514 dev
= port
->port
.dev
;
515 if (dev
&& dev
->attached
) {
517 if ( (val
& UHCI_PORT_RESET
) &&
518 !(port
->ctrl
& UHCI_PORT_RESET
) ) {
519 usb_device_reset(dev
);
522 port
->ctrl
&= UHCI_PORT_READ_ONLY
;
523 port
->ctrl
|= (val
& ~UHCI_PORT_READ_ONLY
);
524 /* some bits are reset when a '1' is written to them */
525 port
->ctrl
&= ~(val
& UHCI_PORT_WRITE_CLEAR
);
531 static uint32_t uhci_ioport_readw(void *opaque
, uint32_t addr
)
533 UHCIState
*s
= opaque
;
563 val
= 0xff7f; /* disabled port */
567 trace_usb_uhci_mmio_readw(addr
, val
);
572 static void uhci_ioport_writel(void *opaque
, uint32_t addr
, uint32_t val
)
574 UHCIState
*s
= opaque
;
577 trace_usb_uhci_mmio_writel(addr
, val
);
581 s
->fl_base_addr
= val
& ~0xfff;
586 static uint32_t uhci_ioport_readl(void *opaque
, uint32_t addr
)
588 UHCIState
*s
= opaque
;
594 val
= s
->fl_base_addr
;
600 trace_usb_uhci_mmio_readl(addr
, val
);
604 /* signal resume if controller suspended */
605 static void uhci_resume (void *opaque
)
607 UHCIState
*s
= (UHCIState
*)opaque
;
612 if (s
->cmd
& UHCI_CMD_EGSM
) {
613 s
->cmd
|= UHCI_CMD_FGR
;
614 s
->status
|= UHCI_STS_RD
;
619 static void uhci_attach(USBPort
*port1
)
621 UHCIState
*s
= port1
->opaque
;
622 UHCIPort
*port
= &s
->ports
[port1
->index
];
624 /* set connect status */
625 port
->ctrl
|= UHCI_PORT_CCS
| UHCI_PORT_CSC
;
628 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
629 port
->ctrl
|= UHCI_PORT_LSDA
;
631 port
->ctrl
&= ~UHCI_PORT_LSDA
;
637 static void uhci_detach(USBPort
*port1
)
639 UHCIState
*s
= port1
->opaque
;
640 UHCIPort
*port
= &s
->ports
[port1
->index
];
642 uhci_async_cancel_device(s
, port1
->dev
);
644 /* set connect status */
645 if (port
->ctrl
& UHCI_PORT_CCS
) {
646 port
->ctrl
&= ~UHCI_PORT_CCS
;
647 port
->ctrl
|= UHCI_PORT_CSC
;
650 if (port
->ctrl
& UHCI_PORT_EN
) {
651 port
->ctrl
&= ~UHCI_PORT_EN
;
652 port
->ctrl
|= UHCI_PORT_ENC
;
658 static void uhci_child_detach(USBPort
*port1
, USBDevice
*child
)
660 UHCIState
*s
= port1
->opaque
;
662 uhci_async_cancel_device(s
, child
);
665 static void uhci_wakeup(USBPort
*port1
)
667 UHCIState
*s
= port1
->opaque
;
668 UHCIPort
*port
= &s
->ports
[port1
->index
];
670 if (port
->ctrl
& UHCI_PORT_SUSPEND
&& !(port
->ctrl
& UHCI_PORT_RD
)) {
671 port
->ctrl
|= UHCI_PORT_RD
;
676 static USBDevice
*uhci_find_device(UHCIState
*s
, uint8_t addr
)
681 for (i
= 0; i
< NB_PORTS
; i
++) {
682 UHCIPort
*port
= &s
->ports
[i
];
683 if (!(port
->ctrl
& UHCI_PORT_EN
)) {
686 dev
= usb_find_device(&port
->port
, addr
);
694 static int uhci_complete_td(UHCIState
*s
, UHCI_TD
*td
, UHCIAsync
*async
, uint32_t *int_mask
)
696 int len
= 0, max_len
, err
, ret
;
699 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
700 pid
= td
->token
& 0xff;
702 ret
= async
->packet
.result
;
704 if (td
->ctrl
& TD_CTRL_IOS
)
705 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
710 len
= async
->packet
.result
;
711 td
->ctrl
= (td
->ctrl
& ~0x7ff) | ((len
- 1) & 0x7ff);
713 /* The NAK bit may have been set by a previous frame, so clear it
714 here. The docs are somewhat unclear, but win2k relies on this
716 td
->ctrl
&= ~(TD_CTRL_ACTIVE
| TD_CTRL_NAK
);
717 if (td
->ctrl
& TD_CTRL_IOC
)
720 if (pid
== USB_TOKEN_IN
) {
721 if ((td
->ctrl
& TD_CTRL_SPD
) && len
< max_len
) {
723 /* short packet: do not update QH */
724 trace_usb_uhci_packet_complete_shortxfer(async
->queue
->token
,
726 return TD_RESULT_NEXT_QH
;
731 trace_usb_uhci_packet_complete_success(async
->queue
->token
, async
->td
);
732 return TD_RESULT_COMPLETE
;
737 td
->ctrl
|= TD_CTRL_NAK
;
738 return TD_RESULT_NEXT_QH
;
741 td
->ctrl
|= TD_CTRL_STALL
;
742 trace_usb_uhci_packet_complete_stall(async
->queue
->token
, async
->td
);
743 err
= TD_RESULT_NEXT_QH
;
747 td
->ctrl
|= TD_CTRL_BABBLE
| TD_CTRL_STALL
;
748 /* frame interrupted */
749 trace_usb_uhci_packet_complete_babble(async
->queue
->token
, async
->td
);
750 err
= TD_RESULT_STOP_FRAME
;
753 case USB_RET_IOERROR
:
756 td
->ctrl
|= TD_CTRL_TIMEOUT
;
757 td
->ctrl
&= ~(3 << TD_CTRL_ERROR_SHIFT
);
758 trace_usb_uhci_packet_complete_error(async
->queue
->token
, async
->td
);
759 err
= TD_RESULT_NEXT_QH
;
763 td
->ctrl
&= ~TD_CTRL_ACTIVE
;
764 s
->status
|= UHCI_STS_USBERR
;
765 if (td
->ctrl
& TD_CTRL_IOC
) {
772 static int uhci_handle_td(UHCIState
*s
, uint32_t addr
, UHCI_TD
*td
,
773 uint32_t *int_mask
, bool queuing
,
774 struct USBEndpoint
**ep_ret
)
777 int len
= 0, max_len
;
784 if (!(td
->ctrl
& TD_CTRL_ACTIVE
)) {
786 * ehci11d spec page 22: "Even if the Active bit in the TD is already
787 * cleared when the TD is fetched ... an IOC interrupt is generated"
789 if (td
->ctrl
& TD_CTRL_IOC
) {
792 return TD_RESULT_NEXT_QH
;
795 async
= uhci_async_find_td(s
, addr
, td
);
797 /* Already submitted */
798 async
->queue
->valid
= 32;
801 return TD_RESULT_ASYNC_CONT
;
803 /* we are busy filling the queue, we are not prepared
804 to consume completed packages then, just leave them
806 return TD_RESULT_ASYNC_CONT
;
809 uhci_async_unlink(async
);
813 /* Allocate new packet */
814 async
= uhci_async_alloc(uhci_queue_get(s
, td
), addr
);
816 /* valid needs to be large enough to handle 10 frame delay
817 * for initial isochronous requests
819 async
->queue
->valid
= 32;
821 max_len
= ((td
->token
>> 21) + 1) & 0x7ff;
822 pid
= td
->token
& 0xff;
823 spd
= (pid
== USB_TOKEN_IN
&& (td
->ctrl
& TD_CTRL_SPD
) != 0);
825 dev
= uhci_find_device(s
, (td
->token
>> 8) & 0x7f);
826 ep
= usb_ep_get(dev
, pid
, (td
->token
>> 15) & 0xf);
830 usb_packet_setup(&async
->packet
, pid
, ep
, addr
, spd
,
831 (td
->ctrl
& TD_CTRL_IOC
) != 0);
832 qemu_sglist_add(&async
->sgl
, td
->buffer
, max_len
);
833 usb_packet_map(&async
->packet
, &async
->sgl
);
837 case USB_TOKEN_SETUP
:
838 len
= usb_handle_packet(dev
, &async
->packet
);
844 len
= usb_handle_packet(dev
, &async
->packet
);
848 /* invalid pid : frame interrupted */
849 usb_packet_unmap(&async
->packet
, &async
->sgl
);
850 uhci_async_free(async
);
851 s
->status
|= UHCI_STS_HCPERR
;
853 return TD_RESULT_STOP_FRAME
;
856 if (len
== USB_RET_ASYNC
) {
857 uhci_async_link(async
);
858 return TD_RESULT_ASYNC_START
;
861 async
->packet
.result
= len
;
864 len
= uhci_complete_td(s
, td
, async
, int_mask
);
865 usb_packet_unmap(&async
->packet
, &async
->sgl
);
866 uhci_async_free(async
);
870 static void uhci_async_complete(USBPort
*port
, USBPacket
*packet
)
872 UHCIAsync
*async
= container_of(packet
, UHCIAsync
, packet
);
873 UHCIState
*s
= async
->queue
->uhci
;
875 if (packet
->result
== USB_RET_REMOVE_FROM_QUEUE
) {
876 uhci_async_unlink(async
);
877 uhci_async_cancel(async
);
882 if (s
->frame_bytes
< s
->frame_bandwidth
) {
883 qemu_bh_schedule(s
->bh
);
887 static int is_valid(uint32_t link
)
889 return (link
& 1) == 0;
892 static int is_qh(uint32_t link
)
894 return (link
& 2) != 0;
897 static int depth_first(uint32_t link
)
899 return (link
& 4) != 0;
902 /* QH DB used for detecting QH loops */
903 #define UHCI_MAX_QUEUES 128
905 uint32_t addr
[UHCI_MAX_QUEUES
];
909 static void qhdb_reset(QhDb
*db
)
914 /* Add QH to DB. Returns 1 if already present or DB is full. */
915 static int qhdb_insert(QhDb
*db
, uint32_t addr
)
918 for (i
= 0; i
< db
->count
; i
++)
919 if (db
->addr
[i
] == addr
)
922 if (db
->count
>= UHCI_MAX_QUEUES
)
925 db
->addr
[db
->count
++] = addr
;
929 static void uhci_fill_queue(UHCIState
*s
, UHCI_TD
*td
, struct USBEndpoint
*ep
)
931 uint32_t int_mask
= 0;
932 uint32_t plink
= td
->link
;
933 uint32_t token
= uhci_queue_token(td
);
937 while (is_valid(plink
)) {
938 pci_dma_read(&s
->dev
, plink
& ~0xf, &ptd
, sizeof(ptd
));
939 le32_to_cpus(&ptd
.link
);
940 le32_to_cpus(&ptd
.ctrl
);
941 le32_to_cpus(&ptd
.token
);
942 le32_to_cpus(&ptd
.buffer
);
943 if (!(ptd
.ctrl
& TD_CTRL_ACTIVE
)) {
946 if (uhci_queue_token(&ptd
) != token
) {
949 trace_usb_uhci_td_queue(plink
& ~0xf, ptd
.ctrl
, ptd
.token
);
950 ret
= uhci_handle_td(s
, plink
, &ptd
, &int_mask
, true, NULL
);
951 if (ret
== TD_RESULT_ASYNC_CONT
) {
954 assert(ret
== TD_RESULT_ASYNC_START
);
955 assert(int_mask
== 0);
958 usb_device_flush_ep_queue(ep
->dev
, ep
);
961 static void uhci_process_frame(UHCIState
*s
)
963 uint32_t frame_addr
, link
, old_td_ctrl
, val
, int_mask
;
964 uint32_t curr_qh
, td_count
= 0;
965 struct USBEndpoint
*curr_ep
;
971 frame_addr
= s
->fl_base_addr
+ ((s
->frnum
& 0x3ff) << 2);
973 pci_dma_read(&s
->dev
, frame_addr
, &link
, 4);
981 for (cnt
= FRAME_MAX_LOOPS
; is_valid(link
) && cnt
; cnt
--) {
982 if (s
->frame_bytes
>= s
->frame_bandwidth
) {
983 /* We've reached the usb 1.1 bandwidth, which is
984 1280 bytes/frame, stop processing */
985 trace_usb_uhci_frame_stop_bandwidth();
990 trace_usb_uhci_qh_load(link
& ~0xf);
992 if (qhdb_insert(&qhdb
, link
)) {
994 * We're going in circles. Which is not a bug because
995 * HCD is allowed to do that as part of the BW management.
997 * Stop processing here if no transaction has been done
998 * since we've been here last time.
1000 if (td_count
== 0) {
1001 trace_usb_uhci_frame_loop_stop_idle();
1004 trace_usb_uhci_frame_loop_continue();
1007 qhdb_insert(&qhdb
, link
);
1011 pci_dma_read(&s
->dev
, link
& ~0xf, &qh
, sizeof(qh
));
1012 le32_to_cpus(&qh
.link
);
1013 le32_to_cpus(&qh
.el_link
);
1015 if (!is_valid(qh
.el_link
)) {
1016 /* QH w/o elements */
1020 /* QH with elements */
1028 pci_dma_read(&s
->dev
, link
& ~0xf, &td
, sizeof(td
));
1029 le32_to_cpus(&td
.link
);
1030 le32_to_cpus(&td
.ctrl
);
1031 le32_to_cpus(&td
.token
);
1032 le32_to_cpus(&td
.buffer
);
1033 trace_usb_uhci_td_load(curr_qh
& ~0xf, link
& ~0xf, td
.ctrl
, td
.token
);
1035 old_td_ctrl
= td
.ctrl
;
1036 ret
= uhci_handle_td(s
, link
, &td
, &int_mask
, false, &curr_ep
);
1037 if (old_td_ctrl
!= td
.ctrl
) {
1038 /* update the status bits of the TD */
1039 val
= cpu_to_le32(td
.ctrl
);
1040 pci_dma_write(&s
->dev
, (link
& ~0xf) + 4, &val
, sizeof(val
));
1044 case TD_RESULT_STOP_FRAME
: /* interrupted frame */
1047 case TD_RESULT_NEXT_QH
:
1048 case TD_RESULT_ASYNC_CONT
:
1049 trace_usb_uhci_td_nextqh(curr_qh
& ~0xf, link
& ~0xf);
1050 link
= curr_qh
? qh
.link
: td
.link
;
1053 case TD_RESULT_ASYNC_START
:
1054 trace_usb_uhci_td_async(curr_qh
& ~0xf, link
& ~0xf);
1055 uhci_fill_queue(s
, &td
, curr_ep
);
1056 link
= curr_qh
? qh
.link
: td
.link
;
1059 case TD_RESULT_COMPLETE
:
1060 trace_usb_uhci_td_complete(curr_qh
& ~0xf, link
& ~0xf);
1063 s
->frame_bytes
+= (td
.ctrl
& 0x7ff) + 1;
1066 /* update QH element link */
1068 val
= cpu_to_le32(qh
.el_link
);
1069 pci_dma_write(&s
->dev
, (curr_qh
& ~0xf) + 4, &val
, sizeof(val
));
1071 if (!depth_first(link
)) {
1072 /* done with this QH */
1080 assert(!"unknown return code");
1083 /* go to the next entry */
1087 s
->pending_int_mask
|= int_mask
;
1090 static void uhci_bh(void *opaque
)
1092 UHCIState
*s
= opaque
;
1093 uhci_process_frame(s
);
1096 static void uhci_frame_timer(void *opaque
)
1098 UHCIState
*s
= opaque
;
1100 /* prepare the timer for the next frame */
1101 s
->expire_time
+= (get_ticks_per_sec() / FRAME_TIMER_FREQ
);
1103 qemu_bh_cancel(s
->bh
);
1105 if (!(s
->cmd
& UHCI_CMD_RS
)) {
1107 trace_usb_uhci_schedule_stop();
1108 qemu_del_timer(s
->frame_timer
);
1109 uhci_async_cancel_all(s
);
1110 /* set hchalted bit in status - UHCI11D 2.1.2 */
1111 s
->status
|= UHCI_STS_HCHALTED
;
1115 /* Complete the previous frame */
1116 if (s
->pending_int_mask
) {
1117 s
->status2
|= s
->pending_int_mask
;
1118 s
->status
|= UHCI_STS_USBINT
;
1121 s
->pending_int_mask
= 0;
1123 /* Start new frame */
1124 s
->frnum
= (s
->frnum
+ 1) & 0x7ff;
1126 trace_usb_uhci_frame_start(s
->frnum
);
1128 uhci_async_validate_begin(s
);
1130 uhci_process_frame(s
);
1132 uhci_async_validate_end(s
);
1134 qemu_mod_timer(s
->frame_timer
, s
->expire_time
);
1137 static const MemoryRegionPortio uhci_portio
[] = {
1138 { 0, 32, 2, .write
= uhci_ioport_writew
, },
1139 { 0, 32, 2, .read
= uhci_ioport_readw
, },
1140 { 0, 32, 4, .write
= uhci_ioport_writel
, },
1141 { 0, 32, 4, .read
= uhci_ioport_readl
, },
1142 { 0, 32, 1, .write
= uhci_ioport_writeb
, },
1143 { 0, 32, 1, .read
= uhci_ioport_readb
, },
1144 PORTIO_END_OF_LIST()
1147 static const MemoryRegionOps uhci_ioport_ops
= {
1148 .old_portio
= uhci_portio
,
1151 static USBPortOps uhci_port_ops
= {
1152 .attach
= uhci_attach
,
1153 .detach
= uhci_detach
,
1154 .child_detach
= uhci_child_detach
,
1155 .wakeup
= uhci_wakeup
,
1156 .complete
= uhci_async_complete
,
1159 static USBBusOps uhci_bus_ops
= {
1162 static int usb_uhci_common_initfn(PCIDevice
*dev
)
1164 PCIDeviceClass
*pc
= PCI_DEVICE_GET_CLASS(dev
);
1165 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1166 uint8_t *pci_conf
= s
->dev
.config
;
1169 pci_conf
[PCI_CLASS_PROG
] = 0x00;
1170 /* TODO: reset value should be 0. */
1171 pci_conf
[USB_SBRN
] = USB_RELEASE_1
; // release number
1173 switch (pc
->device_id
) {
1174 case PCI_DEVICE_ID_INTEL_82801I_UHCI1
:
1175 s
->irq_pin
= 0; /* A */
1177 case PCI_DEVICE_ID_INTEL_82801I_UHCI2
:
1178 s
->irq_pin
= 1; /* B */
1180 case PCI_DEVICE_ID_INTEL_82801I_UHCI3
:
1181 s
->irq_pin
= 2; /* C */
1184 s
->irq_pin
= 3; /* D */
1187 pci_config_set_interrupt_pin(pci_conf
, s
->irq_pin
+ 1);
1190 USBPort
*ports
[NB_PORTS
];
1191 for(i
= 0; i
< NB_PORTS
; i
++) {
1192 ports
[i
] = &s
->ports
[i
].port
;
1194 if (usb_register_companion(s
->masterbus
, ports
, NB_PORTS
,
1195 s
->firstport
, s
, &uhci_port_ops
,
1196 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
) != 0) {
1200 usb_bus_new(&s
->bus
, &uhci_bus_ops
, &s
->dev
.qdev
);
1201 for (i
= 0; i
< NB_PORTS
; i
++) {
1202 usb_register_port(&s
->bus
, &s
->ports
[i
].port
, s
, i
, &uhci_port_ops
,
1203 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
1206 s
->bh
= qemu_bh_new(uhci_bh
, s
);
1207 s
->frame_timer
= qemu_new_timer_ns(vm_clock
, uhci_frame_timer
, s
);
1208 s
->num_ports_vmstate
= NB_PORTS
;
1209 QTAILQ_INIT(&s
->queues
);
1211 qemu_register_reset(uhci_reset
, s
);
1213 memory_region_init_io(&s
->io_bar
, &uhci_ioport_ops
, s
, "uhci", 0x20);
1214 /* Use region 4 for consistency with real hardware. BSD guests seem
1216 pci_register_bar(&s
->dev
, 4, PCI_BASE_ADDRESS_SPACE_IO
, &s
->io_bar
);
1221 static int usb_uhci_vt82c686b_initfn(PCIDevice
*dev
)
1223 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1224 uint8_t *pci_conf
= s
->dev
.config
;
1226 /* USB misc control 1/2 */
1227 pci_set_long(pci_conf
+ 0x40,0x00001000);
1229 pci_set_long(pci_conf
+ 0x80,0x00020001);
1230 /* USB legacy support */
1231 pci_set_long(pci_conf
+ 0xc0,0x00002000);
1233 return usb_uhci_common_initfn(dev
);
1236 static void usb_uhci_exit(PCIDevice
*dev
)
1238 UHCIState
*s
= DO_UPCAST(UHCIState
, dev
, dev
);
1240 memory_region_destroy(&s
->io_bar
);
1243 static Property uhci_properties
[] = {
1244 DEFINE_PROP_STRING("masterbus", UHCIState
, masterbus
),
1245 DEFINE_PROP_UINT32("firstport", UHCIState
, firstport
, 0),
1246 DEFINE_PROP_UINT32("bandwidth", UHCIState
, frame_bandwidth
, 1280),
1247 DEFINE_PROP_END_OF_LIST(),
1250 static void piix3_uhci_class_init(ObjectClass
*klass
, void *data
)
1252 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1253 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1255 k
->init
= usb_uhci_common_initfn
;
1256 k
->exit
= usb_uhci_exit
;
1257 k
->vendor_id
= PCI_VENDOR_ID_INTEL
;
1258 k
->device_id
= PCI_DEVICE_ID_INTEL_82371SB_2
;
1260 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1261 dc
->vmsd
= &vmstate_uhci
;
1262 dc
->props
= uhci_properties
;
1265 static TypeInfo piix3_uhci_info
= {
1266 .name
= "piix3-usb-uhci",
1267 .parent
= TYPE_PCI_DEVICE
,
1268 .instance_size
= sizeof(UHCIState
),
1269 .class_init
= piix3_uhci_class_init
,
1272 static void piix4_uhci_class_init(ObjectClass
*klass
, void *data
)
1274 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1275 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1277 k
->init
= usb_uhci_common_initfn
;
1278 k
->exit
= usb_uhci_exit
;
1279 k
->vendor_id
= PCI_VENDOR_ID_INTEL
;
1280 k
->device_id
= PCI_DEVICE_ID_INTEL_82371AB_2
;
1282 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1283 dc
->vmsd
= &vmstate_uhci
;
1284 dc
->props
= uhci_properties
;
1287 static TypeInfo piix4_uhci_info
= {
1288 .name
= "piix4-usb-uhci",
1289 .parent
= TYPE_PCI_DEVICE
,
1290 .instance_size
= sizeof(UHCIState
),
1291 .class_init
= piix4_uhci_class_init
,
1294 static void vt82c686b_uhci_class_init(ObjectClass
*klass
, void *data
)
1296 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1297 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1299 k
->init
= usb_uhci_vt82c686b_initfn
;
1300 k
->exit
= usb_uhci_exit
;
1301 k
->vendor_id
= PCI_VENDOR_ID_VIA
;
1302 k
->device_id
= PCI_DEVICE_ID_VIA_UHCI
;
1304 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1305 dc
->vmsd
= &vmstate_uhci
;
1306 dc
->props
= uhci_properties
;
1309 static TypeInfo vt82c686b_uhci_info
= {
1310 .name
= "vt82c686b-usb-uhci",
1311 .parent
= TYPE_PCI_DEVICE
,
1312 .instance_size
= sizeof(UHCIState
),
1313 .class_init
= vt82c686b_uhci_class_init
,
1316 static void ich9_uhci1_class_init(ObjectClass
*klass
, void *data
)
1318 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1319 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1321 k
->init
= usb_uhci_common_initfn
;
1322 k
->vendor_id
= PCI_VENDOR_ID_INTEL
;
1323 k
->device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI1
;
1325 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1326 dc
->vmsd
= &vmstate_uhci
;
1327 dc
->props
= uhci_properties
;
1330 static TypeInfo ich9_uhci1_info
= {
1331 .name
= "ich9-usb-uhci1",
1332 .parent
= TYPE_PCI_DEVICE
,
1333 .instance_size
= sizeof(UHCIState
),
1334 .class_init
= ich9_uhci1_class_init
,
1337 static void ich9_uhci2_class_init(ObjectClass
*klass
, void *data
)
1339 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1340 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1342 k
->init
= usb_uhci_common_initfn
;
1343 k
->vendor_id
= PCI_VENDOR_ID_INTEL
;
1344 k
->device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI2
;
1346 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1347 dc
->vmsd
= &vmstate_uhci
;
1348 dc
->props
= uhci_properties
;
1351 static TypeInfo ich9_uhci2_info
= {
1352 .name
= "ich9-usb-uhci2",
1353 .parent
= TYPE_PCI_DEVICE
,
1354 .instance_size
= sizeof(UHCIState
),
1355 .class_init
= ich9_uhci2_class_init
,
1358 static void ich9_uhci3_class_init(ObjectClass
*klass
, void *data
)
1360 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1361 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1363 k
->init
= usb_uhci_common_initfn
;
1364 k
->vendor_id
= PCI_VENDOR_ID_INTEL
;
1365 k
->device_id
= PCI_DEVICE_ID_INTEL_82801I_UHCI3
;
1367 k
->class_id
= PCI_CLASS_SERIAL_USB
;
1368 dc
->vmsd
= &vmstate_uhci
;
1369 dc
->props
= uhci_properties
;
1372 static TypeInfo ich9_uhci3_info
= {
1373 .name
= "ich9-usb-uhci3",
1374 .parent
= TYPE_PCI_DEVICE
,
1375 .instance_size
= sizeof(UHCIState
),
1376 .class_init
= ich9_uhci3_class_init
,
1379 static void uhci_register_types(void)
1381 type_register_static(&piix3_uhci_info
);
1382 type_register_static(&piix4_uhci_info
);
1383 type_register_static(&vt82c686b_uhci_info
);
1384 type_register_static(&ich9_uhci1_info
);
1385 type_register_static(&ich9_uhci2_info
);
1386 type_register_static(&ich9_uhci3_info
);
1389 type_init(uhci_register_types
)