]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - drivers/gpu/drm/amd/amdgpu/amdgpu_object.h
UBUNTU: Ubuntu-5.4.0-117.132
[mirror_ubuntu-focal-kernel.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_object.h
CommitLineData
d38ceaf9
AD
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
9702d40d 34#define AMDGPU_BO_INVALID_OFFSET LONG_MAX
bf314ca3 35#define AMDGPU_BO_MAX_PLACEMENTS 3
9702d40d 36
a906dbb1
CZ
37struct amdgpu_bo_param {
38 unsigned long size;
39 int byte_align;
40 u32 domain;
aa2b2e28 41 u32 preferred_domain;
a906dbb1
CZ
42 u64 flags;
43 enum ttm_bo_type type;
52791eee 44 struct dma_resv *resv;
a906dbb1
CZ
45};
46
ec681545 47/* bo virtual addresses in a vm */
9124a398 48struct amdgpu_bo_va_mapping {
aebc5e6f 49 struct amdgpu_bo_va *bo_va;
9124a398
CK
50 struct list_head list;
51 struct rb_node rb;
52 uint64_t start;
53 uint64_t last;
54 uint64_t __subtree_last;
55 uint64_t offset;
56 uint64_t flags;
57};
58
ec681545 59/* User space allocated BO in a VM */
9124a398 60struct amdgpu_bo_va {
ec681545
CK
61 struct amdgpu_vm_bo_base base;
62
9124a398 63 /* protected by bo being reserved */
9124a398
CK
64 unsigned ref_count;
65
00b5cc83
CK
66 /* all other members protected by the VM PD being reserved */
67 struct dma_fence *last_pt_update;
68
9124a398
CK
69 /* mappings for this bo_va */
70 struct list_head invalids;
71 struct list_head valids;
cb7b6ec2
CK
72
73 /* If the mappings are cleared or filled */
74 bool cleared;
df399b06 75
76 bool is_xgmi;
9124a398
CK
77};
78
9124a398
CK
79struct amdgpu_bo {
80 /* Protected by tbo.reserved */
6d7d9c5a 81 u32 preferred_domains;
9124a398 82 u32 allowed_domains;
bf314ca3 83 struct ttm_place placements[AMDGPU_BO_MAX_PLACEMENTS];
9124a398
CK
84 struct ttm_placement placement;
85 struct ttm_buffer_object tbo;
86 struct ttm_bo_kmap_obj kmap;
87 u64 flags;
88 unsigned pin_count;
89 u64 tiling_flags;
90 u64 metadata_flags;
91 void *metadata;
92 u32 metadata_size;
93 unsigned prime_shared_count;
646b9025
CK
94 /* per VM structure for page tables and with virtual addresses */
95 struct amdgpu_vm_bo_base *vm_bo;
9124a398 96 /* Constant after initialization */
9124a398
CK
97 struct amdgpu_bo *parent;
98 struct amdgpu_bo *shadow;
99
100 struct ttm_bo_kmap_obj dma_buf_vmap;
101 struct amdgpu_mn *mn;
ed5b89c6
CK
102
103 union {
104 struct list_head mn_list;
105 struct list_head shadow_list;
106 };
a46a2cd1
FK
107
108 struct kgd_mem *kfd_bo;
9124a398
CK
109};
110
b82485fd
AR
111static inline struct amdgpu_bo *ttm_to_amdgpu_bo(struct ttm_buffer_object *tbo)
112{
113 return container_of(tbo, struct amdgpu_bo, tbo);
114}
115
d38ceaf9
AD
116/**
117 * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
118 * @mem_type: ttm memory type
119 *
120 * Returns corresponding domain of the ttm mem_type
121 */
122static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
123{
124 switch (mem_type) {
125 case TTM_PL_VRAM:
126 return AMDGPU_GEM_DOMAIN_VRAM;
127 case TTM_PL_TT:
128 return AMDGPU_GEM_DOMAIN_GTT;
129 case TTM_PL_SYSTEM:
130 return AMDGPU_GEM_DOMAIN_CPU;
131 case AMDGPU_PL_GDS:
132 return AMDGPU_GEM_DOMAIN_GDS;
133 case AMDGPU_PL_GWS:
134 return AMDGPU_GEM_DOMAIN_GWS;
135 case AMDGPU_PL_OA:
136 return AMDGPU_GEM_DOMAIN_OA;
137 default:
138 break;
139 }
140 return 0;
141}
142
143/**
144 * amdgpu_bo_reserve - reserve bo
145 * @bo: bo structure
146 * @no_intr: don't return -ERESTARTSYS on pending signal
147 *
148 * Returns:
149 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
150 * a signal. Release all buffer reservations and return to user-space.
151 */
152static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
153{
a7d64de6 154 struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
d38ceaf9
AD
155 int r;
156
55c2e5a1 157 r = __ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
d38ceaf9
AD
158 if (unlikely(r != 0)) {
159 if (r != -ERESTARTSYS)
a7d64de6 160 dev_err(adev->dev, "%p reserve failed\n", bo);
d38ceaf9
AD
161 return r;
162 }
163 return 0;
164}
165
166static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
167{
168 ttm_bo_unreserve(&bo->tbo);
169}
170
d38ceaf9
AD
171static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
172{
173 return bo->tbo.num_pages << PAGE_SHIFT;
174}
175
176static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
177{
178 return (bo->tbo.num_pages << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
179}
180
181static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
182{
183 return (bo->tbo.mem.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
184}
185
186/**
187 * amdgpu_bo_mmap_offset - return mmap offset of bo
188 * @bo: amdgpu object for which we query the offset
189 *
190 * Returns mmap offset of the object.
191 */
192static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
193{
b96f3e7c 194 return drm_vma_node_offset_addr(&bo->tbo.base.vma_node);
d38ceaf9
AD
195}
196
5422a28f
CK
197/**
198 * amdgpu_bo_in_cpu_visible_vram - check if BO is (partly) in visible VRAM
199 */
200static inline bool amdgpu_bo_in_cpu_visible_vram(struct amdgpu_bo *bo)
201{
202 struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
203 unsigned fpfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
204 struct drm_mm_node *node = bo->tbo.mem.mm_node;
205 unsigned long pages_left;
206
207 if (bo->tbo.mem.mem_type != TTM_PL_VRAM)
208 return false;
209
210 for (pages_left = bo->tbo.mem.num_pages; pages_left;
211 pages_left -= node->size, node++)
212 if (node->start < fpfn)
213 return true;
214
215 return false;
216}
217
177ae09b
AR
218/**
219 * amdgpu_bo_explicit_sync - return whether the bo is explicitly synced
220 */
221static inline bool amdgpu_bo_explicit_sync(struct amdgpu_bo *bo)
222{
223 return bo->flags & AMDGPU_GEM_CREATE_EXPLICIT_SYNC;
224}
225
c704ab18
CK
226bool amdgpu_bo_is_amdgpu_bo(struct ttm_buffer_object *bo);
227void amdgpu_bo_placement_from_domain(struct amdgpu_bo *abo, u32 domain);
228
3216c6b7
CZ
229int amdgpu_bo_create(struct amdgpu_device *adev,
230 struct amdgpu_bo_param *bp,
eab3de23 231 struct amdgpu_bo **bo_ptr);
9d903cbd
CK
232int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
233 unsigned long size, int align,
234 u32 domain, struct amdgpu_bo **bo_ptr,
235 u64 *gpu_addr, void **cpu_addr);
7c204889
CK
236int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
237 unsigned long size, int align,
238 u32 domain, struct amdgpu_bo **bo_ptr,
239 u64 *gpu_addr, void **cpu_addr);
9151c65b
CK
240int amdgpu_bo_create_kernel_at(struct amdgpu_device *adev,
241 uint64_t offset, uint64_t size, uint32_t domain,
242 struct amdgpu_bo **bo_ptr, void **cpu_addr);
aa1d562e
JZ
243void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
244 void **cpu_addr);
d38ceaf9 245int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
f5e1c740 246void *amdgpu_bo_kptr(struct amdgpu_bo *bo);
d38ceaf9
AD
247void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
248struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
249void amdgpu_bo_unref(struct amdgpu_bo **bo);
7b7c6c81 250int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain);
d38ceaf9 251int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
7b7c6c81 252 u64 min_offset, u64 max_offset);
d38ceaf9
AD
253int amdgpu_bo_unpin(struct amdgpu_bo *bo);
254int amdgpu_bo_evict_vram(struct amdgpu_device *adev);
d38ceaf9 255int amdgpu_bo_init(struct amdgpu_device *adev);
6f752ec2 256int amdgpu_bo_late_init(struct amdgpu_device *adev);
d38ceaf9
AD
257void amdgpu_bo_fini(struct amdgpu_device *adev);
258int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
259 struct vm_area_struct *vma);
260int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
261void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
262int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
263 uint32_t metadata_size, uint64_t flags);
264int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
265 size_t buffer_size, uint32_t *metadata_size,
266 uint64_t *flags);
267void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
66257db7
NH
268 bool evict,
269 struct ttm_mem_reg *new_mem);
ab2f7a5c 270void amdgpu_bo_release_notify(struct ttm_buffer_object *bo);
d38ceaf9 271int amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
f54d1867 272void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
d38ceaf9 273 bool shared);
e8e32426 274int amdgpu_bo_sync_wait(struct amdgpu_bo *bo, void *owner, bool intr);
cdb7e8f2 275u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
82521316 276int amdgpu_bo_validate(struct amdgpu_bo *bo);
403009bf
CK
277int amdgpu_bo_restore_shadow(struct amdgpu_bo *shadow,
278 struct dma_fence **fence);
84b74608
DS
279uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
280 uint32_t domain);
d38ceaf9
AD
281
282/*
283 * sub allocation
284 */
285
286static inline uint64_t amdgpu_sa_bo_gpu_addr(struct amdgpu_sa_bo *sa_bo)
287{
288 return sa_bo->manager->gpu_addr + sa_bo->soffset;
289}
290
291static inline void * amdgpu_sa_bo_cpu_addr(struct amdgpu_sa_bo *sa_bo)
292{
293 return sa_bo->manager->cpu_ptr + sa_bo->soffset;
294}
295
296int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev,
297 struct amdgpu_sa_manager *sa_manager,
298 unsigned size, u32 align, u32 domain);
299void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev,
300 struct amdgpu_sa_manager *sa_manager);
301int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev,
302 struct amdgpu_sa_manager *sa_manager);
bbf0b345
JZ
303int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager,
304 struct amdgpu_sa_bo **sa_bo,
305 unsigned size, unsigned align);
d38ceaf9
AD
306void amdgpu_sa_bo_free(struct amdgpu_device *adev,
307 struct amdgpu_sa_bo **sa_bo,
f54d1867 308 struct dma_fence *fence);
d38ceaf9
AD
309#if defined(CONFIG_DEBUG_FS)
310void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager,
311 struct seq_file *m);
312#endif
313
3d1b8ec7
AG
314bool amdgpu_bo_support_uswc(u64 bo_flags);
315
d38ceaf9
AD
316
317#endif