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, 26c471748dSMaarten Lankhorst struct lock_class_key *key, 27c471748dSMaarten Lankhorst unsigned alloc_flags); 288475355fSChris Wilson struct drm_i915_gem_object * 29da1184cdSMatthew Auld i915_gem_object_create_shmem(struct drm_i915_private *i915, 30da1184cdSMatthew Auld resource_size_t size); 318475355fSChris Wilson struct drm_i915_gem_object * 328475355fSChris Wilson i915_gem_object_create_shmem_from_data(struct drm_i915_private *i915, 33da1184cdSMatthew Auld const void *data, resource_size_t size); 348475355fSChris Wilson 358475355fSChris Wilson extern const struct drm_i915_gem_object_ops i915_gem_shmem_ops; 36ed29c269SMaarten Lankhorst 378475355fSChris Wilson void __i915_gem_object_release_shmem(struct drm_i915_gem_object *obj, 388475355fSChris Wilson struct sg_table *pages, 398475355fSChris Wilson bool needs_clflush); 408475355fSChris Wilson 41a6117097SMaarten Lankhorst int i915_gem_object_pwrite_phys(struct drm_i915_gem_object *obj, 42a6117097SMaarten Lankhorst const struct drm_i915_gem_pwrite *args); 43a6117097SMaarten Lankhorst int i915_gem_object_pread_phys(struct drm_i915_gem_object *obj, 44a6117097SMaarten Lankhorst const struct drm_i915_gem_pread *args); 45a6117097SMaarten Lankhorst 46f033428dSChris Wilson int i915_gem_object_attach_phys(struct drm_i915_gem_object *obj, int align); 47a85fffe3SMaarten Lankhorst void i915_gem_object_put_pages_shmem(struct drm_i915_gem_object *obj, 48a85fffe3SMaarten Lankhorst struct sg_table *pages); 49a6117097SMaarten Lankhorst void i915_gem_object_put_pages_phys(struct drm_i915_gem_object *obj, 50a6117097SMaarten Lankhorst struct sg_table *pages); 51a6117097SMaarten Lankhorst 528475355fSChris Wilson void i915_gem_flush_free_objects(struct drm_i915_private *i915); 538475355fSChris Wilson 54f033428dSChris Wilson struct sg_table * 55f033428dSChris Wilson __i915_gem_object_unset_pages(struct drm_i915_gem_object *obj); 56f033428dSChris Wilson void i915_gem_object_truncate(struct drm_i915_gem_object *obj); 57f033428dSChris Wilson 5898932149SChris Wilson /** 5998932149SChris Wilson * i915_gem_object_lookup_rcu - look up a temporary GEM object from its handle 6098932149SChris Wilson * @filp: DRM file private date 6198932149SChris Wilson * @handle: userspace handle 6298932149SChris Wilson * 6398932149SChris Wilson * Returns: 6498932149SChris Wilson * 6598932149SChris Wilson * A pointer to the object named by the handle if such exists on @filp, NULL 6698932149SChris Wilson * otherwise. This object is only valid whilst under the RCU read lock, and 6798932149SChris Wilson * note carefully the object may be in the process of being destroyed. 6898932149SChris Wilson */ 6998932149SChris Wilson static inline struct drm_i915_gem_object * 7098932149SChris Wilson i915_gem_object_lookup_rcu(struct drm_file *file, u32 handle) 7198932149SChris Wilson { 7298932149SChris Wilson #ifdef CONFIG_LOCKDEP 7398932149SChris Wilson WARN_ON(debug_locks && !lock_is_held(&rcu_lock_map)); 7498932149SChris Wilson #endif 7598932149SChris Wilson return idr_find(&file->object_idr, handle); 7698932149SChris Wilson } 7798932149SChris Wilson 7898932149SChris Wilson static inline struct drm_i915_gem_object * 79280d14a6SChris Wilson i915_gem_object_get_rcu(struct drm_i915_gem_object *obj) 80280d14a6SChris Wilson { 81280d14a6SChris Wilson if (obj && !kref_get_unless_zero(&obj->base.refcount)) 82280d14a6SChris Wilson obj = NULL; 83280d14a6SChris Wilson 84280d14a6SChris Wilson return obj; 85280d14a6SChris Wilson } 86280d14a6SChris Wilson 87280d14a6SChris Wilson static inline struct drm_i915_gem_object * 8898932149SChris Wilson i915_gem_object_lookup(struct drm_file *file, u32 handle) 8998932149SChris Wilson { 9098932149SChris Wilson struct drm_i915_gem_object *obj; 9198932149SChris Wilson 9298932149SChris Wilson rcu_read_lock(); 9398932149SChris Wilson obj = i915_gem_object_lookup_rcu(file, handle); 94280d14a6SChris Wilson obj = i915_gem_object_get_rcu(obj); 9598932149SChris Wilson rcu_read_unlock(); 9698932149SChris Wilson 9798932149SChris Wilson return obj; 9898932149SChris Wilson } 9998932149SChris Wilson 10098932149SChris Wilson __deprecated 101b5893ffcSJanusz Krzysztofik struct drm_gem_object * 10298932149SChris Wilson drm_gem_object_lookup(struct drm_file *file, u32 handle); 10398932149SChris Wilson 10498932149SChris Wilson __attribute__((nonnull)) 10598932149SChris Wilson static inline struct drm_i915_gem_object * 10698932149SChris Wilson i915_gem_object_get(struct drm_i915_gem_object *obj) 10798932149SChris Wilson { 10898932149SChris Wilson drm_gem_object_get(&obj->base); 10998932149SChris Wilson return obj; 11098932149SChris Wilson } 11198932149SChris Wilson 11298932149SChris Wilson __attribute__((nonnull)) 11398932149SChris Wilson static inline void 11498932149SChris Wilson i915_gem_object_put(struct drm_i915_gem_object *obj) 11598932149SChris Wilson { 11698932149SChris Wilson __drm_gem_object_put(&obj->base); 11798932149SChris Wilson } 11898932149SChris Wilson 11952791eeeSChristian König #define assert_object_held(obj) dma_resv_assert_held((obj)->base.resv) 1206951e589SChris Wilson 12180f0b679SMaarten Lankhorst static inline int __i915_gem_object_lock(struct drm_i915_gem_object *obj, 12280f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww, 12380f0b679SMaarten Lankhorst bool intr) 12498932149SChris Wilson { 12580f0b679SMaarten Lankhorst int ret; 12680f0b679SMaarten Lankhorst 12780f0b679SMaarten Lankhorst if (intr) 12880f0b679SMaarten Lankhorst ret = dma_resv_lock_interruptible(obj->base.resv, ww ? &ww->ctx : NULL); 12980f0b679SMaarten Lankhorst else 13080f0b679SMaarten Lankhorst ret = dma_resv_lock(obj->base.resv, ww ? &ww->ctx : NULL); 13180f0b679SMaarten Lankhorst 13280f0b679SMaarten Lankhorst if (!ret && ww) 13380f0b679SMaarten Lankhorst list_add_tail(&obj->obj_link, &ww->obj_list); 13480f0b679SMaarten Lankhorst if (ret == -EALREADY) 13580f0b679SMaarten Lankhorst ret = 0; 13680f0b679SMaarten Lankhorst 13780f0b679SMaarten Lankhorst if (ret == -EDEADLK) 13880f0b679SMaarten Lankhorst ww->contended = obj; 13980f0b679SMaarten Lankhorst 14080f0b679SMaarten Lankhorst return ret; 14180f0b679SMaarten Lankhorst } 14280f0b679SMaarten Lankhorst 14380f0b679SMaarten Lankhorst static inline int i915_gem_object_lock(struct drm_i915_gem_object *obj, 14480f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww) 14580f0b679SMaarten Lankhorst { 14680f0b679SMaarten Lankhorst return __i915_gem_object_lock(obj, ww, ww && ww->intr); 14780f0b679SMaarten Lankhorst } 14880f0b679SMaarten Lankhorst 14980f0b679SMaarten Lankhorst static inline int i915_gem_object_lock_interruptible(struct drm_i915_gem_object *obj, 15080f0b679SMaarten Lankhorst struct i915_gem_ww_ctx *ww) 15180f0b679SMaarten Lankhorst { 15280f0b679SMaarten Lankhorst WARN_ON(ww && !ww->intr); 15380f0b679SMaarten Lankhorst return __i915_gem_object_lock(obj, ww, true); 15498932149SChris Wilson } 15598932149SChris Wilson 1562850748eSChris Wilson static inline bool i915_gem_object_trylock(struct drm_i915_gem_object *obj) 1572850748eSChris Wilson { 1582850748eSChris Wilson return dma_resv_trylock(obj->base.resv); 1592850748eSChris Wilson } 1602850748eSChris Wilson 16198932149SChris Wilson static inline void i915_gem_object_unlock(struct drm_i915_gem_object *obj) 16298932149SChris Wilson { 16352791eeeSChristian König dma_resv_unlock(obj->base.resv); 16498932149SChris Wilson } 16598932149SChris Wilson 1666951e589SChris Wilson struct dma_fence * 1676951e589SChris Wilson i915_gem_object_lock_fence(struct drm_i915_gem_object *obj); 1686951e589SChris Wilson void i915_gem_object_unlock_fence(struct drm_i915_gem_object *obj, 1696951e589SChris Wilson struct dma_fence *fence); 1706951e589SChris Wilson 17198932149SChris Wilson static inline void 17298932149SChris Wilson i915_gem_object_set_readonly(struct drm_i915_gem_object *obj) 17398932149SChris Wilson { 174cc662126SAbdiel Janulgue obj->flags |= I915_BO_READONLY; 17598932149SChris Wilson } 17698932149SChris Wilson 17798932149SChris Wilson static inline bool 17898932149SChris Wilson i915_gem_object_is_readonly(const struct drm_i915_gem_object *obj) 17998932149SChris Wilson { 180cc662126SAbdiel Janulgue return obj->flags & I915_BO_READONLY; 18198932149SChris Wilson } 18298932149SChris Wilson 18398932149SChris Wilson static inline bool 1842f0b97caSMatthew Auld i915_gem_object_is_contiguous(const struct drm_i915_gem_object *obj) 1852f0b97caSMatthew Auld { 1862f0b97caSMatthew Auld return obj->flags & I915_BO_ALLOC_CONTIGUOUS; 1872f0b97caSMatthew Auld } 1882f0b97caSMatthew Auld 1892f0b97caSMatthew Auld static inline bool 1907c98501aSMatthew Auld i915_gem_object_is_volatile(const struct drm_i915_gem_object *obj) 1917c98501aSMatthew Auld { 1927c98501aSMatthew Auld return obj->flags & I915_BO_ALLOC_VOLATILE; 1937c98501aSMatthew Auld } 1947c98501aSMatthew Auld 1957c98501aSMatthew Auld static inline void 1967c98501aSMatthew Auld i915_gem_object_set_volatile(struct drm_i915_gem_object *obj) 1977c98501aSMatthew Auld { 1987c98501aSMatthew Auld obj->flags |= I915_BO_ALLOC_VOLATILE; 1997c98501aSMatthew Auld } 2007c98501aSMatthew Auld 2017c98501aSMatthew Auld static inline bool 2020175969eSChris Wilson i915_gem_object_has_tiling_quirk(struct drm_i915_gem_object *obj) 2030175969eSChris Wilson { 2040175969eSChris Wilson return test_bit(I915_TILING_QUIRK_BIT, &obj->flags); 2050175969eSChris Wilson } 2060175969eSChris Wilson 2070175969eSChris Wilson static inline void 2080175969eSChris Wilson i915_gem_object_set_tiling_quirk(struct drm_i915_gem_object *obj) 2090175969eSChris Wilson { 2100175969eSChris Wilson set_bit(I915_TILING_QUIRK_BIT, &obj->flags); 2110175969eSChris Wilson } 2120175969eSChris Wilson 2130175969eSChris Wilson static inline void 2140175969eSChris Wilson i915_gem_object_clear_tiling_quirk(struct drm_i915_gem_object *obj) 2150175969eSChris Wilson { 2160175969eSChris Wilson clear_bit(I915_TILING_QUIRK_BIT, &obj->flags); 2170175969eSChris Wilson } 2180175969eSChris Wilson 2190175969eSChris Wilson static inline bool 2203cbad5d7SChris Wilson i915_gem_object_type_has(const struct drm_i915_gem_object *obj, 2213cbad5d7SChris Wilson unsigned long flags) 2223cbad5d7SChris Wilson { 2233cbad5d7SChris Wilson return obj->ops->flags & flags; 2243cbad5d7SChris Wilson } 2253cbad5d7SChris Wilson 2263cbad5d7SChris Wilson static inline bool 22798932149SChris Wilson i915_gem_object_has_struct_page(const struct drm_i915_gem_object *obj) 22898932149SChris Wilson { 229c471748dSMaarten Lankhorst return obj->flags & I915_BO_ALLOC_STRUCT_PAGE; 23098932149SChris Wilson } 23198932149SChris Wilson 23298932149SChris Wilson static inline bool 2335fbc2c2bSImre Deak i915_gem_object_has_iomem(const struct drm_i915_gem_object *obj) 2345fbc2c2bSImre Deak { 2355fbc2c2bSImre Deak return i915_gem_object_type_has(obj, I915_GEM_OBJECT_HAS_IOMEM); 2365fbc2c2bSImre Deak } 2375fbc2c2bSImre Deak 2385fbc2c2bSImre Deak static inline bool 23998932149SChris Wilson i915_gem_object_is_shrinkable(const struct drm_i915_gem_object *obj) 24098932149SChris Wilson { 2413cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_IS_SHRINKABLE); 24298932149SChris Wilson } 24398932149SChris Wilson 24498932149SChris Wilson static inline bool 24598932149SChris Wilson i915_gem_object_is_proxy(const struct drm_i915_gem_object *obj) 24698932149SChris Wilson { 2473cbad5d7SChris Wilson return i915_gem_object_type_has(obj, I915_GEM_OBJECT_IS_PROXY); 24898932149SChris Wilson } 24998932149SChris Wilson 25098932149SChris Wilson static inline bool 251f6c26b55SJanusz Krzysztofik i915_gem_object_never_mmap(const struct drm_i915_gem_object *obj) 252a4311745SChris Wilson { 253f6c26b55SJanusz Krzysztofik return i915_gem_object_type_has(obj, I915_GEM_OBJECT_NO_MMAP); 254a4311745SChris Wilson } 255a4311745SChris Wilson 256a4311745SChris Wilson static inline bool 25798932149SChris Wilson i915_gem_object_is_framebuffer(const struct drm_i915_gem_object *obj) 25898932149SChris Wilson { 2598e7cb179SChris Wilson return READ_ONCE(obj->frontbuffer); 26098932149SChris Wilson } 26198932149SChris Wilson 26298932149SChris Wilson static inline unsigned int 26398932149SChris Wilson i915_gem_object_get_tiling(const struct drm_i915_gem_object *obj) 26498932149SChris Wilson { 26598932149SChris Wilson return obj->tiling_and_stride & TILING_MASK; 26698932149SChris Wilson } 26798932149SChris Wilson 26898932149SChris Wilson static inline bool 26998932149SChris Wilson i915_gem_object_is_tiled(const struct drm_i915_gem_object *obj) 27098932149SChris Wilson { 27198932149SChris Wilson return i915_gem_object_get_tiling(obj) != I915_TILING_NONE; 27298932149SChris Wilson } 27398932149SChris Wilson 27498932149SChris Wilson static inline unsigned int 27598932149SChris Wilson i915_gem_object_get_stride(const struct drm_i915_gem_object *obj) 27698932149SChris Wilson { 27798932149SChris Wilson return obj->tiling_and_stride & STRIDE_MASK; 27898932149SChris Wilson } 27998932149SChris Wilson 28098932149SChris Wilson static inline unsigned int 28198932149SChris Wilson i915_gem_tile_height(unsigned int tiling) 28298932149SChris Wilson { 28398932149SChris Wilson GEM_BUG_ON(!tiling); 28498932149SChris Wilson return tiling == I915_TILING_Y ? 32 : 8; 28598932149SChris Wilson } 28698932149SChris Wilson 28798932149SChris Wilson static inline unsigned int 28898932149SChris Wilson i915_gem_object_get_tile_height(const struct drm_i915_gem_object *obj) 28998932149SChris Wilson { 29098932149SChris Wilson return i915_gem_tile_height(i915_gem_object_get_tiling(obj)); 29198932149SChris Wilson } 29298932149SChris Wilson 29398932149SChris Wilson static inline unsigned int 29498932149SChris Wilson i915_gem_object_get_tile_row_size(const struct drm_i915_gem_object *obj) 29598932149SChris Wilson { 29698932149SChris Wilson return (i915_gem_object_get_stride(obj) * 29798932149SChris Wilson i915_gem_object_get_tile_height(obj)); 29898932149SChris Wilson } 29998932149SChris Wilson 30098932149SChris Wilson int i915_gem_object_set_tiling(struct drm_i915_gem_object *obj, 30198932149SChris Wilson unsigned int tiling, unsigned int stride); 30298932149SChris Wilson 30398932149SChris Wilson struct scatterlist * 304934941edSTvrtko Ursulin __i915_gem_object_get_sg(struct drm_i915_gem_object *obj, 305934941edSTvrtko Ursulin struct i915_gem_object_page_iter *iter, 306934941edSTvrtko Ursulin unsigned int n, 3070edbb9baSMaarten Lankhorst unsigned int *offset, bool allow_alloc); 308934941edSTvrtko Ursulin 309934941edSTvrtko Ursulin static inline struct scatterlist * 31098932149SChris Wilson i915_gem_object_get_sg(struct drm_i915_gem_object *obj, 311934941edSTvrtko Ursulin unsigned int n, 3120edbb9baSMaarten Lankhorst unsigned int *offset, bool allow_alloc) 313934941edSTvrtko Ursulin { 3140edbb9baSMaarten Lankhorst return __i915_gem_object_get_sg(obj, &obj->mm.get_page, n, offset, allow_alloc); 315934941edSTvrtko Ursulin } 316934941edSTvrtko Ursulin 317934941edSTvrtko Ursulin static inline struct scatterlist * 318934941edSTvrtko Ursulin i915_gem_object_get_sg_dma(struct drm_i915_gem_object *obj, 319934941edSTvrtko Ursulin unsigned int n, 3200edbb9baSMaarten Lankhorst unsigned int *offset, bool allow_alloc) 321934941edSTvrtko Ursulin { 3220edbb9baSMaarten Lankhorst return __i915_gem_object_get_sg(obj, &obj->mm.get_dma_page, n, offset, allow_alloc); 323934941edSTvrtko Ursulin } 32498932149SChris Wilson 32598932149SChris Wilson struct page * 32698932149SChris Wilson i915_gem_object_get_page(struct drm_i915_gem_object *obj, 32798932149SChris Wilson unsigned int n); 32898932149SChris Wilson 3294993a8a3SDave Airlie struct page * 3304993a8a3SDave Airlie i915_gem_object_get_dirty_page(struct drm_i915_gem_object *obj, 3314993a8a3SDave Airlie unsigned int n); 3324993a8a3SDave Airlie 33398932149SChris Wilson dma_addr_t 33498932149SChris Wilson i915_gem_object_get_dma_address_len(struct drm_i915_gem_object *obj, 33598932149SChris Wilson unsigned long n, 33698932149SChris Wilson unsigned int *len); 33798932149SChris Wilson 33898932149SChris Wilson dma_addr_t 33998932149SChris Wilson i915_gem_object_get_dma_address(struct drm_i915_gem_object *obj, 34098932149SChris Wilson unsigned long n); 34198932149SChris Wilson 34298932149SChris Wilson void __i915_gem_object_set_pages(struct drm_i915_gem_object *obj, 34398932149SChris Wilson struct sg_table *pages, 34498932149SChris Wilson unsigned int sg_page_sizes); 345f033428dSChris Wilson 346f033428dSChris Wilson int ____i915_gem_object_get_pages(struct drm_i915_gem_object *obj); 34798932149SChris Wilson int __i915_gem_object_get_pages(struct drm_i915_gem_object *obj); 34898932149SChris Wilson 34998932149SChris Wilson static inline int __must_check 35098932149SChris Wilson i915_gem_object_pin_pages(struct drm_i915_gem_object *obj) 35198932149SChris Wilson { 352abd2f577SMaarten Lankhorst might_lock(&obj->mm.lock); 35398932149SChris Wilson 35498932149SChris Wilson if (atomic_inc_not_zero(&obj->mm.pages_pin_count)) 35598932149SChris Wilson return 0; 35698932149SChris Wilson 35798932149SChris Wilson return __i915_gem_object_get_pages(obj); 35898932149SChris Wilson } 35998932149SChris Wilson 36098932149SChris Wilson static inline bool 36198932149SChris Wilson i915_gem_object_has_pages(struct drm_i915_gem_object *obj) 36298932149SChris Wilson { 36398932149SChris Wilson return !IS_ERR_OR_NULL(READ_ONCE(obj->mm.pages)); 36498932149SChris Wilson } 36598932149SChris Wilson 36698932149SChris Wilson static inline void 36798932149SChris Wilson __i915_gem_object_pin_pages(struct drm_i915_gem_object *obj) 36898932149SChris Wilson { 36998932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pages(obj)); 37098932149SChris Wilson 37198932149SChris Wilson atomic_inc(&obj->mm.pages_pin_count); 37298932149SChris Wilson } 37398932149SChris Wilson 37498932149SChris Wilson static inline bool 37598932149SChris Wilson i915_gem_object_has_pinned_pages(struct drm_i915_gem_object *obj) 37698932149SChris Wilson { 37798932149SChris Wilson return atomic_read(&obj->mm.pages_pin_count); 37898932149SChris Wilson } 37998932149SChris Wilson 38098932149SChris Wilson static inline void 38198932149SChris Wilson __i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj) 38298932149SChris Wilson { 38398932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pages(obj)); 38498932149SChris Wilson GEM_BUG_ON(!i915_gem_object_has_pinned_pages(obj)); 38598932149SChris Wilson 38698932149SChris Wilson atomic_dec(&obj->mm.pages_pin_count); 38798932149SChris Wilson } 38898932149SChris Wilson 38998932149SChris Wilson static inline void 39098932149SChris Wilson i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj) 39198932149SChris Wilson { 39298932149SChris Wilson __i915_gem_object_unpin_pages(obj); 39398932149SChris Wilson } 39498932149SChris Wilson 395f86dbacbSDaniel Vetter int __i915_gem_object_put_pages(struct drm_i915_gem_object *obj); 396abd2f577SMaarten Lankhorst int __i915_gem_object_put_pages_locked(struct drm_i915_gem_object *obj); 397f033428dSChris Wilson void i915_gem_object_truncate(struct drm_i915_gem_object *obj); 398f033428dSChris Wilson void i915_gem_object_writeback(struct drm_i915_gem_object *obj); 39998932149SChris Wilson 40098932149SChris Wilson /** 40198932149SChris Wilson * i915_gem_object_pin_map - return a contiguous mapping of the entire object 40298932149SChris Wilson * @obj: the object to map into kernel address space 40398932149SChris Wilson * @type: the type of mapping, used to select pgprot_t 40498932149SChris Wilson * 40598932149SChris Wilson * Calls i915_gem_object_pin_pages() to prevent reaping of the object's 40698932149SChris Wilson * pages and then returns a contiguous mapping of the backing storage into 40798932149SChris Wilson * the kernel address space. Based on the @type of mapping, the PTE will be 40898932149SChris Wilson * set to either WriteBack or WriteCombine (via pgprot_t). 40998932149SChris Wilson * 41098932149SChris Wilson * The caller is responsible for calling i915_gem_object_unpin_map() when the 41198932149SChris Wilson * mapping is no longer required. 41298932149SChris Wilson * 41398932149SChris Wilson * Returns the pointer through which to access the mapped object, or an 41498932149SChris Wilson * ERR_PTR() on error. 41598932149SChris Wilson */ 41698932149SChris Wilson void *__must_check i915_gem_object_pin_map(struct drm_i915_gem_object *obj, 41798932149SChris Wilson enum i915_map_type type); 41898932149SChris Wilson 41998932149SChris Wilson void __i915_gem_object_flush_map(struct drm_i915_gem_object *obj, 42098932149SChris Wilson unsigned long offset, 42198932149SChris Wilson unsigned long size); 42298932149SChris Wilson static inline void i915_gem_object_flush_map(struct drm_i915_gem_object *obj) 42398932149SChris Wilson { 42498932149SChris Wilson __i915_gem_object_flush_map(obj, 0, obj->base.size); 42598932149SChris Wilson } 42698932149SChris Wilson 42798932149SChris Wilson /** 42898932149SChris Wilson * i915_gem_object_unpin_map - releases an earlier mapping 42998932149SChris Wilson * @obj: the object to unmap 43098932149SChris Wilson * 43198932149SChris Wilson * After pinning the object and mapping its pages, once you are finished 43298932149SChris Wilson * with your access, call i915_gem_object_unpin_map() to release the pin 43398932149SChris Wilson * upon the mapping. Once the pin count reaches zero, that mapping may be 43498932149SChris Wilson * removed. 43598932149SChris Wilson */ 43698932149SChris Wilson static inline void i915_gem_object_unpin_map(struct drm_i915_gem_object *obj) 43798932149SChris Wilson { 43898932149SChris Wilson i915_gem_object_unpin_pages(obj); 43998932149SChris Wilson } 44098932149SChris Wilson 44189d19b2bSChris Wilson void __i915_gem_object_release_map(struct drm_i915_gem_object *obj); 44289d19b2bSChris Wilson 443f0e4a063SChris Wilson int i915_gem_object_prepare_read(struct drm_i915_gem_object *obj, 444f0e4a063SChris Wilson unsigned int *needs_clflush); 445f0e4a063SChris Wilson int i915_gem_object_prepare_write(struct drm_i915_gem_object *obj, 446f0e4a063SChris Wilson unsigned int *needs_clflush); 447f0e4a063SChris Wilson #define CLFLUSH_BEFORE BIT(0) 448f0e4a063SChris Wilson #define CLFLUSH_AFTER BIT(1) 449f0e4a063SChris Wilson #define CLFLUSH_FLAGS (CLFLUSH_BEFORE | CLFLUSH_AFTER) 450f0e4a063SChris Wilson 451f0e4a063SChris Wilson static inline void 452f0e4a063SChris Wilson i915_gem_object_finish_access(struct drm_i915_gem_object *obj) 453f0e4a063SChris Wilson { 454f0e4a063SChris Wilson i915_gem_object_unpin_pages(obj); 455f0e4a063SChris Wilson } 456f0e4a063SChris Wilson 45798932149SChris Wilson static inline struct intel_engine_cs * 45898932149SChris Wilson i915_gem_object_last_write_engine(struct drm_i915_gem_object *obj) 45998932149SChris Wilson { 46098932149SChris Wilson struct intel_engine_cs *engine = NULL; 46198932149SChris Wilson struct dma_fence *fence; 46298932149SChris Wilson 46398932149SChris Wilson rcu_read_lock(); 46452791eeeSChristian König fence = dma_resv_get_excl_rcu(obj->base.resv); 46598932149SChris Wilson rcu_read_unlock(); 46698932149SChris Wilson 46798932149SChris Wilson if (fence && dma_fence_is_i915(fence) && !dma_fence_is_signaled(fence)) 46898932149SChris Wilson engine = to_request(fence)->engine; 46998932149SChris Wilson dma_fence_put(fence); 47098932149SChris Wilson 47198932149SChris Wilson return engine; 47298932149SChris Wilson } 47398932149SChris Wilson 47498932149SChris Wilson void i915_gem_object_set_cache_coherency(struct drm_i915_gem_object *obj, 47598932149SChris Wilson unsigned int cache_level); 47698932149SChris Wilson void i915_gem_object_flush_if_display(struct drm_i915_gem_object *obj); 477c1793ba8SMaarten Lankhorst void i915_gem_object_flush_if_display_locked(struct drm_i915_gem_object *obj); 47898932149SChris Wilson 479f0e4a063SChris Wilson int __must_check 480f0e4a063SChris Wilson i915_gem_object_set_to_wc_domain(struct drm_i915_gem_object *obj, bool write); 481f0e4a063SChris Wilson int __must_check 482f0e4a063SChris Wilson i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj, bool write); 483f0e4a063SChris Wilson int __must_check 484f0e4a063SChris Wilson i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write); 485f0e4a063SChris Wilson struct i915_vma * __must_check 486f0e4a063SChris Wilson i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj, 487*1b321026SMaarten Lankhorst struct i915_gem_ww_ctx *ww, 488f0e4a063SChris Wilson u32 alignment, 489f0e4a063SChris Wilson const struct i915_ggtt_view *view, 490f0e4a063SChris Wilson unsigned int flags); 491f0e4a063SChris Wilson 4921aff1903SChris Wilson void i915_gem_object_make_unshrinkable(struct drm_i915_gem_object *obj); 4931aff1903SChris Wilson void i915_gem_object_make_shrinkable(struct drm_i915_gem_object *obj); 4941aff1903SChris Wilson void i915_gem_object_make_purgeable(struct drm_i915_gem_object *obj); 4951aff1903SChris Wilson 4968475355fSChris Wilson static inline bool cpu_write_needs_clflush(struct drm_i915_gem_object *obj) 4978475355fSChris Wilson { 4988475355fSChris Wilson if (obj->cache_dirty) 4998475355fSChris Wilson return false; 5008475355fSChris Wilson 5018475355fSChris Wilson if (!(obj->cache_coherent & I915_BO_CACHE_COHERENT_FOR_WRITE)) 5028475355fSChris Wilson return true; 5038475355fSChris Wilson 5045a90606dSChris Wilson /* Currently in use by HW (display engine)? Keep flushed. */ 5055a90606dSChris Wilson return i915_gem_object_is_framebuffer(obj); 5068475355fSChris Wilson } 5078475355fSChris Wilson 5088475355fSChris Wilson static inline void __start_cpu_write(struct drm_i915_gem_object *obj) 5098475355fSChris Wilson { 5108475355fSChris Wilson obj->read_domains = I915_GEM_DOMAIN_CPU; 5118475355fSChris Wilson obj->write_domain = I915_GEM_DOMAIN_CPU; 5128475355fSChris Wilson if (cpu_write_needs_clflush(obj)) 5138475355fSChris Wilson obj->cache_dirty = true; 5148475355fSChris Wilson } 51598932149SChris Wilson 516f99e67f1SChris Wilson void i915_gem_fence_wait_priority(struct dma_fence *fence, 517f99e67f1SChris Wilson const struct i915_sched_attr *attr); 518f99e67f1SChris Wilson 519d45a1a53SChris Wilson int i915_gem_object_wait(struct drm_i915_gem_object *obj, 520d45a1a53SChris Wilson unsigned int flags, 521d45a1a53SChris Wilson long timeout); 522d45a1a53SChris Wilson int i915_gem_object_wait_priority(struct drm_i915_gem_object *obj, 523d45a1a53SChris Wilson unsigned int flags, 524d45a1a53SChris Wilson const struct i915_sched_attr *attr); 525d45a1a53SChris Wilson 526da42104fSChris Wilson void __i915_gem_object_flush_frontbuffer(struct drm_i915_gem_object *obj, 527da42104fSChris Wilson enum fb_op_origin origin); 528da42104fSChris Wilson void __i915_gem_object_invalidate_frontbuffer(struct drm_i915_gem_object *obj, 529da42104fSChris Wilson enum fb_op_origin origin); 530da42104fSChris Wilson 531da42104fSChris Wilson static inline void 532da42104fSChris Wilson i915_gem_object_flush_frontbuffer(struct drm_i915_gem_object *obj, 533da42104fSChris Wilson enum fb_op_origin origin) 534da42104fSChris Wilson { 535da42104fSChris Wilson if (unlikely(rcu_access_pointer(obj->frontbuffer))) 536da42104fSChris Wilson __i915_gem_object_flush_frontbuffer(obj, origin); 537da42104fSChris Wilson } 538da42104fSChris Wilson 539da42104fSChris Wilson static inline void 540da42104fSChris Wilson i915_gem_object_invalidate_frontbuffer(struct drm_i915_gem_object *obj, 541da42104fSChris Wilson enum fb_op_origin origin) 542da42104fSChris Wilson { 543da42104fSChris Wilson if (unlikely(rcu_access_pointer(obj->frontbuffer))) 544da42104fSChris Wilson __i915_gem_object_invalidate_frontbuffer(obj, origin); 545da42104fSChris Wilson } 546da42104fSChris Wilson 5475fbc2c2bSImre Deak int i915_gem_object_read_from_page(struct drm_i915_gem_object *obj, u64 offset, void *dst, int size); 5485fbc2c2bSImre Deak 54941a9c75dSChris Wilson bool i915_gem_object_is_shmem(const struct drm_i915_gem_object *obj); 55041a9c75dSChris Wilson 551ed29c269SMaarten Lankhorst #ifdef CONFIG_MMU_NOTIFIER 552ed29c269SMaarten Lankhorst static inline bool 553ed29c269SMaarten Lankhorst i915_gem_object_is_userptr(struct drm_i915_gem_object *obj) 554ed29c269SMaarten Lankhorst { 555ed29c269SMaarten Lankhorst return obj->userptr.notifier.mm; 556ed29c269SMaarten Lankhorst } 557ed29c269SMaarten Lankhorst 558ed29c269SMaarten Lankhorst int i915_gem_object_userptr_submit_init(struct drm_i915_gem_object *obj); 559ed29c269SMaarten Lankhorst int i915_gem_object_userptr_submit_done(struct drm_i915_gem_object *obj); 560ed29c269SMaarten Lankhorst void i915_gem_object_userptr_submit_fini(struct drm_i915_gem_object *obj); 561ed29c269SMaarten Lankhorst int i915_gem_object_userptr_validate(struct drm_i915_gem_object *obj); 562ed29c269SMaarten Lankhorst #else 563ed29c269SMaarten Lankhorst static inline bool i915_gem_object_is_userptr(struct drm_i915_gem_object *obj) { return false; } 564ed29c269SMaarten Lankhorst 565ed29c269SMaarten Lankhorst static inline int i915_gem_object_userptr_submit_init(struct drm_i915_gem_object *obj) { GEM_BUG_ON(1); return -ENODEV; } 566ed29c269SMaarten Lankhorst static inline int i915_gem_object_userptr_submit_done(struct drm_i915_gem_object *obj) { GEM_BUG_ON(1); return -ENODEV; } 567ed29c269SMaarten Lankhorst static inline void i915_gem_object_userptr_submit_fini(struct drm_i915_gem_object *obj) { GEM_BUG_ON(1); } 568ed29c269SMaarten Lankhorst static inline int i915_gem_object_userptr_validate(struct drm_i915_gem_object *obj) { GEM_BUG_ON(1); return -ENODEV; } 569ed29c269SMaarten Lankhorst 570ed29c269SMaarten Lankhorst #endif 571ed29c269SMaarten Lankhorst 57298932149SChris Wilson #endif 573