1 /* SPDX-License-Identifier: MIT */
3 * Copyright © 2020 Intel Corporation
5 * Please try to maintain the following order within this file unless it makes
6 * sense to do otherwise. From top to bottom:
8 * 2. #defines, and macros
9 * 3. structure definitions
10 * 4. function prototypes
12 * Within each section, please try to order by generation in ascending order,
13 * from top to bottom (ie. gen6 on the top, gen8 on the bottom).
16 #ifndef __INTEL_GTT_H__
17 #define __INTEL_GTT_H__
19 #include <linux/io-mapping.h>
20 #include <linux/kref.h>
22 #include <linux/pagevec.h>
23 #include <linux/scatterlist.h>
24 #include <linux/workqueue.h>
26 #include <drm/drm_mm.h>
28 #include "gt/intel_reset.h"
29 #include "i915_gem_fence_reg.h"
30 #include "i915_selftest.h"
31 #include "i915_vma_types.h"
33 #define I915_GFP_ALLOW_FAIL (GFP_KERNEL | __GFP_RETRY_MAYFAIL | __GFP_NOWARN)
35 #if IS_ENABLED(CONFIG_DRM_I915_TRACE_GTT)
36 #define DBG(...) trace_printk(__VA_ARGS__)
41 #define NALLOC 3 /* 1 normal, 1 for concurrent threads, 1 for preallocation */
43 #define I915_GTT_PAGE_SIZE_4K BIT_ULL(12)
44 #define I915_GTT_PAGE_SIZE_64K BIT_ULL(16)
45 #define I915_GTT_PAGE_SIZE_2M BIT_ULL(21)
47 #define I915_GTT_PAGE_SIZE I915_GTT_PAGE_SIZE_4K
48 #define I915_GTT_MAX_PAGE_SIZE I915_GTT_PAGE_SIZE_2M
50 #define I915_GTT_PAGE_MASK -I915_GTT_PAGE_SIZE
52 #define I915_GTT_MIN_ALIGNMENT I915_GTT_PAGE_SIZE
54 #define I915_FENCE_REG_NONE -1
55 #define I915_MAX_NUM_FENCES 32
56 /* 32 fences + sign bit for FENCE_REG_NONE */
57 #define I915_MAX_NUM_FENCE_BITS 6
59 typedef u32 gen6_pte_t
;
60 typedef u64 gen8_pte_t
;
62 #define ggtt_total_entries(ggtt) ((ggtt)->vm.total >> PAGE_SHIFT)
64 #define I915_PTES(pte_len) ((unsigned int)(PAGE_SIZE / (pte_len)))
65 #define I915_PTE_MASK(pte_len) (I915_PTES(pte_len) - 1)
67 #define I915_PDE_MASK (I915_PDES - 1)
69 /* gen6-hsw has bit 11-4 for physical addr bit 39-32 */
70 #define GEN6_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0xff0))
71 #define GEN6_PTE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
72 #define GEN6_PDE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
73 #define GEN6_PTE_CACHE_LLC (2 << 1)
74 #define GEN6_PTE_UNCACHED (1 << 1)
75 #define GEN6_PTE_VALID REG_BIT(0)
77 #define GEN6_PTES I915_PTES(sizeof(gen6_pte_t))
78 #define GEN6_PD_SIZE (I915_PDES * PAGE_SIZE)
79 #define GEN6_PD_ALIGN (PAGE_SIZE * 16)
80 #define GEN6_PDE_SHIFT 22
81 #define GEN6_PDE_VALID REG_BIT(0)
82 #define NUM_PTE(pde_shift) (1 << (pde_shift - PAGE_SHIFT))
84 #define GEN7_PTE_CACHE_L3_LLC (3 << 1)
86 #define BYT_PTE_SNOOPED_BY_CPU_CACHES REG_BIT(2)
87 #define BYT_PTE_WRITEABLE REG_BIT(1)
90 * Cacheability Control is a 4-bit value. The low three bits are stored in bits
91 * 3:1 of the PTE, while the fourth bit is stored in bit 11 of the PTE.
93 #define HSW_CACHEABILITY_CONTROL(bits) ((((bits) & 0x7) << 1) | \
94 (((bits) & 0x8) << (11 - 3)))
95 #define HSW_WB_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x2)
96 #define HSW_WB_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x3)
97 #define HSW_WB_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x8)
98 #define HSW_WB_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0xb)
99 #define HSW_WT_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x7)
100 #define HSW_WT_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x6)
101 #define HSW_PTE_UNCACHED (0)
102 #define HSW_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0x7f0))
103 #define HSW_PTE_ADDR_ENCODE(addr) HSW_GTT_ADDR_ENCODE(addr)
106 * GEN8 32b style address is defined as a 3 level page table:
107 * 31:30 | 29:21 | 20:12 | 11:0
108 * PDPE | PDE | PTE | offset
109 * The difference as compared to normal x86 3 level page table is the PDPEs are
110 * programmed via register.
112 * GEN8 48b style address is defined as a 4 level page table:
113 * 47:39 | 38:30 | 29:21 | 20:12 | 11:0
114 * PML4E | PDPE | PDE | PTE | offset
116 #define GEN8_3LVL_PDPES 4
118 #define PPAT_UNCACHED (_PAGE_PWT | _PAGE_PCD)
119 #define PPAT_CACHED_PDE 0 /* WB LLC */
120 #define PPAT_CACHED _PAGE_PAT /* WB LLCeLLC */
121 #define PPAT_DISPLAY_ELLC _PAGE_PCD /* WT eLLC */
123 #define CHV_PPAT_SNOOP REG_BIT(6)
124 #define GEN8_PPAT_AGE(x) ((x)<<4)
125 #define GEN8_PPAT_LLCeLLC (3<<2)
126 #define GEN8_PPAT_LLCELLC (2<<2)
127 #define GEN8_PPAT_LLC (1<<2)
128 #define GEN8_PPAT_WB (3<<0)
129 #define GEN8_PPAT_WT (2<<0)
130 #define GEN8_PPAT_WC (1<<0)
131 #define GEN8_PPAT_UC (0<<0)
132 #define GEN8_PPAT_ELLC_OVERRIDE (0<<2)
133 #define GEN8_PPAT(i, x) ((u64)(x) << ((i) * 8))
135 #define GEN8_PDE_IPS_64K BIT(11)
136 #define GEN8_PDE_PS_2M BIT(7)
138 #define for_each_sgt_daddr(__dp, __iter, __sgt) \
139 __for_each_sgt_daddr(__dp, __iter, __sgt, I915_GTT_PAGE_SIZE)
141 struct i915_page_dma
{
147 * For gen6/gen7 only. This is the offset in the GGTT
148 * where the page directory entries for PPGTT begin
154 struct i915_page_scratch
{
155 struct i915_page_dma base
;
159 struct i915_page_table
{
160 struct i915_page_dma base
;
164 struct i915_page_directory
{
165 struct i915_page_table pt
;
170 #define __px_choose_expr(x, type, expr, other) \
171 __builtin_choose_expr( \
172 __builtin_types_compatible_p(typeof(x), type) || \
173 __builtin_types_compatible_p(typeof(x), const type), \
174 ({ type __x = (type)(x); expr; }), \
177 #define px_base(px) \
178 __px_choose_expr(px, struct i915_page_dma *, __x, \
179 __px_choose_expr(px, struct i915_page_scratch *, &__x->base, \
180 __px_choose_expr(px, struct i915_page_table *, &__x->base, \
181 __px_choose_expr(px, struct i915_page_directory *, &__x->pt.base, \
183 #define px_dma(px) (px_base(px)->daddr)
186 __px_choose_expr(px, struct i915_page_table *, __x, \
187 __px_choose_expr(px, struct i915_page_directory *, &__x->pt, \
189 #define px_used(px) (&px_pt(px)->used)
191 enum i915_cache_level
;
193 struct drm_i915_file_private
;
194 struct drm_i915_gem_object
;
198 struct i915_vma_ops
{
199 /* Map an object into an address space with the given cache flags. */
200 int (*bind_vma
)(struct i915_vma
*vma
,
201 enum i915_cache_level cache_level
,
204 * Unmap an object from an address space. This usually consists of
205 * setting the valid PTE entries to a reserved scratch page.
207 void (*unbind_vma
)(struct i915_vma
*vma
);
209 int (*set_pages
)(struct i915_vma
*vma
);
210 void (*clear_pages
)(struct i915_vma
*vma
);
218 void stash_init(struct pagestash
*stash
);
220 struct i915_address_space
{
226 struct drm_i915_private
*i915
;
229 * Every address space belongs to a struct file - except for the global
230 * GTT that is owned by the driver (and so @file is set to NULL). In
231 * principle, no information should leak from one context to another
232 * (or between files/processes etc) unless explicitly shared by the
233 * owner. Tracking the owner is important in order to free up per-file
234 * objects along with the file, to aide resource tracking, and to
237 struct drm_i915_file_private
*file
;
238 u64 total
; /* size addr space maps (ex. 2GB for ggtt) */
239 u64 reserved
; /* size addr space reserved */
241 unsigned int bind_async_flags
;
244 * Each active user context has its own address space (in full-ppgtt).
245 * Since the vm may be shared between multiple contexts, we count how
246 * many contexts keep us "open". Once open hits zero, we are closed
247 * and do not allow any new attachments, and proceed to shutdown our
248 * vma and page directories.
252 struct mutex mutex
; /* protects vma and our lists */
253 #define VM_CLASS_GGTT 0
254 #define VM_CLASS_PPGTT 1
256 struct i915_page_scratch scratch
[4];
257 unsigned int scratch_order
;
261 * List of vma currently bound.
263 struct list_head bound_list
;
265 struct pagestash free_pages
;
270 /* Some systems require uncached updates of the page directories */
273 /* Some systems support read-only mappings for GGTT and/or PPGTT */
274 bool has_read_only
:1;
276 u64 (*pte_encode
)(dma_addr_t addr
,
277 enum i915_cache_level level
,
278 u32 flags
); /* Create a valid PTE */
279 #define PTE_READ_ONLY BIT(0)
281 int (*allocate_va_range
)(struct i915_address_space
*vm
,
282 u64 start
, u64 length
);
283 void (*clear_range
)(struct i915_address_space
*vm
,
284 u64 start
, u64 length
);
285 void (*insert_page
)(struct i915_address_space
*vm
,
288 enum i915_cache_level cache_level
,
290 void (*insert_entries
)(struct i915_address_space
*vm
,
291 struct i915_vma
*vma
,
292 enum i915_cache_level cache_level
,
294 void (*cleanup
)(struct i915_address_space
*vm
);
296 struct i915_vma_ops vma_ops
;
298 I915_SELFTEST_DECLARE(struct fault_attr fault_attr
);
299 I915_SELFTEST_DECLARE(bool scrub_64K
);
303 * The Graphics Translation Table is the way in which GEN hardware translates a
304 * Graphics Virtual Address into a Physical Address. In addition to the normal
305 * collateral associated with any va->pa translations GEN hardware also has a
306 * portion of the GTT which can be mapped by the CPU and remain both coherent
307 * and correct (in cases like swizzling). That region is referred to as GMADR in
311 struct i915_address_space vm
;
313 struct io_mapping iomap
; /* Mapping to our CPU mappable region */
314 struct resource gmadr
; /* GMADR resource */
315 resource_size_t mappable_end
; /* End offset that we can CPU map */
317 /** "Graphics Stolen Memory" holds the global PTEs */
319 void (*invalidate
)(struct i915_ggtt
*ggtt
);
321 /** PPGTT used for aliasing the PPGTT with the GTT */
322 struct i915_ppgtt
*alias
;
328 /** Bit 6 swizzling required for X tiling */
330 /** Bit 6 swizzling required for Y tiling */
335 unsigned int num_fences
;
336 struct i915_fence_reg fence_regs
[I915_MAX_NUM_FENCES
];
337 struct list_head fence_list
;
340 * List of all objects in gtt_space, currently mmaped by userspace.
341 * All objects within this list must also be on bound_list.
343 struct list_head userfault_list
;
345 /* Manual runtime pm autosuspend delay for user GGTT mmaps */
346 struct intel_wakeref_auto userfault_wakeref
;
348 struct mutex error_mutex
;
349 struct drm_mm_node error_capture
;
350 struct drm_mm_node uc_fw
;
354 struct i915_address_space vm
;
356 struct i915_page_directory
*pd
;
359 #define i915_is_ggtt(vm) ((vm)->is_ggtt)
362 i915_vm_is_4lvl(const struct i915_address_space
*vm
)
364 return (vm
->total
- 1) >> 32;
368 i915_vm_has_scratch_64K(struct i915_address_space
*vm
)
370 return vm
->scratch_order
== get_order(I915_GTT_PAGE_SIZE_64K
);
374 i915_vm_has_cache_coloring(struct i915_address_space
*vm
)
376 return i915_is_ggtt(vm
) && vm
->mm
.color_adjust
;
379 static inline struct i915_ggtt
*
380 i915_vm_to_ggtt(struct i915_address_space
*vm
)
382 BUILD_BUG_ON(offsetof(struct i915_ggtt
, vm
));
383 GEM_BUG_ON(!i915_is_ggtt(vm
));
384 return container_of(vm
, struct i915_ggtt
, vm
);
387 static inline struct i915_ppgtt
*
388 i915_vm_to_ppgtt(struct i915_address_space
*vm
)
390 BUILD_BUG_ON(offsetof(struct i915_ppgtt
, vm
));
391 GEM_BUG_ON(i915_is_ggtt(vm
));
392 return container_of(vm
, struct i915_ppgtt
, vm
);
395 static inline struct i915_address_space
*
396 i915_vm_get(struct i915_address_space
*vm
)
402 void i915_vm_release(struct kref
*kref
);
404 static inline void i915_vm_put(struct i915_address_space
*vm
)
406 kref_put(&vm
->ref
, i915_vm_release
);
409 static inline struct i915_address_space
*
410 i915_vm_open(struct i915_address_space
*vm
)
412 GEM_BUG_ON(!atomic_read(&vm
->open
));
413 atomic_inc(&vm
->open
);
414 return i915_vm_get(vm
);
418 i915_vm_tryopen(struct i915_address_space
*vm
)
420 if (atomic_add_unless(&vm
->open
, 1, 0))
421 return i915_vm_get(vm
);
426 void __i915_vm_close(struct i915_address_space
*vm
);
429 i915_vm_close(struct i915_address_space
*vm
)
431 GEM_BUG_ON(!atomic_read(&vm
->open
));
432 if (atomic_dec_and_test(&vm
->open
))
438 void i915_address_space_init(struct i915_address_space
*vm
, int subclass
);
439 void i915_address_space_fini(struct i915_address_space
*vm
);
441 static inline u32
i915_pte_index(u64 address
, unsigned int pde_shift
)
443 const u32 mask
= NUM_PTE(pde_shift
) - 1;
445 return (address
>> PAGE_SHIFT
) & mask
;
449 * Helper to counts the number of PTEs within the given length. This count
450 * does not cross a page table boundary, so the max value would be
451 * GEN6_PTES for GEN6, and GEN8_PTES for GEN8.
453 static inline u32
i915_pte_count(u64 addr
, u64 length
, unsigned int pde_shift
)
455 const u64 mask
= ~((1ULL << pde_shift
) - 1);
458 GEM_BUG_ON(length
== 0);
459 GEM_BUG_ON(offset_in_page(addr
| length
));
463 if ((addr
& mask
) != (end
& mask
))
464 return NUM_PTE(pde_shift
) - i915_pte_index(addr
, pde_shift
);
466 return i915_pte_index(end
, pde_shift
) - i915_pte_index(addr
, pde_shift
);
469 static inline u32
i915_pde_index(u64 addr
, u32 shift
)
471 return (addr
>> shift
) & I915_PDE_MASK
;
474 static inline struct i915_page_table
*
475 i915_pt_entry(const struct i915_page_directory
* const pd
,
476 const unsigned short n
)
481 static inline struct i915_page_directory
*
482 i915_pd_entry(const struct i915_page_directory
* const pdp
,
483 const unsigned short n
)
485 return pdp
->entry
[n
];
488 static inline dma_addr_t
489 i915_page_dir_dma_addr(const struct i915_ppgtt
*ppgtt
, const unsigned int n
)
491 struct i915_page_dma
*pt
= ppgtt
->pd
->entry
[n
];
493 return px_dma(pt
?: px_base(&ppgtt
->vm
.scratch
[ppgtt
->vm
.top
]));
496 void ppgtt_init(struct i915_ppgtt
*ppgtt
, struct intel_gt
*gt
);
498 int i915_ggtt_probe_hw(struct drm_i915_private
*i915
);
499 int i915_ggtt_init_hw(struct drm_i915_private
*i915
);
500 int i915_ggtt_enable_hw(struct drm_i915_private
*i915
);
501 void i915_ggtt_enable_guc(struct i915_ggtt
*ggtt
);
502 void i915_ggtt_disable_guc(struct i915_ggtt
*ggtt
);
503 int i915_init_ggtt(struct drm_i915_private
*i915
);
504 void i915_ggtt_driver_release(struct drm_i915_private
*i915
);
506 static inline bool i915_ggtt_has_aperture(const struct i915_ggtt
*ggtt
)
508 return ggtt
->mappable_end
> 0;
511 int i915_ppgtt_init_hw(struct intel_gt
*gt
);
513 struct i915_ppgtt
*i915_ppgtt_create(struct intel_gt
*gt
);
515 void i915_gem_suspend_gtt_mappings(struct drm_i915_private
*i915
);
516 void i915_gem_restore_gtt_mappings(struct drm_i915_private
*i915
);
518 u64
gen8_pte_encode(dma_addr_t addr
,
519 enum i915_cache_level level
,
522 int setup_page_dma(struct i915_address_space
*vm
, struct i915_page_dma
*p
);
523 void cleanup_page_dma(struct i915_address_space
*vm
, struct i915_page_dma
*p
);
525 #define kmap_atomic_px(px) kmap_atomic(px_base(px)->page)
528 fill_page_dma(const struct i915_page_dma
*p
, const u64 val
, unsigned int count
);
530 #define fill_px(px, v) fill_page_dma(px_base(px), (v), PAGE_SIZE / sizeof(u64))
531 #define fill32_px(px, v) do { \
532 u64 v__ = lower_32_bits(v); \
533 fill_px((px), v__ << 32 | v__); \
536 int setup_scratch_page(struct i915_address_space
*vm
, gfp_t gfp
);
537 void cleanup_scratch_page(struct i915_address_space
*vm
);
538 void free_scratch(struct i915_address_space
*vm
);
540 struct i915_page_table
*alloc_pt(struct i915_address_space
*vm
);
541 struct i915_page_directory
*alloc_pd(struct i915_address_space
*vm
);
542 struct i915_page_directory
*__alloc_pd(size_t sz
);
544 void free_pd(struct i915_address_space
*vm
, struct i915_page_dma
*pd
);
546 #define free_px(vm, px) free_pd(vm, px_base(px))
549 __set_pd_entry(struct i915_page_directory
* const pd
,
550 const unsigned short idx
,
551 struct i915_page_dma
* const to
,
552 u64 (*encode
)(const dma_addr_t
, const enum i915_cache_level
));
554 #define set_pd_entry(pd, idx, to) \
555 __set_pd_entry((pd), (idx), px_base(to), gen8_pde_encode)
558 clear_pd_entry(struct i915_page_directory
* const pd
,
559 const unsigned short idx
,
560 const struct i915_page_scratch
* const scratch
);
563 release_pd_entry(struct i915_page_directory
* const pd
,
564 const unsigned short idx
,
565 struct i915_page_table
* const pt
,
566 const struct i915_page_scratch
* const scratch
);
567 void gen6_ggtt_invalidate(struct i915_ggtt
*ggtt
);
569 int ggtt_set_pages(struct i915_vma
*vma
);
570 int ppgtt_set_pages(struct i915_vma
*vma
);
571 void clear_pages(struct i915_vma
*vma
);
573 void gtt_write_workarounds(struct intel_gt
*gt
);
575 void setup_private_pat(struct intel_uncore
*uncore
);
577 static inline struct sgt_dma
{
578 struct scatterlist
*sg
;
580 } sgt_dma(struct i915_vma
*vma
) {
581 struct scatterlist
*sg
= vma
->pages
->sgl
;
582 dma_addr_t addr
= sg_dma_address(sg
);
584 return (struct sgt_dma
){ sg
, addr
, addr
+ sg
->length
};