2 * QEMU emulation of an Intel IOMMU (VT-d)
3 * (DMA Remapping device)
5 * Copyright (C) 2013 Knut Omang, Oracle <knut.omang@oracle.com>
6 * Copyright (C) 2014 Le Tan, <tamlokveer@gmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program 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
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, see <http://www.gnu.org/licenses/>.
25 #include "sysemu/dma.h"
26 #include "hw/i386/x86-iommu.h"
27 #include "hw/i386/ioapic.h"
28 #include "hw/pci/msi.h"
29 #include "hw/sysbus.h"
31 #define TYPE_INTEL_IOMMU_DEVICE "intel-iommu"
32 #define INTEL_IOMMU_DEVICE(obj) \
33 OBJECT_CHECK(IntelIOMMUState, (obj), TYPE_INTEL_IOMMU_DEVICE)
35 /* DMAR Hardware Unit Definition address (IOMMU unit) */
36 #define Q35_HOST_BRIDGE_IOMMU_ADDR 0xfed90000ULL
38 #define VTD_PCI_BUS_MAX 256
39 #define VTD_PCI_SLOT_MAX 32
40 #define VTD_PCI_FUNC_MAX 8
41 #define VTD_PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
42 #define VTD_PCI_FUNC(devfn) ((devfn) & 0x07)
43 #define VTD_SID_TO_BUS(sid) (((sid) >> 8) & 0xff)
44 #define VTD_SID_TO_DEVFN(sid) ((sid) & 0xff)
46 #define DMAR_REG_SIZE 0x230
47 #define VTD_HOST_ADDRESS_WIDTH 39
48 #define VTD_HAW_MASK ((1ULL << VTD_HOST_ADDRESS_WIDTH) - 1)
50 #define DMAR_REPORT_F_INTR (1)
52 #define VTD_MSI_ADDR_HI_MASK (0xffffffff00000000ULL)
53 #define VTD_MSI_ADDR_HI_SHIFT (32)
54 #define VTD_MSI_ADDR_LO_MASK (0x00000000ffffffffULL)
56 typedef struct VTDContextEntry VTDContextEntry
;
57 typedef struct VTDContextCacheEntry VTDContextCacheEntry
;
58 typedef struct IntelIOMMUState IntelIOMMUState
;
59 typedef struct VTDAddressSpace VTDAddressSpace
;
60 typedef struct VTDIOTLBEntry VTDIOTLBEntry
;
61 typedef struct VTDBus VTDBus
;
62 typedef union VTD_IRTE VTD_IRTE
;
63 typedef union VTD_IR_MSIAddress VTD_IR_MSIAddress
;
64 typedef struct VTDIrq VTDIrq
;
65 typedef struct VTD_MSIMessage VTD_MSIMessage
;
68 struct VTDContextEntry
{
73 struct VTDContextCacheEntry
{
74 /* The cache entry is obsolete if
75 * context_cache_gen!=IntelIOMMUState.context_cache_gen
77 uint32_t context_cache_gen
;
78 struct VTDContextEntry context_entry
;
81 struct VTDAddressSpace
{
86 MemoryRegion iommu_ir
; /* Interrupt region: 0xfeeXXXXX */
87 IntelIOMMUState
*iommu_state
;
88 VTDContextCacheEntry context_cache_entry
;
92 PCIBus
* bus
; /* A reference to the bus to provide translation for */
93 VTDAddressSpace
*dev_as
[0]; /* A table of VTDAddressSpace objects indexed by devfn */
96 struct VTDIOTLBEntry
{
105 /* VT-d Source-ID Qualifier types */
107 VTD_SQ_FULL
= 0x00, /* Full SID verification */
108 VTD_SQ_IGN_3
= 0x01, /* Ignore bit 3 */
109 VTD_SQ_IGN_2_3
= 0x02, /* Ignore bits 2 & 3 */
110 VTD_SQ_IGN_1_3
= 0x03, /* Ignore bits 1-3 */
114 /* VT-d Source Validation Types */
116 VTD_SVT_NONE
= 0x00, /* No validation */
117 VTD_SVT_ALL
= 0x01, /* Do full validation */
118 VTD_SVT_BUS
= 0x02, /* Validate bus range */
122 /* Interrupt Remapping Table Entry Definition */
125 #ifdef HOST_WORDS_BIGENDIAN
126 uint32_t dest_id
:32; /* Destination ID */
127 uint32_t __reserved_1
:8; /* Reserved 1 */
128 uint32_t vector
:8; /* Interrupt Vector */
129 uint32_t irte_mode
:1; /* IRTE Mode */
130 uint32_t __reserved_0
:3; /* Reserved 0 */
131 uint32_t __avail
:4; /* Available spaces for software */
132 uint32_t delivery_mode
:3; /* Delivery Mode */
133 uint32_t trigger_mode
:1; /* Trigger Mode */
134 uint32_t redir_hint
:1; /* Redirection Hint */
135 uint32_t dest_mode
:1; /* Destination Mode */
136 uint32_t fault_disable
:1; /* Fault Processing Disable */
137 uint32_t present
:1; /* Whether entry present/available */
139 uint32_t present
:1; /* Whether entry present/available */
140 uint32_t fault_disable
:1; /* Fault Processing Disable */
141 uint32_t dest_mode
:1; /* Destination Mode */
142 uint32_t redir_hint
:1; /* Redirection Hint */
143 uint32_t trigger_mode
:1; /* Trigger Mode */
144 uint32_t delivery_mode
:3; /* Delivery Mode */
145 uint32_t __avail
:4; /* Available spaces for software */
146 uint32_t __reserved_0
:3; /* Reserved 0 */
147 uint32_t irte_mode
:1; /* IRTE Mode */
148 uint32_t vector
:8; /* Interrupt Vector */
149 uint32_t __reserved_1
:8; /* Reserved 1 */
150 uint32_t dest_id
:32; /* Destination ID */
152 uint16_t source_id
:16; /* Source-ID */
153 #ifdef HOST_WORDS_BIGENDIAN
154 uint64_t __reserved_2
:44; /* Reserved 2 */
155 uint64_t sid_vtype
:2; /* Source-ID Validation Type */
156 uint64_t sid_q
:2; /* Source-ID Qualifier */
158 uint64_t sid_q
:2; /* Source-ID Qualifier */
159 uint64_t sid_vtype
:2; /* Source-ID Validation Type */
160 uint64_t __reserved_2
:44; /* Reserved 2 */
166 #define VTD_IR_INT_FORMAT_COMPAT (0) /* Compatible Interrupt */
167 #define VTD_IR_INT_FORMAT_REMAP (1) /* Remappable Interrupt */
169 /* Programming format for MSI/MSI-X addresses */
170 union VTD_IR_MSIAddress
{
172 #ifdef HOST_WORDS_BIGENDIAN
173 uint32_t __head
:12; /* Should always be: 0x0fee */
174 uint32_t index_l
:15; /* Interrupt index bit 14-0 */
175 uint32_t int_mode
:1; /* Interrupt format */
176 uint32_t sub_valid
:1; /* SHV: Sub-Handle Valid bit */
177 uint32_t index_h
:1; /* Interrupt index bit 15 */
178 uint32_t __not_care
:2;
180 uint32_t __not_care
:2;
181 uint32_t index_h
:1; /* Interrupt index bit 15 */
182 uint32_t sub_valid
:1; /* SHV: Sub-Handle Valid bit */
183 uint32_t int_mode
:1; /* Interrupt format */
184 uint32_t index_l
:15; /* Interrupt index bit 14-0 */
185 uint32_t __head
:12; /* Should always be: 0x0fee */
191 /* Generic IRQ entry information */
193 /* Used by both IOAPIC/MSI interrupt remapping */
194 uint8_t trigger_mode
;
196 uint8_t delivery_mode
;
200 /* only used by MSI interrupt remapping */
202 uint8_t msi_addr_last_bits
;
205 struct VTD_MSIMessage
{
208 #ifdef HOST_WORDS_BIGENDIAN
209 uint32_t __addr_head
:12; /* 0xfee */
211 uint32_t __reserved
:8;
212 uint32_t redir_hint
:1;
213 uint32_t dest_mode
:1;
214 uint32_t __not_used
:2;
216 uint32_t __not_used
:2;
217 uint32_t dest_mode
:1;
218 uint32_t redir_hint
:1;
219 uint32_t __reserved
:8;
221 uint32_t __addr_head
:12; /* 0xfee */
223 uint32_t __addr_hi
:32;
229 #ifdef HOST_WORDS_BIGENDIAN
230 uint16_t trigger_mode
:1;
233 uint16_t delivery_mode
:3;
237 uint16_t delivery_mode
:3;
240 uint16_t trigger_mode
:1;
242 uint16_t __resved1
:16;
248 /* When IR is enabled, all MSI/MSI-X data bits should be zero */
249 #define VTD_IR_MSI_DATA (0)
251 /* The iommu (DMAR) device state struct */
252 struct IntelIOMMUState
{
253 X86IOMMUState x86_iommu
;
255 uint8_t csr
[DMAR_REG_SIZE
]; /* register values */
256 uint8_t wmask
[DMAR_REG_SIZE
]; /* R/W bytes */
257 uint8_t w1cmask
[DMAR_REG_SIZE
]; /* RW1C(Write 1 to Clear) bytes */
258 uint8_t womask
[DMAR_REG_SIZE
]; /* WO (write only - read returns 0) */
261 dma_addr_t root
; /* Current root table pointer */
262 bool root_extended
; /* Type of root table (extended or not) */
263 bool dmar_enabled
; /* Set if DMA remapping is enabled */
265 uint16_t iq_head
; /* Current invalidation queue head */
266 uint16_t iq_tail
; /* Current invalidation queue tail */
267 dma_addr_t iq
; /* Current invalidation queue pointer */
268 uint16_t iq_size
; /* IQ Size in number of entries */
269 bool qi_enabled
; /* Set if the QI is enabled */
270 uint8_t iq_last_desc_type
; /* The type of last completed descriptor */
272 /* The index of the Fault Recording Register to be used next.
273 * Wraps around from N-1 to 0, where N is the number of FRCD_REG.
275 uint16_t next_frcd_reg
;
277 uint64_t cap
; /* The value of capability reg */
278 uint64_t ecap
; /* The value of extended capability reg */
280 uint32_t context_cache_gen
; /* Should be in [1,MAX] */
281 GHashTable
*iotlb
; /* IOTLB */
283 MemoryRegionIOMMUOps iommu_ops
;
284 GHashTable
*vtd_as_by_busptr
; /* VTDBus objects indexed by PCIBus* reference */
285 VTDBus
*vtd_as_by_bus_num
[VTD_PCI_BUS_MAX
]; /* VTDBus objects indexed by bus number */
287 /* interrupt remapping */
288 bool intr_enabled
; /* Whether guest enabled IR */
289 dma_addr_t intr_root
; /* Interrupt remapping table pointer */
290 uint32_t intr_size
; /* Number of IR table entries */
291 bool intr_eime
; /* Extended interrupt mode enabled */
294 /* Find the VTD Address space associated with the given bus pointer,
295 * create a new one if none exists
297 VTDAddressSpace
*vtd_find_add_as(IntelIOMMUState
*s
, PCIBus
*bus
, int devfn
);