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