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