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 14*90643a24SRob Clark /* Make all GEM related WARN_ON()s ratelimited.. when things go wrong they 15*90643a24SRob Clark * tend to go wrong 1000s of times in a short timespan. 16*90643a24SRob Clark */ 17*90643a24SRob Clark #define GEM_WARN_ON(x) WARN_RATELIMIT(x, "%s", __stringify(x)) 18*90643a24SRob Clark 19072f1f91SRob Clark /* Additional internal-use only BO flags: */ 20072f1f91SRob Clark #define MSM_BO_STOLEN 0x10000000 /* try to use stolen/splash memory */ 210b462d7aSJonathan Marek #define MSM_BO_MAP_PRIV 0x20000000 /* use IOMMU_PRIV when mapping */ 22072f1f91SRob Clark 23667ce33eSRob Clark struct msm_gem_address_space { 24667ce33eSRob Clark const char *name; 25667ce33eSRob Clark /* NOTE: mm managed at the page level, size is in # of pages 26667ce33eSRob Clark * and position mm_node->start is in # of pages: 27667ce33eSRob Clark */ 28667ce33eSRob Clark struct drm_mm mm; 290e08270aSSushmita Susheelendra spinlock_t lock; /* Protects drm_mm node allocation/removal */ 30667ce33eSRob Clark struct msm_mmu *mmu; 31ee546cd3SJordan Crouse struct kref kref; 3225faf2f2SRob Clark 3325faf2f2SRob Clark /* For address spaces associated with a specific process, this 3425faf2f2SRob Clark * will be non-NULL: 3525faf2f2SRob Clark */ 3625faf2f2SRob Clark struct pid *pid; 37667ce33eSRob Clark }; 38667ce33eSRob Clark 39667ce33eSRob Clark struct msm_gem_vma { 40667ce33eSRob Clark struct drm_mm_node node; 41667ce33eSRob Clark uint64_t iova; 424b85f7f5SRob Clark struct msm_gem_address_space *aspace; 434b85f7f5SRob Clark struct list_head list; /* node in msm_gem_object::vmas */ 44c0ee9794SJordan Crouse bool mapped; 457ad0e8cfSJordan Crouse int inuse; 46667ce33eSRob Clark }; 47667ce33eSRob Clark 48c8afe684SRob Clark struct msm_gem_object { 49c8afe684SRob Clark struct drm_gem_object base; 50c8afe684SRob Clark 51c8afe684SRob Clark uint32_t flags; 52c8afe684SRob Clark 534cd33c48SRob Clark /** 544cd33c48SRob Clark * Advice: are the backing pages purgeable? 554cd33c48SRob Clark */ 564cd33c48SRob Clark uint8_t madv; 574cd33c48SRob Clark 58e1e9db2cSRob Clark /** 59cc8a4d5aSRob Clark * Is object on inactive_dontneed list (ie. counted in priv->shrinkable_count)? 60cc8a4d5aSRob Clark */ 61cc8a4d5aSRob Clark bool dontneed : 1; 62cc8a4d5aSRob Clark 63cc8a4d5aSRob Clark /** 64e1e9db2cSRob Clark * count of active vmap'ing 65e1e9db2cSRob Clark */ 66e1e9db2cSRob Clark uint8_t vmap_count; 67e1e9db2cSRob Clark 68cc8a4d5aSRob Clark /** 696ed0897cSRob Clark * Node in list of all objects (mainly for debugfs, protected by 706ed0897cSRob Clark * priv->obj_lock 716ed0897cSRob Clark */ 726ed0897cSRob Clark struct list_head node; 736ed0897cSRob Clark 746ed0897cSRob Clark /** 75cc8a4d5aSRob Clark * An object is either: 766ed0897cSRob Clark * inactive - on priv->inactive_dontneed or priv->inactive_willneed 776ed0897cSRob Clark * (depending on purgability status) 787198e6b0SRob Clark * active - on one one of the gpu's active_list.. well, at 797198e6b0SRob Clark * least for now we don't have (I don't think) hw sync between 807198e6b0SRob Clark * 2d and 3d one devices which have both, meaning we need to 817198e6b0SRob Clark * block on submit if a bo is already on other ring 827198e6b0SRob Clark */ 83c8afe684SRob Clark struct list_head mm_list; 847198e6b0SRob Clark 857198e6b0SRob Clark /* Transiently in the process of submit ioctl, objects associated 867198e6b0SRob Clark * with the submit are on submit->bo_list.. this only lasts for 877198e6b0SRob Clark * the duration of the ioctl, so one bo can never be on multiple 887198e6b0SRob Clark * submit lists. 897198e6b0SRob Clark */ 907198e6b0SRob Clark struct list_head submit_entry; 917198e6b0SRob Clark 92c8afe684SRob Clark struct page **pages; 93c8afe684SRob Clark struct sg_table *sgt; 94c8afe684SRob Clark void *vaddr; 95c8afe684SRob Clark 964b85f7f5SRob Clark struct list_head vmas; /* list of msm_gem_vma */ 977198e6b0SRob Clark 98871d812aSRob Clark /* For physically contiguous buffers. Used when we don't have 99072f1f91SRob Clark * an IOMMU. Also used for stolen/splashscreen buffer. 100871d812aSRob Clark */ 101871d812aSRob Clark struct drm_mm_node *vram_node; 1020815d774SJordan Crouse 1030815d774SJordan Crouse char name[32]; /* Identifier to print for the debugfs files */ 1049d8baa2bSAkhil P Oommen 105ab5c54cbSRob Clark int active_count; 106c8afe684SRob Clark }; 107c8afe684SRob Clark #define to_msm_bo(x) container_of(x, struct msm_gem_object, base) 108c8afe684SRob Clark 1098f642378SRob Clark int msm_gem_mmap_obj(struct drm_gem_object *obj, 1108f642378SRob Clark struct vm_area_struct *vma); 1118f642378SRob Clark int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma); 1128f642378SRob Clark uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj); 1138f642378SRob Clark int msm_gem_get_iova(struct drm_gem_object *obj, 1148f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1158f642378SRob Clark int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj, 1168f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova, 1178f642378SRob Clark u64 range_start, u64 range_end); 118e4b87d22SRob Clark int msm_gem_get_and_pin_iova_locked(struct drm_gem_object *obj, 119e4b87d22SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1208f642378SRob Clark int msm_gem_get_and_pin_iova(struct drm_gem_object *obj, 1218f642378SRob Clark struct msm_gem_address_space *aspace, uint64_t *iova); 1228f642378SRob Clark uint64_t msm_gem_iova(struct drm_gem_object *obj, 1238f642378SRob Clark struct msm_gem_address_space *aspace); 124e4b87d22SRob Clark void msm_gem_unpin_iova_locked(struct drm_gem_object *obj, 125e4b87d22SRob Clark struct msm_gem_address_space *aspace); 1268f642378SRob Clark void msm_gem_unpin_iova(struct drm_gem_object *obj, 1278f642378SRob Clark struct msm_gem_address_space *aspace); 1288f642378SRob Clark struct page **msm_gem_get_pages(struct drm_gem_object *obj); 1298f642378SRob Clark void msm_gem_put_pages(struct drm_gem_object *obj); 1308f642378SRob Clark int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev, 1318f642378SRob Clark struct drm_mode_create_dumb *args); 1328f642378SRob Clark int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, 1338f642378SRob Clark uint32_t handle, uint64_t *offset); 134e4b87d22SRob Clark void *msm_gem_get_vaddr_locked(struct drm_gem_object *obj); 1358f642378SRob Clark void *msm_gem_get_vaddr(struct drm_gem_object *obj); 1368f642378SRob Clark void *msm_gem_get_vaddr_active(struct drm_gem_object *obj); 137e4b87d22SRob Clark void msm_gem_put_vaddr_locked(struct drm_gem_object *obj); 1388f642378SRob Clark void msm_gem_put_vaddr(struct drm_gem_object *obj); 1398f642378SRob Clark int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv); 1408f642378SRob Clark int msm_gem_sync_object(struct drm_gem_object *obj, 1418f642378SRob Clark struct msm_fence_context *fctx, bool exclusive); 1428f642378SRob Clark void msm_gem_active_get(struct drm_gem_object *obj, struct msm_gpu *gpu); 1438f642378SRob Clark void msm_gem_active_put(struct drm_gem_object *obj); 1448f642378SRob Clark int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout); 1458f642378SRob Clark int msm_gem_cpu_fini(struct drm_gem_object *obj); 1468f642378SRob Clark void msm_gem_free_object(struct drm_gem_object *obj); 1478f642378SRob Clark int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file, 1488f642378SRob Clark uint32_t size, uint32_t flags, uint32_t *handle, char *name); 1498f642378SRob Clark struct drm_gem_object *msm_gem_new(struct drm_device *dev, 1508f642378SRob Clark uint32_t size, uint32_t flags); 1518f642378SRob Clark struct drm_gem_object *msm_gem_new_locked(struct drm_device *dev, 1528f642378SRob Clark uint32_t size, uint32_t flags); 1538f642378SRob Clark void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size, 1548f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1558f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1568f642378SRob Clark void *msm_gem_kernel_new_locked(struct drm_device *dev, uint32_t size, 1578f642378SRob Clark uint32_t flags, struct msm_gem_address_space *aspace, 1588f642378SRob Clark struct drm_gem_object **bo, uint64_t *iova); 1598f642378SRob Clark void msm_gem_kernel_put(struct drm_gem_object *bo, 1608f642378SRob Clark struct msm_gem_address_space *aspace, bool locked); 1618f642378SRob Clark struct drm_gem_object *msm_gem_import(struct drm_device *dev, 1628f642378SRob Clark struct dma_buf *dmabuf, struct sg_table *sgt); 1638f642378SRob Clark __printf(2, 3) 1648f642378SRob Clark void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...); 1658f642378SRob Clark #ifdef CONFIG_DEBUG_FS 166528107c8SRob Clark 167528107c8SRob Clark struct msm_gem_stats { 168528107c8SRob Clark struct { 169528107c8SRob Clark unsigned count; 170528107c8SRob Clark size_t size; 1710054eeb7SRob Clark } all, active, purgeable, purged; 172528107c8SRob Clark }; 173528107c8SRob Clark 174528107c8SRob Clark void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m, 175528107c8SRob Clark struct msm_gem_stats *stats); 1768f642378SRob Clark void msm_gem_describe_objects(struct list_head *list, struct seq_file *m); 1778f642378SRob Clark #endif 1788f642378SRob Clark 179a6ae74c9SRob Clark static inline void 180a6ae74c9SRob Clark msm_gem_lock(struct drm_gem_object *obj) 181a6ae74c9SRob Clark { 1826c0e3ea2SRob Clark dma_resv_lock(obj->resv, NULL); 183a6ae74c9SRob Clark } 184a6ae74c9SRob Clark 185599089c6SRob Clark static inline bool __must_check 186599089c6SRob Clark msm_gem_trylock(struct drm_gem_object *obj) 187599089c6SRob Clark { 1886c0e3ea2SRob Clark return dma_resv_trylock(obj->resv); 189599089c6SRob Clark } 190599089c6SRob Clark 191a6ae74c9SRob Clark static inline int 192a6ae74c9SRob Clark msm_gem_lock_interruptible(struct drm_gem_object *obj) 193a6ae74c9SRob Clark { 1946c0e3ea2SRob Clark return dma_resv_lock_interruptible(obj->resv, NULL); 195a6ae74c9SRob Clark } 196a6ae74c9SRob Clark 197a6ae74c9SRob Clark static inline void 198a6ae74c9SRob Clark msm_gem_unlock(struct drm_gem_object *obj) 199a6ae74c9SRob Clark { 2006c0e3ea2SRob Clark dma_resv_unlock(obj->resv); 201a6ae74c9SRob Clark } 202a6ae74c9SRob Clark 203a6ae74c9SRob Clark static inline bool 204a6ae74c9SRob Clark msm_gem_is_locked(struct drm_gem_object *obj) 205a6ae74c9SRob Clark { 2066c0e3ea2SRob Clark return dma_resv_is_locked(obj->resv); 207a6ae74c9SRob Clark } 208a6ae74c9SRob Clark 2097198e6b0SRob Clark static inline bool is_active(struct msm_gem_object *msm_obj) 2107198e6b0SRob Clark { 211*90643a24SRob Clark GEM_WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 212ab5c54cbSRob Clark return msm_obj->active_count; 2137198e6b0SRob Clark } 2147198e6b0SRob Clark 2150054eeb7SRob Clark /* imported/exported objects are not purgeable: */ 2160054eeb7SRob Clark static inline bool is_unpurgeable(struct msm_gem_object *msm_obj) 217cc8a4d5aSRob Clark { 218cc8a4d5aSRob Clark return msm_obj->base.dma_buf && msm_obj->base.import_attach; 219cc8a4d5aSRob Clark } 220cc8a4d5aSRob Clark 22168209390SRob Clark static inline bool is_purgeable(struct msm_gem_object *msm_obj) 22268209390SRob Clark { 22368209390SRob Clark return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt && 2240054eeb7SRob Clark !is_unpurgeable(msm_obj); 22568209390SRob Clark } 22668209390SRob Clark 227e1e9db2cSRob Clark static inline bool is_vunmapable(struct msm_gem_object *msm_obj) 228e1e9db2cSRob Clark { 229*90643a24SRob Clark GEM_WARN_ON(!msm_gem_is_locked(&msm_obj->base)); 230e1e9db2cSRob Clark return (msm_obj->vmap_count == 0) && msm_obj->vaddr; 231e1e9db2cSRob Clark } 232e1e9db2cSRob Clark 2330054eeb7SRob Clark static inline void mark_purgeable(struct msm_gem_object *msm_obj) 234cc8a4d5aSRob Clark { 235cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 236cc8a4d5aSRob Clark 237*90643a24SRob Clark GEM_WARN_ON(!mutex_is_locked(&priv->mm_lock)); 238cc8a4d5aSRob Clark 2390054eeb7SRob Clark if (is_unpurgeable(msm_obj)) 240cc8a4d5aSRob Clark return; 241cc8a4d5aSRob Clark 242*90643a24SRob Clark if (GEM_WARN_ON(msm_obj->dontneed)) 243cc8a4d5aSRob Clark return; 244cc8a4d5aSRob Clark 245cc8a4d5aSRob Clark priv->shrinkable_count += msm_obj->base.size >> PAGE_SHIFT; 246cc8a4d5aSRob Clark msm_obj->dontneed = true; 247cc8a4d5aSRob Clark } 248cc8a4d5aSRob Clark 2490054eeb7SRob Clark static inline void mark_unpurgeable(struct msm_gem_object *msm_obj) 250cc8a4d5aSRob Clark { 251cc8a4d5aSRob Clark struct msm_drm_private *priv = msm_obj->base.dev->dev_private; 252cc8a4d5aSRob Clark 253*90643a24SRob Clark GEM_WARN_ON(!mutex_is_locked(&priv->mm_lock)); 254cc8a4d5aSRob Clark 2550054eeb7SRob Clark if (is_unpurgeable(msm_obj)) 256cc8a4d5aSRob Clark return; 257cc8a4d5aSRob Clark 258*90643a24SRob Clark if (GEM_WARN_ON(!msm_obj->dontneed)) 259cc8a4d5aSRob Clark return; 260cc8a4d5aSRob Clark 261cc8a4d5aSRob Clark priv->shrinkable_count -= msm_obj->base.size >> PAGE_SHIFT; 262*90643a24SRob Clark GEM_WARN_ON(priv->shrinkable_count < 0); 263cc8a4d5aSRob Clark msm_obj->dontneed = false; 264cc8a4d5aSRob Clark } 265cc8a4d5aSRob Clark 266599089c6SRob Clark void msm_gem_purge(struct drm_gem_object *obj); 267599089c6SRob Clark void msm_gem_vunmap(struct drm_gem_object *obj); 2680e08270aSSushmita Susheelendra 2697198e6b0SRob Clark /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc, 2707198e6b0SRob Clark * associated with the cmdstream submission for synchronization (and 2717198e6b0SRob Clark * make it easier to unwind when things go wrong, etc). This only 2727198e6b0SRob Clark * lasts for the duration of the submit-ioctl. 2737198e6b0SRob Clark */ 2747198e6b0SRob Clark struct msm_gem_submit { 275964d2f97SRob Clark struct kref ref; 2767198e6b0SRob Clark struct drm_device *dev; 2777198e6b0SRob Clark struct msm_gpu *gpu; 278295b22aeSJordan Crouse struct msm_gem_address_space *aspace; 279f97decacSJordan Crouse struct list_head node; /* node in ring submit list */ 2807198e6b0SRob Clark struct list_head bo_list; 2817198e6b0SRob Clark struct ww_acquire_ctx ticket; 282f97decacSJordan Crouse uint32_t seqno; /* Sequence number of the submit on the ring */ 283f54d1867SChris Wilson struct dma_fence *fence; 284f7de1545SJordan Crouse struct msm_gpu_submitqueue *queue; 2854816b626SRob Clark struct pid *pid; /* submitting process */ 286340faef2SRob Clark bool valid; /* true if no cmdstream patching needed */ 2876a8bd08dSRob Clark bool in_rb; /* "sudo" mode, copy cmds into RB */ 288f97decacSJordan Crouse struct msm_ringbuffer *ring; 289cf655d61SJordan Crouse struct msm_file_private *ctx; 2907198e6b0SRob Clark unsigned int nr_cmds; 2917198e6b0SRob Clark unsigned int nr_bos; 2924241db42SJordan Crouse u32 ident; /* A "identifier" for the submit for logging */ 2937198e6b0SRob Clark struct { 2947198e6b0SRob Clark uint32_t type; 2957198e6b0SRob Clark uint32_t size; /* in dwords */ 29678babc16SRob Clark uint64_t iova; 29720224d71SRob Clark uint32_t offset;/* in dwords */ 298a7d3c950SRob Clark uint32_t idx; /* cmdstream buffer idx in bos[] */ 29920224d71SRob Clark uint32_t nr_relocs; 30020224d71SRob Clark struct drm_msm_gem_submit_reloc *relocs; 3016b597ce2SRob Clark } *cmd; /* array of size nr_cmds */ 3027198e6b0SRob Clark struct { 3037198e6b0SRob Clark uint32_t flags; 304b673499aSKristian H. Kristensen union { 3057198e6b0SRob Clark struct msm_gem_object *obj; 306b673499aSKristian H. Kristensen uint32_t handle; 307b673499aSKristian H. Kristensen }; 30878babc16SRob Clark uint64_t iova; 3094c145df1SGustavo A. R. Silva } bos[]; 3107198e6b0SRob Clark }; 3117198e6b0SRob Clark 312964d2f97SRob Clark void __msm_gem_submit_destroy(struct kref *kref); 313964d2f97SRob Clark 314964d2f97SRob Clark static inline void msm_gem_submit_get(struct msm_gem_submit *submit) 315964d2f97SRob Clark { 316964d2f97SRob Clark kref_get(&submit->ref); 317964d2f97SRob Clark } 318964d2f97SRob Clark 319964d2f97SRob Clark static inline void msm_gem_submit_put(struct msm_gem_submit *submit) 320964d2f97SRob Clark { 321964d2f97SRob Clark kref_put(&submit->ref, __msm_gem_submit_destroy); 322964d2f97SRob Clark } 323964d2f97SRob Clark 324e515af8dSRob Clark /* helper to determine of a buffer in submit should be dumped, used for both 325e515af8dSRob Clark * devcoredump and debugfs cmdstream dumping: 326e515af8dSRob Clark */ 327e515af8dSRob Clark static inline bool 328e515af8dSRob Clark should_dump(struct msm_gem_submit *submit, int idx) 329e515af8dSRob Clark { 330e515af8dSRob Clark extern bool rd_full; 331e515af8dSRob Clark return rd_full || (submit->bos[idx].flags & MSM_SUBMIT_BO_DUMP); 332e515af8dSRob Clark } 333e515af8dSRob Clark 334c8afe684SRob Clark #endif /* __MSM_GEM_H__ */ 335