xref: /linux/drivers/gpu/drm/amd/amdgpu/amdgpu_object.h (revision cb8fef4b07f71da01843457b66e579ad248a625e)
1 /*
2  * Copyright 2008 Advanced Micro Devices, Inc.
3  * Copyright 2008 Red Hat Inc.
4  * Copyright 2009 Jerome Glisse.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: Dave Airlie
25  *          Alex Deucher
26  *          Jerome Glisse
27  */
28 #ifndef __AMDGPU_OBJECT_H__
29 #define __AMDGPU_OBJECT_H__
30 
31 #include <drm/amdgpu_drm.h>
32 #include "amdgpu.h"
33 #include "amdgpu_res_cursor.h"
34 
35 #ifdef CONFIG_MMU_NOTIFIER
36 #include <linux/mmu_notifier.h>
37 #endif
38 
39 #define AMDGPU_BO_INVALID_OFFSET	LONG_MAX
40 #define AMDGPU_BO_MAX_PLACEMENTS	3
41 
42 /* BO flag to indicate a KFD userptr BO */
43 #define AMDGPU_AMDKFD_CREATE_USERPTR_BO	(1ULL << 63)
44 
45 #define to_amdgpu_bo_user(abo) container_of((abo), struct amdgpu_bo_user, bo)
46 #define to_amdgpu_bo_vm(abo) container_of((abo), struct amdgpu_bo_vm, bo)
47 
48 struct amdgpu_bo_param {
49 	unsigned long			size;
50 	int				byte_align;
51 	u32				bo_ptr_size;
52 	u32				domain;
53 	u32				preferred_domain;
54 	u64				flags;
55 	enum ttm_bo_type		type;
56 	bool				no_wait_gpu;
57 	struct dma_resv			*resv;
58 	void				(*destroy)(struct ttm_buffer_object *bo);
59 	/* xcp partition number plus 1, 0 means any partition */
60 	int8_t				xcp_id_plus1;
61 };
62 
63 /* bo virtual addresses in a vm */
64 struct amdgpu_bo_va_mapping {
65 	struct amdgpu_bo_va		*bo_va;
66 	struct list_head		list;
67 	struct rb_node			rb;
68 	uint64_t			start;
69 	uint64_t			last;
70 	uint64_t			__subtree_last;
71 	uint64_t			offset;
72 	uint32_t			flags;
73 };
74 
75 /* User space allocated BO in a VM */
76 struct amdgpu_bo_va {
77 	struct amdgpu_vm_bo_base	base;
78 
79 	/* protected by bo being reserved */
80 	unsigned			ref_count;
81 
82 	/* all other members protected by the VM PD being reserved */
83 	struct dma_fence	        *last_pt_update;
84 
85 	/* mappings for this bo_va */
86 	struct list_head		invalids;
87 	struct list_head		valids;
88 
89 	/* If the mappings are cleared or filled */
90 	bool				cleared;
91 
92 	bool				is_xgmi;
93 
94 	/*
95 	 * protected by vm reservation lock
96 	 * if non-zero, cannot unmap from GPU because user queues may still access it
97 	 */
98 	unsigned int			queue_refcount;
99 	/* Indicates if this buffer is mapped for any user queue. Once set, never reset. */
100 	bool				userq_va_mapped;
101 };
102 
103 struct amdgpu_bo {
104 	/* Protected by tbo.reserved */
105 	u32				preferred_domains;
106 	u32				allowed_domains;
107 	struct ttm_place		placements[AMDGPU_BO_MAX_PLACEMENTS];
108 	struct ttm_placement		placement;
109 	struct ttm_buffer_object	tbo;
110 	struct ttm_bo_kmap_obj		kmap;
111 	u64				flags;
112 	/* per VM structure for page tables and with virtual addresses */
113 	struct amdgpu_vm_bo_base	*vm_bo;
114 	/* Constant after initialization */
115 	struct amdgpu_bo		*parent;
116 
117 #ifdef CONFIG_MMU_NOTIFIER
118 	struct mmu_interval_notifier	notifier;
119 #endif
120 	struct kgd_mem                  *kfd_bo;
121 
122 	/*
123 	 * For GPUs with spatial partitioning, xcp partition number, -1 means
124 	 * any partition. For other ASICs without spatial partition, always 0
125 	 * for memory accounting.
126 	 */
127 	int8_t				xcp_id;
128 
129 	/* UALink Handle low 64 bits*/
130 	u64				ualink_handle_lo;
131 };
132 
133 struct amdgpu_bo_user {
134 	struct amdgpu_bo		bo;
135 	u64				tiling_flags;
136 	u64				metadata_flags;
137 	void				*metadata;
138 	u32				metadata_size;
139 
140 };
141 
142 struct amdgpu_bo_vm {
143 	struct amdgpu_bo		bo;
144 	struct amdgpu_vm_bo_base        entries[];
145 };
146 
147 static inline struct amdgpu_bo *ttm_to_amdgpu_bo(struct ttm_buffer_object *tbo)
148 {
149 	return container_of(tbo, struct amdgpu_bo, tbo);
150 }
151 
152 /**
153  * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
154  * @mem_type:	ttm memory type
155  *
156  * Returns corresponding domain of the ttm mem_type
157  */
158 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
159 {
160 	switch (mem_type) {
161 	case TTM_PL_VRAM:
162 		return AMDGPU_GEM_DOMAIN_VRAM;
163 	case TTM_PL_TT:
164 		return AMDGPU_GEM_DOMAIN_GTT;
165 	case TTM_PL_SYSTEM:
166 		return AMDGPU_GEM_DOMAIN_CPU;
167 	case AMDGPU_PL_GDS:
168 		return AMDGPU_GEM_DOMAIN_GDS;
169 	case AMDGPU_PL_GWS:
170 		return AMDGPU_GEM_DOMAIN_GWS;
171 	case AMDGPU_PL_OA:
172 		return AMDGPU_GEM_DOMAIN_OA;
173 	case AMDGPU_PL_DOORBELL:
174 		return AMDGPU_GEM_DOMAIN_DOORBELL;
175 	case AMDGPU_PL_NPA:
176 		return AMDGPU_GEM_DOMAIN_NPA;
177 	default:
178 		break;
179 	}
180 	return 0;
181 }
182 
183 /**
184  * amdgpu_bo_reserve - reserve bo
185  * @bo:		bo structure
186  * @no_intr:	don't return -ERESTARTSYS on pending signal
187  *
188  * Returns:
189  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
190  * a signal. Release all buffer reservations and return to user-space.
191  */
192 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
193 {
194 	struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
195 	int r;
196 
197 	r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
198 	if (unlikely(r != 0)) {
199 		if (r != -ERESTARTSYS)
200 			dev_err(adev->dev, "%p reserve failed\n", bo);
201 		return r;
202 	}
203 	return 0;
204 }
205 
206 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
207 {
208 	ttm_bo_unreserve(&bo->tbo);
209 }
210 
211 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
212 {
213 	return bo->tbo.base.size;
214 }
215 
216 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
217 {
218 	return bo->tbo.base.size / AMDGPU_GPU_PAGE_SIZE;
219 }
220 
221 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
222 {
223 	return (bo->tbo.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
224 }
225 
226 /**
227  * amdgpu_bo_mmap_offset - return mmap offset of bo
228  * @bo:	amdgpu object for which we query the offset
229  *
230  * Returns mmap offset of the object.
231  */
232 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
233 {
234 	return drm_vma_node_offset_addr(&bo->tbo.base.vma_node);
235 }
236 
237 /**
238  * amdgpu_bo_explicit_sync - return whether the bo is explicitly synced
239  */
240 static inline bool amdgpu_bo_explicit_sync(struct amdgpu_bo *bo)
241 {
242 	return bo->flags & AMDGPU_GEM_CREATE_EXPLICIT_SYNC;
243 }
244 
245 /**
246  * amdgpu_bo_encrypted - test if the BO is encrypted
247  * @bo: pointer to a buffer object
248  *
249  * Return true if the buffer object is encrypted, false otherwise.
250  */
251 static inline bool amdgpu_bo_encrypted(struct amdgpu_bo *bo)
252 {
253 	return bo->flags & AMDGPU_GEM_CREATE_ENCRYPTED;
254 }
255 
256 bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo);
257 void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain);
258 
259 int amdgpu_bo_create(struct amdgpu_device *adev,
260 		     struct amdgpu_bo_param *bp,
261 		     struct amdgpu_bo **bo_ptr);
262 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
263 			      unsigned long size, int align,
264 			      u32 domain, struct amdgpu_bo **bo_ptr,
265 			      u64 *gpu_addr, void **cpu_addr);
266 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
267 			    unsigned long size, int align,
268 			    u32 domain, struct amdgpu_bo **bo_ptr,
269 			    u64 *gpu_addr, void **cpu_addr);
270 int amdgpu_bo_create_isp_user(struct amdgpu_device *adev,
271 			   struct dma_buf *dbuf, u32 domain,
272 			   struct amdgpu_bo **bo,
273 			   u64 *gpu_addr);
274 int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
275 			       uint64_t offset, uint64_t size,
276 			       struct amdgpu_bo **bo_ptr, void **cpu_addr);
277 int amdgpu_bo_create_user(struct amdgpu_device *adev,
278 			  struct amdgpu_bo_param *bp,
279 			  struct amdgpu_bo_user **ubo_ptr);
280 int amdgpu_bo_create_vm(struct amdgpu_device *adev,
281 			struct amdgpu_bo_param *bp,
282 			struct amdgpu_bo_vm **ubo_ptr);
283 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
284 			   void **cpu_addr);
285 void amdgpu_bo_free_isp_user(struct amdgpu_bo *bo);
286 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
287 void *amdgpu_bo_kptr(struct amdgpu_bo *bo);
288 void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
289 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
290 void amdgpu_bo_unref(struct amdgpu_bo **bo);
291 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain);
292 void amdgpu_bo_unpin(struct amdgpu_bo *bo);
293 int amdgpu_bo_init(struct amdgpu_device *adev);
294 void amdgpu_bo_fini(struct amdgpu_device *adev);
295 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
296 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
297 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
298 			    uint32_t metadata_size, uint64_t flags);
299 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
300 			   size_t buffer_size, uint32_t *metadata_size,
301 			   uint64_t *flags);
302 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
303 			   bool evict,
304 			   struct ttm_resource *new_mem);
305 void amdgpu_bo_release_notify(struct ttm_buffer_object *bo);
306 vm_fault_t amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
307 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
308 		     bool shared);
309 int amdgpu_bo_sync_wait_resv(struct amdgpu_device *adev, struct dma_resv *resv,
310 			     enum amdgpu_sync_mode sync_mode, void *owner,
311 			     bool intr);
312 int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr);
313 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
314 u64 amdgpu_bo_fb_aper_addr(struct amdgpu_bo *bo);
315 u64 amdgpu_bo_gpu_offset_no_check(struct amdgpu_bo *bo);
316 uint32_t amdgpu_bo_mem_stats_placement(struct amdgpu_bo *bo);
317 uint32_t amdgpu_bo_get_preferred_domain(struct amdgpu_device *adev,
318 					    uint32_t domain);
319 
320 bool amdgpu_bo_support_uswc(u64 bo_flags);
321 
322 
323 #endif
324