turnip: semaphore support.
[mesa.git] / include / drm-uapi / msm_drm.h
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 #define MSM_PARAM_GPU_ID 0x01
71 #define MSM_PARAM_GMEM_SIZE 0x02
72 #define MSM_PARAM_CHIP_ID 0x03
73 #define MSM_PARAM_MAX_FREQ 0x04
74 #define MSM_PARAM_TIMESTAMP 0x05
75 #define MSM_PARAM_GMEM_BASE 0x06
76 #define MSM_PARAM_NR_RINGS 0x07
77 #define MSM_PARAM_PP_PGTABLE 0x08 /* => 1 for per-process pagetables, else 0 */
78 #define MSM_PARAM_FAULTS 0x09
79
80 struct drm_msm_param {
81 __u32 pipe; /* in, MSM_PIPE_x */
82 __u32 param; /* in, MSM_PARAM_x */
83 __u64 value; /* out (get_param) or in (set_param) */
84 };
85
86 /*
87 * GEM buffers:
88 */
89
90 #define MSM_BO_SCANOUT 0x00000001 /* scanout capable */
91 #define MSM_BO_GPU_READONLY 0x00000002
92 #define MSM_BO_CACHE_MASK 0x000f0000
93 /* cache modes */
94 #define MSM_BO_CACHED 0x00010000
95 #define MSM_BO_WC 0x00020000
96 #define MSM_BO_UNCACHED 0x00040000
97
98 #define MSM_BO_FLAGS (MSM_BO_SCANOUT | \
99 MSM_BO_GPU_READONLY | \
100 MSM_BO_CACHED | \
101 MSM_BO_WC | \
102 MSM_BO_UNCACHED)
103
104 struct drm_msm_gem_new {
105 __u64 size; /* in */
106 __u32 flags; /* in, mask of MSM_BO_x */
107 __u32 handle; /* out */
108 };
109
110 /* Get or set GEM buffer info. The requested value can be passed
111 * directly in 'value', or for data larger than 64b 'value' is a
112 * pointer to userspace buffer, with 'len' specifying the number of
113 * bytes copied into that buffer. For info returned by pointer,
114 * calling the GEM_INFO ioctl with null 'value' will return the
115 * required buffer size in 'len'
116 */
117 #define MSM_INFO_GET_OFFSET 0x00 /* get mmap() offset, returned by value */
118 #define MSM_INFO_GET_IOVA 0x01 /* get iova, returned by value */
119 #define MSM_INFO_SET_NAME 0x02 /* set the debug name (by pointer) */
120 #define MSM_INFO_GET_NAME 0x03 /* get debug name, returned by pointer */
121
122 struct drm_msm_gem_info {
123 __u32 handle; /* in */
124 __u32 info; /* in - one of MSM_INFO_* */
125 __u64 value; /* in or out */
126 __u32 len; /* in or out */
127 __u32 pad;
128 };
129
130 #define MSM_PREP_READ 0x01
131 #define MSM_PREP_WRITE 0x02
132 #define MSM_PREP_NOSYNC 0x04
133
134 #define MSM_PREP_FLAGS (MSM_PREP_READ | MSM_PREP_WRITE | MSM_PREP_NOSYNC)
135
136 struct drm_msm_gem_cpu_prep {
137 __u32 handle; /* in */
138 __u32 op; /* in, mask of MSM_PREP_x */
139 struct drm_msm_timespec timeout; /* in */
140 };
141
142 struct drm_msm_gem_cpu_fini {
143 __u32 handle; /* in */
144 };
145
146 /*
147 * Cmdstream Submission:
148 */
149
150 /* The value written into the cmdstream is logically:
151 *
152 * ((relocbuf->gpuaddr + reloc_offset) << shift) | or
153 *
154 * When we have GPU's w/ >32bit ptrs, it should be possible to deal
155 * with this by emit'ing two reloc entries with appropriate shift
156 * values. Or a new MSM_SUBMIT_CMD_x type would also be an option.
157 *
158 * NOTE that reloc's must be sorted by order of increasing submit_offset,
159 * otherwise EINVAL.
160 */
161 struct drm_msm_gem_submit_reloc {
162 __u32 submit_offset; /* in, offset from submit_bo */
163 __u32 or; /* in, value OR'd with result */
164 __s32 shift; /* in, amount of left shift (can be negative) */
165 __u32 reloc_idx; /* in, index of reloc_bo buffer */
166 __u64 reloc_offset; /* in, offset from start of reloc_bo */
167 };
168
169 /* submit-types:
170 * BUF - this cmd buffer is executed normally.
171 * IB_TARGET_BUF - this cmd buffer is an IB target. Reloc's are
172 * processed normally, but the kernel does not setup an IB to
173 * this buffer in the first-level ringbuffer
174 * CTX_RESTORE_BUF - only executed if there has been a GPU context
175 * switch since the last SUBMIT ioctl
176 */
177 #define MSM_SUBMIT_CMD_BUF 0x0001
178 #define MSM_SUBMIT_CMD_IB_TARGET_BUF 0x0002
179 #define MSM_SUBMIT_CMD_CTX_RESTORE_BUF 0x0003
180 struct drm_msm_gem_submit_cmd {
181 __u32 type; /* in, one of MSM_SUBMIT_CMD_x */
182 __u32 submit_idx; /* in, index of submit_bo cmdstream buffer */
183 __u32 submit_offset; /* in, offset into submit_bo */
184 __u32 size; /* in, cmdstream size */
185 __u32 pad;
186 __u32 nr_relocs; /* in, number of submit_reloc's */
187 __u64 relocs; /* in, ptr to array of submit_reloc's */
188 };
189
190 /* Each buffer referenced elsewhere in the cmdstream submit (ie. the
191 * cmdstream buffer(s) themselves or reloc entries) has one (and only
192 * one) entry in the submit->bos[] table.
193 *
194 * As a optimization, the current buffer (gpu virtual address) can be
195 * passed back through the 'presumed' field. If on a subsequent reloc,
196 * userspace passes back a 'presumed' address that is still valid,
197 * then patching the cmdstream for this entry is skipped. This can
198 * avoid kernel needing to map/access the cmdstream bo in the common
199 * case.
200 */
201 #define MSM_SUBMIT_BO_READ 0x0001
202 #define MSM_SUBMIT_BO_WRITE 0x0002
203 #define MSM_SUBMIT_BO_DUMP 0x0004
204
205 #define MSM_SUBMIT_BO_FLAGS (MSM_SUBMIT_BO_READ | \
206 MSM_SUBMIT_BO_WRITE | \
207 MSM_SUBMIT_BO_DUMP)
208
209 struct drm_msm_gem_submit_bo {
210 __u32 flags; /* in, mask of MSM_SUBMIT_BO_x */
211 __u32 handle; /* in, GEM handle */
212 __u64 presumed; /* in/out, presumed buffer address */
213 };
214
215 /* Valid submit ioctl flags: */
216 #define MSM_SUBMIT_NO_IMPLICIT 0x80000000 /* disable implicit sync */
217 #define MSM_SUBMIT_FENCE_FD_IN 0x40000000 /* enable input fence_fd */
218 #define MSM_SUBMIT_FENCE_FD_OUT 0x20000000 /* enable output fence_fd */
219 #define MSM_SUBMIT_SUDO 0x10000000 /* run submitted cmds from RB */
220 #define MSM_SUBMIT_SYNCOBJ_IN 0x08000000 /* enable input syncobj */
221 #define MSM_SUBMIT_SYNCOBJ_OUT 0x04000000 /* enable output syncobj */
222 #define MSM_SUBMIT_FLAGS ( \
223 MSM_SUBMIT_NO_IMPLICIT | \
224 MSM_SUBMIT_FENCE_FD_IN | \
225 MSM_SUBMIT_FENCE_FD_OUT | \
226 MSM_SUBMIT_SUDO | \
227 MSM_SUBMIT_SYNCOBJ_IN | \
228 MSM_SUBMIT_SYNCOBJ_OUT | \
229 0)
230
231 #define MSM_SUBMIT_SYNCOBJ_RESET 0x00000001 /* Reset syncobj after wait. */
232 #define MSM_SUBMIT_SYNCOBJ_FLAGS ( \
233 MSM_SUBMIT_SYNCOBJ_RESET | \
234 0)
235
236 struct drm_msm_gem_submit_syncobj {
237 __u32 handle; /* in, syncobj handle. */
238 __u32 flags; /* in, from MSM_SUBMIT_SYNCOBJ_FLAGS */
239 __u64 point; /* in, timepoint for timeline syncobjs. */
240 };
241
242 /* Each cmdstream submit consists of a table of buffers involved, and
243 * one or more cmdstream buffers. This allows for conditional execution
244 * (context-restore), and IB buffers needed for per tile/bin draw cmds.
245 */
246 struct drm_msm_gem_submit {
247 __u32 flags; /* MSM_PIPE_x | MSM_SUBMIT_x */
248 __u32 fence; /* out */
249 __u32 nr_bos; /* in, number of submit_bo's */
250 __u32 nr_cmds; /* in, number of submit_cmd's */
251 __u64 bos; /* in, ptr to array of submit_bo's */
252 __u64 cmds; /* in, ptr to array of submit_cmd's */
253 __s32 fence_fd; /* in/out fence fd (see MSM_SUBMIT_FENCE_FD_IN/OUT) */
254 __u32 queueid; /* in, submitqueue id */
255 __u64 in_syncobjs; /* in, ptr to to array of drm_msm_gem_submit_syncobj */
256 __u64 out_syncobjs; /* in, ptr to to array of drm_msm_gem_submit_syncobj */
257 __u32 nr_in_syncobjs; /* in, number of entries in in_syncobj */
258 __u32 nr_out_syncobjs; /* in, number of entries in out_syncobj. */
259 __u32 syncobj_stride; /* in, stride of syncobj arrays. */
260 __u32 pad; /*in, reserved for future use, always 0. */
261
262 };
263
264 /* The normal way to synchronize with the GPU is just to CPU_PREP on
265 * a buffer if you need to access it from the CPU (other cmdstream
266 * submission from same or other contexts, PAGE_FLIP ioctl, etc, all
267 * handle the required synchronization under the hood). This ioctl
268 * mainly just exists as a way to implement the gallium pipe_fence
269 * APIs without requiring a dummy bo to synchronize on.
270 */
271 struct drm_msm_wait_fence {
272 __u32 fence; /* in */
273 __u32 pad;
274 struct drm_msm_timespec timeout; /* in */
275 __u32 queueid; /* in, submitqueue id */
276 };
277
278 /* madvise provides a way to tell the kernel in case a buffers contents
279 * can be discarded under memory pressure, which is useful for userspace
280 * bo cache where we want to optimistically hold on to buffer allocate
281 * and potential mmap, but allow the pages to be discarded under memory
282 * pressure.
283 *
284 * Typical usage would involve madvise(DONTNEED) when buffer enters BO
285 * cache, and madvise(WILLNEED) if trying to recycle buffer from BO cache.
286 * In the WILLNEED case, 'retained' indicates to userspace whether the
287 * backing pages still exist.
288 */
289 #define MSM_MADV_WILLNEED 0 /* backing pages are needed, status returned in 'retained' */
290 #define MSM_MADV_DONTNEED 1 /* backing pages not needed */
291 #define __MSM_MADV_PURGED 2 /* internal state */
292
293 struct drm_msm_gem_madvise {
294 __u32 handle; /* in, GEM handle */
295 __u32 madv; /* in, MSM_MADV_x */
296 __u32 retained; /* out, whether backing store still exists */
297 };
298
299 /*
300 * Draw queues allow the user to set specific submission parameter. Command
301 * submissions specify a specific submitqueue to use. ID 0 is reserved for
302 * backwards compatibility as a "default" submitqueue
303 */
304
305 #define MSM_SUBMITQUEUE_FLAGS (0)
306
307 struct drm_msm_submitqueue {
308 __u32 flags; /* in, MSM_SUBMITQUEUE_x */
309 __u32 prio; /* in, Priority level */
310 __u32 id; /* out, identifier */
311 };
312
313 #define MSM_SUBMITQUEUE_PARAM_FAULTS 0
314
315 struct drm_msm_submitqueue_query {
316 __u64 data;
317 __u32 id;
318 __u32 param;
319 __u32 len;
320 __u32 pad;
321 };
322
323 #define DRM_MSM_GET_PARAM 0x00
324 /* placeholder:
325 #define DRM_MSM_SET_PARAM 0x01
326 */
327 #define DRM_MSM_GEM_NEW 0x02
328 #define DRM_MSM_GEM_INFO 0x03
329 #define DRM_MSM_GEM_CPU_PREP 0x04
330 #define DRM_MSM_GEM_CPU_FINI 0x05
331 #define DRM_MSM_GEM_SUBMIT 0x06
332 #define DRM_MSM_WAIT_FENCE 0x07
333 #define DRM_MSM_GEM_MADVISE 0x08
334 /* placeholder:
335 #define DRM_MSM_GEM_SVM_NEW 0x09
336 */
337 #define DRM_MSM_SUBMITQUEUE_NEW 0x0A
338 #define DRM_MSM_SUBMITQUEUE_CLOSE 0x0B
339 #define DRM_MSM_SUBMITQUEUE_QUERY 0x0C
340
341 #define DRM_IOCTL_MSM_GET_PARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GET_PARAM, struct drm_msm_param)
342 #define DRM_IOCTL_MSM_GEM_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_NEW, struct drm_msm_gem_new)
343 #define DRM_IOCTL_MSM_GEM_INFO DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_INFO, struct drm_msm_gem_info)
344 #define DRM_IOCTL_MSM_GEM_CPU_PREP DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_PREP, struct drm_msm_gem_cpu_prep)
345 #define DRM_IOCTL_MSM_GEM_CPU_FINI DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_GEM_CPU_FINI, struct drm_msm_gem_cpu_fini)
346 #define DRM_IOCTL_MSM_GEM_SUBMIT DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_SUBMIT, struct drm_msm_gem_submit)
347 #define DRM_IOCTL_MSM_WAIT_FENCE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_WAIT_FENCE, struct drm_msm_wait_fence)
348 #define DRM_IOCTL_MSM_GEM_MADVISE DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_GEM_MADVISE, struct drm_msm_gem_madvise)
349 #define DRM_IOCTL_MSM_SUBMITQUEUE_NEW DRM_IOWR(DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_NEW, struct drm_msm_submitqueue)
350 #define DRM_IOCTL_MSM_SUBMITQUEUE_CLOSE DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_CLOSE, __u32)
351 #define DRM_IOCTL_MSM_SUBMITQUEUE_QUERY DRM_IOW (DRM_COMMAND_BASE + DRM_MSM_SUBMITQUEUE_QUERY, struct drm_msm_submitqueue_query)
352
353 #if defined(__cplusplus)
354 }
355 #endif
356
357 #endif /* __MSM_DRM_H__ */