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/kref.h>
39 #include <linux/mm.h>
40 #include <linux/pagevec.h>
41 #include <linux/workqueue.h>
42 
43 #include <drm/drm_mm.h>
44 
45 #include "gt/intel_reset.h"
46 #include "i915_gem_fence_reg.h"
47 #include "i915_request.h"
48 #include "i915_scatterlist.h"
49 #include "i915_selftest.h"
50 #include "gt/intel_timeline.h"
51 
52 #define I915_GTT_PAGE_SIZE_4K	BIT_ULL(12)
53 #define I915_GTT_PAGE_SIZE_64K	BIT_ULL(16)
54 #define I915_GTT_PAGE_SIZE_2M	BIT_ULL(21)
55 
56 #define I915_GTT_PAGE_SIZE I915_GTT_PAGE_SIZE_4K
57 #define I915_GTT_MAX_PAGE_SIZE I915_GTT_PAGE_SIZE_2M
58 
59 #define I915_GTT_PAGE_MASK -I915_GTT_PAGE_SIZE
60 
61 #define I915_GTT_MIN_ALIGNMENT I915_GTT_PAGE_SIZE
62 
63 #define I915_FENCE_REG_NONE -1
64 #define I915_MAX_NUM_FENCES 32
65 /* 32 fences + sign bit for FENCE_REG_NONE */
66 #define I915_MAX_NUM_FENCE_BITS 6
67 
68 struct drm_i915_file_private;
69 struct drm_i915_gem_object;
70 struct i915_vma;
71 struct intel_gt;
72 
73 typedef u32 gen6_pte_t;
74 typedef u64 gen8_pte_t;
75 
76 #define ggtt_total_entries(ggtt) ((ggtt)->vm.total >> PAGE_SHIFT)
77 
78 /* gen6-hsw has bit 11-4 for physical addr bit 39-32 */
79 #define GEN6_GTT_ADDR_ENCODE(addr)	((addr) | (((addr) >> 28) & 0xff0))
80 #define GEN6_PTE_ADDR_ENCODE(addr)	GEN6_GTT_ADDR_ENCODE(addr)
81 #define GEN6_PDE_ADDR_ENCODE(addr)	GEN6_GTT_ADDR_ENCODE(addr)
82 #define GEN6_PTE_CACHE_LLC		(2 << 1)
83 #define GEN6_PTE_UNCACHED		(1 << 1)
84 #define GEN6_PTE_VALID			(1 << 0)
85 
86 #define I915_PTES(pte_len)		((unsigned int)(PAGE_SIZE / (pte_len)))
87 #define I915_PTE_MASK(pte_len)		(I915_PTES(pte_len) - 1)
88 #define I915_PDES			512
89 #define I915_PDE_MASK			(I915_PDES - 1)
90 #define NUM_PTE(pde_shift)     (1 << (pde_shift - PAGE_SHIFT))
91 
92 #define GEN6_PTES			I915_PTES(sizeof(gen6_pte_t))
93 #define GEN6_PD_SIZE		        (I915_PDES * PAGE_SIZE)
94 #define GEN6_PD_ALIGN			(PAGE_SIZE * 16)
95 #define GEN6_PDE_SHIFT			22
96 #define GEN6_PDE_VALID			(1 << 0)
97 
98 #define GEN7_PTE_CACHE_L3_LLC		(3 << 1)
99 
100 #define BYT_PTE_SNOOPED_BY_CPU_CACHES	(1 << 2)
101 #define BYT_PTE_WRITEABLE		(1 << 1)
102 
103 /* Cacheability Control is a 4-bit value. The low three bits are stored in bits
104  * 3:1 of the PTE, while the fourth bit is stored in bit 11 of the PTE.
105  */
106 #define HSW_CACHEABILITY_CONTROL(bits)	((((bits) & 0x7) << 1) | \
107 					 (((bits) & 0x8) << (11 - 3)))
108 #define HSW_WB_LLC_AGE3			HSW_CACHEABILITY_CONTROL(0x2)
109 #define HSW_WB_LLC_AGE0			HSW_CACHEABILITY_CONTROL(0x3)
110 #define HSW_WB_ELLC_LLC_AGE3		HSW_CACHEABILITY_CONTROL(0x8)
111 #define HSW_WB_ELLC_LLC_AGE0		HSW_CACHEABILITY_CONTROL(0xb)
112 #define HSW_WT_ELLC_LLC_AGE3		HSW_CACHEABILITY_CONTROL(0x7)
113 #define HSW_WT_ELLC_LLC_AGE0		HSW_CACHEABILITY_CONTROL(0x6)
114 #define HSW_PTE_UNCACHED		(0)
115 #define HSW_GTT_ADDR_ENCODE(addr)	((addr) | (((addr) >> 28) & 0x7f0))
116 #define HSW_PTE_ADDR_ENCODE(addr)	HSW_GTT_ADDR_ENCODE(addr)
117 
118 /*
119  * GEN8 32b style address is defined as a 3 level page table:
120  * 31:30 | 29:21 | 20:12 |  11:0
121  * PDPE  |  PDE  |  PTE  | offset
122  * The difference as compared to normal x86 3 level page table is the PDPEs are
123  * programmed via register.
124  *
125  * GEN8 48b style address is defined as a 4 level page table:
126  * 47:39 | 38:30 | 29:21 | 20:12 |  11:0
127  * PML4E | PDPE  |  PDE  |  PTE  | offset
128  */
129 #define GEN8_3LVL_PDPES			4
130 
131 #define PPAT_UNCACHED			(_PAGE_PWT | _PAGE_PCD)
132 #define PPAT_CACHED_PDE			0 /* WB LLC */
133 #define PPAT_CACHED			_PAGE_PAT /* WB LLCeLLC */
134 #define PPAT_DISPLAY_ELLC		_PAGE_PCD /* WT eLLC */
135 
136 #define CHV_PPAT_SNOOP			(1<<6)
137 #define GEN8_PPAT_AGE(x)		((x)<<4)
138 #define GEN8_PPAT_LLCeLLC		(3<<2)
139 #define GEN8_PPAT_LLCELLC		(2<<2)
140 #define GEN8_PPAT_LLC			(1<<2)
141 #define GEN8_PPAT_WB			(3<<0)
142 #define GEN8_PPAT_WT			(2<<0)
143 #define GEN8_PPAT_WC			(1<<0)
144 #define GEN8_PPAT_UC			(0<<0)
145 #define GEN8_PPAT_ELLC_OVERRIDE		(0<<2)
146 #define GEN8_PPAT(i, x)			((u64)(x) << ((i) * 8))
147 
148 #define GEN8_PDE_IPS_64K BIT(11)
149 #define GEN8_PDE_PS_2M   BIT(7)
150 
151 #define for_each_sgt_daddr(__dp, __iter, __sgt) \
152 	__for_each_sgt_daddr(__dp, __iter, __sgt, I915_GTT_PAGE_SIZE)
153 
154 struct intel_remapped_plane_info {
155 	/* in gtt pages */
156 	unsigned int width, height, stride, offset;
157 } __packed;
158 
159 struct intel_remapped_info {
160 	struct intel_remapped_plane_info plane[2];
161 	unsigned int unused_mbz;
162 } __packed;
163 
164 struct intel_rotation_info {
165 	struct intel_remapped_plane_info plane[2];
166 } __packed;
167 
168 struct intel_partial_info {
169 	u64 offset;
170 	unsigned int size;
171 } __packed;
172 
173 enum i915_ggtt_view_type {
174 	I915_GGTT_VIEW_NORMAL = 0,
175 	I915_GGTT_VIEW_ROTATED = sizeof(struct intel_rotation_info),
176 	I915_GGTT_VIEW_PARTIAL = sizeof(struct intel_partial_info),
177 	I915_GGTT_VIEW_REMAPPED = sizeof(struct intel_remapped_info),
178 };
179 
180 static inline void assert_i915_gem_gtt_types(void)
181 {
182 	BUILD_BUG_ON(sizeof(struct intel_rotation_info) != 8*sizeof(unsigned int));
183 	BUILD_BUG_ON(sizeof(struct intel_partial_info) != sizeof(u64) + sizeof(unsigned int));
184 	BUILD_BUG_ON(sizeof(struct intel_remapped_info) != 9*sizeof(unsigned int));
185 
186 	/* Check that rotation/remapped shares offsets for simplicity */
187 	BUILD_BUG_ON(offsetof(struct intel_remapped_info, plane[0]) !=
188 		     offsetof(struct intel_rotation_info, plane[0]));
189 	BUILD_BUG_ON(offsetofend(struct intel_remapped_info, plane[1]) !=
190 		     offsetofend(struct intel_rotation_info, plane[1]));
191 
192 	/* As we encode the size of each branch inside the union into its type,
193 	 * we have to be careful that each branch has a unique size.
194 	 */
195 	switch ((enum i915_ggtt_view_type)0) {
196 	case I915_GGTT_VIEW_NORMAL:
197 	case I915_GGTT_VIEW_PARTIAL:
198 	case I915_GGTT_VIEW_ROTATED:
199 	case I915_GGTT_VIEW_REMAPPED:
200 		/* gcc complains if these are identical cases */
201 		break;
202 	}
203 }
204 
205 struct i915_ggtt_view {
206 	enum i915_ggtt_view_type type;
207 	union {
208 		/* Members need to contain no holes/padding */
209 		struct intel_partial_info partial;
210 		struct intel_rotation_info rotated;
211 		struct intel_remapped_info remapped;
212 	};
213 };
214 
215 enum i915_cache_level;
216 
217 struct i915_vma;
218 
219 struct i915_page_dma {
220 	struct page *page;
221 	union {
222 		dma_addr_t daddr;
223 
224 		/* For gen6/gen7 only. This is the offset in the GGTT
225 		 * where the page directory entries for PPGTT begin
226 		 */
227 		u32 ggtt_offset;
228 	};
229 };
230 
231 struct i915_page_scratch {
232 	struct i915_page_dma base;
233 	u64 encode;
234 };
235 
236 struct i915_page_table {
237 	struct i915_page_dma base;
238 	atomic_t used;
239 };
240 
241 struct i915_page_directory {
242 	struct i915_page_table pt;
243 	spinlock_t lock;
244 	void *entry[512];
245 };
246 
247 #define __px_choose_expr(x, type, expr, other) \
248 	__builtin_choose_expr( \
249 	__builtin_types_compatible_p(typeof(x), type) || \
250 	__builtin_types_compatible_p(typeof(x), const type), \
251 	({ type __x = (type)(x); expr; }), \
252 	other)
253 
254 #define px_base(px) \
255 	__px_choose_expr(px, struct i915_page_dma *, __x, \
256 	__px_choose_expr(px, struct i915_page_scratch *, &__x->base, \
257 	__px_choose_expr(px, struct i915_page_table *, &__x->base, \
258 	__px_choose_expr(px, struct i915_page_directory *, &__x->pt.base, \
259 	(void)0))))
260 #define px_dma(px) (px_base(px)->daddr)
261 
262 #define px_pt(px) \
263 	__px_choose_expr(px, struct i915_page_table *, __x, \
264 	__px_choose_expr(px, struct i915_page_directory *, &__x->pt, \
265 	(void)0))
266 #define px_used(px) (&px_pt(px)->used)
267 
268 struct i915_vma_ops {
269 	/* Map an object into an address space with the given cache flags. */
270 	int (*bind_vma)(struct i915_vma *vma,
271 			enum i915_cache_level cache_level,
272 			u32 flags);
273 	/*
274 	 * Unmap an object from an address space. This usually consists of
275 	 * setting the valid PTE entries to a reserved scratch page.
276 	 */
277 	void (*unbind_vma)(struct i915_vma *vma);
278 
279 	int (*set_pages)(struct i915_vma *vma);
280 	void (*clear_pages)(struct i915_vma *vma);
281 };
282 
283 struct pagestash {
284 	spinlock_t lock;
285 	struct pagevec pvec;
286 };
287 
288 struct i915_address_space {
289 	struct kref ref;
290 	struct rcu_work rcu;
291 
292 	struct drm_mm mm;
293 	struct intel_gt *gt;
294 	struct drm_i915_private *i915;
295 	struct device *dma;
296 	/* Every address space belongs to a struct file - except for the global
297 	 * GTT that is owned by the driver (and so @file is set to NULL). In
298 	 * principle, no information should leak from one context to another
299 	 * (or between files/processes etc) unless explicitly shared by the
300 	 * owner. Tracking the owner is important in order to free up per-file
301 	 * objects along with the file, to aide resource tracking, and to
302 	 * assign blame.
303 	 */
304 	struct drm_i915_file_private *file;
305 	u64 total;		/* size addr space maps (ex. 2GB for ggtt) */
306 	u64 reserved;		/* size addr space reserved */
307 
308 	unsigned int bind_async_flags;
309 
310 	/*
311 	 * Each active user context has its own address space (in full-ppgtt).
312 	 * Since the vm may be shared between multiple contexts, we count how
313 	 * many contexts keep us "open". Once open hits zero, we are closed
314 	 * and do not allow any new attachments, and proceed to shutdown our
315 	 * vma and page directories.
316 	 */
317 	atomic_t open;
318 
319 	struct mutex mutex; /* protects vma and our lists */
320 #define VM_CLASS_GGTT 0
321 #define VM_CLASS_PPGTT 1
322 
323 	struct i915_page_scratch scratch[4];
324 	unsigned int scratch_order;
325 	unsigned int top;
326 
327 	/**
328 	 * List of vma currently bound.
329 	 */
330 	struct list_head bound_list;
331 
332 	struct pagestash free_pages;
333 
334 	/* Global GTT */
335 	bool is_ggtt:1;
336 
337 	/* Some systems require uncached updates of the page directories */
338 	bool pt_kmap_wc:1;
339 
340 	/* Some systems support read-only mappings for GGTT and/or PPGTT */
341 	bool has_read_only:1;
342 
343 	u64 (*pte_encode)(dma_addr_t addr,
344 			  enum i915_cache_level level,
345 			  u32 flags); /* Create a valid PTE */
346 #define PTE_READ_ONLY	(1<<0)
347 
348 	int (*allocate_va_range)(struct i915_address_space *vm,
349 				 u64 start, u64 length);
350 	void (*clear_range)(struct i915_address_space *vm,
351 			    u64 start, u64 length);
352 	void (*insert_page)(struct i915_address_space *vm,
353 			    dma_addr_t addr,
354 			    u64 offset,
355 			    enum i915_cache_level cache_level,
356 			    u32 flags);
357 	void (*insert_entries)(struct i915_address_space *vm,
358 			       struct i915_vma *vma,
359 			       enum i915_cache_level cache_level,
360 			       u32 flags);
361 	void (*cleanup)(struct i915_address_space *vm);
362 
363 	struct i915_vma_ops vma_ops;
364 
365 	I915_SELFTEST_DECLARE(struct fault_attr fault_attr);
366 	I915_SELFTEST_DECLARE(bool scrub_64K);
367 };
368 
369 #define i915_is_ggtt(vm) ((vm)->is_ggtt)
370 
371 static inline bool
372 i915_vm_is_4lvl(const struct i915_address_space *vm)
373 {
374 	return (vm->total - 1) >> 32;
375 }
376 
377 static inline bool
378 i915_vm_has_scratch_64K(struct i915_address_space *vm)
379 {
380 	return vm->scratch_order == get_order(I915_GTT_PAGE_SIZE_64K);
381 }
382 
383 static inline bool
384 i915_vm_has_cache_coloring(struct i915_address_space *vm)
385 {
386 	return i915_is_ggtt(vm) && vm->mm.color_adjust;
387 }
388 
389 /* The Graphics Translation Table is the way in which GEN hardware translates a
390  * Graphics Virtual Address into a Physical Address. In addition to the normal
391  * collateral associated with any va->pa translations GEN hardware also has a
392  * portion of the GTT which can be mapped by the CPU and remain both coherent
393  * and correct (in cases like swizzling). That region is referred to as GMADR in
394  * the spec.
395  */
396 struct i915_ggtt {
397 	struct i915_address_space vm;
398 
399 	struct io_mapping iomap;	/* Mapping to our CPU mappable region */
400 	struct resource gmadr;          /* GMADR resource */
401 	resource_size_t mappable_end;	/* End offset that we can CPU map */
402 
403 	/** "Graphics Stolen Memory" holds the global PTEs */
404 	void __iomem *gsm;
405 	void (*invalidate)(struct i915_ggtt *ggtt);
406 
407 	/** PPGTT used for aliasing the PPGTT with the GTT */
408 	struct i915_ppgtt *alias;
409 
410 	bool do_idle_maps;
411 
412 	int mtrr;
413 
414 	/** Bit 6 swizzling required for X tiling */
415 	u32 bit_6_swizzle_x;
416 	/** Bit 6 swizzling required for Y tiling */
417 	u32 bit_6_swizzle_y;
418 
419 	u32 pin_bias;
420 
421 	unsigned int num_fences;
422 	struct i915_fence_reg fence_regs[I915_MAX_NUM_FENCES];
423 	struct list_head fence_list;
424 
425 	/** List of all objects in gtt_space, currently mmaped by userspace.
426 	 * All objects within this list must also be on bound_list.
427 	 */
428 	struct list_head userfault_list;
429 
430 	/* Manual runtime pm autosuspend delay for user GGTT mmaps */
431 	struct intel_wakeref_auto userfault_wakeref;
432 
433 	struct drm_mm_node error_capture;
434 	struct drm_mm_node uc_fw;
435 };
436 
437 struct i915_ppgtt {
438 	struct i915_address_space vm;
439 
440 	struct i915_page_directory *pd;
441 };
442 
443 struct gen6_ppgtt {
444 	struct i915_ppgtt base;
445 
446 	struct i915_vma *vma;
447 	gen6_pte_t __iomem *pd_addr;
448 
449 	atomic_t pin_count;
450 	struct mutex pin_mutex;
451 
452 	bool scan_for_unused_pt;
453 };
454 
455 #define __to_gen6_ppgtt(base) container_of(base, struct gen6_ppgtt, base)
456 
457 static inline struct gen6_ppgtt *to_gen6_ppgtt(struct i915_ppgtt *base)
458 {
459 	BUILD_BUG_ON(offsetof(struct gen6_ppgtt, base));
460 	return __to_gen6_ppgtt(base);
461 }
462 
463 /*
464  * gen6_for_each_pde() iterates over every pde from start until start+length.
465  * If start and start+length are not perfectly divisible, the macro will round
466  * down and up as needed. Start=0 and length=2G effectively iterates over
467  * every PDE in the system. The macro modifies ALL its parameters except 'pd',
468  * so each of the other parameters should preferably be a simple variable, or
469  * at most an lvalue with no side-effects!
470  */
471 #define gen6_for_each_pde(pt, pd, start, length, iter)			\
472 	for (iter = gen6_pde_index(start);				\
473 	     length > 0 && iter < I915_PDES &&				\
474 		     (pt = i915_pt_entry(pd, iter), true);		\
475 	     ({ u32 temp = ALIGN(start+1, 1 << GEN6_PDE_SHIFT);		\
476 		    temp = min(temp - start, length);			\
477 		    start += temp, length -= temp; }), ++iter)
478 
479 #define gen6_for_all_pdes(pt, pd, iter)					\
480 	for (iter = 0;							\
481 	     iter < I915_PDES &&					\
482 		     (pt = i915_pt_entry(pd, iter), true);		\
483 	     ++iter)
484 
485 static inline u32 i915_pte_index(u64 address, unsigned int pde_shift)
486 {
487 	const u32 mask = NUM_PTE(pde_shift) - 1;
488 
489 	return (address >> PAGE_SHIFT) & mask;
490 }
491 
492 /* Helper to counts the number of PTEs within the given length. This count
493  * does not cross a page table boundary, so the max value would be
494  * GEN6_PTES for GEN6, and GEN8_PTES for GEN8.
495 */
496 static inline u32 i915_pte_count(u64 addr, u64 length, unsigned int pde_shift)
497 {
498 	const u64 mask = ~((1ULL << pde_shift) - 1);
499 	u64 end;
500 
501 	GEM_BUG_ON(length == 0);
502 	GEM_BUG_ON(offset_in_page(addr | length));
503 
504 	end = addr + length;
505 
506 	if ((addr & mask) != (end & mask))
507 		return NUM_PTE(pde_shift) - i915_pte_index(addr, pde_shift);
508 
509 	return i915_pte_index(end, pde_shift) - i915_pte_index(addr, pde_shift);
510 }
511 
512 static inline u32 i915_pde_index(u64 addr, u32 shift)
513 {
514 	return (addr >> shift) & I915_PDE_MASK;
515 }
516 
517 static inline u32 gen6_pte_index(u32 addr)
518 {
519 	return i915_pte_index(addr, GEN6_PDE_SHIFT);
520 }
521 
522 static inline u32 gen6_pte_count(u32 addr, u32 length)
523 {
524 	return i915_pte_count(addr, length, GEN6_PDE_SHIFT);
525 }
526 
527 static inline u32 gen6_pde_index(u32 addr)
528 {
529 	return i915_pde_index(addr, GEN6_PDE_SHIFT);
530 }
531 
532 static inline struct i915_page_table *
533 i915_pt_entry(const struct i915_page_directory * const pd,
534 	      const unsigned short n)
535 {
536 	return pd->entry[n];
537 }
538 
539 static inline struct i915_page_directory *
540 i915_pd_entry(const struct i915_page_directory * const pdp,
541 	      const unsigned short n)
542 {
543 	return pdp->entry[n];
544 }
545 
546 static inline dma_addr_t
547 i915_page_dir_dma_addr(const struct i915_ppgtt *ppgtt, const unsigned int n)
548 {
549 	struct i915_page_dma *pt = ppgtt->pd->entry[n];
550 
551 	return px_dma(pt ?: px_base(&ppgtt->vm.scratch[ppgtt->vm.top]));
552 }
553 
554 static inline struct i915_ggtt *
555 i915_vm_to_ggtt(struct i915_address_space *vm)
556 {
557 	BUILD_BUG_ON(offsetof(struct i915_ggtt, vm));
558 	GEM_BUG_ON(!i915_is_ggtt(vm));
559 	return container_of(vm, struct i915_ggtt, vm);
560 }
561 
562 static inline struct i915_ppgtt *
563 i915_vm_to_ppgtt(struct i915_address_space *vm)
564 {
565 	BUILD_BUG_ON(offsetof(struct i915_ppgtt, vm));
566 	GEM_BUG_ON(i915_is_ggtt(vm));
567 	return container_of(vm, struct i915_ppgtt, vm);
568 }
569 
570 int i915_ggtt_probe_hw(struct drm_i915_private *dev_priv);
571 int i915_ggtt_init_hw(struct drm_i915_private *dev_priv);
572 int i915_ggtt_enable_hw(struct drm_i915_private *dev_priv);
573 void i915_ggtt_enable_guc(struct i915_ggtt *ggtt);
574 void i915_ggtt_disable_guc(struct i915_ggtt *ggtt);
575 int i915_init_ggtt(struct drm_i915_private *dev_priv);
576 void i915_ggtt_driver_release(struct drm_i915_private *dev_priv);
577 
578 static inline bool i915_ggtt_has_aperture(const struct i915_ggtt *ggtt)
579 {
580 	return ggtt->mappable_end > 0;
581 }
582 
583 int i915_ppgtt_init_hw(struct intel_gt *gt);
584 
585 struct i915_ppgtt *i915_ppgtt_create(struct drm_i915_private *dev_priv);
586 
587 static inline struct i915_address_space *
588 i915_vm_get(struct i915_address_space *vm)
589 {
590 	kref_get(&vm->ref);
591 	return vm;
592 }
593 
594 void i915_vm_release(struct kref *kref);
595 
596 static inline void i915_vm_put(struct i915_address_space *vm)
597 {
598 	kref_put(&vm->ref, i915_vm_release);
599 }
600 
601 static inline struct i915_address_space *
602 i915_vm_open(struct i915_address_space *vm)
603 {
604 	GEM_BUG_ON(!atomic_read(&vm->open));
605 	atomic_inc(&vm->open);
606 	return i915_vm_get(vm);
607 }
608 
609 static inline bool
610 i915_vm_tryopen(struct i915_address_space *vm)
611 {
612 	if (atomic_add_unless(&vm->open, 1, 0))
613 		return i915_vm_get(vm);
614 
615 	return false;
616 }
617 
618 void __i915_vm_close(struct i915_address_space *vm);
619 
620 static inline void
621 i915_vm_close(struct i915_address_space *vm)
622 {
623 	GEM_BUG_ON(!atomic_read(&vm->open));
624 	if (atomic_dec_and_test(&vm->open))
625 		__i915_vm_close(vm);
626 
627 	i915_vm_put(vm);
628 }
629 
630 int gen6_ppgtt_pin(struct i915_ppgtt *base);
631 void gen6_ppgtt_unpin(struct i915_ppgtt *base);
632 void gen6_ppgtt_unpin_all(struct i915_ppgtt *base);
633 
634 void i915_gem_suspend_gtt_mappings(struct drm_i915_private *dev_priv);
635 void i915_gem_restore_gtt_mappings(struct drm_i915_private *dev_priv);
636 
637 int __must_check i915_gem_gtt_prepare_pages(struct drm_i915_gem_object *obj,
638 					    struct sg_table *pages);
639 void i915_gem_gtt_finish_pages(struct drm_i915_gem_object *obj,
640 			       struct sg_table *pages);
641 
642 int i915_gem_gtt_reserve(struct i915_address_space *vm,
643 			 struct drm_mm_node *node,
644 			 u64 size, u64 offset, unsigned long color,
645 			 unsigned int flags);
646 
647 int i915_gem_gtt_insert(struct i915_address_space *vm,
648 			struct drm_mm_node *node,
649 			u64 size, u64 alignment, unsigned long color,
650 			u64 start, u64 end, unsigned int flags);
651 
652 /* Flags used by pin/bind&friends. */
653 #define PIN_NOEVICT		BIT_ULL(0)
654 #define PIN_NOSEARCH		BIT_ULL(1)
655 #define PIN_NONBLOCK		BIT_ULL(2)
656 #define PIN_MAPPABLE		BIT_ULL(3)
657 #define PIN_ZONE_4G		BIT_ULL(4)
658 #define PIN_HIGH		BIT_ULL(5)
659 #define PIN_OFFSET_BIAS		BIT_ULL(6)
660 #define PIN_OFFSET_FIXED	BIT_ULL(7)
661 
662 #define PIN_UPDATE		BIT_ULL(9)
663 #define PIN_GLOBAL		BIT_ULL(10) /* I915_VMA_GLOBAL_BIND */
664 #define PIN_USER		BIT_ULL(11) /* I915_VMA_LOCAL_BIND */
665 
666 #define PIN_OFFSET_MASK		(-I915_GTT_PAGE_SIZE)
667 
668 #endif
669