1 /*
2 * Copyright (C) 2013 Red Hat
3 * Author: Rob Clark <robdclark@gmail.com>
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * 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 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25 #ifndef __MSM_DRM_H__
26 #define __MSM_DRM_H__
27
28 #include "drm.h"
29
30 #if defined(__cplusplus)
31 extern "C" {
32 #endif
33
34 /* Please note that modifications to all structs defined here are
35 * subject to backwards-compatibility constraints:
36 * 1) Do not use pointers, use __u64 instead for 32 bit / 64 bit
37 * user/kernel compatibility
38 * 2) Keep fields aligned to their size
39 * 3) Because of how drm_ioctl() works, we can add new fields at
40 * the end of an ioctl if some care is taken: drm_ioctl() will
41 * zero out the new fields at the tail of the ioctl, so a zero
42 * value should have a backwards compatible meaning. And for
43 * output params, userspace won't see the newly added output
44 * fields.. so that has to be somehow ok.
45 */
46
47 #define MSM_PIPE_NONE 0x00
48 #define MSM_PIPE_2D0 0x01
49 #define MSM_PIPE_2D1 0x02
50 #define MSM_PIPE_3D0 0x10
51
52 /* The pipe-id just uses the lower bits, so can be OR'd with flags in
53 * the upper 16 bits (which could be extended further, if needed, maybe
54 * we extend/overload the pipe-id some day to deal with multiple rings,
55 * but even then I don't think we need the full lower 16 bits).
56 */
57 #define MSM_PIPE_ID_MASK 0xffff
58 #define MSM_PIPE_ID(x) ((x) & MSM_PIPE_ID_MASK)
59 #define MSM_PIPE_FLAGS(x) ((x) & ~MSM_PIPE_ID_MASK)
60
61 /* timeouts are specified in clock-monotonic absolute times (to simplify
62 * restarting interrupted ioctls). The following struct is logically the
63 * same as 'struct timespec' but 32/64b ABI safe.
64 */
65 struct drm_msm_timespec {
66 __s64 tv_sec; /* seconds */
67 __s64 tv_nsec; /* nanoseconds */
68 };
69
70 /* Below "RO" indicates a read-only param, "WO" indicates write-only, and
71 * "RW" indicates a param that can be both read (GET_PARAM) and written
72 * (SET_PARAM)
73 */
74 #define MSM_PARAM_GPU_ID 0x01 /* RO */
75 #define MSM_PARAM_GMEM_SIZE 0x02 /* RO */
76 #define MSM_PARAM_CHIP_ID 0x03 /* RO */
77 #define MSM_PARAM_MAX_FREQ 0x04 /* RO */
78 #define MSM_PARAM_TIMESTAMP 0x05 /* RO */
79 #define MSM_PARAM_GMEM_BASE 0x06 /* RO */
80 #define MSM_PARAM_PRIORITIES 0x07 /* RO: The # of priority levels */
81 #define MSM_PARAM_PP_PGTABLE 0x08 /* RO: Deprecated, always returns zero */
82 #define MSM_PARAM_FAULTS 0x09 /* RO */
83 #define MSM_PARAM_SUSPENDS 0x0a /* RO */
84 #define MSM_PARAM_SYSPROF 0x0b /* WO: 1 preserves perfcntrs, 2 also disables suspend */
85 #define MSM_PARAM_COMM 0x0c /* WO: override for task->comm */
86 #define MSM_PARAM_CMDLINE 0x0d /* WO: override for task cmdline */
87 #define MSM_PARAM_VA_START 0x0e /* RO: start of valid GPU iova range */
88 #define MSM_PARAM_VA_SIZE 0x0f /* RO: size of valid GPU iova range (bytes) */
89 #define MSM_PARAM_HIGHEST_BANK_BIT 0x10 /* RO */
90 #define MSM_PARAM_RAYTRACING 0x11 /* RO */
91
92 /* For backwards compat. The original support for preemption was based on
93 * a single ring per priority level so # of priority levels equals the #
94 * of rings. With drm/scheduler providing additional levels of priority,
95 * the number of priorities is greater than the # of rings. The param is
96 * renamed to better reflect this.
97 */
98 #define MSM_PARAM_NR_RINGS MSM_PARAM_PRIORITIES
99
100 struct drm_msm_param {
101 __u32 pipe; /* in, MSM_PIPE_x */
102 __u32 param; /* in, MSM_PARAM_x */
103 __u64 value; /* out (get_param) or in (set_param) */
104 __u32 len; /* zero for non-pointer params */
105 __u32 pad; /* must be zero */
106 };
107
108 /*
109 * GEM buffers:
110 */
111
112 #define MSM_BO_SCANOUT 0x00000001 /* scanout capable */
113 #define MSM_BO_GPU_READONLY 0x00000002
114 #define MSM_BO_CACHE_MASK 0x000f0000
115 /* cache modes */
116 #define MSM_BO_CACHED 0x00010000
117 #define MSM_BO_WC 0x00020000
118 #define MSM_BO_UNCACHED 0x00040000 /* deprecated, use MSM_BO_WC */
119 #define MSM_BO_CACHED_COHERENT 0x080000
120
121 #define MSM_BO_FLAGS (MSM_BO_SCANOUT | \
122 MSM_BO_GPU_READONLY | \
123 MSM_BO_CACHE_MASK)
124
125 struct drm_msm_gem_new {
126 __u64 size; /* in */
127 __u32 flags; /* in, mask of MSM_BO_x */
128 __u32 handle; /* out */
129 };
130
131 /* Get or set GEM buffer info. The requested value can be passed
132 * directly in 'value', or for data larger than 64b 'value' is a
133 * pointer to userspace buffer, with 'len' specifying the number of
134 * bytes copied into that buffer. For info returned by pointer,
135 * calling the GEM_INFO ioctl with null 'value' will return the
136 * required buffer size in 'len'
137 */
138 #define MSM_INFO_GET_OFFSET 0x00 /* get mmap() offset, returned by value */
139 #define MSM_INFO_GET_IOVA 0x01 /* get iova, returned by value */
140 #define MSM_INFO_SET_NAME 0x02 /* set the debug name (by pointer) */
141 #define MSM_INFO_GET_NAME 0x03 /* get debug name, returned by pointer */
142 #define MSM_INFO_SET_IOVA 0x04 /* set the iova, passed by value */
143 #define MSM_INFO_GET_FLAGS 0x05 /* get the MSM_BO_x flags */
144 #define MSM_INFO_SET_METADATA 0x06 /* set userspace metadata */
145 #define MSM_INFO_GET_METADATA 0x07 /* get userspace metadata */
146
147 struct drm_msm_gem_info {
148 __u32 handle; /* in */
149 __u32 info; /* in - one of MSM_INFO_* */
150 __u64 value; /* in or out */
151 __u32 len; /* in or out */
152 __u32 pad;
153 };
154
155 #define MSM_PREP_READ 0x01
156 #define MSM_PREP_WRITE 0x02
157 #define MSM_PREP_NOSYNC 0x04
158 #define MSM_PREP_BOOST 0x08
159
160 #define MSM_PREP_FLAGS (MSM_PREP_READ | \
161 MSM_PREP_WRITE | \
162 MSM_PREP_NOSYNC | \
163 MSM_PREP_BOOST | \
164 0)
165
166 struct drm_msm_gem_cpu_prep {
167 __u32 handle; /* in */
168 __u32 op; /* in, mask of MSM_PREP_x */
169 struct drm_msm_timespec timeout; /* in */
170 };
171
172 struct drm_msm_gem_cpu_fini {
173 __u32 handle; /* in */
174 };
175
176 /*
177 * Cmdstream Submission:
178 */
179
180 /* The value written into the cmdstream is logically:
181 *
182 * ((relocbuf->gpuaddr + reloc_offset) << shift) | or
183 *
184 * When we have GPU's w/ >32bit ptrs, it should be possible to deal
185 * with this by emit'ing two reloc entries with appropriate shift
186 * values. Or a new MSM_SUBMIT_CMD_x type would also be an option.
187 *
188 * NOTE that reloc's must be sorted by order of increasing submit_offset,
189 * otherwise EINVAL.
190 */
191 struct drm_msm_gem_submit_reloc {
192 __u32 submit_offset; /* in, offset from submit_bo */
193 #ifdef __cplusplus
194 __u32 _or; /* in, value OR'd with result */
195 #else
196 __u32 or; /* in, value OR'd with result */
197 #endif
198 __s32 shift; /* in, amount of left shift (can be negative) */
199 __u32 reloc_idx; /* in, index of reloc_bo buffer */
200 __u64 reloc_offset; /* in, offset from start of reloc_bo */
201 };
202
203 /* submit-types:
204 * BUF - this cmd buffer is executed normally.
205 * IB_TARGET_BUF - this cmd buffer is an IB target. Reloc's are
206 * processed normally, but the kernel does not setup an IB to
207 * this buffer in the first-level ringbuffer
208 * CTX_RESTORE_BUF - only executed if there has been a GPU context
209 * switch since the last SUBMIT ioctl
210 */
211 #define MSM_SUBMIT_CMD_BUF 0x0001
212 #define MSM_SUBMIT_CMD_IB_TARGET_BUF 0x0002
213 #define MSM_SUBMIT_CMD_CTX_RESTORE_BUF 0x0003
214 struct drm_msm_gem_submit_cmd {
215 __u32 type; /* in, one of MSM_SUBMIT_CMD_x */
216 __u32 submit_idx; /* in, index of submit_bo cmdstream buffer */
217 __u32 submit_offset; /* in, offset into submit_bo */
218 __u32 size; /* in, cmdstream size */
219 __u32 pad;
220 __u32 nr_relocs; /* in, number of submit_reloc's */
221 __u64 relocs; /* in, ptr to array of submit_reloc's */
222 };
223
224 /* Each buffer referenced elsewhere in the cmdstream submit (ie. the
225 * cmdstream buffer(s) themselves or reloc entries) has one (and only
226 * one) entry in the submit->bos[] table.
227 *
228 * As a optimization, the current buffer (gpu virtual address) can be
229 * passed back through the 'presumed' field. If on a subsequent reloc,
230 * userspace passes back a 'presumed' address that is still valid,
231 * then patching the cmdstream for this entry is skipped. This can
232 * avoid kernel needing to map/access the cmdstream bo in the common
233 * case.
234 */
235 #define MSM_SUBMIT_BO_READ 0x0001
236 #define MSM_SUBMIT_BO_WRITE 0x0002
237 #define MSM_SUBMIT_BO_DUMP 0x0004
238 #define MSM_SUBMIT_BO_NO_IMPLICIT 0x0008
239
240 #define MSM_SUBMIT_BO_FLAGS (MSM_SUBMIT_BO_READ | \
241 MSM_SUBMIT_BO_WRITE | \
242 MSM_SUBMIT_BO_DUMP | \
243 MSM_SUBMIT_BO_NO_IMPLICIT)
244
245 struct drm_msm_gem_submit_bo {
246 __u32 flags; /* in, mask of MSM_SUBMIT_BO_x */
247 __u32 handle; /* in, GEM handle */
248 __u64 presumed; /* in/out, presumed buffer address */
249 };
250
251 /* Valid submit ioctl flags: */
252 #define MSM_SUBMIT_NO_IMPLICIT 0x80000000 /* disable implicit sync */
253 #define MSM_SUBMIT_FENCE_FD_IN 0x40000000 /* enable input fence_fd */
254 #define MSM_SUBMIT_FENCE_FD_OUT 0x20000000 /* enable output fence_fd */
255 #define MSM_SUBMIT_SUDO 0x10000000 /* run submitted cmds from RB */
256 #define MSM_SUBMIT_SYNCOBJ_IN 0x08000000 /* enable input syncobj */
257 #define MSM_SUBMIT_SYNCOBJ_OUT 0x04000000 /* enable output syncobj */
258 #define MSM_SUBMIT_FENCE_SN_IN 0x02000000 /* userspace passes in seqno fence */
259 #define MSM_SUBMIT_FLAGS ( \
260 MSM_SUBMIT_NO_IMPLICIT | \
261 MSM_SUBMIT_FENCE_FD_IN | \
262 MSM_SUBMIT_FENCE_FD_OUT | \
263 MSM_SUBMIT_SUDO | \
264 MSM_SUBMIT_SYNCOBJ_IN | \
265 MSM_SUBMIT_SYNCOBJ_OUT | \
266 MSM_SUBMIT_FENCE_SN_IN | \
267 0)
268
269 #define MSM_SUBMIT_SYNCOBJ_RESET 0x00000001 /* Reset syncobj after wait. */
270 #define MSM_SUBMIT_SYNCOBJ_FLAGS ( \
271 MSM_SUBMIT_SYNCOBJ_RESET | \
272 0)
273
274 struct drm_msm_gem_submit_syncobj {
275 __u32 handle; /* in, syncobj handle. */
276 __u32 flags; /* in, from MSM_SUBMIT_SYNCOBJ_FLAGS */
277 __u64 point; /* in, timepoint for timeline syncobjs. */
278 };
279
280 /* Each cmdstream submit consists of a table of buffers involved, and
281 * one or more cmdstream buffers. This allows for conditional execution
282 * (context-restore), and IB buffers needed for per tile/bin draw cmds.
283 */
284 struct drm_msm_gem_submit {
285 __u32 flags; /* MSM_PIPE_x | MSM_SUBMIT_x */
286 __u32 fence; /* out (or in with MSM_SUBMIT_FENCE_SN_IN flag) */
287 __u32 nr_bos; /* in, number of submit_bo's */
288 __u32 nr_cmds; /* in, number of submit_cmd's */
289 __u64 bos; /* in, ptr to array of submit_bo's */
290 __u64 cmds; /* in, ptr to array of submit_cmd's */
291 __s32 fence_fd; /* in/out fence fd (see MSM_SUBMIT_FENCE_FD_IN/OUT) */
292 __u32 queueid; /* in, submitqueue id */
293 __u64 in_syncobjs; /* in, ptr to array of drm_msm_gem_submit_syncobj */
294 __u64 out_syncobjs; /* in, ptr to array of drm_msm_gem_submit_syncobj */
295 __u32 nr_in_syncobjs; /* in, number of entries in in_syncobj */
296 __u32 nr_out_syncobjs; /* in, number of entries in out_syncobj. */
297 __u32 syncobj_stride; /* in, stride of syncobj arrays. */
298 __u32 pad; /*in, reserved for future use, always 0. */
299
300 };
301
302 #define MSM_WAIT_FENCE_BOOST 0x00000001
303 #define MSM_WAIT_FENCE_FLAGS ( \
304 MSM_WAIT_FENCE_BOOST | \
305 0)
306
307 /* The normal way to synchronize with the GPU is just to CPU_PREP on
308 * a buffer if you need to access it from the CPU (other cmdstream
309 * submission from same or other contexts, PAGE_FLIP ioctl, etc, all
310 * handle the required synchronization under the hood). This ioctl
311 * mainly just exists as a way to implement the gallium pipe_fence
312 * APIs without requiring a dummy bo to synchronize on.
313 */
314 struct drm_msm_wait_fence {
315 __u32 fence; /* in */
316 __u32 flags; /* in, bitmask of MSM_WAIT_FENCE_x */
317 struct drm_msm_timespec timeout; /* in */
318 __u32 queueid; /* in, submitqueue id */
319 };
320
321 /* madvise provides a way to tell the kernel in case a buffers contents
322 * can be discarded under memory pressure, which is useful for userspace
323 * bo cache where we want to optimistically hold on to buffer allocate
324 * and potential mmap, but allow the pages to be discarded under memory
325 * pressure.
326 *
327 * Typical usage would involve madvise(DONTNEED) when buffer enters BO
328 * cache, and madvise(WILLNEED) if trying to recycle buffer from BO cache.
329 * In the WILLNEED case, 'retained' indicates to userspace whether the
330 * backing pages still exist.
331 */
332 #define MSM_MADV_WILLNEED 0 /* backing pages are needed, status returned in 'retained' */
333 #define MSM_MADV_DONTNEED 1 /* backing pages not needed */
334 #define __MSM_MADV_PURGED 2 /* internal state */
335
336 struct drm_msm_gem_madvise {
337 __u32 handle; /* in, GEM handle */
338 __u32 madv; /* in, MSM_MADV_x */
339 __u32 retained; /* out, whether backing store still exists */
340 };
341
342 /*
343 * Draw queues allow the user to set specific submission parameter. Command
344 * submissions specify a specific submitqueue to use. ID 0 is reserved for
345 * backwards compatibility as a "default" submitqueue
346 */
347
348 #define MSM_SUBMITQUEUE_FLAGS (0)
349
350 /*
351 * The submitqueue priority should be between 0 and MSM_PARAM_PRIORITIES-1,
352 * a lower numeric value is higher priority.
353 */
354 struct drm_msm_submitqueue {
355 __u32 flags; /* in, MSM_SUBMITQUEUE_x */
356 __u32 prio; /* in, Priority level */
357 __u32 id; /* out, identifier */
358 };
359
360 #define MSM_SUBMITQUEUE_PARAM_FAULTS 0
361
362 struct drm_msm_submitqueue_query {
363 __u64 data;
364 __u32 id;
365 __u32 param;
366 __u32 len;
367 __u32 pad;
368 };
369
370 #define DRM_MSM_GET_PARAM 0x00
371 #define DRM_MSM_SET_PARAM 0x01
372 #define DRM_MSM_GEM_NEW 0x02
373 #define DRM_MSM_GEM_INFO 0x03
374 #define DRM_MSM_GEM_CPU_PREP 0x04
375 #define DRM_MSM_GEM_CPU_FINI 0x05
376 #define DRM_MSM_GEM_SUBMIT 0x06
377 #define DRM_MSM_WAIT_FENCE 0x07
378 #define DRM_MSM_GEM_MADVISE 0x08
379 /* placeholder:
380 #define DRM_MSM_GEM_SVM_NEW 0x09
381 */
382 #define DRM_MSM_SUBMITQUEUE_NEW 0x0A
383 #define DRM_MSM_SUBMITQUEUE_CLOSE 0x0B
384 #define DRM_MSM_SUBMITQUEUE_QUERY 0x0C
385
386 #define DRM_IOCTL_MSM_GET_PARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GET_PARAM, struct drm_msm_param)
387 #define DRM_IOCTL_MSM_SET_PARAM DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SET_PARAM, struct drm_msm_param)
388 #define DRM_IOCTL_MSM_GEM_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_NEW, struct drm_msm_gem_new)
389 #define DRM_IOCTL_MSM_GEM_INFO DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_INFO, struct drm_msm_gem_info)
390 #define DRM_IOCTL_MSM_GEM_CPU_PREP DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_PREP, struct drm_msm_gem_cpu_prep)
391 #define DRM_IOCTL_MSM_GEM_CPU_FINI DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_FINI, struct drm_msm_gem_cpu_fini)
392 #define DRM_IOCTL_MSM_GEM_SUBMIT DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_SUBMIT, struct drm_msm_gem_submit)
393 #define DRM_IOCTL_MSM_WAIT_FENCE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_WAIT_FENCE, struct drm_msm_wait_fence)
394 #define DRM_IOCTL_MSM_GEM_MADVISE DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_MADVISE, struct drm_msm_gem_madvise)
395 #define DRM_IOCTL_MSM_SUBMITQUEUE_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_NEW, struct drm_msm_submitqueue)
396 #define DRM_IOCTL_MSM_SUBMITQUEUE_CLOSE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_CLOSE, __u32)
397 #define DRM_IOCTL_MSM_SUBMITQUEUE_QUERY DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_QUERY, struct drm_msm_submitqueue_query)
398
399 #if defined(__cplusplus)
400 }
401 #endif
402
403 #endif /* __MSM_DRM_H__ */
404
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.