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 
37 #include <linux/io-mapping.h>
38 #include <linux/mm.h>
39 #include <linux/pagevec.h>
40 
41 #include "i915_request.h"
42 #include "i915_selftest.h"
43 #include "i915_timeline.h"
44 
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 
52 #define I915_GTT_MIN_ALIGNMENT I915_GTT_PAGE_SIZE
53 
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 
59 struct drm_i915_file_private;
60 struct drm_i915_fence_reg;
61 struct i915_vma;
62 
63 typedef u32 gen6_pte_t;
64 typedef u64 gen8_pte_t;
65 typedef u64 gen8_pde_t;
66 typedef u64 gen8_ppgtt_pdpe_t;
67 typedef u64 gen8_ppgtt_pml4e_t;
68 
69 #define ggtt_total_entries(ggtt) ((ggtt)->vm.total >> PAGE_SHIFT)
70 
71 /* gen6-hsw has bit 11-4 for physical addr bit 39-32 */
72 #define GEN6_GTT_ADDR_ENCODE(addr)	((addr) | (((addr) >> 28) & 0xff0))
73 #define GEN6_PTE_ADDR_ENCODE(addr)	GEN6_GTT_ADDR_ENCODE(addr)
74 #define GEN6_PDE_ADDR_ENCODE(addr)	GEN6_GTT_ADDR_ENCODE(addr)
75 #define GEN6_PTE_CACHE_LLC		(2 << 1)
76 #define GEN6_PTE_UNCACHED		(1 << 1)
77 #define GEN6_PTE_VALID			(1 << 0)
78 
79 #define I915_PTES(pte_len)		((unsigned int)(PAGE_SIZE / (pte_len)))
80 #define I915_PTE_MASK(pte_len)		(I915_PTES(pte_len) - 1)
81 #define I915_PDES			512
82 #define I915_PDE_MASK			(I915_PDES - 1)
83 #define NUM_PTE(pde_shift)     (1 << (pde_shift - PAGE_SHIFT))
84 
85 #define GEN6_PTES			I915_PTES(sizeof(gen6_pte_t))
86 #define GEN6_PD_SIZE		        (I915_PDES * PAGE_SIZE)
87 #define GEN6_PD_ALIGN			(PAGE_SIZE * 16)
88 #define GEN6_PDE_SHIFT			22
89 #define GEN6_PDE_VALID			(1 << 0)
90 
91 #define GEN7_PTE_CACHE_L3_LLC		(3 << 1)
92 
93 #define BYT_PTE_SNOOPED_BY_CPU_CACHES	(1 << 2)
94 #define BYT_PTE_WRITEABLE		(1 << 1)
95 
96 /* Cacheability Control is a 4-bit value. The low three bits are stored in bits
97  * 3:1 of the PTE, while the fourth bit is stored in bit 11 of the PTE.
98  */
99 #define HSW_CACHEABILITY_CONTROL(bits)	((((bits) & 0x7) << 1) | \
100 					 (((bits) & 0x8) << (11 - 3)))
101 #define HSW_WB_LLC_AGE3			HSW_CACHEABILITY_CONTROL(0x2)
102 #define HSW_WB_LLC_AGE0			HSW_CACHEABILITY_CONTROL(0x3)
103 #define HSW_WB_ELLC_LLC_AGE3		HSW_CACHEABILITY_CONTROL(0x8)
104 #define HSW_WB_ELLC_LLC_AGE0		HSW_CACHEABILITY_CONTROL(0xb)
105 #define HSW_WT_ELLC_LLC_AGE3		HSW_CACHEABILITY_CONTROL(0x7)
106 #define HSW_WT_ELLC_LLC_AGE0		HSW_CACHEABILITY_CONTROL(0x6)
107 #define HSW_PTE_UNCACHED		(0)
108 #define HSW_GTT_ADDR_ENCODE(addr)	((addr) | (((addr) >> 28) & 0x7f0))
109 #define HSW_PTE_ADDR_ENCODE(addr)	HSW_GTT_ADDR_ENCODE(addr)
110 
111 /* GEN8 32b style address is defined as a 3 level page table:
112  * 31:30 | 29:21 | 20:12 |  11:0
113  * PDPE  |  PDE  |  PTE  | offset
114  * The difference as compared to normal x86 3 level page table is the PDPEs are
115  * programmed via register.
116  */
117 #define GEN8_3LVL_PDPES			4
118 #define GEN8_PDE_SHIFT			21
119 #define GEN8_PDE_MASK			0x1ff
120 #define GEN8_PTE_SHIFT			12
121 #define GEN8_PTE_MASK			0x1ff
122 #define GEN8_PTES			I915_PTES(sizeof(gen8_pte_t))
123 
124 /* GEN8 48b style address is defined as a 4 level page table:
125  * 47:39 | 38:30 | 29:21 | 20:12 |  11:0
126  * PML4E | PDPE  |  PDE  |  PTE  | offset
127  */
128 #define GEN8_PML4ES_PER_PML4		512
129 #define GEN8_PML4E_SHIFT		39
130 #define GEN8_PML4E_MASK			(GEN8_PML4ES_PER_PML4 - 1)
131 #define GEN8_PDPE_SHIFT			30
132 /* NB: GEN8_PDPE_MASK is untrue for 32b platforms, but it has no impact on 32b page
133  * tables */
134 #define GEN8_PDPE_MASK			0x1ff
135 
136 #define PPAT_UNCACHED			(_PAGE_PWT | _PAGE_PCD)
137 #define PPAT_CACHED_PDE			0 /* WB LLC */
138 #define PPAT_CACHED			_PAGE_PAT /* WB LLCeLLC */
139 #define PPAT_DISPLAY_ELLC		_PAGE_PCD /* WT eLLC */
140 
141 #define CHV_PPAT_SNOOP			(1<<6)
142 #define GEN8_PPAT_AGE(x)		((x)<<4)
143 #define GEN8_PPAT_LLCeLLC		(3<<2)
144 #define GEN8_PPAT_LLCELLC		(2<<2)
145 #define GEN8_PPAT_LLC			(1<<2)
146 #define GEN8_PPAT_WB			(3<<0)
147 #define GEN8_PPAT_WT			(2<<0)
148 #define GEN8_PPAT_WC			(1<<0)
149 #define GEN8_PPAT_UC			(0<<0)
150 #define GEN8_PPAT_ELLC_OVERRIDE		(0<<2)
151 #define GEN8_PPAT(i, x)			((u64)(x) << ((i) * 8))
152 
153 #define GEN8_PPAT_GET_CA(x) ((x) & 3)
154 #define GEN8_PPAT_GET_TC(x) ((x) & (3 << 2))
155 #define GEN8_PPAT_GET_AGE(x) ((x) & (3 << 4))
156 #define CHV_PPAT_GET_SNOOP(x) ((x) & (1 << 6))
157 
158 #define GEN8_PDE_IPS_64K BIT(11)
159 #define GEN8_PDE_PS_2M   BIT(7)
160 
161 struct sg_table;
162 
163 struct intel_rotation_info {
164 	struct intel_rotation_plane_info {
165 		/* tiles */
166 		unsigned int width, height, stride, offset;
167 	} plane[2];
168 } __packed;
169 
170 struct intel_partial_info {
171 	u64 offset;
172 	unsigned int size;
173 } __packed;
174 
175 enum i915_ggtt_view_type {
176 	I915_GGTT_VIEW_NORMAL = 0,
177 	I915_GGTT_VIEW_ROTATED = sizeof(struct intel_rotation_info),
178 	I915_GGTT_VIEW_PARTIAL = sizeof(struct intel_partial_info),
179 };
180 
181 static inline void assert_i915_gem_gtt_types(void)
182 {
183 	BUILD_BUG_ON(sizeof(struct intel_rotation_info) != 8*sizeof(unsigned int));
184 	BUILD_BUG_ON(sizeof(struct intel_partial_info) != sizeof(u64) + sizeof(unsigned int));
185 
186 	/* As we encode the size of each branch inside the union into its type,
187 	 * we have to be careful that each branch has a unique size.
188 	 */
189 	switch ((enum i915_ggtt_view_type)0) {
190 	case I915_GGTT_VIEW_NORMAL:
191 	case I915_GGTT_VIEW_PARTIAL:
192 	case I915_GGTT_VIEW_ROTATED:
193 		/* gcc complains if these are identical cases */
194 		break;
195 	}
196 }
197 
198 struct i915_ggtt_view {
199 	enum i915_ggtt_view_type type;
200 	union {
201 		/* Members need to contain no holes/padding */
202 		struct intel_partial_info partial;
203 		struct intel_rotation_info rotated;
204 	};
205 };
206 
207 enum i915_cache_level;
208 
209 struct i915_vma;
210 
211 struct i915_page_dma {
212 	struct page *page;
213 	int order;
214 	union {
215 		dma_addr_t daddr;
216 
217 		/* For gen6/gen7 only. This is the offset in the GGTT
218 		 * where the page directory entries for PPGTT begin
219 		 */
220 		u32 ggtt_offset;
221 	};
222 };
223 
224 #define px_base(px) (&(px)->base)
225 #define px_dma(px) (px_base(px)->daddr)
226 
227 struct i915_page_table {
228 	struct i915_page_dma base;
229 	unsigned int used_ptes;
230 };
231 
232 struct i915_page_directory {
233 	struct i915_page_dma base;
234 
235 	struct i915_page_table *page_table[I915_PDES]; /* PDEs */
236 	unsigned int used_pdes;
237 };
238 
239 struct i915_page_directory_pointer {
240 	struct i915_page_dma base;
241 	struct i915_page_directory **page_directory;
242 	unsigned int used_pdpes;
243 };
244 
245 struct i915_pml4 {
246 	struct i915_page_dma base;
247 	struct i915_page_directory_pointer *pdps[GEN8_PML4ES_PER_PML4];
248 };
249 
250 struct i915_vma_ops {
251 	/* Map an object into an address space with the given cache flags. */
252 	int (*bind_vma)(struct i915_vma *vma,
253 			enum i915_cache_level cache_level,
254 			u32 flags);
255 	/*
256 	 * Unmap an object from an address space. This usually consists of
257 	 * setting the valid PTE entries to a reserved scratch page.
258 	 */
259 	void (*unbind_vma)(struct i915_vma *vma);
260 
261 	int (*set_pages)(struct i915_vma *vma);
262 	void (*clear_pages)(struct i915_vma *vma);
263 };
264 
265 struct pagestash {
266 	spinlock_t lock;
267 	struct pagevec pvec;
268 };
269 
270 struct i915_address_space {
271 	struct drm_mm mm;
272 	struct drm_i915_private *i915;
273 	struct device *dma;
274 	/* Every address space belongs to a struct file - except for the global
275 	 * GTT that is owned by the driver (and so @file is set to NULL). In
276 	 * principle, no information should leak from one context to another
277 	 * (or between files/processes etc) unless explicitly shared by the
278 	 * owner. Tracking the owner is important in order to free up per-file
279 	 * objects along with the file, to aide resource tracking, and to
280 	 * assign blame.
281 	 */
282 	struct drm_i915_file_private *file;
283 	u64 total;		/* size addr space maps (ex. 2GB for ggtt) */
284 	u64 reserved;		/* size addr space reserved */
285 
286 	bool closed;
287 
288 	struct mutex mutex; /* protects vma and our lists */
289 
290 	struct i915_page_dma scratch_page;
291 	struct i915_page_table *scratch_pt;
292 	struct i915_page_directory *scratch_pd;
293 	struct i915_page_directory_pointer *scratch_pdp; /* GEN8+ & 48b PPGTT */
294 
295 	/**
296 	 * List of objects currently involved in rendering.
297 	 *
298 	 * Includes buffers having the contents of their GPU caches
299 	 * flushed, not necessarily primitives. last_read_req
300 	 * represents when the rendering involved will be completed.
301 	 *
302 	 * A reference is held on the buffer while on this list.
303 	 */
304 	struct list_head active_list;
305 
306 	/**
307 	 * LRU list of objects which are not in the ringbuffer and
308 	 * are ready to unbind, but are still in the GTT.
309 	 *
310 	 * last_read_req is NULL while an object is in this list.
311 	 *
312 	 * A reference is not held on the buffer while on this list,
313 	 * as merely being GTT-bound shouldn't prevent its being
314 	 * freed, and we'll pull it off the list in the free path.
315 	 */
316 	struct list_head inactive_list;
317 
318 	/**
319 	 * List of vma that have been unbound.
320 	 *
321 	 * A reference is not held on the buffer while on this list.
322 	 */
323 	struct list_head unbound_list;
324 
325 	struct pagestash free_pages;
326 
327 	/* Global GTT */
328 	bool is_ggtt:1;
329 
330 	/* Some systems require uncached updates of the page directories */
331 	bool pt_kmap_wc:1;
332 
333 	/* Some systems support read-only mappings for GGTT and/or PPGTT */
334 	bool has_read_only:1;
335 
336 	/* FIXME: Need a more generic return type */
337 	gen6_pte_t (*pte_encode)(dma_addr_t addr,
338 				 enum i915_cache_level level,
339 				 u32 flags); /* Create a valid PTE */
340 	/* flags for pte_encode */
341 #define PTE_READ_ONLY	(1<<0)
342 	int (*allocate_va_range)(struct i915_address_space *vm,
343 				 u64 start, u64 length);
344 	void (*clear_range)(struct i915_address_space *vm,
345 			    u64 start, u64 length);
346 	void (*insert_page)(struct i915_address_space *vm,
347 			    dma_addr_t addr,
348 			    u64 offset,
349 			    enum i915_cache_level cache_level,
350 			    u32 flags);
351 	void (*insert_entries)(struct i915_address_space *vm,
352 			       struct i915_vma *vma,
353 			       enum i915_cache_level cache_level,
354 			       u32 flags);
355 	void (*cleanup)(struct i915_address_space *vm);
356 
357 	struct i915_vma_ops vma_ops;
358 
359 	I915_SELFTEST_DECLARE(struct fault_attr fault_attr);
360 	I915_SELFTEST_DECLARE(bool scrub_64K);
361 };
362 
363 #define i915_is_ggtt(vm) ((vm)->is_ggtt)
364 
365 static inline bool
366 i915_vm_is_48bit(const struct i915_address_space *vm)
367 {
368 	return (vm->total - 1) >> 32;
369 }
370 
371 static inline bool
372 i915_vm_has_scratch_64K(struct i915_address_space *vm)
373 {
374 	return vm->scratch_page.order == get_order(I915_GTT_PAGE_SIZE_64K);
375 }
376 
377 /* The Graphics Translation Table is the way in which GEN hardware translates a
378  * Graphics Virtual Address into a Physical Address. In addition to the normal
379  * collateral associated with any va->pa translations GEN hardware also has a
380  * portion of the GTT which can be mapped by the CPU and remain both coherent
381  * and correct (in cases like swizzling). That region is referred to as GMADR in
382  * the spec.
383  */
384 struct i915_ggtt {
385 	struct i915_address_space vm;
386 
387 	struct io_mapping iomap;	/* Mapping to our CPU mappable region */
388 	struct resource gmadr;          /* GMADR resource */
389 	resource_size_t mappable_end;	/* End offset that we can CPU map */
390 
391 	/** "Graphics Stolen Memory" holds the global PTEs */
392 	void __iomem *gsm;
393 	void (*invalidate)(struct drm_i915_private *dev_priv);
394 
395 	bool do_idle_maps;
396 
397 	int mtrr;
398 
399 	u32 pin_bias;
400 
401 	struct drm_mm_node error_capture;
402 };
403 
404 struct i915_hw_ppgtt {
405 	struct i915_address_space vm;
406 	struct kref ref;
407 
408 	unsigned long pd_dirty_rings;
409 	union {
410 		struct i915_pml4 pml4;		/* GEN8+ & 48b PPGTT */
411 		struct i915_page_directory_pointer pdp;	/* GEN8+ */
412 		struct i915_page_directory pd;		/* GEN6-7 */
413 	};
414 
415 	void (*debug_dump)(struct i915_hw_ppgtt *ppgtt, struct seq_file *m);
416 };
417 
418 struct gen6_hw_ppgtt {
419 	struct i915_hw_ppgtt base;
420 
421 	struct i915_vma *vma;
422 	gen6_pte_t __iomem *pd_addr;
423 	gen6_pte_t scratch_pte;
424 
425 	unsigned int pin_count;
426 	bool scan_for_unused_pt;
427 };
428 
429 #define __to_gen6_ppgtt(base) container_of(base, struct gen6_hw_ppgtt, base)
430 
431 static inline struct gen6_hw_ppgtt *to_gen6_ppgtt(struct i915_hw_ppgtt *base)
432 {
433 	BUILD_BUG_ON(offsetof(struct gen6_hw_ppgtt, base));
434 	return __to_gen6_ppgtt(base);
435 }
436 
437 /*
438  * gen6_for_each_pde() iterates over every pde from start until start+length.
439  * If start and start+length are not perfectly divisible, the macro will round
440  * down and up as needed. Start=0 and length=2G effectively iterates over
441  * every PDE in the system. The macro modifies ALL its parameters except 'pd',
442  * so each of the other parameters should preferably be a simple variable, or
443  * at most an lvalue with no side-effects!
444  */
445 #define gen6_for_each_pde(pt, pd, start, length, iter)			\
446 	for (iter = gen6_pde_index(start);				\
447 	     length > 0 && iter < I915_PDES &&				\
448 		(pt = (pd)->page_table[iter], true);			\
449 	     ({ u32 temp = ALIGN(start+1, 1 << GEN6_PDE_SHIFT);		\
450 		    temp = min(temp - start, length);			\
451 		    start += temp, length -= temp; }), ++iter)
452 
453 #define gen6_for_all_pdes(pt, pd, iter)					\
454 	for (iter = 0;							\
455 	     iter < I915_PDES &&					\
456 		(pt = (pd)->page_table[iter], true);			\
457 	     ++iter)
458 
459 static inline u32 i915_pte_index(u64 address, unsigned int pde_shift)
460 {
461 	const u32 mask = NUM_PTE(pde_shift) - 1;
462 
463 	return (address >> PAGE_SHIFT) & mask;
464 }
465 
466 /* Helper to counts the number of PTEs within the given length. This count
467  * does not cross a page table boundary, so the max value would be
468  * GEN6_PTES for GEN6, and GEN8_PTES for GEN8.
469 */
470 static inline u32 i915_pte_count(u64 addr, u64 length, unsigned int pde_shift)
471 {
472 	const u64 mask = ~((1ULL << pde_shift) - 1);
473 	u64 end;
474 
475 	GEM_BUG_ON(length == 0);
476 	GEM_BUG_ON(offset_in_page(addr | length));
477 
478 	end = addr + length;
479 
480 	if ((addr & mask) != (end & mask))
481 		return NUM_PTE(pde_shift) - i915_pte_index(addr, pde_shift);
482 
483 	return i915_pte_index(end, pde_shift) - i915_pte_index(addr, pde_shift);
484 }
485 
486 static inline u32 i915_pde_index(u64 addr, u32 shift)
487 {
488 	return (addr >> shift) & I915_PDE_MASK;
489 }
490 
491 static inline u32 gen6_pte_index(u32 addr)
492 {
493 	return i915_pte_index(addr, GEN6_PDE_SHIFT);
494 }
495 
496 static inline u32 gen6_pte_count(u32 addr, u32 length)
497 {
498 	return i915_pte_count(addr, length, GEN6_PDE_SHIFT);
499 }
500 
501 static inline u32 gen6_pde_index(u32 addr)
502 {
503 	return i915_pde_index(addr, GEN6_PDE_SHIFT);
504 }
505 
506 static inline unsigned int
507 i915_pdpes_per_pdp(const struct i915_address_space *vm)
508 {
509 	if (i915_vm_is_48bit(vm))
510 		return GEN8_PML4ES_PER_PML4;
511 
512 	return GEN8_3LVL_PDPES;
513 }
514 
515 /* Equivalent to the gen6 version, For each pde iterates over every pde
516  * between from start until start + length. On gen8+ it simply iterates
517  * over every page directory entry in a page directory.
518  */
519 #define gen8_for_each_pde(pt, pd, start, length, iter)			\
520 	for (iter = gen8_pde_index(start);				\
521 	     length > 0 && iter < I915_PDES &&				\
522 		(pt = (pd)->page_table[iter], true);			\
523 	     ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDE_SHIFT);		\
524 		    temp = min(temp - start, length);			\
525 		    start += temp, length -= temp; }), ++iter)
526 
527 #define gen8_for_each_pdpe(pd, pdp, start, length, iter)		\
528 	for (iter = gen8_pdpe_index(start);				\
529 	     length > 0 && iter < i915_pdpes_per_pdp(vm) &&		\
530 		(pd = (pdp)->page_directory[iter], true);		\
531 	     ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDPE_SHIFT);	\
532 		    temp = min(temp - start, length);			\
533 		    start += temp, length -= temp; }), ++iter)
534 
535 #define gen8_for_each_pml4e(pdp, pml4, start, length, iter)		\
536 	for (iter = gen8_pml4e_index(start);				\
537 	     length > 0 && iter < GEN8_PML4ES_PER_PML4 &&		\
538 		(pdp = (pml4)->pdps[iter], true);			\
539 	     ({ u64 temp = ALIGN(start+1, 1ULL << GEN8_PML4E_SHIFT);	\
540 		    temp = min(temp - start, length);			\
541 		    start += temp, length -= temp; }), ++iter)
542 
543 static inline u32 gen8_pte_index(u64 address)
544 {
545 	return i915_pte_index(address, GEN8_PDE_SHIFT);
546 }
547 
548 static inline u32 gen8_pde_index(u64 address)
549 {
550 	return i915_pde_index(address, GEN8_PDE_SHIFT);
551 }
552 
553 static inline u32 gen8_pdpe_index(u64 address)
554 {
555 	return (address >> GEN8_PDPE_SHIFT) & GEN8_PDPE_MASK;
556 }
557 
558 static inline u32 gen8_pml4e_index(u64 address)
559 {
560 	return (address >> GEN8_PML4E_SHIFT) & GEN8_PML4E_MASK;
561 }
562 
563 static inline u64 gen8_pte_count(u64 address, u64 length)
564 {
565 	return i915_pte_count(address, length, GEN8_PDE_SHIFT);
566 }
567 
568 static inline dma_addr_t
569 i915_page_dir_dma_addr(const struct i915_hw_ppgtt *ppgtt, const unsigned n)
570 {
571 	return px_dma(ppgtt->pdp.page_directory[n]);
572 }
573 
574 static inline struct i915_ggtt *
575 i915_vm_to_ggtt(struct i915_address_space *vm)
576 {
577 	GEM_BUG_ON(!i915_is_ggtt(vm));
578 	return container_of(vm, struct i915_ggtt, vm);
579 }
580 
581 #define INTEL_MAX_PPAT_ENTRIES 8
582 #define INTEL_PPAT_PERFECT_MATCH (~0U)
583 
584 struct intel_ppat;
585 
586 struct intel_ppat_entry {
587 	struct intel_ppat *ppat;
588 	struct kref ref;
589 	u8 value;
590 };
591 
592 struct intel_ppat {
593 	struct intel_ppat_entry entries[INTEL_MAX_PPAT_ENTRIES];
594 	DECLARE_BITMAP(used, INTEL_MAX_PPAT_ENTRIES);
595 	DECLARE_BITMAP(dirty, INTEL_MAX_PPAT_ENTRIES);
596 	unsigned int max_entries;
597 	u8 clear_value;
598 	/*
599 	 * Return a score to show how two PPAT values match,
600 	 * a INTEL_PPAT_PERFECT_MATCH indicates a perfect match
601 	 */
602 	unsigned int (*match)(u8 src, u8 dst);
603 	void (*update_hw)(struct drm_i915_private *i915);
604 
605 	struct drm_i915_private *i915;
606 };
607 
608 const struct intel_ppat_entry *
609 intel_ppat_get(struct drm_i915_private *i915, u8 value);
610 void intel_ppat_put(const struct intel_ppat_entry *entry);
611 
612 int i915_gem_init_aliasing_ppgtt(struct drm_i915_private *i915);
613 void i915_gem_fini_aliasing_ppgtt(struct drm_i915_private *i915);
614 
615 int i915_ggtt_probe_hw(struct drm_i915_private *dev_priv);
616 int i915_ggtt_init_hw(struct drm_i915_private *dev_priv);
617 int i915_ggtt_enable_hw(struct drm_i915_private *dev_priv);
618 void i915_ggtt_enable_guc(struct drm_i915_private *i915);
619 void i915_ggtt_disable_guc(struct drm_i915_private *i915);
620 int i915_gem_init_ggtt(struct drm_i915_private *dev_priv);
621 void i915_ggtt_cleanup_hw(struct drm_i915_private *dev_priv);
622 
623 int i915_ppgtt_init_hw(struct drm_i915_private *dev_priv);
624 void i915_ppgtt_release(struct kref *kref);
625 struct i915_hw_ppgtt *i915_ppgtt_create(struct drm_i915_private *dev_priv,
626 					struct drm_i915_file_private *fpriv);
627 void i915_ppgtt_close(struct i915_address_space *vm);
628 static inline void i915_ppgtt_get(struct i915_hw_ppgtt *ppgtt)
629 {
630 	if (ppgtt)
631 		kref_get(&ppgtt->ref);
632 }
633 static inline void i915_ppgtt_put(struct i915_hw_ppgtt *ppgtt)
634 {
635 	if (ppgtt)
636 		kref_put(&ppgtt->ref, i915_ppgtt_release);
637 }
638 
639 int gen6_ppgtt_pin(struct i915_hw_ppgtt *base);
640 void gen6_ppgtt_unpin(struct i915_hw_ppgtt *base);
641 
642 void i915_check_and_clear_faults(struct drm_i915_private *dev_priv);
643 void i915_gem_suspend_gtt_mappings(struct drm_i915_private *dev_priv);
644 void i915_gem_restore_gtt_mappings(struct drm_i915_private *dev_priv);
645 
646 int __must_check i915_gem_gtt_prepare_pages(struct drm_i915_gem_object *obj,
647 					    struct sg_table *pages);
648 void i915_gem_gtt_finish_pages(struct drm_i915_gem_object *obj,
649 			       struct sg_table *pages);
650 
651 int i915_gem_gtt_reserve(struct i915_address_space *vm,
652 			 struct drm_mm_node *node,
653 			 u64 size, u64 offset, unsigned long color,
654 			 unsigned int flags);
655 
656 int i915_gem_gtt_insert(struct i915_address_space *vm,
657 			struct drm_mm_node *node,
658 			u64 size, u64 alignment, unsigned long color,
659 			u64 start, u64 end, unsigned int flags);
660 
661 /* Flags used by pin/bind&friends. */
662 #define PIN_NONBLOCK		BIT(0)
663 #define PIN_MAPPABLE		BIT(1)
664 #define PIN_ZONE_4G		BIT(2)
665 #define PIN_NONFAULT		BIT(3)
666 #define PIN_NOEVICT		BIT(4)
667 
668 #define PIN_MBZ			BIT(5) /* I915_VMA_PIN_OVERFLOW */
669 #define PIN_GLOBAL		BIT(6) /* I915_VMA_GLOBAL_BIND */
670 #define PIN_USER		BIT(7) /* I915_VMA_LOCAL_BIND */
671 #define PIN_UPDATE		BIT(8)
672 
673 #define PIN_HIGH		BIT(9)
674 #define PIN_OFFSET_BIAS		BIT(10)
675 #define PIN_OFFSET_FIXED	BIT(11)
676 #define PIN_OFFSET_MASK		(-I915_GTT_PAGE_SIZE)
677 
678 #endif
679