qxl: avoid unaligned pointer reads/writes
[qemu/ar7.git] / hw / usb / hcd-xhci.c
blob2e9a839f2bf94fbfb50e58f36193a4389a0bcfa8
1 /*
2 * USB xHCI controller emulation
4 * Copyright (c) 2011 Securiforest
5 * Date: 2011-05-11 ; Author: Hector Martin <hector@marcansoft.com>
6 * Based on usb-ohci.c, emulates Renesas NEC USB 3.0
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include "qemu/osdep.h"
22 #include "hw/hw.h"
23 #include "qemu/timer.h"
24 #include "qemu/queue.h"
25 #include "hw/usb.h"
26 #include "hw/pci/pci.h"
27 #include "hw/pci/msi.h"
28 #include "hw/pci/msix.h"
29 #include "trace.h"
30 #include "qapi/error.h"
32 #include "hcd-xhci.h"
34 //#define DEBUG_XHCI
35 //#define DEBUG_DATA
37 #ifdef DEBUG_XHCI
38 #define DPRINTF(...) fprintf(stderr, __VA_ARGS__)
39 #else
40 #define DPRINTF(...) do {} while (0)
41 #endif
42 #define FIXME(_msg) do { fprintf(stderr, "FIXME %s:%d %s\n", \
43 __func__, __LINE__, _msg); abort(); } while (0)
45 #define TRB_LINK_LIMIT 32
46 #define COMMAND_LIMIT 256
47 #define TRANSFER_LIMIT 256
49 #define LEN_CAP 0x40
50 #define LEN_OPER (0x400 + 0x10 * MAXPORTS)
51 #define LEN_RUNTIME ((MAXINTRS + 1) * 0x20)
52 #define LEN_DOORBELL ((MAXSLOTS + 1) * 0x20)
54 #define OFF_OPER LEN_CAP
55 #define OFF_RUNTIME 0x1000
56 #define OFF_DOORBELL 0x2000
57 #define OFF_MSIX_TABLE 0x3000
58 #define OFF_MSIX_PBA 0x3800
59 /* must be power of 2 */
60 #define LEN_REGS 0x4000
62 #if (OFF_OPER + LEN_OPER) > OFF_RUNTIME
63 #error Increase OFF_RUNTIME
64 #endif
65 #if (OFF_RUNTIME + LEN_RUNTIME) > OFF_DOORBELL
66 #error Increase OFF_DOORBELL
67 #endif
68 #if (OFF_DOORBELL + LEN_DOORBELL) > LEN_REGS
69 # error Increase LEN_REGS
70 #endif
72 /* bit definitions */
73 #define USBCMD_RS (1<<0)
74 #define USBCMD_HCRST (1<<1)
75 #define USBCMD_INTE (1<<2)
76 #define USBCMD_HSEE (1<<3)
77 #define USBCMD_LHCRST (1<<7)
78 #define USBCMD_CSS (1<<8)
79 #define USBCMD_CRS (1<<9)
80 #define USBCMD_EWE (1<<10)
81 #define USBCMD_EU3S (1<<11)
83 #define USBSTS_HCH (1<<0)
84 #define USBSTS_HSE (1<<2)
85 #define USBSTS_EINT (1<<3)
86 #define USBSTS_PCD (1<<4)
87 #define USBSTS_SSS (1<<8)
88 #define USBSTS_RSS (1<<9)
89 #define USBSTS_SRE (1<<10)
90 #define USBSTS_CNR (1<<11)
91 #define USBSTS_HCE (1<<12)
94 #define PORTSC_CCS (1<<0)
95 #define PORTSC_PED (1<<1)
96 #define PORTSC_OCA (1<<3)
97 #define PORTSC_PR (1<<4)
98 #define PORTSC_PLS_SHIFT 5
99 #define PORTSC_PLS_MASK 0xf
100 #define PORTSC_PP (1<<9)
101 #define PORTSC_SPEED_SHIFT 10
102 #define PORTSC_SPEED_MASK 0xf
103 #define PORTSC_SPEED_FULL (1<<10)
104 #define PORTSC_SPEED_LOW (2<<10)
105 #define PORTSC_SPEED_HIGH (3<<10)
106 #define PORTSC_SPEED_SUPER (4<<10)
107 #define PORTSC_PIC_SHIFT 14
108 #define PORTSC_PIC_MASK 0x3
109 #define PORTSC_LWS (1<<16)
110 #define PORTSC_CSC (1<<17)
111 #define PORTSC_PEC (1<<18)
112 #define PORTSC_WRC (1<<19)
113 #define PORTSC_OCC (1<<20)
114 #define PORTSC_PRC (1<<21)
115 #define PORTSC_PLC (1<<22)
116 #define PORTSC_CEC (1<<23)
117 #define PORTSC_CAS (1<<24)
118 #define PORTSC_WCE (1<<25)
119 #define PORTSC_WDE (1<<26)
120 #define PORTSC_WOE (1<<27)
121 #define PORTSC_DR (1<<30)
122 #define PORTSC_WPR (1<<31)
124 #define CRCR_RCS (1<<0)
125 #define CRCR_CS (1<<1)
126 #define CRCR_CA (1<<2)
127 #define CRCR_CRR (1<<3)
129 #define IMAN_IP (1<<0)
130 #define IMAN_IE (1<<1)
132 #define ERDP_EHB (1<<3)
134 #define TRB_SIZE 16
135 typedef struct XHCITRB {
136 uint64_t parameter;
137 uint32_t status;
138 uint32_t control;
139 dma_addr_t addr;
140 bool ccs;
141 } XHCITRB;
143 enum {
144 PLS_U0 = 0,
145 PLS_U1 = 1,
146 PLS_U2 = 2,
147 PLS_U3 = 3,
148 PLS_DISABLED = 4,
149 PLS_RX_DETECT = 5,
150 PLS_INACTIVE = 6,
151 PLS_POLLING = 7,
152 PLS_RECOVERY = 8,
153 PLS_HOT_RESET = 9,
154 PLS_COMPILANCE_MODE = 10,
155 PLS_TEST_MODE = 11,
156 PLS_RESUME = 15,
159 #define CR_LINK TR_LINK
161 #define TRB_C (1<<0)
162 #define TRB_TYPE_SHIFT 10
163 #define TRB_TYPE_MASK 0x3f
164 #define TRB_TYPE(t) (((t).control >> TRB_TYPE_SHIFT) & TRB_TYPE_MASK)
166 #define TRB_EV_ED (1<<2)
168 #define TRB_TR_ENT (1<<1)
169 #define TRB_TR_ISP (1<<2)
170 #define TRB_TR_NS (1<<3)
171 #define TRB_TR_CH (1<<4)
172 #define TRB_TR_IOC (1<<5)
173 #define TRB_TR_IDT (1<<6)
174 #define TRB_TR_TBC_SHIFT 7
175 #define TRB_TR_TBC_MASK 0x3
176 #define TRB_TR_BEI (1<<9)
177 #define TRB_TR_TLBPC_SHIFT 16
178 #define TRB_TR_TLBPC_MASK 0xf
179 #define TRB_TR_FRAMEID_SHIFT 20
180 #define TRB_TR_FRAMEID_MASK 0x7ff
181 #define TRB_TR_SIA (1<<31)
183 #define TRB_TR_DIR (1<<16)
185 #define TRB_CR_SLOTID_SHIFT 24
186 #define TRB_CR_SLOTID_MASK 0xff
187 #define TRB_CR_EPID_SHIFT 16
188 #define TRB_CR_EPID_MASK 0x1f
190 #define TRB_CR_BSR (1<<9)
191 #define TRB_CR_DC (1<<9)
193 #define TRB_LK_TC (1<<1)
195 #define TRB_INTR_SHIFT 22
196 #define TRB_INTR_MASK 0x3ff
197 #define TRB_INTR(t) (((t).status >> TRB_INTR_SHIFT) & TRB_INTR_MASK)
199 #define EP_TYPE_MASK 0x7
200 #define EP_TYPE_SHIFT 3
202 #define EP_STATE_MASK 0x7
203 #define EP_DISABLED (0<<0)
204 #define EP_RUNNING (1<<0)
205 #define EP_HALTED (2<<0)
206 #define EP_STOPPED (3<<0)
207 #define EP_ERROR (4<<0)
209 #define SLOT_STATE_MASK 0x1f
210 #define SLOT_STATE_SHIFT 27
211 #define SLOT_STATE(s) (((s)>>SLOT_STATE_SHIFT)&SLOT_STATE_MASK)
212 #define SLOT_ENABLED 0
213 #define SLOT_DEFAULT 1
214 #define SLOT_ADDRESSED 2
215 #define SLOT_CONFIGURED 3
217 #define SLOT_CONTEXT_ENTRIES_MASK 0x1f
218 #define SLOT_CONTEXT_ENTRIES_SHIFT 27
220 #define get_field(data, field) \
221 (((data) >> field##_SHIFT) & field##_MASK)
223 #define set_field(data, newval, field) do { \
224 uint32_t val = *data; \
225 val &= ~(field##_MASK << field##_SHIFT); \
226 val |= ((newval) & field##_MASK) << field##_SHIFT; \
227 *data = val; \
228 } while (0)
230 typedef enum EPType {
231 ET_INVALID = 0,
232 ET_ISO_OUT,
233 ET_BULK_OUT,
234 ET_INTR_OUT,
235 ET_CONTROL,
236 ET_ISO_IN,
237 ET_BULK_IN,
238 ET_INTR_IN,
239 } EPType;
241 typedef struct XHCITransfer {
242 XHCIEPContext *epctx;
243 USBPacket packet;
244 QEMUSGList sgl;
245 bool running_async;
246 bool running_retry;
247 bool complete;
248 bool int_req;
249 unsigned int iso_pkts;
250 unsigned int streamid;
251 bool in_xfer;
252 bool iso_xfer;
253 bool timed_xfer;
255 unsigned int trb_count;
256 XHCITRB *trbs;
258 TRBCCode status;
260 unsigned int pkts;
261 unsigned int pktsize;
262 unsigned int cur_pkt;
264 uint64_t mfindex_kick;
266 QTAILQ_ENTRY(XHCITransfer) next;
267 } XHCITransfer;
269 struct XHCIStreamContext {
270 dma_addr_t pctx;
271 unsigned int sct;
272 XHCIRing ring;
275 struct XHCIEPContext {
276 XHCIState *xhci;
277 unsigned int slotid;
278 unsigned int epid;
280 XHCIRing ring;
281 uint32_t xfer_count;
282 QTAILQ_HEAD(, XHCITransfer) transfers;
283 XHCITransfer *retry;
284 EPType type;
285 dma_addr_t pctx;
286 unsigned int max_psize;
287 uint32_t state;
288 uint32_t kick_active;
290 /* streams */
291 unsigned int max_pstreams;
292 bool lsa;
293 unsigned int nr_pstreams;
294 XHCIStreamContext *pstreams;
296 /* iso xfer scheduling */
297 unsigned int interval;
298 int64_t mfindex_last;
299 QEMUTimer *kick_timer;
302 typedef struct XHCIEvRingSeg {
303 uint32_t addr_low;
304 uint32_t addr_high;
305 uint32_t size;
306 uint32_t rsvd;
307 } XHCIEvRingSeg;
309 static void xhci_kick_ep(XHCIState *xhci, unsigned int slotid,
310 unsigned int epid, unsigned int streamid);
311 static void xhci_kick_epctx(XHCIEPContext *epctx, unsigned int streamid);
312 static TRBCCode xhci_disable_ep(XHCIState *xhci, unsigned int slotid,
313 unsigned int epid);
314 static void xhci_xfer_report(XHCITransfer *xfer);
315 static void xhci_event(XHCIState *xhci, XHCIEvent *event, int v);
316 static void xhci_write_event(XHCIState *xhci, XHCIEvent *event, int v);
317 static USBEndpoint *xhci_epid_to_usbep(XHCIEPContext *epctx);
319 static const char *TRBType_names[] = {
320 [TRB_RESERVED] = "TRB_RESERVED",
321 [TR_NORMAL] = "TR_NORMAL",
322 [TR_SETUP] = "TR_SETUP",
323 [TR_DATA] = "TR_DATA",
324 [TR_STATUS] = "TR_STATUS",
325 [TR_ISOCH] = "TR_ISOCH",
326 [TR_LINK] = "TR_LINK",
327 [TR_EVDATA] = "TR_EVDATA",
328 [TR_NOOP] = "TR_NOOP",
329 [CR_ENABLE_SLOT] = "CR_ENABLE_SLOT",
330 [CR_DISABLE_SLOT] = "CR_DISABLE_SLOT",
331 [CR_ADDRESS_DEVICE] = "CR_ADDRESS_DEVICE",
332 [CR_CONFIGURE_ENDPOINT] = "CR_CONFIGURE_ENDPOINT",
333 [CR_EVALUATE_CONTEXT] = "CR_EVALUATE_CONTEXT",
334 [CR_RESET_ENDPOINT] = "CR_RESET_ENDPOINT",
335 [CR_STOP_ENDPOINT] = "CR_STOP_ENDPOINT",
336 [CR_SET_TR_DEQUEUE] = "CR_SET_TR_DEQUEUE",
337 [CR_RESET_DEVICE] = "CR_RESET_DEVICE",
338 [CR_FORCE_EVENT] = "CR_FORCE_EVENT",
339 [CR_NEGOTIATE_BW] = "CR_NEGOTIATE_BW",
340 [CR_SET_LATENCY_TOLERANCE] = "CR_SET_LATENCY_TOLERANCE",
341 [CR_GET_PORT_BANDWIDTH] = "CR_GET_PORT_BANDWIDTH",
342 [CR_FORCE_HEADER] = "CR_FORCE_HEADER",
343 [CR_NOOP] = "CR_NOOP",
344 [ER_TRANSFER] = "ER_TRANSFER",
345 [ER_COMMAND_COMPLETE] = "ER_COMMAND_COMPLETE",
346 [ER_PORT_STATUS_CHANGE] = "ER_PORT_STATUS_CHANGE",
347 [ER_BANDWIDTH_REQUEST] = "ER_BANDWIDTH_REQUEST",
348 [ER_DOORBELL] = "ER_DOORBELL",
349 [ER_HOST_CONTROLLER] = "ER_HOST_CONTROLLER",
350 [ER_DEVICE_NOTIFICATION] = "ER_DEVICE_NOTIFICATION",
351 [ER_MFINDEX_WRAP] = "ER_MFINDEX_WRAP",
352 [CR_VENDOR_NEC_FIRMWARE_REVISION] = "CR_VENDOR_NEC_FIRMWARE_REVISION",
353 [CR_VENDOR_NEC_CHALLENGE_RESPONSE] = "CR_VENDOR_NEC_CHALLENGE_RESPONSE",
356 static const char *TRBCCode_names[] = {
357 [CC_INVALID] = "CC_INVALID",
358 [CC_SUCCESS] = "CC_SUCCESS",
359 [CC_DATA_BUFFER_ERROR] = "CC_DATA_BUFFER_ERROR",
360 [CC_BABBLE_DETECTED] = "CC_BABBLE_DETECTED",
361 [CC_USB_TRANSACTION_ERROR] = "CC_USB_TRANSACTION_ERROR",
362 [CC_TRB_ERROR] = "CC_TRB_ERROR",
363 [CC_STALL_ERROR] = "CC_STALL_ERROR",
364 [CC_RESOURCE_ERROR] = "CC_RESOURCE_ERROR",
365 [CC_BANDWIDTH_ERROR] = "CC_BANDWIDTH_ERROR",
366 [CC_NO_SLOTS_ERROR] = "CC_NO_SLOTS_ERROR",
367 [CC_INVALID_STREAM_TYPE_ERROR] = "CC_INVALID_STREAM_TYPE_ERROR",
368 [CC_SLOT_NOT_ENABLED_ERROR] = "CC_SLOT_NOT_ENABLED_ERROR",
369 [CC_EP_NOT_ENABLED_ERROR] = "CC_EP_NOT_ENABLED_ERROR",
370 [CC_SHORT_PACKET] = "CC_SHORT_PACKET",
371 [CC_RING_UNDERRUN] = "CC_RING_UNDERRUN",
372 [CC_RING_OVERRUN] = "CC_RING_OVERRUN",
373 [CC_VF_ER_FULL] = "CC_VF_ER_FULL",
374 [CC_PARAMETER_ERROR] = "CC_PARAMETER_ERROR",
375 [CC_BANDWIDTH_OVERRUN] = "CC_BANDWIDTH_OVERRUN",
376 [CC_CONTEXT_STATE_ERROR] = "CC_CONTEXT_STATE_ERROR",
377 [CC_NO_PING_RESPONSE_ERROR] = "CC_NO_PING_RESPONSE_ERROR",
378 [CC_EVENT_RING_FULL_ERROR] = "CC_EVENT_RING_FULL_ERROR",
379 [CC_INCOMPATIBLE_DEVICE_ERROR] = "CC_INCOMPATIBLE_DEVICE_ERROR",
380 [CC_MISSED_SERVICE_ERROR] = "CC_MISSED_SERVICE_ERROR",
381 [CC_COMMAND_RING_STOPPED] = "CC_COMMAND_RING_STOPPED",
382 [CC_COMMAND_ABORTED] = "CC_COMMAND_ABORTED",
383 [CC_STOPPED] = "CC_STOPPED",
384 [CC_STOPPED_LENGTH_INVALID] = "CC_STOPPED_LENGTH_INVALID",
385 [CC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR]
386 = "CC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR",
387 [CC_ISOCH_BUFFER_OVERRUN] = "CC_ISOCH_BUFFER_OVERRUN",
388 [CC_EVENT_LOST_ERROR] = "CC_EVENT_LOST_ERROR",
389 [CC_UNDEFINED_ERROR] = "CC_UNDEFINED_ERROR",
390 [CC_INVALID_STREAM_ID_ERROR] = "CC_INVALID_STREAM_ID_ERROR",
391 [CC_SECONDARY_BANDWIDTH_ERROR] = "CC_SECONDARY_BANDWIDTH_ERROR",
392 [CC_SPLIT_TRANSACTION_ERROR] = "CC_SPLIT_TRANSACTION_ERROR",
395 static const char *ep_state_names[] = {
396 [EP_DISABLED] = "disabled",
397 [EP_RUNNING] = "running",
398 [EP_HALTED] = "halted",
399 [EP_STOPPED] = "stopped",
400 [EP_ERROR] = "error",
403 static const char *lookup_name(uint32_t index, const char **list, uint32_t llen)
405 if (index >= llen || list[index] == NULL) {
406 return "???";
408 return list[index];
411 static const char *trb_name(XHCITRB *trb)
413 return lookup_name(TRB_TYPE(*trb), TRBType_names,
414 ARRAY_SIZE(TRBType_names));
417 static const char *event_name(XHCIEvent *event)
419 return lookup_name(event->ccode, TRBCCode_names,
420 ARRAY_SIZE(TRBCCode_names));
423 static const char *ep_state_name(uint32_t state)
425 return lookup_name(state, ep_state_names,
426 ARRAY_SIZE(ep_state_names));
429 static bool xhci_get_flag(XHCIState *xhci, enum xhci_flags bit)
431 return xhci->flags & (1 << bit);
434 static void xhci_set_flag(XHCIState *xhci, enum xhci_flags bit)
436 xhci->flags |= (1 << bit);
439 static uint64_t xhci_mfindex_get(XHCIState *xhci)
441 int64_t now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
442 return (now - xhci->mfindex_start) / 125000;
445 static void xhci_mfwrap_update(XHCIState *xhci)
447 const uint32_t bits = USBCMD_RS | USBCMD_EWE;
448 uint32_t mfindex, left;
449 int64_t now;
451 if ((xhci->usbcmd & bits) == bits) {
452 now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
453 mfindex = ((now - xhci->mfindex_start) / 125000) & 0x3fff;
454 left = 0x4000 - mfindex;
455 timer_mod(xhci->mfwrap_timer, now + left * 125000);
456 } else {
457 timer_del(xhci->mfwrap_timer);
461 static void xhci_mfwrap_timer(void *opaque)
463 XHCIState *xhci = opaque;
464 XHCIEvent wrap = { ER_MFINDEX_WRAP, CC_SUCCESS };
466 xhci_event(xhci, &wrap, 0);
467 xhci_mfwrap_update(xhci);
470 static inline dma_addr_t xhci_addr64(uint32_t low, uint32_t high)
472 if (sizeof(dma_addr_t) == 4) {
473 return low;
474 } else {
475 return low | (((dma_addr_t)high << 16) << 16);
479 static inline dma_addr_t xhci_mask64(uint64_t addr)
481 if (sizeof(dma_addr_t) == 4) {
482 return addr & 0xffffffff;
483 } else {
484 return addr;
488 static inline void xhci_dma_read_u32s(XHCIState *xhci, dma_addr_t addr,
489 uint32_t *buf, size_t len)
491 int i;
493 assert((len % sizeof(uint32_t)) == 0);
495 pci_dma_read(PCI_DEVICE(xhci), addr, buf, len);
497 for (i = 0; i < (len / sizeof(uint32_t)); i++) {
498 buf[i] = le32_to_cpu(buf[i]);
502 static inline void xhci_dma_write_u32s(XHCIState *xhci, dma_addr_t addr,
503 uint32_t *buf, size_t len)
505 int i;
506 uint32_t tmp[5];
507 uint32_t n = len / sizeof(uint32_t);
509 assert((len % sizeof(uint32_t)) == 0);
510 assert(n <= ARRAY_SIZE(tmp));
512 for (i = 0; i < n; i++) {
513 tmp[i] = cpu_to_le32(buf[i]);
515 pci_dma_write(PCI_DEVICE(xhci), addr, tmp, len);
518 static XHCIPort *xhci_lookup_port(XHCIState *xhci, struct USBPort *uport)
520 int index;
522 if (!uport->dev) {
523 return NULL;
525 switch (uport->dev->speed) {
526 case USB_SPEED_LOW:
527 case USB_SPEED_FULL:
528 case USB_SPEED_HIGH:
529 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
530 index = uport->index + xhci->numports_3;
531 } else {
532 index = uport->index;
534 break;
535 case USB_SPEED_SUPER:
536 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
537 index = uport->index;
538 } else {
539 index = uport->index + xhci->numports_2;
541 break;
542 default:
543 return NULL;
545 return &xhci->ports[index];
548 static void xhci_intx_update(XHCIState *xhci)
550 PCIDevice *pci_dev = PCI_DEVICE(xhci);
551 int level = 0;
553 if (msix_enabled(pci_dev) ||
554 msi_enabled(pci_dev)) {
555 return;
558 if (xhci->intr[0].iman & IMAN_IP &&
559 xhci->intr[0].iman & IMAN_IE &&
560 xhci->usbcmd & USBCMD_INTE) {
561 level = 1;
564 trace_usb_xhci_irq_intx(level);
565 pci_set_irq(pci_dev, level);
568 static void xhci_msix_update(XHCIState *xhci, int v)
570 PCIDevice *pci_dev = PCI_DEVICE(xhci);
571 bool enabled;
573 if (!msix_enabled(pci_dev)) {
574 return;
577 enabled = xhci->intr[v].iman & IMAN_IE;
578 if (enabled == xhci->intr[v].msix_used) {
579 return;
582 if (enabled) {
583 trace_usb_xhci_irq_msix_use(v);
584 msix_vector_use(pci_dev, v);
585 xhci->intr[v].msix_used = true;
586 } else {
587 trace_usb_xhci_irq_msix_unuse(v);
588 msix_vector_unuse(pci_dev, v);
589 xhci->intr[v].msix_used = false;
593 static void xhci_intr_raise(XHCIState *xhci, int v)
595 PCIDevice *pci_dev = PCI_DEVICE(xhci);
596 bool pending = (xhci->intr[v].erdp_low & ERDP_EHB);
598 xhci->intr[v].erdp_low |= ERDP_EHB;
599 xhci->intr[v].iman |= IMAN_IP;
600 xhci->usbsts |= USBSTS_EINT;
602 if (pending) {
603 return;
605 if (!(xhci->intr[v].iman & IMAN_IE)) {
606 return;
609 if (!(xhci->usbcmd & USBCMD_INTE)) {
610 return;
613 if (msix_enabled(pci_dev)) {
614 trace_usb_xhci_irq_msix(v);
615 msix_notify(pci_dev, v);
616 return;
619 if (msi_enabled(pci_dev)) {
620 trace_usb_xhci_irq_msi(v);
621 msi_notify(pci_dev, v);
622 return;
625 if (v == 0) {
626 trace_usb_xhci_irq_intx(1);
627 pci_irq_assert(pci_dev);
631 static inline int xhci_running(XHCIState *xhci)
633 return !(xhci->usbsts & USBSTS_HCH);
636 static void xhci_die(XHCIState *xhci)
638 xhci->usbsts |= USBSTS_HCE;
639 DPRINTF("xhci: asserted controller error\n");
642 static void xhci_write_event(XHCIState *xhci, XHCIEvent *event, int v)
644 PCIDevice *pci_dev = PCI_DEVICE(xhci);
645 XHCIInterrupter *intr = &xhci->intr[v];
646 XHCITRB ev_trb;
647 dma_addr_t addr;
649 ev_trb.parameter = cpu_to_le64(event->ptr);
650 ev_trb.status = cpu_to_le32(event->length | (event->ccode << 24));
651 ev_trb.control = (event->slotid << 24) | (event->epid << 16) |
652 event->flags | (event->type << TRB_TYPE_SHIFT);
653 if (intr->er_pcs) {
654 ev_trb.control |= TRB_C;
656 ev_trb.control = cpu_to_le32(ev_trb.control);
658 trace_usb_xhci_queue_event(v, intr->er_ep_idx, trb_name(&ev_trb),
659 event_name(event), ev_trb.parameter,
660 ev_trb.status, ev_trb.control);
662 addr = intr->er_start + TRB_SIZE*intr->er_ep_idx;
663 pci_dma_write(pci_dev, addr, &ev_trb, TRB_SIZE);
665 intr->er_ep_idx++;
666 if (intr->er_ep_idx >= intr->er_size) {
667 intr->er_ep_idx = 0;
668 intr->er_pcs = !intr->er_pcs;
672 static void xhci_event(XHCIState *xhci, XHCIEvent *event, int v)
674 XHCIInterrupter *intr;
675 dma_addr_t erdp;
676 unsigned int dp_idx;
678 if (v >= xhci->numintrs) {
679 DPRINTF("intr nr out of range (%d >= %d)\n", v, xhci->numintrs);
680 return;
682 intr = &xhci->intr[v];
684 erdp = xhci_addr64(intr->erdp_low, intr->erdp_high);
685 if (erdp < intr->er_start ||
686 erdp >= (intr->er_start + TRB_SIZE*intr->er_size)) {
687 DPRINTF("xhci: ERDP out of bounds: "DMA_ADDR_FMT"\n", erdp);
688 DPRINTF("xhci: ER[%d] at "DMA_ADDR_FMT" len %d\n",
689 v, intr->er_start, intr->er_size);
690 xhci_die(xhci);
691 return;
694 dp_idx = (erdp - intr->er_start) / TRB_SIZE;
695 assert(dp_idx < intr->er_size);
697 if ((intr->er_ep_idx + 2) % intr->er_size == dp_idx) {
698 DPRINTF("xhci: ER %d full, send ring full error\n", v);
699 XHCIEvent full = {ER_HOST_CONTROLLER, CC_EVENT_RING_FULL_ERROR};
700 xhci_write_event(xhci, &full, v);
701 } else if ((intr->er_ep_idx + 1) % intr->er_size == dp_idx) {
702 DPRINTF("xhci: ER %d full, drop event\n", v);
703 } else {
704 xhci_write_event(xhci, event, v);
707 xhci_intr_raise(xhci, v);
710 static void xhci_ring_init(XHCIState *xhci, XHCIRing *ring,
711 dma_addr_t base)
713 ring->dequeue = base;
714 ring->ccs = 1;
717 static TRBType xhci_ring_fetch(XHCIState *xhci, XHCIRing *ring, XHCITRB *trb,
718 dma_addr_t *addr)
720 PCIDevice *pci_dev = PCI_DEVICE(xhci);
721 uint32_t link_cnt = 0;
723 while (1) {
724 TRBType type;
725 pci_dma_read(pci_dev, ring->dequeue, trb, TRB_SIZE);
726 trb->addr = ring->dequeue;
727 trb->ccs = ring->ccs;
728 le64_to_cpus(&trb->parameter);
729 le32_to_cpus(&trb->status);
730 le32_to_cpus(&trb->control);
732 trace_usb_xhci_fetch_trb(ring->dequeue, trb_name(trb),
733 trb->parameter, trb->status, trb->control);
735 if ((trb->control & TRB_C) != ring->ccs) {
736 return 0;
739 type = TRB_TYPE(*trb);
741 if (type != TR_LINK) {
742 if (addr) {
743 *addr = ring->dequeue;
745 ring->dequeue += TRB_SIZE;
746 return type;
747 } else {
748 if (++link_cnt > TRB_LINK_LIMIT) {
749 trace_usb_xhci_enforced_limit("trb-link");
750 return 0;
752 ring->dequeue = xhci_mask64(trb->parameter);
753 if (trb->control & TRB_LK_TC) {
754 ring->ccs = !ring->ccs;
760 static int xhci_ring_chain_length(XHCIState *xhci, const XHCIRing *ring)
762 PCIDevice *pci_dev = PCI_DEVICE(xhci);
763 XHCITRB trb;
764 int length = 0;
765 dma_addr_t dequeue = ring->dequeue;
766 bool ccs = ring->ccs;
767 /* hack to bundle together the two/three TDs that make a setup transfer */
768 bool control_td_set = 0;
769 uint32_t link_cnt = 0;
771 while (1) {
772 TRBType type;
773 pci_dma_read(pci_dev, dequeue, &trb, TRB_SIZE);
774 le64_to_cpus(&trb.parameter);
775 le32_to_cpus(&trb.status);
776 le32_to_cpus(&trb.control);
778 if ((trb.control & TRB_C) != ccs) {
779 return -length;
782 type = TRB_TYPE(trb);
784 if (type == TR_LINK) {
785 if (++link_cnt > TRB_LINK_LIMIT) {
786 return -length;
788 dequeue = xhci_mask64(trb.parameter);
789 if (trb.control & TRB_LK_TC) {
790 ccs = !ccs;
792 continue;
795 length += 1;
796 dequeue += TRB_SIZE;
798 if (type == TR_SETUP) {
799 control_td_set = 1;
800 } else if (type == TR_STATUS) {
801 control_td_set = 0;
804 if (!control_td_set && !(trb.control & TRB_TR_CH)) {
805 return length;
810 static void xhci_er_reset(XHCIState *xhci, int v)
812 XHCIInterrupter *intr = &xhci->intr[v];
813 XHCIEvRingSeg seg;
814 dma_addr_t erstba = xhci_addr64(intr->erstba_low, intr->erstba_high);
816 if (intr->erstsz == 0 || erstba == 0) {
817 /* disabled */
818 intr->er_start = 0;
819 intr->er_size = 0;
820 return;
822 /* cache the (sole) event ring segment location */
823 if (intr->erstsz != 1) {
824 DPRINTF("xhci: invalid value for ERSTSZ: %d\n", intr->erstsz);
825 xhci_die(xhci);
826 return;
828 pci_dma_read(PCI_DEVICE(xhci), erstba, &seg, sizeof(seg));
829 le32_to_cpus(&seg.addr_low);
830 le32_to_cpus(&seg.addr_high);
831 le32_to_cpus(&seg.size);
832 if (seg.size < 16 || seg.size > 4096) {
833 DPRINTF("xhci: invalid value for segment size: %d\n", seg.size);
834 xhci_die(xhci);
835 return;
837 intr->er_start = xhci_addr64(seg.addr_low, seg.addr_high);
838 intr->er_size = seg.size;
840 intr->er_ep_idx = 0;
841 intr->er_pcs = 1;
843 DPRINTF("xhci: event ring[%d]:" DMA_ADDR_FMT " [%d]\n",
844 v, intr->er_start, intr->er_size);
847 static void xhci_run(XHCIState *xhci)
849 trace_usb_xhci_run();
850 xhci->usbsts &= ~USBSTS_HCH;
851 xhci->mfindex_start = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
854 static void xhci_stop(XHCIState *xhci)
856 trace_usb_xhci_stop();
857 xhci->usbsts |= USBSTS_HCH;
858 xhci->crcr_low &= ~CRCR_CRR;
861 static XHCIStreamContext *xhci_alloc_stream_contexts(unsigned count,
862 dma_addr_t base)
864 XHCIStreamContext *stctx;
865 unsigned int i;
867 stctx = g_new0(XHCIStreamContext, count);
868 for (i = 0; i < count; i++) {
869 stctx[i].pctx = base + i * 16;
870 stctx[i].sct = -1;
872 return stctx;
875 static void xhci_reset_streams(XHCIEPContext *epctx)
877 unsigned int i;
879 for (i = 0; i < epctx->nr_pstreams; i++) {
880 epctx->pstreams[i].sct = -1;
884 static void xhci_alloc_streams(XHCIEPContext *epctx, dma_addr_t base)
886 assert(epctx->pstreams == NULL);
887 epctx->nr_pstreams = 2 << epctx->max_pstreams;
888 epctx->pstreams = xhci_alloc_stream_contexts(epctx->nr_pstreams, base);
891 static void xhci_free_streams(XHCIEPContext *epctx)
893 assert(epctx->pstreams != NULL);
895 g_free(epctx->pstreams);
896 epctx->pstreams = NULL;
897 epctx->nr_pstreams = 0;
900 static int xhci_epmask_to_eps_with_streams(XHCIState *xhci,
901 unsigned int slotid,
902 uint32_t epmask,
903 XHCIEPContext **epctxs,
904 USBEndpoint **eps)
906 XHCISlot *slot;
907 XHCIEPContext *epctx;
908 USBEndpoint *ep;
909 int i, j;
911 assert(slotid >= 1 && slotid <= xhci->numslots);
913 slot = &xhci->slots[slotid - 1];
915 for (i = 2, j = 0; i <= 31; i++) {
916 if (!(epmask & (1u << i))) {
917 continue;
920 epctx = slot->eps[i - 1];
921 ep = xhci_epid_to_usbep(epctx);
922 if (!epctx || !epctx->nr_pstreams || !ep) {
923 continue;
926 if (epctxs) {
927 epctxs[j] = epctx;
929 eps[j++] = ep;
931 return j;
934 static void xhci_free_device_streams(XHCIState *xhci, unsigned int slotid,
935 uint32_t epmask)
937 USBEndpoint *eps[30];
938 int nr_eps;
940 nr_eps = xhci_epmask_to_eps_with_streams(xhci, slotid, epmask, NULL, eps);
941 if (nr_eps) {
942 usb_device_free_streams(eps[0]->dev, eps, nr_eps);
946 static TRBCCode xhci_alloc_device_streams(XHCIState *xhci, unsigned int slotid,
947 uint32_t epmask)
949 XHCIEPContext *epctxs[30];
950 USBEndpoint *eps[30];
951 int i, r, nr_eps, req_nr_streams, dev_max_streams;
953 nr_eps = xhci_epmask_to_eps_with_streams(xhci, slotid, epmask, epctxs,
954 eps);
955 if (nr_eps == 0) {
956 return CC_SUCCESS;
959 req_nr_streams = epctxs[0]->nr_pstreams;
960 dev_max_streams = eps[0]->max_streams;
962 for (i = 1; i < nr_eps; i++) {
964 * HdG: I don't expect these to ever trigger, but if they do we need
965 * to come up with another solution, ie group identical endpoints
966 * together and make an usb_device_alloc_streams call per group.
968 if (epctxs[i]->nr_pstreams != req_nr_streams) {
969 FIXME("guest streams config not identical for all eps");
970 return CC_RESOURCE_ERROR;
972 if (eps[i]->max_streams != dev_max_streams) {
973 FIXME("device streams config not identical for all eps");
974 return CC_RESOURCE_ERROR;
979 * max-streams in both the device descriptor and in the controller is a
980 * power of 2. But stream id 0 is reserved, so if a device can do up to 4
981 * streams the guest will ask for 5 rounded up to the next power of 2 which
982 * becomes 8. For emulated devices usb_device_alloc_streams is a nop.
984 * For redirected devices however this is an issue, as there we must ask
985 * the real xhci controller to alloc streams, and the host driver for the
986 * real xhci controller will likely disallow allocating more streams then
987 * the device can handle.
989 * So we limit the requested nr_streams to the maximum number the device
990 * can handle.
992 if (req_nr_streams > dev_max_streams) {
993 req_nr_streams = dev_max_streams;
996 r = usb_device_alloc_streams(eps[0]->dev, eps, nr_eps, req_nr_streams);
997 if (r != 0) {
998 DPRINTF("xhci: alloc streams failed\n");
999 return CC_RESOURCE_ERROR;
1002 return CC_SUCCESS;
1005 static XHCIStreamContext *xhci_find_stream(XHCIEPContext *epctx,
1006 unsigned int streamid,
1007 uint32_t *cc_error)
1009 XHCIStreamContext *sctx;
1010 dma_addr_t base;
1011 uint32_t ctx[2], sct;
1013 assert(streamid != 0);
1014 if (epctx->lsa) {
1015 if (streamid >= epctx->nr_pstreams) {
1016 *cc_error = CC_INVALID_STREAM_ID_ERROR;
1017 return NULL;
1019 sctx = epctx->pstreams + streamid;
1020 } else {
1021 FIXME("secondary streams not implemented yet");
1024 if (sctx->sct == -1) {
1025 xhci_dma_read_u32s(epctx->xhci, sctx->pctx, ctx, sizeof(ctx));
1026 sct = (ctx[0] >> 1) & 0x07;
1027 if (epctx->lsa && sct != 1) {
1028 *cc_error = CC_INVALID_STREAM_TYPE_ERROR;
1029 return NULL;
1031 sctx->sct = sct;
1032 base = xhci_addr64(ctx[0] & ~0xf, ctx[1]);
1033 xhci_ring_init(epctx->xhci, &sctx->ring, base);
1035 return sctx;
1038 static void xhci_set_ep_state(XHCIState *xhci, XHCIEPContext *epctx,
1039 XHCIStreamContext *sctx, uint32_t state)
1041 XHCIRing *ring = NULL;
1042 uint32_t ctx[5];
1043 uint32_t ctx2[2];
1045 xhci_dma_read_u32s(xhci, epctx->pctx, ctx, sizeof(ctx));
1046 ctx[0] &= ~EP_STATE_MASK;
1047 ctx[0] |= state;
1049 /* update ring dequeue ptr */
1050 if (epctx->nr_pstreams) {
1051 if (sctx != NULL) {
1052 ring = &sctx->ring;
1053 xhci_dma_read_u32s(xhci, sctx->pctx, ctx2, sizeof(ctx2));
1054 ctx2[0] &= 0xe;
1055 ctx2[0] |= sctx->ring.dequeue | sctx->ring.ccs;
1056 ctx2[1] = (sctx->ring.dequeue >> 16) >> 16;
1057 xhci_dma_write_u32s(xhci, sctx->pctx, ctx2, sizeof(ctx2));
1059 } else {
1060 ring = &epctx->ring;
1062 if (ring) {
1063 ctx[2] = ring->dequeue | ring->ccs;
1064 ctx[3] = (ring->dequeue >> 16) >> 16;
1066 DPRINTF("xhci: set epctx: " DMA_ADDR_FMT " state=%d dequeue=%08x%08x\n",
1067 epctx->pctx, state, ctx[3], ctx[2]);
1070 xhci_dma_write_u32s(xhci, epctx->pctx, ctx, sizeof(ctx));
1071 if (epctx->state != state) {
1072 trace_usb_xhci_ep_state(epctx->slotid, epctx->epid,
1073 ep_state_name(epctx->state),
1074 ep_state_name(state));
1076 epctx->state = state;
1079 static void xhci_ep_kick_timer(void *opaque)
1081 XHCIEPContext *epctx = opaque;
1082 xhci_kick_epctx(epctx, 0);
1085 static XHCIEPContext *xhci_alloc_epctx(XHCIState *xhci,
1086 unsigned int slotid,
1087 unsigned int epid)
1089 XHCIEPContext *epctx;
1091 epctx = g_new0(XHCIEPContext, 1);
1092 epctx->xhci = xhci;
1093 epctx->slotid = slotid;
1094 epctx->epid = epid;
1096 QTAILQ_INIT(&epctx->transfers);
1097 epctx->kick_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, xhci_ep_kick_timer, epctx);
1099 return epctx;
1102 static void xhci_init_epctx(XHCIEPContext *epctx,
1103 dma_addr_t pctx, uint32_t *ctx)
1105 dma_addr_t dequeue;
1107 dequeue = xhci_addr64(ctx[2] & ~0xf, ctx[3]);
1109 epctx->type = (ctx[1] >> EP_TYPE_SHIFT) & EP_TYPE_MASK;
1110 epctx->pctx = pctx;
1111 epctx->max_psize = ctx[1]>>16;
1112 epctx->max_psize *= 1+((ctx[1]>>8)&0xff);
1113 epctx->max_pstreams = (ctx[0] >> 10) & epctx->xhci->max_pstreams_mask;
1114 epctx->lsa = (ctx[0] >> 15) & 1;
1115 if (epctx->max_pstreams) {
1116 xhci_alloc_streams(epctx, dequeue);
1117 } else {
1118 xhci_ring_init(epctx->xhci, &epctx->ring, dequeue);
1119 epctx->ring.ccs = ctx[2] & 1;
1122 epctx->interval = 1 << ((ctx[0] >> 16) & 0xff);
1125 static TRBCCode xhci_enable_ep(XHCIState *xhci, unsigned int slotid,
1126 unsigned int epid, dma_addr_t pctx,
1127 uint32_t *ctx)
1129 XHCISlot *slot;
1130 XHCIEPContext *epctx;
1132 trace_usb_xhci_ep_enable(slotid, epid);
1133 assert(slotid >= 1 && slotid <= xhci->numslots);
1134 assert(epid >= 1 && epid <= 31);
1136 slot = &xhci->slots[slotid-1];
1137 if (slot->eps[epid-1]) {
1138 xhci_disable_ep(xhci, slotid, epid);
1141 epctx = xhci_alloc_epctx(xhci, slotid, epid);
1142 slot->eps[epid-1] = epctx;
1143 xhci_init_epctx(epctx, pctx, ctx);
1145 DPRINTF("xhci: endpoint %d.%d type is %d, max transaction (burst) "
1146 "size is %d\n", epid/2, epid%2, epctx->type, epctx->max_psize);
1148 epctx->mfindex_last = 0;
1150 epctx->state = EP_RUNNING;
1151 ctx[0] &= ~EP_STATE_MASK;
1152 ctx[0] |= EP_RUNNING;
1154 return CC_SUCCESS;
1157 static XHCITransfer *xhci_ep_alloc_xfer(XHCIEPContext *epctx,
1158 uint32_t length)
1160 uint32_t limit = epctx->nr_pstreams + 16;
1161 XHCITransfer *xfer;
1163 if (epctx->xfer_count >= limit) {
1164 return NULL;
1167 xfer = g_new0(XHCITransfer, 1);
1168 xfer->epctx = epctx;
1169 xfer->trbs = g_new(XHCITRB, length);
1170 xfer->trb_count = length;
1171 usb_packet_init(&xfer->packet);
1173 QTAILQ_INSERT_TAIL(&epctx->transfers, xfer, next);
1174 epctx->xfer_count++;
1176 return xfer;
1179 static void xhci_ep_free_xfer(XHCITransfer *xfer)
1181 QTAILQ_REMOVE(&xfer->epctx->transfers, xfer, next);
1182 xfer->epctx->xfer_count--;
1184 usb_packet_cleanup(&xfer->packet);
1185 g_free(xfer->trbs);
1186 g_free(xfer);
1189 static int xhci_ep_nuke_one_xfer(XHCITransfer *t, TRBCCode report)
1191 int killed = 0;
1193 if (report && (t->running_async || t->running_retry)) {
1194 t->status = report;
1195 xhci_xfer_report(t);
1198 if (t->running_async) {
1199 usb_cancel_packet(&t->packet);
1200 t->running_async = 0;
1201 killed = 1;
1203 if (t->running_retry) {
1204 if (t->epctx) {
1205 t->epctx->retry = NULL;
1206 timer_del(t->epctx->kick_timer);
1208 t->running_retry = 0;
1209 killed = 1;
1211 g_free(t->trbs);
1213 t->trbs = NULL;
1214 t->trb_count = 0;
1216 return killed;
1219 static int xhci_ep_nuke_xfers(XHCIState *xhci, unsigned int slotid,
1220 unsigned int epid, TRBCCode report)
1222 XHCISlot *slot;
1223 XHCIEPContext *epctx;
1224 XHCITransfer *xfer;
1225 int killed = 0;
1226 USBEndpoint *ep = NULL;
1227 assert(slotid >= 1 && slotid <= xhci->numslots);
1228 assert(epid >= 1 && epid <= 31);
1230 DPRINTF("xhci_ep_nuke_xfers(%d, %d)\n", slotid, epid);
1232 slot = &xhci->slots[slotid-1];
1234 if (!slot->eps[epid-1]) {
1235 return 0;
1238 epctx = slot->eps[epid-1];
1240 for (;;) {
1241 xfer = QTAILQ_FIRST(&epctx->transfers);
1242 if (xfer == NULL) {
1243 break;
1245 killed += xhci_ep_nuke_one_xfer(xfer, report);
1246 if (killed) {
1247 report = 0; /* Only report once */
1249 xhci_ep_free_xfer(xfer);
1252 ep = xhci_epid_to_usbep(epctx);
1253 if (ep) {
1254 usb_device_ep_stopped(ep->dev, ep);
1256 return killed;
1259 static TRBCCode xhci_disable_ep(XHCIState *xhci, unsigned int slotid,
1260 unsigned int epid)
1262 XHCISlot *slot;
1263 XHCIEPContext *epctx;
1265 trace_usb_xhci_ep_disable(slotid, epid);
1266 assert(slotid >= 1 && slotid <= xhci->numslots);
1267 assert(epid >= 1 && epid <= 31);
1269 slot = &xhci->slots[slotid-1];
1271 if (!slot->eps[epid-1]) {
1272 DPRINTF("xhci: slot %d ep %d already disabled\n", slotid, epid);
1273 return CC_SUCCESS;
1276 xhci_ep_nuke_xfers(xhci, slotid, epid, 0);
1278 epctx = slot->eps[epid-1];
1280 if (epctx->nr_pstreams) {
1281 xhci_free_streams(epctx);
1284 /* only touch guest RAM if we're not resetting the HC */
1285 if (xhci->dcbaap_low || xhci->dcbaap_high) {
1286 xhci_set_ep_state(xhci, epctx, NULL, EP_DISABLED);
1289 timer_free(epctx->kick_timer);
1290 g_free(epctx);
1291 slot->eps[epid-1] = NULL;
1293 return CC_SUCCESS;
1296 static TRBCCode xhci_stop_ep(XHCIState *xhci, unsigned int slotid,
1297 unsigned int epid)
1299 XHCISlot *slot;
1300 XHCIEPContext *epctx;
1302 trace_usb_xhci_ep_stop(slotid, epid);
1303 assert(slotid >= 1 && slotid <= xhci->numslots);
1305 if (epid < 1 || epid > 31) {
1306 DPRINTF("xhci: bad ep %d\n", epid);
1307 return CC_TRB_ERROR;
1310 slot = &xhci->slots[slotid-1];
1312 if (!slot->eps[epid-1]) {
1313 DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1314 return CC_EP_NOT_ENABLED_ERROR;
1317 if (xhci_ep_nuke_xfers(xhci, slotid, epid, CC_STOPPED) > 0) {
1318 DPRINTF("xhci: FIXME: endpoint stopped w/ xfers running, "
1319 "data might be lost\n");
1322 epctx = slot->eps[epid-1];
1324 xhci_set_ep_state(xhci, epctx, NULL, EP_STOPPED);
1326 if (epctx->nr_pstreams) {
1327 xhci_reset_streams(epctx);
1330 return CC_SUCCESS;
1333 static TRBCCode xhci_reset_ep(XHCIState *xhci, unsigned int slotid,
1334 unsigned int epid)
1336 XHCISlot *slot;
1337 XHCIEPContext *epctx;
1339 trace_usb_xhci_ep_reset(slotid, epid);
1340 assert(slotid >= 1 && slotid <= xhci->numslots);
1342 if (epid < 1 || epid > 31) {
1343 DPRINTF("xhci: bad ep %d\n", epid);
1344 return CC_TRB_ERROR;
1347 slot = &xhci->slots[slotid-1];
1349 if (!slot->eps[epid-1]) {
1350 DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1351 return CC_EP_NOT_ENABLED_ERROR;
1354 epctx = slot->eps[epid-1];
1356 if (epctx->state != EP_HALTED) {
1357 DPRINTF("xhci: reset EP while EP %d not halted (%d)\n",
1358 epid, epctx->state);
1359 return CC_CONTEXT_STATE_ERROR;
1362 if (xhci_ep_nuke_xfers(xhci, slotid, epid, 0) > 0) {
1363 DPRINTF("xhci: FIXME: endpoint reset w/ xfers running, "
1364 "data might be lost\n");
1367 if (!xhci->slots[slotid-1].uport ||
1368 !xhci->slots[slotid-1].uport->dev ||
1369 !xhci->slots[slotid-1].uport->dev->attached) {
1370 return CC_USB_TRANSACTION_ERROR;
1373 xhci_set_ep_state(xhci, epctx, NULL, EP_STOPPED);
1375 if (epctx->nr_pstreams) {
1376 xhci_reset_streams(epctx);
1379 return CC_SUCCESS;
1382 static TRBCCode xhci_set_ep_dequeue(XHCIState *xhci, unsigned int slotid,
1383 unsigned int epid, unsigned int streamid,
1384 uint64_t pdequeue)
1386 XHCISlot *slot;
1387 XHCIEPContext *epctx;
1388 XHCIStreamContext *sctx;
1389 dma_addr_t dequeue;
1391 assert(slotid >= 1 && slotid <= xhci->numslots);
1393 if (epid < 1 || epid > 31) {
1394 DPRINTF("xhci: bad ep %d\n", epid);
1395 return CC_TRB_ERROR;
1398 trace_usb_xhci_ep_set_dequeue(slotid, epid, streamid, pdequeue);
1399 dequeue = xhci_mask64(pdequeue);
1401 slot = &xhci->slots[slotid-1];
1403 if (!slot->eps[epid-1]) {
1404 DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1405 return CC_EP_NOT_ENABLED_ERROR;
1408 epctx = slot->eps[epid-1];
1410 if (epctx->state != EP_STOPPED) {
1411 DPRINTF("xhci: set EP dequeue pointer while EP %d not stopped\n", epid);
1412 return CC_CONTEXT_STATE_ERROR;
1415 if (epctx->nr_pstreams) {
1416 uint32_t err;
1417 sctx = xhci_find_stream(epctx, streamid, &err);
1418 if (sctx == NULL) {
1419 return err;
1421 xhci_ring_init(xhci, &sctx->ring, dequeue & ~0xf);
1422 sctx->ring.ccs = dequeue & 1;
1423 } else {
1424 sctx = NULL;
1425 xhci_ring_init(xhci, &epctx->ring, dequeue & ~0xF);
1426 epctx->ring.ccs = dequeue & 1;
1429 xhci_set_ep_state(xhci, epctx, sctx, EP_STOPPED);
1431 return CC_SUCCESS;
1434 static int xhci_xfer_create_sgl(XHCITransfer *xfer, int in_xfer)
1436 XHCIState *xhci = xfer->epctx->xhci;
1437 int i;
1439 xfer->int_req = false;
1440 pci_dma_sglist_init(&xfer->sgl, PCI_DEVICE(xhci), xfer->trb_count);
1441 for (i = 0; i < xfer->trb_count; i++) {
1442 XHCITRB *trb = &xfer->trbs[i];
1443 dma_addr_t addr;
1444 unsigned int chunk = 0;
1446 if (trb->control & TRB_TR_IOC) {
1447 xfer->int_req = true;
1450 switch (TRB_TYPE(*trb)) {
1451 case TR_DATA:
1452 if ((!(trb->control & TRB_TR_DIR)) != (!in_xfer)) {
1453 DPRINTF("xhci: data direction mismatch for TR_DATA\n");
1454 goto err;
1456 /* fallthrough */
1457 case TR_NORMAL:
1458 case TR_ISOCH:
1459 addr = xhci_mask64(trb->parameter);
1460 chunk = trb->status & 0x1ffff;
1461 if (trb->control & TRB_TR_IDT) {
1462 if (chunk > 8 || in_xfer) {
1463 DPRINTF("xhci: invalid immediate data TRB\n");
1464 goto err;
1466 qemu_sglist_add(&xfer->sgl, trb->addr, chunk);
1467 } else {
1468 qemu_sglist_add(&xfer->sgl, addr, chunk);
1470 break;
1474 return 0;
1476 err:
1477 qemu_sglist_destroy(&xfer->sgl);
1478 xhci_die(xhci);
1479 return -1;
1482 static void xhci_xfer_unmap(XHCITransfer *xfer)
1484 usb_packet_unmap(&xfer->packet, &xfer->sgl);
1485 qemu_sglist_destroy(&xfer->sgl);
1488 static void xhci_xfer_report(XHCITransfer *xfer)
1490 uint32_t edtla = 0;
1491 unsigned int left;
1492 bool reported = 0;
1493 bool shortpkt = 0;
1494 XHCIEvent event = {ER_TRANSFER, CC_SUCCESS};
1495 XHCIState *xhci = xfer->epctx->xhci;
1496 int i;
1498 left = xfer->packet.actual_length;
1500 for (i = 0; i < xfer->trb_count; i++) {
1501 XHCITRB *trb = &xfer->trbs[i];
1502 unsigned int chunk = 0;
1504 switch (TRB_TYPE(*trb)) {
1505 case TR_SETUP:
1506 chunk = trb->status & 0x1ffff;
1507 if (chunk > 8) {
1508 chunk = 8;
1510 break;
1511 case TR_DATA:
1512 case TR_NORMAL:
1513 case TR_ISOCH:
1514 chunk = trb->status & 0x1ffff;
1515 if (chunk > left) {
1516 chunk = left;
1517 if (xfer->status == CC_SUCCESS) {
1518 shortpkt = 1;
1521 left -= chunk;
1522 edtla += chunk;
1523 break;
1524 case TR_STATUS:
1525 reported = 0;
1526 shortpkt = 0;
1527 break;
1530 if (!reported && ((trb->control & TRB_TR_IOC) ||
1531 (shortpkt && (trb->control & TRB_TR_ISP)) ||
1532 (xfer->status != CC_SUCCESS && left == 0))) {
1533 event.slotid = xfer->epctx->slotid;
1534 event.epid = xfer->epctx->epid;
1535 event.length = (trb->status & 0x1ffff) - chunk;
1536 event.flags = 0;
1537 event.ptr = trb->addr;
1538 if (xfer->status == CC_SUCCESS) {
1539 event.ccode = shortpkt ? CC_SHORT_PACKET : CC_SUCCESS;
1540 } else {
1541 event.ccode = xfer->status;
1543 if (TRB_TYPE(*trb) == TR_EVDATA) {
1544 event.ptr = trb->parameter;
1545 event.flags |= TRB_EV_ED;
1546 event.length = edtla & 0xffffff;
1547 DPRINTF("xhci_xfer_data: EDTLA=%d\n", event.length);
1548 edtla = 0;
1550 xhci_event(xhci, &event, TRB_INTR(*trb));
1551 reported = 1;
1552 if (xfer->status != CC_SUCCESS) {
1553 return;
1557 switch (TRB_TYPE(*trb)) {
1558 case TR_SETUP:
1559 reported = 0;
1560 shortpkt = 0;
1561 break;
1567 static void xhci_stall_ep(XHCITransfer *xfer)
1569 XHCIEPContext *epctx = xfer->epctx;
1570 XHCIState *xhci = epctx->xhci;
1571 uint32_t err;
1572 XHCIStreamContext *sctx;
1574 if (epctx->type == ET_ISO_IN || epctx->type == ET_ISO_OUT) {
1575 /* never halt isoch endpoints, 4.10.2 */
1576 return;
1579 if (epctx->nr_pstreams) {
1580 sctx = xhci_find_stream(epctx, xfer->streamid, &err);
1581 if (sctx == NULL) {
1582 return;
1584 sctx->ring.dequeue = xfer->trbs[0].addr;
1585 sctx->ring.ccs = xfer->trbs[0].ccs;
1586 xhci_set_ep_state(xhci, epctx, sctx, EP_HALTED);
1587 } else {
1588 epctx->ring.dequeue = xfer->trbs[0].addr;
1589 epctx->ring.ccs = xfer->trbs[0].ccs;
1590 xhci_set_ep_state(xhci, epctx, NULL, EP_HALTED);
1594 static int xhci_setup_packet(XHCITransfer *xfer)
1596 USBEndpoint *ep;
1597 int dir;
1599 dir = xfer->in_xfer ? USB_TOKEN_IN : USB_TOKEN_OUT;
1601 if (xfer->packet.ep) {
1602 ep = xfer->packet.ep;
1603 } else {
1604 ep = xhci_epid_to_usbep(xfer->epctx);
1605 if (!ep) {
1606 DPRINTF("xhci: slot %d has no device\n",
1607 xfer->epctx->slotid);
1608 return -1;
1612 xhci_xfer_create_sgl(xfer, dir == USB_TOKEN_IN); /* Also sets int_req */
1613 usb_packet_setup(&xfer->packet, dir, ep, xfer->streamid,
1614 xfer->trbs[0].addr, false, xfer->int_req);
1615 usb_packet_map(&xfer->packet, &xfer->sgl);
1616 DPRINTF("xhci: setup packet pid 0x%x addr %d ep %d\n",
1617 xfer->packet.pid, ep->dev->addr, ep->nr);
1618 return 0;
1621 static int xhci_try_complete_packet(XHCITransfer *xfer)
1623 if (xfer->packet.status == USB_RET_ASYNC) {
1624 trace_usb_xhci_xfer_async(xfer);
1625 xfer->running_async = 1;
1626 xfer->running_retry = 0;
1627 xfer->complete = 0;
1628 return 0;
1629 } else if (xfer->packet.status == USB_RET_NAK) {
1630 trace_usb_xhci_xfer_nak(xfer);
1631 xfer->running_async = 0;
1632 xfer->running_retry = 1;
1633 xfer->complete = 0;
1634 return 0;
1635 } else {
1636 xfer->running_async = 0;
1637 xfer->running_retry = 0;
1638 xfer->complete = 1;
1639 xhci_xfer_unmap(xfer);
1642 if (xfer->packet.status == USB_RET_SUCCESS) {
1643 trace_usb_xhci_xfer_success(xfer, xfer->packet.actual_length);
1644 xfer->status = CC_SUCCESS;
1645 xhci_xfer_report(xfer);
1646 return 0;
1649 /* error */
1650 trace_usb_xhci_xfer_error(xfer, xfer->packet.status);
1651 switch (xfer->packet.status) {
1652 case USB_RET_NODEV:
1653 case USB_RET_IOERROR:
1654 xfer->status = CC_USB_TRANSACTION_ERROR;
1655 xhci_xfer_report(xfer);
1656 xhci_stall_ep(xfer);
1657 break;
1658 case USB_RET_STALL:
1659 xfer->status = CC_STALL_ERROR;
1660 xhci_xfer_report(xfer);
1661 xhci_stall_ep(xfer);
1662 break;
1663 case USB_RET_BABBLE:
1664 xfer->status = CC_BABBLE_DETECTED;
1665 xhci_xfer_report(xfer);
1666 xhci_stall_ep(xfer);
1667 break;
1668 default:
1669 DPRINTF("%s: FIXME: status = %d\n", __func__,
1670 xfer->packet.status);
1671 FIXME("unhandled USB_RET_*");
1673 return 0;
1676 static int xhci_fire_ctl_transfer(XHCIState *xhci, XHCITransfer *xfer)
1678 XHCITRB *trb_setup, *trb_status;
1679 uint8_t bmRequestType;
1681 trb_setup = &xfer->trbs[0];
1682 trb_status = &xfer->trbs[xfer->trb_count-1];
1684 trace_usb_xhci_xfer_start(xfer, xfer->epctx->slotid,
1685 xfer->epctx->epid, xfer->streamid);
1687 /* at most one Event Data TRB allowed after STATUS */
1688 if (TRB_TYPE(*trb_status) == TR_EVDATA && xfer->trb_count > 2) {
1689 trb_status--;
1692 /* do some sanity checks */
1693 if (TRB_TYPE(*trb_setup) != TR_SETUP) {
1694 DPRINTF("xhci: ep0 first TD not SETUP: %d\n",
1695 TRB_TYPE(*trb_setup));
1696 return -1;
1698 if (TRB_TYPE(*trb_status) != TR_STATUS) {
1699 DPRINTF("xhci: ep0 last TD not STATUS: %d\n",
1700 TRB_TYPE(*trb_status));
1701 return -1;
1703 if (!(trb_setup->control & TRB_TR_IDT)) {
1704 DPRINTF("xhci: Setup TRB doesn't have IDT set\n");
1705 return -1;
1707 if ((trb_setup->status & 0x1ffff) != 8) {
1708 DPRINTF("xhci: Setup TRB has bad length (%d)\n",
1709 (trb_setup->status & 0x1ffff));
1710 return -1;
1713 bmRequestType = trb_setup->parameter;
1715 xfer->in_xfer = bmRequestType & USB_DIR_IN;
1716 xfer->iso_xfer = false;
1717 xfer->timed_xfer = false;
1719 if (xhci_setup_packet(xfer) < 0) {
1720 return -1;
1722 xfer->packet.parameter = trb_setup->parameter;
1724 usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1725 xhci_try_complete_packet(xfer);
1726 return 0;
1729 static void xhci_calc_intr_kick(XHCIState *xhci, XHCITransfer *xfer,
1730 XHCIEPContext *epctx, uint64_t mfindex)
1732 uint64_t asap = ((mfindex + epctx->interval - 1) &
1733 ~(epctx->interval-1));
1734 uint64_t kick = epctx->mfindex_last + epctx->interval;
1736 assert(epctx->interval != 0);
1737 xfer->mfindex_kick = MAX(asap, kick);
1740 static void xhci_calc_iso_kick(XHCIState *xhci, XHCITransfer *xfer,
1741 XHCIEPContext *epctx, uint64_t mfindex)
1743 if (xfer->trbs[0].control & TRB_TR_SIA) {
1744 uint64_t asap = ((mfindex + epctx->interval - 1) &
1745 ~(epctx->interval-1));
1746 if (asap >= epctx->mfindex_last &&
1747 asap <= epctx->mfindex_last + epctx->interval * 4) {
1748 xfer->mfindex_kick = epctx->mfindex_last + epctx->interval;
1749 } else {
1750 xfer->mfindex_kick = asap;
1752 } else {
1753 xfer->mfindex_kick = ((xfer->trbs[0].control >> TRB_TR_FRAMEID_SHIFT)
1754 & TRB_TR_FRAMEID_MASK) << 3;
1755 xfer->mfindex_kick |= mfindex & ~0x3fff;
1756 if (xfer->mfindex_kick + 0x100 < mfindex) {
1757 xfer->mfindex_kick += 0x4000;
1762 static void xhci_check_intr_iso_kick(XHCIState *xhci, XHCITransfer *xfer,
1763 XHCIEPContext *epctx, uint64_t mfindex)
1765 if (xfer->mfindex_kick > mfindex) {
1766 timer_mod(epctx->kick_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
1767 (xfer->mfindex_kick - mfindex) * 125000);
1768 xfer->running_retry = 1;
1769 } else {
1770 epctx->mfindex_last = xfer->mfindex_kick;
1771 timer_del(epctx->kick_timer);
1772 xfer->running_retry = 0;
1777 static int xhci_submit(XHCIState *xhci, XHCITransfer *xfer, XHCIEPContext *epctx)
1779 uint64_t mfindex;
1781 DPRINTF("xhci_submit(slotid=%d,epid=%d)\n", epctx->slotid, epctx->epid);
1783 xfer->in_xfer = epctx->type>>2;
1785 switch(epctx->type) {
1786 case ET_INTR_OUT:
1787 case ET_INTR_IN:
1788 xfer->pkts = 0;
1789 xfer->iso_xfer = false;
1790 xfer->timed_xfer = true;
1791 mfindex = xhci_mfindex_get(xhci);
1792 xhci_calc_intr_kick(xhci, xfer, epctx, mfindex);
1793 xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1794 if (xfer->running_retry) {
1795 return -1;
1797 break;
1798 case ET_BULK_OUT:
1799 case ET_BULK_IN:
1800 xfer->pkts = 0;
1801 xfer->iso_xfer = false;
1802 xfer->timed_xfer = false;
1803 break;
1804 case ET_ISO_OUT:
1805 case ET_ISO_IN:
1806 xfer->pkts = 1;
1807 xfer->iso_xfer = true;
1808 xfer->timed_xfer = true;
1809 mfindex = xhci_mfindex_get(xhci);
1810 xhci_calc_iso_kick(xhci, xfer, epctx, mfindex);
1811 xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1812 if (xfer->running_retry) {
1813 return -1;
1815 break;
1816 default:
1817 trace_usb_xhci_unimplemented("endpoint type", epctx->type);
1818 return -1;
1821 if (xhci_setup_packet(xfer) < 0) {
1822 return -1;
1824 usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1825 xhci_try_complete_packet(xfer);
1826 return 0;
1829 static int xhci_fire_transfer(XHCIState *xhci, XHCITransfer *xfer, XHCIEPContext *epctx)
1831 trace_usb_xhci_xfer_start(xfer, xfer->epctx->slotid,
1832 xfer->epctx->epid, xfer->streamid);
1833 return xhci_submit(xhci, xfer, epctx);
1836 static void xhci_kick_ep(XHCIState *xhci, unsigned int slotid,
1837 unsigned int epid, unsigned int streamid)
1839 XHCIEPContext *epctx;
1841 assert(slotid >= 1 && slotid <= xhci->numslots);
1842 assert(epid >= 1 && epid <= 31);
1844 if (!xhci->slots[slotid-1].enabled) {
1845 DPRINTF("xhci: xhci_kick_ep for disabled slot %d\n", slotid);
1846 return;
1848 epctx = xhci->slots[slotid-1].eps[epid-1];
1849 if (!epctx) {
1850 DPRINTF("xhci: xhci_kick_ep for disabled endpoint %d,%d\n",
1851 epid, slotid);
1852 return;
1855 if (epctx->kick_active) {
1856 return;
1858 xhci_kick_epctx(epctx, streamid);
1861 static void xhci_kick_epctx(XHCIEPContext *epctx, unsigned int streamid)
1863 XHCIState *xhci = epctx->xhci;
1864 XHCIStreamContext *stctx = NULL;
1865 XHCITransfer *xfer;
1866 XHCIRing *ring;
1867 USBEndpoint *ep = NULL;
1868 uint64_t mfindex;
1869 unsigned int count = 0;
1870 int length;
1871 int i;
1873 trace_usb_xhci_ep_kick(epctx->slotid, epctx->epid, streamid);
1874 assert(!epctx->kick_active);
1876 /* If the device has been detached, but the guest has not noticed this
1877 yet the 2 above checks will succeed, but we must NOT continue */
1878 if (!xhci->slots[epctx->slotid - 1].uport ||
1879 !xhci->slots[epctx->slotid - 1].uport->dev ||
1880 !xhci->slots[epctx->slotid - 1].uport->dev->attached) {
1881 return;
1884 if (epctx->retry) {
1885 XHCITransfer *xfer = epctx->retry;
1887 trace_usb_xhci_xfer_retry(xfer);
1888 assert(xfer->running_retry);
1889 if (xfer->timed_xfer) {
1890 /* time to kick the transfer? */
1891 mfindex = xhci_mfindex_get(xhci);
1892 xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1893 if (xfer->running_retry) {
1894 return;
1896 xfer->timed_xfer = 0;
1897 xfer->running_retry = 1;
1899 if (xfer->iso_xfer) {
1900 /* retry iso transfer */
1901 if (xhci_setup_packet(xfer) < 0) {
1902 return;
1904 usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1905 assert(xfer->packet.status != USB_RET_NAK);
1906 xhci_try_complete_packet(xfer);
1907 } else {
1908 /* retry nak'ed transfer */
1909 if (xhci_setup_packet(xfer) < 0) {
1910 return;
1912 usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1913 if (xfer->packet.status == USB_RET_NAK) {
1914 return;
1916 xhci_try_complete_packet(xfer);
1918 assert(!xfer->running_retry);
1919 if (xfer->complete) {
1920 /* update ring dequeue ptr */
1921 xhci_set_ep_state(xhci, epctx, stctx, epctx->state);
1922 xhci_ep_free_xfer(epctx->retry);
1924 epctx->retry = NULL;
1927 if (epctx->state == EP_HALTED) {
1928 DPRINTF("xhci: ep halted, not running schedule\n");
1929 return;
1933 if (epctx->nr_pstreams) {
1934 uint32_t err;
1935 stctx = xhci_find_stream(epctx, streamid, &err);
1936 if (stctx == NULL) {
1937 return;
1939 ring = &stctx->ring;
1940 xhci_set_ep_state(xhci, epctx, stctx, EP_RUNNING);
1941 } else {
1942 ring = &epctx->ring;
1943 streamid = 0;
1944 xhci_set_ep_state(xhci, epctx, NULL, EP_RUNNING);
1946 assert(ring->dequeue != 0);
1948 epctx->kick_active++;
1949 while (1) {
1950 length = xhci_ring_chain_length(xhci, ring);
1951 if (length <= 0) {
1952 if (epctx->type == ET_ISO_OUT || epctx->type == ET_ISO_IN) {
1953 /* 4.10.3.1 */
1954 XHCIEvent ev = { ER_TRANSFER };
1955 ev.ccode = epctx->type == ET_ISO_IN ?
1956 CC_RING_OVERRUN : CC_RING_UNDERRUN;
1957 ev.slotid = epctx->slotid;
1958 ev.epid = epctx->epid;
1959 ev.ptr = epctx->ring.dequeue;
1960 xhci_event(xhci, &ev, xhci->slots[epctx->slotid-1].intr);
1962 break;
1964 xfer = xhci_ep_alloc_xfer(epctx, length);
1965 if (xfer == NULL) {
1966 break;
1969 for (i = 0; i < length; i++) {
1970 TRBType type;
1971 type = xhci_ring_fetch(xhci, ring, &xfer->trbs[i], NULL);
1972 if (!type) {
1973 xhci_die(xhci);
1974 xhci_ep_free_xfer(xfer);
1975 epctx->kick_active--;
1976 return;
1979 xfer->streamid = streamid;
1981 if (epctx->epid == 1) {
1982 xhci_fire_ctl_transfer(xhci, xfer);
1983 } else {
1984 xhci_fire_transfer(xhci, xfer, epctx);
1986 if (xfer->complete) {
1987 /* update ring dequeue ptr */
1988 xhci_set_ep_state(xhci, epctx, stctx, epctx->state);
1989 xhci_ep_free_xfer(xfer);
1990 xfer = NULL;
1993 if (epctx->state == EP_HALTED) {
1994 break;
1996 if (xfer != NULL && xfer->running_retry) {
1997 DPRINTF("xhci: xfer nacked, stopping schedule\n");
1998 epctx->retry = xfer;
1999 break;
2001 if (count++ > TRANSFER_LIMIT) {
2002 trace_usb_xhci_enforced_limit("transfers");
2003 break;
2006 epctx->kick_active--;
2008 ep = xhci_epid_to_usbep(epctx);
2009 if (ep) {
2010 usb_device_flush_ep_queue(ep->dev, ep);
2014 static TRBCCode xhci_enable_slot(XHCIState *xhci, unsigned int slotid)
2016 trace_usb_xhci_slot_enable(slotid);
2017 assert(slotid >= 1 && slotid <= xhci->numslots);
2018 xhci->slots[slotid-1].enabled = 1;
2019 xhci->slots[slotid-1].uport = NULL;
2020 memset(xhci->slots[slotid-1].eps, 0, sizeof(XHCIEPContext*)*31);
2022 return CC_SUCCESS;
2025 static TRBCCode xhci_disable_slot(XHCIState *xhci, unsigned int slotid)
2027 int i;
2029 trace_usb_xhci_slot_disable(slotid);
2030 assert(slotid >= 1 && slotid <= xhci->numslots);
2032 for (i = 1; i <= 31; i++) {
2033 if (xhci->slots[slotid-1].eps[i-1]) {
2034 xhci_disable_ep(xhci, slotid, i);
2038 xhci->slots[slotid-1].enabled = 0;
2039 xhci->slots[slotid-1].addressed = 0;
2040 xhci->slots[slotid-1].uport = NULL;
2041 xhci->slots[slotid-1].intr = 0;
2042 return CC_SUCCESS;
2045 static USBPort *xhci_lookup_uport(XHCIState *xhci, uint32_t *slot_ctx)
2047 USBPort *uport;
2048 char path[32];
2049 int i, pos, port;
2051 port = (slot_ctx[1]>>16) & 0xFF;
2052 if (port < 1 || port > xhci->numports) {
2053 return NULL;
2055 port = xhci->ports[port-1].uport->index+1;
2056 pos = snprintf(path, sizeof(path), "%d", port);
2057 for (i = 0; i < 5; i++) {
2058 port = (slot_ctx[0] >> 4*i) & 0x0f;
2059 if (!port) {
2060 break;
2062 pos += snprintf(path + pos, sizeof(path) - pos, ".%d", port);
2065 QTAILQ_FOREACH(uport, &xhci->bus.used, next) {
2066 if (strcmp(uport->path, path) == 0) {
2067 return uport;
2070 return NULL;
2073 static TRBCCode xhci_address_slot(XHCIState *xhci, unsigned int slotid,
2074 uint64_t pictx, bool bsr)
2076 XHCISlot *slot;
2077 USBPort *uport;
2078 USBDevice *dev;
2079 dma_addr_t ictx, octx, dcbaap;
2080 uint64_t poctx;
2081 uint32_t ictl_ctx[2];
2082 uint32_t slot_ctx[4];
2083 uint32_t ep0_ctx[5];
2084 int i;
2085 TRBCCode res;
2087 assert(slotid >= 1 && slotid <= xhci->numslots);
2089 dcbaap = xhci_addr64(xhci->dcbaap_low, xhci->dcbaap_high);
2090 poctx = ldq_le_pci_dma(PCI_DEVICE(xhci), dcbaap + 8 * slotid);
2091 ictx = xhci_mask64(pictx);
2092 octx = xhci_mask64(poctx);
2094 DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2095 DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2097 xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2099 if (ictl_ctx[0] != 0x0 || ictl_ctx[1] != 0x3) {
2100 DPRINTF("xhci: invalid input context control %08x %08x\n",
2101 ictl_ctx[0], ictl_ctx[1]);
2102 return CC_TRB_ERROR;
2105 xhci_dma_read_u32s(xhci, ictx+32, slot_ctx, sizeof(slot_ctx));
2106 xhci_dma_read_u32s(xhci, ictx+64, ep0_ctx, sizeof(ep0_ctx));
2108 DPRINTF("xhci: input slot context: %08x %08x %08x %08x\n",
2109 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2111 DPRINTF("xhci: input ep0 context: %08x %08x %08x %08x %08x\n",
2112 ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2114 uport = xhci_lookup_uport(xhci, slot_ctx);
2115 if (uport == NULL) {
2116 DPRINTF("xhci: port not found\n");
2117 return CC_TRB_ERROR;
2119 trace_usb_xhci_slot_address(slotid, uport->path);
2121 dev = uport->dev;
2122 if (!dev || !dev->attached) {
2123 DPRINTF("xhci: port %s not connected\n", uport->path);
2124 return CC_USB_TRANSACTION_ERROR;
2127 for (i = 0; i < xhci->numslots; i++) {
2128 if (i == slotid-1) {
2129 continue;
2131 if (xhci->slots[i].uport == uport) {
2132 DPRINTF("xhci: port %s already assigned to slot %d\n",
2133 uport->path, i+1);
2134 return CC_TRB_ERROR;
2138 slot = &xhci->slots[slotid-1];
2139 slot->uport = uport;
2140 slot->ctx = octx;
2141 slot->intr = get_field(slot_ctx[2], TRB_INTR);
2143 /* Make sure device is in USB_STATE_DEFAULT state */
2144 usb_device_reset(dev);
2145 if (bsr) {
2146 slot_ctx[3] = SLOT_DEFAULT << SLOT_STATE_SHIFT;
2147 } else {
2148 USBPacket p;
2149 uint8_t buf[1];
2151 slot_ctx[3] = (SLOT_ADDRESSED << SLOT_STATE_SHIFT) | slotid;
2152 memset(&p, 0, sizeof(p));
2153 usb_packet_addbuf(&p, buf, sizeof(buf));
2154 usb_packet_setup(&p, USB_TOKEN_OUT,
2155 usb_ep_get(dev, USB_TOKEN_OUT, 0), 0,
2156 0, false, false);
2157 usb_device_handle_control(dev, &p,
2158 DeviceOutRequest | USB_REQ_SET_ADDRESS,
2159 slotid, 0, 0, NULL);
2160 assert(p.status != USB_RET_ASYNC);
2163 res = xhci_enable_ep(xhci, slotid, 1, octx+32, ep0_ctx);
2165 DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2166 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2167 DPRINTF("xhci: output ep0 context: %08x %08x %08x %08x %08x\n",
2168 ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2170 xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2171 xhci_dma_write_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2173 xhci->slots[slotid-1].addressed = 1;
2174 return res;
2178 static TRBCCode xhci_configure_slot(XHCIState *xhci, unsigned int slotid,
2179 uint64_t pictx, bool dc)
2181 dma_addr_t ictx, octx;
2182 uint32_t ictl_ctx[2];
2183 uint32_t slot_ctx[4];
2184 uint32_t islot_ctx[4];
2185 uint32_t ep_ctx[5];
2186 int i;
2187 TRBCCode res;
2189 trace_usb_xhci_slot_configure(slotid);
2190 assert(slotid >= 1 && slotid <= xhci->numslots);
2192 ictx = xhci_mask64(pictx);
2193 octx = xhci->slots[slotid-1].ctx;
2195 DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2196 DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2198 if (dc) {
2199 for (i = 2; i <= 31; i++) {
2200 if (xhci->slots[slotid-1].eps[i-1]) {
2201 xhci_disable_ep(xhci, slotid, i);
2205 xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2206 slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2207 slot_ctx[3] |= SLOT_ADDRESSED << SLOT_STATE_SHIFT;
2208 DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2209 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2210 xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2212 return CC_SUCCESS;
2215 xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2217 if ((ictl_ctx[0] & 0x3) != 0x0 || (ictl_ctx[1] & 0x3) != 0x1) {
2218 DPRINTF("xhci: invalid input context control %08x %08x\n",
2219 ictl_ctx[0], ictl_ctx[1]);
2220 return CC_TRB_ERROR;
2223 xhci_dma_read_u32s(xhci, ictx+32, islot_ctx, sizeof(islot_ctx));
2224 xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2226 if (SLOT_STATE(slot_ctx[3]) < SLOT_ADDRESSED) {
2227 DPRINTF("xhci: invalid slot state %08x\n", slot_ctx[3]);
2228 return CC_CONTEXT_STATE_ERROR;
2231 xhci_free_device_streams(xhci, slotid, ictl_ctx[0] | ictl_ctx[1]);
2233 for (i = 2; i <= 31; i++) {
2234 if (ictl_ctx[0] & (1<<i)) {
2235 xhci_disable_ep(xhci, slotid, i);
2237 if (ictl_ctx[1] & (1<<i)) {
2238 xhci_dma_read_u32s(xhci, ictx+32+(32*i), ep_ctx, sizeof(ep_ctx));
2239 DPRINTF("xhci: input ep%d.%d context: %08x %08x %08x %08x %08x\n",
2240 i/2, i%2, ep_ctx[0], ep_ctx[1], ep_ctx[2],
2241 ep_ctx[3], ep_ctx[4]);
2242 xhci_disable_ep(xhci, slotid, i);
2243 res = xhci_enable_ep(xhci, slotid, i, octx+(32*i), ep_ctx);
2244 if (res != CC_SUCCESS) {
2245 return res;
2247 DPRINTF("xhci: output ep%d.%d context: %08x %08x %08x %08x %08x\n",
2248 i/2, i%2, ep_ctx[0], ep_ctx[1], ep_ctx[2],
2249 ep_ctx[3], ep_ctx[4]);
2250 xhci_dma_write_u32s(xhci, octx+(32*i), ep_ctx, sizeof(ep_ctx));
2254 res = xhci_alloc_device_streams(xhci, slotid, ictl_ctx[1]);
2255 if (res != CC_SUCCESS) {
2256 for (i = 2; i <= 31; i++) {
2257 if (ictl_ctx[1] & (1u << i)) {
2258 xhci_disable_ep(xhci, slotid, i);
2261 return res;
2264 slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2265 slot_ctx[3] |= SLOT_CONFIGURED << SLOT_STATE_SHIFT;
2266 slot_ctx[0] &= ~(SLOT_CONTEXT_ENTRIES_MASK << SLOT_CONTEXT_ENTRIES_SHIFT);
2267 slot_ctx[0] |= islot_ctx[0] & (SLOT_CONTEXT_ENTRIES_MASK <<
2268 SLOT_CONTEXT_ENTRIES_SHIFT);
2269 DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2270 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2272 xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2274 return CC_SUCCESS;
2278 static TRBCCode xhci_evaluate_slot(XHCIState *xhci, unsigned int slotid,
2279 uint64_t pictx)
2281 dma_addr_t ictx, octx;
2282 uint32_t ictl_ctx[2];
2283 uint32_t iep0_ctx[5];
2284 uint32_t ep0_ctx[5];
2285 uint32_t islot_ctx[4];
2286 uint32_t slot_ctx[4];
2288 trace_usb_xhci_slot_evaluate(slotid);
2289 assert(slotid >= 1 && slotid <= xhci->numslots);
2291 ictx = xhci_mask64(pictx);
2292 octx = xhci->slots[slotid-1].ctx;
2294 DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2295 DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2297 xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2299 if (ictl_ctx[0] != 0x0 || ictl_ctx[1] & ~0x3) {
2300 DPRINTF("xhci: invalid input context control %08x %08x\n",
2301 ictl_ctx[0], ictl_ctx[1]);
2302 return CC_TRB_ERROR;
2305 if (ictl_ctx[1] & 0x1) {
2306 xhci_dma_read_u32s(xhci, ictx+32, islot_ctx, sizeof(islot_ctx));
2308 DPRINTF("xhci: input slot context: %08x %08x %08x %08x\n",
2309 islot_ctx[0], islot_ctx[1], islot_ctx[2], islot_ctx[3]);
2311 xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2313 slot_ctx[1] &= ~0xFFFF; /* max exit latency */
2314 slot_ctx[1] |= islot_ctx[1] & 0xFFFF;
2315 /* update interrupter target field */
2316 xhci->slots[slotid-1].intr = get_field(islot_ctx[2], TRB_INTR);
2317 set_field(&slot_ctx[2], xhci->slots[slotid-1].intr, TRB_INTR);
2319 DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2320 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2322 xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2325 if (ictl_ctx[1] & 0x2) {
2326 xhci_dma_read_u32s(xhci, ictx+64, iep0_ctx, sizeof(iep0_ctx));
2328 DPRINTF("xhci: input ep0 context: %08x %08x %08x %08x %08x\n",
2329 iep0_ctx[0], iep0_ctx[1], iep0_ctx[2],
2330 iep0_ctx[3], iep0_ctx[4]);
2332 xhci_dma_read_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2334 ep0_ctx[1] &= ~0xFFFF0000; /* max packet size*/
2335 ep0_ctx[1] |= iep0_ctx[1] & 0xFFFF0000;
2337 DPRINTF("xhci: output ep0 context: %08x %08x %08x %08x %08x\n",
2338 ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2340 xhci_dma_write_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2343 return CC_SUCCESS;
2346 static TRBCCode xhci_reset_slot(XHCIState *xhci, unsigned int slotid)
2348 uint32_t slot_ctx[4];
2349 dma_addr_t octx;
2350 int i;
2352 trace_usb_xhci_slot_reset(slotid);
2353 assert(slotid >= 1 && slotid <= xhci->numslots);
2355 octx = xhci->slots[slotid-1].ctx;
2357 DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2359 for (i = 2; i <= 31; i++) {
2360 if (xhci->slots[slotid-1].eps[i-1]) {
2361 xhci_disable_ep(xhci, slotid, i);
2365 xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2366 slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2367 slot_ctx[3] |= SLOT_DEFAULT << SLOT_STATE_SHIFT;
2368 DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2369 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2370 xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2372 return CC_SUCCESS;
2375 static unsigned int xhci_get_slot(XHCIState *xhci, XHCIEvent *event, XHCITRB *trb)
2377 unsigned int slotid;
2378 slotid = (trb->control >> TRB_CR_SLOTID_SHIFT) & TRB_CR_SLOTID_MASK;
2379 if (slotid < 1 || slotid > xhci->numslots) {
2380 DPRINTF("xhci: bad slot id %d\n", slotid);
2381 event->ccode = CC_TRB_ERROR;
2382 return 0;
2383 } else if (!xhci->slots[slotid-1].enabled) {
2384 DPRINTF("xhci: slot id %d not enabled\n", slotid);
2385 event->ccode = CC_SLOT_NOT_ENABLED_ERROR;
2386 return 0;
2388 return slotid;
2391 /* cleanup slot state on usb device detach */
2392 static void xhci_detach_slot(XHCIState *xhci, USBPort *uport)
2394 int slot, ep;
2396 for (slot = 0; slot < xhci->numslots; slot++) {
2397 if (xhci->slots[slot].uport == uport) {
2398 break;
2401 if (slot == xhci->numslots) {
2402 return;
2405 for (ep = 0; ep < 31; ep++) {
2406 if (xhci->slots[slot].eps[ep]) {
2407 xhci_ep_nuke_xfers(xhci, slot + 1, ep + 1, 0);
2410 xhci->slots[slot].uport = NULL;
2413 static TRBCCode xhci_get_port_bandwidth(XHCIState *xhci, uint64_t pctx)
2415 dma_addr_t ctx;
2416 uint8_t bw_ctx[xhci->numports+1];
2418 DPRINTF("xhci_get_port_bandwidth()\n");
2420 ctx = xhci_mask64(pctx);
2422 DPRINTF("xhci: bandwidth context at "DMA_ADDR_FMT"\n", ctx);
2424 /* TODO: actually implement real values here */
2425 bw_ctx[0] = 0;
2426 memset(&bw_ctx[1], 80, xhci->numports); /* 80% */
2427 pci_dma_write(PCI_DEVICE(xhci), ctx, bw_ctx, sizeof(bw_ctx));
2429 return CC_SUCCESS;
2432 static uint32_t rotl(uint32_t v, unsigned count)
2434 count &= 31;
2435 return (v << count) | (v >> (32 - count));
2439 static uint32_t xhci_nec_challenge(uint32_t hi, uint32_t lo)
2441 uint32_t val;
2442 val = rotl(lo - 0x49434878, 32 - ((hi>>8) & 0x1F));
2443 val += rotl(lo + 0x49434878, hi & 0x1F);
2444 val -= rotl(hi ^ 0x49434878, (lo >> 16) & 0x1F);
2445 return ~val;
2448 static void xhci_process_commands(XHCIState *xhci)
2450 XHCITRB trb;
2451 TRBType type;
2452 XHCIEvent event = {ER_COMMAND_COMPLETE, CC_SUCCESS};
2453 dma_addr_t addr;
2454 unsigned int i, slotid = 0, count = 0;
2456 DPRINTF("xhci_process_commands()\n");
2457 if (!xhci_running(xhci)) {
2458 DPRINTF("xhci_process_commands() called while xHC stopped or paused\n");
2459 return;
2462 xhci->crcr_low |= CRCR_CRR;
2464 while ((type = xhci_ring_fetch(xhci, &xhci->cmd_ring, &trb, &addr))) {
2465 event.ptr = addr;
2466 switch (type) {
2467 case CR_ENABLE_SLOT:
2468 for (i = 0; i < xhci->numslots; i++) {
2469 if (!xhci->slots[i].enabled) {
2470 break;
2473 if (i >= xhci->numslots) {
2474 DPRINTF("xhci: no device slots available\n");
2475 event.ccode = CC_NO_SLOTS_ERROR;
2476 } else {
2477 slotid = i+1;
2478 event.ccode = xhci_enable_slot(xhci, slotid);
2480 break;
2481 case CR_DISABLE_SLOT:
2482 slotid = xhci_get_slot(xhci, &event, &trb);
2483 if (slotid) {
2484 event.ccode = xhci_disable_slot(xhci, slotid);
2486 break;
2487 case CR_ADDRESS_DEVICE:
2488 slotid = xhci_get_slot(xhci, &event, &trb);
2489 if (slotid) {
2490 event.ccode = xhci_address_slot(xhci, slotid, trb.parameter,
2491 trb.control & TRB_CR_BSR);
2493 break;
2494 case CR_CONFIGURE_ENDPOINT:
2495 slotid = xhci_get_slot(xhci, &event, &trb);
2496 if (slotid) {
2497 event.ccode = xhci_configure_slot(xhci, slotid, trb.parameter,
2498 trb.control & TRB_CR_DC);
2500 break;
2501 case CR_EVALUATE_CONTEXT:
2502 slotid = xhci_get_slot(xhci, &event, &trb);
2503 if (slotid) {
2504 event.ccode = xhci_evaluate_slot(xhci, slotid, trb.parameter);
2506 break;
2507 case CR_STOP_ENDPOINT:
2508 slotid = xhci_get_slot(xhci, &event, &trb);
2509 if (slotid) {
2510 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2511 & TRB_CR_EPID_MASK;
2512 event.ccode = xhci_stop_ep(xhci, slotid, epid);
2514 break;
2515 case CR_RESET_ENDPOINT:
2516 slotid = xhci_get_slot(xhci, &event, &trb);
2517 if (slotid) {
2518 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2519 & TRB_CR_EPID_MASK;
2520 event.ccode = xhci_reset_ep(xhci, slotid, epid);
2522 break;
2523 case CR_SET_TR_DEQUEUE:
2524 slotid = xhci_get_slot(xhci, &event, &trb);
2525 if (slotid) {
2526 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2527 & TRB_CR_EPID_MASK;
2528 unsigned int streamid = (trb.status >> 16) & 0xffff;
2529 event.ccode = xhci_set_ep_dequeue(xhci, slotid,
2530 epid, streamid,
2531 trb.parameter);
2533 break;
2534 case CR_RESET_DEVICE:
2535 slotid = xhci_get_slot(xhci, &event, &trb);
2536 if (slotid) {
2537 event.ccode = xhci_reset_slot(xhci, slotid);
2539 break;
2540 case CR_GET_PORT_BANDWIDTH:
2541 event.ccode = xhci_get_port_bandwidth(xhci, trb.parameter);
2542 break;
2543 case CR_VENDOR_NEC_FIRMWARE_REVISION:
2544 if (xhci->nec_quirks) {
2545 event.type = 48; /* NEC reply */
2546 event.length = 0x3025;
2547 } else {
2548 event.ccode = CC_TRB_ERROR;
2550 break;
2551 case CR_VENDOR_NEC_CHALLENGE_RESPONSE:
2552 if (xhci->nec_quirks) {
2553 uint32_t chi = trb.parameter >> 32;
2554 uint32_t clo = trb.parameter;
2555 uint32_t val = xhci_nec_challenge(chi, clo);
2556 event.length = val & 0xFFFF;
2557 event.epid = val >> 16;
2558 slotid = val >> 24;
2559 event.type = 48; /* NEC reply */
2560 } else {
2561 event.ccode = CC_TRB_ERROR;
2563 break;
2564 default:
2565 trace_usb_xhci_unimplemented("command", type);
2566 event.ccode = CC_TRB_ERROR;
2567 break;
2569 event.slotid = slotid;
2570 xhci_event(xhci, &event, 0);
2572 if (count++ > COMMAND_LIMIT) {
2573 trace_usb_xhci_enforced_limit("commands");
2574 return;
2579 static bool xhci_port_have_device(XHCIPort *port)
2581 if (!port->uport->dev || !port->uport->dev->attached) {
2582 return false; /* no device present */
2584 if (!((1 << port->uport->dev->speed) & port->speedmask)) {
2585 return false; /* speed mismatch */
2587 return true;
2590 static void xhci_port_notify(XHCIPort *port, uint32_t bits)
2592 XHCIEvent ev = { ER_PORT_STATUS_CHANGE, CC_SUCCESS,
2593 port->portnr << 24 };
2595 if ((port->portsc & bits) == bits) {
2596 return;
2598 trace_usb_xhci_port_notify(port->portnr, bits);
2599 port->portsc |= bits;
2600 if (!xhci_running(port->xhci)) {
2601 return;
2603 xhci_event(port->xhci, &ev, 0);
2606 static void xhci_port_update(XHCIPort *port, int is_detach)
2608 uint32_t pls = PLS_RX_DETECT;
2610 assert(port);
2611 port->portsc = PORTSC_PP;
2612 if (!is_detach && xhci_port_have_device(port)) {
2613 port->portsc |= PORTSC_CCS;
2614 switch (port->uport->dev->speed) {
2615 case USB_SPEED_LOW:
2616 port->portsc |= PORTSC_SPEED_LOW;
2617 pls = PLS_POLLING;
2618 break;
2619 case USB_SPEED_FULL:
2620 port->portsc |= PORTSC_SPEED_FULL;
2621 pls = PLS_POLLING;
2622 break;
2623 case USB_SPEED_HIGH:
2624 port->portsc |= PORTSC_SPEED_HIGH;
2625 pls = PLS_POLLING;
2626 break;
2627 case USB_SPEED_SUPER:
2628 port->portsc |= PORTSC_SPEED_SUPER;
2629 port->portsc |= PORTSC_PED;
2630 pls = PLS_U0;
2631 break;
2634 set_field(&port->portsc, pls, PORTSC_PLS);
2635 trace_usb_xhci_port_link(port->portnr, pls);
2636 xhci_port_notify(port, PORTSC_CSC);
2639 static void xhci_port_reset(XHCIPort *port, bool warm_reset)
2641 trace_usb_xhci_port_reset(port->portnr, warm_reset);
2643 if (!xhci_port_have_device(port)) {
2644 return;
2647 usb_device_reset(port->uport->dev);
2649 switch (port->uport->dev->speed) {
2650 case USB_SPEED_SUPER:
2651 if (warm_reset) {
2652 port->portsc |= PORTSC_WRC;
2654 /* fall through */
2655 case USB_SPEED_LOW:
2656 case USB_SPEED_FULL:
2657 case USB_SPEED_HIGH:
2658 set_field(&port->portsc, PLS_U0, PORTSC_PLS);
2659 trace_usb_xhci_port_link(port->portnr, PLS_U0);
2660 port->portsc |= PORTSC_PED;
2661 break;
2664 port->portsc &= ~PORTSC_PR;
2665 xhci_port_notify(port, PORTSC_PRC);
2668 static void xhci_reset(DeviceState *dev)
2670 XHCIState *xhci = XHCI(dev);
2671 int i;
2673 trace_usb_xhci_reset();
2674 if (!(xhci->usbsts & USBSTS_HCH)) {
2675 DPRINTF("xhci: reset while running!\n");
2678 xhci->usbcmd = 0;
2679 xhci->usbsts = USBSTS_HCH;
2680 xhci->dnctrl = 0;
2681 xhci->crcr_low = 0;
2682 xhci->crcr_high = 0;
2683 xhci->dcbaap_low = 0;
2684 xhci->dcbaap_high = 0;
2685 xhci->config = 0;
2687 for (i = 0; i < xhci->numslots; i++) {
2688 xhci_disable_slot(xhci, i+1);
2691 for (i = 0; i < xhci->numports; i++) {
2692 xhci_port_update(xhci->ports + i, 0);
2695 for (i = 0; i < xhci->numintrs; i++) {
2696 xhci->intr[i].iman = 0;
2697 xhci->intr[i].imod = 0;
2698 xhci->intr[i].erstsz = 0;
2699 xhci->intr[i].erstba_low = 0;
2700 xhci->intr[i].erstba_high = 0;
2701 xhci->intr[i].erdp_low = 0;
2702 xhci->intr[i].erdp_high = 0;
2703 xhci->intr[i].msix_used = 0;
2705 xhci->intr[i].er_ep_idx = 0;
2706 xhci->intr[i].er_pcs = 1;
2707 xhci->intr[i].ev_buffer_put = 0;
2708 xhci->intr[i].ev_buffer_get = 0;
2711 xhci->mfindex_start = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
2712 xhci_mfwrap_update(xhci);
2715 static uint64_t xhci_cap_read(void *ptr, hwaddr reg, unsigned size)
2717 XHCIState *xhci = ptr;
2718 uint32_t ret;
2720 switch (reg) {
2721 case 0x00: /* HCIVERSION, CAPLENGTH */
2722 ret = 0x01000000 | LEN_CAP;
2723 break;
2724 case 0x04: /* HCSPARAMS 1 */
2725 ret = ((xhci->numports_2+xhci->numports_3)<<24)
2726 | (xhci->numintrs<<8) | xhci->numslots;
2727 break;
2728 case 0x08: /* HCSPARAMS 2 */
2729 ret = 0x0000000f;
2730 break;
2731 case 0x0c: /* HCSPARAMS 3 */
2732 ret = 0x00000000;
2733 break;
2734 case 0x10: /* HCCPARAMS */
2735 if (sizeof(dma_addr_t) == 4) {
2736 ret = 0x00080000 | (xhci->max_pstreams_mask << 12);
2737 } else {
2738 ret = 0x00080001 | (xhci->max_pstreams_mask << 12);
2740 break;
2741 case 0x14: /* DBOFF */
2742 ret = OFF_DOORBELL;
2743 break;
2744 case 0x18: /* RTSOFF */
2745 ret = OFF_RUNTIME;
2746 break;
2748 /* extended capabilities */
2749 case 0x20: /* Supported Protocol:00 */
2750 ret = 0x02000402; /* USB 2.0 */
2751 break;
2752 case 0x24: /* Supported Protocol:04 */
2753 ret = 0x20425355; /* "USB " */
2754 break;
2755 case 0x28: /* Supported Protocol:08 */
2756 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
2757 ret = (xhci->numports_2<<8) | (xhci->numports_3+1);
2758 } else {
2759 ret = (xhci->numports_2<<8) | 1;
2761 break;
2762 case 0x2c: /* Supported Protocol:0c */
2763 ret = 0x00000000; /* reserved */
2764 break;
2765 case 0x30: /* Supported Protocol:00 */
2766 ret = 0x03000002; /* USB 3.0 */
2767 break;
2768 case 0x34: /* Supported Protocol:04 */
2769 ret = 0x20425355; /* "USB " */
2770 break;
2771 case 0x38: /* Supported Protocol:08 */
2772 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
2773 ret = (xhci->numports_3<<8) | 1;
2774 } else {
2775 ret = (xhci->numports_3<<8) | (xhci->numports_2+1);
2777 break;
2778 case 0x3c: /* Supported Protocol:0c */
2779 ret = 0x00000000; /* reserved */
2780 break;
2781 default:
2782 trace_usb_xhci_unimplemented("cap read", reg);
2783 ret = 0;
2786 trace_usb_xhci_cap_read(reg, ret);
2787 return ret;
2790 static uint64_t xhci_port_read(void *ptr, hwaddr reg, unsigned size)
2792 XHCIPort *port = ptr;
2793 uint32_t ret;
2795 switch (reg) {
2796 case 0x00: /* PORTSC */
2797 ret = port->portsc;
2798 break;
2799 case 0x04: /* PORTPMSC */
2800 case 0x08: /* PORTLI */
2801 ret = 0;
2802 break;
2803 case 0x0c: /* reserved */
2804 default:
2805 trace_usb_xhci_unimplemented("port read", reg);
2806 ret = 0;
2809 trace_usb_xhci_port_read(port->portnr, reg, ret);
2810 return ret;
2813 static void xhci_port_write(void *ptr, hwaddr reg,
2814 uint64_t val, unsigned size)
2816 XHCIPort *port = ptr;
2817 uint32_t portsc, notify;
2819 trace_usb_xhci_port_write(port->portnr, reg, val);
2821 switch (reg) {
2822 case 0x00: /* PORTSC */
2823 /* write-1-to-start bits */
2824 if (val & PORTSC_WPR) {
2825 xhci_port_reset(port, true);
2826 break;
2828 if (val & PORTSC_PR) {
2829 xhci_port_reset(port, false);
2830 break;
2833 portsc = port->portsc;
2834 notify = 0;
2835 /* write-1-to-clear bits*/
2836 portsc &= ~(val & (PORTSC_CSC|PORTSC_PEC|PORTSC_WRC|PORTSC_OCC|
2837 PORTSC_PRC|PORTSC_PLC|PORTSC_CEC));
2838 if (val & PORTSC_LWS) {
2839 /* overwrite PLS only when LWS=1 */
2840 uint32_t old_pls = get_field(port->portsc, PORTSC_PLS);
2841 uint32_t new_pls = get_field(val, PORTSC_PLS);
2842 switch (new_pls) {
2843 case PLS_U0:
2844 if (old_pls != PLS_U0) {
2845 set_field(&portsc, new_pls, PORTSC_PLS);
2846 trace_usb_xhci_port_link(port->portnr, new_pls);
2847 notify = PORTSC_PLC;
2849 break;
2850 case PLS_U3:
2851 if (old_pls < PLS_U3) {
2852 set_field(&portsc, new_pls, PORTSC_PLS);
2853 trace_usb_xhci_port_link(port->portnr, new_pls);
2855 break;
2856 case PLS_RESUME:
2857 /* windows does this for some reason, don't spam stderr */
2858 break;
2859 default:
2860 DPRINTF("%s: ignore pls write (old %d, new %d)\n",
2861 __func__, old_pls, new_pls);
2862 break;
2865 /* read/write bits */
2866 portsc &= ~(PORTSC_PP|PORTSC_WCE|PORTSC_WDE|PORTSC_WOE);
2867 portsc |= (val & (PORTSC_PP|PORTSC_WCE|PORTSC_WDE|PORTSC_WOE));
2868 port->portsc = portsc;
2869 if (notify) {
2870 xhci_port_notify(port, notify);
2872 break;
2873 case 0x04: /* PORTPMSC */
2874 case 0x08: /* PORTLI */
2875 default:
2876 trace_usb_xhci_unimplemented("port write", reg);
2880 static uint64_t xhci_oper_read(void *ptr, hwaddr reg, unsigned size)
2882 XHCIState *xhci = ptr;
2883 uint32_t ret;
2885 switch (reg) {
2886 case 0x00: /* USBCMD */
2887 ret = xhci->usbcmd;
2888 break;
2889 case 0x04: /* USBSTS */
2890 ret = xhci->usbsts;
2891 break;
2892 case 0x08: /* PAGESIZE */
2893 ret = 1; /* 4KiB */
2894 break;
2895 case 0x14: /* DNCTRL */
2896 ret = xhci->dnctrl;
2897 break;
2898 case 0x18: /* CRCR low */
2899 ret = xhci->crcr_low & ~0xe;
2900 break;
2901 case 0x1c: /* CRCR high */
2902 ret = xhci->crcr_high;
2903 break;
2904 case 0x30: /* DCBAAP low */
2905 ret = xhci->dcbaap_low;
2906 break;
2907 case 0x34: /* DCBAAP high */
2908 ret = xhci->dcbaap_high;
2909 break;
2910 case 0x38: /* CONFIG */
2911 ret = xhci->config;
2912 break;
2913 default:
2914 trace_usb_xhci_unimplemented("oper read", reg);
2915 ret = 0;
2918 trace_usb_xhci_oper_read(reg, ret);
2919 return ret;
2922 static void xhci_oper_write(void *ptr, hwaddr reg,
2923 uint64_t val, unsigned size)
2925 XHCIState *xhci = ptr;
2926 DeviceState *d = DEVICE(ptr);
2928 trace_usb_xhci_oper_write(reg, val);
2930 switch (reg) {
2931 case 0x00: /* USBCMD */
2932 if ((val & USBCMD_RS) && !(xhci->usbcmd & USBCMD_RS)) {
2933 xhci_run(xhci);
2934 } else if (!(val & USBCMD_RS) && (xhci->usbcmd & USBCMD_RS)) {
2935 xhci_stop(xhci);
2937 if (val & USBCMD_CSS) {
2938 /* save state */
2939 xhci->usbsts &= ~USBSTS_SRE;
2941 if (val & USBCMD_CRS) {
2942 /* restore state */
2943 xhci->usbsts |= USBSTS_SRE;
2945 xhci->usbcmd = val & 0xc0f;
2946 xhci_mfwrap_update(xhci);
2947 if (val & USBCMD_HCRST) {
2948 xhci_reset(d);
2950 xhci_intx_update(xhci);
2951 break;
2953 case 0x04: /* USBSTS */
2954 /* these bits are write-1-to-clear */
2955 xhci->usbsts &= ~(val & (USBSTS_HSE|USBSTS_EINT|USBSTS_PCD|USBSTS_SRE));
2956 xhci_intx_update(xhci);
2957 break;
2959 case 0x14: /* DNCTRL */
2960 xhci->dnctrl = val & 0xffff;
2961 break;
2962 case 0x18: /* CRCR low */
2963 xhci->crcr_low = (val & 0xffffffcf) | (xhci->crcr_low & CRCR_CRR);
2964 break;
2965 case 0x1c: /* CRCR high */
2966 xhci->crcr_high = val;
2967 if (xhci->crcr_low & (CRCR_CA|CRCR_CS) && (xhci->crcr_low & CRCR_CRR)) {
2968 XHCIEvent event = {ER_COMMAND_COMPLETE, CC_COMMAND_RING_STOPPED};
2969 xhci->crcr_low &= ~CRCR_CRR;
2970 xhci_event(xhci, &event, 0);
2971 DPRINTF("xhci: command ring stopped (CRCR=%08x)\n", xhci->crcr_low);
2972 } else {
2973 dma_addr_t base = xhci_addr64(xhci->crcr_low & ~0x3f, val);
2974 xhci_ring_init(xhci, &xhci->cmd_ring, base);
2976 xhci->crcr_low &= ~(CRCR_CA | CRCR_CS);
2977 break;
2978 case 0x30: /* DCBAAP low */
2979 xhci->dcbaap_low = val & 0xffffffc0;
2980 break;
2981 case 0x34: /* DCBAAP high */
2982 xhci->dcbaap_high = val;
2983 break;
2984 case 0x38: /* CONFIG */
2985 xhci->config = val & 0xff;
2986 break;
2987 default:
2988 trace_usb_xhci_unimplemented("oper write", reg);
2992 static uint64_t xhci_runtime_read(void *ptr, hwaddr reg,
2993 unsigned size)
2995 XHCIState *xhci = ptr;
2996 uint32_t ret = 0;
2998 if (reg < 0x20) {
2999 switch (reg) {
3000 case 0x00: /* MFINDEX */
3001 ret = xhci_mfindex_get(xhci) & 0x3fff;
3002 break;
3003 default:
3004 trace_usb_xhci_unimplemented("runtime read", reg);
3005 break;
3007 } else {
3008 int v = (reg - 0x20) / 0x20;
3009 XHCIInterrupter *intr = &xhci->intr[v];
3010 switch (reg & 0x1f) {
3011 case 0x00: /* IMAN */
3012 ret = intr->iman;
3013 break;
3014 case 0x04: /* IMOD */
3015 ret = intr->imod;
3016 break;
3017 case 0x08: /* ERSTSZ */
3018 ret = intr->erstsz;
3019 break;
3020 case 0x10: /* ERSTBA low */
3021 ret = intr->erstba_low;
3022 break;
3023 case 0x14: /* ERSTBA high */
3024 ret = intr->erstba_high;
3025 break;
3026 case 0x18: /* ERDP low */
3027 ret = intr->erdp_low;
3028 break;
3029 case 0x1c: /* ERDP high */
3030 ret = intr->erdp_high;
3031 break;
3035 trace_usb_xhci_runtime_read(reg, ret);
3036 return ret;
3039 static void xhci_runtime_write(void *ptr, hwaddr reg,
3040 uint64_t val, unsigned size)
3042 XHCIState *xhci = ptr;
3043 int v = (reg - 0x20) / 0x20;
3044 XHCIInterrupter *intr = &xhci->intr[v];
3045 trace_usb_xhci_runtime_write(reg, val);
3047 if (reg < 0x20) {
3048 trace_usb_xhci_unimplemented("runtime write", reg);
3049 return;
3052 switch (reg & 0x1f) {
3053 case 0x00: /* IMAN */
3054 if (val & IMAN_IP) {
3055 intr->iman &= ~IMAN_IP;
3057 intr->iman &= ~IMAN_IE;
3058 intr->iman |= val & IMAN_IE;
3059 if (v == 0) {
3060 xhci_intx_update(xhci);
3062 xhci_msix_update(xhci, v);
3063 break;
3064 case 0x04: /* IMOD */
3065 intr->imod = val;
3066 break;
3067 case 0x08: /* ERSTSZ */
3068 intr->erstsz = val & 0xffff;
3069 break;
3070 case 0x10: /* ERSTBA low */
3071 if (xhci->nec_quirks) {
3072 /* NEC driver bug: it doesn't align this to 64 bytes */
3073 intr->erstba_low = val & 0xfffffff0;
3074 } else {
3075 intr->erstba_low = val & 0xffffffc0;
3077 break;
3078 case 0x14: /* ERSTBA high */
3079 intr->erstba_high = val;
3080 xhci_er_reset(xhci, v);
3081 break;
3082 case 0x18: /* ERDP low */
3083 if (val & ERDP_EHB) {
3084 intr->erdp_low &= ~ERDP_EHB;
3086 intr->erdp_low = (val & ~ERDP_EHB) | (intr->erdp_low & ERDP_EHB);
3087 if (val & ERDP_EHB) {
3088 dma_addr_t erdp = xhci_addr64(intr->erdp_low, intr->erdp_high);
3089 unsigned int dp_idx = (erdp - intr->er_start) / TRB_SIZE;
3090 if (erdp >= intr->er_start &&
3091 erdp < (intr->er_start + TRB_SIZE * intr->er_size) &&
3092 dp_idx != intr->er_ep_idx) {
3093 xhci_intr_raise(xhci, v);
3096 break;
3097 case 0x1c: /* ERDP high */
3098 intr->erdp_high = val;
3099 break;
3100 default:
3101 trace_usb_xhci_unimplemented("oper write", reg);
3105 static uint64_t xhci_doorbell_read(void *ptr, hwaddr reg,
3106 unsigned size)
3108 /* doorbells always read as 0 */
3109 trace_usb_xhci_doorbell_read(reg, 0);
3110 return 0;
3113 static void xhci_doorbell_write(void *ptr, hwaddr reg,
3114 uint64_t val, unsigned size)
3116 XHCIState *xhci = ptr;
3117 unsigned int epid, streamid;
3119 trace_usb_xhci_doorbell_write(reg, val);
3121 if (!xhci_running(xhci)) {
3122 DPRINTF("xhci: wrote doorbell while xHC stopped or paused\n");
3123 return;
3126 reg >>= 2;
3128 if (reg == 0) {
3129 if (val == 0) {
3130 xhci_process_commands(xhci);
3131 } else {
3132 DPRINTF("xhci: bad doorbell 0 write: 0x%x\n",
3133 (uint32_t)val);
3135 } else {
3136 epid = val & 0xff;
3137 streamid = (val >> 16) & 0xffff;
3138 if (reg > xhci->numslots) {
3139 DPRINTF("xhci: bad doorbell %d\n", (int)reg);
3140 } else if (epid == 0 || epid > 31) {
3141 DPRINTF("xhci: bad doorbell %d write: 0x%x\n",
3142 (int)reg, (uint32_t)val);
3143 } else {
3144 xhci_kick_ep(xhci, reg, epid, streamid);
3149 static void xhci_cap_write(void *opaque, hwaddr addr, uint64_t val,
3150 unsigned width)
3152 /* nothing */
3155 static const MemoryRegionOps xhci_cap_ops = {
3156 .read = xhci_cap_read,
3157 .write = xhci_cap_write,
3158 .valid.min_access_size = 1,
3159 .valid.max_access_size = 4,
3160 .impl.min_access_size = 4,
3161 .impl.max_access_size = 4,
3162 .endianness = DEVICE_LITTLE_ENDIAN,
3165 static const MemoryRegionOps xhci_oper_ops = {
3166 .read = xhci_oper_read,
3167 .write = xhci_oper_write,
3168 .valid.min_access_size = 4,
3169 .valid.max_access_size = 4,
3170 .endianness = DEVICE_LITTLE_ENDIAN,
3173 static const MemoryRegionOps xhci_port_ops = {
3174 .read = xhci_port_read,
3175 .write = xhci_port_write,
3176 .valid.min_access_size = 4,
3177 .valid.max_access_size = 4,
3178 .endianness = DEVICE_LITTLE_ENDIAN,
3181 static const MemoryRegionOps xhci_runtime_ops = {
3182 .read = xhci_runtime_read,
3183 .write = xhci_runtime_write,
3184 .valid.min_access_size = 4,
3185 .valid.max_access_size = 4,
3186 .endianness = DEVICE_LITTLE_ENDIAN,
3189 static const MemoryRegionOps xhci_doorbell_ops = {
3190 .read = xhci_doorbell_read,
3191 .write = xhci_doorbell_write,
3192 .valid.min_access_size = 4,
3193 .valid.max_access_size = 4,
3194 .endianness = DEVICE_LITTLE_ENDIAN,
3197 static void xhci_attach(USBPort *usbport)
3199 XHCIState *xhci = usbport->opaque;
3200 XHCIPort *port = xhci_lookup_port(xhci, usbport);
3202 xhci_port_update(port, 0);
3205 static void xhci_detach(USBPort *usbport)
3207 XHCIState *xhci = usbport->opaque;
3208 XHCIPort *port = xhci_lookup_port(xhci, usbport);
3210 xhci_detach_slot(xhci, usbport);
3211 xhci_port_update(port, 1);
3214 static void xhci_wakeup(USBPort *usbport)
3216 XHCIState *xhci = usbport->opaque;
3217 XHCIPort *port = xhci_lookup_port(xhci, usbport);
3219 assert(port);
3220 if (get_field(port->portsc, PORTSC_PLS) != PLS_U3) {
3221 return;
3223 set_field(&port->portsc, PLS_RESUME, PORTSC_PLS);
3224 xhci_port_notify(port, PORTSC_PLC);
3227 static void xhci_complete(USBPort *port, USBPacket *packet)
3229 XHCITransfer *xfer = container_of(packet, XHCITransfer, packet);
3231 if (packet->status == USB_RET_REMOVE_FROM_QUEUE) {
3232 xhci_ep_nuke_one_xfer(xfer, 0);
3233 return;
3235 xhci_try_complete_packet(xfer);
3236 xhci_kick_epctx(xfer->epctx, xfer->streamid);
3237 if (xfer->complete) {
3238 xhci_ep_free_xfer(xfer);
3242 static void xhci_child_detach(USBPort *uport, USBDevice *child)
3244 USBBus *bus = usb_bus_from_device(child);
3245 XHCIState *xhci = container_of(bus, XHCIState, bus);
3247 xhci_detach_slot(xhci, child->port);
3250 static USBPortOps xhci_uport_ops = {
3251 .attach = xhci_attach,
3252 .detach = xhci_detach,
3253 .wakeup = xhci_wakeup,
3254 .complete = xhci_complete,
3255 .child_detach = xhci_child_detach,
3258 static int xhci_find_epid(USBEndpoint *ep)
3260 if (ep->nr == 0) {
3261 return 1;
3263 if (ep->pid == USB_TOKEN_IN) {
3264 return ep->nr * 2 + 1;
3265 } else {
3266 return ep->nr * 2;
3270 static USBEndpoint *xhci_epid_to_usbep(XHCIEPContext *epctx)
3272 USBPort *uport;
3273 uint32_t token;
3275 if (!epctx) {
3276 return NULL;
3278 uport = epctx->xhci->slots[epctx->slotid - 1].uport;
3279 if (!uport || !uport->dev) {
3280 return NULL;
3282 token = (epctx->epid & 1) ? USB_TOKEN_IN : USB_TOKEN_OUT;
3283 return usb_ep_get(uport->dev, token, epctx->epid >> 1);
3286 static void xhci_wakeup_endpoint(USBBus *bus, USBEndpoint *ep,
3287 unsigned int stream)
3289 XHCIState *xhci = container_of(bus, XHCIState, bus);
3290 int slotid;
3292 DPRINTF("%s\n", __func__);
3293 slotid = ep->dev->addr;
3294 if (slotid == 0 || !xhci->slots[slotid-1].enabled) {
3295 DPRINTF("%s: oops, no slot for dev %d\n", __func__, ep->dev->addr);
3296 return;
3298 xhci_kick_ep(xhci, slotid, xhci_find_epid(ep), stream);
3301 static USBBusOps xhci_bus_ops = {
3302 .wakeup_endpoint = xhci_wakeup_endpoint,
3305 static void usb_xhci_init(XHCIState *xhci)
3307 DeviceState *dev = DEVICE(xhci);
3308 XHCIPort *port;
3309 unsigned int i, usbports, speedmask;
3311 xhci->usbsts = USBSTS_HCH;
3313 if (xhci->numports_2 > MAXPORTS_2) {
3314 xhci->numports_2 = MAXPORTS_2;
3316 if (xhci->numports_3 > MAXPORTS_3) {
3317 xhci->numports_3 = MAXPORTS_3;
3319 usbports = MAX(xhci->numports_2, xhci->numports_3);
3320 xhci->numports = xhci->numports_2 + xhci->numports_3;
3322 usb_bus_new(&xhci->bus, sizeof(xhci->bus), &xhci_bus_ops, dev);
3324 for (i = 0; i < usbports; i++) {
3325 speedmask = 0;
3326 if (i < xhci->numports_2) {
3327 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
3328 port = &xhci->ports[i + xhci->numports_3];
3329 port->portnr = i + 1 + xhci->numports_3;
3330 } else {
3331 port = &xhci->ports[i];
3332 port->portnr = i + 1;
3334 port->uport = &xhci->uports[i];
3335 port->speedmask =
3336 USB_SPEED_MASK_LOW |
3337 USB_SPEED_MASK_FULL |
3338 USB_SPEED_MASK_HIGH;
3339 assert(i < MAXPORTS);
3340 snprintf(port->name, sizeof(port->name), "usb2 port #%d", i+1);
3341 speedmask |= port->speedmask;
3343 if (i < xhci->numports_3) {
3344 if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
3345 port = &xhci->ports[i];
3346 port->portnr = i + 1;
3347 } else {
3348 port = &xhci->ports[i + xhci->numports_2];
3349 port->portnr = i + 1 + xhci->numports_2;
3351 port->uport = &xhci->uports[i];
3352 port->speedmask = USB_SPEED_MASK_SUPER;
3353 assert(i < MAXPORTS);
3354 snprintf(port->name, sizeof(port->name), "usb3 port #%d", i+1);
3355 speedmask |= port->speedmask;
3357 usb_register_port(&xhci->bus, &xhci->uports[i], xhci, i,
3358 &xhci_uport_ops, speedmask);
3362 static void usb_xhci_realize(struct PCIDevice *dev, Error **errp)
3364 int i, ret;
3365 Error *err = NULL;
3367 XHCIState *xhci = XHCI(dev);
3369 dev->config[PCI_CLASS_PROG] = 0x30; /* xHCI */
3370 dev->config[PCI_INTERRUPT_PIN] = 0x01; /* interrupt pin 1 */
3371 dev->config[PCI_CACHE_LINE_SIZE] = 0x10;
3372 dev->config[0x60] = 0x30; /* release number */
3374 if (strcmp(object_get_typename(OBJECT(dev)), TYPE_NEC_XHCI) == 0) {
3375 xhci->nec_quirks = true;
3377 if (xhci->numintrs > MAXINTRS) {
3378 xhci->numintrs = MAXINTRS;
3380 while (xhci->numintrs & (xhci->numintrs - 1)) { /* ! power of 2 */
3381 xhci->numintrs++;
3383 if (xhci->numintrs < 1) {
3384 xhci->numintrs = 1;
3386 if (xhci->numslots > MAXSLOTS) {
3387 xhci->numslots = MAXSLOTS;
3389 if (xhci->numslots < 1) {
3390 xhci->numslots = 1;
3392 if (xhci_get_flag(xhci, XHCI_FLAG_ENABLE_STREAMS)) {
3393 xhci->max_pstreams_mask = 7; /* == 256 primary streams */
3394 } else {
3395 xhci->max_pstreams_mask = 0;
3398 if (xhci->msi != ON_OFF_AUTO_OFF) {
3399 ret = msi_init(dev, 0x70, xhci->numintrs, true, false, &err);
3400 /* Any error other than -ENOTSUP(board's MSI support is broken)
3401 * is a programming error */
3402 assert(!ret || ret == -ENOTSUP);
3403 if (ret && xhci->msi == ON_OFF_AUTO_ON) {
3404 /* Can't satisfy user's explicit msi=on request, fail */
3405 error_append_hint(&err, "You have to use msi=auto (default) or "
3406 "msi=off with this machine type.\n");
3407 error_propagate(errp, err);
3408 return;
3410 assert(!err || xhci->msi == ON_OFF_AUTO_AUTO);
3411 /* With msi=auto, we fall back to MSI off silently */
3412 error_free(err);
3415 usb_xhci_init(xhci);
3416 xhci->mfwrap_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, xhci_mfwrap_timer, xhci);
3418 memory_region_init(&xhci->mem, OBJECT(xhci), "xhci", LEN_REGS);
3419 memory_region_init_io(&xhci->mem_cap, OBJECT(xhci), &xhci_cap_ops, xhci,
3420 "capabilities", LEN_CAP);
3421 memory_region_init_io(&xhci->mem_oper, OBJECT(xhci), &xhci_oper_ops, xhci,
3422 "operational", 0x400);
3423 memory_region_init_io(&xhci->mem_runtime, OBJECT(xhci), &xhci_runtime_ops, xhci,
3424 "runtime", LEN_RUNTIME);
3425 memory_region_init_io(&xhci->mem_doorbell, OBJECT(xhci), &xhci_doorbell_ops, xhci,
3426 "doorbell", LEN_DOORBELL);
3428 memory_region_add_subregion(&xhci->mem, 0, &xhci->mem_cap);
3429 memory_region_add_subregion(&xhci->mem, OFF_OPER, &xhci->mem_oper);
3430 memory_region_add_subregion(&xhci->mem, OFF_RUNTIME, &xhci->mem_runtime);
3431 memory_region_add_subregion(&xhci->mem, OFF_DOORBELL, &xhci->mem_doorbell);
3433 for (i = 0; i < xhci->numports; i++) {
3434 XHCIPort *port = &xhci->ports[i];
3435 uint32_t offset = OFF_OPER + 0x400 + 0x10 * i;
3436 port->xhci = xhci;
3437 memory_region_init_io(&port->mem, OBJECT(xhci), &xhci_port_ops, port,
3438 port->name, 0x10);
3439 memory_region_add_subregion(&xhci->mem, offset, &port->mem);
3442 pci_register_bar(dev, 0,
3443 PCI_BASE_ADDRESS_SPACE_MEMORY|PCI_BASE_ADDRESS_MEM_TYPE_64,
3444 &xhci->mem);
3446 if (pci_bus_is_express(pci_get_bus(dev)) ||
3447 xhci_get_flag(xhci, XHCI_FLAG_FORCE_PCIE_ENDCAP)) {
3448 ret = pcie_endpoint_cap_init(dev, 0xa0);
3449 assert(ret > 0);
3452 if (xhci->msix != ON_OFF_AUTO_OFF) {
3453 /* TODO check for errors, and should fail when msix=on */
3454 msix_init(dev, xhci->numintrs,
3455 &xhci->mem, 0, OFF_MSIX_TABLE,
3456 &xhci->mem, 0, OFF_MSIX_PBA,
3457 0x90, NULL);
3461 static void usb_xhci_exit(PCIDevice *dev)
3463 int i;
3464 XHCIState *xhci = XHCI(dev);
3466 trace_usb_xhci_exit();
3468 for (i = 0; i < xhci->numslots; i++) {
3469 xhci_disable_slot(xhci, i + 1);
3472 if (xhci->mfwrap_timer) {
3473 timer_del(xhci->mfwrap_timer);
3474 timer_free(xhci->mfwrap_timer);
3475 xhci->mfwrap_timer = NULL;
3478 memory_region_del_subregion(&xhci->mem, &xhci->mem_cap);
3479 memory_region_del_subregion(&xhci->mem, &xhci->mem_oper);
3480 memory_region_del_subregion(&xhci->mem, &xhci->mem_runtime);
3481 memory_region_del_subregion(&xhci->mem, &xhci->mem_doorbell);
3483 for (i = 0; i < xhci->numports; i++) {
3484 XHCIPort *port = &xhci->ports[i];
3485 memory_region_del_subregion(&xhci->mem, &port->mem);
3488 /* destroy msix memory region */
3489 if (dev->msix_table && dev->msix_pba
3490 && dev->msix_entry_used) {
3491 msix_uninit(dev, &xhci->mem, &xhci->mem);
3494 usb_bus_release(&xhci->bus);
3497 static int usb_xhci_post_load(void *opaque, int version_id)
3499 XHCIState *xhci = opaque;
3500 PCIDevice *pci_dev = PCI_DEVICE(xhci);
3501 XHCISlot *slot;
3502 XHCIEPContext *epctx;
3503 dma_addr_t dcbaap, pctx;
3504 uint32_t slot_ctx[4];
3505 uint32_t ep_ctx[5];
3506 int slotid, epid, state, intr;
3508 dcbaap = xhci_addr64(xhci->dcbaap_low, xhci->dcbaap_high);
3510 for (slotid = 1; slotid <= xhci->numslots; slotid++) {
3511 slot = &xhci->slots[slotid-1];
3512 if (!slot->addressed) {
3513 continue;
3515 slot->ctx =
3516 xhci_mask64(ldq_le_pci_dma(pci_dev, dcbaap + 8 * slotid));
3517 xhci_dma_read_u32s(xhci, slot->ctx, slot_ctx, sizeof(slot_ctx));
3518 slot->uport = xhci_lookup_uport(xhci, slot_ctx);
3519 if (!slot->uport) {
3520 /* should not happen, but may trigger on guest bugs */
3521 slot->enabled = 0;
3522 slot->addressed = 0;
3523 continue;
3525 assert(slot->uport && slot->uport->dev);
3527 for (epid = 1; epid <= 31; epid++) {
3528 pctx = slot->ctx + 32 * epid;
3529 xhci_dma_read_u32s(xhci, pctx, ep_ctx, sizeof(ep_ctx));
3530 state = ep_ctx[0] & EP_STATE_MASK;
3531 if (state == EP_DISABLED) {
3532 continue;
3534 epctx = xhci_alloc_epctx(xhci, slotid, epid);
3535 slot->eps[epid-1] = epctx;
3536 xhci_init_epctx(epctx, pctx, ep_ctx);
3537 epctx->state = state;
3538 if (state == EP_RUNNING) {
3539 /* kick endpoint after vmload is finished */
3540 timer_mod(epctx->kick_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
3545 for (intr = 0; intr < xhci->numintrs; intr++) {
3546 if (xhci->intr[intr].msix_used) {
3547 msix_vector_use(pci_dev, intr);
3548 } else {
3549 msix_vector_unuse(pci_dev, intr);
3553 return 0;
3556 static const VMStateDescription vmstate_xhci_ring = {
3557 .name = "xhci-ring",
3558 .version_id = 1,
3559 .fields = (VMStateField[]) {
3560 VMSTATE_UINT64(dequeue, XHCIRing),
3561 VMSTATE_BOOL(ccs, XHCIRing),
3562 VMSTATE_END_OF_LIST()
3566 static const VMStateDescription vmstate_xhci_port = {
3567 .name = "xhci-port",
3568 .version_id = 1,
3569 .fields = (VMStateField[]) {
3570 VMSTATE_UINT32(portsc, XHCIPort),
3571 VMSTATE_END_OF_LIST()
3575 static const VMStateDescription vmstate_xhci_slot = {
3576 .name = "xhci-slot",
3577 .version_id = 1,
3578 .fields = (VMStateField[]) {
3579 VMSTATE_BOOL(enabled, XHCISlot),
3580 VMSTATE_BOOL(addressed, XHCISlot),
3581 VMSTATE_END_OF_LIST()
3585 static const VMStateDescription vmstate_xhci_event = {
3586 .name = "xhci-event",
3587 .version_id = 1,
3588 .fields = (VMStateField[]) {
3589 VMSTATE_UINT32(type, XHCIEvent),
3590 VMSTATE_UINT32(ccode, XHCIEvent),
3591 VMSTATE_UINT64(ptr, XHCIEvent),
3592 VMSTATE_UINT32(length, XHCIEvent),
3593 VMSTATE_UINT32(flags, XHCIEvent),
3594 VMSTATE_UINT8(slotid, XHCIEvent),
3595 VMSTATE_UINT8(epid, XHCIEvent),
3596 VMSTATE_END_OF_LIST()
3600 static bool xhci_er_full(void *opaque, int version_id)
3602 return false;
3605 static const VMStateDescription vmstate_xhci_intr = {
3606 .name = "xhci-intr",
3607 .version_id = 1,
3608 .fields = (VMStateField[]) {
3609 /* registers */
3610 VMSTATE_UINT32(iman, XHCIInterrupter),
3611 VMSTATE_UINT32(imod, XHCIInterrupter),
3612 VMSTATE_UINT32(erstsz, XHCIInterrupter),
3613 VMSTATE_UINT32(erstba_low, XHCIInterrupter),
3614 VMSTATE_UINT32(erstba_high, XHCIInterrupter),
3615 VMSTATE_UINT32(erdp_low, XHCIInterrupter),
3616 VMSTATE_UINT32(erdp_high, XHCIInterrupter),
3618 /* state */
3619 VMSTATE_BOOL(msix_used, XHCIInterrupter),
3620 VMSTATE_BOOL(er_pcs, XHCIInterrupter),
3621 VMSTATE_UINT64(er_start, XHCIInterrupter),
3622 VMSTATE_UINT32(er_size, XHCIInterrupter),
3623 VMSTATE_UINT32(er_ep_idx, XHCIInterrupter),
3625 /* event queue (used if ring is full) */
3626 VMSTATE_BOOL(er_full_unused, XHCIInterrupter),
3627 VMSTATE_UINT32_TEST(ev_buffer_put, XHCIInterrupter, xhci_er_full),
3628 VMSTATE_UINT32_TEST(ev_buffer_get, XHCIInterrupter, xhci_er_full),
3629 VMSTATE_STRUCT_ARRAY_TEST(ev_buffer, XHCIInterrupter, EV_QUEUE,
3630 xhci_er_full, 1,
3631 vmstate_xhci_event, XHCIEvent),
3633 VMSTATE_END_OF_LIST()
3637 static const VMStateDescription vmstate_xhci = {
3638 .name = "xhci",
3639 .version_id = 1,
3640 .post_load = usb_xhci_post_load,
3641 .fields = (VMStateField[]) {
3642 VMSTATE_PCI_DEVICE(parent_obj, XHCIState),
3643 VMSTATE_MSIX(parent_obj, XHCIState),
3645 VMSTATE_STRUCT_VARRAY_UINT32(ports, XHCIState, numports, 1,
3646 vmstate_xhci_port, XHCIPort),
3647 VMSTATE_STRUCT_VARRAY_UINT32(slots, XHCIState, numslots, 1,
3648 vmstate_xhci_slot, XHCISlot),
3649 VMSTATE_STRUCT_VARRAY_UINT32(intr, XHCIState, numintrs, 1,
3650 vmstate_xhci_intr, XHCIInterrupter),
3652 /* Operational Registers */
3653 VMSTATE_UINT32(usbcmd, XHCIState),
3654 VMSTATE_UINT32(usbsts, XHCIState),
3655 VMSTATE_UINT32(dnctrl, XHCIState),
3656 VMSTATE_UINT32(crcr_low, XHCIState),
3657 VMSTATE_UINT32(crcr_high, XHCIState),
3658 VMSTATE_UINT32(dcbaap_low, XHCIState),
3659 VMSTATE_UINT32(dcbaap_high, XHCIState),
3660 VMSTATE_UINT32(config, XHCIState),
3662 /* Runtime Registers & state */
3663 VMSTATE_INT64(mfindex_start, XHCIState),
3664 VMSTATE_TIMER_PTR(mfwrap_timer, XHCIState),
3665 VMSTATE_STRUCT(cmd_ring, XHCIState, 1, vmstate_xhci_ring, XHCIRing),
3667 VMSTATE_END_OF_LIST()
3671 static Property xhci_properties[] = {
3672 DEFINE_PROP_BIT("streams", XHCIState, flags,
3673 XHCI_FLAG_ENABLE_STREAMS, true),
3674 DEFINE_PROP_UINT32("p2", XHCIState, numports_2, 4),
3675 DEFINE_PROP_UINT32("p3", XHCIState, numports_3, 4),
3676 DEFINE_PROP_END_OF_LIST(),
3679 static void xhci_instance_init(Object *obj)
3681 /* QEMU_PCI_CAP_EXPRESS initialization does not depend on QEMU command
3682 * line, therefore, no need to wait to realize like other devices */
3683 PCI_DEVICE(obj)->cap_present |= QEMU_PCI_CAP_EXPRESS;
3686 static void xhci_class_init(ObjectClass *klass, void *data)
3688 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
3689 DeviceClass *dc = DEVICE_CLASS(klass);
3691 dc->vmsd = &vmstate_xhci;
3692 dc->props = xhci_properties;
3693 dc->reset = xhci_reset;
3694 set_bit(DEVICE_CATEGORY_USB, dc->categories);
3695 k->realize = usb_xhci_realize;
3696 k->exit = usb_xhci_exit;
3697 k->class_id = PCI_CLASS_SERIAL_USB;
3700 static const TypeInfo xhci_info = {
3701 .name = TYPE_XHCI,
3702 .parent = TYPE_PCI_DEVICE,
3703 .instance_size = sizeof(XHCIState),
3704 .class_init = xhci_class_init,
3705 .instance_init = xhci_instance_init,
3706 .abstract = true,
3707 .interfaces = (InterfaceInfo[]) {
3708 { INTERFACE_PCIE_DEVICE },
3709 { INTERFACE_CONVENTIONAL_PCI_DEVICE },
3714 static void qemu_xhci_class_init(ObjectClass *klass, void *data)
3716 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
3718 k->vendor_id = PCI_VENDOR_ID_REDHAT;
3719 k->device_id = PCI_DEVICE_ID_REDHAT_XHCI;
3720 k->revision = 0x01;
3723 static void qemu_xhci_instance_init(Object *obj)
3725 XHCIState *xhci = XHCI(obj);
3727 xhci->msi = ON_OFF_AUTO_OFF;
3728 xhci->msix = ON_OFF_AUTO_AUTO;
3729 xhci->numintrs = MAXINTRS;
3730 xhci->numslots = MAXSLOTS;
3731 xhci_set_flag(xhci, XHCI_FLAG_SS_FIRST);
3734 static const TypeInfo qemu_xhci_info = {
3735 .name = TYPE_QEMU_XHCI,
3736 .parent = TYPE_XHCI,
3737 .class_init = qemu_xhci_class_init,
3738 .instance_init = qemu_xhci_instance_init,
3741 static void xhci_register_types(void)
3743 type_register_static(&xhci_info);
3744 type_register_static(&qemu_xhci_info);
3747 type_init(xhci_register_types)