2 * Copyright © 2014 Intel Corporation
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:
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
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
23 * Please try to maintain the following order within this file unless it makes
24 * sense to do otherwise. From top to bottom:
26 * 2. #defines, and macros
27 * 3. structure definitions
28 * 4. function prototypes
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).
34 #ifndef __I915_GEM_GTT_H__
35 #define __I915_GEM_GTT_H__
37 #include <linux/io-mapping.h>
39 #include "i915_gem_request.h"
41 struct drm_i915_file_private
;
43 typedef uint32_t gen6_pte_t
;
44 typedef uint64_t gen8_pte_t
;
45 typedef uint64_t gen8_pde_t
;
46 typedef uint64_t gen8_ppgtt_pdpe_t
;
47 typedef uint64_t gen8_ppgtt_pml4e_t
;
49 #define ggtt_total_entries(ggtt) ((ggtt)->base.total >> PAGE_SHIFT)
51 /* gen6-hsw has bit 11-4 for physical addr bit 39-32 */
52 #define GEN6_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0xff0))
53 #define GEN6_PTE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
54 #define GEN6_PDE_ADDR_ENCODE(addr) GEN6_GTT_ADDR_ENCODE(addr)
55 #define GEN6_PTE_CACHE_LLC (2 << 1)
56 #define GEN6_PTE_UNCACHED (1 << 1)
57 #define GEN6_PTE_VALID (1 << 0)
59 #define I915_PTES(pte_len) (PAGE_SIZE / (pte_len))
60 #define I915_PTE_MASK(pte_len) (I915_PTES(pte_len) - 1)
62 #define I915_PDE_MASK (I915_PDES - 1)
63 #define NUM_PTE(pde_shift) (1 << (pde_shift - PAGE_SHIFT))
65 #define GEN6_PTES I915_PTES(sizeof(gen6_pte_t))
66 #define GEN6_PD_SIZE (I915_PDES * PAGE_SIZE)
67 #define GEN6_PD_ALIGN (PAGE_SIZE * 16)
68 #define GEN6_PDE_SHIFT 22
69 #define GEN6_PDE_VALID (1 << 0)
71 #define GEN7_PTE_CACHE_L3_LLC (3 << 1)
73 #define BYT_PTE_SNOOPED_BY_CPU_CACHES (1 << 2)
74 #define BYT_PTE_WRITEABLE (1 << 1)
76 /* Cacheability Control is a 4-bit value. The low three bits are stored in bits
77 * 3:1 of the PTE, while the fourth bit is stored in bit 11 of the PTE.
79 #define HSW_CACHEABILITY_CONTROL(bits) ((((bits) & 0x7) << 1) | \
80 (((bits) & 0x8) << (11 - 3)))
81 #define HSW_WB_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x2)
82 #define HSW_WB_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x3)
83 #define HSW_WB_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x8)
84 #define HSW_WB_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0xb)
85 #define HSW_WT_ELLC_LLC_AGE3 HSW_CACHEABILITY_CONTROL(0x7)
86 #define HSW_WT_ELLC_LLC_AGE0 HSW_CACHEABILITY_CONTROL(0x6)
87 #define HSW_PTE_UNCACHED (0)
88 #define HSW_GTT_ADDR_ENCODE(addr) ((addr) | (((addr) >> 28) & 0x7f0))
89 #define HSW_PTE_ADDR_ENCODE(addr) HSW_GTT_ADDR_ENCODE(addr)
91 /* GEN8 legacy style address is defined as a 3 level page table:
92 * 31:30 | 29:21 | 20:12 | 11:0
93 * PDPE | PDE | PTE | offset
94 * The difference as compared to normal x86 3 level page table is the PDPEs are
95 * programmed via register.
97 * GEN8 48b legacy style address is defined as a 4 level page table:
98 * 47:39 | 38:30 | 29:21 | 20:12 | 11:0
99 * PML4E | PDPE | PDE | PTE | offset
101 #define GEN8_PML4ES_PER_PML4 512
102 #define GEN8_PML4E_SHIFT 39
103 #define GEN8_PML4E_MASK (GEN8_PML4ES_PER_PML4 - 1)
104 #define GEN8_PDPE_SHIFT 30
105 /* NB: GEN8_PDPE_MASK is untrue for 32b platforms, but it has no impact on 32b page
107 #define GEN8_PDPE_MASK 0x1ff
108 #define GEN8_PDE_SHIFT 21
109 #define GEN8_PDE_MASK 0x1ff
110 #define GEN8_PTE_SHIFT 12
111 #define GEN8_PTE_MASK 0x1ff
112 #define GEN8_LEGACY_PDPES 4
113 #define GEN8_PTES I915_PTES(sizeof(gen8_pte_t))
115 #define I915_PDPES_PER_PDP(dev) (USES_FULL_48BIT_PPGTT(dev) ?\
116 GEN8_PML4ES_PER_PML4 : GEN8_LEGACY_PDPES)
118 #define PPAT_UNCACHED_INDEX (_PAGE_PWT | _PAGE_PCD)
119 #define PPAT_CACHED_PDE_INDEX 0 /* WB LLC */
120 #define PPAT_CACHED_INDEX _PAGE_PAT /* WB LLCeLLC */
121 #define PPAT_DISPLAY_ELLC_INDEX _PAGE_PCD /* WT eLLC */
123 #define CHV_PPAT_SNOOP (1<<6)
124 #define GEN8_PPAT_AGE(x) (x<<4)
125 #define GEN8_PPAT_LLCeLLC (3<<2)
126 #define GEN8_PPAT_LLCELLC (2<<2)
127 #define GEN8_PPAT_LLC (1<<2)
128 #define GEN8_PPAT_WB (3<<0)
129 #define GEN8_PPAT_WT (2<<0)
130 #define GEN8_PPAT_WC (1<<0)
131 #define GEN8_PPAT_UC (0<<0)
132 #define GEN8_PPAT_ELLC_OVERRIDE (0<<2)
133 #define GEN8_PPAT(i, x) ((uint64_t) (x) << ((i) * 8))
135 enum i915_ggtt_view_type
{
136 I915_GGTT_VIEW_NORMAL
= 0,
137 I915_GGTT_VIEW_ROTATED
,
138 I915_GGTT_VIEW_PARTIAL
,
141 struct intel_rotation_info
{
144 unsigned int width
, height
, stride
, offset
;
148 struct i915_ggtt_view
{
149 enum i915_ggtt_view_type type
;
156 struct intel_rotation_info rotated
;
160 extern const struct i915_ggtt_view i915_ggtt_view_normal
;
161 extern const struct i915_ggtt_view i915_ggtt_view_rotated
;
163 enum i915_cache_level
;
166 * A VMA represents a GEM BO that is bound into an address space. Therefore, a
167 * VMA's presence cannot be guaranteed before binding, or after unbinding the
168 * object into/from the address space.
170 * To make things as simple as possible (ie. no refcounting), a VMA's lifetime
171 * will always be <= an objects lifetime. So object refcounting should cover us.
174 struct drm_mm_node node
;
175 struct drm_i915_gem_object
*obj
;
176 struct i915_address_space
*vm
;
177 struct sg_table
*pages
;
183 * How many users have pinned this object in GTT space. The following
184 * users can each hold at most one reference: pwrite/pread, execbuffer
185 * (objects are not allowed multiple times for the same batchbuffer),
186 * and the framebuffer code. When switching/pageflipping, the
187 * framebuffer code has at most two buffers pinned per crtc.
189 * In the worst case this is 1 + 1 + 1 + 2*2 = 7. That would fit into 3
190 * bits with absolutely no headroom. So use 4 bits.
192 #define I915_VMA_PIN_MASK 0xf
193 #define I915_VMA_PIN_OVERFLOW BIT(5)
195 /** Flags and address space this VMA is bound to */
196 #define I915_VMA_GLOBAL_BIND BIT(6)
197 #define I915_VMA_LOCAL_BIND BIT(7)
198 #define I915_VMA_BIND_MASK (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND | I915_VMA_PIN_OVERFLOW)
200 #define I915_VMA_GGTT BIT(8)
201 #define I915_VMA_CAN_FENCE BIT(9)
202 #define I915_VMA_CLOSED BIT(10)
205 struct i915_gem_active last_read
[I915_NUM_ENGINES
];
208 * Support different GGTT views into the same object.
209 * This means there can be multiple VMA mappings per object and per VM.
210 * i915_ggtt_view_type is used to distinguish between those entries.
211 * The default one of zero (I915_GGTT_VIEW_NORMAL) is default and also
212 * assumed in GEM functions which take no ggtt view parameter.
214 struct i915_ggtt_view ggtt_view
;
216 /** This object's place on the active/inactive lists */
217 struct list_head vm_link
;
219 struct list_head obj_link
; /* Link in the object's VMA list */
221 /** This vma's place in the batchbuffer or on the eviction list */
222 struct list_head exec_list
;
225 * Used for performing relocations during execbuffer insertion.
227 struct hlist_node exec_node
;
228 unsigned long exec_handle
;
229 struct drm_i915_gem_exec_object2
*exec_entry
;
233 i915_vma_create(struct drm_i915_gem_object
*obj
,
234 struct i915_address_space
*vm
,
235 const struct i915_ggtt_view
*view
);
236 void i915_vma_unpin_and_release(struct i915_vma
**p_vma
);
238 static inline bool i915_vma_is_ggtt(const struct i915_vma
*vma
)
240 return vma
->flags
& I915_VMA_GGTT
;
243 static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma
*vma
)
245 return vma
->flags
& I915_VMA_CAN_FENCE
;
248 static inline bool i915_vma_is_closed(const struct i915_vma
*vma
)
250 return vma
->flags
& I915_VMA_CLOSED
;
253 static inline unsigned int i915_vma_get_active(const struct i915_vma
*vma
)
258 static inline bool i915_vma_is_active(const struct i915_vma
*vma
)
260 return i915_vma_get_active(vma
);
263 static inline void i915_vma_set_active(struct i915_vma
*vma
,
266 vma
->active
|= BIT(engine
);
269 static inline void i915_vma_clear_active(struct i915_vma
*vma
,
272 vma
->active
&= ~BIT(engine
);
275 static inline bool i915_vma_has_active_engine(const struct i915_vma
*vma
,
278 return vma
->active
& BIT(engine
);
281 static inline u32
i915_ggtt_offset(const struct i915_vma
*vma
)
283 GEM_BUG_ON(!i915_vma_is_ggtt(vma
));
284 GEM_BUG_ON(!vma
->node
.allocated
);
285 GEM_BUG_ON(upper_32_bits(vma
->node
.start
));
286 GEM_BUG_ON(upper_32_bits(vma
->node
.start
+ vma
->node
.size
- 1));
287 return lower_32_bits(vma
->node
.start
);
290 struct i915_page_dma
{
295 /* For gen6/gen7 only. This is the offset in the GGTT
296 * where the page directory entries for PPGTT begin
298 uint32_t ggtt_offset
;
302 #define px_base(px) (&(px)->base)
303 #define px_page(px) (px_base(px)->page)
304 #define px_dma(px) (px_base(px)->daddr)
306 struct i915_page_scratch
{
307 struct i915_page_dma base
;
310 struct i915_page_table
{
311 struct i915_page_dma base
;
313 unsigned long *used_ptes
;
316 struct i915_page_directory
{
317 struct i915_page_dma base
;
319 unsigned long *used_pdes
;
320 struct i915_page_table
*page_table
[I915_PDES
]; /* PDEs */
323 struct i915_page_directory_pointer
{
324 struct i915_page_dma base
;
326 unsigned long *used_pdpes
;
327 struct i915_page_directory
**page_directory
;
331 struct i915_page_dma base
;
333 DECLARE_BITMAP(used_pml4es
, GEN8_PML4ES_PER_PML4
);
334 struct i915_page_directory_pointer
*pdps
[GEN8_PML4ES_PER_PML4
];
337 struct i915_address_space
{
339 struct drm_device
*dev
;
340 /* Every address space belongs to a struct file - except for the global
341 * GTT that is owned by the driver (and so @file is set to NULL). In
342 * principle, no information should leak from one context to another
343 * (or between files/processes etc) unless explicitly shared by the
344 * owner. Tracking the owner is important in order to free up per-file
345 * objects along with the file, to aide resource tracking, and to
348 struct drm_i915_file_private
*file
;
349 struct list_head global_link
;
350 u64 start
; /* Start offset always 0 for dri2 */
351 u64 total
; /* size addr space maps (ex. 2GB for ggtt) */
355 struct i915_page_scratch
*scratch_page
;
356 struct i915_page_table
*scratch_pt
;
357 struct i915_page_directory
*scratch_pd
;
358 struct i915_page_directory_pointer
*scratch_pdp
; /* GEN8+ & 48b PPGTT */
361 * List of objects currently involved in rendering.
363 * Includes buffers having the contents of their GPU caches
364 * flushed, not necessarily primitives. last_read_req
365 * represents when the rendering involved will be completed.
367 * A reference is held on the buffer while on this list.
369 struct list_head active_list
;
372 * LRU list of objects which are not in the ringbuffer and
373 * are ready to unbind, but are still in the GTT.
375 * last_read_req is NULL while an object is in this list.
377 * A reference is not held on the buffer while on this list,
378 * as merely being GTT-bound shouldn't prevent its being
379 * freed, and we'll pull it off the list in the free path.
381 struct list_head inactive_list
;
384 * List of vma that have been unbound.
386 * A reference is not held on the buffer while on this list.
388 struct list_head unbound_list
;
390 /* FIXME: Need a more generic return type */
391 gen6_pte_t (*pte_encode
)(dma_addr_t addr
,
392 enum i915_cache_level level
,
393 bool valid
, u32 flags
); /* Create a valid PTE */
394 /* flags for pte_encode */
395 #define PTE_READ_ONLY (1<<0)
396 int (*allocate_va_range
)(struct i915_address_space
*vm
,
399 void (*clear_range
)(struct i915_address_space
*vm
,
403 void (*insert_page
)(struct i915_address_space
*vm
,
406 enum i915_cache_level cache_level
,
408 void (*insert_entries
)(struct i915_address_space
*vm
,
411 enum i915_cache_level cache_level
, u32 flags
);
412 void (*cleanup
)(struct i915_address_space
*vm
);
413 /** Unmap an object from an address space. This usually consists of
414 * setting the valid PTE entries to a reserved scratch page. */
415 void (*unbind_vma
)(struct i915_vma
*vma
);
416 /* Map an object into an address space with the given cache flags. */
417 int (*bind_vma
)(struct i915_vma
*vma
,
418 enum i915_cache_level cache_level
,
422 #define i915_is_ggtt(V) (!(V)->file)
424 /* The Graphics Translation Table is the way in which GEN hardware translates a
425 * Graphics Virtual Address into a Physical Address. In addition to the normal
426 * collateral associated with any va->pa translations GEN hardware also has a
427 * portion of the GTT which can be mapped by the CPU and remain both coherent
428 * and correct (in cases like swizzling). That region is referred to as GMADR in
432 struct i915_address_space base
;
434 size_t stolen_size
; /* Total size of stolen memory */
435 size_t stolen_usable_size
; /* Total size minus BIOS reserved */
436 size_t stolen_reserved_base
;
437 size_t stolen_reserved_size
;
438 u64 mappable_end
; /* End offset that we can CPU map */
439 struct io_mapping
*mappable
; /* Mapping to our CPU mappable region */
440 phys_addr_t mappable_base
; /* PA of our GMADR */
442 /** "Graphics Stolen Memory" holds the global PTEs */
450 struct i915_hw_ppgtt
{
451 struct i915_address_space base
;
453 struct drm_mm_node node
;
454 unsigned long pd_dirty_rings
;
456 struct i915_pml4 pml4
; /* GEN8+ & 48b PPGTT */
457 struct i915_page_directory_pointer pdp
; /* GEN8+ */
458 struct i915_page_directory pd
; /* GEN6-7 */
461 gen6_pte_t __iomem
*pd_addr
;
463 int (*enable
)(struct i915_hw_ppgtt
*ppgtt
);
464 int (*switch_mm
)(struct i915_hw_ppgtt
*ppgtt
,
465 struct drm_i915_gem_request
*req
);
466 void (*debug_dump
)(struct i915_hw_ppgtt
*ppgtt
, struct seq_file
*m
);
470 * gen6_for_each_pde() iterates over every pde from start until start+length.
471 * If start and start+length are not perfectly divisible, the macro will round
472 * down and up as needed. Start=0 and length=2G effectively iterates over
473 * every PDE in the system. The macro modifies ALL its parameters except 'pd',
474 * so each of the other parameters should preferably be a simple variable, or
475 * at most an lvalue with no side-effects!
477 #define gen6_for_each_pde(pt, pd, start, length, iter) \
478 for (iter = gen6_pde_index(start); \
479 length > 0 && iter < I915_PDES && \
480 (pt = (pd)->page_table[iter], true); \
481 ({ u32 temp = ALIGN(start+1, 1 << GEN6_PDE_SHIFT); \
482 temp = min(temp - start, length); \
483 start += temp, length -= temp; }), ++iter)
485 #define gen6_for_all_pdes(pt, pd, iter) \
487 iter < I915_PDES && \
488 (pt = (pd)->page_table[iter], true); \
491 static inline uint32_t i915_pte_index(uint64_t address
, uint32_t pde_shift
)
493 const uint32_t mask
= NUM_PTE(pde_shift
) - 1;
495 return (address
>> PAGE_SHIFT
) & mask
;
498 /* Helper to counts the number of PTEs within the given length. This count
499 * does not cross a page table boundary, so the max value would be
500 * GEN6_PTES for GEN6, and GEN8_PTES for GEN8.
502 static inline uint32_t i915_pte_count(uint64_t addr
, size_t length
,
505 const uint64_t mask
= ~((1ULL << pde_shift
) - 1);
508 WARN_ON(length
== 0);
509 WARN_ON(offset_in_page(addr
|length
));
513 if ((addr
& mask
) != (end
& mask
))
514 return NUM_PTE(pde_shift
) - i915_pte_index(addr
, pde_shift
);
516 return i915_pte_index(end
, pde_shift
) - i915_pte_index(addr
, pde_shift
);
519 static inline uint32_t i915_pde_index(uint64_t addr
, uint32_t shift
)
521 return (addr
>> shift
) & I915_PDE_MASK
;
524 static inline uint32_t gen6_pte_index(uint32_t addr
)
526 return i915_pte_index(addr
, GEN6_PDE_SHIFT
);
529 static inline size_t gen6_pte_count(uint32_t addr
, uint32_t length
)
531 return i915_pte_count(addr
, length
, GEN6_PDE_SHIFT
);
534 static inline uint32_t gen6_pde_index(uint32_t addr
)
536 return i915_pde_index(addr
, GEN6_PDE_SHIFT
);
539 /* Equivalent to the gen6 version, For each pde iterates over every pde
540 * between from start until start + length. On gen8+ it simply iterates
541 * over every page directory entry in a page directory.
543 #define gen8_for_each_pde(pt, pd, start, length, iter) \
544 for (iter = gen8_pde_index(start); \
545 length > 0 && iter < I915_PDES && \
546 (pt = (pd)->page_table[iter], true); \
547 ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDE_SHIFT); \
548 temp = min(temp - start, length); \
549 start += temp, length -= temp; }), ++iter)
551 #define gen8_for_each_pdpe(pd, pdp, start, length, iter) \
552 for (iter = gen8_pdpe_index(start); \
553 length > 0 && iter < I915_PDPES_PER_PDP(dev) && \
554 (pd = (pdp)->page_directory[iter], true); \
555 ({ u64 temp = ALIGN(start+1, 1 << GEN8_PDPE_SHIFT); \
556 temp = min(temp - start, length); \
557 start += temp, length -= temp; }), ++iter)
559 #define gen8_for_each_pml4e(pdp, pml4, start, length, iter) \
560 for (iter = gen8_pml4e_index(start); \
561 length > 0 && iter < GEN8_PML4ES_PER_PML4 && \
562 (pdp = (pml4)->pdps[iter], true); \
563 ({ u64 temp = ALIGN(start+1, 1ULL << GEN8_PML4E_SHIFT); \
564 temp = min(temp - start, length); \
565 start += temp, length -= temp; }), ++iter)
567 static inline uint32_t gen8_pte_index(uint64_t address
)
569 return i915_pte_index(address
, GEN8_PDE_SHIFT
);
572 static inline uint32_t gen8_pde_index(uint64_t address
)
574 return i915_pde_index(address
, GEN8_PDE_SHIFT
);
577 static inline uint32_t gen8_pdpe_index(uint64_t address
)
579 return (address
>> GEN8_PDPE_SHIFT
) & GEN8_PDPE_MASK
;
582 static inline uint32_t gen8_pml4e_index(uint64_t address
)
584 return (address
>> GEN8_PML4E_SHIFT
) & GEN8_PML4E_MASK
;
587 static inline size_t gen8_pte_count(uint64_t address
, uint64_t length
)
589 return i915_pte_count(address
, length
, GEN8_PDE_SHIFT
);
592 static inline dma_addr_t
593 i915_page_dir_dma_addr(const struct i915_hw_ppgtt
*ppgtt
, const unsigned n
)
595 return test_bit(n
, ppgtt
->pdp
.used_pdpes
) ?
596 px_dma(ppgtt
->pdp
.page_directory
[n
]) :
597 px_dma(ppgtt
->base
.scratch_pd
);
600 int i915_ggtt_probe_hw(struct drm_i915_private
*dev_priv
);
601 int i915_ggtt_init_hw(struct drm_i915_private
*dev_priv
);
602 int i915_ggtt_enable_hw(struct drm_i915_private
*dev_priv
);
603 int i915_gem_init_ggtt(struct drm_i915_private
*dev_priv
);
604 void i915_ggtt_cleanup_hw(struct drm_i915_private
*dev_priv
);
606 int i915_ppgtt_init_hw(struct drm_device
*dev
);
607 void i915_ppgtt_release(struct kref
*kref
);
608 struct i915_hw_ppgtt
*i915_ppgtt_create(struct drm_i915_private
*dev_priv
,
609 struct drm_i915_file_private
*fpriv
);
610 static inline void i915_ppgtt_get(struct i915_hw_ppgtt
*ppgtt
)
613 kref_get(&ppgtt
->ref
);
615 static inline void i915_ppgtt_put(struct i915_hw_ppgtt
*ppgtt
)
618 kref_put(&ppgtt
->ref
, i915_ppgtt_release
);
621 void i915_check_and_clear_faults(struct drm_i915_private
*dev_priv
);
622 void i915_gem_suspend_gtt_mappings(struct drm_device
*dev
);
623 void i915_gem_restore_gtt_mappings(struct drm_device
*dev
);
625 int __must_check
i915_gem_gtt_prepare_object(struct drm_i915_gem_object
*obj
);
626 void i915_gem_gtt_finish_object(struct drm_i915_gem_object
*obj
);
628 /* Flags used by pin/bind&friends. */
629 #define PIN_NONBLOCK BIT(0)
630 #define PIN_MAPPABLE BIT(1)
631 #define PIN_ZONE_4G BIT(2)
633 #define PIN_MBZ BIT(5) /* I915_VMA_PIN_OVERFLOW */
634 #define PIN_GLOBAL BIT(6) /* I915_VMA_GLOBAL_BIND */
635 #define PIN_USER BIT(7) /* I915_VMA_LOCAL_BIND */
636 #define PIN_UPDATE BIT(8)
638 #define PIN_HIGH BIT(9)
639 #define PIN_OFFSET_BIAS BIT(10)
640 #define PIN_OFFSET_FIXED BIT(11)
641 #define PIN_OFFSET_MASK (~4095)
643 int __i915_vma_do_pin(struct i915_vma
*vma
,
644 u64 size
, u64 alignment
, u64 flags
);
645 static inline int __must_check
646 i915_vma_pin(struct i915_vma
*vma
, u64 size
, u64 alignment
, u64 flags
)
648 BUILD_BUG_ON(PIN_MBZ
!= I915_VMA_PIN_OVERFLOW
);
649 BUILD_BUG_ON(PIN_GLOBAL
!= I915_VMA_GLOBAL_BIND
);
650 BUILD_BUG_ON(PIN_USER
!= I915_VMA_LOCAL_BIND
);
652 /* Pin early to prevent the shrinker/eviction logic from destroying
653 * our vma as we insert and bind.
655 if (likely(((++vma
->flags
^ flags
) & I915_VMA_BIND_MASK
) == 0))
658 return __i915_vma_do_pin(vma
, size
, alignment
, flags
);
661 static inline int i915_vma_pin_count(const struct i915_vma
*vma
)
663 return vma
->flags
& I915_VMA_PIN_MASK
;
666 static inline bool i915_vma_is_pinned(const struct i915_vma
*vma
)
668 return i915_vma_pin_count(vma
);
671 static inline void __i915_vma_pin(struct i915_vma
*vma
)
674 GEM_BUG_ON(vma
->flags
& I915_VMA_PIN_OVERFLOW
);
677 static inline void __i915_vma_unpin(struct i915_vma
*vma
)
679 GEM_BUG_ON(!i915_vma_is_pinned(vma
));
683 static inline void i915_vma_unpin(struct i915_vma
*vma
)
685 GEM_BUG_ON(!drm_mm_node_allocated(&vma
->node
));
686 __i915_vma_unpin(vma
);
690 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture
693 * The passed in VMA has to be pinned in the global GTT mappable region.
694 * An extra pinning of the VMA is acquired for the return iomapping,
695 * the caller must call i915_vma_unpin_iomap to relinquish the pinning
696 * after the iomapping is no longer required.
698 * Callers must hold the struct_mutex.
700 * Returns a valid iomapped pointer or ERR_PTR.
702 void __iomem
*i915_vma_pin_iomap(struct i915_vma
*vma
);
703 #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x))
706 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap
709 * Unpins the previously iomapped VMA from i915_vma_pin_iomap().
711 * Callers must hold the struct_mutex. This function is only valid to be
712 * called on a VMA previously iomapped by the caller with i915_vma_pin_iomap().
714 static inline void i915_vma_unpin_iomap(struct i915_vma
*vma
)
716 lockdep_assert_held(&vma
->vm
->dev
->struct_mutex
);
717 GEM_BUG_ON(vma
->iomap
== NULL
);
721 static inline struct page
*i915_vma_first_page(struct i915_vma
*vma
)
723 GEM_BUG_ON(!vma
->pages
);
724 return sg_page(vma
->pages
->sgl
);