198932149SChris Wilson /* 298932149SChris Wilson * SPDX-License-Identifier: MIT 398932149SChris Wilson * 498932149SChris Wilson * Copyright © 2016 Intel Corporation 598932149SChris Wilson */ 698932149SChris Wilson 798932149SChris Wilson #ifndef __I915_GEM_OBJECT_H__ 898932149SChris Wilson #define __I915_GEM_OBJECT_H__ 998932149SChris Wilson 1098932149SChris Wilson #include <drm/drm_gem.h> 1198932149SChris Wilson #include <drm/drm_file.h> 1298932149SChris Wilson #include <drm/drm_device.h> 1398932149SChris Wilson 14da42104fSChris Wilson #include "display/intel_frontbuffer.h" 1598932149SChris Wilson #include "i915_gem_object_types.h" 16f0e4a063SChris Wilson #include "i915_gem_gtt.h" 172c86e55dSMatthew Auld #include "i915_vma_types.h" 18f0e4a063SChris Wilson 198475355fSChris Wilson void i915_gem_init__objects(struct drm_i915_private *i915); 208475355fSChris Wilson 2198932149SChris Wilson struct drm_i915_gem_object *i915_gem_object_alloc(void); 2298932149SChris Wilson void i915_gem_object_free(struct drm_i915_gem_object *obj); 2398932149SChris Wilson 248475355fSChris Wilson void i915_gem_object_init(struct drm_i915_gem_object *obj, 257867d709SChris Wilson const struct drm_i915_gem_object_ops *ops, 267867d709SChris Wilson struct lock_class_key *key); 278475355fSChris Wilson struct drm_i915_gem_object * 28da1184cdSMatthew Auld i915_gem_object_create_shmem(struct drm_i915_private *i915, 29da1184cdSMatthew Auld resource_size_t size); 308475355fSChris Wilson struct drm_i915_gem_object * 318475355fSChris Wilson i915_gem_object_create_shmem_from_data(struct drm_i915_private *i915, 32da1184cdSMatthew Auld const void *data, resource_size_t size); 338475355fSChris Wilson 348475355fSChris Wilson extern const struct drm_i915_gem_object_ops i915_gem_shmem_ops; 358475355fSChris Wilson void __i915_gem_object_release_shmem(struct drm_i915_gem_object *obj, 368475355fSChris Wilson struct sg_table *pages, 378475355fSChris Wilson bool needs_clflush); 388475355fSChris Wilson 39f033428dSChris Wilson int i915_gem_object_attach_phys(struct drm_i915_gem_object *obj, int align); 40f033428dSChris Wilson 418475355fSChris Wilson void i915_gem_close_object(struct drm_gem_object *gem, struct drm_file *file); 428475355fSChris Wilson void i915_gem_free_object(struct drm_gem_object *obj); 438475355fSChris Wilson 448475355fSChris Wilson void i915_gem_flush_free_objects(struct drm_i915_private *i915); 458475355fSChris Wilson 46f033428dSChris Wilson struct sg_table * 47f033428dSChris Wilson __i915_gem_object_unset_pages(struct drm_i915_gem_object *obj); 48f033428dSChris Wilson void i915_gem_object_truncate(struct drm_i915_gem_object *obj); 49f033428dSChris Wilson 5098932149SChris Wilson /** 5198932149SChris Wilson * i915_gem_object_lookup_rcu - look up a temporary GEM object from its handle 5298932149SChris Wilson * @filp: DRM file private date 5398932149SChris Wilson * @handle: userspace handle 5498932149SChris Wilson * 5598932149SChris Wilson * Returns: 5698932149SChris Wilson * 5798932149SChris Wilson * A pointer to the object named by the handle if such exists on @filp, NULL 5898932149SChris Wilson * otherwise. This object is only valid whilst under the RCU read lock, and 5998932149SChris Wilson * note carefully the object may be in the process of being destroyed. 6098932149SChris Wilson */ 6198932149SChris Wilson static inline struct drm_i915_gem_object * 6298932149SChris Wilson i915_gem_object_lookup_rcu(struct drm_file *file, u32 handle) 6398932149SChris Wilson { 6498932149SChris Wilson #ifdef CONFIG_LOCKDEP 6598932149SChris Wilson WARN_ON(debug_locks && !lock_is_held(&rcu_lock_map)); 6698932149SChris Wilson #endif 6798932149SChris Wilson return idr_find(&file->object_idr, handle); 6898932149SChris Wilson } 6998932149SChris Wilson 7098932149SChris Wilson static inline struct drm_i915_gem_object * 71280d14a6SChris Wilson i915_gem_object_get_rcu(struct drm_i915_gem_object *obj) 72280d14a6SChris Wilson { 73280d14a6SChris Wilson if (obj && !kref_get_unless_zero(&obj->base.refcount)) 74280d14a6SChris Wilson obj = NULL; 75280d14a6SChris Wilson 76280d14a6SChris Wilson return obj; 77280d14a6SChris Wilson } 78280d14a6SChris Wilson 79280d14a6SChris Wilson static inline struct drm_i915_gem_object * 8098932149SChris Wilson i915_gem_object_lookup(struct drm_file *file, u32 handle) 8198932149SChris Wilson { 8298932149SChris Wilson struct drm_i915_gem_object *obj; 8398932149SChris Wilson 8498932149SChris Wilson rcu_read_lock(); 8598932149SChris Wilson obj = i915_gem_object_lookup_rcu(file, handle); 86280d14a6SChris Wilson obj = i915_gem_object_get_rcu(obj); 8798932149SChris Wilson rcu_read_unlock(); 8898932149SChris Wilson 8998932149SChris Wilson return obj; 9098932149SChris Wilson } 9198932149SChris Wilson 9298932149SChris Wilson __deprecated 93b5893ffcSJanusz Krzysztofik struct drm_gem_object * 9498932149SChris Wilson drm_gem_object_lookup(struct drm_file *file, u32 handle); 9598932149SChris Wilson 9698932149SChris Wilson __attribute__((nonnull)) 9798932149SChris Wilson static inline struct drm_i915_gem_object * 9898932149SChris Wilson i915_gem_object_get(struct drm_i915_gem_object *obj) 9998932149SChris Wilson { 10098932149SChris Wilson drm_gem_object_get(&obj->base); 10198932149SChris Wilson return obj; 10298932149SChris Wilson } 10398932149SChris Wilson 10498932149SChris Wilson __attribute__((nonnull)) 10598932149SChris Wilson static inline void 10698932149SChris Wilson i915_gem_object_put(struct drm_i915_gem_object *obj) 10798932149SChris Wilson { 10898932149SChris Wilson __drm_gem_object_put(&obj->base); 10998932149SChris Wilson } 11098932149SChris Wilson 11152791eeeSChristian König #define assert_object_held(obj) dma_resv_assert_held((obj)->base.resv) 1126951e589SChris Wilson 11380f0b679SMaarten Lankhorst static inline int __i915_gem_object_lock(struct drm_i915_gem_object *obj, 11480f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww, 11580f0b679SMaarten Lankhorst bool intr) 11698932149SChris Wilson { 11780f0b679SMaarten Lankhorst int ret; 11880f0b679SMaarten Lankhorst 11980f0b679SMaarten Lankhorst if (intr) 12080f0b679SMaarten Lankhorst ret = dma_resv_lock_interruptible(obj->base.resv, ww ? &ww->ctx : NULL); 12180f0b679SMaarten Lankhorst else 12280f0b679SMaarten Lankhorst ret = dma_resv_lock(obj->base.resv, ww ? &ww->ctx : NULL); 12380f0b679SMaarten Lankhorst 12480f0b679SMaarten Lankhorst if (!ret && ww) 12580f0b679SMaarten Lankhorst list_add_tail(&obj->obj_link, &ww->obj_list); 12680f0b679SMaarten Lankhorst if (ret == -EALREADY) 12780f0b679SMaarten Lankhorst ret = 0; 12880f0b679SMaarten Lankhorst 12980f0b679SMaarten Lankhorst if (ret == -EDEADLK) 13080f0b679SMaarten Lankhorst ww->contended = obj; 13180f0b679SMaarten Lankhorst 13280f0b679SMaarten Lankhorst return ret; 13380f0b679SMaarten Lankhorst } 13480f0b679SMaarten Lankhorst 13580f0b679SMaarten Lankhorst static inline int i915_gem_object_lock(struct drm_i915_gem_object *obj, 13680f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww) 13780f0b679SMaarten Lankhorst { 13880f0b679SMaarten Lankhorst return __i915_gem_object_lock(obj, ww, ww && ww->intr); 13980f0b679SMaarten Lankhorst } 14080f0b679SMaarten Lankhorst 14180f0b679SMaarten Lankhorst static inline int i915_gem_object_lock_interruptible(struct drm_i915_gem_object *obj, 14280f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww) 14380f0b679SMaarten Lankhorst { 14480f0b679SMaarten Lankhorst WARN_ON(ww && !ww->intr); 14580f0b679SMaarten Lankhorst return __i915_gem_object_lock(obj, ww, true); 14698932149SChris Wilson } 14798932149SChris Wilson 1482850748eSChris Wilson static inline bool i915_gem_object_trylock(struct drm_i915_gem_object *obj) 1492850748eSChris Wilson { 1502850748eSChris Wilson return dma_resv_trylock(obj->base.resv); 1512850748eSChris Wilson } 1522850748eSChris Wilson 15398932149SChris Wilson static inline void i915_gem_object_unlock(struct drm_i915_gem_object *obj) 15498932149SChris Wilson { 15552791eeeSChristian König dma_resv_unlock(obj->base.resv); 15698932149SChris Wilson } 15798932149SChris Wilson 1586951e589SChris Wilson struct dma_fence * 1596951e589SChris Wilson i915_gem_object_lock_fence(struct drm_i915_gem_object *obj); 1606951e589SChris Wilson void i915_gem_object_unlock_fence(struct drm_i915_gem_object *obj, 1616951e589SChris Wilson struct dma_fence *fence); 1626951e589SChris Wilson 16398932149SChris Wilson static inline void 16498932149SChris Wilson i915_gem_object_set_readonly(struct drm_i915_gem_object *obj) 16598932149SChris Wilson { 166cc662126SAbdiel Janulgue obj->flags |= I915_BO_READONLY; 16798932149SChris Wilson } 16898932149SChris Wilson 16998932149SChris Wilson static inline bool 17098932149SChris Wilson i915_gem_object_is_readonly(const struct drm_i915_gem_object *obj) 17198932149SChris Wilson { 172cc662126SAbdiel Janulgue return obj->flags & I915_BO_READONLY; 17398932149SChris Wilson } 17498932149SChris Wilson 17598932149SChris Wilson static inline bool 1762f0b97caSMatthew Auld i915_gem_object_is_contiguous(const struct drm_i915_gem_object *obj) 1772f0b97caSMatthew Auld { 1782f0b97caSMatthew Auld return obj->flags & I915_BO_ALLOC_CONTIGUOUS; 1792f0b97caSMatthew Auld } 1802f0b97caSMatthew Auld 1812f0b97caSMatthew Auld static inline bool 1827c98501aSMatthew Auld i915_gem_object_is_volatile(const struct drm_i915_gem_object *obj) 1837c98501aSMatthew Auld { 1847c98501aSMatthew Auld return obj->flags & I915_BO_ALLOC_VOLATILE; 1857c98501aSMatthew Auld } 1867c98501aSMatthew Auld 1877c98501aSMatthew Auld static inline void 1887c98501aSMatthew Auld i915_gem_object_set_volatile(struct drm_i915_gem_object *obj) 1897c98501aSMatthew Auld { 1907c98501aSMatthew Auld obj->flags |= I915_BO_ALLOC_VOLATILE; 1917c98501aSMatthew Auld } 1927c98501aSMatthew Auld 1937c98501aSMatthew Auld static inline bool 1943cbad5d7SChris Wilson i915_gem_object_type_has(const struct drm_i915_gem_object *obj, 1953cbad5d7SChris Wilson unsigned long flags) 1963cbad5d7SChris Wilson { 1973cbad5d7SChris Wilson return obj->ops->flags & flags; 1983cbad5d7SChris Wilson } 1993cbad5d7SChris Wilson 2003cbad5d7SChris Wilson static inline bool 20198932149SChris Wilson i915_gem_object_has_struct_page(const struct drm_i915_gem_object *obj) 20298932149SChris Wilson { 2033cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_HAS_STRUCT_PAGE); 20498932149SChris Wilson } 20598932149SChris Wilson 20698932149SChris Wilson static inline bool 20798932149SChris Wilson i915_gem_object_is_shrinkable(const struct drm_i915_gem_object *obj) 20898932149SChris Wilson { 2093cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_IS_SHRINKABLE); 21098932149SChris Wilson } 21198932149SChris Wilson 21298932149SChris Wilson static inline bool 21398932149SChris Wilson i915_gem_object_is_proxy(const struct drm_i915_gem_object *obj) 21498932149SChris Wilson { 2153cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_IS_PROXY); 21698932149SChris Wilson } 21798932149SChris Wilson 21898932149SChris Wilson static inline bool 219f6c26b55SJanusz Krzysztofik i915_gem_object_never_mmap(const struct drm_i915_gem_object *obj) 220a4311745SChris Wilson { 221f6c26b55SJanusz Krzysztofik return i915_gem_object_type_has(obj, I915_GEM_OBJECT_NO_MMAP); 222a4311745SChris Wilson } 223a4311745SChris Wilson 224a4311745SChris Wilson static inline bool 22598932149SChris Wilson i915_gem_object_needs_async_cancel(const struct drm_i915_gem_object *obj) 22698932149SChris Wilson { 2273cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_ASYNC_CANCEL); 22898932149SChris Wilson } 22998932149SChris Wilson 23098932149SChris Wilson static inline bool 23198932149SChris Wilson i915_gem_object_is_framebuffer(const struct drm_i915_gem_object *obj) 23298932149SChris Wilson { 2338e7cb179SChris Wilson return READ_ONCE(obj->frontbuffer); 23498932149SChris Wilson } 23598932149SChris Wilson 23698932149SChris Wilson static inline unsigned int 23798932149SChris Wilson i915_gem_object_get_tiling(const struct drm_i915_gem_object *obj) 23898932149SChris Wilson { 23998932149SChris Wilson return obj->tiling_and_stride & TILING_MASK; 24098932149SChris Wilson } 24198932149SChris Wilson 24298932149SChris Wilson static inline bool 24398932149SChris Wilson i915_gem_object_is_tiled(const struct drm_i915_gem_object *obj) 24498932149SChris Wilson { 24598932149SChris Wilson return i915_gem_object_get_tiling(obj) != I915_TILING_NONE; 24698932149SChris Wilson } 24798932149SChris Wilson 24898932149SChris Wilson static inline unsigned int 24998932149SChris Wilson i915_gem_object_get_stride(const struct drm_i915_gem_object *obj) 25098932149SChris Wilson { 25198932149SChris Wilson return obj->tiling_and_stride & STRIDE_MASK; 25298932149SChris Wilson } 25398932149SChris Wilson 25498932149SChris Wilson static inline unsigned int 25598932149SChris Wilson i915_gem_tile_height(unsigned int tiling) 25698932149SChris Wilson { 25798932149SChris Wilson GEM_BUG_ON(!tiling); 25898932149SChris Wilson return tiling == I915_TILING_Y ? 32 : 8; 25998932149SChris Wilson } 26098932149SChris Wilson 26198932149SChris Wilson static inline unsigned int 26298932149SChris Wilson i915_gem_object_get_tile_height(const struct drm_i915_gem_object *obj) 26398932149SChris Wilson { 26498932149SChris Wilson return i915_gem_tile_height(i915_gem_object_get_tiling(obj)); 26598932149SChris Wilson } 26698932149SChris Wilson 26798932149SChris Wilson static inline unsigned int 26898932149SChris Wilson i915_gem_object_get_tile_row_size(const struct drm_i915_gem_object *obj) 26998932149SChris Wilson { 27098932149SChris Wilson return (i915_gem_object_get_stride(obj) * 27198932149SChris Wilson i915_gem_object_get_tile_height(obj)); 27298932149SChris Wilson } 27398932149SChris Wilson 27498932149SChris Wilson int i915_gem_object_set_tiling(struct drm_i915_gem_object *obj, 27598932149SChris Wilson unsigned int tiling, unsigned int stride); 27698932149SChris Wilson 27798932149SChris Wilson struct scatterlist * 278*934941edSTvrtko Ursulin __i915_gem_object_get_sg(struct drm_i915_gem_object *obj, 279*934941edSTvrtko Ursulin struct i915_gem_object_page_iter *iter, 280*934941edSTvrtko Ursulin unsigned int n, 281*934941edSTvrtko Ursulin unsigned int *offset); 282*934941edSTvrtko Ursulin 283*934941edSTvrtko Ursulin static inline struct scatterlist * 28498932149SChris Wilson i915_gem_object_get_sg(struct drm_i915_gem_object *obj, 285*934941edSTvrtko Ursulin unsigned int n, 286*934941edSTvrtko Ursulin unsigned int *offset) 287*934941edSTvrtko Ursulin { 288*934941edSTvrtko Ursulin return __i915_gem_object_get_sg(obj, &obj->mm.get_page, n, offset); 289*934941edSTvrtko Ursulin } 290*934941edSTvrtko Ursulin 291*934941edSTvrtko Ursulin static inline struct scatterlist * 292*934941edSTvrtko Ursulin i915_gem_object_get_sg_dma(struct drm_i915_gem_object *obj, 293*934941edSTvrtko Ursulin unsigned int n, 294*934941edSTvrtko Ursulin unsigned int *offset) 295*934941edSTvrtko Ursulin { 296*934941edSTvrtko Ursulin return __i915_gem_object_get_sg(obj, &obj->mm.get_dma_page, n, offset); 297*934941edSTvrtko Ursulin } 29898932149SChris Wilson 29998932149SChris Wilson struct page * 30098932149SChris Wilson i915_gem_object_get_page(struct drm_i915_gem_object *obj, 30198932149SChris Wilson unsigned int n); 30298932149SChris Wilson 30398932149SChris Wilson dma_addr_t 30498932149SChris Wilson i915_gem_object_get_dma_address_len(struct drm_i915_gem_object *obj, 30598932149SChris Wilson unsigned long n, 30698932149SChris Wilson unsigned int *len); 30798932149SChris Wilson 30898932149SChris Wilson dma_addr_t 30998932149SChris Wilson i915_gem_object_get_dma_address(struct drm_i915_gem_object *obj, 31098932149SChris Wilson unsigned long n); 31198932149SChris Wilson 31298932149SChris Wilson void __i915_gem_object_set_pages(struct drm_i915_gem_object *obj, 31398932149SChris Wilson struct sg_table *pages, 31498932149SChris Wilson unsigned int sg_page_sizes); 315f033428dSChris Wilson 316f033428dSChris Wilson int ____i915_gem_object_get_pages(struct drm_i915_gem_object *obj); 31798932149SChris Wilson int __i915_gem_object_get_pages(struct drm_i915_gem_object *obj); 31898932149SChris Wilson 31974ceefd1SDaniel Vetter enum i915_mm_subclass { /* lockdep subclass for obj->mm.lock/struct_mutex */ 32074ceefd1SDaniel Vetter I915_MM_NORMAL = 0, 32174ceefd1SDaniel Vetter /* 32274ceefd1SDaniel Vetter * Only used by struct_mutex, when called "recursively" from 32374ceefd1SDaniel Vetter * direct-reclaim-esque. Safe because there is only every one 32474ceefd1SDaniel Vetter * struct_mutex in the entire system. 32574ceefd1SDaniel Vetter */ 32674ceefd1SDaniel Vetter I915_MM_SHRINKER = 1, 32774ceefd1SDaniel Vetter /* 32874ceefd1SDaniel Vetter * Used for obj->mm.lock when allocating pages. Safe because the object 32974ceefd1SDaniel Vetter * isn't yet on any LRU, and therefore the shrinker can't deadlock on 33074ceefd1SDaniel Vetter * it. As soon as the object has pages, obj->mm.lock nests within 33174ceefd1SDaniel Vetter * fs_reclaim. 33274ceefd1SDaniel Vetter */ 33374ceefd1SDaniel Vetter I915_MM_GET_PAGES = 1, 33474ceefd1SDaniel Vetter }; 33574ceefd1SDaniel Vetter 33698932149SChris Wilson static inline int __must_check 33798932149SChris Wilson i915_gem_object_pin_pages(struct drm_i915_gem_object *obj) 33898932149SChris Wilson { 33974ceefd1SDaniel Vetter might_lock_nested(&obj->mm.lock, I915_MM_GET_PAGES); 34098932149SChris Wilson 34198932149SChris Wilson if (atomic_inc_not_zero(&obj->mm.pages_pin_count)) 34298932149SChris Wilson return 0; 34398932149SChris Wilson 34498932149SChris Wilson return __i915_gem_object_get_pages(obj); 34598932149SChris Wilson } 34698932149SChris Wilson 34798932149SChris Wilson static inline bool 34898932149SChris Wilson i915_gem_object_has_pages(struct drm_i915_gem_object *obj) 34998932149SChris Wilson { 35098932149SChris Wilson return !IS_ERR_OR_NULL(READ_ONCE(obj->mm.pages)); 35198932149SChris Wilson } 35298932149SChris Wilson 35398932149SChris Wilson static inline void 35498932149SChris Wilson __i915_gem_object_pin_pages(struct drm_i915_gem_object *obj) 35598932149SChris Wilson { 35698932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pages(obj)); 35798932149SChris Wilson 35898932149SChris Wilson atomic_inc(&obj->mm.pages_pin_count); 35998932149SChris Wilson } 36098932149SChris Wilson 36198932149SChris Wilson static inline bool 36298932149SChris Wilson i915_gem_object_has_pinned_pages(struct drm_i915_gem_object *obj) 36398932149SChris Wilson { 36498932149SChris Wilson return atomic_read(&obj->mm.pages_pin_count); 36598932149SChris Wilson } 36698932149SChris Wilson 36798932149SChris Wilson static inline void 36898932149SChris Wilson __i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj) 36998932149SChris Wilson { 37098932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pages(obj)); 37198932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pinned_pages(obj)); 37298932149SChris Wilson 37398932149SChris Wilson atomic_dec(&obj->mm.pages_pin_count); 37498932149SChris Wilson } 37598932149SChris Wilson 37698932149SChris Wilson static inline void 37798932149SChris Wilson i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj) 37898932149SChris Wilson { 37998932149SChris Wilson __i915_gem_object_unpin_pages(obj); 38098932149SChris Wilson } 38198932149SChris Wilson 382f86dbacbSDaniel Vetter int __i915_gem_object_put_pages(struct drm_i915_gem_object *obj); 383f033428dSChris Wilson void i915_gem_object_truncate(struct drm_i915_gem_object *obj); 384f033428dSChris Wilson void i915_gem_object_writeback(struct drm_i915_gem_object *obj); 38598932149SChris Wilson 38698932149SChris Wilson enum i915_map_type { 38798932149SChris Wilson I915_MAP_WB = 0, 38898932149SChris Wilson I915_MAP_WC, 38998932149SChris Wilson #define I915_MAP_OVERRIDE BIT(31) 39098932149SChris Wilson I915_MAP_FORCE_WB = I915_MAP_WB | I915_MAP_OVERRIDE, 39198932149SChris Wilson I915_MAP_FORCE_WC = I915_MAP_WC | I915_MAP_OVERRIDE, 39298932149SChris Wilson }; 39398932149SChris Wilson 39498932149SChris Wilson /** 39598932149SChris Wilson * i915_gem_object_pin_map - return a contiguous mapping of the entire object 39698932149SChris Wilson * @obj: the object to map into kernel address space 39798932149SChris Wilson * @type: the type of mapping, used to select pgprot_t 39898932149SChris Wilson * 39998932149SChris Wilson * Calls i915_gem_object_pin_pages() to prevent reaping of the object's 40098932149SChris Wilson * pages and then returns a contiguous mapping of the backing storage into 40198932149SChris Wilson * the kernel address space. Based on the @type of mapping, the PTE will be 40298932149SChris Wilson * set to either WriteBack or WriteCombine (via pgprot_t). 40398932149SChris Wilson * 40498932149SChris Wilson * The caller is responsible for calling i915_gem_object_unpin_map() when the 40598932149SChris Wilson * mapping is no longer required. 40698932149SChris Wilson * 40798932149SChris Wilson * Returns the pointer through which to access the mapped object, or an 40898932149SChris Wilson * ERR_PTR() on error. 40998932149SChris Wilson */ 41098932149SChris Wilson void *__must_check i915_gem_object_pin_map(struct drm_i915_gem_object *obj, 41198932149SChris Wilson enum i915_map_type type); 41298932149SChris Wilson 41398932149SChris Wilson void __i915_gem_object_flush_map(struct drm_i915_gem_object *obj, 41498932149SChris Wilson unsigned long offset, 41598932149SChris Wilson unsigned long size); 41698932149SChris Wilson static inline void i915_gem_object_flush_map(struct drm_i915_gem_object *obj) 41798932149SChris Wilson { 41898932149SChris Wilson __i915_gem_object_flush_map(obj, 0, obj->base.size); 41998932149SChris Wilson } 42098932149SChris Wilson 42198932149SChris Wilson /** 42298932149SChris Wilson * i915_gem_object_unpin_map - releases an earlier mapping 42398932149SChris Wilson * @obj: the object to unmap 42498932149SChris Wilson * 42598932149SChris Wilson * After pinning the object and mapping its pages, once you are finished 42698932149SChris Wilson * with your access, call i915_gem_object_unpin_map() to release the pin 42798932149SChris Wilson * upon the mapping. Once the pin count reaches zero, that mapping may be 42898932149SChris Wilson * removed. 42998932149SChris Wilson */ 43098932149SChris Wilson static inline void i915_gem_object_unpin_map(struct drm_i915_gem_object *obj) 43198932149SChris Wilson { 43298932149SChris Wilson i915_gem_object_unpin_pages(obj); 43398932149SChris Wilson } 43498932149SChris Wilson 43589d19b2bSChris Wilson void __i915_gem_object_release_map(struct drm_i915_gem_object *obj); 43689d19b2bSChris Wilson 437b414fcd5SChris Wilson void 438b414fcd5SChris Wilson i915_gem_object_flush_write_domain(struct drm_i915_gem_object *obj, 439b414fcd5SChris Wilson unsigned int flush_domains); 440b414fcd5SChris Wilson 441f0e4a063SChris Wilson int i915_gem_object_prepare_read(struct drm_i915_gem_object *obj, 442f0e4a063SChris Wilson unsigned int *needs_clflush); 443f0e4a063SChris Wilson int i915_gem_object_prepare_write(struct drm_i915_gem_object *obj, 444f0e4a063SChris Wilson unsigned int *needs_clflush); 445f0e4a063SChris Wilson #define CLFLUSH_BEFORE BIT(0) 446f0e4a063SChris Wilson #define CLFLUSH_AFTER BIT(1) 447f0e4a063SChris Wilson #define CLFLUSH_FLAGS (CLFLUSH_BEFORE | CLFLUSH_AFTER) 448f0e4a063SChris Wilson 449f0e4a063SChris Wilson static inline void 450f0e4a063SChris Wilson i915_gem_object_finish_access(struct drm_i915_gem_object *obj) 451f0e4a063SChris Wilson { 452f0e4a063SChris Wilson i915_gem_object_unpin_pages(obj); 453f0e4a063SChris Wilson } 454f0e4a063SChris Wilson 45598932149SChris Wilson static inline struct intel_engine_cs * 45698932149SChris Wilson i915_gem_object_last_write_engine(struct drm_i915_gem_object *obj) 45798932149SChris Wilson { 45898932149SChris Wilson struct intel_engine_cs *engine = NULL; 45998932149SChris Wilson struct dma_fence *fence; 46098932149SChris Wilson 46198932149SChris Wilson rcu_read_lock(); 46252791eeeSChristian König fence = dma_resv_get_excl_rcu(obj->base.resv); 46398932149SChris Wilson rcu_read_unlock(); 46498932149SChris Wilson 46598932149SChris Wilson if (fence && dma_fence_is_i915(fence) && !dma_fence_is_signaled(fence)) 46698932149SChris Wilson engine = to_request(fence)->engine; 46798932149SChris Wilson dma_fence_put(fence); 46898932149SChris Wilson 46998932149SChris Wilson return engine; 47098932149SChris Wilson } 47198932149SChris Wilson 47298932149SChris Wilson void i915_gem_object_set_cache_coherency(struct drm_i915_gem_object *obj, 47398932149SChris Wilson unsigned int cache_level); 47498932149SChris Wilson void i915_gem_object_flush_if_display(struct drm_i915_gem_object *obj); 475c1793ba8SMaarten Lankhorst void i915_gem_object_flush_if_display_locked(struct drm_i915_gem_object *obj); 47698932149SChris Wilson 477f0e4a063SChris Wilson int __must_check 478f0e4a063SChris Wilson i915_gem_object_set_to_wc_domain(struct drm_i915_gem_object *obj, bool write); 479f0e4a063SChris Wilson int __must_check 480f0e4a063SChris Wilson i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj, bool write); 481f0e4a063SChris Wilson int __must_check 482f0e4a063SChris Wilson i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write); 483f0e4a063SChris Wilson struct i915_vma * __must_check 484f0e4a063SChris Wilson i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj, 485f0e4a063SChris Wilson u32 alignment, 486f0e4a063SChris Wilson const struct i915_ggtt_view *view, 487f0e4a063SChris Wilson unsigned int flags); 488f0e4a063SChris Wilson void i915_gem_object_unpin_from_display_plane(struct i915_vma *vma); 489f0e4a063SChris Wilson 4901aff1903SChris Wilson void i915_gem_object_make_unshrinkable(struct drm_i915_gem_object *obj); 4911aff1903SChris Wilson void i915_gem_object_make_shrinkable(struct drm_i915_gem_object *obj); 4921aff1903SChris Wilson void i915_gem_object_make_purgeable(struct drm_i915_gem_object *obj); 4931aff1903SChris Wilson 4948475355fSChris Wilson static inline bool cpu_write_needs_clflush(struct drm_i915_gem_object *obj) 4958475355fSChris Wilson { 4968475355fSChris Wilson if (obj->cache_dirty) 4978475355fSChris Wilson return false; 4988475355fSChris Wilson 4998475355fSChris Wilson if (!(obj->cache_coherent & I915_BO_CACHE_COHERENT_FOR_WRITE)) 5008475355fSChris Wilson return true; 5018475355fSChris Wilson 5025a90606dSChris Wilson /* Currently in use by HW (display engine)? Keep flushed. */ 5035a90606dSChris Wilson return i915_gem_object_is_framebuffer(obj); 5048475355fSChris Wilson } 5058475355fSChris Wilson 5068475355fSChris Wilson static inline void __start_cpu_write(struct drm_i915_gem_object *obj) 5078475355fSChris Wilson { 5088475355fSChris Wilson obj->read_domains = I915_GEM_DOMAIN_CPU; 5098475355fSChris Wilson obj->write_domain = I915_GEM_DOMAIN_CPU; 5108475355fSChris Wilson if (cpu_write_needs_clflush(obj)) 5118475355fSChris Wilson obj->cache_dirty = true; 5128475355fSChris Wilson } 51398932149SChris Wilson 514d45a1a53SChris Wilson int i915_gem_object_wait(struct drm_i915_gem_object *obj, 515d45a1a53SChris Wilson unsigned int flags, 516d45a1a53SChris Wilson long timeout); 517d45a1a53SChris Wilson int i915_gem_object_wait_priority(struct drm_i915_gem_object *obj, 518d45a1a53SChris Wilson unsigned int flags, 519d45a1a53SChris Wilson const struct i915_sched_attr *attr); 520d45a1a53SChris Wilson 521da42104fSChris Wilson void __i915_gem_object_flush_frontbuffer(struct drm_i915_gem_object *obj, 522da42104fSChris Wilson enum fb_op_origin origin); 523da42104fSChris Wilson void __i915_gem_object_invalidate_frontbuffer(struct drm_i915_gem_object *obj, 524da42104fSChris Wilson enum fb_op_origin origin); 525da42104fSChris Wilson 526da42104fSChris Wilson static inline void 527da42104fSChris Wilson i915_gem_object_flush_frontbuffer(struct drm_i915_gem_object *obj, 528da42104fSChris Wilson enum fb_op_origin origin) 529da42104fSChris Wilson { 530da42104fSChris Wilson if (unlikely(rcu_access_pointer(obj->frontbuffer))) 531da42104fSChris Wilson __i915_gem_object_flush_frontbuffer(obj, origin); 532da42104fSChris Wilson } 533da42104fSChris Wilson 534da42104fSChris Wilson static inline void 535da42104fSChris Wilson i915_gem_object_invalidate_frontbuffer(struct drm_i915_gem_object *obj, 536da42104fSChris Wilson enum fb_op_origin origin) 537da42104fSChris Wilson { 538da42104fSChris Wilson if (unlikely(rcu_access_pointer(obj->frontbuffer))) 539da42104fSChris Wilson __i915_gem_object_invalidate_frontbuffer(obj, origin); 540da42104fSChris Wilson } 541da42104fSChris Wilson 54298932149SChris Wilson #endif 543