2 * USB xHCI controller emulation
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
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.
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.
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/>.
22 #ifndef HW_USB_HCD_XHCI_H
23 #define HW_USB_HCD_XHCI_H
24 #include "qom/object.h"
26 #define TYPE_XHCI "base-xhci"
27 #define TYPE_NEC_XHCI "nec-usb-xhci"
28 #define TYPE_QEMU_XHCI "qemu-xhci"
30 typedef struct XHCIState XHCIState
;
31 DECLARE_INSTANCE_CHECKER(XHCIState
, XHCI
,
37 #define MAXPORTS (MAXPORTS_2 + MAXPORTS_3)
41 /* Very pessimistic, let's hope it's enough for all cases */
42 #define EV_QUEUE (((3 * 24) + 16) * MAXSLOTS)
44 typedef struct XHCIStreamContext XHCIStreamContext
;
45 typedef struct XHCIEPContext XHCIEPContext
;
48 XHCI_FLAG_SS_FIRST
= 1,
49 XHCI_FLAG_FORCE_PCIE_ENDCAP
,
50 XHCI_FLAG_ENABLE_STREAMS
,
53 typedef enum TRBType
{
66 CR_CONFIGURE_ENDPOINT
,
74 CR_SET_LATENCY_TOLERANCE
,
75 CR_GET_PORT_BANDWIDTH
,
80 ER_PORT_STATUS_CHANGE
,
84 ER_DEVICE_NOTIFICATION
,
86 /* vendor specific bits */
87 CR_VENDOR_NEC_FIRMWARE_REVISION
= 49,
88 CR_VENDOR_NEC_CHALLENGE_RESPONSE
= 50,
91 typedef enum TRBCCode
{
96 CC_USB_TRANSACTION_ERROR
,
102 CC_INVALID_STREAM_TYPE_ERROR
,
103 CC_SLOT_NOT_ENABLED_ERROR
,
104 CC_EP_NOT_ENABLED_ERROR
,
110 CC_BANDWIDTH_OVERRUN
,
111 CC_CONTEXT_STATE_ERROR
,
112 CC_NO_PING_RESPONSE_ERROR
,
113 CC_EVENT_RING_FULL_ERROR
,
114 CC_INCOMPATIBLE_DEVICE_ERROR
,
115 CC_MISSED_SERVICE_ERROR
,
116 CC_COMMAND_RING_STOPPED
,
119 CC_STOPPED_LENGTH_INVALID
,
120 CC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR
= 29,
121 CC_ISOCH_BUFFER_OVERRUN
= 31,
124 CC_INVALID_STREAM_ID_ERROR
,
125 CC_SECONDARY_BANDWIDTH_ERROR
,
126 CC_SPLIT_TRANSACTION_ERROR
129 typedef struct XHCIRing
{
134 typedef struct XHCIPort
{
144 typedef struct XHCISlot
{
150 XHCIEPContext
*eps
[31];
153 typedef struct XHCIEvent
{
163 typedef struct XHCIInterrupter
{
168 uint32_t erstba_high
;
172 bool msix_used
, er_pcs
;
176 unsigned int er_ep_idx
;
178 /* kept for live migration compat only */
180 XHCIEvent ev_buffer
[EV_QUEUE
];
181 unsigned int ev_buffer_put
;
182 unsigned int ev_buffer_get
;
188 PCIDevice parent_obj
;
193 MemoryRegion mem_cap
;
194 MemoryRegion mem_oper
;
195 MemoryRegion mem_runtime
;
196 MemoryRegion mem_doorbell
;
204 uint32_t max_pstreams_mask
;
208 /* Operational Registers */
215 uint32_t dcbaap_high
;
218 USBPort uports
[MAX_CONST(MAXPORTS_2
, MAXPORTS_3
)];
219 XHCIPort ports
[MAXPORTS
];
220 XHCISlot slots
[MAXSLOTS
];
223 /* Runtime Registers */
224 int64_t mfindex_start
;
225 QEMUTimer
*mfwrap_timer
;
226 XHCIInterrupter intr
[MAXINTRS
];