]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/gpu/drm/i915/i915_gem_gtt.h
drm/i915: introduce page_sizes field to dev_info
[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / i915 / i915_gem_gtt.h
CommitLineData
0260c420
BW
1/*
2 * Copyright © 2014 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 * Please try to maintain the following order within this file unless it makes
24 * sense to do otherwise. From top to bottom:
25 * 1. typedefs
26 * 2. #defines, and macros
27 * 3. structure definitions
28 * 4. function prototypes
29 *
30 * Within each section, please try to order by generation in ascending order,
31 * from top to bottom (ie. gen6 on the top, gen8 on the bottom).
32 */
33
34#ifndef __I915_GEM_GTT_H__
35#define __I915_GEM_GTT_H__
36
8ef8561f 37#include <linux/io-mapping.h>
b42fe9ca 38#include <linux/mm.h>
8448661d 39#include <linux/pagevec.h>
8ef8561f 40
b42fe9ca 41#include "i915_gem_timeline.h"
b0decaf7 42#include "i915_gem_request.h"
8448661d 43#include "i915_selftest.h"
b0decaf7 44
2a9654b2
MA
45#define I915_GTT_PAGE_SIZE_4K BIT(12)
46#define I915_GTT_PAGE_SIZE_64K BIT(16)
47#define I915_GTT_PAGE_SIZE_2M BIT(21)
48
49#define I915_GTT_PAGE_SIZE I915_GTT_PAGE_SIZE_4K
50#define I915_GTT_MAX_PAGE_SIZE I915_GTT_PAGE_SIZE_2M
51
f51455d4
CW
52#define I915_GTT_MIN_ALIGNMENT I915_GTT_PAGE_SIZE
53
49ef5294
CW
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
58
4d884705 59struct drm_i915_file_private;
49ef5294 60struct drm_i915_fence_reg;
4d884705 61
75c7b0b8
CW
62typedef u32 gen6_pte_t;
63typedef u64 gen8_pte_t;
64typedef u64 gen8_pde_t;
65typedef u64 gen8_ppgtt_pdpe_t;
66typedef u64 gen8_ppgtt_pml4e_t;
0260c420 67
72e96d64 68#define ggtt_total_entries(ggtt) ((ggtt)->base.total >> PAGE_SHIFT)
0260c420 69
0260c420
BW
70/* gen6-hsw has bit 11-4 for physical addr bit 39-32 */
71#define GEN6_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0xff0))
72#define GEN6_PTE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
73#define GEN6_PDE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
74#define GEN6_PTE_CACHE_LLC (2 << 1)
75#define GEN6_PTE_UNCACHED (1 << 1)
76#define GEN6_PTE_VALID (1 << 0)
77
dd19674b 78#define I915_PTES(pte_len) ((unsigned int)(PAGE_SIZE / (pte_len)))
07749ef3
MT
79#define I915_PTE_MASK(pte_len) (I915_PTES(pte_len) - 1)
80#define I915_PDES 512
81#define I915_PDE_MASK (I915_PDES - 1)
678d96fb 82#define NUM_PTE(pde_shift) (1 << (pde_shift - PAGE_SHIFT))
07749ef3
MT
83
84#define GEN6_PTES I915_PTES(sizeof(gen6_pte_t))
85#define GEN6_PD_SIZE (I915_PDES * PAGE_SIZE)
0260c420 86#define GEN6_PD_ALIGN (PAGE_SIZE * 16)
678d96fb 87#define GEN6_PDE_SHIFT 22
0260c420
BW
88#define GEN6_PDE_VALID (1 << 0)
89
90#define GEN7_PTE_CACHE_L3_LLC (3 << 1)
91
92#define BYT_PTE_SNOOPED_BY_CPU_CACHES (1 << 2)
93#define BYT_PTE_WRITEABLE (1 << 1)
94
95/* Cacheability Control is a 4-bit value. The low three bits are stored in bits
96 * 3:1 of the PTE, while the fourth bit is stored in bit 11 of the PTE.
97 */
98#define HSW_CACHEABILITY_CONTROL(bits) ((((bits) & 0x7) << 1) | \
99 (((bits) & 0x8) << (11 - 3)))
100#define HSW_WB_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x2)
101#define HSW_WB_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x3)
102#define HSW_WB_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x8)
103#define HSW_WB_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0xb)
104#define HSW_WT_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x7)
105#define HSW_WT_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x6)
106#define HSW_PTE_UNCACHED (0)
107#define HSW_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0x7f0))
108#define HSW_PTE_ADDR_ENCODE(addr) HSW_GTT_ADDR_ENCODE(addr)
109
e7167769 110/* GEN8 32b style address is defined as a 3 level page table:
0260c420
BW
111 * 31:30 | 29:21 | 20:12 | 11:0
112 * PDPE | PDE | PTE | offset
113 * The difference as compared to normal x86 3 level page table is the PDPEs are
114 * programmed via register.
e7167769
MK
115 */
116#define GEN8_3LVL_PDPES 4
117#define GEN8_PDE_SHIFT 21
118#define GEN8_PDE_MASK 0x1ff
119#define GEN8_PTE_SHIFT 12
120#define GEN8_PTE_MASK 0x1ff
121#define GEN8_PTES I915_PTES(sizeof(gen8_pte_t))
122
123/* GEN8 48b style address is defined as a 4 level page table:
81ba8aef
MT
124 * 47:39 | 38:30 | 29:21 | 20:12 | 11:0
125 * PML4E | PDPE | PDE | PTE | offset
0260c420 126 */
81ba8aef
MT
127#define GEN8_PML4ES_PER_PML4 512
128#define GEN8_PML4E_SHIFT 39
762d9936 129#define GEN8_PML4E_MASK (GEN8_PML4ES_PER_PML4 - 1)
0260c420 130#define GEN8_PDPE_SHIFT 30
81ba8aef
MT
131/* NB: GEN8_PDPE_MASK is untrue for 32b platforms, but it has no impact on 32b page
132 * tables */
133#define GEN8_PDPE_MASK 0x1ff
0260c420 134
c095b97c
ZW
135#define PPAT_UNCACHED (_PAGE_PWT | _PAGE_PCD)
136#define PPAT_CACHED_PDE 0 /* WB LLC */
137#define PPAT_CACHED _PAGE_PAT /* WB LLCeLLC */
138#define PPAT_DISPLAY_ELLC _PAGE_PCD /* WT eLLC */
0260c420 139
ee0ce478 140#define CHV_PPAT_SNOOP (1<<6)
1790625b 141#define GEN8_PPAT_AGE(x) ((x)<<4)
0260c420
BW
142#define GEN8_PPAT_LLCeLLC (3<<2)
143#define GEN8_PPAT_LLCELLC (2<<2)
144#define GEN8_PPAT_LLC (1<<2)
145#define GEN8_PPAT_WB (3<<0)
146#define GEN8_PPAT_WT (2<<0)
147#define GEN8_PPAT_WC (1<<0)
148#define GEN8_PPAT_UC (0<<0)
149#define GEN8_PPAT_ELLC_OVERRIDE (0<<2)
75c7b0b8 150#define GEN8_PPAT(i, x) ((u64)(x) << ((i) * 8))
0260c420 151
4395890a
ZW
152#define GEN8_PPAT_GET_CA(x) ((x) & 3)
153#define GEN8_PPAT_GET_TC(x) ((x) & (3 << 2))
154#define GEN8_PPAT_GET_AGE(x) ((x) & (3 << 4))
155#define CHV_PPAT_GET_SNOOP(x) ((x) & (1 << 6))
156
b42fe9ca
JL
157struct sg_table;
158
50470bb0 159struct intel_rotation_info {
7ff19c56 160 struct intel_rotation_plane_info {
1663b9d6 161 /* tiles */
6687c906 162 unsigned int width, height, stride, offset;
1663b9d6 163 } plane[2];
8d9046ad
CW
164} __packed;
165
166static inline void assert_intel_rotation_info_is_packed(void)
167{
168 BUILD_BUG_ON(sizeof(struct intel_rotation_info) != 8*sizeof(unsigned int));
169}
fe14d5f4 170
7ff19c56
CW
171struct intel_partial_info {
172 u64 offset;
173 unsigned int size;
8d9046ad
CW
174} __packed;
175
176static inline void assert_intel_partial_info_is_packed(void)
177{
178 BUILD_BUG_ON(sizeof(struct intel_partial_info) != sizeof(u64) + sizeof(unsigned int));
179}
7ff19c56 180
992e418d
CW
181enum i915_ggtt_view_type {
182 I915_GGTT_VIEW_NORMAL = 0,
183 I915_GGTT_VIEW_ROTATED = sizeof(struct intel_rotation_info),
184 I915_GGTT_VIEW_PARTIAL = sizeof(struct intel_partial_info),
185};
186
187static inline void assert_i915_ggtt_view_type_is_unique(void)
188{
189 /* As we encode the size of each branch inside the union into its type,
190 * we have to be careful that each branch has a unique size.
191 */
192 switch ((enum i915_ggtt_view_type)0) {
193 case I915_GGTT_VIEW_NORMAL:
194 case I915_GGTT_VIEW_PARTIAL:
195 case I915_GGTT_VIEW_ROTATED:
196 /* gcc complains if these are identical cases */
197 break;
198 }
199}
200
fe14d5f4
TU
201struct i915_ggtt_view {
202 enum i915_ggtt_view_type type;
8bd7ef16 203 union {
992e418d 204 /* Members need to contain no holes/padding */
7ff19c56 205 struct intel_partial_info partial;
7723f47d 206 struct intel_rotation_info rotated;
8bab1193 207 };
fe14d5f4
TU
208};
209
0260c420 210enum i915_cache_level;
fe14d5f4 211
b42fe9ca 212struct i915_vma;
bde13ebd 213
44159ddb 214struct i915_page_dma {
d7b3de91 215 struct page *page;
44159ddb
MK
216 union {
217 dma_addr_t daddr;
218
219 /* For gen6/gen7 only. This is the offset in the GGTT
220 * where the page directory entries for PPGTT begin
221 */
75c7b0b8 222 u32 ggtt_offset;
44159ddb
MK
223 };
224};
225
567047be
MK
226#define px_base(px) (&(px)->base)
227#define px_page(px) (px_base(px)->page)
228#define px_dma(px) (px_base(px)->daddr)
229
44159ddb
MK
230struct i915_page_table {
231 struct i915_page_dma base;
dd19674b 232 unsigned int used_ptes;
d7b3de91
BW
233};
234
ec565b3c 235struct i915_page_directory {
44159ddb 236 struct i915_page_dma base;
7324cc04 237
ec565b3c 238 struct i915_page_table *page_table[I915_PDES]; /* PDEs */
fe52e37f 239 unsigned int used_pdes;
d7b3de91
BW
240};
241
ec565b3c 242struct i915_page_directory_pointer {
6ac18502 243 struct i915_page_dma base;
6ac18502 244 struct i915_page_directory **page_directory;
e2b763ca 245 unsigned int used_pdpes;
d7b3de91
BW
246};
247
81ba8aef
MT
248struct i915_pml4 {
249 struct i915_page_dma base;
81ba8aef
MT
250 struct i915_page_directory_pointer *pdps[GEN8_PML4ES_PER_PML4];
251};
252
0260c420
BW
253struct i915_address_space {
254 struct drm_mm mm;
80b204bc 255 struct i915_gem_timeline timeline;
49d73912 256 struct drm_i915_private *i915;
8448661d 257 struct device *dma;
2bfa996e
CW
258 /* Every address space belongs to a struct file - except for the global
259 * GTT that is owned by the driver (and so @file is set to NULL). In
260 * principle, no information should leak from one context to another
261 * (or between files/processes etc) unless explicitly shared by the
262 * owner. Tracking the owner is important in order to free up per-file
263 * objects along with the file, to aide resource tracking, and to
264 * assign blame.
265 */
266 struct drm_i915_file_private *file;
0260c420 267 struct list_head global_link;
c44ef60e 268 u64 total; /* size addr space maps (ex. 2GB for ggtt) */
ff8f7975 269 u64 reserved; /* size addr space reserved */
0260c420 270
50e046b6
CW
271 bool closed;
272
8bcdd0f7 273 struct i915_page_dma scratch_page;
79ab9370
MK
274 struct i915_page_table *scratch_pt;
275 struct i915_page_directory *scratch_pd;
69ab76fd 276 struct i915_page_directory_pointer *scratch_pdp; /* GEN8+ & 48b PPGTT */
0260c420
BW
277
278 /**
279 * List of objects currently involved in rendering.
280 *
281 * Includes buffers having the contents of their GPU caches
97b2a6a1 282 * flushed, not necessarily primitives. last_read_req
0260c420
BW
283 * represents when the rendering involved will be completed.
284 *
285 * A reference is held on the buffer while on this list.
286 */
287 struct list_head active_list;
288
289 /**
290 * LRU list of objects which are not in the ringbuffer and
291 * are ready to unbind, but are still in the GTT.
292 *
97b2a6a1 293 * last_read_req is NULL while an object is in this list.
0260c420
BW
294 *
295 * A reference is not held on the buffer while on this list,
296 * as merely being GTT-bound shouldn't prevent its being
297 * freed, and we'll pull it off the list in the free path.
298 */
299 struct list_head inactive_list;
300
50e046b6
CW
301 /**
302 * List of vma that have been unbound.
303 *
304 * A reference is not held on the buffer while on this list.
305 */
306 struct list_head unbound_list;
307
8448661d
CW
308 struct pagevec free_pages;
309 bool pt_kmap_wc;
310
0260c420 311 /* FIXME: Need a more generic return type */
07749ef3
MT
312 gen6_pte_t (*pte_encode)(dma_addr_t addr,
313 enum i915_cache_level level,
4fb84d99 314 u32 flags); /* Create a valid PTE */
f329f5f6
DV
315 /* flags for pte_encode */
316#define PTE_READ_ONLY (1<<0)
678d96fb 317 int (*allocate_va_range)(struct i915_address_space *vm,
75c7b0b8 318 u64 start, u64 length);
0260c420 319 void (*clear_range)(struct i915_address_space *vm,
75c7b0b8 320 u64 start, u64 length);
d6473f56
CW
321 void (*insert_page)(struct i915_address_space *vm,
322 dma_addr_t addr,
75c7b0b8 323 u64 offset,
d6473f56
CW
324 enum i915_cache_level cache_level,
325 u32 flags);
0260c420 326 void (*insert_entries)(struct i915_address_space *vm,
4a234c5f 327 struct i915_vma *vma,
75c7b0b8
CW
328 enum i915_cache_level cache_level,
329 u32 flags);
0260c420 330 void (*cleanup)(struct i915_address_space *vm);
777dc5bb
DV
331 /** Unmap an object from an address space. This usually consists of
332 * setting the valid PTE entries to a reserved scratch page. */
333 void (*unbind_vma)(struct i915_vma *vma);
334 /* Map an object into an address space with the given cache flags. */
70b9f6f8
DV
335 int (*bind_vma)(struct i915_vma *vma,
336 enum i915_cache_level cache_level,
337 u32 flags);
8448661d
CW
338
339 I915_SELFTEST_DECLARE(struct fault_attr fault_attr);
0260c420
BW
340};
341
2bfa996e 342#define i915_is_ggtt(V) (!(V)->file)
596c5923 343
3e490042
MK
344static inline bool
345i915_vm_is_48bit(const struct i915_address_space *vm)
346{
347 return (vm->total - 1) >> 32;
348}
349
0260c420
BW
350/* The Graphics Translation Table is the way in which GEN hardware translates a
351 * Graphics Virtual Address into a Physical Address. In addition to the normal
352 * collateral associated with any va->pa translations GEN hardware also has a
353 * portion of the GTT which can be mapped by the CPU and remain both coherent
354 * and correct (in cases like swizzling). That region is referred to as GMADR in
355 * the spec.
356 */
62106b4f 357struct i915_ggtt {
0260c420 358 struct i915_address_space base;
f7bbe788 359 struct io_mapping mappable; /* Mapping to our CPU mappable region */
0260c420 360
edd1f2fe
CW
361 phys_addr_t mappable_base; /* PA of our GMADR */
362 u64 mappable_end; /* End offset that we can CPU map */
363
3c6b29b2
PZ
364 /* Stolen memory is segmented in hardware with different portions
365 * offlimits to certain functions.
366 *
367 * The drm_mm is initialised to the total accessible range, as found
368 * from the PCI config. On Broadwell+, this is further restricted to
369 * avoid the first page! The upper end of stolen memory is reserved for
370 * hardware functions and similarly removed from the accessible range.
371 */
edd1f2fe
CW
372 u32 stolen_size; /* Total size of stolen memory */
373 u32 stolen_usable_size; /* Total size minus reserved ranges */
374 u32 stolen_reserved_base;
375 u32 stolen_reserved_size;
0260c420
BW
376
377 /** "Graphics Stolen Memory" holds the global PTEs */
378 void __iomem *gsm;
7c3f86b6 379 void (*invalidate)(struct drm_i915_private *dev_priv);
0260c420
BW
380
381 bool do_idle_maps;
382
383 int mtrr;
95374d75
CW
384
385 struct drm_mm_node error_capture;
0260c420
BW
386};
387
388struct i915_hw_ppgtt {
389 struct i915_address_space base;
390 struct kref ref;
391 struct drm_mm_node node;
563222a7 392 unsigned long pd_dirty_rings;
d7b3de91 393 union {
81ba8aef
MT
394 struct i915_pml4 pml4; /* GEN8+ & 48b PPGTT */
395 struct i915_page_directory_pointer pdp; /* GEN8+ */
396 struct i915_page_directory pd; /* GEN6-7 */
d7b3de91 397 };
0260c420 398
678d96fb
BW
399 gen6_pte_t __iomem *pd_addr;
400
0260c420 401 int (*switch_mm)(struct i915_hw_ppgtt *ppgtt,
e85b26dc 402 struct drm_i915_gem_request *req);
0260c420
BW
403 void (*debug_dump)(struct i915_hw_ppgtt *ppgtt, struct seq_file *m);
404};
405
731f74c5
DG
406/*
407 * gen6_for_each_pde() iterates over every pde from start until start+length.
408 * If start and start+length are not perfectly divisible, the macro will round
409 * down and up as needed. Start=0 and length=2G effectively iterates over
410 * every PDE in the system. The macro modifies ALL its parameters except 'pd',
411 * so each of the other parameters should preferably be a simple variable, or
412 * at most an lvalue with no side-effects!
678d96fb 413 */
731f74c5
DG
414#define gen6_for_each_pde(pt, pd, start, length, iter) \
415 for (iter = gen6_pde_index(start); \
416 length > 0 && iter < I915_PDES && \
417 (pt = (pd)->page_table[iter], true); \
418 ({ u32 temp = ALIGN(start+1, 1 << GEN6_PDE_SHIFT); \
419 temp = min(temp - start, length); \
420 start += temp, length -= temp; }), ++iter)
421
422#define gen6_for_all_pdes(pt, pd, iter) \
423 for (iter = 0; \
424 iter < I915_PDES && \
425 (pt = (pd)->page_table[iter], true); \
426 ++iter)
09942c65 427
75c7b0b8 428static inline u32 i915_pte_index(u64 address, unsigned int pde_shift)
678d96fb 429{
75c7b0b8 430 const u32 mask = NUM_PTE(pde_shift) - 1;
678d96fb
BW
431
432 return (address >> PAGE_SHIFT) & mask;
433}
434
435/* Helper to counts the number of PTEs within the given length. This count
436 * does not cross a page table boundary, so the max value would be
437 * GEN6_PTES for GEN6, and GEN8_PTES for GEN8.
438*/
75c7b0b8 439static inline u32 i915_pte_count(u64 addr, u64 length, unsigned int pde_shift)
678d96fb 440{
75c7b0b8
CW
441 const u64 mask = ~((1ULL << pde_shift) - 1);
442 u64 end;
678d96fb
BW
443
444 WARN_ON(length == 0);
445 WARN_ON(offset_in_page(addr|length));
446
447 end = addr + length;
448
449 if ((addr & mask) != (end & mask))
450 return NUM_PTE(pde_shift) - i915_pte_index(addr, pde_shift);
451
452 return i915_pte_index(end, pde_shift) - i915_pte_index(addr, pde_shift);
453}
454
75c7b0b8 455static inline u32 i915_pde_index(u64 addr, u32 shift)
678d96fb
BW
456{
457 return (addr >> shift) & I915_PDE_MASK;
458}
459
75c7b0b8 460static inline u32 gen6_pte_index(u32 addr)
678d96fb
BW
461{
462 return i915_pte_index(addr, GEN6_PDE_SHIFT);
463}
464
75c7b0b8 465static inline u32 gen6_pte_count(u32 addr, u32 length)
678d96fb
BW
466{
467 return i915_pte_count(addr, length, GEN6_PDE_SHIFT);
468}
469
75c7b0b8 470static inline u32 gen6_pde_index(u32 addr)
678d96fb
BW
471{
472 return i915_pde_index(addr, GEN6_PDE_SHIFT);
473}
474
3e490042
MK
475static inline unsigned int
476i915_pdpes_per_pdp(const struct i915_address_space *vm)
477{
478 if (i915_vm_is_48bit(vm))
479 return GEN8_PML4ES_PER_PML4;
480
e7167769 481 return GEN8_3LVL_PDPES;
3e490042
MK
482}
483
9271d959
MT
484/* Equivalent to the gen6 version, For each pde iterates over every pde
485 * between from start until start + length. On gen8+ it simply iterates
486 * over every page directory entry in a page directory.
487 */
e8ebd8e2
DG
488#define gen8_for_each_pde(pt, pd, start, length, iter) \
489 for (iter = gen8_pde_index(start); \
490 length > 0 && iter < I915_PDES && \
491 (pt = (pd)->page_table[iter], true); \
492 ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDE_SHIFT); \
493 temp = min(temp - start, length); \
494 start += temp, length -= temp; }), ++iter)
495
496#define gen8_for_each_pdpe(pd, pdp, start, length, iter) \
497 for (iter = gen8_pdpe_index(start); \
3e490042 498 length > 0 && iter < i915_pdpes_per_pdp(vm) && \
e8ebd8e2
DG
499 (pd = (pdp)->page_directory[iter], true); \
500 ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDPE_SHIFT); \
501 temp = min(temp - start, length); \
502 start += temp, length -= temp; }), ++iter)
503
504#define gen8_for_each_pml4e(pdp, pml4, start, length, iter) \
505 for (iter = gen8_pml4e_index(start); \
506 length > 0 && iter < GEN8_PML4ES_PER_PML4 && \
507 (pdp = (pml4)->pdps[iter], true); \
508 ({ u64 temp = ALIGN(start+1, 1ULL << GEN8_PML4E_SHIFT); \
509 temp = min(temp - start, length); \
510 start += temp, length -= temp; }), ++iter)
762d9936 511
75c7b0b8 512static inline u32 gen8_pte_index(u64 address)
9271d959
MT
513{
514 return i915_pte_index(address, GEN8_PDE_SHIFT);
515}
516
75c7b0b8 517static inline u32 gen8_pde_index(u64 address)
9271d959
MT
518{
519 return i915_pde_index(address, GEN8_PDE_SHIFT);
520}
521
75c7b0b8 522static inline u32 gen8_pdpe_index(u64 address)
9271d959
MT
523{
524 return (address >> GEN8_PDPE_SHIFT) & GEN8_PDPE_MASK;
525}
526
75c7b0b8 527static inline u32 gen8_pml4e_index(u64 address)
9271d959 528{
762d9936 529 return (address >> GEN8_PML4E_SHIFT) & GEN8_PML4E_MASK;
9271d959
MT
530}
531
75c7b0b8 532static inline u64 gen8_pte_count(u64 address, u64 length)
33c8819f
MT
533{
534 return i915_pte_count(address, length, GEN8_PDE_SHIFT);
535}
536
d852c7bf
MK
537static inline dma_addr_t
538i915_page_dir_dma_addr(const struct i915_hw_ppgtt *ppgtt, const unsigned n)
539{
fe52e37f 540 return px_dma(ppgtt->pdp.page_directory[n]);
d852c7bf
MK
541}
542
b42fe9ca
JL
543static inline struct i915_ggtt *
544i915_vm_to_ggtt(struct i915_address_space *vm)
545{
546 GEM_BUG_ON(!i915_is_ggtt(vm));
547 return container_of(vm, struct i915_ggtt, base);
548}
549
4395890a
ZW
550#define INTEL_MAX_PPAT_ENTRIES 8
551#define INTEL_PPAT_PERFECT_MATCH (~0U)
552
553struct intel_ppat;
554
555struct intel_ppat_entry {
556 struct intel_ppat *ppat;
557 struct kref ref;
558 u8 value;
559};
560
561struct intel_ppat {
562 struct intel_ppat_entry entries[INTEL_MAX_PPAT_ENTRIES];
563 DECLARE_BITMAP(used, INTEL_MAX_PPAT_ENTRIES);
564 DECLARE_BITMAP(dirty, INTEL_MAX_PPAT_ENTRIES);
565 unsigned int max_entries;
566 u8 clear_value;
567 /*
568 * Return a score to show how two PPAT values match,
569 * a INTEL_PPAT_PERFECT_MATCH indicates a perfect match
570 */
571 unsigned int (*match)(u8 src, u8 dst);
572 void (*update_hw)(struct drm_i915_private *i915);
573
574 struct drm_i915_private *i915;
575};
576
577const struct intel_ppat_entry *
578intel_ppat_get(struct drm_i915_private *i915, u8 value);
579void intel_ppat_put(const struct intel_ppat_entry *entry);
580
6cde9a02
CW
581int i915_gem_init_aliasing_ppgtt(struct drm_i915_private *i915);
582void i915_gem_fini_aliasing_ppgtt(struct drm_i915_private *i915);
583
97d6d7ab
CW
584int i915_ggtt_probe_hw(struct drm_i915_private *dev_priv);
585int i915_ggtt_init_hw(struct drm_i915_private *dev_priv);
586int i915_ggtt_enable_hw(struct drm_i915_private *dev_priv);
7c3f86b6
CW
587void i915_ggtt_enable_guc(struct drm_i915_private *i915);
588void i915_ggtt_disable_guc(struct drm_i915_private *i915);
f6b9d5ca 589int i915_gem_init_ggtt(struct drm_i915_private *dev_priv);
97d6d7ab 590void i915_ggtt_cleanup_hw(struct drm_i915_private *dev_priv);
ee960be7 591
c6be607a 592int i915_ppgtt_init_hw(struct drm_i915_private *dev_priv);
ee960be7 593void i915_ppgtt_release(struct kref *kref);
2bfa996e 594struct i915_hw_ppgtt *i915_ppgtt_create(struct drm_i915_private *dev_priv,
80b204bc
CW
595 struct drm_i915_file_private *fpriv,
596 const char *name);
0c7eeda1 597void i915_ppgtt_close(struct i915_address_space *vm);
ee960be7
DV
598static inline void i915_ppgtt_get(struct i915_hw_ppgtt *ppgtt)
599{
600 if (ppgtt)
601 kref_get(&ppgtt->ref);
602}
603static inline void i915_ppgtt_put(struct i915_hw_ppgtt *ppgtt)
604{
605 if (ppgtt)
606 kref_put(&ppgtt->ref, i915_ppgtt_release);
607}
0260c420 608
dc97997a 609void i915_check_and_clear_faults(struct drm_i915_private *dev_priv);
275a991c
TU
610void i915_gem_suspend_gtt_mappings(struct drm_i915_private *dev_priv);
611void i915_gem_restore_gtt_mappings(struct drm_i915_private *dev_priv);
0260c420 612
03ac84f1
CW
613int __must_check i915_gem_gtt_prepare_pages(struct drm_i915_gem_object *obj,
614 struct sg_table *pages);
615void i915_gem_gtt_finish_pages(struct drm_i915_gem_object *obj,
616 struct sg_table *pages);
0260c420 617
625d988a
CW
618int i915_gem_gtt_reserve(struct i915_address_space *vm,
619 struct drm_mm_node *node,
620 u64 size, u64 offset, unsigned long color,
621 unsigned int flags);
622
e007b19d
CW
623int i915_gem_gtt_insert(struct i915_address_space *vm,
624 struct drm_mm_node *node,
625 u64 size, u64 alignment, unsigned long color,
626 u64 start, u64 end, unsigned int flags);
627
59bfa124 628/* Flags used by pin/bind&friends. */
305bc234
CW
629#define PIN_NONBLOCK BIT(0)
630#define PIN_MAPPABLE BIT(1)
631#define PIN_ZONE_4G BIT(2)
82118877 632#define PIN_NONFAULT BIT(3)
616d9cee 633#define PIN_NOEVICT BIT(4)
305bc234
CW
634
635#define PIN_MBZ BIT(5) /* I915_VMA_PIN_OVERFLOW */
636#define PIN_GLOBAL BIT(6) /* I915_VMA_GLOBAL_BIND */
637#define PIN_USER BIT(7) /* I915_VMA_LOCAL_BIND */
638#define PIN_UPDATE BIT(8)
639
640#define PIN_HIGH BIT(9)
641#define PIN_OFFSET_BIAS BIT(10)
642#define PIN_OFFSET_FIXED BIT(11)
f51455d4 643#define PIN_OFFSET_MASK (-I915_GTT_PAGE_SIZE)
59bfa124 644
0260c420 645#endif