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