1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (C) 2007-2010 Advanced Micro Devices, Inc.
4 * Author: Joerg Roedel <jroedel@suse.de>
5 * Leo Duran <leo.duran@amd.com>
6 */
7
8 #ifndef _ASM_X86_AMD_IOMMU_TYPES_H
9 #define _ASM_X86_AMD_IOMMU_TYPES_H
10
11 #include <linux/types.h>
12 #include <linux/mutex.h>
13 #include <linux/msi.h>
14 #include <linux/list.h>
15 #include <linux/spinlock.h>
16 #include <linux/pci.h>
17 #include <linux/irqreturn.h>
18
19 /*
20 * Maximum number of IOMMUs supported
21 */
22 #define MAX_IOMMUS 32
23
24 /*
25 * some size calculation constants
26 */
27 #define DEV_TABLE_ENTRY_SIZE 32
28 #define ALIAS_TABLE_ENTRY_SIZE 2
29 #define RLOOKUP_TABLE_ENTRY_SIZE (sizeof(void *))
30
31 /* Capability offsets used by the driver */
32 #define MMIO_CAP_HDR_OFFSET 0x00
33 #define MMIO_RANGE_OFFSET 0x0c
34 #define MMIO_MISC_OFFSET 0x10
35
36 /* Masks, shifts and macros to parse the device range capability */
37 #define MMIO_RANGE_LD_MASK 0xff000000
38 #define MMIO_RANGE_FD_MASK 0x00ff0000
39 #define MMIO_RANGE_BUS_MASK 0x0000ff00
40 #define MMIO_RANGE_LD_SHIFT 24
41 #define MMIO_RANGE_FD_SHIFT 16
42 #define MMIO_RANGE_BUS_SHIFT 8
43 #define MMIO_GET_LD(x) (((x) & MMIO_RANGE_LD_MASK) >> MMIO_RANGE_LD_SHIFT)
44 #define MMIO_GET_FD(x) (((x) & MMIO_RANGE_FD_MASK) >> MMIO_RANGE_FD_SHIFT)
45 #define MMIO_GET_BUS(x) (((x) & MMIO_RANGE_BUS_MASK) >> MMIO_RANGE_BUS_SHIFT)
46 #define MMIO_MSI_NUM(x) ((x) & 0x1f)
47
48 /* Flag masks for the AMD IOMMU exclusion range */
49 #define MMIO_EXCL_ENABLE_MASK 0x01ULL
50 #define MMIO_EXCL_ALLOW_MASK 0x02ULL
51
52 /* Used offsets into the MMIO space */
53 #define MMIO_DEV_TABLE_OFFSET 0x0000
54 #define MMIO_CMD_BUF_OFFSET 0x0008
55 #define MMIO_EVT_BUF_OFFSET 0x0010
56 #define MMIO_CONTROL_OFFSET 0x0018
57 #define MMIO_EXCL_BASE_OFFSET 0x0020
58 #define MMIO_EXCL_LIMIT_OFFSET 0x0028
59 #define MMIO_EXT_FEATURES 0x0030
60 #define MMIO_PPR_LOG_OFFSET 0x0038
61 #define MMIO_GA_LOG_BASE_OFFSET 0x00e0
62 #define MMIO_GA_LOG_TAIL_OFFSET 0x00e8
63 #define MMIO_MSI_ADDR_LO_OFFSET 0x015C
64 #define MMIO_MSI_ADDR_HI_OFFSET 0x0160
65 #define MMIO_MSI_DATA_OFFSET 0x0164
66 #define MMIO_INTCAPXT_EVT_OFFSET 0x0170
67 #define MMIO_INTCAPXT_PPR_OFFSET 0x0178
68 #define MMIO_INTCAPXT_GALOG_OFFSET 0x0180
69 #define MMIO_CMD_HEAD_OFFSET 0x2000
70 #define MMIO_CMD_TAIL_OFFSET 0x2008
71 #define MMIO_EVT_HEAD_OFFSET 0x2010
72 #define MMIO_EVT_TAIL_OFFSET 0x2018
73 #define MMIO_STATUS_OFFSET 0x2020
74 #define MMIO_PPR_HEAD_OFFSET 0x2030
75 #define MMIO_PPR_TAIL_OFFSET 0x2038
76 #define MMIO_GA_HEAD_OFFSET 0x2040
77 #define MMIO_GA_TAIL_OFFSET 0x2048
78 #define MMIO_CNTR_CONF_OFFSET 0x4000
79 #define MMIO_CNTR_REG_OFFSET 0x40000
80 #define MMIO_REG_END_OFFSET 0x80000
81
82
83
84 /* Extended Feature Bits */
85 #define FEATURE_PREFETCH (1ULL<<0)
86 #define FEATURE_PPR (1ULL<<1)
87 #define FEATURE_X2APIC (1ULL<<2)
88 #define FEATURE_NX (1ULL<<3)
89 #define FEATURE_GT (1ULL<<4)
90 #define FEATURE_IA (1ULL<<6)
91 #define FEATURE_GA (1ULL<<7)
92 #define FEATURE_HE (1ULL<<8)
93 #define FEATURE_PC (1ULL<<9)
94 #define FEATURE_GAM_VAPIC (1ULL<<21)
95 #define FEATURE_EPHSUP (1ULL<<50)
96
97 #define FEATURE_PASID_SHIFT 32
98 #define FEATURE_PASID_MASK (0x1fULL << FEATURE_PASID_SHIFT)
99
100 #define FEATURE_GLXVAL_SHIFT 14
101 #define FEATURE_GLXVAL_MASK (0x03ULL << FEATURE_GLXVAL_SHIFT)
102
103 /* Note:
104 * The current driver only support 16-bit PASID.
105 * Currently, hardware only implement upto 16-bit PASID
106 * even though the spec says it could have upto 20 bits.
107 */
108 #define PASID_MASK 0x0000ffff
109
110 /* MMIO status bits */
111 #define MMIO_STATUS_EVT_INT_MASK (1 << 1)
112 #define MMIO_STATUS_COM_WAIT_INT_MASK (1 << 2)
113 #define MMIO_STATUS_PPR_INT_MASK (1 << 6)
114 #define MMIO_STATUS_GALOG_RUN_MASK (1 << 8)
115 #define MMIO_STATUS_GALOG_OVERFLOW_MASK (1 << 9)
116 #define MMIO_STATUS_GALOG_INT_MASK (1 << 10)
117
118 /* event logging constants */
119 #define EVENT_ENTRY_SIZE 0x10
120 #define EVENT_TYPE_SHIFT 28
121 #define EVENT_TYPE_MASK 0xf
122 #define EVENT_TYPE_ILL_DEV 0x1
123 #define EVENT_TYPE_IO_FAULT 0x2
124 #define EVENT_TYPE_DEV_TAB_ERR 0x3
125 #define EVENT_TYPE_PAGE_TAB_ERR 0x4
126 #define EVENT_TYPE_ILL_CMD 0x5
127 #define EVENT_TYPE_CMD_HARD_ERR 0x6
128 #define EVENT_TYPE_IOTLB_INV_TO 0x7
129 #define EVENT_TYPE_INV_DEV_REQ 0x8
130 #define EVENT_TYPE_INV_PPR_REQ 0x9
131 #define EVENT_DEVID_MASK 0xffff
132 #define EVENT_DEVID_SHIFT 0
133 #define EVENT_DOMID_MASK_LO 0xffff
134 #define EVENT_DOMID_MASK_HI 0xf0000
135 #define EVENT_FLAGS_MASK 0xfff
136 #define EVENT_FLAGS_SHIFT 0x10
137
138 /* feature control bits */
139 #define CONTROL_IOMMU_EN 0x00ULL
140 #define CONTROL_HT_TUN_EN 0x01ULL
141 #define CONTROL_EVT_LOG_EN 0x02ULL
142 #define CONTROL_EVT_INT_EN 0x03ULL
143 #define CONTROL_COMWAIT_EN 0x04ULL
144 #define CONTROL_INV_TIMEOUT 0x05ULL
145 #define CONTROL_PASSPW_EN 0x08ULL
146 #define CONTROL_RESPASSPW_EN 0x09ULL
147 #define CONTROL_COHERENT_EN 0x0aULL
148 #define CONTROL_ISOC_EN 0x0bULL
149 #define CONTROL_CMDBUF_EN 0x0cULL
150 #define CONTROL_PPFLOG_EN 0x0dULL
151 #define CONTROL_PPFINT_EN 0x0eULL
152 #define CONTROL_PPR_EN 0x0fULL
153 #define CONTROL_GT_EN 0x10ULL
154 #define CONTROL_GA_EN 0x11ULL
155 #define CONTROL_GAM_EN 0x19ULL
156 #define CONTROL_GALOG_EN 0x1CULL
157 #define CONTROL_GAINT_EN 0x1DULL
158 #define CONTROL_XT_EN 0x32ULL
159 #define CONTROL_INTCAPXT_EN 0x33ULL
160
161 #define CTRL_INV_TO_MASK (7 << CONTROL_INV_TIMEOUT)
162 #define CTRL_INV_TO_NONE 0
163 #define CTRL_INV_TO_1MS 1
164 #define CTRL_INV_TO_10MS 2
165 #define CTRL_INV_TO_100MS 3
166 #define CTRL_INV_TO_1S 4
167 #define CTRL_INV_TO_10S 5
168 #define CTRL_INV_TO_100S 6
169
170 /* command specific defines */
171 #define CMD_COMPL_WAIT 0x01
172 #define CMD_INV_DEV_ENTRY 0x02
173 #define CMD_INV_IOMMU_PAGES 0x03
174 #define CMD_INV_IOTLB_PAGES 0x04
175 #define CMD_INV_IRT 0x05
176 #define CMD_COMPLETE_PPR 0x07
177 #define CMD_INV_ALL 0x08
178
179 #define CMD_COMPL_WAIT_STORE_MASK 0x01
180 #define CMD_COMPL_WAIT_INT_MASK 0x02
181 #define CMD_INV_IOMMU_PAGES_SIZE_MASK 0x01
182 #define CMD_INV_IOMMU_PAGES_PDE_MASK 0x02
183 #define CMD_INV_IOMMU_PAGES_GN_MASK 0x04
184
185 #define PPR_STATUS_MASK 0xf
186 #define PPR_STATUS_SHIFT 12
187
188 #define CMD_INV_IOMMU_ALL_PAGES_ADDRESS 0x7fffffffffffffffULL
189
190 /* macros and definitions for device table entries */
191 #define DEV_ENTRY_VALID 0x00
192 #define DEV_ENTRY_TRANSLATION 0x01
193 #define DEV_ENTRY_PPR 0x34
194 #define DEV_ENTRY_IR 0x3d
195 #define DEV_ENTRY_IW 0x3e
196 #define DEV_ENTRY_NO_PAGE_FAULT 0x62
197 #define DEV_ENTRY_EX 0x67
198 #define DEV_ENTRY_SYSMGT1 0x68
199 #define DEV_ENTRY_SYSMGT2 0x69
200 #define DEV_ENTRY_IRQ_TBL_EN 0x80
201 #define DEV_ENTRY_INIT_PASS 0xb8
202 #define DEV_ENTRY_EINT_PASS 0xb9
203 #define DEV_ENTRY_NMI_PASS 0xba
204 #define DEV_ENTRY_LINT0_PASS 0xbe
205 #define DEV_ENTRY_LINT1_PASS 0xbf
206 #define DEV_ENTRY_MODE_MASK 0x07
207 #define DEV_ENTRY_MODE_SHIFT 0x09
208
209 #define MAX_DEV_TABLE_ENTRIES 0xffff
210
211 /* constants to configure the command buffer */
212 #define CMD_BUFFER_SIZE 8192
213 #define CMD_BUFFER_UNINITIALIZED 1
214 #define CMD_BUFFER_ENTRIES 512
215 #define MMIO_CMD_SIZE_SHIFT 56
216 #define MMIO_CMD_SIZE_512 (0x9ULL << MMIO_CMD_SIZE_SHIFT)
217
218 /* constants for event buffer handling */
219 #define EVT_BUFFER_SIZE 8192 /* 512 entries */
220 #define EVT_LEN_MASK (0x9ULL << 56)
221
222 /* Constants for PPR Log handling */
223 #define PPR_LOG_ENTRIES 512
224 #define PPR_LOG_SIZE_SHIFT 56
225 #define PPR_LOG_SIZE_512 (0x9ULL << PPR_LOG_SIZE_SHIFT)
226 #define PPR_ENTRY_SIZE 16
227 #define PPR_LOG_SIZE (PPR_ENTRY_SIZE * PPR_LOG_ENTRIES)
228
229 #define PPR_REQ_TYPE(x) (((x) >> 60) & 0xfULL)
230 #define PPR_FLAGS(x) (((x) >> 48) & 0xfffULL)
231 #define PPR_DEVID(x) ((x) & 0xffffULL)
232 #define PPR_TAG(x) (((x) >> 32) & 0x3ffULL)
233 #define PPR_PASID1(x) (((x) >> 16) & 0xffffULL)
234 #define PPR_PASID2(x) (((x) >> 42) & 0xfULL)
235 #define PPR_PASID(x) ((PPR_PASID2(x) << 16) | PPR_PASID1(x))
236
237 #define PPR_REQ_FAULT 0x01
238
239 /* Constants for GA Log handling */
240 #define GA_LOG_ENTRIES 512
241 #define GA_LOG_SIZE_SHIFT 56
242 #define GA_LOG_SIZE_512 (0x8ULL << GA_LOG_SIZE_SHIFT)
243 #define GA_ENTRY_SIZE 8
244 #define GA_LOG_SIZE (GA_ENTRY_SIZE * GA_LOG_ENTRIES)
245
246 #define GA_TAG(x) (u32)(x & 0xffffffffULL)
247 #define GA_DEVID(x) (u16)(((x) >> 32) & 0xffffULL)
248 #define GA_REQ_TYPE(x) (((x) >> 60) & 0xfULL)
249
250 #define GA_GUEST_NR 0x1
251
252 /* Bit value definition for dte irq remapping fields*/
253 #define DTE_IRQ_PHYS_ADDR_MASK (((1ULL << 45)-1) << 6)
254 #define DTE_IRQ_REMAP_INTCTL_MASK (0x3ULL << 60)
255 #define DTE_IRQ_TABLE_LEN_MASK (0xfULL << 1)
256 #define DTE_IRQ_REMAP_INTCTL (2ULL << 60)
257 #define DTE_IRQ_TABLE_LEN (8ULL << 1)
258 #define DTE_IRQ_REMAP_ENABLE 1ULL
259
260 #define PAGE_MODE_NONE 0x00
261 #define PAGE_MODE_1_LEVEL 0x01
262 #define PAGE_MODE_2_LEVEL 0x02
263 #define PAGE_MODE_3_LEVEL 0x03
264 #define PAGE_MODE_4_LEVEL 0x04
265 #define PAGE_MODE_5_LEVEL 0x05
266 #define PAGE_MODE_6_LEVEL 0x06
267 #define PAGE_MODE_7_LEVEL 0x07
268
269 #define PM_LEVEL_SHIFT(x) (12 + ((x) * 9))
270 #define PM_LEVEL_SIZE(x) (((x) < 6) ? \
271 ((1ULL << PM_LEVEL_SHIFT((x))) - 1): \
272 (0xffffffffffffffffULL))
273 #define PM_LEVEL_INDEX(x, a) (((a) >> PM_LEVEL_SHIFT((x))) & 0x1ffULL)
274 #define PM_LEVEL_ENC(x) (((x) << 9) & 0xe00ULL)
275 #define PM_LEVEL_PDE(x, a) ((a) | PM_LEVEL_ENC((x)) | \
276 IOMMU_PTE_PR | IOMMU_PTE_IR | IOMMU_PTE_IW)
277 #define PM_PTE_LEVEL(pte) (((pte) >> 9) & 0x7ULL)
278
279 #define PM_MAP_4k 0
280 #define PM_ADDR_MASK 0x000ffffffffff000ULL
281 #define PM_MAP_MASK(lvl) (PM_ADDR_MASK & \
282 (~((1ULL << (12 + ((lvl) * 9))) - 1)))
283 #define PM_ALIGNED(lvl, addr) ((PM_MAP_MASK(lvl) & (addr)) == (addr))
284
285 /*
286 * Returns the page table level to use for a given page size
287 * Pagesize is expected to be a power-of-two
288 */
289 #define PAGE_SIZE_LEVEL(pagesize) \
290 ((__ffs(pagesize) - 12) / 9)
291 /*
292 * Returns the number of ptes to use for a given page size
293 * Pagesize is expected to be a power-of-two
294 */
295 #define PAGE_SIZE_PTE_COUNT(pagesize) \
296 (1ULL << ((__ffs(pagesize) - 12) % 9))
297
298 /*
299 * Aligns a given io-virtual address to a given page size
300 * Pagesize is expected to be a power-of-two
301 */
302 #define PAGE_SIZE_ALIGN(address, pagesize) \
303 ((address) & ~((pagesize) - 1))
304 /*
305 * Creates an IOMMU PTE for an address and a given pagesize
306 * The PTE has no permission bits set
307 * Pagesize is expected to be a power-of-two larger than 4096
308 */
309 #define PAGE_SIZE_PTE(address, pagesize) \
310 (((address) | ((pagesize) - 1)) & \
311 (~(pagesize >> 1)) & PM_ADDR_MASK)
312
313 /*
314 * Takes a PTE value with mode=0x07 and returns the page size it maps
315 */
316 #define PTE_PAGE_SIZE(pte) \
317 (1ULL << (1 + ffz(((pte) | 0xfffULL))))
318
319 /*
320 * Takes a page-table level and returns the default page-size for this level
321 */
322 #define PTE_LEVEL_PAGE_SIZE(level) \
323 (1ULL << (12 + (9 * (level))))
324
325 /*
326 * Bit value definition for I/O PTE fields
327 */
328 #define IOMMU_PTE_PR (1ULL << 0)
329 #define IOMMU_PTE_U (1ULL << 59)
330 #define IOMMU_PTE_FC (1ULL << 60)
331 #define IOMMU_PTE_IR (1ULL << 61)
332 #define IOMMU_PTE_IW (1ULL << 62)
333
334 /*
335 * Bit value definition for DTE fields
336 */
337 #define DTE_FLAG_V (1ULL << 0)
338 #define DTE_FLAG_TV (1ULL << 1)
339 #define DTE_FLAG_IR (1ULL << 61)
340 #define DTE_FLAG_IW (1ULL << 62)
341
342 #define DTE_FLAG_IOTLB (1ULL << 32)
343 #define DTE_FLAG_GV (1ULL << 55)
344 #define DTE_FLAG_MASK (0x3ffULL << 32)
345 #define DTE_GLX_SHIFT (56)
346 #define DTE_GLX_MASK (3)
347 #define DEV_DOMID_MASK 0xffffULL
348
349 #define DTE_GCR3_VAL_A(x) (((x) >> 12) & 0x00007ULL)
350 #define DTE_GCR3_VAL_B(x) (((x) >> 15) & 0x0ffffULL)
351 #define DTE_GCR3_VAL_C(x) (((x) >> 31) & 0xfffffULL)
352
353 #define DTE_GCR3_INDEX_A 0
354 #define DTE_GCR3_INDEX_B 1
355 #define DTE_GCR3_INDEX_C 1
356
357 #define DTE_GCR3_SHIFT_A 58
358 #define DTE_GCR3_SHIFT_B 16
359 #define DTE_GCR3_SHIFT_C 43
360
361 #define GCR3_VALID 0x01ULL
362
363 #define IOMMU_PAGE_MASK (((1ULL << 52) - 1) & ~0xfffULL)
364 #define IOMMU_PTE_PRESENT(pte) ((pte) & IOMMU_PTE_PR)
365 #define IOMMU_PTE_PAGE(pte) (iommu_phys_to_virt((pte) & IOMMU_PAGE_MASK))
366 #define IOMMU_PTE_MODE(pte) (((pte) >> 9) & 0x07)
367
368 #define IOMMU_PROT_MASK 0x03
369 #define IOMMU_PROT_IR 0x01
370 #define IOMMU_PROT_IW 0x02
371
372 #define IOMMU_UNITY_MAP_FLAG_EXCL_RANGE (1 << 2)
373
374 /* IOMMU capabilities */
375 #define IOMMU_CAP_IOTLB 24
376 #define IOMMU_CAP_NPCACHE 26
377 #define IOMMU_CAP_EFR 27
378
379 /* IOMMU Feature Reporting Field (for IVHD type 10h */
380 #define IOMMU_FEAT_XTSUP_SHIFT 0
381 #define IOMMU_FEAT_GASUP_SHIFT 6
382
383 /* IOMMU Extended Feature Register (EFR) */
384 #define IOMMU_EFR_XTSUP_SHIFT 2
385 #define IOMMU_EFR_GASUP_SHIFT 7
386
387 #define MAX_DOMAIN_ID 65536
388
389 /* Protection domain flags */
390 #define PD_DMA_OPS_MASK (1UL << 0) /* domain used for dma_ops */
391 #define PD_DEFAULT_MASK (1UL << 1) /* domain is a default dma_ops
392 domain for an IOMMU */
393 #define PD_PASSTHROUGH_MASK (1UL << 2) /* domain has no page
394 translation */
395 #define PD_IOMMUV2_MASK (1UL << 3) /* domain has gcr3 table */
396
397 extern bool amd_iommu_dump;
398 #define DUMP_printk(format, arg...) \
399 do { \
400 if (amd_iommu_dump) \
401 printk(KERN_INFO "AMD-Vi: " format, ## arg); \
402 } while(0);
403
404 /* global flag if IOMMUs cache non-present entries */
405 extern bool amd_iommu_np_cache;
406 /* Only true if all IOMMUs support device IOTLBs */
407 extern bool amd_iommu_iotlb_sup;
408
409 #define MAX_IRQS_PER_TABLE 256
410 #define IRQ_TABLE_ALIGNMENT 128
411
412 struct irq_remap_table {
413 raw_spinlock_t lock;
414 unsigned min_index;
415 u32 *table;
416 };
417
418 extern struct irq_remap_table **irq_lookup_table;
419
420 /* Interrupt remapping feature used? */
421 extern bool amd_iommu_irq_remap;
422
423 /* kmem_cache to get tables with 128 byte alignement */
424 extern struct kmem_cache *amd_iommu_irq_cache;
425
426 /*
427 * Make iterating over all IOMMUs easier
428 */
429 #define for_each_iommu(iommu) \
430 list_for_each_entry((iommu), &amd_iommu_list, list)
431 #define for_each_iommu_safe(iommu, next) \
432 list_for_each_entry_safe((iommu), (next), &amd_iommu_list, list)
433
434 #define APERTURE_RANGE_SHIFT 27 /* 128 MB */
435 #define APERTURE_RANGE_SIZE (1ULL << APERTURE_RANGE_SHIFT)
436 #define APERTURE_RANGE_PAGES (APERTURE_RANGE_SIZE >> PAGE_SHIFT)
437 #define APERTURE_MAX_RANGES 32 /* allows 4GB of DMA address space */
438 #define APERTURE_RANGE_INDEX(a) ((a) >> APERTURE_RANGE_SHIFT)
439 #define APERTURE_PAGE_INDEX(a) (((a) >> 21) & 0x3fULL)
440
441 /*
442 * This struct is used to pass information about
443 * incoming PPR faults around.
444 */
445 struct amd_iommu_fault {
446 u64 address; /* IO virtual address of the fault*/
447 u32 pasid; /* Address space identifier */
448 u16 device_id; /* Originating PCI device id */
449 u16 tag; /* PPR tag */
450 u16 flags; /* Fault flags */
451
452 };
453
454
455 struct iommu_domain;
456 struct irq_domain;
457 struct amd_irte_ops;
458
459 #define AMD_IOMMU_FLAG_TRANS_PRE_ENABLED (1 << 0)
460
461 /*
462 * This structure contains generic data for IOMMU protection domains
463 * independent of their use.
464 */
465 struct protection_domain {
466 struct list_head list; /* for list of all protection domains */
467 struct list_head dev_list; /* List of all devices in this domain */
468 struct iommu_domain domain; /* generic domain handle used by
469 iommu core code */
470 spinlock_t lock; /* mostly used to lock the page table*/
471 struct mutex api_lock; /* protect page tables in the iommu-api path */
472 u16 id; /* the domain id written to the device table */
473 int mode; /* paging mode (0-6 levels) */
474 u64 *pt_root; /* page table root pointer */
475 int glx; /* Number of levels for GCR3 table */
476 u64 *gcr3_tbl; /* Guest CR3 table */
477 unsigned long flags; /* flags to find out type of domain */
478 unsigned dev_cnt; /* devices assigned to this domain */
479 unsigned dev_iommu[MAX_IOMMUS]; /* per-IOMMU reference count */
480 };
481
482 /*
483 * Structure where we save information about one hardware AMD IOMMU in the
484 * system.
485 */
486 struct amd_iommu {
487 struct list_head list;
488
489 /* Index within the IOMMU array */
490 int index;
491
492 /* locks the accesses to the hardware */
493 raw_spinlock_t lock;
494
495 /* Pointer to PCI device of this IOMMU */
496 struct pci_dev *dev;
497
498 /* Cache pdev to root device for resume quirks */
499 struct pci_dev *root_pdev;
500
501 /* physical address of MMIO space */
502 u64 mmio_phys;
503
504 /* physical end address of MMIO space */
505 u64 mmio_phys_end;
506
507 /* virtual address of MMIO space */
508 u8 __iomem *mmio_base;
509
510 /* capabilities of that IOMMU read from ACPI */
511 u32 cap;
512
513 /* flags read from acpi table */
514 u8 acpi_flags;
515
516 /* Extended features */
517 u64 features;
518
519 /* IOMMUv2 */
520 bool is_iommu_v2;
521
522 /* PCI device id of the IOMMU device */
523 u16 devid;
524
525 /*
526 * Capability pointer. There could be more than one IOMMU per PCI
527 * device function if there are more than one AMD IOMMU capability
528 * pointers.
529 */
530 u16 cap_ptr;
531
532 /* pci domain of this IOMMU */
533 u16 pci_seg;
534
535 /* start of exclusion range of that IOMMU */
536 u64 exclusion_start;
537 /* length of exclusion range of that IOMMU */
538 u64 exclusion_length;
539
540 /* command buffer virtual address */
541 u8 *cmd_buf;
542 u32 cmd_buf_head;
543 u32 cmd_buf_tail;
544
545 /* event buffer virtual address */
546 u8 *evt_buf;
547
548 /* Base of the PPR log, if present */
549 u8 *ppr_log;
550
551 /* Base of the GA log, if present */
552 u8 *ga_log;
553
554 /* Tail of the GA log, if present */
555 u8 *ga_log_tail;
556
557 /* true if interrupts for this IOMMU are already enabled */
558 bool int_enabled;
559
560 /* if one, we need to send a completion wait command */
561 bool need_sync;
562
563 /* Handle for IOMMU core code */
564 struct iommu_device iommu;
565
566 /*
567 * We can't rely on the BIOS to restore all values on reinit, so we
568 * need to stash them
569 */
570
571 /* The iommu BAR */
572 u32 stored_addr_lo;
573 u32 stored_addr_hi;
574
575 /*
576 * Each iommu has 6 l1s, each of which is documented as having 0x12
577 * registers
578 */
579 u32 stored_l1[6][0x12];
580
581 /* The l2 indirect registers */
582 u32 stored_l2[0x83];
583
584 /* The maximum PC banks and counters/bank (PCSup=1) */
585 u8 max_banks;
586 u8 max_counters;
587 #ifdef CONFIG_IRQ_REMAP
588 struct irq_domain *ir_domain;
589 struct irq_domain *msi_domain;
590
591 struct amd_irte_ops *irte_ops;
592 #endif
593
594 u32 flags;
595 volatile u64 __aligned(8) cmd_sem;
596
597 #ifdef CONFIG_AMD_IOMMU_DEBUGFS
598 /* DebugFS Info */
599 struct dentry *debugfs;
600 #endif
601 /* IRQ notifier for IntCapXT interrupt */
602 struct irq_affinity_notify intcapxt_notify;
603 };
604
dev_to_amd_iommu(struct device * dev)605 static inline struct amd_iommu *dev_to_amd_iommu(struct device *dev)
606 {
607 struct iommu_device *iommu = dev_to_iommu_device(dev);
608
609 return container_of(iommu, struct amd_iommu, iommu);
610 }
611
612 #define ACPIHID_UID_LEN 256
613 #define ACPIHID_HID_LEN 9
614
615 struct acpihid_map_entry {
616 struct list_head list;
617 u8 uid[ACPIHID_UID_LEN];
618 u8 hid[ACPIHID_HID_LEN];
619 u16 devid;
620 u16 root_devid;
621 bool cmd_line;
622 struct iommu_group *group;
623 };
624
625 struct devid_map {
626 struct list_head list;
627 u8 id;
628 u16 devid;
629 bool cmd_line;
630 };
631
632 /*
633 * This struct contains device specific data for the IOMMU
634 */
635 struct iommu_dev_data {
636 /*Protect against attach/detach races */
637 spinlock_t lock;
638
639 struct list_head list; /* For domain->dev_list */
640 struct llist_node dev_data_list; /* For global dev_data_list */
641 struct protection_domain *domain; /* Domain the device is bound to */
642 struct pci_dev *pdev;
643 u16 devid; /* PCI Device ID */
644 bool iommu_v2; /* Device can make use of IOMMUv2 */
645 bool passthrough; /* Device is identity mapped */
646 struct {
647 bool enabled;
648 int qdep;
649 } ats; /* ATS state */
650 bool pri_tlp; /* PASID TLB required for
651 PPR completions */
652 u32 errata; /* Bitmap for errata to apply */
653 bool use_vapic; /* Enable device to use vapic mode */
654 bool defer_attach;
655
656 struct ratelimit_state rs; /* Ratelimit IOPF messages */
657 };
658
659 /* Map HPET and IOAPIC ids to the devid used by the IOMMU */
660 extern struct list_head ioapic_map;
661 extern struct list_head hpet_map;
662 extern struct list_head acpihid_map;
663
664 /*
665 * List with all IOMMUs in the system. This list is not locked because it is
666 * only written and read at driver initialization or suspend time
667 */
668 extern struct list_head amd_iommu_list;
669
670 /*
671 * Array with pointers to each IOMMU struct
672 * The indices are referenced in the protection domains
673 */
674 extern struct amd_iommu *amd_iommus[MAX_IOMMUS];
675
676 /*
677 * Structure defining one entry in the device table
678 */
679 struct dev_table_entry {
680 u64 data[4];
681 };
682
683 /*
684 * One entry for unity mappings parsed out of the ACPI table.
685 */
686 struct unity_map_entry {
687 struct list_head list;
688
689 /* starting device id this entry is used for (including) */
690 u16 devid_start;
691 /* end device id this entry is used for (including) */
692 u16 devid_end;
693
694 /* start address to unity map (including) */
695 u64 address_start;
696 /* end address to unity map (including) */
697 u64 address_end;
698
699 /* required protection */
700 int prot;
701 };
702
703 /*
704 * List of all unity mappings. It is not locked because as runtime it is only
705 * read. It is created at ACPI table parsing time.
706 */
707 extern struct list_head amd_iommu_unity_map;
708
709 /*
710 * Data structures for device handling
711 */
712
713 /*
714 * Device table used by hardware. Read and write accesses by software are
715 * locked with the amd_iommu_pd_table lock.
716 */
717 extern struct dev_table_entry *amd_iommu_dev_table;
718
719 /*
720 * Alias table to find requestor ids to device ids. Not locked because only
721 * read on runtime.
722 */
723 extern u16 *amd_iommu_alias_table;
724
725 /*
726 * Reverse lookup table to find the IOMMU which translates a specific device.
727 */
728 extern struct amd_iommu **amd_iommu_rlookup_table;
729
730 /* size of the dma_ops aperture as power of 2 */
731 extern unsigned amd_iommu_aperture_order;
732
733 /* largest PCI device id we expect translation requests for */
734 extern u16 amd_iommu_last_bdf;
735
736 /* allocation bitmap for domain ids */
737 extern unsigned long *amd_iommu_pd_alloc_bitmap;
738
739 /*
740 * If true, the addresses will be flushed on unmap time, not when
741 * they are reused
742 */
743 extern bool amd_iommu_unmap_flush;
744
745 /* Smallest max PASID supported by any IOMMU in the system */
746 extern u32 amd_iommu_max_pasid;
747
748 extern bool amd_iommu_v2_present;
749
750 extern bool amd_iommu_force_isolation;
751
752 /* Max levels of glxval supported */
753 extern int amd_iommu_max_glx_val;
754
755 /*
756 * This function flushes all internal caches of
757 * the IOMMU used by this driver.
758 */
759 extern void iommu_flush_all_caches(struct amd_iommu *iommu);
760
get_ioapic_devid(int id)761 static inline int get_ioapic_devid(int id)
762 {
763 struct devid_map *entry;
764
765 list_for_each_entry(entry, &ioapic_map, list) {
766 if (entry->id == id)
767 return entry->devid;
768 }
769
770 return -EINVAL;
771 }
772
get_hpet_devid(int id)773 static inline int get_hpet_devid(int id)
774 {
775 struct devid_map *entry;
776
777 list_for_each_entry(entry, &hpet_map, list) {
778 if (entry->id == id)
779 return entry->devid;
780 }
781
782 return -EINVAL;
783 }
784
785 enum amd_iommu_intr_mode_type {
786 AMD_IOMMU_GUEST_IR_LEGACY,
787
788 /* This mode is not visible to users. It is used when
789 * we cannot fully enable vAPIC and fallback to only support
790 * legacy interrupt remapping via 128-bit IRTE.
791 */
792 AMD_IOMMU_GUEST_IR_LEGACY_GA,
793 AMD_IOMMU_GUEST_IR_VAPIC,
794 };
795
796 #define AMD_IOMMU_GUEST_IR_GA(x) (x == AMD_IOMMU_GUEST_IR_VAPIC || \
797 x == AMD_IOMMU_GUEST_IR_LEGACY_GA)
798
799 #define AMD_IOMMU_GUEST_IR_VAPIC(x) (x == AMD_IOMMU_GUEST_IR_VAPIC)
800
801 union irte {
802 u32 val;
803 struct {
804 u32 valid : 1,
805 no_fault : 1,
806 int_type : 3,
807 rq_eoi : 1,
808 dm : 1,
809 rsvd_1 : 1,
810 destination : 8,
811 vector : 8,
812 rsvd_2 : 8;
813 } fields;
814 };
815
816 #define APICID_TO_IRTE_DEST_LO(x) (x & 0xffffff)
817 #define APICID_TO_IRTE_DEST_HI(x) ((x >> 24) & 0xff)
818
819 union irte_ga_lo {
820 u64 val;
821
822 /* For int remapping */
823 struct {
824 u64 valid : 1,
825 no_fault : 1,
826 /* ------ */
827 int_type : 3,
828 rq_eoi : 1,
829 dm : 1,
830 /* ------ */
831 guest_mode : 1,
832 destination : 24,
833 ga_tag : 32;
834 } fields_remap;
835
836 /* For guest vAPIC */
837 struct {
838 u64 valid : 1,
839 no_fault : 1,
840 /* ------ */
841 ga_log_intr : 1,
842 rsvd1 : 3,
843 is_run : 1,
844 /* ------ */
845 guest_mode : 1,
846 destination : 24,
847 ga_tag : 32;
848 } fields_vapic;
849 };
850
851 union irte_ga_hi {
852 u64 val;
853 struct {
854 u64 vector : 8,
855 rsvd_1 : 4,
856 ga_root_ptr : 40,
857 rsvd_2 : 4,
858 destination : 8;
859 } fields;
860 };
861
862 struct irte_ga {
863 union irte_ga_lo lo;
864 union irte_ga_hi hi;
865 };
866
867 struct irq_2_irte {
868 u16 devid; /* Device ID for IRTE table */
869 u16 index; /* Index into IRTE table*/
870 };
871
872 struct amd_ir_data {
873 u32 cached_ga_tag;
874 struct irq_2_irte irq_2_irte;
875 struct msi_msg msi_entry;
876 void *entry; /* Pointer to union irte or struct irte_ga */
877 void *ref; /* Pointer to the actual irte */
878
879 /**
880 * Store information for activate/de-activate
881 * Guest virtual APIC mode during runtime.
882 */
883 struct irq_cfg *cfg;
884 int ga_vector;
885 int ga_root_ptr;
886 int ga_tag;
887 };
888
889 struct amd_irte_ops {
890 void (*prepare)(void *, u32, u32, u8, u32, int);
891 void (*activate)(void *, u16, u16);
892 void (*deactivate)(void *, u16, u16);
893 void (*set_affinity)(void *, u16, u16, u8, u32);
894 void *(*get)(struct irq_remap_table *, int);
895 void (*set_allocated)(struct irq_remap_table *, int);
896 bool (*is_allocated)(struct irq_remap_table *, int);
897 void (*clear_allocated)(struct irq_remap_table *, int);
898 };
899
900 #ifdef CONFIG_IRQ_REMAP
901 extern struct amd_irte_ops irte_32_ops;
902 extern struct amd_irte_ops irte_128_ops;
903 #endif
904
905 #endif /* _ASM_X86_AMD_IOMMU_TYPES_H */
906