Debian Codegraph @

src/imagination/vulkan/winsys/pvrsrvkm/pvr_srv_bo.h

raw
1 /*
2 * Copyright © 2022 Imagination Technologies Ltd.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24 #ifndef PVR_SRV_BO_H
25 #define PVR_SRV_BO_H
26
27 #include <stdint.h>
28
29 #include "pvr_srv.h"
30 #include "pvr_types.h"
31 #include "pvr_winsys.h"
32 #include "util/macros.h"
33
34 /*******************************************
35 MemAlloc flags
36 *******************************************/
37
38 /* TODO: remove unused and redundant flags */
39 #define PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_OFFSET 26U
40 #define PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK \
41 (0x3ULL << PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_OFFSET)
42 #define PVR_SRV_MEMALLOCFLAG_CPU_CACHE_CLEAN BITFIELD_BIT(19U)
43 #define PVR_SRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE BITFIELD_BIT(14U)
44 #define PVR_SRV_MEMALLOCFLAG_ZERO_ON_ALLOC BITFIELD_BIT(31U)
45 #define PVR_SRV_MEMALLOCFLAG_SVM_ALLOC BITFIELD_BIT(17U)
46 #define PVR_SRV_MEMALLOCFLAG_POISON_ON_ALLOC BITFIELD_BIT(30U)
47 #define PVR_SRV_MEMALLOCFLAG_POISON_ON_FREE BITFIELD_BIT(29U)
48 #define PVR_SRV_MEMALLOCFLAG_GPU_READABLE BITFIELD_BIT(0U)
49 #define PVR_SRV_MEMALLOCFLAG_GPU_WRITEABLE BITFIELD_BIT(1U)
50 #define PVR_SRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK (7ULL << 8U)
51 #define PVR_SRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK \
52 (PVR_SRV_MEMALLOCFLAG_GPU_READABLE | PVR_SRV_MEMALLOCFLAG_GPU_WRITEABLE | \
53 PVR_SRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK)
54 #define PVR_SRV_MEMALLOCFLAG_CPU_READABLE BITFIELD_BIT(4U)
55 #define PVR_SRV_MEMALLOCFLAG_CPU_WRITEABLE BITFIELD_BIT(5U)
56 #define PVR_SRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK (7ULL << 11U)
57 #define PVR_SRV_MEMALLOCFLAG_CPU_CACHE_INCOHERENT (3ULL << 11U)
58 #define PVR_SRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK \
59 (PVR_SRV_MEMALLOCFLAG_CPU_READABLE | PVR_SRV_MEMALLOCFLAG_CPU_WRITEABLE | \
60 PVR_SRV_MEMALLOCFLAG_CPU_CACHE_MODE_MASK)
61 #define PVR_SRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC BITFIELD_BIT(15U)
62 #define PVR_SRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING BITFIELD_BIT(18U)
63 #define PVR_SRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING BITFIELD_BIT(20U)
64 #define PVR_SRV_MEMALLOCFLAG_FW_ALLOC_OSID_MASK (7ULL << 23U)
65 #define PVR_SRV_MEMALLOCFLAG_VAL_SECURE_BUFFER BITFIELD64_BIT(34U)
66 #define PVR_SRV_MEMALLOCFLAG_VAL_SHARED_BUFFER BITFIELD64_BIT(35U)
67 #define PVR_SRV_PHYS_HEAP_HINT_SHIFT (60U)
68 #define PVR_SRV_PHYS_HEAP_HINT_MASK (0xFULL << PVR_SRV_PHYS_HEAP_HINT_SHIFT)
69 #define PVR_SRV_MEMALLOCFLAG_GPU_UNCACHED BITFIELD_BIT(8U)
70 #define PVR_SRV_MEMALLOCFLAG_GPU_CACHE_INCOHERENT (3ULL << 8U)
71 #define PVR_SRV_MEMALLOCFLAG_CPU_UNCACHED_WC (0ULL << 11U)
72 #define PVR_SRV_MEMALLOCFLAG_GPU_READ_PERMITTED BITFIELD_BIT(2U)
73 #define PVR_SRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED BITFIELD_BIT(3U)
74 #define PVR_SRV_MEMALLOCFLAG_CPU_READ_PERMITTED BITFIELD_BIT(6U)
75 #define PVR_SRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED BITFIELD_BIT(7U)
76
77 #define PVR_SRV_MEMALLOCFLAGS_PMRFLAGSMASK \
78 (PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK | \
79 PVR_SRV_MEMALLOCFLAG_CPU_CACHE_CLEAN | \
80 PVR_SRV_MEMALLOCFLAG_KERNEL_CPU_MAPPABLE | \
81 PVR_SRV_MEMALLOCFLAG_ZERO_ON_ALLOC | PVR_SRV_MEMALLOCFLAG_SVM_ALLOC | \
82 PVR_SRV_MEMALLOCFLAG_POISON_ON_ALLOC | \
83 PVR_SRV_MEMALLOCFLAG_POISON_ON_FREE | \
84 PVR_SRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK | \
85 PVR_SRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK | \
86 PVR_SRV_MEMALLOCFLAG_NO_OSPAGES_ON_ALLOC | \
87 PVR_SRV_MEMALLOCFLAG_SPARSE_NO_DUMMY_BACKING | \
88 PVR_SRV_MEMALLOCFLAG_SPARSE_ZERO_BACKING | \
89 PVR_SRV_MEMALLOCFLAG_FW_ALLOC_OSID_MASK | \
90 PVR_SRV_MEMALLOCFLAG_VAL_SECURE_BUFFER | \
91 PVR_SRV_MEMALLOCFLAG_VAL_SHARED_BUFFER | PVR_SRV_PHYS_HEAP_HINT_MASK)
92
93 #define PVR_SRV_MEMALLOCFLAGS_PHYSICAL_MASK \
94 (PVR_SRV_MEMALLOCFLAGS_CPU_MMUFLAGSMASK | \
95 PVR_SRV_MEMALLOCFLAG_GPU_CACHE_MODE_MASK | \
96 PVR_SRV_MEMALLOCFLAG_CPU_READ_PERMITTED | \
97 PVR_SRV_MEMALLOCFLAG_CPU_WRITE_PERMITTED | \
98 PVR_SRV_MEMALLOCFLAG_CPU_CACHE_CLEAN | \
99 PVR_SRV_MEMALLOCFLAG_ZERO_ON_ALLOC | \
100 PVR_SRV_MEMALLOCFLAG_POISON_ON_ALLOC | \
101 PVR_SRV_MEMALLOCFLAG_POISON_ON_FREE | PVR_SRV_PHYS_HEAP_HINT_MASK)
102
103 #define PVR_SRV_MEMALLOCFLAGS_VIRTUAL_MASK \
104 (PVR_SRV_MEMALLOCFLAGS_GPU_MMUFLAGSMASK | \
105 PVR_SRV_MEMALLOCFLAG_GPU_READ_PERMITTED | \
106 PVR_SRV_MEMALLOCFLAG_GPU_WRITE_PERMITTED)
107
108 /* Device specific MMU flags. */
109 /*!< Memory that only the PM and Firmware can access */
110 #define PM_FW_PROTECT BITFIELD_BIT(0U)
111
112 /* Helper macro for setting device specific MMU flags. */
113 #define PVR_SRV_MEMALLOCFLAG_DEVICE_FLAG(n) \
114 (((n) << PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_OFFSET) & \
115 PVR_SRV_MEMALLOCFLAG_DEVICE_FLAGS_MASK)
116
117 /*******************************************
118 struct definitions
119 *******************************************/
120
121 struct pvr_srv_winsys_bo {
122 struct pvr_winsys_bo base;
123 uint32_t ref_count;
124 void *pmr;
125
126 bool is_display_buffer;
127 uint32_t handle;
128 uint64_t flags;
129 };
130
131 struct pvr_srv_winsys_vma {
132 struct pvr_winsys_vma base;
133 void *reservation;
134
135 /* Required when mapping whole PMR, used for display buffers mapping. */
136 void *mapping;
137 };
138
139 /*******************************************
140 function prototypes
141 *******************************************/
142
143 VkResult pvr_srv_winsys_buffer_create(struct pvr_winsys *ws,
144 uint64_t size,
145 uint64_t alignment,
146 enum pvr_winsys_bo_type type,
147 uint32_t ws_flags,
148 struct pvr_winsys_bo **const bo_out);
149 VkResult
150 pvr_srv_winsys_buffer_create_from_fd(struct pvr_winsys *ws,
151 int fd,
152 struct pvr_winsys_bo **const bo_out);
153 void pvr_srv_winsys_buffer_destroy(struct pvr_winsys_bo *bo);
154
155 VkResult pvr_srv_winsys_buffer_get_fd(struct pvr_winsys_bo *bo,
156 int *const fd_out);
157
158 VkResult pvr_srv_winsys_buffer_map(struct pvr_winsys_bo *bo, void *addr);
159 VkResult pvr_srv_winsys_buffer_unmap(struct pvr_winsys_bo *bo, bool reserve);
160
161 VkResult pvr_srv_heap_alloc_carveout(struct pvr_winsys_heap *heap,
162 const pvr_dev_addr_t carveout_dev_addr,
163 uint64_t size,
164 uint64_t alignment,
165 struct pvr_winsys_vma **vma_out);
166 VkResult pvr_srv_winsys_heap_alloc(struct pvr_winsys_heap *heap,
167 uint64_t size,
168 uint64_t alignment,
169 struct pvr_winsys_vma **vma_out);
170 void pvr_srv_winsys_heap_free(struct pvr_winsys_vma *vma);
171
172 VkResult pvr_srv_winsys_vma_map(struct pvr_winsys_vma *vma,
173 struct pvr_winsys_bo *bo,
174 uint64_t offset,
175 uint64_t size,
176 pvr_dev_addr_t *dev_addr_out);
177 void pvr_srv_winsys_vma_unmap(struct pvr_winsys_vma *vma);
178
179 /*******************************************
180 helper macros
181 *******************************************/
182
183 #define to_pvr_srv_winsys_bo(bo) \
184 container_of((bo), struct pvr_srv_winsys_bo, base)
185 #define to_pvr_srv_winsys_vma(vma) \
186 container_of((vma), struct pvr_srv_winsys_vma, base)
187
188 #endif /* PVR_SRV_BO_H */