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