1 /* SPDX-License-Identifier: GPL-2.0 or MIT */
2 /* Copyright 2019 Linaro, Ltd, Rob Herring <[email protected]> */
3 /* Copyright 2023 Collabora ltd. */
4 
5 #ifndef __PANTHOR_MMU_H__
6 #define __PANTHOR_MMU_H__
7 
8 #include <linux/dma-resv.h>
9 
10 struct drm_exec;
11 struct drm_sched_job;
12 struct drm_memory_stats;
13 struct panthor_gem_object;
14 struct panthor_heap_pool;
15 struct panthor_vm;
16 struct panthor_vma;
17 struct panthor_mmu;
18 
19 int panthor_mmu_init(struct panthor_device *ptdev);
20 void panthor_mmu_unplug(struct panthor_device *ptdev);
21 void panthor_mmu_pre_reset(struct panthor_device *ptdev);
22 void panthor_mmu_post_reset(struct panthor_device *ptdev);
23 void panthor_mmu_suspend(struct panthor_device *ptdev);
24 void panthor_mmu_resume(struct panthor_device *ptdev);
25 
26 int panthor_vm_map_bo_range(struct panthor_vm *vm, struct panthor_gem_object *bo,
27 			    u64 offset, u64 size, u64 va, u32 flags);
28 int panthor_vm_unmap_range(struct panthor_vm *vm, u64 va, u64 size);
29 struct panthor_gem_object *
30 panthor_vm_get_bo_for_va(struct panthor_vm *vm, u64 va, u64 *bo_offset);
31 
32 int panthor_vm_active(struct panthor_vm *vm);
33 void panthor_vm_idle(struct panthor_vm *vm);
34 u32 panthor_vm_page_size(struct panthor_vm *vm);
35 int panthor_vm_as(struct panthor_vm *vm);
36 int panthor_vm_flush_all(struct panthor_vm *vm);
37 
38 struct panthor_heap_pool *
39 panthor_vm_get_heap_pool(struct panthor_vm *vm, bool create);
40 
41 void panthor_vm_heaps_sizes(struct panthor_file *pfile, struct drm_memory_stats *stats);
42 
43 struct panthor_vm *panthor_vm_get(struct panthor_vm *vm);
44 void panthor_vm_put(struct panthor_vm *vm);
45 struct panthor_vm *panthor_vm_create(struct panthor_device *ptdev, bool for_mcu,
46 				     u64 kernel_va_start, u64 kernel_va_size,
47 				     u64 kernel_auto_va_start,
48 				     u64 kernel_auto_va_size);
49 
50 int panthor_vm_prepare_mapped_bos_resvs(struct drm_exec *exec,
51 					struct panthor_vm *vm,
52 					u32 slot_count);
53 int panthor_vm_add_bos_resvs_deps_to_job(struct panthor_vm *vm,
54 					 struct drm_sched_job *job);
55 void panthor_vm_add_job_fence_to_bos_resvs(struct panthor_vm *vm,
56 					   struct drm_sched_job *job);
57 
58 struct dma_resv *panthor_vm_resv(struct panthor_vm *vm);
59 struct drm_gem_object *panthor_vm_root_gem(struct panthor_vm *vm);
60 
61 void panthor_vm_pool_destroy(struct panthor_file *pfile);
62 int panthor_vm_pool_create(struct panthor_file *pfile);
63 int panthor_vm_pool_create_vm(struct panthor_device *ptdev,
64 			      struct panthor_vm_pool *pool,
65 			      struct drm_panthor_vm_create *args);
66 int panthor_vm_pool_destroy_vm(struct panthor_vm_pool *pool, u32 handle);
67 struct panthor_vm *panthor_vm_pool_get_vm(struct panthor_vm_pool *pool, u32 handle);
68 
69 bool panthor_vm_has_unhandled_faults(struct panthor_vm *vm);
70 bool panthor_vm_is_unusable(struct panthor_vm *vm);
71 
72 /*
73  * PANTHOR_VM_KERNEL_AUTO_VA: Use this magic address when you want the GEM
74  * logic to auto-allocate the virtual address in the reserved kernel VA range.
75  */
76 #define PANTHOR_VM_KERNEL_AUTO_VA		~0ull
77 
78 int panthor_vm_alloc_va(struct panthor_vm *vm, u64 va, u64 size,
79 			struct drm_mm_node *va_node);
80 void panthor_vm_free_va(struct panthor_vm *vm, struct drm_mm_node *va_node);
81 
82 int panthor_vm_bind_exec_sync_op(struct drm_file *file,
83 				 struct panthor_vm *vm,
84 				 struct drm_panthor_vm_bind_op *op);
85 
86 struct drm_sched_job *
87 panthor_vm_bind_job_create(struct drm_file *file,
88 			   struct panthor_vm *vm,
89 			   const struct drm_panthor_vm_bind_op *op);
90 void panthor_vm_bind_job_put(struct drm_sched_job *job);
91 int panthor_vm_bind_job_prepare_resvs(struct drm_exec *exec,
92 				      struct drm_sched_job *job);
93 void panthor_vm_bind_job_update_resvs(struct drm_exec *exec, struct drm_sched_job *job);
94 
95 void panthor_vm_update_resvs(struct panthor_vm *vm, struct drm_exec *exec,
96 			     struct dma_fence *fence,
97 			     enum dma_resv_usage private_usage,
98 			     enum dma_resv_usage extobj_usage);
99 
100 int panthor_mmu_pt_cache_init(void);
101 void panthor_mmu_pt_cache_fini(void);
102 
103 #ifdef CONFIG_DEBUG_FS
104 void panthor_mmu_debugfs_init(struct drm_minor *minor);
105 #endif
106 
107 #endif
108