1caab277bSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 2c8afe684SRob Clark /* 3c8afe684SRob Clark * Copyright (C) 2013 Red Hat 4c8afe684SRob Clark * Author: Rob Clark <robdclark@gmail.com> 5c8afe684SRob Clark */ 6c8afe684SRob Clark 7c8afe684SRob Clark #ifndef __MSM_GEM_H__ 8c8afe684SRob Clark #define __MSM_GEM_H__ 9c8afe684SRob Clark 10ee546cd3SJordan Crouse #include <linux/kref.h> 1152791eeeSChristian König #include <linux/dma-resv.h> 12c8afe684SRob Clark #include "msm_drv.h" 13c8afe684SRob Clark 14072f1f91SRob Clark /* Additional internal-use only BO flags: */ 15072f1f91SRob Clark #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 160b462d7aSJonathan Marek #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 17072f1f91SRob Clark 18667ce33eSRob Clark struct msm_gem_address_space { 19667ce33eSRob Clark const char *name; 20667ce33eSRob Clark /* NOTE: mm managed at the page level, size is in # of pages 21667ce33eSRob Clark * and position mm_node->start is in # of pages: 22667ce33eSRob Clark */ 23667ce33eSRob Clark struct drm_mm mm; 240e08270aSSushmita Susheelendra spinlock_t lock; /* Protects drm_mm node allocation/removal */ 25667ce33eSRob Clark struct msm_mmu *mmu; 26ee546cd3SJordan Crouse struct kref kref; 2725faf2f2SRob Clark 2825faf2f2SRob Clark /* For address spaces associated with a specific process, this 2925faf2f2SRob Clark * will be non-NULL: 3025faf2f2SRob Clark */ 3125faf2f2SRob Clark struct pid *pid; 32667ce33eSRob Clark }; 33667ce33eSRob Clark 34667ce33eSRob Clark struct msm_gem_vma { 35667ce33eSRob Clark struct drm_mm_node node; 36667ce33eSRob Clark uint64_t iova; 374b85f7f5SRob Clark struct msm_gem_address_space *aspace; 384b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 39c0ee9794SJordan Crouse bool mapped; 407ad0e8cfSJordan Crouse int inuse; 41667ce33eSRob Clark }; 42667ce33eSRob Clark 43c8afe684SRob Clark struct msm_gem_object { 44c8afe684SRob Clark struct drm_gem_object base; 45c8afe684SRob Clark 46c8afe684SRob Clark uint32_t flags; 47c8afe684SRob Clark 484cd33c48SRob Clark /** 494cd33c48SRob Clark * Advice: are the backing pages purgeable? 504cd33c48SRob Clark */ 514cd33c48SRob Clark uint8_t madv; 524cd33c48SRob Clark 53e1e9db2cSRob Clark /** 54cc8a4d5aSRob Clark * Is object on inactive_dontneed list (ie. counted in priv->shrinkable_count)? 55cc8a4d5aSRob Clark */ 56cc8a4d5aSRob Clark bool dontneed : 1; 57cc8a4d5aSRob Clark 58cc8a4d5aSRob Clark /** 59e1e9db2cSRob Clark * count of active vmap'ing 60e1e9db2cSRob Clark */ 61e1e9db2cSRob Clark uint8_t vmap_count; 62e1e9db2cSRob Clark 63cc8a4d5aSRob Clark /** 64*6ed0897cSRob Clark * Node in list of all objects (mainly for debugfs, protected by 65*6ed0897cSRob Clark * priv->obj_lock 66*6ed0897cSRob Clark */ 67*6ed0897cSRob Clark struct list_head node; 68*6ed0897cSRob Clark 69*6ed0897cSRob Clark /** 70cc8a4d5aSRob Clark * An object is either: 71*6ed0897cSRob Clark * inactive - on priv->inactive_dontneed or priv->inactive_willneed 72*6ed0897cSRob Clark * (depending on purgability status) 737198e6b0SRob Clark * active - on one one of the gpu's active_list.. well, at 747198e6b0SRob Clark * least for now we don't have (I don't think) hw sync between 757198e6b0SRob Clark * 2d and 3d one devices which have both, meaning we need to 767198e6b0SRob Clark * block on submit if a bo is already on other ring 777198e6b0SRob Clark */ 78c8afe684SRob Clark struct list_head mm_list; 797198e6b0SRob Clark 807198e6b0SRob Clark /* Transiently in the process of submit ioctl, objects associated 817198e6b0SRob Clark * with the submit are on submit->bo_list.. this only lasts for 827198e6b0SRob Clark * the duration of the ioctl, so one bo can never be on multiple 837198e6b0SRob Clark * submit lists. 847198e6b0SRob Clark */ 857198e6b0SRob Clark struct list_head submit_entry; 867198e6b0SRob Clark 87c8afe684SRob Clark struct page **pages; 88c8afe684SRob Clark struct sg_table *sgt; 89c8afe684SRob Clark void *vaddr; 90c8afe684SRob Clark 914b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 927198e6b0SRob Clark 93871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 94072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 95871d812aSRob Clark */ 96871d812aSRob Clark struct drm_mm_node *vram_node; 970815d774SJordan Crouse 980815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 999d8baa2bSAkhil P Oommen 100ab5c54cbSRob Clark int active_count; 101c8afe684SRob Clark }; 102c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 103c8afe684SRob Clark 1048f642378SRob Clark int msm_gem_mmap_obj(struct drm_gem_object *obj, 1058f642378SRob Clark struct vm_area_struct *vma); 1068f642378SRob Clark int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma); 1078f642378SRob Clark uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 1088f642378SRob Clark int msm_gem_get_iova(struct drm_gem_object *obj, 1098f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1108f642378SRob Clark int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 1118f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova, 1128f642378SRob Clark u64 range_start, u64 range_end); 113e4b87d22SRob Clark int msm_gem_get_and_pin_iova_locked(struct drm_gem_object *obj, 114e4b87d22SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1158f642378SRob Clark int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 1168f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1178f642378SRob Clark uint64_t msm_gem_iova(struct drm_gem_object *obj, 1188f642378SRob Clark struct msm_gem_address_space *aspace); 119e4b87d22SRob Clark void msm_gem_unpin_iova_locked(struct drm_gem_object *obj, 120e4b87d22SRob Clark struct msm_gem_address_space *aspace); 1218f642378SRob Clark void msm_gem_unpin_iova(struct drm_gem_object *obj, 1228f642378SRob Clark struct msm_gem_address_space *aspace); 1238f642378SRob Clark struct page **msm_gem_get_pages(struct drm_gem_object *obj); 1248f642378SRob Clark void msm_gem_put_pages(struct drm_gem_object *obj); 1258f642378SRob Clark int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 1268f642378SRob Clark struct drm_mode_create_dumb *args); 1278f642378SRob Clark int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 1288f642378SRob Clark uint32_t handle, uint64_t *offset); 129e4b87d22SRob Clark void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 1308f642378SRob Clark void *msm_gem_get_vaddr(struct drm_gem_object *obj); 1318f642378SRob Clark void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 132e4b87d22SRob Clark void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 1338f642378SRob Clark void msm_gem_put_vaddr(struct drm_gem_object *obj); 1348f642378SRob Clark int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 1358f642378SRob Clark int msm_gem_sync_object(struct drm_gem_object *obj, 1368f642378SRob Clark struct msm_fence_context *fctx, bool exclusive); 1378f642378SRob Clark void msm_gem_active_get(struct drm_gem_object *obj, struct msm_gpu *gpu); 1388f642378SRob Clark void msm_gem_active_put(struct drm_gem_object *obj); 1398f642378SRob Clark int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 1408f642378SRob Clark int msm_gem_cpu_fini(struct drm_gem_object *obj); 1418f642378SRob Clark void msm_gem_free_object(struct drm_gem_object *obj); 1428f642378SRob Clark int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 1438f642378SRob Clark uint32_t size, uint32_t flags, uint32_t *handle, char *name); 1448f642378SRob Clark struct drm_gem_object *msm_gem_new(struct drm_device *dev, 1458f642378SRob Clark uint32_t size, uint32_t flags); 1468f642378SRob Clark struct drm_gem_object *msm_gem_new_locked(struct drm_device *dev, 1478f642378SRob Clark uint32_t size, uint32_t flags); 1488f642378SRob Clark void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 1498f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1508f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1518f642378SRob Clark void *msm_gem_kernel_new_locked(struct drm_device *dev, uint32_t size, 1528f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1538f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1548f642378SRob Clark void msm_gem_kernel_put(struct drm_gem_object *bo, 1558f642378SRob Clark struct msm_gem_address_space *aspace, bool locked); 1568f642378SRob Clark struct drm_gem_object *msm_gem_import(struct drm_device *dev, 1578f642378SRob Clark struct dma_buf *dmabuf, struct sg_table *sgt); 1588f642378SRob Clark __printf(2, 3) 1598f642378SRob Clark void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 1608f642378SRob Clark #ifdef CONFIG_DEBUG_FS 1618f642378SRob Clark void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m); 1628f642378SRob Clark void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 1638f642378SRob Clark #endif 1648f642378SRob Clark 165a6ae74c9SRob Clark static inline void 166a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 167a6ae74c9SRob Clark { 1686c0e3ea2SRob Clark dma_resv_lock(obj->resv, NULL); 169a6ae74c9SRob Clark } 170a6ae74c9SRob Clark 171599089c6SRob Clark static inline bool __must_check 172599089c6SRob Clark msm_gem_trylock(struct drm_gem_object *obj) 173599089c6SRob Clark { 1746c0e3ea2SRob Clark return dma_resv_trylock(obj->resv); 175599089c6SRob Clark } 176599089c6SRob Clark 177a6ae74c9SRob Clark static inline int 178a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 179a6ae74c9SRob Clark { 1806c0e3ea2SRob Clark return dma_resv_lock_interruptible(obj->resv, NULL); 181a6ae74c9SRob Clark } 182a6ae74c9SRob Clark 183a6ae74c9SRob Clark static inline void 184a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 185a6ae74c9SRob Clark { 1866c0e3ea2SRob Clark dma_resv_unlock(obj->resv); 187a6ae74c9SRob Clark } 188a6ae74c9SRob Clark 189a6ae74c9SRob Clark static inline bool 190a6ae74c9SRob Clark msm_gem_is_locked(struct drm_gem_object *obj) 191a6ae74c9SRob Clark { 1926c0e3ea2SRob Clark return dma_resv_is_locked(obj->resv); 193a6ae74c9SRob Clark } 194a6ae74c9SRob Clark 1957198e6b0SRob Clark static inline bool is_active(struct msm_gem_object *msm_obj) 1967198e6b0SRob Clark { 197ab5c54cbSRob Clark WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 198ab5c54cbSRob Clark return msm_obj->active_count; 1997198e6b0SRob Clark } 2007198e6b0SRob Clark 201cc8a4d5aSRob Clark /* imported/exported objects are not purgable: */ 202cc8a4d5aSRob Clark static inline bool is_unpurgable(struct msm_gem_object *msm_obj) 203cc8a4d5aSRob Clark { 204cc8a4d5aSRob Clark return msm_obj->base.dma_buf && msm_obj->base.import_attach; 205cc8a4d5aSRob Clark } 206cc8a4d5aSRob Clark 20768209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 20868209390SRob Clark { 20968209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 210cc8a4d5aSRob Clark !is_unpurgable(msm_obj); 21168209390SRob Clark } 21268209390SRob Clark 213e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 214e1e9db2cSRob Clark { 215599089c6SRob Clark WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 216e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 217e1e9db2cSRob Clark } 218e1e9db2cSRob Clark 219cc8a4d5aSRob Clark static inline void mark_purgable(struct msm_gem_object *msm_obj) 220cc8a4d5aSRob Clark { 221cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 222cc8a4d5aSRob Clark 223cc8a4d5aSRob Clark WARN_ON(!mutex_is_locked(&priv->mm_lock)); 224cc8a4d5aSRob Clark 225cc8a4d5aSRob Clark if (is_unpurgable(msm_obj)) 226cc8a4d5aSRob Clark return; 227cc8a4d5aSRob Clark 228cc8a4d5aSRob Clark if (WARN_ON(msm_obj->dontneed)) 229cc8a4d5aSRob Clark return; 230cc8a4d5aSRob Clark 231cc8a4d5aSRob Clark priv->shrinkable_count += msm_obj->base.size >> PAGE_SHIFT; 232cc8a4d5aSRob Clark msm_obj->dontneed = true; 233cc8a4d5aSRob Clark } 234cc8a4d5aSRob Clark 235cc8a4d5aSRob Clark static inline void mark_unpurgable(struct msm_gem_object *msm_obj) 236cc8a4d5aSRob Clark { 237cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 238cc8a4d5aSRob Clark 239cc8a4d5aSRob Clark WARN_ON(!mutex_is_locked(&priv->mm_lock)); 240cc8a4d5aSRob Clark 241cc8a4d5aSRob Clark if (is_unpurgable(msm_obj)) 242cc8a4d5aSRob Clark return; 243cc8a4d5aSRob Clark 244cc8a4d5aSRob Clark if (WARN_ON(!msm_obj->dontneed)) 245cc8a4d5aSRob Clark return; 246cc8a4d5aSRob Clark 247cc8a4d5aSRob Clark priv->shrinkable_count -= msm_obj->base.size >> PAGE_SHIFT; 248cc8a4d5aSRob Clark WARN_ON(priv->shrinkable_count < 0); 249cc8a4d5aSRob Clark msm_obj->dontneed = false; 250cc8a4d5aSRob Clark } 251cc8a4d5aSRob Clark 252599089c6SRob Clark void msm_gem_purge(struct drm_gem_object *obj); 253599089c6SRob Clark void msm_gem_vunmap(struct drm_gem_object *obj); 2540e08270aSSushmita Susheelendra 2557198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 2567198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 2577198e6b0SRob Clark * make it easier to unwind when things go wrong, etc). This only 2587198e6b0SRob Clark * lasts for the duration of the submit-ioctl. 2597198e6b0SRob Clark */ 2607198e6b0SRob Clark struct msm_gem_submit { 261964d2f97SRob Clark struct kref ref; 2627198e6b0SRob Clark struct drm_device *dev; 2637198e6b0SRob Clark struct msm_gpu *gpu; 264295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 265f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 2667198e6b0SRob Clark struct list_head bo_list; 2677198e6b0SRob Clark struct ww_acquire_ctx ticket; 268f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 269f54d1867SChris Wilson struct dma_fence *fence; 270f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 2714816b626SRob Clark struct pid *pid; /* submitting process */ 272340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 2736a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 274f97decacSJordan Crouse struct msm_ringbuffer *ring; 275cf655d61SJordan Crouse struct msm_file_private *ctx; 2767198e6b0SRob Clark unsigned int nr_cmds; 2777198e6b0SRob Clark unsigned int nr_bos; 2784241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 2797198e6b0SRob Clark struct { 2807198e6b0SRob Clark uint32_t type; 2817198e6b0SRob Clark uint32_t size; /* in dwords */ 28278babc16SRob Clark uint64_t iova; 28320224d71SRob Clark uint32_t offset;/* in dwords */ 284a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 28520224d71SRob Clark uint32_t nr_relocs; 28620224d71SRob Clark struct drm_msm_gem_submit_reloc *relocs; 2876b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 2887198e6b0SRob Clark struct { 2897198e6b0SRob Clark uint32_t flags; 290b673499aSKristian H. Kristensen union { 2917198e6b0SRob Clark struct msm_gem_object *obj; 292b673499aSKristian H. Kristensen uint32_t handle; 293b673499aSKristian H. Kristensen }; 29478babc16SRob Clark uint64_t iova; 2954c145df1SGustavo A. R. Silva } bos[]; 2967198e6b0SRob Clark }; 2977198e6b0SRob Clark 298964d2f97SRob Clark void __msm_gem_submit_destroy(struct kref *kref); 299964d2f97SRob Clark 300964d2f97SRob Clark static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 301964d2f97SRob Clark { 302964d2f97SRob Clark kref_get(&submit->ref); 303964d2f97SRob Clark } 304964d2f97SRob Clark 305964d2f97SRob Clark static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 306964d2f97SRob Clark { 307964d2f97SRob Clark kref_put(&submit->ref, __msm_gem_submit_destroy); 308964d2f97SRob Clark } 309964d2f97SRob Clark 310e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 311e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 312e515af8dSRob Clark */ 313e515af8dSRob Clark static inline bool 314e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 315e515af8dSRob Clark { 316e515af8dSRob Clark extern bool rd_full; 317e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 318e515af8dSRob Clark } 319e515af8dSRob Clark 320c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 321