2 * Copyright 2016 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
22 * Authors: Christian König
24 #ifndef __AMDGPU_VM_H__
25 #define __AMDGPU_VM_H__
27 #include <linux/idr.h>
28 #include <linux/kfifo.h>
29 #include <linux/rbtree.h>
30 #include <drm/gpu_scheduler.h>
31 #include <drm/drm_file.h>
33 #include "amdgpu_sync.h"
34 #include "amdgpu_ring.h"
35 #include "amdgpu_ids.h"
39 struct amdgpu_bo_list_entry;
45 /* Maximum number of PTEs the hardware can write with one command */
46 #define AMDGPU_VM_MAX_UPDATE_SIZE 0x3FFFF
48 /* number of entries in page table */
49 #define AMDGPU_VM_PTE_COUNT(adev) (1 << (adev)->vm_manager.block_size)
51 /* PTBs (Page Table Blocks) need to be aligned to 32K */
52 #define AMDGPU_VM_PTB_ALIGN_SIZE 32768
54 #define AMDGPU_PTE_VALID (1ULL << 0)
55 #define AMDGPU_PTE_SYSTEM (1ULL << 1)
56 #define AMDGPU_PTE_SNOOPED (1ULL << 2)
59 #define AMDGPU_PTE_EXECUTABLE (1ULL << 4)
61 #define AMDGPU_PTE_READABLE (1ULL << 5)
62 #define AMDGPU_PTE_WRITEABLE (1ULL << 6)
64 #define AMDGPU_PTE_FRAG(x) ((x & 0x1fULL) << 7)
66 /* TILED for VEGA10, reserved for older ASICs */
67 #define AMDGPU_PTE_PRT (1ULL << 51)
69 /* PDE is handled as PTE for VEGA10 */
70 #define AMDGPU_PDE_PTE (1ULL << 54)
72 /* PTE is handled as PDE for VEGA10 (Translate Further) */
73 #define AMDGPU_PTE_TF (1ULL << 56)
75 /* PDE Block Fragment Size for VEGA10 */
76 #define AMDGPU_PDE_BFS(a) ((uint64_t)a << 59)
79 #define AMDGPU_PTE_MTYPE(a) ((uint64_t)a << 57)
80 #define AMDGPU_PTE_MTYPE_MASK AMDGPU_PTE_MTYPE(3ULL)
83 #define AMDGPU_MTYPE_CC 2
85 #define AMDGPU_PTE_DEFAULT_ATC (AMDGPU_PTE_SYSTEM \
86 | AMDGPU_PTE_SNOOPED \
87 | AMDGPU_PTE_EXECUTABLE \
88 | AMDGPU_PTE_READABLE \
89 | AMDGPU_PTE_WRITEABLE \
90 | AMDGPU_PTE_MTYPE(AMDGPU_MTYPE_CC))
92 /* How to programm VM fault handling */
93 #define AMDGPU_VM_FAULT_STOP_NEVER 0
94 #define AMDGPU_VM_FAULT_STOP_FIRST 1
95 #define AMDGPU_VM_FAULT_STOP_ALWAYS 2
97 /* max number of VMHUB */
98 #define AMDGPU_MAX_VMHUBS 2
99 #define AMDGPU_GFXHUB 0
100 #define AMDGPU_MMHUB 1
102 /* hardcode that limit for now */
103 #define AMDGPU_VA_RESERVED_SIZE (1ULL << 20)
105 /* VA hole for 48bit addresses on Vega10 */
106 #define AMDGPU_VA_HOLE_START 0x0000800000000000ULL
107 #define AMDGPU_VA_HOLE_END 0xffff800000000000ULL
110 * Hardware is programmed as if the hole doesn't exists with start and end
113 * This mask is used to remove the upper 16bits of the VA and so come up with
114 * the linear addr value.
116 #define AMDGPU_VA_HOLE_MASK 0x0000ffffffffffffULL
118 /* max vmids dedicated for process */
119 #define AMDGPU_VM_MAX_RESERVED_VMID 1
121 #define AMDGPU_VM_CONTEXT_GFX 0
122 #define AMDGPU_VM_CONTEXT_COMPUTE 1
124 /* See vm_update_mode */
125 #define AMDGPU_VM_USE_CPU_FOR_GFX (1 << 0)
126 #define AMDGPU_VM_USE_CPU_FOR_COMPUTE (1 << 1)
128 /* VMPT level enumerate, and the hiberachy is:
129 * PDB2->PDB1->PDB0->PTB
131 enum amdgpu_vm_level {
138 /* base structure for tracking BO usage in a VM */
139 struct amdgpu_vm_bo_base {
140 /* constant after initialization */
141 struct amdgpu_vm *vm;
142 struct amdgpu_bo *bo;
144 /* protected by bo being reserved */
145 struct list_head bo_list;
147 /* protected by spinlock */
148 struct list_head vm_status;
150 /* protected by the BO being reserved */
154 struct amdgpu_vm_pt {
155 struct amdgpu_vm_bo_base base;
158 /* array of page tables, one for each directory entry */
159 struct amdgpu_vm_pt *entries;
162 #define AMDGPU_VM_FAULT(pasid, addr) (((u64)(pasid) << 48) | (addr))
163 #define AMDGPU_VM_FAULT_PASID(fault) ((u64)(fault) >> 48)
164 #define AMDGPU_VM_FAULT_ADDR(fault) ((u64)(fault) & 0xfffffffff000ULL)
167 /* tree of virtual addresses mapped */
168 struct rb_root_cached va;
170 /* protecting invalidated */
171 spinlock_t status_lock;
173 /* BOs who needs a validation */
174 struct list_head evicted;
176 /* PT BOs which relocated and their parent need an update */
177 struct list_head relocated;
179 /* BOs moved, but not yet updated in the PT */
180 struct list_head moved;
182 /* BO mappings freed, but not yet updated in the PT */
183 struct list_head freed;
185 /* contains the page directory */
186 struct amdgpu_vm_pt root;
187 struct dma_fence *last_update;
189 /* protecting freed */
190 spinlock_t freed_lock;
192 /* Scheduler entity for page table updates */
193 struct drm_sched_entity entity;
196 /* dedicated to vm */
197 struct amdgpu_vmid *reserved_vmid[AMDGPU_MAX_VMHUBS];
199 /* Flag to indicate if VM tables are updated by CPU or GPU (SDMA) */
200 bool use_cpu_for_update;
202 /* Flag to indicate ATS support from PTE for GFX9 */
203 bool pte_support_ats;
205 /* Up to 128 pending retry page faults */
206 DECLARE_KFIFO(faults, u64, 128);
208 /* Limit non-retry fault storms */
209 unsigned int fault_credit;
212 struct amdgpu_vm_manager {
213 /* Handling of VMIDs */
214 struct amdgpu_vmid_mgr id_mgr[AMDGPU_MAX_VMHUBS];
216 /* Handling of VM fences */
218 unsigned seqno[AMDGPU_MAX_RINGS];
223 uint32_t fragment_size;
224 enum amdgpu_vm_level root_level;
225 /* vram base address for page table entry */
226 u64 vram_base_offset;
227 /* vm pte handling */
228 const struct amdgpu_vm_pte_funcs *vm_pte_funcs;
229 struct amdgpu_ring *vm_pte_rings[AMDGPU_MAX_RINGS];
230 unsigned vm_pte_num_rings;
231 atomic_t vm_pte_next_ring;
233 /* partial resident texture handling */
235 atomic_t num_prt_users;
237 /* controls how VM page tables are updated for Graphics and Compute.
238 * BIT0[= 0] Graphics updated by SDMA [= 1] by CPU
239 * BIT1[= 0] Compute updated by SDMA [= 1] by CPU
243 /* PASID to VM mapping, will be used in interrupt context to
244 * look up VM of a page fault
246 struct idr pasid_idr;
247 spinlock_t pasid_lock;
250 void amdgpu_vm_manager_init(struct amdgpu_device *adev);
251 void amdgpu_vm_manager_fini(struct amdgpu_device *adev);
252 int amdgpu_vm_init(struct amdgpu_device *adev, struct amdgpu_vm *vm,
253 int vm_context, unsigned int pasid);
254 void amdgpu_vm_fini(struct amdgpu_device *adev, struct amdgpu_vm *vm);
255 bool amdgpu_vm_pasid_fault_credit(struct amdgpu_device *adev,
257 void amdgpu_vm_get_pd_bo(struct amdgpu_vm *vm,
258 struct list_head *validated,
259 struct amdgpu_bo_list_entry *entry);
260 bool amdgpu_vm_ready(struct amdgpu_vm *vm);
261 int amdgpu_vm_validate_pt_bos(struct amdgpu_device *adev, struct amdgpu_vm *vm,
262 int (*callback)(void *p, struct amdgpu_bo *bo),
264 int amdgpu_vm_alloc_pts(struct amdgpu_device *adev,
265 struct amdgpu_vm *vm,
266 uint64_t saddr, uint64_t size);
267 int amdgpu_vm_flush(struct amdgpu_ring *ring, struct amdgpu_job *job, bool need_pipe_sync);
268 int amdgpu_vm_update_directories(struct amdgpu_device *adev,
269 struct amdgpu_vm *vm);
270 int amdgpu_vm_clear_freed(struct amdgpu_device *adev,
271 struct amdgpu_vm *vm,
272 struct dma_fence **fence);
273 int amdgpu_vm_handle_moved(struct amdgpu_device *adev,
274 struct amdgpu_vm *vm);
275 int amdgpu_vm_bo_update(struct amdgpu_device *adev,
276 struct amdgpu_bo_va *bo_va,
278 void amdgpu_vm_bo_invalidate(struct amdgpu_device *adev,
279 struct amdgpu_bo *bo, bool evicted);
280 struct amdgpu_bo_va *amdgpu_vm_bo_find(struct amdgpu_vm *vm,
281 struct amdgpu_bo *bo);
282 struct amdgpu_bo_va *amdgpu_vm_bo_add(struct amdgpu_device *adev,
283 struct amdgpu_vm *vm,
284 struct amdgpu_bo *bo);
285 int amdgpu_vm_bo_map(struct amdgpu_device *adev,
286 struct amdgpu_bo_va *bo_va,
287 uint64_t addr, uint64_t offset,
288 uint64_t size, uint64_t flags);
289 int amdgpu_vm_bo_replace_map(struct amdgpu_device *adev,
290 struct amdgpu_bo_va *bo_va,
291 uint64_t addr, uint64_t offset,
292 uint64_t size, uint64_t flags);
293 int amdgpu_vm_bo_unmap(struct amdgpu_device *adev,
294 struct amdgpu_bo_va *bo_va,
296 int amdgpu_vm_bo_clear_mappings(struct amdgpu_device *adev,
297 struct amdgpu_vm *vm,
298 uint64_t saddr, uint64_t size);
299 struct amdgpu_bo_va_mapping *amdgpu_vm_bo_lookup_mapping(struct amdgpu_vm *vm,
301 void amdgpu_vm_bo_rmv(struct amdgpu_device *adev,
302 struct amdgpu_bo_va *bo_va);
303 void amdgpu_vm_adjust_size(struct amdgpu_device *adev, uint32_t vm_size,
304 uint32_t fragment_size_default, unsigned max_level,
306 int amdgpu_vm_ioctl(struct drm_device *dev, void *data, struct drm_file *filp);
307 bool amdgpu_vm_need_pipeline_sync(struct amdgpu_ring *ring,
308 struct amdgpu_job *job);
309 void amdgpu_vm_check_compute_bug(struct amdgpu_device *adev);