1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28#include "qemu/osdep.h"
29#include "hw/hw.h"
30#include "hw/usb.h"
31#include "hw/usb/uhci-regs.h"
32#include "hw/pci/pci.h"
33#include "qapi/error.h"
34#include "qemu/timer.h"
35#include "qemu/iov.h"
36#include "sysemu/dma.h"
37#include "trace.h"
38#include "qemu/main-loop.h"
39
40#define FRAME_TIMER_FREQ 1000
41
42#define FRAME_MAX_LOOPS 256
43
44
45#define QH_VALID 32
46
47#define MAX_FRAMES_PER_TICK (QH_VALID / 2)
48
49#define NB_PORTS 2
50
51enum {
52 TD_RESULT_STOP_FRAME = 10,
53 TD_RESULT_COMPLETE,
54 TD_RESULT_NEXT_QH,
55 TD_RESULT_ASYNC_START,
56 TD_RESULT_ASYNC_CONT,
57};
58
59typedef struct UHCIState UHCIState;
60typedef struct UHCIAsync UHCIAsync;
61typedef struct UHCIQueue UHCIQueue;
62typedef struct UHCIInfo UHCIInfo;
63typedef struct UHCIPCIDeviceClass UHCIPCIDeviceClass;
64
65struct UHCIInfo {
66 const char *name;
67 uint16_t vendor_id;
68 uint16_t device_id;
69 uint8_t revision;
70 uint8_t irq_pin;
71 void (*realize)(PCIDevice *dev, Error **errp);
72 bool unplug;
73};
74
75struct UHCIPCIDeviceClass {
76 PCIDeviceClass parent_class;
77 UHCIInfo info;
78};
79
80
81
82
83
84
85
86struct UHCIAsync {
87 USBPacket packet;
88 uint8_t static_buf[64];
89 uint8_t *buf;
90 UHCIQueue *queue;
91 QTAILQ_ENTRY(UHCIAsync) next;
92 uint32_t td_addr;
93 uint8_t done;
94};
95
96struct UHCIQueue {
97 uint32_t qh_addr;
98 uint32_t token;
99 UHCIState *uhci;
100 USBEndpoint *ep;
101 QTAILQ_ENTRY(UHCIQueue) next;
102 QTAILQ_HEAD(, UHCIAsync) asyncs;
103 int8_t valid;
104};
105
106typedef struct UHCIPort {
107 USBPort port;
108 uint16_t ctrl;
109} UHCIPort;
110
111struct UHCIState {
112 PCIDevice dev;
113 MemoryRegion io_bar;
114 USBBus bus;
115 uint16_t cmd;
116 uint16_t status;
117 uint16_t intr;
118 uint16_t frnum;
119 uint32_t fl_base_addr;
120 uint8_t sof_timing;
121 uint8_t status2;
122 int64_t expire_time;
123 QEMUTimer *frame_timer;
124 QEMUBH *bh;
125 uint32_t frame_bytes;
126 uint32_t frame_bandwidth;
127 bool completions_only;
128 UHCIPort ports[NB_PORTS];
129
130
131 uint32_t pending_int_mask;
132
133
134 QTAILQ_HEAD(, UHCIQueue) queues;
135 uint8_t num_ports_vmstate;
136
137
138 char *masterbus;
139 uint32_t firstport;
140 uint32_t maxframes;
141};
142
143typedef struct UHCI_TD {
144 uint32_t link;
145 uint32_t ctrl;
146 uint32_t token;
147 uint32_t buffer;
148} UHCI_TD;
149
150typedef struct UHCI_QH {
151 uint32_t link;
152 uint32_t el_link;
153} UHCI_QH;
154
155static void uhci_async_cancel(UHCIAsync *async);
156static void uhci_queue_fill(UHCIQueue *q, UHCI_TD *td);
157static void uhci_resume(void *opaque);
158
159#define TYPE_UHCI "pci-uhci-usb"
160#define UHCI(obj) OBJECT_CHECK(UHCIState, (obj), TYPE_UHCI)
161
162static inline int32_t uhci_queue_token(UHCI_TD *td)
163{
164 if ((td->token & (0xf << 15)) == 0) {
165
166 return td->token & 0x7ff00;
167 } else {
168
169 return td->token & 0x7ffff;
170 }
171}
172
173static UHCIQueue *uhci_queue_new(UHCIState *s, uint32_t qh_addr, UHCI_TD *td,
174 USBEndpoint *ep)
175{
176 UHCIQueue *queue;
177
178 queue = g_new0(UHCIQueue, 1);
179 queue->uhci = s;
180 queue->qh_addr = qh_addr;
181 queue->token = uhci_queue_token(td);
182 queue->ep = ep;
183 QTAILQ_INIT(&queue->asyncs);
184 QTAILQ_INSERT_HEAD(&s->queues, queue, next);
185 queue->valid = QH_VALID;
186 trace_usb_uhci_queue_add(queue->token);
187 return queue;
188}
189
190static void uhci_queue_free(UHCIQueue *queue, const char *reason)
191{
192 UHCIState *s = queue->uhci;
193 UHCIAsync *async;
194
195 while (!QTAILQ_EMPTY(&queue->asyncs)) {
196 async = QTAILQ_FIRST(&queue->asyncs);
197 uhci_async_cancel(async);
198 }
199 usb_device_ep_stopped(queue->ep->dev, queue->ep);
200
201 trace_usb_uhci_queue_del(queue->token, reason);
202 QTAILQ_REMOVE(&s->queues, queue, next);
203 g_free(queue);
204}
205
206static UHCIQueue *uhci_queue_find(UHCIState *s, UHCI_TD *td)
207{
208 uint32_t token = uhci_queue_token(td);
209 UHCIQueue *queue;
210
211 QTAILQ_FOREACH(queue, &s->queues, next) {
212 if (queue->token == token) {
213 return queue;
214 }
215 }
216 return NULL;
217}
218
219static bool uhci_queue_verify(UHCIQueue *queue, uint32_t qh_addr, UHCI_TD *td,
220 uint32_t td_addr, bool queuing)
221{
222 UHCIAsync *first = QTAILQ_FIRST(&queue->asyncs);
223 uint32_t queue_token_addr = (queue->token >> 8) & 0x7f;
224
225 return queue->qh_addr == qh_addr &&
226 queue->token == uhci_queue_token(td) &&
227 queue_token_addr == queue->ep->dev->addr &&
228 (queuing || !(td->ctrl & TD_CTRL_ACTIVE) || first == NULL ||
229 first->td_addr == td_addr);
230}
231
232static UHCIAsync *uhci_async_alloc(UHCIQueue *queue, uint32_t td_addr)
233{
234 UHCIAsync *async = g_new0(UHCIAsync, 1);
235
236 async->queue = queue;
237 async->td_addr = td_addr;
238 usb_packet_init(&async->packet);
239 trace_usb_uhci_packet_add(async->queue->token, async->td_addr);
240
241 return async;
242}
243
244static void uhci_async_free(UHCIAsync *async)
245{
246 trace_usb_uhci_packet_del(async->queue->token, async->td_addr);
247 usb_packet_cleanup(&async->packet);
248 if (async->buf != async->static_buf) {
249 g_free(async->buf);
250 }
251 g_free(async);
252}
253
254static void uhci_async_link(UHCIAsync *async)
255{
256 UHCIQueue *queue = async->queue;
257 QTAILQ_INSERT_TAIL(&queue->asyncs, async, next);
258 trace_usb_uhci_packet_link_async(async->queue->token, async->td_addr);
259}
260
261static void uhci_async_unlink(UHCIAsync *async)
262{
263 UHCIQueue *queue = async->queue;
264 QTAILQ_REMOVE(&queue->asyncs, async, next);
265 trace_usb_uhci_packet_unlink_async(async->queue->token, async->td_addr);
266}
267
268static void uhci_async_cancel(UHCIAsync *async)
269{
270 uhci_async_unlink(async);
271 trace_usb_uhci_packet_cancel(async->queue->token, async->td_addr,
272 async->done);
273 if (!async->done)
274 usb_cancel_packet(&async->packet);
275 uhci_async_free(async);
276}
277
278
279
280
281
282static void uhci_async_validate_begin(UHCIState *s)
283{
284 UHCIQueue *queue;
285
286 QTAILQ_FOREACH(queue, &s->queues, next) {
287 queue->valid--;
288 }
289}
290
291
292
293
294static void uhci_async_validate_end(UHCIState *s)
295{
296 UHCIQueue *queue, *n;
297
298 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, n) {
299 if (!queue->valid) {
300 uhci_queue_free(queue, "validate-end");
301 }
302 }
303}
304
305static void uhci_async_cancel_device(UHCIState *s, USBDevice *dev)
306{
307 UHCIQueue *queue, *n;
308
309 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, n) {
310 if (queue->ep->dev == dev) {
311 uhci_queue_free(queue, "cancel-device");
312 }
313 }
314}
315
316static void uhci_async_cancel_all(UHCIState *s)
317{
318 UHCIQueue *queue, *nq;
319
320 QTAILQ_FOREACH_SAFE(queue, &s->queues, next, nq) {
321 uhci_queue_free(queue, "cancel-all");
322 }
323}
324
325static UHCIAsync *uhci_async_find_td(UHCIState *s, uint32_t td_addr)
326{
327 UHCIQueue *queue;
328 UHCIAsync *async;
329
330 QTAILQ_FOREACH(queue, &s->queues, next) {
331 QTAILQ_FOREACH(async, &queue->asyncs, next) {
332 if (async->td_addr == td_addr) {
333 return async;
334 }
335 }
336 }
337 return NULL;
338}
339
340static void uhci_update_irq(UHCIState *s)
341{
342 int level;
343 if (((s->status2 & 1) && (s->intr & (1 << 2))) ||
344 ((s->status2 & 2) && (s->intr & (1 << 3))) ||
345 ((s->status & UHCI_STS_USBERR) && (s->intr & (1 << 0))) ||
346 ((s->status & UHCI_STS_RD) && (s->intr & (1 << 1))) ||
347 (s->status & UHCI_STS_HSERR) ||
348 (s->status & UHCI_STS_HCPERR)) {
349 level = 1;
350 } else {
351 level = 0;
352 }
353 pci_set_irq(&s->dev, level);
354}
355
356static void uhci_reset(DeviceState *dev)
357{
358 PCIDevice *d = PCI_DEVICE(dev);
359 UHCIState *s = UHCI(d);
360 uint8_t *pci_conf;
361 int i;
362 UHCIPort *port;
363
364 trace_usb_uhci_reset();
365
366 pci_conf = s->dev.config;
367
368 pci_conf[0x6a] = 0x01;
369 pci_conf[0x6b] = 0x00;
370 s->cmd = 0;
371 s->status = UHCI_STS_HCHALTED;
372 s->status2 = 0;
373 s->intr = 0;
374 s->fl_base_addr = 0;
375 s->sof_timing = 64;
376
377 for(i = 0; i < NB_PORTS; i++) {
378 port = &s->ports[i];
379 port->ctrl = 0x0080;
380 if (port->port.dev && port->port.dev->attached) {
381 usb_port_reset(&port->port);
382 }
383 }
384
385 uhci_async_cancel_all(s);
386 qemu_bh_cancel(s->bh);
387 uhci_update_irq(s);
388}
389
390static const VMStateDescription vmstate_uhci_port = {
391 .name = "uhci port",
392 .version_id = 1,
393 .minimum_version_id = 1,
394 .fields = (VMStateField[]) {
395 VMSTATE_UINT16(ctrl, UHCIPort),
396 VMSTATE_END_OF_LIST()
397 }
398};
399
400static int uhci_post_load(void *opaque, int version_id)
401{
402 UHCIState *s = opaque;
403
404 if (version_id < 2) {
405 s->expire_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
406 (NANOSECONDS_PER_SECOND / FRAME_TIMER_FREQ);
407 }
408 return 0;
409}
410
411static const VMStateDescription vmstate_uhci = {
412 .name = "uhci",
413 .version_id = 3,
414 .minimum_version_id = 1,
415 .post_load = uhci_post_load,
416 .fields = (VMStateField[]) {
417 VMSTATE_PCI_DEVICE(dev, UHCIState),
418 VMSTATE_UINT8_EQUAL(num_ports_vmstate, UHCIState, NULL),
419 VMSTATE_STRUCT_ARRAY(ports, UHCIState, NB_PORTS, 1,
420 vmstate_uhci_port, UHCIPort),
421 VMSTATE_UINT16(cmd, UHCIState),
422 VMSTATE_UINT16(status, UHCIState),
423 VMSTATE_UINT16(intr, UHCIState),
424 VMSTATE_UINT16(frnum, UHCIState),
425 VMSTATE_UINT32(fl_base_addr, UHCIState),
426 VMSTATE_UINT8(sof_timing, UHCIState),
427 VMSTATE_UINT8(status2, UHCIState),
428 VMSTATE_TIMER_PTR(frame_timer, UHCIState),
429 VMSTATE_INT64_V(expire_time, UHCIState, 2),
430 VMSTATE_UINT32_V(pending_int_mask, UHCIState, 3),
431 VMSTATE_END_OF_LIST()
432 }
433};
434
435static void uhci_port_write(void *opaque, hwaddr addr,
436 uint64_t val, unsigned size)
437{
438 UHCIState *s = opaque;
439
440 trace_usb_uhci_mmio_writew(addr, val);
441
442 switch(addr) {
443 case 0x00:
444 if ((val & UHCI_CMD_RS) && !(s->cmd & UHCI_CMD_RS)) {
445
446 trace_usb_uhci_schedule_start();
447 s->expire_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
448 (NANOSECONDS_PER_SECOND / FRAME_TIMER_FREQ);
449 timer_mod(s->frame_timer, s->expire_time);
450 s->status &= ~UHCI_STS_HCHALTED;
451 } else if (!(val & UHCI_CMD_RS)) {
452 s->status |= UHCI_STS_HCHALTED;
453 }
454 if (val & UHCI_CMD_GRESET) {
455 UHCIPort *port;
456 int i;
457
458
459 for(i = 0; i < NB_PORTS; i++) {
460 port = &s->ports[i];
461 usb_device_reset(port->port.dev);
462 }
463 uhci_reset(DEVICE(s));
464 return;
465 }
466 if (val & UHCI_CMD_HCRESET) {
467 uhci_reset(DEVICE(s));
468 return;
469 }
470 s->cmd = val;
471 if (val & UHCI_CMD_EGSM) {
472 if ((s->ports[0].ctrl & UHCI_PORT_RD) ||
473 (s->ports[1].ctrl & UHCI_PORT_RD)) {
474 uhci_resume(s);
475 }
476 }
477 break;
478 case 0x02:
479 s->status &= ~val;
480
481
482 if (val & UHCI_STS_USBINT)
483 s->status2 = 0;
484 uhci_update_irq(s);
485 break;
486 case 0x04:
487 s->intr = val;
488 uhci_update_irq(s);
489 break;
490 case 0x06:
491 if (s->status & UHCI_STS_HCHALTED)
492 s->frnum = val & 0x7ff;
493 break;
494 case 0x08:
495 s->fl_base_addr &= 0xffff0000;
496 s->fl_base_addr |= val & ~0xfff;
497 break;
498 case 0x0a:
499 s->fl_base_addr &= 0x0000ffff;
500 s->fl_base_addr |= (val << 16);
501 break;
502 case 0x0c:
503 s->sof_timing = val & 0xff;
504 break;
505 case 0x10 ... 0x1f:
506 {
507 UHCIPort *port;
508 USBDevice *dev;
509 int n;
510
511 n = (addr >> 1) & 7;
512 if (n >= NB_PORTS)
513 return;
514 port = &s->ports[n];
515 dev = port->port.dev;
516 if (dev && dev->attached) {
517
518 if ( (val & UHCI_PORT_RESET) &&
519 !(port->ctrl & UHCI_PORT_RESET) ) {
520 usb_device_reset(dev);
521 }
522 }
523 port->ctrl &= UHCI_PORT_READ_ONLY;
524
525 if (!(port->ctrl & UHCI_PORT_CCS)) {
526 val &= ~UHCI_PORT_EN;
527 }
528 port->ctrl |= (val & ~UHCI_PORT_READ_ONLY);
529
530 port->ctrl &= ~(val & UHCI_PORT_WRITE_CLEAR);
531 }
532 break;
533 }
534}
535
536static uint64_t uhci_port_read(void *opaque, hwaddr addr, unsigned size)
537{
538 UHCIState *s = opaque;
539 uint32_t val;
540
541 switch(addr) {
542 case 0x00:
543 val = s->cmd;
544 break;
545 case 0x02:
546 val = s->status;
547 break;
548 case 0x04:
549 val = s->intr;
550 break;
551 case 0x06:
552 val = s->frnum;
553 break;
554 case 0x08:
555 val = s->fl_base_addr & 0xffff;
556 break;
557 case 0x0a:
558 val = (s->fl_base_addr >> 16) & 0xffff;
559 break;
560 case 0x0c:
561 val = s->sof_timing;
562 break;
563 case 0x10 ... 0x1f:
564 {
565 UHCIPort *port;
566 int n;
567 n = (addr >> 1) & 7;
568 if (n >= NB_PORTS)
569 goto read_default;
570 port = &s->ports[n];
571 val = port->ctrl;
572 }
573 break;
574 default:
575 read_default:
576 val = 0xff7f;
577 break;
578 }
579
580 trace_usb_uhci_mmio_readw(addr, val);
581
582 return val;
583}
584
585
586static void uhci_resume (void *opaque)
587{
588 UHCIState *s = (UHCIState *)opaque;
589
590 if (!s)
591 return;
592
593 if (s->cmd & UHCI_CMD_EGSM) {
594 s->cmd |= UHCI_CMD_FGR;
595 s->status |= UHCI_STS_RD;
596 uhci_update_irq(s);
597 }
598}
599
600static void uhci_attach(USBPort *port1)
601{
602 UHCIState *s = port1->opaque;
603 UHCIPort *port = &s->ports[port1->index];
604
605
606 port->ctrl |= UHCI_PORT_CCS | UHCI_PORT_CSC;
607
608
609 if (port->port.dev->speed == USB_SPEED_LOW) {
610 port->ctrl |= UHCI_PORT_LSDA;
611 } else {
612 port->ctrl &= ~UHCI_PORT_LSDA;
613 }
614
615 uhci_resume(s);
616}
617
618static void uhci_detach(USBPort *port1)
619{
620 UHCIState *s = port1->opaque;
621 UHCIPort *port = &s->ports[port1->index];
622
623 uhci_async_cancel_device(s, port1->dev);
624
625
626 if (port->ctrl & UHCI_PORT_CCS) {
627 port->ctrl &= ~UHCI_PORT_CCS;
628 port->ctrl |= UHCI_PORT_CSC;
629 }
630
631 if (port->ctrl & UHCI_PORT_EN) {
632 port->ctrl &= ~UHCI_PORT_EN;
633 port->ctrl |= UHCI_PORT_ENC;
634 }
635
636 uhci_resume(s);
637}
638
639static void uhci_child_detach(USBPort *port1, USBDevice *child)
640{
641 UHCIState *s = port1->opaque;
642
643 uhci_async_cancel_device(s, child);
644}
645
646static void uhci_wakeup(USBPort *port1)
647{
648 UHCIState *s = port1->opaque;
649 UHCIPort *port = &s->ports[port1->index];
650
651 if (port->ctrl & UHCI_PORT_SUSPEND && !(port->ctrl & UHCI_PORT_RD)) {
652 port->ctrl |= UHCI_PORT_RD;
653 uhci_resume(s);
654 }
655}
656
657static USBDevice *uhci_find_device(UHCIState *s, uint8_t addr)
658{
659 USBDevice *dev;
660 int i;
661
662 for (i = 0; i < NB_PORTS; i++) {
663 UHCIPort *port = &s->ports[i];
664 if (!(port->ctrl & UHCI_PORT_EN)) {
665 continue;
666 }
667 dev = usb_find_device(&port->port, addr);
668 if (dev != NULL) {
669 return dev;
670 }
671 }
672 return NULL;
673}
674
675static void uhci_read_td(UHCIState *s, UHCI_TD *td, uint32_t link)
676{
677 pci_dma_read(&s->dev, link & ~0xf, td, sizeof(*td));
678 le32_to_cpus(&td->link);
679 le32_to_cpus(&td->ctrl);
680 le32_to_cpus(&td->token);
681 le32_to_cpus(&td->buffer);
682}
683
684static int uhci_handle_td_error(UHCIState *s, UHCI_TD *td, uint32_t td_addr,
685 int status, uint32_t *int_mask)
686{
687 uint32_t queue_token = uhci_queue_token(td);
688 int ret;
689
690 switch (status) {
691 case USB_RET_NAK:
692 td->ctrl |= TD_CTRL_NAK;
693 return TD_RESULT_NEXT_QH;
694
695 case USB_RET_STALL:
696 td->ctrl |= TD_CTRL_STALL;
697 trace_usb_uhci_packet_complete_stall(queue_token, td_addr);
698 ret = TD_RESULT_NEXT_QH;
699 break;
700
701 case USB_RET_BABBLE:
702 td->ctrl |= TD_CTRL_BABBLE | TD_CTRL_STALL;
703
704 trace_usb_uhci_packet_complete_babble(queue_token, td_addr);
705 ret = TD_RESULT_STOP_FRAME;
706 break;
707
708 case USB_RET_IOERROR:
709 case USB_RET_NODEV:
710 default:
711 td->ctrl |= TD_CTRL_TIMEOUT;
712 td->ctrl &= ~(3 << TD_CTRL_ERROR_SHIFT);
713 trace_usb_uhci_packet_complete_error(queue_token, td_addr);
714 ret = TD_RESULT_NEXT_QH;
715 break;
716 }
717
718 td->ctrl &= ~TD_CTRL_ACTIVE;
719 s->status |= UHCI_STS_USBERR;
720 if (td->ctrl & TD_CTRL_IOC) {
721 *int_mask |= 0x01;
722 }
723 uhci_update_irq(s);
724 return ret;
725}
726
727static int uhci_complete_td(UHCIState *s, UHCI_TD *td, UHCIAsync *async, uint32_t *int_mask)
728{
729 int len = 0, max_len;
730 uint8_t pid;
731
732 max_len = ((td->token >> 21) + 1) & 0x7ff;
733 pid = td->token & 0xff;
734
735 if (td->ctrl & TD_CTRL_IOS)
736 td->ctrl &= ~TD_CTRL_ACTIVE;
737
738 if (async->packet.status != USB_RET_SUCCESS) {
739 return uhci_handle_td_error(s, td, async->td_addr,
740 async->packet.status, int_mask);
741 }
742
743 len = async->packet.actual_length;
744 td->ctrl = (td->ctrl & ~0x7ff) | ((len - 1) & 0x7ff);
745
746
747
748
749 td->ctrl &= ~(TD_CTRL_ACTIVE | TD_CTRL_NAK);
750 if (td->ctrl & TD_CTRL_IOC)
751 *int_mask |= 0x01;
752
753 if (pid == USB_TOKEN_IN) {
754 pci_dma_write(&s->dev, td->buffer, async->buf, len);
755 if ((td->ctrl & TD_CTRL_SPD) && len < max_len) {
756 *int_mask |= 0x02;
757
758 trace_usb_uhci_packet_complete_shortxfer(async->queue->token,
759 async->td_addr);
760 return TD_RESULT_NEXT_QH;
761 }
762 }
763
764
765 trace_usb_uhci_packet_complete_success(async->queue->token,
766 async->td_addr);
767 return TD_RESULT_COMPLETE;
768}
769
770static int uhci_handle_td(UHCIState *s, UHCIQueue *q, uint32_t qh_addr,
771 UHCI_TD *td, uint32_t td_addr, uint32_t *int_mask)
772{
773 int ret, max_len;
774 bool spd;
775 bool queuing = (q != NULL);
776 uint8_t pid = td->token & 0xff;
777 UHCIAsync *async;
778
779 async = uhci_async_find_td(s, td_addr);
780 if (async) {
781 if (uhci_queue_verify(async->queue, qh_addr, td, td_addr, queuing)) {
782 assert(q == NULL || q == async->queue);
783 q = async->queue;
784 } else {
785 uhci_queue_free(async->queue, "guest re-used pending td");
786 async = NULL;
787 }
788 }
789
790 if (q == NULL) {
791 q = uhci_queue_find(s, td);
792 if (q && !uhci_queue_verify(q, qh_addr, td, td_addr, queuing)) {
793 uhci_queue_free(q, "guest re-used qh");
794 q = NULL;
795 }
796 }
797
798 if (q) {
799 q->valid = QH_VALID;
800 }
801
802
803 if (!(td->ctrl & TD_CTRL_ACTIVE)) {
804 if (async) {
805
806 uhci_queue_free(async->queue, "pending td non-active");
807 }
808
809
810
811
812 if (td->ctrl & TD_CTRL_IOC) {
813 *int_mask |= 0x01;
814 }
815 return TD_RESULT_NEXT_QH;
816 }
817
818 switch (pid) {
819 case USB_TOKEN_OUT:
820 case USB_TOKEN_SETUP:
821 case USB_TOKEN_IN:
822 break;
823 default:
824
825 s->status |= UHCI_STS_HCPERR;
826 s->cmd &= ~UHCI_CMD_RS;
827 uhci_update_irq(s);
828 return TD_RESULT_STOP_FRAME;
829 }
830
831 if (async) {
832 if (queuing) {
833
834
835
836 return TD_RESULT_ASYNC_CONT;
837 }
838 if (!async->done) {
839 UHCI_TD last_td;
840 UHCIAsync *last = QTAILQ_LAST(&async->queue->asyncs);
841
842
843
844
845
846 uhci_read_td(s, &last_td, last->td_addr);
847 uhci_queue_fill(async->queue, &last_td);
848
849 return TD_RESULT_ASYNC_CONT;
850 }
851 uhci_async_unlink(async);
852 goto done;
853 }
854
855 if (s->completions_only) {
856 return TD_RESULT_ASYNC_CONT;
857 }
858
859
860 if (q == NULL) {
861 USBDevice *dev;
862 USBEndpoint *ep;
863
864 dev = uhci_find_device(s, (td->token >> 8) & 0x7f);
865 if (dev == NULL) {
866 return uhci_handle_td_error(s, td, td_addr, USB_RET_NODEV,
867 int_mask);
868 }
869 ep = usb_ep_get(dev, pid, (td->token >> 15) & 0xf);
870 q = uhci_queue_new(s, qh_addr, td, ep);
871 }
872 async = uhci_async_alloc(q, td_addr);
873
874 max_len = ((td->token >> 21) + 1) & 0x7ff;
875 spd = (pid == USB_TOKEN_IN && (td->ctrl & TD_CTRL_SPD) != 0);
876 usb_packet_setup(&async->packet, pid, q->ep, 0, td_addr, spd,
877 (td->ctrl & TD_CTRL_IOC) != 0);
878 if (max_len <= sizeof(async->static_buf)) {
879 async->buf = async->static_buf;
880 } else {
881 async->buf = g_malloc(max_len);
882 }
883 usb_packet_addbuf(&async->packet, async->buf, max_len);
884
885 switch(pid) {
886 case USB_TOKEN_OUT:
887 case USB_TOKEN_SETUP:
888 pci_dma_read(&s->dev, td->buffer, async->buf, max_len);
889 usb_handle_packet(q->ep->dev, &async->packet);
890 if (async->packet.status == USB_RET_SUCCESS) {
891 async->packet.actual_length = max_len;
892 }
893 break;
894
895 case USB_TOKEN_IN:
896 usb_handle_packet(q->ep->dev, &async->packet);
897 break;
898
899 default:
900 abort();
901 }
902
903 if (async->packet.status == USB_RET_ASYNC) {
904 uhci_async_link(async);
905 if (!queuing) {
906 uhci_queue_fill(q, td);
907 }
908 return TD_RESULT_ASYNC_START;
909 }
910
911done:
912 ret = uhci_complete_td(s, td, async, int_mask);
913 uhci_async_free(async);
914 return ret;
915}
916
917static void uhci_async_complete(USBPort *port, USBPacket *packet)
918{
919 UHCIAsync *async = container_of(packet, UHCIAsync, packet);
920 UHCIState *s = async->queue->uhci;
921
922 if (packet->status == USB_RET_REMOVE_FROM_QUEUE) {
923 uhci_async_cancel(async);
924 return;
925 }
926
927 async->done = 1;
928
929 s->completions_only = true;
930 qemu_bh_schedule(s->bh);
931}
932
933static int is_valid(uint32_t link)
934{
935 return (link & 1) == 0;
936}
937
938static int is_qh(uint32_t link)
939{
940 return (link & 2) != 0;
941}
942
943static int depth_first(uint32_t link)
944{
945 return (link & 4) != 0;
946}
947
948
949#define UHCI_MAX_QUEUES 128
950typedef struct {
951 uint32_t addr[UHCI_MAX_QUEUES];
952 int count;
953} QhDb;
954
955static void qhdb_reset(QhDb *db)
956{
957 db->count = 0;
958}
959
960
961static int qhdb_insert(QhDb *db, uint32_t addr)
962{
963 int i;
964 for (i = 0; i < db->count; i++)
965 if (db->addr[i] == addr)
966 return 1;
967
968 if (db->count >= UHCI_MAX_QUEUES)
969 return 1;
970
971 db->addr[db->count++] = addr;
972 return 0;
973}
974
975static void uhci_queue_fill(UHCIQueue *q, UHCI_TD *td)
976{
977 uint32_t int_mask = 0;
978 uint32_t plink = td->link;
979 UHCI_TD ptd;
980 int ret;
981
982 while (is_valid(plink)) {
983 uhci_read_td(q->uhci, &ptd, plink);
984 if (!(ptd.ctrl & TD_CTRL_ACTIVE)) {
985 break;
986 }
987 if (uhci_queue_token(&ptd) != q->token) {
988 break;
989 }
990 trace_usb_uhci_td_queue(plink & ~0xf, ptd.ctrl, ptd.token);
991 ret = uhci_handle_td(q->uhci, q, q->qh_addr, &ptd, plink, &int_mask);
992 if (ret == TD_RESULT_ASYNC_CONT) {
993 break;
994 }
995 assert(ret == TD_RESULT_ASYNC_START);
996 assert(int_mask == 0);
997 plink = ptd.link;
998 }
999 usb_device_flush_ep_queue(q->ep->dev, q->ep);
1000}
1001
1002static void uhci_process_frame(UHCIState *s)
1003{
1004 uint32_t frame_addr, link, old_td_ctrl, val, int_mask;
1005 uint32_t curr_qh, td_count = 0;
1006 int cnt, ret;
1007 UHCI_TD td;
1008 UHCI_QH qh;
1009 QhDb qhdb;
1010
1011 frame_addr = s->fl_base_addr + ((s->frnum & 0x3ff) << 2);
1012
1013 pci_dma_read(&s->dev, frame_addr, &link, 4);
1014 le32_to_cpus(&link);
1015
1016 int_mask = 0;
1017 curr_qh = 0;
1018
1019 qhdb_reset(&qhdb);
1020
1021 for (cnt = FRAME_MAX_LOOPS; is_valid(link) && cnt; cnt--) {
1022 if (!s->completions_only && s->frame_bytes >= s->frame_bandwidth) {
1023
1024
1025 trace_usb_uhci_frame_stop_bandwidth();
1026 break;
1027 }
1028 if (is_qh(link)) {
1029
1030 trace_usb_uhci_qh_load(link & ~0xf);
1031
1032 if (qhdb_insert(&qhdb, link)) {
1033
1034
1035
1036
1037
1038
1039
1040 if (td_count == 0) {
1041 trace_usb_uhci_frame_loop_stop_idle();
1042 break;
1043 } else {
1044 trace_usb_uhci_frame_loop_continue();
1045 td_count = 0;
1046 qhdb_reset(&qhdb);
1047 qhdb_insert(&qhdb, link);
1048 }
1049 }
1050
1051 pci_dma_read(&s->dev, link & ~0xf, &qh, sizeof(qh));
1052 le32_to_cpus(&qh.link);
1053 le32_to_cpus(&qh.el_link);
1054
1055 if (!is_valid(qh.el_link)) {
1056
1057 curr_qh = 0;
1058 link = qh.link;
1059 } else {
1060
1061 curr_qh = link;
1062 link = qh.el_link;
1063 }
1064 continue;
1065 }
1066
1067
1068 uhci_read_td(s, &td, link);
1069 trace_usb_uhci_td_load(curr_qh & ~0xf, link & ~0xf, td.ctrl, td.token);
1070
1071 old_td_ctrl = td.ctrl;
1072 ret = uhci_handle_td(s, NULL, curr_qh, &td, link, &int_mask);
1073 if (old_td_ctrl != td.ctrl) {
1074
1075 val = cpu_to_le32(td.ctrl);
1076 pci_dma_write(&s->dev, (link & ~0xf) + 4, &val, sizeof(val));
1077 }
1078
1079 switch (ret) {
1080 case TD_RESULT_STOP_FRAME:
1081 goto out;
1082
1083 case TD_RESULT_NEXT_QH:
1084 case TD_RESULT_ASYNC_CONT:
1085 trace_usb_uhci_td_nextqh(curr_qh & ~0xf, link & ~0xf);
1086 link = curr_qh ? qh.link : td.link;
1087 continue;
1088
1089 case TD_RESULT_ASYNC_START:
1090 trace_usb_uhci_td_async(curr_qh & ~0xf, link & ~0xf);
1091 link = curr_qh ? qh.link : td.link;
1092 continue;
1093
1094 case TD_RESULT_COMPLETE:
1095 trace_usb_uhci_td_complete(curr_qh & ~0xf, link & ~0xf);
1096 link = td.link;
1097 td_count++;
1098 s->frame_bytes += (td.ctrl & 0x7ff) + 1;
1099
1100 if (curr_qh) {
1101
1102 qh.el_link = link;
1103 val = cpu_to_le32(qh.el_link);
1104 pci_dma_write(&s->dev, (curr_qh & ~0xf) + 4, &val, sizeof(val));
1105
1106 if (!depth_first(link)) {
1107
1108 curr_qh = 0;
1109 link = qh.link;
1110 }
1111 }
1112 break;
1113
1114 default:
1115 assert(!"unknown return code");
1116 }
1117
1118
1119 }
1120
1121out:
1122 s->pending_int_mask |= int_mask;
1123}
1124
1125static void uhci_bh(void *opaque)
1126{
1127 UHCIState *s = opaque;
1128 uhci_process_frame(s);
1129}
1130
1131static void uhci_frame_timer(void *opaque)
1132{
1133 UHCIState *s = opaque;
1134 uint64_t t_now, t_last_run;
1135 int i, frames;
1136 const uint64_t frame_t = NANOSECONDS_PER_SECOND / FRAME_TIMER_FREQ;
1137
1138 s->completions_only = false;
1139 qemu_bh_cancel(s->bh);
1140
1141 if (!(s->cmd & UHCI_CMD_RS)) {
1142
1143 trace_usb_uhci_schedule_stop();
1144 timer_del(s->frame_timer);
1145 uhci_async_cancel_all(s);
1146
1147 s->status |= UHCI_STS_HCHALTED;
1148 return;
1149 }
1150
1151
1152 t_last_run = s->expire_time - frame_t;
1153 t_now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1154
1155
1156 frames = (t_now - t_last_run) / frame_t;
1157 if (frames > s->maxframes) {
1158 int skipped = frames - s->maxframes;
1159 s->expire_time += skipped * frame_t;
1160 s->frnum = (s->frnum + skipped) & 0x7ff;
1161 frames -= skipped;
1162 }
1163 if (frames > MAX_FRAMES_PER_TICK) {
1164 frames = MAX_FRAMES_PER_TICK;
1165 }
1166
1167 for (i = 0; i < frames; i++) {
1168 s->frame_bytes = 0;
1169 trace_usb_uhci_frame_start(s->frnum);
1170 uhci_async_validate_begin(s);
1171 uhci_process_frame(s);
1172 uhci_async_validate_end(s);
1173
1174
1175 s->frnum = (s->frnum + 1) & 0x7ff;
1176 s->expire_time += frame_t;
1177 }
1178
1179
1180 if (s->pending_int_mask) {
1181 s->status2 |= s->pending_int_mask;
1182 s->status |= UHCI_STS_USBINT;
1183 uhci_update_irq(s);
1184 }
1185 s->pending_int_mask = 0;
1186
1187 timer_mod(s->frame_timer, t_now + frame_t);
1188}
1189
1190static const MemoryRegionOps uhci_ioport_ops = {
1191 .read = uhci_port_read,
1192 .write = uhci_port_write,
1193 .valid.min_access_size = 1,
1194 .valid.max_access_size = 4,
1195 .impl.min_access_size = 2,
1196 .impl.max_access_size = 2,
1197 .endianness = DEVICE_LITTLE_ENDIAN,
1198};
1199
1200static USBPortOps uhci_port_ops = {
1201 .attach = uhci_attach,
1202 .detach = uhci_detach,
1203 .child_detach = uhci_child_detach,
1204 .wakeup = uhci_wakeup,
1205 .complete = uhci_async_complete,
1206};
1207
1208static USBBusOps uhci_bus_ops = {
1209};
1210
1211static void usb_uhci_common_realize(PCIDevice *dev, Error **errp)
1212{
1213 Error *err = NULL;
1214 PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(dev);
1215 UHCIPCIDeviceClass *u = container_of(pc, UHCIPCIDeviceClass, parent_class);
1216 UHCIState *s = UHCI(dev);
1217 uint8_t *pci_conf = s->dev.config;
1218 int i;
1219
1220 pci_conf[PCI_CLASS_PROG] = 0x00;
1221
1222 pci_conf[USB_SBRN] = USB_RELEASE_1;
1223
1224 pci_config_set_interrupt_pin(pci_conf, u->info.irq_pin + 1);
1225
1226 if (s->masterbus) {
1227 USBPort *ports[NB_PORTS];
1228 for(i = 0; i < NB_PORTS; i++) {
1229 ports[i] = &s->ports[i].port;
1230 }
1231 usb_register_companion(s->masterbus, ports, NB_PORTS,
1232 s->firstport, s, &uhci_port_ops,
1233 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL,
1234 &err);
1235 if (err) {
1236 error_propagate(errp, err);
1237 return;
1238 }
1239 } else {
1240 usb_bus_new(&s->bus, sizeof(s->bus), &uhci_bus_ops, DEVICE(dev));
1241 for (i = 0; i < NB_PORTS; i++) {
1242 usb_register_port(&s->bus, &s->ports[i].port, s, i, &uhci_port_ops,
1243 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
1244 }
1245 }
1246 s->bh = qemu_bh_new(uhci_bh, s);
1247 s->frame_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, uhci_frame_timer, s);
1248 s->num_ports_vmstate = NB_PORTS;
1249 QTAILQ_INIT(&s->queues);
1250
1251 memory_region_init_io(&s->io_bar, OBJECT(s), &uhci_ioport_ops, s,
1252 "uhci", 0x20);
1253
1254
1255
1256 pci_register_bar(&s->dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &s->io_bar);
1257}
1258
1259static void usb_uhci_vt82c686b_realize(PCIDevice *dev, Error **errp)
1260{
1261 UHCIState *s = UHCI(dev);
1262 uint8_t *pci_conf = s->dev.config;
1263
1264
1265 pci_set_long(pci_conf + 0x40,0x00001000);
1266
1267 pci_set_long(pci_conf + 0x80,0x00020001);
1268
1269 pci_set_long(pci_conf + 0xc0,0x00002000);
1270
1271 usb_uhci_common_realize(dev, errp);
1272}
1273
1274static void usb_uhci_exit(PCIDevice *dev)
1275{
1276 UHCIState *s = UHCI(dev);
1277
1278 trace_usb_uhci_exit();
1279
1280 if (s->frame_timer) {
1281 timer_del(s->frame_timer);
1282 timer_free(s->frame_timer);
1283 s->frame_timer = NULL;
1284 }
1285
1286 if (s->bh) {
1287 qemu_bh_delete(s->bh);
1288 }
1289
1290 uhci_async_cancel_all(s);
1291
1292 if (!s->masterbus) {
1293 usb_bus_release(&s->bus);
1294 }
1295}
1296
1297static Property uhci_properties_companion[] = {
1298 DEFINE_PROP_STRING("masterbus", UHCIState, masterbus),
1299 DEFINE_PROP_UINT32("firstport", UHCIState, firstport, 0),
1300 DEFINE_PROP_UINT32("bandwidth", UHCIState, frame_bandwidth, 1280),
1301 DEFINE_PROP_UINT32("maxframes", UHCIState, maxframes, 128),
1302 DEFINE_PROP_END_OF_LIST(),
1303};
1304static Property uhci_properties_standalone[] = {
1305 DEFINE_PROP_UINT32("bandwidth", UHCIState, frame_bandwidth, 1280),
1306 DEFINE_PROP_UINT32("maxframes", UHCIState, maxframes, 128),
1307 DEFINE_PROP_END_OF_LIST(),
1308};
1309
1310static void uhci_class_init(ObjectClass *klass, void *data)
1311{
1312 DeviceClass *dc = DEVICE_CLASS(klass);
1313 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1314
1315 k->class_id = PCI_CLASS_SERIAL_USB;
1316 dc->vmsd = &vmstate_uhci;
1317 dc->reset = uhci_reset;
1318 set_bit(DEVICE_CATEGORY_USB, dc->categories);
1319}
1320
1321static const TypeInfo uhci_pci_type_info = {
1322 .name = TYPE_UHCI,
1323 .parent = TYPE_PCI_DEVICE,
1324 .instance_size = sizeof(UHCIState),
1325 .class_size = sizeof(UHCIPCIDeviceClass),
1326 .abstract = true,
1327 .class_init = uhci_class_init,
1328 .interfaces = (InterfaceInfo[]) {
1329 { INTERFACE_CONVENTIONAL_PCI_DEVICE },
1330 { },
1331 },
1332};
1333
1334static void uhci_data_class_init(ObjectClass *klass, void *data)
1335{
1336 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1337 DeviceClass *dc = DEVICE_CLASS(klass);
1338 UHCIPCIDeviceClass *u = container_of(k, UHCIPCIDeviceClass, parent_class);
1339 UHCIInfo *info = data;
1340
1341 k->realize = info->realize ? info->realize : usb_uhci_common_realize;
1342 k->exit = info->unplug ? usb_uhci_exit : NULL;
1343 k->vendor_id = info->vendor_id;
1344 k->device_id = info->device_id;
1345 k->revision = info->revision;
1346 if (!info->unplug) {
1347
1348 dc->hotpluggable = false;
1349 dc->props = uhci_properties_companion;
1350 } else {
1351 dc->props = uhci_properties_standalone;
1352 }
1353 u->info = *info;
1354}
1355
1356static UHCIInfo uhci_info[] = {
1357 {
1358 .name = "piix3-usb-uhci",
1359 .vendor_id = PCI_VENDOR_ID_INTEL,
1360 .device_id = PCI_DEVICE_ID_INTEL_82371SB_2,
1361 .revision = 0x01,
1362 .irq_pin = 3,
1363 .unplug = true,
1364 },{
1365 .name = "piix4-usb-uhci",
1366 .vendor_id = PCI_VENDOR_ID_INTEL,
1367 .device_id = PCI_DEVICE_ID_INTEL_82371AB_2,
1368 .revision = 0x01,
1369 .irq_pin = 3,
1370 .unplug = true,
1371 },{
1372 .name = "vt82c686b-usb-uhci",
1373 .vendor_id = PCI_VENDOR_ID_VIA,
1374 .device_id = PCI_DEVICE_ID_VIA_UHCI,
1375 .revision = 0x01,
1376 .irq_pin = 3,
1377 .realize = usb_uhci_vt82c686b_realize,
1378 .unplug = true,
1379 },{
1380 .name = "ich9-usb-uhci1",
1381 .vendor_id = PCI_VENDOR_ID_INTEL,
1382 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI1,
1383 .revision = 0x03,
1384 .irq_pin = 0,
1385 .unplug = false,
1386 },{
1387 .name = "ich9-usb-uhci2",
1388 .vendor_id = PCI_VENDOR_ID_INTEL,
1389 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI2,
1390 .revision = 0x03,
1391 .irq_pin = 1,
1392 .unplug = false,
1393 },{
1394 .name = "ich9-usb-uhci3",
1395 .vendor_id = PCI_VENDOR_ID_INTEL,
1396 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI3,
1397 .revision = 0x03,
1398 .irq_pin = 2,
1399 .unplug = false,
1400 },{
1401 .name = "ich9-usb-uhci4",
1402 .vendor_id = PCI_VENDOR_ID_INTEL,
1403 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI4,
1404 .revision = 0x03,
1405 .irq_pin = 0,
1406 .unplug = false,
1407 },{
1408 .name = "ich9-usb-uhci5",
1409 .vendor_id = PCI_VENDOR_ID_INTEL,
1410 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI5,
1411 .revision = 0x03,
1412 .irq_pin = 1,
1413 .unplug = false,
1414 },{
1415 .name = "ich9-usb-uhci6",
1416 .vendor_id = PCI_VENDOR_ID_INTEL,
1417 .device_id = PCI_DEVICE_ID_INTEL_82801I_UHCI6,
1418 .revision = 0x03,
1419 .irq_pin = 2,
1420 .unplug = false,
1421 }
1422};
1423
1424static void uhci_register_types(void)
1425{
1426 TypeInfo uhci_type_info = {
1427 .parent = TYPE_UHCI,
1428 .class_init = uhci_data_class_init,
1429 };
1430 int i;
1431
1432 type_register_static(&uhci_pci_type_info);
1433
1434 for (i = 0; i < ARRAY_SIZE(uhci_info); i++) {
1435 uhci_type_info.name = uhci_info[i].name;
1436 uhci_type_info.class_data = uhci_info + i;
1437 type_register(&uhci_type_info);
1438 }
1439}
1440
1441type_init(uhci_register_types)
1442