xref: /openbmc/qemu/hw/usb/hcd-xhci.c (revision db1015e9)
1 /*
2  * USB xHCI controller emulation
3  *
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
7  *
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.
12  *
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.
17  *
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/>.
20  */
21 
22 #include "qemu/osdep.h"
23 #include "qemu/timer.h"
24 #include "qemu/module.h"
25 #include "qemu/queue.h"
26 #include "hw/usb.h"
27 #include "migration/vmstate.h"
28 #include "hw/pci/pci.h"
29 #include "hw/qdev-properties.h"
30 #include "hw/pci/msi.h"
31 #include "hw/pci/msix.h"
32 #include "trace.h"
33 #include "qapi/error.h"
34 
35 #include "hcd-xhci.h"
36 
37 //#define DEBUG_XHCI
38 //#define DEBUG_DATA
39 
40 #ifdef DEBUG_XHCI
41 #define DPRINTF(...) fprintf(stderr, __VA_ARGS__)
42 #else
43 #define DPRINTF(...) do {} while (0)
44 #endif
45 #define FIXME(_msg) do { fprintf(stderr, "FIXME %s:%d %s\n", \
46                                  __func__, __LINE__, _msg); abort(); } while (0)
47 
48 #define TRB_LINK_LIMIT  32
49 #define COMMAND_LIMIT   256
50 #define TRANSFER_LIMIT  256
51 
52 #define LEN_CAP         0x40
53 #define LEN_OPER        (0x400 + 0x10 * MAXPORTS)
54 #define LEN_RUNTIME     ((MAXINTRS + 1) * 0x20)
55 #define LEN_DOORBELL    ((MAXSLOTS + 1) * 0x20)
56 
57 #define OFF_OPER        LEN_CAP
58 #define OFF_RUNTIME     0x1000
59 #define OFF_DOORBELL    0x2000
60 #define OFF_MSIX_TABLE  0x3000
61 #define OFF_MSIX_PBA    0x3800
62 /* must be power of 2 */
63 #define LEN_REGS        0x4000
64 
65 #if (OFF_OPER + LEN_OPER) > OFF_RUNTIME
66 #error Increase OFF_RUNTIME
67 #endif
68 #if (OFF_RUNTIME + LEN_RUNTIME) > OFF_DOORBELL
69 #error Increase OFF_DOORBELL
70 #endif
71 #if (OFF_DOORBELL + LEN_DOORBELL) > LEN_REGS
72 # error Increase LEN_REGS
73 #endif
74 
75 /* bit definitions */
76 #define USBCMD_RS       (1<<0)
77 #define USBCMD_HCRST    (1<<1)
78 #define USBCMD_INTE     (1<<2)
79 #define USBCMD_HSEE     (1<<3)
80 #define USBCMD_LHCRST   (1<<7)
81 #define USBCMD_CSS      (1<<8)
82 #define USBCMD_CRS      (1<<9)
83 #define USBCMD_EWE      (1<<10)
84 #define USBCMD_EU3S     (1<<11)
85 
86 #define USBSTS_HCH      (1<<0)
87 #define USBSTS_HSE      (1<<2)
88 #define USBSTS_EINT     (1<<3)
89 #define USBSTS_PCD      (1<<4)
90 #define USBSTS_SSS      (1<<8)
91 #define USBSTS_RSS      (1<<9)
92 #define USBSTS_SRE      (1<<10)
93 #define USBSTS_CNR      (1<<11)
94 #define USBSTS_HCE      (1<<12)
95 
96 
97 #define PORTSC_CCS          (1<<0)
98 #define PORTSC_PED          (1<<1)
99 #define PORTSC_OCA          (1<<3)
100 #define PORTSC_PR           (1<<4)
101 #define PORTSC_PLS_SHIFT        5
102 #define PORTSC_PLS_MASK     0xf
103 #define PORTSC_PP           (1<<9)
104 #define PORTSC_SPEED_SHIFT      10
105 #define PORTSC_SPEED_MASK   0xf
106 #define PORTSC_SPEED_FULL   (1<<10)
107 #define PORTSC_SPEED_LOW    (2<<10)
108 #define PORTSC_SPEED_HIGH   (3<<10)
109 #define PORTSC_SPEED_SUPER  (4<<10)
110 #define PORTSC_PIC_SHIFT        14
111 #define PORTSC_PIC_MASK     0x3
112 #define PORTSC_LWS          (1<<16)
113 #define PORTSC_CSC          (1<<17)
114 #define PORTSC_PEC          (1<<18)
115 #define PORTSC_WRC          (1<<19)
116 #define PORTSC_OCC          (1<<20)
117 #define PORTSC_PRC          (1<<21)
118 #define PORTSC_PLC          (1<<22)
119 #define PORTSC_CEC          (1<<23)
120 #define PORTSC_CAS          (1<<24)
121 #define PORTSC_WCE          (1<<25)
122 #define PORTSC_WDE          (1<<26)
123 #define PORTSC_WOE          (1<<27)
124 #define PORTSC_DR           (1<<30)
125 #define PORTSC_WPR          (1<<31)
126 
127 #define CRCR_RCS        (1<<0)
128 #define CRCR_CS         (1<<1)
129 #define CRCR_CA         (1<<2)
130 #define CRCR_CRR        (1<<3)
131 
132 #define IMAN_IP         (1<<0)
133 #define IMAN_IE         (1<<1)
134 
135 #define ERDP_EHB        (1<<3)
136 
137 #define TRB_SIZE 16
138 typedef struct XHCITRB {
139     uint64_t parameter;
140     uint32_t status;
141     uint32_t control;
142     dma_addr_t addr;
143     bool ccs;
144 } XHCITRB;
145 
146 enum {
147     PLS_U0              =  0,
148     PLS_U1              =  1,
149     PLS_U2              =  2,
150     PLS_U3              =  3,
151     PLS_DISABLED        =  4,
152     PLS_RX_DETECT       =  5,
153     PLS_INACTIVE        =  6,
154     PLS_POLLING         =  7,
155     PLS_RECOVERY        =  8,
156     PLS_HOT_RESET       =  9,
157     PLS_COMPILANCE_MODE = 10,
158     PLS_TEST_MODE       = 11,
159     PLS_RESUME          = 15,
160 };
161 
162 #define CR_LINK TR_LINK
163 
164 #define TRB_C               (1<<0)
165 #define TRB_TYPE_SHIFT          10
166 #define TRB_TYPE_MASK       0x3f
167 #define TRB_TYPE(t)         (((t).control >> TRB_TYPE_SHIFT) & TRB_TYPE_MASK)
168 
169 #define TRB_EV_ED           (1<<2)
170 
171 #define TRB_TR_ENT          (1<<1)
172 #define TRB_TR_ISP          (1<<2)
173 #define TRB_TR_NS           (1<<3)
174 #define TRB_TR_CH           (1<<4)
175 #define TRB_TR_IOC          (1<<5)
176 #define TRB_TR_IDT          (1<<6)
177 #define TRB_TR_TBC_SHIFT        7
178 #define TRB_TR_TBC_MASK     0x3
179 #define TRB_TR_BEI          (1<<9)
180 #define TRB_TR_TLBPC_SHIFT      16
181 #define TRB_TR_TLBPC_MASK   0xf
182 #define TRB_TR_FRAMEID_SHIFT    20
183 #define TRB_TR_FRAMEID_MASK 0x7ff
184 #define TRB_TR_SIA          (1<<31)
185 
186 #define TRB_TR_DIR          (1<<16)
187 
188 #define TRB_CR_SLOTID_SHIFT     24
189 #define TRB_CR_SLOTID_MASK  0xff
190 #define TRB_CR_EPID_SHIFT       16
191 #define TRB_CR_EPID_MASK    0x1f
192 
193 #define TRB_CR_BSR          (1<<9)
194 #define TRB_CR_DC           (1<<9)
195 
196 #define TRB_LK_TC           (1<<1)
197 
198 #define TRB_INTR_SHIFT          22
199 #define TRB_INTR_MASK       0x3ff
200 #define TRB_INTR(t)         (((t).status >> TRB_INTR_SHIFT) & TRB_INTR_MASK)
201 
202 #define EP_TYPE_MASK        0x7
203 #define EP_TYPE_SHIFT           3
204 
205 #define EP_STATE_MASK       0x7
206 #define EP_DISABLED         (0<<0)
207 #define EP_RUNNING          (1<<0)
208 #define EP_HALTED           (2<<0)
209 #define EP_STOPPED          (3<<0)
210 #define EP_ERROR            (4<<0)
211 
212 #define SLOT_STATE_MASK     0x1f
213 #define SLOT_STATE_SHIFT        27
214 #define SLOT_STATE(s)       (((s)>>SLOT_STATE_SHIFT)&SLOT_STATE_MASK)
215 #define SLOT_ENABLED        0
216 #define SLOT_DEFAULT        1
217 #define SLOT_ADDRESSED      2
218 #define SLOT_CONFIGURED     3
219 
220 #define SLOT_CONTEXT_ENTRIES_MASK 0x1f
221 #define SLOT_CONTEXT_ENTRIES_SHIFT 27
222 
223 #define get_field(data, field)                  \
224     (((data) >> field##_SHIFT) & field##_MASK)
225 
226 #define set_field(data, newval, field) do {                     \
227         uint32_t val = *data;                                   \
228         val &= ~(field##_MASK << field##_SHIFT);                \
229         val |= ((newval) & field##_MASK) << field##_SHIFT;      \
230         *data = val;                                            \
231     } while (0)
232 
233 typedef enum EPType {
234     ET_INVALID = 0,
235     ET_ISO_OUT,
236     ET_BULK_OUT,
237     ET_INTR_OUT,
238     ET_CONTROL,
239     ET_ISO_IN,
240     ET_BULK_IN,
241     ET_INTR_IN,
242 } EPType;
243 
244 typedef struct XHCITransfer {
245     XHCIEPContext *epctx;
246     USBPacket packet;
247     QEMUSGList sgl;
248     bool running_async;
249     bool running_retry;
250     bool complete;
251     bool int_req;
252     unsigned int iso_pkts;
253     unsigned int streamid;
254     bool in_xfer;
255     bool iso_xfer;
256     bool timed_xfer;
257 
258     unsigned int trb_count;
259     XHCITRB *trbs;
260 
261     TRBCCode status;
262 
263     unsigned int pkts;
264     unsigned int pktsize;
265     unsigned int cur_pkt;
266 
267     uint64_t mfindex_kick;
268 
269     QTAILQ_ENTRY(XHCITransfer) next;
270 } XHCITransfer;
271 
272 struct XHCIStreamContext {
273     dma_addr_t pctx;
274     unsigned int sct;
275     XHCIRing ring;
276 };
277 
278 struct XHCIEPContext {
279     XHCIState *xhci;
280     unsigned int slotid;
281     unsigned int epid;
282 
283     XHCIRing ring;
284     uint32_t xfer_count;
285     QTAILQ_HEAD(, XHCITransfer) transfers;
286     XHCITransfer *retry;
287     EPType type;
288     dma_addr_t pctx;
289     unsigned int max_psize;
290     uint32_t state;
291     uint32_t kick_active;
292 
293     /* streams */
294     unsigned int max_pstreams;
295     bool         lsa;
296     unsigned int nr_pstreams;
297     XHCIStreamContext *pstreams;
298 
299     /* iso xfer scheduling */
300     unsigned int interval;
301     int64_t mfindex_last;
302     QEMUTimer *kick_timer;
303 };
304 
305 typedef struct XHCIEvRingSeg {
306     uint32_t addr_low;
307     uint32_t addr_high;
308     uint32_t size;
309     uint32_t rsvd;
310 } XHCIEvRingSeg;
311 
312 static void xhci_kick_ep(XHCIState *xhci, unsigned int slotid,
313                          unsigned int epid, unsigned int streamid);
314 static void xhci_kick_epctx(XHCIEPContext *epctx, unsigned int streamid);
315 static TRBCCode xhci_disable_ep(XHCIState *xhci, unsigned int slotid,
316                                 unsigned int epid);
317 static void xhci_xfer_report(XHCITransfer *xfer);
318 static void xhci_event(XHCIState *xhci, XHCIEvent *event, int v);
319 static void xhci_write_event(XHCIState *xhci, XHCIEvent *event, int v);
320 static USBEndpoint *xhci_epid_to_usbep(XHCIEPContext *epctx);
321 
322 static const char *TRBType_names[] = {
323     [TRB_RESERVED]                     = "TRB_RESERVED",
324     [TR_NORMAL]                        = "TR_NORMAL",
325     [TR_SETUP]                         = "TR_SETUP",
326     [TR_DATA]                          = "TR_DATA",
327     [TR_STATUS]                        = "TR_STATUS",
328     [TR_ISOCH]                         = "TR_ISOCH",
329     [TR_LINK]                          = "TR_LINK",
330     [TR_EVDATA]                        = "TR_EVDATA",
331     [TR_NOOP]                          = "TR_NOOP",
332     [CR_ENABLE_SLOT]                   = "CR_ENABLE_SLOT",
333     [CR_DISABLE_SLOT]                  = "CR_DISABLE_SLOT",
334     [CR_ADDRESS_DEVICE]                = "CR_ADDRESS_DEVICE",
335     [CR_CONFIGURE_ENDPOINT]            = "CR_CONFIGURE_ENDPOINT",
336     [CR_EVALUATE_CONTEXT]              = "CR_EVALUATE_CONTEXT",
337     [CR_RESET_ENDPOINT]                = "CR_RESET_ENDPOINT",
338     [CR_STOP_ENDPOINT]                 = "CR_STOP_ENDPOINT",
339     [CR_SET_TR_DEQUEUE]                = "CR_SET_TR_DEQUEUE",
340     [CR_RESET_DEVICE]                  = "CR_RESET_DEVICE",
341     [CR_FORCE_EVENT]                   = "CR_FORCE_EVENT",
342     [CR_NEGOTIATE_BW]                  = "CR_NEGOTIATE_BW",
343     [CR_SET_LATENCY_TOLERANCE]         = "CR_SET_LATENCY_TOLERANCE",
344     [CR_GET_PORT_BANDWIDTH]            = "CR_GET_PORT_BANDWIDTH",
345     [CR_FORCE_HEADER]                  = "CR_FORCE_HEADER",
346     [CR_NOOP]                          = "CR_NOOP",
347     [ER_TRANSFER]                      = "ER_TRANSFER",
348     [ER_COMMAND_COMPLETE]              = "ER_COMMAND_COMPLETE",
349     [ER_PORT_STATUS_CHANGE]            = "ER_PORT_STATUS_CHANGE",
350     [ER_BANDWIDTH_REQUEST]             = "ER_BANDWIDTH_REQUEST",
351     [ER_DOORBELL]                      = "ER_DOORBELL",
352     [ER_HOST_CONTROLLER]               = "ER_HOST_CONTROLLER",
353     [ER_DEVICE_NOTIFICATION]           = "ER_DEVICE_NOTIFICATION",
354     [ER_MFINDEX_WRAP]                  = "ER_MFINDEX_WRAP",
355     [CR_VENDOR_NEC_FIRMWARE_REVISION]  = "CR_VENDOR_NEC_FIRMWARE_REVISION",
356     [CR_VENDOR_NEC_CHALLENGE_RESPONSE] = "CR_VENDOR_NEC_CHALLENGE_RESPONSE",
357 };
358 
359 static const char *TRBCCode_names[] = {
360     [CC_INVALID]                       = "CC_INVALID",
361     [CC_SUCCESS]                       = "CC_SUCCESS",
362     [CC_DATA_BUFFER_ERROR]             = "CC_DATA_BUFFER_ERROR",
363     [CC_BABBLE_DETECTED]               = "CC_BABBLE_DETECTED",
364     [CC_USB_TRANSACTION_ERROR]         = "CC_USB_TRANSACTION_ERROR",
365     [CC_TRB_ERROR]                     = "CC_TRB_ERROR",
366     [CC_STALL_ERROR]                   = "CC_STALL_ERROR",
367     [CC_RESOURCE_ERROR]                = "CC_RESOURCE_ERROR",
368     [CC_BANDWIDTH_ERROR]               = "CC_BANDWIDTH_ERROR",
369     [CC_NO_SLOTS_ERROR]                = "CC_NO_SLOTS_ERROR",
370     [CC_INVALID_STREAM_TYPE_ERROR]     = "CC_INVALID_STREAM_TYPE_ERROR",
371     [CC_SLOT_NOT_ENABLED_ERROR]        = "CC_SLOT_NOT_ENABLED_ERROR",
372     [CC_EP_NOT_ENABLED_ERROR]          = "CC_EP_NOT_ENABLED_ERROR",
373     [CC_SHORT_PACKET]                  = "CC_SHORT_PACKET",
374     [CC_RING_UNDERRUN]                 = "CC_RING_UNDERRUN",
375     [CC_RING_OVERRUN]                  = "CC_RING_OVERRUN",
376     [CC_VF_ER_FULL]                    = "CC_VF_ER_FULL",
377     [CC_PARAMETER_ERROR]               = "CC_PARAMETER_ERROR",
378     [CC_BANDWIDTH_OVERRUN]             = "CC_BANDWIDTH_OVERRUN",
379     [CC_CONTEXT_STATE_ERROR]           = "CC_CONTEXT_STATE_ERROR",
380     [CC_NO_PING_RESPONSE_ERROR]        = "CC_NO_PING_RESPONSE_ERROR",
381     [CC_EVENT_RING_FULL_ERROR]         = "CC_EVENT_RING_FULL_ERROR",
382     [CC_INCOMPATIBLE_DEVICE_ERROR]     = "CC_INCOMPATIBLE_DEVICE_ERROR",
383     [CC_MISSED_SERVICE_ERROR]          = "CC_MISSED_SERVICE_ERROR",
384     [CC_COMMAND_RING_STOPPED]          = "CC_COMMAND_RING_STOPPED",
385     [CC_COMMAND_ABORTED]               = "CC_COMMAND_ABORTED",
386     [CC_STOPPED]                       = "CC_STOPPED",
387     [CC_STOPPED_LENGTH_INVALID]        = "CC_STOPPED_LENGTH_INVALID",
388     [CC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR]
389     = "CC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR",
390     [CC_ISOCH_BUFFER_OVERRUN]          = "CC_ISOCH_BUFFER_OVERRUN",
391     [CC_EVENT_LOST_ERROR]              = "CC_EVENT_LOST_ERROR",
392     [CC_UNDEFINED_ERROR]               = "CC_UNDEFINED_ERROR",
393     [CC_INVALID_STREAM_ID_ERROR]       = "CC_INVALID_STREAM_ID_ERROR",
394     [CC_SECONDARY_BANDWIDTH_ERROR]     = "CC_SECONDARY_BANDWIDTH_ERROR",
395     [CC_SPLIT_TRANSACTION_ERROR]       = "CC_SPLIT_TRANSACTION_ERROR",
396 };
397 
398 static const char *ep_state_names[] = {
399     [EP_DISABLED] = "disabled",
400     [EP_RUNNING]  = "running",
401     [EP_HALTED]   = "halted",
402     [EP_STOPPED]  = "stopped",
403     [EP_ERROR]    = "error",
404 };
405 
406 static const char *lookup_name(uint32_t index, const char **list, uint32_t llen)
407 {
408     if (index >= llen || list[index] == NULL) {
409         return "???";
410     }
411     return list[index];
412 }
413 
414 static const char *trb_name(XHCITRB *trb)
415 {
416     return lookup_name(TRB_TYPE(*trb), TRBType_names,
417                        ARRAY_SIZE(TRBType_names));
418 }
419 
420 static const char *event_name(XHCIEvent *event)
421 {
422     return lookup_name(event->ccode, TRBCCode_names,
423                        ARRAY_SIZE(TRBCCode_names));
424 }
425 
426 static const char *ep_state_name(uint32_t state)
427 {
428     return lookup_name(state, ep_state_names,
429                        ARRAY_SIZE(ep_state_names));
430 }
431 
432 static bool xhci_get_flag(XHCIState *xhci, enum xhci_flags bit)
433 {
434     return xhci->flags & (1 << bit);
435 }
436 
437 static void xhci_set_flag(XHCIState *xhci, enum xhci_flags bit)
438 {
439     xhci->flags |= (1 << bit);
440 }
441 
442 static uint64_t xhci_mfindex_get(XHCIState *xhci)
443 {
444     int64_t now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
445     return (now - xhci->mfindex_start) / 125000;
446 }
447 
448 static void xhci_mfwrap_update(XHCIState *xhci)
449 {
450     const uint32_t bits = USBCMD_RS | USBCMD_EWE;
451     uint32_t mfindex, left;
452     int64_t now;
453 
454     if ((xhci->usbcmd & bits) == bits) {
455         now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
456         mfindex = ((now - xhci->mfindex_start) / 125000) & 0x3fff;
457         left = 0x4000 - mfindex;
458         timer_mod(xhci->mfwrap_timer, now + left * 125000);
459     } else {
460         timer_del(xhci->mfwrap_timer);
461     }
462 }
463 
464 static void xhci_mfwrap_timer(void *opaque)
465 {
466     XHCIState *xhci = opaque;
467     XHCIEvent wrap = { ER_MFINDEX_WRAP, CC_SUCCESS };
468 
469     xhci_event(xhci, &wrap, 0);
470     xhci_mfwrap_update(xhci);
471 }
472 
473 static inline dma_addr_t xhci_addr64(uint32_t low, uint32_t high)
474 {
475     if (sizeof(dma_addr_t) == 4) {
476         return low;
477     } else {
478         return low | (((dma_addr_t)high << 16) << 16);
479     }
480 }
481 
482 static inline dma_addr_t xhci_mask64(uint64_t addr)
483 {
484     if (sizeof(dma_addr_t) == 4) {
485         return addr & 0xffffffff;
486     } else {
487         return addr;
488     }
489 }
490 
491 static inline void xhci_dma_read_u32s(XHCIState *xhci, dma_addr_t addr,
492                                       uint32_t *buf, size_t len)
493 {
494     int i;
495 
496     assert((len % sizeof(uint32_t)) == 0);
497 
498     pci_dma_read(PCI_DEVICE(xhci), addr, buf, len);
499 
500     for (i = 0; i < (len / sizeof(uint32_t)); i++) {
501         buf[i] = le32_to_cpu(buf[i]);
502     }
503 }
504 
505 static inline void xhci_dma_write_u32s(XHCIState *xhci, dma_addr_t addr,
506                                        uint32_t *buf, size_t len)
507 {
508     int i;
509     uint32_t tmp[5];
510     uint32_t n = len / sizeof(uint32_t);
511 
512     assert((len % sizeof(uint32_t)) == 0);
513     assert(n <= ARRAY_SIZE(tmp));
514 
515     for (i = 0; i < n; i++) {
516         tmp[i] = cpu_to_le32(buf[i]);
517     }
518     pci_dma_write(PCI_DEVICE(xhci), addr, tmp, len);
519 }
520 
521 static XHCIPort *xhci_lookup_port(XHCIState *xhci, struct USBPort *uport)
522 {
523     int index;
524 
525     if (!uport->dev) {
526         return NULL;
527     }
528     switch (uport->dev->speed) {
529     case USB_SPEED_LOW:
530     case USB_SPEED_FULL:
531     case USB_SPEED_HIGH:
532         if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
533             index = uport->index + xhci->numports_3;
534         } else {
535             index = uport->index;
536         }
537         break;
538     case USB_SPEED_SUPER:
539         if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
540             index = uport->index;
541         } else {
542             index = uport->index + xhci->numports_2;
543         }
544         break;
545     default:
546         return NULL;
547     }
548     return &xhci->ports[index];
549 }
550 
551 static void xhci_intx_update(XHCIState *xhci)
552 {
553     PCIDevice *pci_dev = PCI_DEVICE(xhci);
554     int level = 0;
555 
556     if (msix_enabled(pci_dev) ||
557         msi_enabled(pci_dev)) {
558         return;
559     }
560 
561     if (xhci->intr[0].iman & IMAN_IP &&
562         xhci->intr[0].iman & IMAN_IE &&
563         xhci->usbcmd & USBCMD_INTE) {
564         level = 1;
565     }
566 
567     trace_usb_xhci_irq_intx(level);
568     pci_set_irq(pci_dev, level);
569 }
570 
571 static void xhci_msix_update(XHCIState *xhci, int v)
572 {
573     PCIDevice *pci_dev = PCI_DEVICE(xhci);
574     bool enabled;
575 
576     if (!msix_enabled(pci_dev)) {
577         return;
578     }
579 
580     enabled = xhci->intr[v].iman & IMAN_IE;
581     if (enabled == xhci->intr[v].msix_used) {
582         return;
583     }
584 
585     if (enabled) {
586         trace_usb_xhci_irq_msix_use(v);
587         msix_vector_use(pci_dev, v);
588         xhci->intr[v].msix_used = true;
589     } else {
590         trace_usb_xhci_irq_msix_unuse(v);
591         msix_vector_unuse(pci_dev, v);
592         xhci->intr[v].msix_used = false;
593     }
594 }
595 
596 static void xhci_intr_raise(XHCIState *xhci, int v)
597 {
598     PCIDevice *pci_dev = PCI_DEVICE(xhci);
599     bool pending = (xhci->intr[v].erdp_low & ERDP_EHB);
600 
601     xhci->intr[v].erdp_low |= ERDP_EHB;
602     xhci->intr[v].iman |= IMAN_IP;
603     xhci->usbsts |= USBSTS_EINT;
604 
605     if (pending) {
606         return;
607     }
608     if (!(xhci->intr[v].iman & IMAN_IE)) {
609         return;
610     }
611 
612     if (!(xhci->usbcmd & USBCMD_INTE)) {
613         return;
614     }
615 
616     if (msix_enabled(pci_dev)) {
617         trace_usb_xhci_irq_msix(v);
618         msix_notify(pci_dev, v);
619         return;
620     }
621 
622     if (msi_enabled(pci_dev)) {
623         trace_usb_xhci_irq_msi(v);
624         msi_notify(pci_dev, v);
625         return;
626     }
627 
628     if (v == 0) {
629         trace_usb_xhci_irq_intx(1);
630         pci_irq_assert(pci_dev);
631     }
632 }
633 
634 static inline int xhci_running(XHCIState *xhci)
635 {
636     return !(xhci->usbsts & USBSTS_HCH);
637 }
638 
639 static void xhci_die(XHCIState *xhci)
640 {
641     xhci->usbsts |= USBSTS_HCE;
642     DPRINTF("xhci: asserted controller error\n");
643 }
644 
645 static void xhci_write_event(XHCIState *xhci, XHCIEvent *event, int v)
646 {
647     PCIDevice *pci_dev = PCI_DEVICE(xhci);
648     XHCIInterrupter *intr = &xhci->intr[v];
649     XHCITRB ev_trb;
650     dma_addr_t addr;
651 
652     ev_trb.parameter = cpu_to_le64(event->ptr);
653     ev_trb.status = cpu_to_le32(event->length | (event->ccode << 24));
654     ev_trb.control = (event->slotid << 24) | (event->epid << 16) |
655                      event->flags | (event->type << TRB_TYPE_SHIFT);
656     if (intr->er_pcs) {
657         ev_trb.control |= TRB_C;
658     }
659     ev_trb.control = cpu_to_le32(ev_trb.control);
660 
661     trace_usb_xhci_queue_event(v, intr->er_ep_idx, trb_name(&ev_trb),
662                                event_name(event), ev_trb.parameter,
663                                ev_trb.status, ev_trb.control);
664 
665     addr = intr->er_start + TRB_SIZE*intr->er_ep_idx;
666     pci_dma_write(pci_dev, addr, &ev_trb, TRB_SIZE);
667 
668     intr->er_ep_idx++;
669     if (intr->er_ep_idx >= intr->er_size) {
670         intr->er_ep_idx = 0;
671         intr->er_pcs = !intr->er_pcs;
672     }
673 }
674 
675 static void xhci_event(XHCIState *xhci, XHCIEvent *event, int v)
676 {
677     XHCIInterrupter *intr;
678     dma_addr_t erdp;
679     unsigned int dp_idx;
680 
681     if (v >= xhci->numintrs) {
682         DPRINTF("intr nr out of range (%d >= %d)\n", v, xhci->numintrs);
683         return;
684     }
685     intr = &xhci->intr[v];
686 
687     erdp = xhci_addr64(intr->erdp_low, intr->erdp_high);
688     if (erdp < intr->er_start ||
689         erdp >= (intr->er_start + TRB_SIZE*intr->er_size)) {
690         DPRINTF("xhci: ERDP out of bounds: "DMA_ADDR_FMT"\n", erdp);
691         DPRINTF("xhci: ER[%d] at "DMA_ADDR_FMT" len %d\n",
692                 v, intr->er_start, intr->er_size);
693         xhci_die(xhci);
694         return;
695     }
696 
697     dp_idx = (erdp - intr->er_start) / TRB_SIZE;
698     assert(dp_idx < intr->er_size);
699 
700     if ((intr->er_ep_idx + 2) % intr->er_size == dp_idx) {
701         DPRINTF("xhci: ER %d full, send ring full error\n", v);
702         XHCIEvent full = {ER_HOST_CONTROLLER, CC_EVENT_RING_FULL_ERROR};
703         xhci_write_event(xhci, &full, v);
704     } else if ((intr->er_ep_idx + 1) % intr->er_size == dp_idx) {
705         DPRINTF("xhci: ER %d full, drop event\n", v);
706     } else {
707         xhci_write_event(xhci, event, v);
708     }
709 
710     xhci_intr_raise(xhci, v);
711 }
712 
713 static void xhci_ring_init(XHCIState *xhci, XHCIRing *ring,
714                            dma_addr_t base)
715 {
716     ring->dequeue = base;
717     ring->ccs = 1;
718 }
719 
720 static TRBType xhci_ring_fetch(XHCIState *xhci, XHCIRing *ring, XHCITRB *trb,
721                                dma_addr_t *addr)
722 {
723     PCIDevice *pci_dev = PCI_DEVICE(xhci);
724     uint32_t link_cnt = 0;
725 
726     while (1) {
727         TRBType type;
728         pci_dma_read(pci_dev, ring->dequeue, trb, TRB_SIZE);
729         trb->addr = ring->dequeue;
730         trb->ccs = ring->ccs;
731         le64_to_cpus(&trb->parameter);
732         le32_to_cpus(&trb->status);
733         le32_to_cpus(&trb->control);
734 
735         trace_usb_xhci_fetch_trb(ring->dequeue, trb_name(trb),
736                                  trb->parameter, trb->status, trb->control);
737 
738         if ((trb->control & TRB_C) != ring->ccs) {
739             return 0;
740         }
741 
742         type = TRB_TYPE(*trb);
743 
744         if (type != TR_LINK) {
745             if (addr) {
746                 *addr = ring->dequeue;
747             }
748             ring->dequeue += TRB_SIZE;
749             return type;
750         } else {
751             if (++link_cnt > TRB_LINK_LIMIT) {
752                 trace_usb_xhci_enforced_limit("trb-link");
753                 return 0;
754             }
755             ring->dequeue = xhci_mask64(trb->parameter);
756             if (trb->control & TRB_LK_TC) {
757                 ring->ccs = !ring->ccs;
758             }
759         }
760     }
761 }
762 
763 static int xhci_ring_chain_length(XHCIState *xhci, const XHCIRing *ring)
764 {
765     PCIDevice *pci_dev = PCI_DEVICE(xhci);
766     XHCITRB trb;
767     int length = 0;
768     dma_addr_t dequeue = ring->dequeue;
769     bool ccs = ring->ccs;
770     /* hack to bundle together the two/three TDs that make a setup transfer */
771     bool control_td_set = 0;
772     uint32_t link_cnt = 0;
773 
774     while (1) {
775         TRBType type;
776         pci_dma_read(pci_dev, dequeue, &trb, TRB_SIZE);
777         le64_to_cpus(&trb.parameter);
778         le32_to_cpus(&trb.status);
779         le32_to_cpus(&trb.control);
780 
781         if ((trb.control & TRB_C) != ccs) {
782             return -length;
783         }
784 
785         type = TRB_TYPE(trb);
786 
787         if (type == TR_LINK) {
788             if (++link_cnt > TRB_LINK_LIMIT) {
789                 return -length;
790             }
791             dequeue = xhci_mask64(trb.parameter);
792             if (trb.control & TRB_LK_TC) {
793                 ccs = !ccs;
794             }
795             continue;
796         }
797 
798         length += 1;
799         dequeue += TRB_SIZE;
800 
801         if (type == TR_SETUP) {
802             control_td_set = 1;
803         } else if (type == TR_STATUS) {
804             control_td_set = 0;
805         }
806 
807         if (!control_td_set && !(trb.control & TRB_TR_CH)) {
808             return length;
809         }
810     }
811 }
812 
813 static void xhci_er_reset(XHCIState *xhci, int v)
814 {
815     XHCIInterrupter *intr = &xhci->intr[v];
816     XHCIEvRingSeg seg;
817     dma_addr_t erstba = xhci_addr64(intr->erstba_low, intr->erstba_high);
818 
819     if (intr->erstsz == 0 || erstba == 0) {
820         /* disabled */
821         intr->er_start = 0;
822         intr->er_size = 0;
823         return;
824     }
825     /* cache the (sole) event ring segment location */
826     if (intr->erstsz != 1) {
827         DPRINTF("xhci: invalid value for ERSTSZ: %d\n", intr->erstsz);
828         xhci_die(xhci);
829         return;
830     }
831     pci_dma_read(PCI_DEVICE(xhci), erstba, &seg, sizeof(seg));
832     le32_to_cpus(&seg.addr_low);
833     le32_to_cpus(&seg.addr_high);
834     le32_to_cpus(&seg.size);
835     if (seg.size < 16 || seg.size > 4096) {
836         DPRINTF("xhci: invalid value for segment size: %d\n", seg.size);
837         xhci_die(xhci);
838         return;
839     }
840     intr->er_start = xhci_addr64(seg.addr_low, seg.addr_high);
841     intr->er_size = seg.size;
842 
843     intr->er_ep_idx = 0;
844     intr->er_pcs = 1;
845 
846     DPRINTF("xhci: event ring[%d]:" DMA_ADDR_FMT " [%d]\n",
847             v, intr->er_start, intr->er_size);
848 }
849 
850 static void xhci_run(XHCIState *xhci)
851 {
852     trace_usb_xhci_run();
853     xhci->usbsts &= ~USBSTS_HCH;
854     xhci->mfindex_start = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
855 }
856 
857 static void xhci_stop(XHCIState *xhci)
858 {
859     trace_usb_xhci_stop();
860     xhci->usbsts |= USBSTS_HCH;
861     xhci->crcr_low &= ~CRCR_CRR;
862 }
863 
864 static XHCIStreamContext *xhci_alloc_stream_contexts(unsigned count,
865                                                      dma_addr_t base)
866 {
867     XHCIStreamContext *stctx;
868     unsigned int i;
869 
870     stctx = g_new0(XHCIStreamContext, count);
871     for (i = 0; i < count; i++) {
872         stctx[i].pctx = base + i * 16;
873         stctx[i].sct = -1;
874     }
875     return stctx;
876 }
877 
878 static void xhci_reset_streams(XHCIEPContext *epctx)
879 {
880     unsigned int i;
881 
882     for (i = 0; i < epctx->nr_pstreams; i++) {
883         epctx->pstreams[i].sct = -1;
884     }
885 }
886 
887 static void xhci_alloc_streams(XHCIEPContext *epctx, dma_addr_t base)
888 {
889     assert(epctx->pstreams == NULL);
890     epctx->nr_pstreams = 2 << epctx->max_pstreams;
891     epctx->pstreams = xhci_alloc_stream_contexts(epctx->nr_pstreams, base);
892 }
893 
894 static void xhci_free_streams(XHCIEPContext *epctx)
895 {
896     assert(epctx->pstreams != NULL);
897 
898     g_free(epctx->pstreams);
899     epctx->pstreams = NULL;
900     epctx->nr_pstreams = 0;
901 }
902 
903 static int xhci_epmask_to_eps_with_streams(XHCIState *xhci,
904                                            unsigned int slotid,
905                                            uint32_t epmask,
906                                            XHCIEPContext **epctxs,
907                                            USBEndpoint **eps)
908 {
909     XHCISlot *slot;
910     XHCIEPContext *epctx;
911     USBEndpoint *ep;
912     int i, j;
913 
914     assert(slotid >= 1 && slotid <= xhci->numslots);
915 
916     slot = &xhci->slots[slotid - 1];
917 
918     for (i = 2, j = 0; i <= 31; i++) {
919         if (!(epmask & (1u << i))) {
920             continue;
921         }
922 
923         epctx = slot->eps[i - 1];
924         ep = xhci_epid_to_usbep(epctx);
925         if (!epctx || !epctx->nr_pstreams || !ep) {
926             continue;
927         }
928 
929         if (epctxs) {
930             epctxs[j] = epctx;
931         }
932         eps[j++] = ep;
933     }
934     return j;
935 }
936 
937 static void xhci_free_device_streams(XHCIState *xhci, unsigned int slotid,
938                                      uint32_t epmask)
939 {
940     USBEndpoint *eps[30];
941     int nr_eps;
942 
943     nr_eps = xhci_epmask_to_eps_with_streams(xhci, slotid, epmask, NULL, eps);
944     if (nr_eps) {
945         usb_device_free_streams(eps[0]->dev, eps, nr_eps);
946     }
947 }
948 
949 static TRBCCode xhci_alloc_device_streams(XHCIState *xhci, unsigned int slotid,
950                                           uint32_t epmask)
951 {
952     XHCIEPContext *epctxs[30];
953     USBEndpoint *eps[30];
954     int i, r, nr_eps, req_nr_streams, dev_max_streams;
955 
956     nr_eps = xhci_epmask_to_eps_with_streams(xhci, slotid, epmask, epctxs,
957                                              eps);
958     if (nr_eps == 0) {
959         return CC_SUCCESS;
960     }
961 
962     req_nr_streams = epctxs[0]->nr_pstreams;
963     dev_max_streams = eps[0]->max_streams;
964 
965     for (i = 1; i < nr_eps; i++) {
966         /*
967          * HdG: I don't expect these to ever trigger, but if they do we need
968          * to come up with another solution, ie group identical endpoints
969          * together and make an usb_device_alloc_streams call per group.
970          */
971         if (epctxs[i]->nr_pstreams != req_nr_streams) {
972             FIXME("guest streams config not identical for all eps");
973             return CC_RESOURCE_ERROR;
974         }
975         if (eps[i]->max_streams != dev_max_streams) {
976             FIXME("device streams config not identical for all eps");
977             return CC_RESOURCE_ERROR;
978         }
979     }
980 
981     /*
982      * max-streams in both the device descriptor and in the controller is a
983      * power of 2. But stream id 0 is reserved, so if a device can do up to 4
984      * streams the guest will ask for 5 rounded up to the next power of 2 which
985      * becomes 8. For emulated devices usb_device_alloc_streams is a nop.
986      *
987      * For redirected devices however this is an issue, as there we must ask
988      * the real xhci controller to alloc streams, and the host driver for the
989      * real xhci controller will likely disallow allocating more streams then
990      * the device can handle.
991      *
992      * So we limit the requested nr_streams to the maximum number the device
993      * can handle.
994      */
995     if (req_nr_streams > dev_max_streams) {
996         req_nr_streams = dev_max_streams;
997     }
998 
999     r = usb_device_alloc_streams(eps[0]->dev, eps, nr_eps, req_nr_streams);
1000     if (r != 0) {
1001         DPRINTF("xhci: alloc streams failed\n");
1002         return CC_RESOURCE_ERROR;
1003     }
1004 
1005     return CC_SUCCESS;
1006 }
1007 
1008 static XHCIStreamContext *xhci_find_stream(XHCIEPContext *epctx,
1009                                            unsigned int streamid,
1010                                            uint32_t *cc_error)
1011 {
1012     XHCIStreamContext *sctx;
1013     dma_addr_t base;
1014     uint32_t ctx[2], sct;
1015 
1016     assert(streamid != 0);
1017     if (epctx->lsa) {
1018         if (streamid >= epctx->nr_pstreams) {
1019             *cc_error = CC_INVALID_STREAM_ID_ERROR;
1020             return NULL;
1021         }
1022         sctx = epctx->pstreams + streamid;
1023     } else {
1024         FIXME("secondary streams not implemented yet");
1025     }
1026 
1027     if (sctx->sct == -1) {
1028         xhci_dma_read_u32s(epctx->xhci, sctx->pctx, ctx, sizeof(ctx));
1029         sct = (ctx[0] >> 1) & 0x07;
1030         if (epctx->lsa && sct != 1) {
1031             *cc_error = CC_INVALID_STREAM_TYPE_ERROR;
1032             return NULL;
1033         }
1034         sctx->sct = sct;
1035         base = xhci_addr64(ctx[0] & ~0xf, ctx[1]);
1036         xhci_ring_init(epctx->xhci, &sctx->ring, base);
1037     }
1038     return sctx;
1039 }
1040 
1041 static void xhci_set_ep_state(XHCIState *xhci, XHCIEPContext *epctx,
1042                               XHCIStreamContext *sctx, uint32_t state)
1043 {
1044     XHCIRing *ring = NULL;
1045     uint32_t ctx[5];
1046     uint32_t ctx2[2];
1047 
1048     xhci_dma_read_u32s(xhci, epctx->pctx, ctx, sizeof(ctx));
1049     ctx[0] &= ~EP_STATE_MASK;
1050     ctx[0] |= state;
1051 
1052     /* update ring dequeue ptr */
1053     if (epctx->nr_pstreams) {
1054         if (sctx != NULL) {
1055             ring = &sctx->ring;
1056             xhci_dma_read_u32s(xhci, sctx->pctx, ctx2, sizeof(ctx2));
1057             ctx2[0] &= 0xe;
1058             ctx2[0] |= sctx->ring.dequeue | sctx->ring.ccs;
1059             ctx2[1] = (sctx->ring.dequeue >> 16) >> 16;
1060             xhci_dma_write_u32s(xhci, sctx->pctx, ctx2, sizeof(ctx2));
1061         }
1062     } else {
1063         ring = &epctx->ring;
1064     }
1065     if (ring) {
1066         ctx[2] = ring->dequeue | ring->ccs;
1067         ctx[3] = (ring->dequeue >> 16) >> 16;
1068 
1069         DPRINTF("xhci: set epctx: " DMA_ADDR_FMT " state=%d dequeue=%08x%08x\n",
1070                 epctx->pctx, state, ctx[3], ctx[2]);
1071     }
1072 
1073     xhci_dma_write_u32s(xhci, epctx->pctx, ctx, sizeof(ctx));
1074     if (epctx->state != state) {
1075         trace_usb_xhci_ep_state(epctx->slotid, epctx->epid,
1076                                 ep_state_name(epctx->state),
1077                                 ep_state_name(state));
1078     }
1079     epctx->state = state;
1080 }
1081 
1082 static void xhci_ep_kick_timer(void *opaque)
1083 {
1084     XHCIEPContext *epctx = opaque;
1085     xhci_kick_epctx(epctx, 0);
1086 }
1087 
1088 static XHCIEPContext *xhci_alloc_epctx(XHCIState *xhci,
1089                                        unsigned int slotid,
1090                                        unsigned int epid)
1091 {
1092     XHCIEPContext *epctx;
1093 
1094     epctx = g_new0(XHCIEPContext, 1);
1095     epctx->xhci = xhci;
1096     epctx->slotid = slotid;
1097     epctx->epid = epid;
1098 
1099     QTAILQ_INIT(&epctx->transfers);
1100     epctx->kick_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, xhci_ep_kick_timer, epctx);
1101 
1102     return epctx;
1103 }
1104 
1105 static void xhci_init_epctx(XHCIEPContext *epctx,
1106                             dma_addr_t pctx, uint32_t *ctx)
1107 {
1108     dma_addr_t dequeue;
1109 
1110     dequeue = xhci_addr64(ctx[2] & ~0xf, ctx[3]);
1111 
1112     epctx->type = (ctx[1] >> EP_TYPE_SHIFT) & EP_TYPE_MASK;
1113     epctx->pctx = pctx;
1114     epctx->max_psize = ctx[1]>>16;
1115     epctx->max_psize *= 1+((ctx[1]>>8)&0xff);
1116     epctx->max_pstreams = (ctx[0] >> 10) & epctx->xhci->max_pstreams_mask;
1117     epctx->lsa = (ctx[0] >> 15) & 1;
1118     if (epctx->max_pstreams) {
1119         xhci_alloc_streams(epctx, dequeue);
1120     } else {
1121         xhci_ring_init(epctx->xhci, &epctx->ring, dequeue);
1122         epctx->ring.ccs = ctx[2] & 1;
1123     }
1124 
1125     epctx->interval = 1 << ((ctx[0] >> 16) & 0xff);
1126 }
1127 
1128 static TRBCCode xhci_enable_ep(XHCIState *xhci, unsigned int slotid,
1129                                unsigned int epid, dma_addr_t pctx,
1130                                uint32_t *ctx)
1131 {
1132     XHCISlot *slot;
1133     XHCIEPContext *epctx;
1134 
1135     trace_usb_xhci_ep_enable(slotid, epid);
1136     assert(slotid >= 1 && slotid <= xhci->numslots);
1137     assert(epid >= 1 && epid <= 31);
1138 
1139     slot = &xhci->slots[slotid-1];
1140     if (slot->eps[epid-1]) {
1141         xhci_disable_ep(xhci, slotid, epid);
1142     }
1143 
1144     epctx = xhci_alloc_epctx(xhci, slotid, epid);
1145     slot->eps[epid-1] = epctx;
1146     xhci_init_epctx(epctx, pctx, ctx);
1147 
1148     DPRINTF("xhci: endpoint %d.%d type is %d, max transaction (burst) "
1149             "size is %d\n", epid/2, epid%2, epctx->type, epctx->max_psize);
1150 
1151     epctx->mfindex_last = 0;
1152 
1153     epctx->state = EP_RUNNING;
1154     ctx[0] &= ~EP_STATE_MASK;
1155     ctx[0] |= EP_RUNNING;
1156 
1157     return CC_SUCCESS;
1158 }
1159 
1160 static XHCITransfer *xhci_ep_alloc_xfer(XHCIEPContext *epctx,
1161                                         uint32_t length)
1162 {
1163     uint32_t limit = epctx->nr_pstreams + 16;
1164     XHCITransfer *xfer;
1165 
1166     if (epctx->xfer_count >= limit) {
1167         return NULL;
1168     }
1169 
1170     xfer = g_new0(XHCITransfer, 1);
1171     xfer->epctx = epctx;
1172     xfer->trbs = g_new(XHCITRB, length);
1173     xfer->trb_count = length;
1174     usb_packet_init(&xfer->packet);
1175 
1176     QTAILQ_INSERT_TAIL(&epctx->transfers, xfer, next);
1177     epctx->xfer_count++;
1178 
1179     return xfer;
1180 }
1181 
1182 static void xhci_ep_free_xfer(XHCITransfer *xfer)
1183 {
1184     QTAILQ_REMOVE(&xfer->epctx->transfers, xfer, next);
1185     xfer->epctx->xfer_count--;
1186 
1187     usb_packet_cleanup(&xfer->packet);
1188     g_free(xfer->trbs);
1189     g_free(xfer);
1190 }
1191 
1192 static int xhci_ep_nuke_one_xfer(XHCITransfer *t, TRBCCode report)
1193 {
1194     int killed = 0;
1195 
1196     if (report && (t->running_async || t->running_retry)) {
1197         t->status = report;
1198         xhci_xfer_report(t);
1199     }
1200 
1201     if (t->running_async) {
1202         usb_cancel_packet(&t->packet);
1203         t->running_async = 0;
1204         killed = 1;
1205     }
1206     if (t->running_retry) {
1207         if (t->epctx) {
1208             t->epctx->retry = NULL;
1209             timer_del(t->epctx->kick_timer);
1210         }
1211         t->running_retry = 0;
1212         killed = 1;
1213     }
1214     g_free(t->trbs);
1215 
1216     t->trbs = NULL;
1217     t->trb_count = 0;
1218 
1219     return killed;
1220 }
1221 
1222 static int xhci_ep_nuke_xfers(XHCIState *xhci, unsigned int slotid,
1223                                unsigned int epid, TRBCCode report)
1224 {
1225     XHCISlot *slot;
1226     XHCIEPContext *epctx;
1227     XHCITransfer *xfer;
1228     int killed = 0;
1229     USBEndpoint *ep = NULL;
1230     assert(slotid >= 1 && slotid <= xhci->numslots);
1231     assert(epid >= 1 && epid <= 31);
1232 
1233     DPRINTF("xhci_ep_nuke_xfers(%d, %d)\n", slotid, epid);
1234 
1235     slot = &xhci->slots[slotid-1];
1236 
1237     if (!slot->eps[epid-1]) {
1238         return 0;
1239     }
1240 
1241     epctx = slot->eps[epid-1];
1242 
1243     for (;;) {
1244         xfer = QTAILQ_FIRST(&epctx->transfers);
1245         if (xfer == NULL) {
1246             break;
1247         }
1248         killed += xhci_ep_nuke_one_xfer(xfer, report);
1249         if (killed) {
1250             report = 0; /* Only report once */
1251         }
1252         xhci_ep_free_xfer(xfer);
1253     }
1254 
1255     ep = xhci_epid_to_usbep(epctx);
1256     if (ep) {
1257         usb_device_ep_stopped(ep->dev, ep);
1258     }
1259     return killed;
1260 }
1261 
1262 static TRBCCode xhci_disable_ep(XHCIState *xhci, unsigned int slotid,
1263                                unsigned int epid)
1264 {
1265     XHCISlot *slot;
1266     XHCIEPContext *epctx;
1267 
1268     trace_usb_xhci_ep_disable(slotid, epid);
1269     assert(slotid >= 1 && slotid <= xhci->numslots);
1270     assert(epid >= 1 && epid <= 31);
1271 
1272     slot = &xhci->slots[slotid-1];
1273 
1274     if (!slot->eps[epid-1]) {
1275         DPRINTF("xhci: slot %d ep %d already disabled\n", slotid, epid);
1276         return CC_SUCCESS;
1277     }
1278 
1279     xhci_ep_nuke_xfers(xhci, slotid, epid, 0);
1280 
1281     epctx = slot->eps[epid-1];
1282 
1283     if (epctx->nr_pstreams) {
1284         xhci_free_streams(epctx);
1285     }
1286 
1287     /* only touch guest RAM if we're not resetting the HC */
1288     if (xhci->dcbaap_low || xhci->dcbaap_high) {
1289         xhci_set_ep_state(xhci, epctx, NULL, EP_DISABLED);
1290     }
1291 
1292     timer_free(epctx->kick_timer);
1293     g_free(epctx);
1294     slot->eps[epid-1] = NULL;
1295 
1296     return CC_SUCCESS;
1297 }
1298 
1299 static TRBCCode xhci_stop_ep(XHCIState *xhci, unsigned int slotid,
1300                              unsigned int epid)
1301 {
1302     XHCISlot *slot;
1303     XHCIEPContext *epctx;
1304 
1305     trace_usb_xhci_ep_stop(slotid, epid);
1306     assert(slotid >= 1 && slotid <= xhci->numslots);
1307 
1308     if (epid < 1 || epid > 31) {
1309         DPRINTF("xhci: bad ep %d\n", epid);
1310         return CC_TRB_ERROR;
1311     }
1312 
1313     slot = &xhci->slots[slotid-1];
1314 
1315     if (!slot->eps[epid-1]) {
1316         DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1317         return CC_EP_NOT_ENABLED_ERROR;
1318     }
1319 
1320     if (xhci_ep_nuke_xfers(xhci, slotid, epid, CC_STOPPED) > 0) {
1321         DPRINTF("xhci: FIXME: endpoint stopped w/ xfers running, "
1322                 "data might be lost\n");
1323     }
1324 
1325     epctx = slot->eps[epid-1];
1326 
1327     xhci_set_ep_state(xhci, epctx, NULL, EP_STOPPED);
1328 
1329     if (epctx->nr_pstreams) {
1330         xhci_reset_streams(epctx);
1331     }
1332 
1333     return CC_SUCCESS;
1334 }
1335 
1336 static TRBCCode xhci_reset_ep(XHCIState *xhci, unsigned int slotid,
1337                               unsigned int epid)
1338 {
1339     XHCISlot *slot;
1340     XHCIEPContext *epctx;
1341 
1342     trace_usb_xhci_ep_reset(slotid, epid);
1343     assert(slotid >= 1 && slotid <= xhci->numslots);
1344 
1345     if (epid < 1 || epid > 31) {
1346         DPRINTF("xhci: bad ep %d\n", epid);
1347         return CC_TRB_ERROR;
1348     }
1349 
1350     slot = &xhci->slots[slotid-1];
1351 
1352     if (!slot->eps[epid-1]) {
1353         DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1354         return CC_EP_NOT_ENABLED_ERROR;
1355     }
1356 
1357     epctx = slot->eps[epid-1];
1358 
1359     if (epctx->state != EP_HALTED) {
1360         DPRINTF("xhci: reset EP while EP %d not halted (%d)\n",
1361                 epid, epctx->state);
1362         return CC_CONTEXT_STATE_ERROR;
1363     }
1364 
1365     if (xhci_ep_nuke_xfers(xhci, slotid, epid, 0) > 0) {
1366         DPRINTF("xhci: FIXME: endpoint reset w/ xfers running, "
1367                 "data might be lost\n");
1368     }
1369 
1370     if (!xhci->slots[slotid-1].uport ||
1371         !xhci->slots[slotid-1].uport->dev ||
1372         !xhci->slots[slotid-1].uport->dev->attached) {
1373         return CC_USB_TRANSACTION_ERROR;
1374     }
1375 
1376     xhci_set_ep_state(xhci, epctx, NULL, EP_STOPPED);
1377 
1378     if (epctx->nr_pstreams) {
1379         xhci_reset_streams(epctx);
1380     }
1381 
1382     return CC_SUCCESS;
1383 }
1384 
1385 static TRBCCode xhci_set_ep_dequeue(XHCIState *xhci, unsigned int slotid,
1386                                     unsigned int epid, unsigned int streamid,
1387                                     uint64_t pdequeue)
1388 {
1389     XHCISlot *slot;
1390     XHCIEPContext *epctx;
1391     XHCIStreamContext *sctx;
1392     dma_addr_t dequeue;
1393 
1394     assert(slotid >= 1 && slotid <= xhci->numslots);
1395 
1396     if (epid < 1 || epid > 31) {
1397         DPRINTF("xhci: bad ep %d\n", epid);
1398         return CC_TRB_ERROR;
1399     }
1400 
1401     trace_usb_xhci_ep_set_dequeue(slotid, epid, streamid, pdequeue);
1402     dequeue = xhci_mask64(pdequeue);
1403 
1404     slot = &xhci->slots[slotid-1];
1405 
1406     if (!slot->eps[epid-1]) {
1407         DPRINTF("xhci: slot %d ep %d not enabled\n", slotid, epid);
1408         return CC_EP_NOT_ENABLED_ERROR;
1409     }
1410 
1411     epctx = slot->eps[epid-1];
1412 
1413     if (epctx->state != EP_STOPPED) {
1414         DPRINTF("xhci: set EP dequeue pointer while EP %d not stopped\n", epid);
1415         return CC_CONTEXT_STATE_ERROR;
1416     }
1417 
1418     if (epctx->nr_pstreams) {
1419         uint32_t err;
1420         sctx = xhci_find_stream(epctx, streamid, &err);
1421         if (sctx == NULL) {
1422             return err;
1423         }
1424         xhci_ring_init(xhci, &sctx->ring, dequeue & ~0xf);
1425         sctx->ring.ccs = dequeue & 1;
1426     } else {
1427         sctx = NULL;
1428         xhci_ring_init(xhci, &epctx->ring, dequeue & ~0xF);
1429         epctx->ring.ccs = dequeue & 1;
1430     }
1431 
1432     xhci_set_ep_state(xhci, epctx, sctx, EP_STOPPED);
1433 
1434     return CC_SUCCESS;
1435 }
1436 
1437 static int xhci_xfer_create_sgl(XHCITransfer *xfer, int in_xfer)
1438 {
1439     XHCIState *xhci = xfer->epctx->xhci;
1440     int i;
1441 
1442     xfer->int_req = false;
1443     pci_dma_sglist_init(&xfer->sgl, PCI_DEVICE(xhci), xfer->trb_count);
1444     for (i = 0; i < xfer->trb_count; i++) {
1445         XHCITRB *trb = &xfer->trbs[i];
1446         dma_addr_t addr;
1447         unsigned int chunk = 0;
1448 
1449         if (trb->control & TRB_TR_IOC) {
1450             xfer->int_req = true;
1451         }
1452 
1453         switch (TRB_TYPE(*trb)) {
1454         case TR_DATA:
1455             if ((!(trb->control & TRB_TR_DIR)) != (!in_xfer)) {
1456                 DPRINTF("xhci: data direction mismatch for TR_DATA\n");
1457                 goto err;
1458             }
1459             /* fallthrough */
1460         case TR_NORMAL:
1461         case TR_ISOCH:
1462             addr = xhci_mask64(trb->parameter);
1463             chunk = trb->status & 0x1ffff;
1464             if (trb->control & TRB_TR_IDT) {
1465                 if (chunk > 8 || in_xfer) {
1466                     DPRINTF("xhci: invalid immediate data TRB\n");
1467                     goto err;
1468                 }
1469                 qemu_sglist_add(&xfer->sgl, trb->addr, chunk);
1470             } else {
1471                 qemu_sglist_add(&xfer->sgl, addr, chunk);
1472             }
1473             break;
1474         }
1475     }
1476 
1477     return 0;
1478 
1479 err:
1480     qemu_sglist_destroy(&xfer->sgl);
1481     xhci_die(xhci);
1482     return -1;
1483 }
1484 
1485 static void xhci_xfer_unmap(XHCITransfer *xfer)
1486 {
1487     usb_packet_unmap(&xfer->packet, &xfer->sgl);
1488     qemu_sglist_destroy(&xfer->sgl);
1489 }
1490 
1491 static void xhci_xfer_report(XHCITransfer *xfer)
1492 {
1493     uint32_t edtla = 0;
1494     unsigned int left;
1495     bool reported = 0;
1496     bool shortpkt = 0;
1497     XHCIEvent event = {ER_TRANSFER, CC_SUCCESS};
1498     XHCIState *xhci = xfer->epctx->xhci;
1499     int i;
1500 
1501     left = xfer->packet.actual_length;
1502 
1503     for (i = 0; i < xfer->trb_count; i++) {
1504         XHCITRB *trb = &xfer->trbs[i];
1505         unsigned int chunk = 0;
1506 
1507         switch (TRB_TYPE(*trb)) {
1508         case TR_SETUP:
1509             chunk = trb->status & 0x1ffff;
1510             if (chunk > 8) {
1511                 chunk = 8;
1512             }
1513             break;
1514         case TR_DATA:
1515         case TR_NORMAL:
1516         case TR_ISOCH:
1517             chunk = trb->status & 0x1ffff;
1518             if (chunk > left) {
1519                 chunk = left;
1520                 if (xfer->status == CC_SUCCESS) {
1521                     shortpkt = 1;
1522                 }
1523             }
1524             left -= chunk;
1525             edtla += chunk;
1526             break;
1527         case TR_STATUS:
1528             reported = 0;
1529             shortpkt = 0;
1530             break;
1531         }
1532 
1533         if (!reported && ((trb->control & TRB_TR_IOC) ||
1534                           (shortpkt && (trb->control & TRB_TR_ISP)) ||
1535                           (xfer->status != CC_SUCCESS && left == 0))) {
1536             event.slotid = xfer->epctx->slotid;
1537             event.epid = xfer->epctx->epid;
1538             event.length = (trb->status & 0x1ffff) - chunk;
1539             event.flags = 0;
1540             event.ptr = trb->addr;
1541             if (xfer->status == CC_SUCCESS) {
1542                 event.ccode = shortpkt ? CC_SHORT_PACKET : CC_SUCCESS;
1543             } else {
1544                 event.ccode = xfer->status;
1545             }
1546             if (TRB_TYPE(*trb) == TR_EVDATA) {
1547                 event.ptr = trb->parameter;
1548                 event.flags |= TRB_EV_ED;
1549                 event.length = edtla & 0xffffff;
1550                 DPRINTF("xhci_xfer_data: EDTLA=%d\n", event.length);
1551                 edtla = 0;
1552             }
1553             xhci_event(xhci, &event, TRB_INTR(*trb));
1554             reported = 1;
1555             if (xfer->status != CC_SUCCESS) {
1556                 return;
1557             }
1558         }
1559 
1560         switch (TRB_TYPE(*trb)) {
1561         case TR_SETUP:
1562             reported = 0;
1563             shortpkt = 0;
1564             break;
1565         }
1566 
1567     }
1568 }
1569 
1570 static void xhci_stall_ep(XHCITransfer *xfer)
1571 {
1572     XHCIEPContext *epctx = xfer->epctx;
1573     XHCIState *xhci = epctx->xhci;
1574     uint32_t err;
1575     XHCIStreamContext *sctx;
1576 
1577     if (epctx->type == ET_ISO_IN || epctx->type == ET_ISO_OUT) {
1578         /* never halt isoch endpoints, 4.10.2 */
1579         return;
1580     }
1581 
1582     if (epctx->nr_pstreams) {
1583         sctx = xhci_find_stream(epctx, xfer->streamid, &err);
1584         if (sctx == NULL) {
1585             return;
1586         }
1587         sctx->ring.dequeue = xfer->trbs[0].addr;
1588         sctx->ring.ccs = xfer->trbs[0].ccs;
1589         xhci_set_ep_state(xhci, epctx, sctx, EP_HALTED);
1590     } else {
1591         epctx->ring.dequeue = xfer->trbs[0].addr;
1592         epctx->ring.ccs = xfer->trbs[0].ccs;
1593         xhci_set_ep_state(xhci, epctx, NULL, EP_HALTED);
1594     }
1595 }
1596 
1597 static int xhci_setup_packet(XHCITransfer *xfer)
1598 {
1599     USBEndpoint *ep;
1600     int dir;
1601 
1602     dir = xfer->in_xfer ? USB_TOKEN_IN : USB_TOKEN_OUT;
1603 
1604     if (xfer->packet.ep) {
1605         ep = xfer->packet.ep;
1606     } else {
1607         ep = xhci_epid_to_usbep(xfer->epctx);
1608         if (!ep) {
1609             DPRINTF("xhci: slot %d has no device\n",
1610                     xfer->epctx->slotid);
1611             return -1;
1612         }
1613     }
1614 
1615     xhci_xfer_create_sgl(xfer, dir == USB_TOKEN_IN); /* Also sets int_req */
1616     usb_packet_setup(&xfer->packet, dir, ep, xfer->streamid,
1617                      xfer->trbs[0].addr, false, xfer->int_req);
1618     if (usb_packet_map(&xfer->packet, &xfer->sgl)) {
1619         qemu_sglist_destroy(&xfer->sgl);
1620         return -1;
1621     }
1622     DPRINTF("xhci: setup packet pid 0x%x addr %d ep %d\n",
1623             xfer->packet.pid, ep->dev->addr, ep->nr);
1624     return 0;
1625 }
1626 
1627 static int xhci_try_complete_packet(XHCITransfer *xfer)
1628 {
1629     if (xfer->packet.status == USB_RET_ASYNC) {
1630         trace_usb_xhci_xfer_async(xfer);
1631         xfer->running_async = 1;
1632         xfer->running_retry = 0;
1633         xfer->complete = 0;
1634         return 0;
1635     } else if (xfer->packet.status == USB_RET_NAK) {
1636         trace_usb_xhci_xfer_nak(xfer);
1637         xfer->running_async = 0;
1638         xfer->running_retry = 1;
1639         xfer->complete = 0;
1640         return 0;
1641     } else {
1642         xfer->running_async = 0;
1643         xfer->running_retry = 0;
1644         xfer->complete = 1;
1645         xhci_xfer_unmap(xfer);
1646     }
1647 
1648     if (xfer->packet.status == USB_RET_SUCCESS) {
1649         trace_usb_xhci_xfer_success(xfer, xfer->packet.actual_length);
1650         xfer->status = CC_SUCCESS;
1651         xhci_xfer_report(xfer);
1652         return 0;
1653     }
1654 
1655     /* error */
1656     trace_usb_xhci_xfer_error(xfer, xfer->packet.status);
1657     switch (xfer->packet.status) {
1658     case USB_RET_NODEV:
1659     case USB_RET_IOERROR:
1660         xfer->status = CC_USB_TRANSACTION_ERROR;
1661         xhci_xfer_report(xfer);
1662         xhci_stall_ep(xfer);
1663         break;
1664     case USB_RET_STALL:
1665         xfer->status = CC_STALL_ERROR;
1666         xhci_xfer_report(xfer);
1667         xhci_stall_ep(xfer);
1668         break;
1669     case USB_RET_BABBLE:
1670         xfer->status = CC_BABBLE_DETECTED;
1671         xhci_xfer_report(xfer);
1672         xhci_stall_ep(xfer);
1673         break;
1674     default:
1675         DPRINTF("%s: FIXME: status = %d\n", __func__,
1676                 xfer->packet.status);
1677         FIXME("unhandled USB_RET_*");
1678     }
1679     return 0;
1680 }
1681 
1682 static int xhci_fire_ctl_transfer(XHCIState *xhci, XHCITransfer *xfer)
1683 {
1684     XHCITRB *trb_setup, *trb_status;
1685     uint8_t bmRequestType;
1686 
1687     trb_setup = &xfer->trbs[0];
1688     trb_status = &xfer->trbs[xfer->trb_count-1];
1689 
1690     trace_usb_xhci_xfer_start(xfer, xfer->epctx->slotid,
1691                               xfer->epctx->epid, xfer->streamid);
1692 
1693     /* at most one Event Data TRB allowed after STATUS */
1694     if (TRB_TYPE(*trb_status) == TR_EVDATA && xfer->trb_count > 2) {
1695         trb_status--;
1696     }
1697 
1698     /* do some sanity checks */
1699     if (TRB_TYPE(*trb_setup) != TR_SETUP) {
1700         DPRINTF("xhci: ep0 first TD not SETUP: %d\n",
1701                 TRB_TYPE(*trb_setup));
1702         return -1;
1703     }
1704     if (TRB_TYPE(*trb_status) != TR_STATUS) {
1705         DPRINTF("xhci: ep0 last TD not STATUS: %d\n",
1706                 TRB_TYPE(*trb_status));
1707         return -1;
1708     }
1709     if (!(trb_setup->control & TRB_TR_IDT)) {
1710         DPRINTF("xhci: Setup TRB doesn't have IDT set\n");
1711         return -1;
1712     }
1713     if ((trb_setup->status & 0x1ffff) != 8) {
1714         DPRINTF("xhci: Setup TRB has bad length (%d)\n",
1715                 (trb_setup->status & 0x1ffff));
1716         return -1;
1717     }
1718 
1719     bmRequestType = trb_setup->parameter;
1720 
1721     xfer->in_xfer = bmRequestType & USB_DIR_IN;
1722     xfer->iso_xfer = false;
1723     xfer->timed_xfer = false;
1724 
1725     if (xhci_setup_packet(xfer) < 0) {
1726         return -1;
1727     }
1728     xfer->packet.parameter = trb_setup->parameter;
1729 
1730     usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1731     xhci_try_complete_packet(xfer);
1732     return 0;
1733 }
1734 
1735 static void xhci_calc_intr_kick(XHCIState *xhci, XHCITransfer *xfer,
1736                                 XHCIEPContext *epctx, uint64_t mfindex)
1737 {
1738     uint64_t asap = ((mfindex + epctx->interval - 1) &
1739                      ~(epctx->interval-1));
1740     uint64_t kick = epctx->mfindex_last + epctx->interval;
1741 
1742     assert(epctx->interval != 0);
1743     xfer->mfindex_kick = MAX(asap, kick);
1744 }
1745 
1746 static void xhci_calc_iso_kick(XHCIState *xhci, XHCITransfer *xfer,
1747                                XHCIEPContext *epctx, uint64_t mfindex)
1748 {
1749     if (xfer->trbs[0].control & TRB_TR_SIA) {
1750         uint64_t asap = ((mfindex + epctx->interval - 1) &
1751                          ~(epctx->interval-1));
1752         if (asap >= epctx->mfindex_last &&
1753             asap <= epctx->mfindex_last + epctx->interval * 4) {
1754             xfer->mfindex_kick = epctx->mfindex_last + epctx->interval;
1755         } else {
1756             xfer->mfindex_kick = asap;
1757         }
1758     } else {
1759         xfer->mfindex_kick = ((xfer->trbs[0].control >> TRB_TR_FRAMEID_SHIFT)
1760                               & TRB_TR_FRAMEID_MASK) << 3;
1761         xfer->mfindex_kick |= mfindex & ~0x3fff;
1762         if (xfer->mfindex_kick + 0x100 < mfindex) {
1763             xfer->mfindex_kick += 0x4000;
1764         }
1765     }
1766 }
1767 
1768 static void xhci_check_intr_iso_kick(XHCIState *xhci, XHCITransfer *xfer,
1769                                      XHCIEPContext *epctx, uint64_t mfindex)
1770 {
1771     if (xfer->mfindex_kick > mfindex) {
1772         timer_mod(epctx->kick_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
1773                        (xfer->mfindex_kick - mfindex) * 125000);
1774         xfer->running_retry = 1;
1775     } else {
1776         epctx->mfindex_last = xfer->mfindex_kick;
1777         timer_del(epctx->kick_timer);
1778         xfer->running_retry = 0;
1779     }
1780 }
1781 
1782 
1783 static int xhci_submit(XHCIState *xhci, XHCITransfer *xfer, XHCIEPContext *epctx)
1784 {
1785     uint64_t mfindex;
1786 
1787     DPRINTF("xhci_submit(slotid=%d,epid=%d)\n", epctx->slotid, epctx->epid);
1788 
1789     xfer->in_xfer = epctx->type>>2;
1790 
1791     switch(epctx->type) {
1792     case ET_INTR_OUT:
1793     case ET_INTR_IN:
1794         xfer->pkts = 0;
1795         xfer->iso_xfer = false;
1796         xfer->timed_xfer = true;
1797         mfindex = xhci_mfindex_get(xhci);
1798         xhci_calc_intr_kick(xhci, xfer, epctx, mfindex);
1799         xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1800         if (xfer->running_retry) {
1801             return -1;
1802         }
1803         break;
1804     case ET_BULK_OUT:
1805     case ET_BULK_IN:
1806         xfer->pkts = 0;
1807         xfer->iso_xfer = false;
1808         xfer->timed_xfer = false;
1809         break;
1810     case ET_ISO_OUT:
1811     case ET_ISO_IN:
1812         xfer->pkts = 1;
1813         xfer->iso_xfer = true;
1814         xfer->timed_xfer = true;
1815         mfindex = xhci_mfindex_get(xhci);
1816         xhci_calc_iso_kick(xhci, xfer, epctx, mfindex);
1817         xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1818         if (xfer->running_retry) {
1819             return -1;
1820         }
1821         break;
1822     default:
1823         trace_usb_xhci_unimplemented("endpoint type", epctx->type);
1824         return -1;
1825     }
1826 
1827     if (xhci_setup_packet(xfer) < 0) {
1828         return -1;
1829     }
1830     usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1831     xhci_try_complete_packet(xfer);
1832     return 0;
1833 }
1834 
1835 static int xhci_fire_transfer(XHCIState *xhci, XHCITransfer *xfer, XHCIEPContext *epctx)
1836 {
1837     trace_usb_xhci_xfer_start(xfer, xfer->epctx->slotid,
1838                               xfer->epctx->epid, xfer->streamid);
1839     return xhci_submit(xhci, xfer, epctx);
1840 }
1841 
1842 static void xhci_kick_ep(XHCIState *xhci, unsigned int slotid,
1843                          unsigned int epid, unsigned int streamid)
1844 {
1845     XHCIEPContext *epctx;
1846 
1847     assert(slotid >= 1 && slotid <= xhci->numslots);
1848     assert(epid >= 1 && epid <= 31);
1849 
1850     if (!xhci->slots[slotid-1].enabled) {
1851         DPRINTF("xhci: xhci_kick_ep for disabled slot %d\n", slotid);
1852         return;
1853     }
1854     epctx = xhci->slots[slotid-1].eps[epid-1];
1855     if (!epctx) {
1856         DPRINTF("xhci: xhci_kick_ep for disabled endpoint %d,%d\n",
1857                 epid, slotid);
1858         return;
1859     }
1860 
1861     if (epctx->kick_active) {
1862         return;
1863     }
1864     xhci_kick_epctx(epctx, streamid);
1865 }
1866 
1867 static bool xhci_slot_ok(XHCIState *xhci, int slotid)
1868 {
1869     return (xhci->slots[slotid - 1].uport &&
1870             xhci->slots[slotid - 1].uport->dev &&
1871             xhci->slots[slotid - 1].uport->dev->attached);
1872 }
1873 
1874 static void xhci_kick_epctx(XHCIEPContext *epctx, unsigned int streamid)
1875 {
1876     XHCIState *xhci = epctx->xhci;
1877     XHCIStreamContext *stctx = NULL;
1878     XHCITransfer *xfer;
1879     XHCIRing *ring;
1880     USBEndpoint *ep = NULL;
1881     uint64_t mfindex;
1882     unsigned int count = 0;
1883     int length;
1884     int i;
1885 
1886     trace_usb_xhci_ep_kick(epctx->slotid, epctx->epid, streamid);
1887     assert(!epctx->kick_active);
1888 
1889     /* If the device has been detached, but the guest has not noticed this
1890        yet the 2 above checks will succeed, but we must NOT continue */
1891     if (!xhci_slot_ok(xhci, epctx->slotid)) {
1892         return;
1893     }
1894 
1895     if (epctx->retry) {
1896         XHCITransfer *xfer = epctx->retry;
1897 
1898         trace_usb_xhci_xfer_retry(xfer);
1899         assert(xfer->running_retry);
1900         if (xfer->timed_xfer) {
1901             /* time to kick the transfer? */
1902             mfindex = xhci_mfindex_get(xhci);
1903             xhci_check_intr_iso_kick(xhci, xfer, epctx, mfindex);
1904             if (xfer->running_retry) {
1905                 return;
1906             }
1907             xfer->timed_xfer = 0;
1908             xfer->running_retry = 1;
1909         }
1910         if (xfer->iso_xfer) {
1911             /* retry iso transfer */
1912             if (xhci_setup_packet(xfer) < 0) {
1913                 return;
1914             }
1915             usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1916             assert(xfer->packet.status != USB_RET_NAK);
1917             xhci_try_complete_packet(xfer);
1918         } else {
1919             /* retry nak'ed transfer */
1920             if (xhci_setup_packet(xfer) < 0) {
1921                 return;
1922             }
1923             usb_handle_packet(xfer->packet.ep->dev, &xfer->packet);
1924             if (xfer->packet.status == USB_RET_NAK) {
1925                 xhci_xfer_unmap(xfer);
1926                 return;
1927             }
1928             xhci_try_complete_packet(xfer);
1929         }
1930         assert(!xfer->running_retry);
1931         if (xfer->complete) {
1932             /* update ring dequeue ptr */
1933             xhci_set_ep_state(xhci, epctx, stctx, epctx->state);
1934             xhci_ep_free_xfer(epctx->retry);
1935         }
1936         epctx->retry = NULL;
1937     }
1938 
1939     if (epctx->state == EP_HALTED) {
1940         DPRINTF("xhci: ep halted, not running schedule\n");
1941         return;
1942     }
1943 
1944 
1945     if (epctx->nr_pstreams) {
1946         uint32_t err;
1947         stctx = xhci_find_stream(epctx, streamid, &err);
1948         if (stctx == NULL) {
1949             return;
1950         }
1951         ring = &stctx->ring;
1952         xhci_set_ep_state(xhci, epctx, stctx, EP_RUNNING);
1953     } else {
1954         ring = &epctx->ring;
1955         streamid = 0;
1956         xhci_set_ep_state(xhci, epctx, NULL, EP_RUNNING);
1957     }
1958     assert(ring->dequeue != 0);
1959 
1960     epctx->kick_active++;
1961     while (1) {
1962         length = xhci_ring_chain_length(xhci, ring);
1963         if (length <= 0) {
1964             if (epctx->type == ET_ISO_OUT || epctx->type == ET_ISO_IN) {
1965                 /* 4.10.3.1 */
1966                 XHCIEvent ev = { ER_TRANSFER };
1967                 ev.ccode  = epctx->type == ET_ISO_IN ?
1968                     CC_RING_OVERRUN : CC_RING_UNDERRUN;
1969                 ev.slotid = epctx->slotid;
1970                 ev.epid   = epctx->epid;
1971                 ev.ptr    = epctx->ring.dequeue;
1972                 xhci_event(xhci, &ev, xhci->slots[epctx->slotid-1].intr);
1973             }
1974             break;
1975         }
1976         xfer = xhci_ep_alloc_xfer(epctx, length);
1977         if (xfer == NULL) {
1978             break;
1979         }
1980 
1981         for (i = 0; i < length; i++) {
1982             TRBType type;
1983             type = xhci_ring_fetch(xhci, ring, &xfer->trbs[i], NULL);
1984             if (!type) {
1985                 xhci_die(xhci);
1986                 xhci_ep_free_xfer(xfer);
1987                 epctx->kick_active--;
1988                 return;
1989             }
1990         }
1991         xfer->streamid = streamid;
1992 
1993         if (epctx->epid == 1) {
1994             xhci_fire_ctl_transfer(xhci, xfer);
1995         } else {
1996             xhci_fire_transfer(xhci, xfer, epctx);
1997         }
1998         if (!xhci_slot_ok(xhci, epctx->slotid)) {
1999             /* surprise removal -> stop processing */
2000             break;
2001         }
2002         if (xfer->complete) {
2003             /* update ring dequeue ptr */
2004             xhci_set_ep_state(xhci, epctx, stctx, epctx->state);
2005             xhci_ep_free_xfer(xfer);
2006             xfer = NULL;
2007         }
2008 
2009         if (epctx->state == EP_HALTED) {
2010             break;
2011         }
2012         if (xfer != NULL && xfer->running_retry) {
2013             DPRINTF("xhci: xfer nacked, stopping schedule\n");
2014             epctx->retry = xfer;
2015             xhci_xfer_unmap(xfer);
2016             break;
2017         }
2018         if (count++ > TRANSFER_LIMIT) {
2019             trace_usb_xhci_enforced_limit("transfers");
2020             break;
2021         }
2022     }
2023     epctx->kick_active--;
2024 
2025     ep = xhci_epid_to_usbep(epctx);
2026     if (ep) {
2027         usb_device_flush_ep_queue(ep->dev, ep);
2028     }
2029 }
2030 
2031 static TRBCCode xhci_enable_slot(XHCIState *xhci, unsigned int slotid)
2032 {
2033     trace_usb_xhci_slot_enable(slotid);
2034     assert(slotid >= 1 && slotid <= xhci->numslots);
2035     xhci->slots[slotid-1].enabled = 1;
2036     xhci->slots[slotid-1].uport = NULL;
2037     memset(xhci->slots[slotid-1].eps, 0, sizeof(XHCIEPContext*)*31);
2038 
2039     return CC_SUCCESS;
2040 }
2041 
2042 static TRBCCode xhci_disable_slot(XHCIState *xhci, unsigned int slotid)
2043 {
2044     int i;
2045 
2046     trace_usb_xhci_slot_disable(slotid);
2047     assert(slotid >= 1 && slotid <= xhci->numslots);
2048 
2049     for (i = 1; i <= 31; i++) {
2050         if (xhci->slots[slotid-1].eps[i-1]) {
2051             xhci_disable_ep(xhci, slotid, i);
2052         }
2053     }
2054 
2055     xhci->slots[slotid-1].enabled = 0;
2056     xhci->slots[slotid-1].addressed = 0;
2057     xhci->slots[slotid-1].uport = NULL;
2058     xhci->slots[slotid-1].intr = 0;
2059     return CC_SUCCESS;
2060 }
2061 
2062 static USBPort *xhci_lookup_uport(XHCIState *xhci, uint32_t *slot_ctx)
2063 {
2064     USBPort *uport;
2065     char path[32];
2066     int i, pos, port;
2067 
2068     port = (slot_ctx[1]>>16) & 0xFF;
2069     if (port < 1 || port > xhci->numports) {
2070         return NULL;
2071     }
2072     port = xhci->ports[port-1].uport->index+1;
2073     pos = snprintf(path, sizeof(path), "%d", port);
2074     for (i = 0; i < 5; i++) {
2075         port = (slot_ctx[0] >> 4*i) & 0x0f;
2076         if (!port) {
2077             break;
2078         }
2079         pos += snprintf(path + pos, sizeof(path) - pos, ".%d", port);
2080     }
2081 
2082     QTAILQ_FOREACH(uport, &xhci->bus.used, next) {
2083         if (strcmp(uport->path, path) == 0) {
2084             return uport;
2085         }
2086     }
2087     return NULL;
2088 }
2089 
2090 static TRBCCode xhci_address_slot(XHCIState *xhci, unsigned int slotid,
2091                                   uint64_t pictx, bool bsr)
2092 {
2093     XHCISlot *slot;
2094     USBPort *uport;
2095     USBDevice *dev;
2096     dma_addr_t ictx, octx, dcbaap;
2097     uint64_t poctx;
2098     uint32_t ictl_ctx[2];
2099     uint32_t slot_ctx[4];
2100     uint32_t ep0_ctx[5];
2101     int i;
2102     TRBCCode res;
2103 
2104     assert(slotid >= 1 && slotid <= xhci->numslots);
2105 
2106     dcbaap = xhci_addr64(xhci->dcbaap_low, xhci->dcbaap_high);
2107     poctx = ldq_le_pci_dma(PCI_DEVICE(xhci), dcbaap + 8 * slotid);
2108     ictx = xhci_mask64(pictx);
2109     octx = xhci_mask64(poctx);
2110 
2111     DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2112     DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2113 
2114     xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2115 
2116     if (ictl_ctx[0] != 0x0 || ictl_ctx[1] != 0x3) {
2117         DPRINTF("xhci: invalid input context control %08x %08x\n",
2118                 ictl_ctx[0], ictl_ctx[1]);
2119         return CC_TRB_ERROR;
2120     }
2121 
2122     xhci_dma_read_u32s(xhci, ictx+32, slot_ctx, sizeof(slot_ctx));
2123     xhci_dma_read_u32s(xhci, ictx+64, ep0_ctx, sizeof(ep0_ctx));
2124 
2125     DPRINTF("xhci: input slot context: %08x %08x %08x %08x\n",
2126             slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2127 
2128     DPRINTF("xhci: input ep0 context: %08x %08x %08x %08x %08x\n",
2129             ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2130 
2131     uport = xhci_lookup_uport(xhci, slot_ctx);
2132     if (uport == NULL) {
2133         DPRINTF("xhci: port not found\n");
2134         return CC_TRB_ERROR;
2135     }
2136     trace_usb_xhci_slot_address(slotid, uport->path);
2137 
2138     dev = uport->dev;
2139     if (!dev || !dev->attached) {
2140         DPRINTF("xhci: port %s not connected\n", uport->path);
2141         return CC_USB_TRANSACTION_ERROR;
2142     }
2143 
2144     for (i = 0; i < xhci->numslots; i++) {
2145         if (i == slotid-1) {
2146             continue;
2147         }
2148         if (xhci->slots[i].uport == uport) {
2149             DPRINTF("xhci: port %s already assigned to slot %d\n",
2150                     uport->path, i+1);
2151             return CC_TRB_ERROR;
2152         }
2153     }
2154 
2155     slot = &xhci->slots[slotid-1];
2156     slot->uport = uport;
2157     slot->ctx = octx;
2158     slot->intr = get_field(slot_ctx[2], TRB_INTR);
2159 
2160     /* Make sure device is in USB_STATE_DEFAULT state */
2161     usb_device_reset(dev);
2162     if (bsr) {
2163         slot_ctx[3] = SLOT_DEFAULT << SLOT_STATE_SHIFT;
2164     } else {
2165         USBPacket p;
2166         uint8_t buf[1];
2167 
2168         slot_ctx[3] = (SLOT_ADDRESSED << SLOT_STATE_SHIFT) | slotid;
2169         memset(&p, 0, sizeof(p));
2170         usb_packet_addbuf(&p, buf, sizeof(buf));
2171         usb_packet_setup(&p, USB_TOKEN_OUT,
2172                          usb_ep_get(dev, USB_TOKEN_OUT, 0), 0,
2173                          0, false, false);
2174         usb_device_handle_control(dev, &p,
2175                                   DeviceOutRequest | USB_REQ_SET_ADDRESS,
2176                                   slotid, 0, 0, NULL);
2177         assert(p.status != USB_RET_ASYNC);
2178         usb_packet_cleanup(&p);
2179     }
2180 
2181     res = xhci_enable_ep(xhci, slotid, 1, octx+32, ep0_ctx);
2182 
2183     DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2184             slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2185     DPRINTF("xhci: output ep0 context: %08x %08x %08x %08x %08x\n",
2186             ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2187 
2188     xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2189     xhci_dma_write_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2190 
2191     xhci->slots[slotid-1].addressed = 1;
2192     return res;
2193 }
2194 
2195 
2196 static TRBCCode xhci_configure_slot(XHCIState *xhci, unsigned int slotid,
2197                                   uint64_t pictx, bool dc)
2198 {
2199     dma_addr_t ictx, octx;
2200     uint32_t ictl_ctx[2];
2201     uint32_t slot_ctx[4];
2202     uint32_t islot_ctx[4];
2203     uint32_t ep_ctx[5];
2204     int i;
2205     TRBCCode res;
2206 
2207     trace_usb_xhci_slot_configure(slotid);
2208     assert(slotid >= 1 && slotid <= xhci->numslots);
2209 
2210     ictx = xhci_mask64(pictx);
2211     octx = xhci->slots[slotid-1].ctx;
2212 
2213     DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2214     DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2215 
2216     if (dc) {
2217         for (i = 2; i <= 31; i++) {
2218             if (xhci->slots[slotid-1].eps[i-1]) {
2219                 xhci_disable_ep(xhci, slotid, i);
2220             }
2221         }
2222 
2223         xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2224         slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2225         slot_ctx[3] |= SLOT_ADDRESSED << SLOT_STATE_SHIFT;
2226         DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2227                 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2228         xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2229 
2230         return CC_SUCCESS;
2231     }
2232 
2233     xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2234 
2235     if ((ictl_ctx[0] & 0x3) != 0x0 || (ictl_ctx[1] & 0x3) != 0x1) {
2236         DPRINTF("xhci: invalid input context control %08x %08x\n",
2237                 ictl_ctx[0], ictl_ctx[1]);
2238         return CC_TRB_ERROR;
2239     }
2240 
2241     xhci_dma_read_u32s(xhci, ictx+32, islot_ctx, sizeof(islot_ctx));
2242     xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2243 
2244     if (SLOT_STATE(slot_ctx[3]) < SLOT_ADDRESSED) {
2245         DPRINTF("xhci: invalid slot state %08x\n", slot_ctx[3]);
2246         return CC_CONTEXT_STATE_ERROR;
2247     }
2248 
2249     xhci_free_device_streams(xhci, slotid, ictl_ctx[0] | ictl_ctx[1]);
2250 
2251     for (i = 2; i <= 31; i++) {
2252         if (ictl_ctx[0] & (1<<i)) {
2253             xhci_disable_ep(xhci, slotid, i);
2254         }
2255         if (ictl_ctx[1] & (1<<i)) {
2256             xhci_dma_read_u32s(xhci, ictx+32+(32*i), ep_ctx, sizeof(ep_ctx));
2257             DPRINTF("xhci: input ep%d.%d context: %08x %08x %08x %08x %08x\n",
2258                     i/2, i%2, ep_ctx[0], ep_ctx[1], ep_ctx[2],
2259                     ep_ctx[3], ep_ctx[4]);
2260             xhci_disable_ep(xhci, slotid, i);
2261             res = xhci_enable_ep(xhci, slotid, i, octx+(32*i), ep_ctx);
2262             if (res != CC_SUCCESS) {
2263                 return res;
2264             }
2265             DPRINTF("xhci: output ep%d.%d context: %08x %08x %08x %08x %08x\n",
2266                     i/2, i%2, ep_ctx[0], ep_ctx[1], ep_ctx[2],
2267                     ep_ctx[3], ep_ctx[4]);
2268             xhci_dma_write_u32s(xhci, octx+(32*i), ep_ctx, sizeof(ep_ctx));
2269         }
2270     }
2271 
2272     res = xhci_alloc_device_streams(xhci, slotid, ictl_ctx[1]);
2273     if (res != CC_SUCCESS) {
2274         for (i = 2; i <= 31; i++) {
2275             if (ictl_ctx[1] & (1u << i)) {
2276                 xhci_disable_ep(xhci, slotid, i);
2277             }
2278         }
2279         return res;
2280     }
2281 
2282     slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2283     slot_ctx[3] |= SLOT_CONFIGURED << SLOT_STATE_SHIFT;
2284     slot_ctx[0] &= ~(SLOT_CONTEXT_ENTRIES_MASK << SLOT_CONTEXT_ENTRIES_SHIFT);
2285     slot_ctx[0] |= islot_ctx[0] & (SLOT_CONTEXT_ENTRIES_MASK <<
2286                                    SLOT_CONTEXT_ENTRIES_SHIFT);
2287     DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2288             slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2289 
2290     xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2291 
2292     return CC_SUCCESS;
2293 }
2294 
2295 
2296 static TRBCCode xhci_evaluate_slot(XHCIState *xhci, unsigned int slotid,
2297                                    uint64_t pictx)
2298 {
2299     dma_addr_t ictx, octx;
2300     uint32_t ictl_ctx[2];
2301     uint32_t iep0_ctx[5];
2302     uint32_t ep0_ctx[5];
2303     uint32_t islot_ctx[4];
2304     uint32_t slot_ctx[4];
2305 
2306     trace_usb_xhci_slot_evaluate(slotid);
2307     assert(slotid >= 1 && slotid <= xhci->numslots);
2308 
2309     ictx = xhci_mask64(pictx);
2310     octx = xhci->slots[slotid-1].ctx;
2311 
2312     DPRINTF("xhci: input context at "DMA_ADDR_FMT"\n", ictx);
2313     DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2314 
2315     xhci_dma_read_u32s(xhci, ictx, ictl_ctx, sizeof(ictl_ctx));
2316 
2317     if (ictl_ctx[0] != 0x0 || ictl_ctx[1] & ~0x3) {
2318         DPRINTF("xhci: invalid input context control %08x %08x\n",
2319                 ictl_ctx[0], ictl_ctx[1]);
2320         return CC_TRB_ERROR;
2321     }
2322 
2323     if (ictl_ctx[1] & 0x1) {
2324         xhci_dma_read_u32s(xhci, ictx+32, islot_ctx, sizeof(islot_ctx));
2325 
2326         DPRINTF("xhci: input slot context: %08x %08x %08x %08x\n",
2327                 islot_ctx[0], islot_ctx[1], islot_ctx[2], islot_ctx[3]);
2328 
2329         xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2330 
2331         slot_ctx[1] &= ~0xFFFF; /* max exit latency */
2332         slot_ctx[1] |= islot_ctx[1] & 0xFFFF;
2333         /* update interrupter target field */
2334         xhci->slots[slotid-1].intr = get_field(islot_ctx[2], TRB_INTR);
2335         set_field(&slot_ctx[2], xhci->slots[slotid-1].intr, TRB_INTR);
2336 
2337         DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2338                 slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2339 
2340         xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2341     }
2342 
2343     if (ictl_ctx[1] & 0x2) {
2344         xhci_dma_read_u32s(xhci, ictx+64, iep0_ctx, sizeof(iep0_ctx));
2345 
2346         DPRINTF("xhci: input ep0 context: %08x %08x %08x %08x %08x\n",
2347                 iep0_ctx[0], iep0_ctx[1], iep0_ctx[2],
2348                 iep0_ctx[3], iep0_ctx[4]);
2349 
2350         xhci_dma_read_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2351 
2352         ep0_ctx[1] &= ~0xFFFF0000; /* max packet size*/
2353         ep0_ctx[1] |= iep0_ctx[1] & 0xFFFF0000;
2354 
2355         DPRINTF("xhci: output ep0 context: %08x %08x %08x %08x %08x\n",
2356                 ep0_ctx[0], ep0_ctx[1], ep0_ctx[2], ep0_ctx[3], ep0_ctx[4]);
2357 
2358         xhci_dma_write_u32s(xhci, octx+32, ep0_ctx, sizeof(ep0_ctx));
2359     }
2360 
2361     return CC_SUCCESS;
2362 }
2363 
2364 static TRBCCode xhci_reset_slot(XHCIState *xhci, unsigned int slotid)
2365 {
2366     uint32_t slot_ctx[4];
2367     dma_addr_t octx;
2368     int i;
2369 
2370     trace_usb_xhci_slot_reset(slotid);
2371     assert(slotid >= 1 && slotid <= xhci->numslots);
2372 
2373     octx = xhci->slots[slotid-1].ctx;
2374 
2375     DPRINTF("xhci: output context at "DMA_ADDR_FMT"\n", octx);
2376 
2377     for (i = 2; i <= 31; i++) {
2378         if (xhci->slots[slotid-1].eps[i-1]) {
2379             xhci_disable_ep(xhci, slotid, i);
2380         }
2381     }
2382 
2383     xhci_dma_read_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2384     slot_ctx[3] &= ~(SLOT_STATE_MASK << SLOT_STATE_SHIFT);
2385     slot_ctx[3] |= SLOT_DEFAULT << SLOT_STATE_SHIFT;
2386     DPRINTF("xhci: output slot context: %08x %08x %08x %08x\n",
2387             slot_ctx[0], slot_ctx[1], slot_ctx[2], slot_ctx[3]);
2388     xhci_dma_write_u32s(xhci, octx, slot_ctx, sizeof(slot_ctx));
2389 
2390     return CC_SUCCESS;
2391 }
2392 
2393 static unsigned int xhci_get_slot(XHCIState *xhci, XHCIEvent *event, XHCITRB *trb)
2394 {
2395     unsigned int slotid;
2396     slotid = (trb->control >> TRB_CR_SLOTID_SHIFT) & TRB_CR_SLOTID_MASK;
2397     if (slotid < 1 || slotid > xhci->numslots) {
2398         DPRINTF("xhci: bad slot id %d\n", slotid);
2399         event->ccode = CC_TRB_ERROR;
2400         return 0;
2401     } else if (!xhci->slots[slotid-1].enabled) {
2402         DPRINTF("xhci: slot id %d not enabled\n", slotid);
2403         event->ccode = CC_SLOT_NOT_ENABLED_ERROR;
2404         return 0;
2405     }
2406     return slotid;
2407 }
2408 
2409 /* cleanup slot state on usb device detach */
2410 static void xhci_detach_slot(XHCIState *xhci, USBPort *uport)
2411 {
2412     int slot, ep;
2413 
2414     for (slot = 0; slot < xhci->numslots; slot++) {
2415         if (xhci->slots[slot].uport == uport) {
2416             break;
2417         }
2418     }
2419     if (slot == xhci->numslots) {
2420         return;
2421     }
2422 
2423     for (ep = 0; ep < 31; ep++) {
2424         if (xhci->slots[slot].eps[ep]) {
2425             xhci_ep_nuke_xfers(xhci, slot + 1, ep + 1, 0);
2426         }
2427     }
2428     xhci->slots[slot].uport = NULL;
2429 }
2430 
2431 static TRBCCode xhci_get_port_bandwidth(XHCIState *xhci, uint64_t pctx)
2432 {
2433     dma_addr_t ctx;
2434     uint8_t bw_ctx[xhci->numports+1];
2435 
2436     DPRINTF("xhci_get_port_bandwidth()\n");
2437 
2438     ctx = xhci_mask64(pctx);
2439 
2440     DPRINTF("xhci: bandwidth context at "DMA_ADDR_FMT"\n", ctx);
2441 
2442     /* TODO: actually implement real values here */
2443     bw_ctx[0] = 0;
2444     memset(&bw_ctx[1], 80, xhci->numports); /* 80% */
2445     pci_dma_write(PCI_DEVICE(xhci), ctx, bw_ctx, sizeof(bw_ctx));
2446 
2447     return CC_SUCCESS;
2448 }
2449 
2450 static uint32_t rotl(uint32_t v, unsigned count)
2451 {
2452     count &= 31;
2453     return (v << count) | (v >> (32 - count));
2454 }
2455 
2456 
2457 static uint32_t xhci_nec_challenge(uint32_t hi, uint32_t lo)
2458 {
2459     uint32_t val;
2460     val = rotl(lo - 0x49434878, 32 - ((hi>>8) & 0x1F));
2461     val += rotl(lo + 0x49434878, hi & 0x1F);
2462     val -= rotl(hi ^ 0x49434878, (lo >> 16) & 0x1F);
2463     return ~val;
2464 }
2465 
2466 static void xhci_process_commands(XHCIState *xhci)
2467 {
2468     XHCITRB trb;
2469     TRBType type;
2470     XHCIEvent event = {ER_COMMAND_COMPLETE, CC_SUCCESS};
2471     dma_addr_t addr;
2472     unsigned int i, slotid = 0, count = 0;
2473 
2474     DPRINTF("xhci_process_commands()\n");
2475     if (!xhci_running(xhci)) {
2476         DPRINTF("xhci_process_commands() called while xHC stopped or paused\n");
2477         return;
2478     }
2479 
2480     xhci->crcr_low |= CRCR_CRR;
2481 
2482     while ((type = xhci_ring_fetch(xhci, &xhci->cmd_ring, &trb, &addr))) {
2483         event.ptr = addr;
2484         switch (type) {
2485         case CR_ENABLE_SLOT:
2486             for (i = 0; i < xhci->numslots; i++) {
2487                 if (!xhci->slots[i].enabled) {
2488                     break;
2489                 }
2490             }
2491             if (i >= xhci->numslots) {
2492                 DPRINTF("xhci: no device slots available\n");
2493                 event.ccode = CC_NO_SLOTS_ERROR;
2494             } else {
2495                 slotid = i+1;
2496                 event.ccode = xhci_enable_slot(xhci, slotid);
2497             }
2498             break;
2499         case CR_DISABLE_SLOT:
2500             slotid = xhci_get_slot(xhci, &event, &trb);
2501             if (slotid) {
2502                 event.ccode = xhci_disable_slot(xhci, slotid);
2503             }
2504             break;
2505         case CR_ADDRESS_DEVICE:
2506             slotid = xhci_get_slot(xhci, &event, &trb);
2507             if (slotid) {
2508                 event.ccode = xhci_address_slot(xhci, slotid, trb.parameter,
2509                                                 trb.control & TRB_CR_BSR);
2510             }
2511             break;
2512         case CR_CONFIGURE_ENDPOINT:
2513             slotid = xhci_get_slot(xhci, &event, &trb);
2514             if (slotid) {
2515                 event.ccode = xhci_configure_slot(xhci, slotid, trb.parameter,
2516                                                   trb.control & TRB_CR_DC);
2517             }
2518             break;
2519         case CR_EVALUATE_CONTEXT:
2520             slotid = xhci_get_slot(xhci, &event, &trb);
2521             if (slotid) {
2522                 event.ccode = xhci_evaluate_slot(xhci, slotid, trb.parameter);
2523             }
2524             break;
2525         case CR_STOP_ENDPOINT:
2526             slotid = xhci_get_slot(xhci, &event, &trb);
2527             if (slotid) {
2528                 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2529                     & TRB_CR_EPID_MASK;
2530                 event.ccode = xhci_stop_ep(xhci, slotid, epid);
2531             }
2532             break;
2533         case CR_RESET_ENDPOINT:
2534             slotid = xhci_get_slot(xhci, &event, &trb);
2535             if (slotid) {
2536                 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2537                     & TRB_CR_EPID_MASK;
2538                 event.ccode = xhci_reset_ep(xhci, slotid, epid);
2539             }
2540             break;
2541         case CR_SET_TR_DEQUEUE:
2542             slotid = xhci_get_slot(xhci, &event, &trb);
2543             if (slotid) {
2544                 unsigned int epid = (trb.control >> TRB_CR_EPID_SHIFT)
2545                     & TRB_CR_EPID_MASK;
2546                 unsigned int streamid = (trb.status >> 16) & 0xffff;
2547                 event.ccode = xhci_set_ep_dequeue(xhci, slotid,
2548                                                   epid, streamid,
2549                                                   trb.parameter);
2550             }
2551             break;
2552         case CR_RESET_DEVICE:
2553             slotid = xhci_get_slot(xhci, &event, &trb);
2554             if (slotid) {
2555                 event.ccode = xhci_reset_slot(xhci, slotid);
2556             }
2557             break;
2558         case CR_GET_PORT_BANDWIDTH:
2559             event.ccode = xhci_get_port_bandwidth(xhci, trb.parameter);
2560             break;
2561         case CR_NOOP:
2562             event.ccode = CC_SUCCESS;
2563             break;
2564         case CR_VENDOR_NEC_FIRMWARE_REVISION:
2565             if (xhci->nec_quirks) {
2566                 event.type = 48; /* NEC reply */
2567                 event.length = 0x3025;
2568             } else {
2569                 event.ccode = CC_TRB_ERROR;
2570             }
2571             break;
2572         case CR_VENDOR_NEC_CHALLENGE_RESPONSE:
2573             if (xhci->nec_quirks) {
2574                 uint32_t chi = trb.parameter >> 32;
2575                 uint32_t clo = trb.parameter;
2576                 uint32_t val = xhci_nec_challenge(chi, clo);
2577                 event.length = val & 0xFFFF;
2578                 event.epid = val >> 16;
2579                 slotid = val >> 24;
2580                 event.type = 48; /* NEC reply */
2581             } else {
2582                 event.ccode = CC_TRB_ERROR;
2583             }
2584             break;
2585         default:
2586             trace_usb_xhci_unimplemented("command", type);
2587             event.ccode = CC_TRB_ERROR;
2588             break;
2589         }
2590         event.slotid = slotid;
2591         xhci_event(xhci, &event, 0);
2592 
2593         if (count++ > COMMAND_LIMIT) {
2594             trace_usb_xhci_enforced_limit("commands");
2595             return;
2596         }
2597     }
2598 }
2599 
2600 static bool xhci_port_have_device(XHCIPort *port)
2601 {
2602     if (!port->uport->dev || !port->uport->dev->attached) {
2603         return false; /* no device present */
2604     }
2605     if (!((1 << port->uport->dev->speed) & port->speedmask)) {
2606         return false; /* speed mismatch */
2607     }
2608     return true;
2609 }
2610 
2611 static void xhci_port_notify(XHCIPort *port, uint32_t bits)
2612 {
2613     XHCIEvent ev = { ER_PORT_STATUS_CHANGE, CC_SUCCESS,
2614                      port->portnr << 24 };
2615 
2616     if ((port->portsc & bits) == bits) {
2617         return;
2618     }
2619     trace_usb_xhci_port_notify(port->portnr, bits);
2620     port->portsc |= bits;
2621     if (!xhci_running(port->xhci)) {
2622         return;
2623     }
2624     xhci_event(port->xhci, &ev, 0);
2625 }
2626 
2627 static void xhci_port_update(XHCIPort *port, int is_detach)
2628 {
2629     uint32_t pls = PLS_RX_DETECT;
2630 
2631     assert(port);
2632     port->portsc = PORTSC_PP;
2633     if (!is_detach && xhci_port_have_device(port)) {
2634         port->portsc |= PORTSC_CCS;
2635         switch (port->uport->dev->speed) {
2636         case USB_SPEED_LOW:
2637             port->portsc |= PORTSC_SPEED_LOW;
2638             pls = PLS_POLLING;
2639             break;
2640         case USB_SPEED_FULL:
2641             port->portsc |= PORTSC_SPEED_FULL;
2642             pls = PLS_POLLING;
2643             break;
2644         case USB_SPEED_HIGH:
2645             port->portsc |= PORTSC_SPEED_HIGH;
2646             pls = PLS_POLLING;
2647             break;
2648         case USB_SPEED_SUPER:
2649             port->portsc |= PORTSC_SPEED_SUPER;
2650             port->portsc |= PORTSC_PED;
2651             pls = PLS_U0;
2652             break;
2653         }
2654     }
2655     set_field(&port->portsc, pls, PORTSC_PLS);
2656     trace_usb_xhci_port_link(port->portnr, pls);
2657     xhci_port_notify(port, PORTSC_CSC);
2658 }
2659 
2660 static void xhci_port_reset(XHCIPort *port, bool warm_reset)
2661 {
2662     trace_usb_xhci_port_reset(port->portnr, warm_reset);
2663 
2664     if (!xhci_port_have_device(port)) {
2665         return;
2666     }
2667 
2668     usb_device_reset(port->uport->dev);
2669 
2670     switch (port->uport->dev->speed) {
2671     case USB_SPEED_SUPER:
2672         if (warm_reset) {
2673             port->portsc |= PORTSC_WRC;
2674         }
2675         /* fall through */
2676     case USB_SPEED_LOW:
2677     case USB_SPEED_FULL:
2678     case USB_SPEED_HIGH:
2679         set_field(&port->portsc, PLS_U0, PORTSC_PLS);
2680         trace_usb_xhci_port_link(port->portnr, PLS_U0);
2681         port->portsc |= PORTSC_PED;
2682         break;
2683     }
2684 
2685     port->portsc &= ~PORTSC_PR;
2686     xhci_port_notify(port, PORTSC_PRC);
2687 }
2688 
2689 static void xhci_reset(DeviceState *dev)
2690 {
2691     XHCIState *xhci = XHCI(dev);
2692     int i;
2693 
2694     trace_usb_xhci_reset();
2695     if (!(xhci->usbsts & USBSTS_HCH)) {
2696         DPRINTF("xhci: reset while running!\n");
2697     }
2698 
2699     xhci->usbcmd = 0;
2700     xhci->usbsts = USBSTS_HCH;
2701     xhci->dnctrl = 0;
2702     xhci->crcr_low = 0;
2703     xhci->crcr_high = 0;
2704     xhci->dcbaap_low = 0;
2705     xhci->dcbaap_high = 0;
2706     xhci->config = 0;
2707 
2708     for (i = 0; i < xhci->numslots; i++) {
2709         xhci_disable_slot(xhci, i+1);
2710     }
2711 
2712     for (i = 0; i < xhci->numports; i++) {
2713         xhci_port_update(xhci->ports + i, 0);
2714     }
2715 
2716     for (i = 0; i < xhci->numintrs; i++) {
2717         xhci->intr[i].iman = 0;
2718         xhci->intr[i].imod = 0;
2719         xhci->intr[i].erstsz = 0;
2720         xhci->intr[i].erstba_low = 0;
2721         xhci->intr[i].erstba_high = 0;
2722         xhci->intr[i].erdp_low = 0;
2723         xhci->intr[i].erdp_high = 0;
2724         xhci->intr[i].msix_used = 0;
2725 
2726         xhci->intr[i].er_ep_idx = 0;
2727         xhci->intr[i].er_pcs = 1;
2728         xhci->intr[i].ev_buffer_put = 0;
2729         xhci->intr[i].ev_buffer_get = 0;
2730     }
2731 
2732     xhci->mfindex_start = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
2733     xhci_mfwrap_update(xhci);
2734 }
2735 
2736 static uint64_t xhci_cap_read(void *ptr, hwaddr reg, unsigned size)
2737 {
2738     XHCIState *xhci = ptr;
2739     uint32_t ret;
2740 
2741     switch (reg) {
2742     case 0x00: /* HCIVERSION, CAPLENGTH */
2743         ret = 0x01000000 | LEN_CAP;
2744         break;
2745     case 0x04: /* HCSPARAMS 1 */
2746         ret = ((xhci->numports_2+xhci->numports_3)<<24)
2747             | (xhci->numintrs<<8) | xhci->numslots;
2748         break;
2749     case 0x08: /* HCSPARAMS 2 */
2750         ret = 0x0000000f;
2751         break;
2752     case 0x0c: /* HCSPARAMS 3 */
2753         ret = 0x00000000;
2754         break;
2755     case 0x10: /* HCCPARAMS */
2756         if (sizeof(dma_addr_t) == 4) {
2757             ret = 0x00080000 | (xhci->max_pstreams_mask << 12);
2758         } else {
2759             ret = 0x00080001 | (xhci->max_pstreams_mask << 12);
2760         }
2761         break;
2762     case 0x14: /* DBOFF */
2763         ret = OFF_DOORBELL;
2764         break;
2765     case 0x18: /* RTSOFF */
2766         ret = OFF_RUNTIME;
2767         break;
2768 
2769     /* extended capabilities */
2770     case 0x20: /* Supported Protocol:00 */
2771         ret = 0x02000402; /* USB 2.0 */
2772         break;
2773     case 0x24: /* Supported Protocol:04 */
2774         ret = 0x20425355; /* "USB " */
2775         break;
2776     case 0x28: /* Supported Protocol:08 */
2777         if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
2778             ret = (xhci->numports_2<<8) | (xhci->numports_3+1);
2779         } else {
2780             ret = (xhci->numports_2<<8) | 1;
2781         }
2782         break;
2783     case 0x2c: /* Supported Protocol:0c */
2784         ret = 0x00000000; /* reserved */
2785         break;
2786     case 0x30: /* Supported Protocol:00 */
2787         ret = 0x03000002; /* USB 3.0 */
2788         break;
2789     case 0x34: /* Supported Protocol:04 */
2790         ret = 0x20425355; /* "USB " */
2791         break;
2792     case 0x38: /* Supported Protocol:08 */
2793         if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
2794             ret = (xhci->numports_3<<8) | 1;
2795         } else {
2796             ret = (xhci->numports_3<<8) | (xhci->numports_2+1);
2797         }
2798         break;
2799     case 0x3c: /* Supported Protocol:0c */
2800         ret = 0x00000000; /* reserved */
2801         break;
2802     default:
2803         trace_usb_xhci_unimplemented("cap read", reg);
2804         ret = 0;
2805     }
2806 
2807     trace_usb_xhci_cap_read(reg, ret);
2808     return ret;
2809 }
2810 
2811 static uint64_t xhci_port_read(void *ptr, hwaddr reg, unsigned size)
2812 {
2813     XHCIPort *port = ptr;
2814     uint32_t ret;
2815 
2816     switch (reg) {
2817     case 0x00: /* PORTSC */
2818         ret = port->portsc;
2819         break;
2820     case 0x04: /* PORTPMSC */
2821     case 0x08: /* PORTLI */
2822         ret = 0;
2823         break;
2824     case 0x0c: /* reserved */
2825     default:
2826         trace_usb_xhci_unimplemented("port read", reg);
2827         ret = 0;
2828     }
2829 
2830     trace_usb_xhci_port_read(port->portnr, reg, ret);
2831     return ret;
2832 }
2833 
2834 static void xhci_port_write(void *ptr, hwaddr reg,
2835                             uint64_t val, unsigned size)
2836 {
2837     XHCIPort *port = ptr;
2838     uint32_t portsc, notify;
2839 
2840     trace_usb_xhci_port_write(port->portnr, reg, val);
2841 
2842     switch (reg) {
2843     case 0x00: /* PORTSC */
2844         /* write-1-to-start bits */
2845         if (val & PORTSC_WPR) {
2846             xhci_port_reset(port, true);
2847             break;
2848         }
2849         if (val & PORTSC_PR) {
2850             xhci_port_reset(port, false);
2851             break;
2852         }
2853 
2854         portsc = port->portsc;
2855         notify = 0;
2856         /* write-1-to-clear bits*/
2857         portsc &= ~(val & (PORTSC_CSC|PORTSC_PEC|PORTSC_WRC|PORTSC_OCC|
2858                            PORTSC_PRC|PORTSC_PLC|PORTSC_CEC));
2859         if (val & PORTSC_LWS) {
2860             /* overwrite PLS only when LWS=1 */
2861             uint32_t old_pls = get_field(port->portsc, PORTSC_PLS);
2862             uint32_t new_pls = get_field(val, PORTSC_PLS);
2863             switch (new_pls) {
2864             case PLS_U0:
2865                 if (old_pls != PLS_U0) {
2866                     set_field(&portsc, new_pls, PORTSC_PLS);
2867                     trace_usb_xhci_port_link(port->portnr, new_pls);
2868                     notify = PORTSC_PLC;
2869                 }
2870                 break;
2871             case PLS_U3:
2872                 if (old_pls < PLS_U3) {
2873                     set_field(&portsc, new_pls, PORTSC_PLS);
2874                     trace_usb_xhci_port_link(port->portnr, new_pls);
2875                 }
2876                 break;
2877             case PLS_RESUME:
2878                 /* windows does this for some reason, don't spam stderr */
2879                 break;
2880             default:
2881                 DPRINTF("%s: ignore pls write (old %d, new %d)\n",
2882                         __func__, old_pls, new_pls);
2883                 break;
2884             }
2885         }
2886         /* read/write bits */
2887         portsc &= ~(PORTSC_PP|PORTSC_WCE|PORTSC_WDE|PORTSC_WOE);
2888         portsc |= (val & (PORTSC_PP|PORTSC_WCE|PORTSC_WDE|PORTSC_WOE));
2889         port->portsc = portsc;
2890         if (notify) {
2891             xhci_port_notify(port, notify);
2892         }
2893         break;
2894     case 0x04: /* PORTPMSC */
2895     case 0x08: /* PORTLI */
2896     default:
2897         trace_usb_xhci_unimplemented("port write", reg);
2898     }
2899 }
2900 
2901 static uint64_t xhci_oper_read(void *ptr, hwaddr reg, unsigned size)
2902 {
2903     XHCIState *xhci = ptr;
2904     uint32_t ret;
2905 
2906     switch (reg) {
2907     case 0x00: /* USBCMD */
2908         ret = xhci->usbcmd;
2909         break;
2910     case 0x04: /* USBSTS */
2911         ret = xhci->usbsts;
2912         break;
2913     case 0x08: /* PAGESIZE */
2914         ret = 1; /* 4KiB */
2915         break;
2916     case 0x14: /* DNCTRL */
2917         ret = xhci->dnctrl;
2918         break;
2919     case 0x18: /* CRCR low */
2920         ret = xhci->crcr_low & ~0xe;
2921         break;
2922     case 0x1c: /* CRCR high */
2923         ret = xhci->crcr_high;
2924         break;
2925     case 0x30: /* DCBAAP low */
2926         ret = xhci->dcbaap_low;
2927         break;
2928     case 0x34: /* DCBAAP high */
2929         ret = xhci->dcbaap_high;
2930         break;
2931     case 0x38: /* CONFIG */
2932         ret = xhci->config;
2933         break;
2934     default:
2935         trace_usb_xhci_unimplemented("oper read", reg);
2936         ret = 0;
2937     }
2938 
2939     trace_usb_xhci_oper_read(reg, ret);
2940     return ret;
2941 }
2942 
2943 static void xhci_oper_write(void *ptr, hwaddr reg,
2944                             uint64_t val, unsigned size)
2945 {
2946     XHCIState *xhci = ptr;
2947     DeviceState *d = DEVICE(ptr);
2948 
2949     trace_usb_xhci_oper_write(reg, val);
2950 
2951     switch (reg) {
2952     case 0x00: /* USBCMD */
2953         if ((val & USBCMD_RS) && !(xhci->usbcmd & USBCMD_RS)) {
2954             xhci_run(xhci);
2955         } else if (!(val & USBCMD_RS) && (xhci->usbcmd & USBCMD_RS)) {
2956             xhci_stop(xhci);
2957         }
2958         if (val & USBCMD_CSS) {
2959             /* save state */
2960             xhci->usbsts &= ~USBSTS_SRE;
2961         }
2962         if (val & USBCMD_CRS) {
2963             /* restore state */
2964             xhci->usbsts |= USBSTS_SRE;
2965         }
2966         xhci->usbcmd = val & 0xc0f;
2967         xhci_mfwrap_update(xhci);
2968         if (val & USBCMD_HCRST) {
2969             xhci_reset(d);
2970         }
2971         xhci_intx_update(xhci);
2972         break;
2973 
2974     case 0x04: /* USBSTS */
2975         /* these bits are write-1-to-clear */
2976         xhci->usbsts &= ~(val & (USBSTS_HSE|USBSTS_EINT|USBSTS_PCD|USBSTS_SRE));
2977         xhci_intx_update(xhci);
2978         break;
2979 
2980     case 0x14: /* DNCTRL */
2981         xhci->dnctrl = val & 0xffff;
2982         break;
2983     case 0x18: /* CRCR low */
2984         xhci->crcr_low = (val & 0xffffffcf) | (xhci->crcr_low & CRCR_CRR);
2985         break;
2986     case 0x1c: /* CRCR high */
2987         xhci->crcr_high = val;
2988         if (xhci->crcr_low & (CRCR_CA|CRCR_CS) && (xhci->crcr_low & CRCR_CRR)) {
2989             XHCIEvent event = {ER_COMMAND_COMPLETE, CC_COMMAND_RING_STOPPED};
2990             xhci->crcr_low &= ~CRCR_CRR;
2991             xhci_event(xhci, &event, 0);
2992             DPRINTF("xhci: command ring stopped (CRCR=%08x)\n", xhci->crcr_low);
2993         } else {
2994             dma_addr_t base = xhci_addr64(xhci->crcr_low & ~0x3f, val);
2995             xhci_ring_init(xhci, &xhci->cmd_ring, base);
2996         }
2997         xhci->crcr_low &= ~(CRCR_CA | CRCR_CS);
2998         break;
2999     case 0x30: /* DCBAAP low */
3000         xhci->dcbaap_low = val & 0xffffffc0;
3001         break;
3002     case 0x34: /* DCBAAP high */
3003         xhci->dcbaap_high = val;
3004         break;
3005     case 0x38: /* CONFIG */
3006         xhci->config = val & 0xff;
3007         break;
3008     default:
3009         trace_usb_xhci_unimplemented("oper write", reg);
3010     }
3011 }
3012 
3013 static uint64_t xhci_runtime_read(void *ptr, hwaddr reg,
3014                                   unsigned size)
3015 {
3016     XHCIState *xhci = ptr;
3017     uint32_t ret = 0;
3018 
3019     if (reg < 0x20) {
3020         switch (reg) {
3021         case 0x00: /* MFINDEX */
3022             ret = xhci_mfindex_get(xhci) & 0x3fff;
3023             break;
3024         default:
3025             trace_usb_xhci_unimplemented("runtime read", reg);
3026             break;
3027         }
3028     } else {
3029         int v = (reg - 0x20) / 0x20;
3030         XHCIInterrupter *intr = &xhci->intr[v];
3031         switch (reg & 0x1f) {
3032         case 0x00: /* IMAN */
3033             ret = intr->iman;
3034             break;
3035         case 0x04: /* IMOD */
3036             ret = intr->imod;
3037             break;
3038         case 0x08: /* ERSTSZ */
3039             ret = intr->erstsz;
3040             break;
3041         case 0x10: /* ERSTBA low */
3042             ret = intr->erstba_low;
3043             break;
3044         case 0x14: /* ERSTBA high */
3045             ret = intr->erstba_high;
3046             break;
3047         case 0x18: /* ERDP low */
3048             ret = intr->erdp_low;
3049             break;
3050         case 0x1c: /* ERDP high */
3051             ret = intr->erdp_high;
3052             break;
3053         }
3054     }
3055 
3056     trace_usb_xhci_runtime_read(reg, ret);
3057     return ret;
3058 }
3059 
3060 static void xhci_runtime_write(void *ptr, hwaddr reg,
3061                                uint64_t val, unsigned size)
3062 {
3063     XHCIState *xhci = ptr;
3064     int v = (reg - 0x20) / 0x20;
3065     XHCIInterrupter *intr = &xhci->intr[v];
3066     trace_usb_xhci_runtime_write(reg, val);
3067 
3068     if (reg < 0x20) {
3069         trace_usb_xhci_unimplemented("runtime write", reg);
3070         return;
3071     }
3072 
3073     switch (reg & 0x1f) {
3074     case 0x00: /* IMAN */
3075         if (val & IMAN_IP) {
3076             intr->iman &= ~IMAN_IP;
3077         }
3078         intr->iman &= ~IMAN_IE;
3079         intr->iman |= val & IMAN_IE;
3080         if (v == 0) {
3081             xhci_intx_update(xhci);
3082         }
3083         xhci_msix_update(xhci, v);
3084         break;
3085     case 0x04: /* IMOD */
3086         intr->imod = val;
3087         break;
3088     case 0x08: /* ERSTSZ */
3089         intr->erstsz = val & 0xffff;
3090         break;
3091     case 0x10: /* ERSTBA low */
3092         if (xhci->nec_quirks) {
3093             /* NEC driver bug: it doesn't align this to 64 bytes */
3094             intr->erstba_low = val & 0xfffffff0;
3095         } else {
3096             intr->erstba_low = val & 0xffffffc0;
3097         }
3098         break;
3099     case 0x14: /* ERSTBA high */
3100         intr->erstba_high = val;
3101         xhci_er_reset(xhci, v);
3102         break;
3103     case 0x18: /* ERDP low */
3104         if (val & ERDP_EHB) {
3105             intr->erdp_low &= ~ERDP_EHB;
3106         }
3107         intr->erdp_low = (val & ~ERDP_EHB) | (intr->erdp_low & ERDP_EHB);
3108         if (val & ERDP_EHB) {
3109             dma_addr_t erdp = xhci_addr64(intr->erdp_low, intr->erdp_high);
3110             unsigned int dp_idx = (erdp - intr->er_start) / TRB_SIZE;
3111             if (erdp >= intr->er_start &&
3112                 erdp < (intr->er_start + TRB_SIZE * intr->er_size) &&
3113                 dp_idx != intr->er_ep_idx) {
3114                 xhci_intr_raise(xhci, v);
3115             }
3116         }
3117         break;
3118     case 0x1c: /* ERDP high */
3119         intr->erdp_high = val;
3120         break;
3121     default:
3122         trace_usb_xhci_unimplemented("oper write", reg);
3123     }
3124 }
3125 
3126 static uint64_t xhci_doorbell_read(void *ptr, hwaddr reg,
3127                                    unsigned size)
3128 {
3129     /* doorbells always read as 0 */
3130     trace_usb_xhci_doorbell_read(reg, 0);
3131     return 0;
3132 }
3133 
3134 static void xhci_doorbell_write(void *ptr, hwaddr reg,
3135                                 uint64_t val, unsigned size)
3136 {
3137     XHCIState *xhci = ptr;
3138     unsigned int epid, streamid;
3139 
3140     trace_usb_xhci_doorbell_write(reg, val);
3141 
3142     if (!xhci_running(xhci)) {
3143         DPRINTF("xhci: wrote doorbell while xHC stopped or paused\n");
3144         return;
3145     }
3146 
3147     reg >>= 2;
3148 
3149     if (reg == 0) {
3150         if (val == 0) {
3151             xhci_process_commands(xhci);
3152         } else {
3153             DPRINTF("xhci: bad doorbell 0 write: 0x%x\n",
3154                     (uint32_t)val);
3155         }
3156     } else {
3157         epid = val & 0xff;
3158         streamid = (val >> 16) & 0xffff;
3159         if (reg > xhci->numslots) {
3160             DPRINTF("xhci: bad doorbell %d\n", (int)reg);
3161         } else if (epid == 0 || epid > 31) {
3162             DPRINTF("xhci: bad doorbell %d write: 0x%x\n",
3163                     (int)reg, (uint32_t)val);
3164         } else {
3165             xhci_kick_ep(xhci, reg, epid, streamid);
3166         }
3167     }
3168 }
3169 
3170 static void xhci_cap_write(void *opaque, hwaddr addr, uint64_t val,
3171                            unsigned width)
3172 {
3173     /* nothing */
3174 }
3175 
3176 static const MemoryRegionOps xhci_cap_ops = {
3177     .read = xhci_cap_read,
3178     .write = xhci_cap_write,
3179     .valid.min_access_size = 1,
3180     .valid.max_access_size = 4,
3181     .impl.min_access_size = 4,
3182     .impl.max_access_size = 4,
3183     .endianness = DEVICE_LITTLE_ENDIAN,
3184 };
3185 
3186 static const MemoryRegionOps xhci_oper_ops = {
3187     .read = xhci_oper_read,
3188     .write = xhci_oper_write,
3189     .valid.min_access_size = 4,
3190     .valid.max_access_size = sizeof(dma_addr_t),
3191     .endianness = DEVICE_LITTLE_ENDIAN,
3192 };
3193 
3194 static const MemoryRegionOps xhci_port_ops = {
3195     .read = xhci_port_read,
3196     .write = xhci_port_write,
3197     .valid.min_access_size = 4,
3198     .valid.max_access_size = 4,
3199     .endianness = DEVICE_LITTLE_ENDIAN,
3200 };
3201 
3202 static const MemoryRegionOps xhci_runtime_ops = {
3203     .read = xhci_runtime_read,
3204     .write = xhci_runtime_write,
3205     .valid.min_access_size = 4,
3206     .valid.max_access_size = sizeof(dma_addr_t),
3207     .endianness = DEVICE_LITTLE_ENDIAN,
3208 };
3209 
3210 static const MemoryRegionOps xhci_doorbell_ops = {
3211     .read = xhci_doorbell_read,
3212     .write = xhci_doorbell_write,
3213     .valid.min_access_size = 4,
3214     .valid.max_access_size = 4,
3215     .endianness = DEVICE_LITTLE_ENDIAN,
3216 };
3217 
3218 static void xhci_attach(USBPort *usbport)
3219 {
3220     XHCIState *xhci = usbport->opaque;
3221     XHCIPort *port = xhci_lookup_port(xhci, usbport);
3222 
3223     xhci_port_update(port, 0);
3224 }
3225 
3226 static void xhci_detach(USBPort *usbport)
3227 {
3228     XHCIState *xhci = usbport->opaque;
3229     XHCIPort *port = xhci_lookup_port(xhci, usbport);
3230 
3231     xhci_detach_slot(xhci, usbport);
3232     xhci_port_update(port, 1);
3233 }
3234 
3235 static void xhci_wakeup(USBPort *usbport)
3236 {
3237     XHCIState *xhci = usbport->opaque;
3238     XHCIPort *port = xhci_lookup_port(xhci, usbport);
3239 
3240     assert(port);
3241     if (get_field(port->portsc, PORTSC_PLS) != PLS_U3) {
3242         return;
3243     }
3244     set_field(&port->portsc, PLS_RESUME, PORTSC_PLS);
3245     xhci_port_notify(port, PORTSC_PLC);
3246 }
3247 
3248 static void xhci_complete(USBPort *port, USBPacket *packet)
3249 {
3250     XHCITransfer *xfer = container_of(packet, XHCITransfer, packet);
3251 
3252     if (packet->status == USB_RET_REMOVE_FROM_QUEUE) {
3253         xhci_ep_nuke_one_xfer(xfer, 0);
3254         return;
3255     }
3256     xhci_try_complete_packet(xfer);
3257     xhci_kick_epctx(xfer->epctx, xfer->streamid);
3258     if (xfer->complete) {
3259         xhci_ep_free_xfer(xfer);
3260     }
3261 }
3262 
3263 static void xhci_child_detach(USBPort *uport, USBDevice *child)
3264 {
3265     USBBus *bus = usb_bus_from_device(child);
3266     XHCIState *xhci = container_of(bus, XHCIState, bus);
3267 
3268     xhci_detach_slot(xhci, child->port);
3269 }
3270 
3271 static USBPortOps xhci_uport_ops = {
3272     .attach   = xhci_attach,
3273     .detach   = xhci_detach,
3274     .wakeup   = xhci_wakeup,
3275     .complete = xhci_complete,
3276     .child_detach = xhci_child_detach,
3277 };
3278 
3279 static int xhci_find_epid(USBEndpoint *ep)
3280 {
3281     if (ep->nr == 0) {
3282         return 1;
3283     }
3284     if (ep->pid == USB_TOKEN_IN) {
3285         return ep->nr * 2 + 1;
3286     } else {
3287         return ep->nr * 2;
3288     }
3289 }
3290 
3291 static USBEndpoint *xhci_epid_to_usbep(XHCIEPContext *epctx)
3292 {
3293     USBPort *uport;
3294     uint32_t token;
3295 
3296     if (!epctx) {
3297         return NULL;
3298     }
3299     uport = epctx->xhci->slots[epctx->slotid - 1].uport;
3300     if (!uport || !uport->dev) {
3301         return NULL;
3302     }
3303     token = (epctx->epid & 1) ? USB_TOKEN_IN : USB_TOKEN_OUT;
3304     return usb_ep_get(uport->dev, token, epctx->epid >> 1);
3305 }
3306 
3307 static void xhci_wakeup_endpoint(USBBus *bus, USBEndpoint *ep,
3308                                  unsigned int stream)
3309 {
3310     XHCIState *xhci = container_of(bus, XHCIState, bus);
3311     int slotid;
3312 
3313     DPRINTF("%s\n", __func__);
3314     slotid = ep->dev->addr;
3315     if (slotid == 0 || !xhci->slots[slotid-1].enabled) {
3316         DPRINTF("%s: oops, no slot for dev %d\n", __func__, ep->dev->addr);
3317         return;
3318     }
3319     xhci_kick_ep(xhci, slotid, xhci_find_epid(ep), stream);
3320 }
3321 
3322 static USBBusOps xhci_bus_ops = {
3323     .wakeup_endpoint = xhci_wakeup_endpoint,
3324 };
3325 
3326 static void usb_xhci_init(XHCIState *xhci)
3327 {
3328     DeviceState *dev = DEVICE(xhci);
3329     XHCIPort *port;
3330     unsigned int i, usbports, speedmask;
3331 
3332     xhci->usbsts = USBSTS_HCH;
3333 
3334     if (xhci->numports_2 > MAXPORTS_2) {
3335         xhci->numports_2 = MAXPORTS_2;
3336     }
3337     if (xhci->numports_3 > MAXPORTS_3) {
3338         xhci->numports_3 = MAXPORTS_3;
3339     }
3340     usbports = MAX(xhci->numports_2, xhci->numports_3);
3341     xhci->numports = xhci->numports_2 + xhci->numports_3;
3342 
3343     usb_bus_new(&xhci->bus, sizeof(xhci->bus), &xhci_bus_ops, dev);
3344 
3345     for (i = 0; i < usbports; i++) {
3346         speedmask = 0;
3347         if (i < xhci->numports_2) {
3348             if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
3349                 port = &xhci->ports[i + xhci->numports_3];
3350                 port->portnr = i + 1 + xhci->numports_3;
3351             } else {
3352                 port = &xhci->ports[i];
3353                 port->portnr = i + 1;
3354             }
3355             port->uport = &xhci->uports[i];
3356             port->speedmask =
3357                 USB_SPEED_MASK_LOW  |
3358                 USB_SPEED_MASK_FULL |
3359                 USB_SPEED_MASK_HIGH;
3360             assert(i < MAXPORTS);
3361             snprintf(port->name, sizeof(port->name), "usb2 port #%d", i+1);
3362             speedmask |= port->speedmask;
3363         }
3364         if (i < xhci->numports_3) {
3365             if (xhci_get_flag(xhci, XHCI_FLAG_SS_FIRST)) {
3366                 port = &xhci->ports[i];
3367                 port->portnr = i + 1;
3368             } else {
3369                 port = &xhci->ports[i + xhci->numports_2];
3370                 port->portnr = i + 1 + xhci->numports_2;
3371             }
3372             port->uport = &xhci->uports[i];
3373             port->speedmask = USB_SPEED_MASK_SUPER;
3374             assert(i < MAXPORTS);
3375             snprintf(port->name, sizeof(port->name), "usb3 port #%d", i+1);
3376             speedmask |= port->speedmask;
3377         }
3378         usb_register_port(&xhci->bus, &xhci->uports[i], xhci, i,
3379                           &xhci_uport_ops, speedmask);
3380     }
3381 }
3382 
3383 static void usb_xhci_realize(struct PCIDevice *dev, Error **errp)
3384 {
3385     int i, ret;
3386     Error *err = NULL;
3387 
3388     XHCIState *xhci = XHCI(dev);
3389 
3390     dev->config[PCI_CLASS_PROG] = 0x30;    /* xHCI */
3391     dev->config[PCI_INTERRUPT_PIN] = 0x01; /* interrupt pin 1 */
3392     dev->config[PCI_CACHE_LINE_SIZE] = 0x10;
3393     dev->config[0x60] = 0x30; /* release number */
3394 
3395     if (strcmp(object_get_typename(OBJECT(dev)), TYPE_NEC_XHCI) == 0) {
3396         xhci->nec_quirks = true;
3397     }
3398     if (xhci->numintrs > MAXINTRS) {
3399         xhci->numintrs = MAXINTRS;
3400     }
3401     while (xhci->numintrs & (xhci->numintrs - 1)) {   /* ! power of 2 */
3402         xhci->numintrs++;
3403     }
3404     if (xhci->numintrs < 1) {
3405         xhci->numintrs = 1;
3406     }
3407     if (xhci->numslots > MAXSLOTS) {
3408         xhci->numslots = MAXSLOTS;
3409     }
3410     if (xhci->numslots < 1) {
3411         xhci->numslots = 1;
3412     }
3413     if (xhci_get_flag(xhci, XHCI_FLAG_ENABLE_STREAMS)) {
3414         xhci->max_pstreams_mask = 7; /* == 256 primary streams */
3415     } else {
3416         xhci->max_pstreams_mask = 0;
3417     }
3418 
3419     if (xhci->msi != ON_OFF_AUTO_OFF) {
3420         ret = msi_init(dev, 0x70, xhci->numintrs, true, false, &err);
3421         /* Any error other than -ENOTSUP(board's MSI support is broken)
3422          * is a programming error */
3423         assert(!ret || ret == -ENOTSUP);
3424         if (ret && xhci->msi == ON_OFF_AUTO_ON) {
3425             /* Can't satisfy user's explicit msi=on request, fail */
3426             error_append_hint(&err, "You have to use msi=auto (default) or "
3427                     "msi=off with this machine type.\n");
3428             error_propagate(errp, err);
3429             return;
3430         }
3431         assert(!err || xhci->msi == ON_OFF_AUTO_AUTO);
3432         /* With msi=auto, we fall back to MSI off silently */
3433         error_free(err);
3434     }
3435 
3436     usb_xhci_init(xhci);
3437     xhci->mfwrap_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, xhci_mfwrap_timer, xhci);
3438 
3439     memory_region_init(&xhci->mem, OBJECT(xhci), "xhci", LEN_REGS);
3440     memory_region_init_io(&xhci->mem_cap, OBJECT(xhci), &xhci_cap_ops, xhci,
3441                           "capabilities", LEN_CAP);
3442     memory_region_init_io(&xhci->mem_oper, OBJECT(xhci), &xhci_oper_ops, xhci,
3443                           "operational", 0x400);
3444     memory_region_init_io(&xhci->mem_runtime, OBJECT(xhci), &xhci_runtime_ops, xhci,
3445                           "runtime", LEN_RUNTIME);
3446     memory_region_init_io(&xhci->mem_doorbell, OBJECT(xhci), &xhci_doorbell_ops, xhci,
3447                           "doorbell", LEN_DOORBELL);
3448 
3449     memory_region_add_subregion(&xhci->mem, 0,            &xhci->mem_cap);
3450     memory_region_add_subregion(&xhci->mem, OFF_OPER,     &xhci->mem_oper);
3451     memory_region_add_subregion(&xhci->mem, OFF_RUNTIME,  &xhci->mem_runtime);
3452     memory_region_add_subregion(&xhci->mem, OFF_DOORBELL, &xhci->mem_doorbell);
3453 
3454     for (i = 0; i < xhci->numports; i++) {
3455         XHCIPort *port = &xhci->ports[i];
3456         uint32_t offset = OFF_OPER + 0x400 + 0x10 * i;
3457         port->xhci = xhci;
3458         memory_region_init_io(&port->mem, OBJECT(xhci), &xhci_port_ops, port,
3459                               port->name, 0x10);
3460         memory_region_add_subregion(&xhci->mem, offset, &port->mem);
3461     }
3462 
3463     pci_register_bar(dev, 0,
3464                      PCI_BASE_ADDRESS_SPACE_MEMORY|PCI_BASE_ADDRESS_MEM_TYPE_64,
3465                      &xhci->mem);
3466 
3467     if (pci_bus_is_express(pci_get_bus(dev)) ||
3468         xhci_get_flag(xhci, XHCI_FLAG_FORCE_PCIE_ENDCAP)) {
3469         ret = pcie_endpoint_cap_init(dev, 0xa0);
3470         assert(ret > 0);
3471     }
3472 
3473     if (xhci->msix != ON_OFF_AUTO_OFF) {
3474         /* TODO check for errors, and should fail when msix=on */
3475         msix_init(dev, xhci->numintrs,
3476                   &xhci->mem, 0, OFF_MSIX_TABLE,
3477                   &xhci->mem, 0, OFF_MSIX_PBA,
3478                   0x90, NULL);
3479     }
3480 }
3481 
3482 static void usb_xhci_exit(PCIDevice *dev)
3483 {
3484     int i;
3485     XHCIState *xhci = XHCI(dev);
3486 
3487     trace_usb_xhci_exit();
3488 
3489     for (i = 0; i < xhci->numslots; i++) {
3490         xhci_disable_slot(xhci, i + 1);
3491     }
3492 
3493     if (xhci->mfwrap_timer) {
3494         timer_del(xhci->mfwrap_timer);
3495         timer_free(xhci->mfwrap_timer);
3496         xhci->mfwrap_timer = NULL;
3497     }
3498 
3499     memory_region_del_subregion(&xhci->mem, &xhci->mem_cap);
3500     memory_region_del_subregion(&xhci->mem, &xhci->mem_oper);
3501     memory_region_del_subregion(&xhci->mem, &xhci->mem_runtime);
3502     memory_region_del_subregion(&xhci->mem, &xhci->mem_doorbell);
3503 
3504     for (i = 0; i < xhci->numports; i++) {
3505         XHCIPort *port = &xhci->ports[i];
3506         memory_region_del_subregion(&xhci->mem, &port->mem);
3507     }
3508 
3509     /* destroy msix memory region */
3510     if (dev->msix_table && dev->msix_pba
3511         && dev->msix_entry_used) {
3512         msix_uninit(dev, &xhci->mem, &xhci->mem);
3513     }
3514 
3515     usb_bus_release(&xhci->bus);
3516 }
3517 
3518 static int usb_xhci_post_load(void *opaque, int version_id)
3519 {
3520     XHCIState *xhci = opaque;
3521     PCIDevice *pci_dev = PCI_DEVICE(xhci);
3522     XHCISlot *slot;
3523     XHCIEPContext *epctx;
3524     dma_addr_t dcbaap, pctx;
3525     uint32_t slot_ctx[4];
3526     uint32_t ep_ctx[5];
3527     int slotid, epid, state, intr;
3528 
3529     dcbaap = xhci_addr64(xhci->dcbaap_low, xhci->dcbaap_high);
3530 
3531     for (slotid = 1; slotid <= xhci->numslots; slotid++) {
3532         slot = &xhci->slots[slotid-1];
3533         if (!slot->addressed) {
3534             continue;
3535         }
3536         slot->ctx =
3537             xhci_mask64(ldq_le_pci_dma(pci_dev, dcbaap + 8 * slotid));
3538         xhci_dma_read_u32s(xhci, slot->ctx, slot_ctx, sizeof(slot_ctx));
3539         slot->uport = xhci_lookup_uport(xhci, slot_ctx);
3540         if (!slot->uport) {
3541             /* should not happen, but may trigger on guest bugs */
3542             slot->enabled = 0;
3543             slot->addressed = 0;
3544             continue;
3545         }
3546         assert(slot->uport && slot->uport->dev);
3547 
3548         for (epid = 1; epid <= 31; epid++) {
3549             pctx = slot->ctx + 32 * epid;
3550             xhci_dma_read_u32s(xhci, pctx, ep_ctx, sizeof(ep_ctx));
3551             state = ep_ctx[0] & EP_STATE_MASK;
3552             if (state == EP_DISABLED) {
3553                 continue;
3554             }
3555             epctx = xhci_alloc_epctx(xhci, slotid, epid);
3556             slot->eps[epid-1] = epctx;
3557             xhci_init_epctx(epctx, pctx, ep_ctx);
3558             epctx->state = state;
3559             if (state == EP_RUNNING) {
3560                 /* kick endpoint after vmload is finished */
3561                 timer_mod(epctx->kick_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL));
3562             }
3563         }
3564     }
3565 
3566     for (intr = 0; intr < xhci->numintrs; intr++) {
3567         if (xhci->intr[intr].msix_used) {
3568             msix_vector_use(pci_dev, intr);
3569         } else {
3570             msix_vector_unuse(pci_dev, intr);
3571         }
3572     }
3573 
3574     return 0;
3575 }
3576 
3577 static const VMStateDescription vmstate_xhci_ring = {
3578     .name = "xhci-ring",
3579     .version_id = 1,
3580     .fields = (VMStateField[]) {
3581         VMSTATE_UINT64(dequeue, XHCIRing),
3582         VMSTATE_BOOL(ccs, XHCIRing),
3583         VMSTATE_END_OF_LIST()
3584     }
3585 };
3586 
3587 static const VMStateDescription vmstate_xhci_port = {
3588     .name = "xhci-port",
3589     .version_id = 1,
3590     .fields = (VMStateField[]) {
3591         VMSTATE_UINT32(portsc, XHCIPort),
3592         VMSTATE_END_OF_LIST()
3593     }
3594 };
3595 
3596 static const VMStateDescription vmstate_xhci_slot = {
3597     .name = "xhci-slot",
3598     .version_id = 1,
3599     .fields = (VMStateField[]) {
3600         VMSTATE_BOOL(enabled,   XHCISlot),
3601         VMSTATE_BOOL(addressed, XHCISlot),
3602         VMSTATE_END_OF_LIST()
3603     }
3604 };
3605 
3606 static const VMStateDescription vmstate_xhci_event = {
3607     .name = "xhci-event",
3608     .version_id = 1,
3609     .fields = (VMStateField[]) {
3610         VMSTATE_UINT32(type,   XHCIEvent),
3611         VMSTATE_UINT32(ccode,  XHCIEvent),
3612         VMSTATE_UINT64(ptr,    XHCIEvent),
3613         VMSTATE_UINT32(length, XHCIEvent),
3614         VMSTATE_UINT32(flags,  XHCIEvent),
3615         VMSTATE_UINT8(slotid,  XHCIEvent),
3616         VMSTATE_UINT8(epid,    XHCIEvent),
3617         VMSTATE_END_OF_LIST()
3618     }
3619 };
3620 
3621 static bool xhci_er_full(void *opaque, int version_id)
3622 {
3623     return false;
3624 }
3625 
3626 static const VMStateDescription vmstate_xhci_intr = {
3627     .name = "xhci-intr",
3628     .version_id = 1,
3629     .fields = (VMStateField[]) {
3630         /* registers */
3631         VMSTATE_UINT32(iman,          XHCIInterrupter),
3632         VMSTATE_UINT32(imod,          XHCIInterrupter),
3633         VMSTATE_UINT32(erstsz,        XHCIInterrupter),
3634         VMSTATE_UINT32(erstba_low,    XHCIInterrupter),
3635         VMSTATE_UINT32(erstba_high,   XHCIInterrupter),
3636         VMSTATE_UINT32(erdp_low,      XHCIInterrupter),
3637         VMSTATE_UINT32(erdp_high,     XHCIInterrupter),
3638 
3639         /* state */
3640         VMSTATE_BOOL(msix_used,       XHCIInterrupter),
3641         VMSTATE_BOOL(er_pcs,          XHCIInterrupter),
3642         VMSTATE_UINT64(er_start,      XHCIInterrupter),
3643         VMSTATE_UINT32(er_size,       XHCIInterrupter),
3644         VMSTATE_UINT32(er_ep_idx,     XHCIInterrupter),
3645 
3646         /* event queue (used if ring is full) */
3647         VMSTATE_BOOL(er_full_unused,  XHCIInterrupter),
3648         VMSTATE_UINT32_TEST(ev_buffer_put, XHCIInterrupter, xhci_er_full),
3649         VMSTATE_UINT32_TEST(ev_buffer_get, XHCIInterrupter, xhci_er_full),
3650         VMSTATE_STRUCT_ARRAY_TEST(ev_buffer, XHCIInterrupter, EV_QUEUE,
3651                                   xhci_er_full, 1,
3652                                   vmstate_xhci_event, XHCIEvent),
3653 
3654         VMSTATE_END_OF_LIST()
3655     }
3656 };
3657 
3658 static const VMStateDescription vmstate_xhci = {
3659     .name = "xhci",
3660     .version_id = 1,
3661     .post_load = usb_xhci_post_load,
3662     .fields = (VMStateField[]) {
3663         VMSTATE_PCI_DEVICE(parent_obj, XHCIState),
3664         VMSTATE_MSIX(parent_obj, XHCIState),
3665 
3666         VMSTATE_STRUCT_VARRAY_UINT32(ports, XHCIState, numports, 1,
3667                                      vmstate_xhci_port, XHCIPort),
3668         VMSTATE_STRUCT_VARRAY_UINT32(slots, XHCIState, numslots, 1,
3669                                      vmstate_xhci_slot, XHCISlot),
3670         VMSTATE_STRUCT_VARRAY_UINT32(intr, XHCIState, numintrs, 1,
3671                                      vmstate_xhci_intr, XHCIInterrupter),
3672 
3673         /* Operational Registers */
3674         VMSTATE_UINT32(usbcmd,        XHCIState),
3675         VMSTATE_UINT32(usbsts,        XHCIState),
3676         VMSTATE_UINT32(dnctrl,        XHCIState),
3677         VMSTATE_UINT32(crcr_low,      XHCIState),
3678         VMSTATE_UINT32(crcr_high,     XHCIState),
3679         VMSTATE_UINT32(dcbaap_low,    XHCIState),
3680         VMSTATE_UINT32(dcbaap_high,   XHCIState),
3681         VMSTATE_UINT32(config,        XHCIState),
3682 
3683         /* Runtime Registers & state */
3684         VMSTATE_INT64(mfindex_start,  XHCIState),
3685         VMSTATE_TIMER_PTR(mfwrap_timer,   XHCIState),
3686         VMSTATE_STRUCT(cmd_ring, XHCIState, 1, vmstate_xhci_ring, XHCIRing),
3687 
3688         VMSTATE_END_OF_LIST()
3689     }
3690 };
3691 
3692 static Property xhci_properties[] = {
3693     DEFINE_PROP_BIT("streams", XHCIState, flags,
3694                     XHCI_FLAG_ENABLE_STREAMS, true),
3695     DEFINE_PROP_UINT32("p2",    XHCIState, numports_2, 4),
3696     DEFINE_PROP_UINT32("p3",    XHCIState, numports_3, 4),
3697     DEFINE_PROP_END_OF_LIST(),
3698 };
3699 
3700 static void xhci_instance_init(Object *obj)
3701 {
3702     /* QEMU_PCI_CAP_EXPRESS initialization does not depend on QEMU command
3703      * line, therefore, no need to wait to realize like other devices */
3704     PCI_DEVICE(obj)->cap_present |= QEMU_PCI_CAP_EXPRESS;
3705 }
3706 
3707 static void xhci_class_init(ObjectClass *klass, void *data)
3708 {
3709     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
3710     DeviceClass *dc = DEVICE_CLASS(klass);
3711 
3712     dc->vmsd    = &vmstate_xhci;
3713     device_class_set_props(dc, xhci_properties);
3714     dc->reset   = xhci_reset;
3715     set_bit(DEVICE_CATEGORY_USB, dc->categories);
3716     k->realize      = usb_xhci_realize;
3717     k->exit         = usb_xhci_exit;
3718     k->class_id     = PCI_CLASS_SERIAL_USB;
3719 }
3720 
3721 static const TypeInfo xhci_info = {
3722     .name          = TYPE_XHCI,
3723     .parent        = TYPE_PCI_DEVICE,
3724     .instance_size = sizeof(XHCIState),
3725     .class_init    = xhci_class_init,
3726     .instance_init = xhci_instance_init,
3727     .abstract      = true,
3728     .interfaces = (InterfaceInfo[]) {
3729         { INTERFACE_PCIE_DEVICE },
3730         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
3731         { }
3732     },
3733 };
3734 
3735 static void qemu_xhci_class_init(ObjectClass *klass, void *data)
3736 {
3737     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
3738 
3739     k->vendor_id    = PCI_VENDOR_ID_REDHAT;
3740     k->device_id    = PCI_DEVICE_ID_REDHAT_XHCI;
3741     k->revision     = 0x01;
3742 }
3743 
3744 static void qemu_xhci_instance_init(Object *obj)
3745 {
3746     XHCIState *xhci = XHCI(obj);
3747 
3748     xhci->msi      = ON_OFF_AUTO_OFF;
3749     xhci->msix     = ON_OFF_AUTO_AUTO;
3750     xhci->numintrs = MAXINTRS;
3751     xhci->numslots = MAXSLOTS;
3752     xhci_set_flag(xhci, XHCI_FLAG_SS_FIRST);
3753 }
3754 
3755 static const TypeInfo qemu_xhci_info = {
3756     .name          = TYPE_QEMU_XHCI,
3757     .parent        = TYPE_XHCI,
3758     .class_init    = qemu_xhci_class_init,
3759     .instance_init = qemu_xhci_instance_init,
3760 };
3761 
3762 static void xhci_register_types(void)
3763 {
3764     type_register_static(&xhci_info);
3765     type_register_static(&qemu_xhci_info);
3766 }
3767 
3768 type_init(xhci_register_types)
3769