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