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