]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/uapi/drm/i915_drm.h
drm/i915: expose _SUBSLICE_MASK GETPARM
[mirror_ubuntu-bionic-kernel.git] / include / uapi / drm / i915_drm.h
CommitLineData
718dcedd
DH
1/*
2 * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
3 * All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
15 * of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
20 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
21 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 *
25 */
26
27#ifndef _UAPI_I915_DRM_H_
28#define _UAPI_I915_DRM_H_
29
1049102f 30#include "drm.h"
718dcedd 31
b1c1f5c4
EV
32#if defined(__cplusplus)
33extern "C" {
34#endif
35
718dcedd
DH
36/* Please note that modifications to all structs defined here are
37 * subject to backwards-compatibility constraints.
38 */
39
cce723ed
BW
40/**
41 * DOC: uevents generated by i915 on it's device node
42 *
43 * I915_L3_PARITY_UEVENT - Generated when the driver receives a parity mismatch
44 * event from the gpu l3 cache. Additional information supplied is ROW,
35a85ac6
BW
45 * BANK, SUBBANK, SLICE of the affected cacheline. Userspace should keep
46 * track of these events and if a specific cache-line seems to have a
47 * persistent error remap it with the l3 remapping tool supplied in
48 * intel-gpu-tools. The value supplied with the event is always 1.
cce723ed
BW
49 *
50 * I915_ERROR_UEVENT - Generated upon error detection, currently only via
51 * hangcheck. The error detection event is a good indicator of when things
52 * began to go badly. The value supplied with the event is a 1 upon error
53 * detection, and a 0 upon reset completion, signifying no more error
54 * exists. NOTE: Disabling hangcheck or reset via module parameter will
55 * cause the related events to not be seen.
56 *
57 * I915_RESET_UEVENT - Event is generated just before an attempt to reset the
58 * the GPU. The value supplied with the event is always 1. NOTE: Disable
59 * reset via module parameter will cause this event to not be seen.
60 */
61#define I915_L3_PARITY_UEVENT "L3_PARITY_ERROR"
62#define I915_ERROR_UEVENT "ERROR"
63#define I915_RESET_UEVENT "RESET"
718dcedd 64
3373ce2e
ID
65/*
66 * MOCS indexes used for GPU surfaces, defining the cacheability of the
67 * surface data and the coherency for this data wrt. CPU vs. GPU accesses.
68 */
69enum i915_mocs_table_index {
70 /*
71 * Not cached anywhere, coherency between CPU and GPU accesses is
72 * guaranteed.
73 */
74 I915_MOCS_UNCACHED,
75 /*
76 * Cacheability and coherency controlled by the kernel automatically
77 * based on the DRM_I915_GEM_SET_CACHING IOCTL setting and the current
78 * usage of the surface (used for display scanout or not).
79 */
80 I915_MOCS_PTE,
81 /*
82 * Cached in all GPU caches available on the platform.
83 * Coherency between CPU and GPU accesses to the surface is not
84 * guaranteed without extra synchronization.
85 */
86 I915_MOCS_CACHED,
87};
88
718dcedd
DH
89/* Each region is a minimum of 16k, and there are at most 255 of them.
90 */
91#define I915_NR_TEX_REGIONS 255 /* table size 2k - maximum due to use
92 * of chars for next/prev indices */
93#define I915_LOG_MIN_TEX_REGION_SIZE 14
94
95typedef struct _drm_i915_init {
96 enum {
97 I915_INIT_DMA = 0x01,
98 I915_CLEANUP_DMA = 0x02,
99 I915_RESUME_DMA = 0x03
100 } func;
101 unsigned int mmio_offset;
102 int sarea_priv_offset;
103 unsigned int ring_start;
104 unsigned int ring_end;
105 unsigned int ring_size;
106 unsigned int front_offset;
107 unsigned int back_offset;
108 unsigned int depth_offset;
109 unsigned int w;
110 unsigned int h;
111 unsigned int pitch;
112 unsigned int pitch_bits;
113 unsigned int back_pitch;
114 unsigned int depth_pitch;
115 unsigned int cpp;
116 unsigned int chipset;
117} drm_i915_init_t;
118
119typedef struct _drm_i915_sarea {
120 struct drm_tex_region texList[I915_NR_TEX_REGIONS + 1];
121 int last_upload; /* last time texture was uploaded */
122 int last_enqueue; /* last time a buffer was enqueued */
123 int last_dispatch; /* age of the most recently dispatched buffer */
124 int ctxOwner; /* last context to upload state */
125 int texAge;
126 int pf_enabled; /* is pageflipping allowed? */
127 int pf_active;
128 int pf_current_page; /* which buffer is being displayed? */
129 int perf_boxes; /* performance boxes to be displayed */
130 int width, height; /* screen size in pixels */
131
132 drm_handle_t front_handle;
133 int front_offset;
134 int front_size;
135
136 drm_handle_t back_handle;
137 int back_offset;
138 int back_size;
139
140 drm_handle_t depth_handle;
141 int depth_offset;
142 int depth_size;
143
144 drm_handle_t tex_handle;
145 int tex_offset;
146 int tex_size;
147 int log_tex_granularity;
148 int pitch;
149 int rotation; /* 0, 90, 180 or 270 */
150 int rotated_offset;
151 int rotated_size;
152 int rotated_pitch;
153 int virtualX, virtualY;
154
155 unsigned int front_tiled;
156 unsigned int back_tiled;
157 unsigned int depth_tiled;
158 unsigned int rotated_tiled;
159 unsigned int rotated2_tiled;
160
161 int pipeA_x;
162 int pipeA_y;
163 int pipeA_w;
164 int pipeA_h;
165 int pipeB_x;
166 int pipeB_y;
167 int pipeB_w;
168 int pipeB_h;
169
170 /* fill out some space for old userspace triple buffer */
171 drm_handle_t unused_handle;
172 __u32 unused1, unused2, unused3;
173
174 /* buffer object handles for static buffers. May change
175 * over the lifetime of the client.
176 */
177 __u32 front_bo_handle;
178 __u32 back_bo_handle;
179 __u32 unused_bo_handle;
180 __u32 depth_bo_handle;
181
182} drm_i915_sarea_t;
183
184/* due to userspace building against these headers we need some compat here */
185#define planeA_x pipeA_x
186#define planeA_y pipeA_y
187#define planeA_w pipeA_w
188#define planeA_h pipeA_h
189#define planeB_x pipeB_x
190#define planeB_y pipeB_y
191#define planeB_w pipeB_w
192#define planeB_h pipeB_h
193
194/* Flags for perf_boxes
195 */
196#define I915_BOX_RING_EMPTY 0x1
197#define I915_BOX_FLIP 0x2
198#define I915_BOX_WAIT 0x4
199#define I915_BOX_TEXTURE_LOAD 0x8
200#define I915_BOX_LOST_CONTEXT 0x10
201
21631f10
DL
202/*
203 * i915 specific ioctls.
204 *
205 * The device specific ioctl range is [DRM_COMMAND_BASE, DRM_COMMAND_END) ie
206 * [0x40, 0xa0) (a0 is excluded). The numbers below are defined as offset
207 * against DRM_COMMAND_BASE and should be between [0x0, 0x60).
718dcedd
DH
208 */
209#define DRM_I915_INIT 0x00
210#define DRM_I915_FLUSH 0x01
211#define DRM_I915_FLIP 0x02
212#define DRM_I915_BATCHBUFFER 0x03
213#define DRM_I915_IRQ_EMIT 0x04
214#define DRM_I915_IRQ_WAIT 0x05
215#define DRM_I915_GETPARAM 0x06
216#define DRM_I915_SETPARAM 0x07
217#define DRM_I915_ALLOC 0x08
218#define DRM_I915_FREE 0x09
219#define DRM_I915_INIT_HEAP 0x0a
220#define DRM_I915_CMDBUFFER 0x0b
221#define DRM_I915_DESTROY_HEAP 0x0c
222#define DRM_I915_SET_VBLANK_PIPE 0x0d
223#define DRM_I915_GET_VBLANK_PIPE 0x0e
224#define DRM_I915_VBLANK_SWAP 0x0f
225#define DRM_I915_HWS_ADDR 0x11
226#define DRM_I915_GEM_INIT 0x13
227#define DRM_I915_GEM_EXECBUFFER 0x14
228#define DRM_I915_GEM_PIN 0x15
229#define DRM_I915_GEM_UNPIN 0x16
230#define DRM_I915_GEM_BUSY 0x17
231#define DRM_I915_GEM_THROTTLE 0x18
232#define DRM_I915_GEM_ENTERVT 0x19
233#define DRM_I915_GEM_LEAVEVT 0x1a
234#define DRM_I915_GEM_CREATE 0x1b
235#define DRM_I915_GEM_PREAD 0x1c
236#define DRM_I915_GEM_PWRITE 0x1d
237#define DRM_I915_GEM_MMAP 0x1e
238#define DRM_I915_GEM_SET_DOMAIN 0x1f
239#define DRM_I915_GEM_SW_FINISH 0x20
240#define DRM_I915_GEM_SET_TILING 0x21
241#define DRM_I915_GEM_GET_TILING 0x22
242#define DRM_I915_GEM_GET_APERTURE 0x23
243#define DRM_I915_GEM_MMAP_GTT 0x24
244#define DRM_I915_GET_PIPE_FROM_CRTC_ID 0x25
245#define DRM_I915_GEM_MADVISE 0x26
246#define DRM_I915_OVERLAY_PUT_IMAGE 0x27
247#define DRM_I915_OVERLAY_ATTRS 0x28
248#define DRM_I915_GEM_EXECBUFFER2 0x29
fec0445c 249#define DRM_I915_GEM_EXECBUFFER2_WR DRM_I915_GEM_EXECBUFFER2
718dcedd
DH
250#define DRM_I915_GET_SPRITE_COLORKEY 0x2a
251#define DRM_I915_SET_SPRITE_COLORKEY 0x2b
252#define DRM_I915_GEM_WAIT 0x2c
253#define DRM_I915_GEM_CONTEXT_CREATE 0x2d
254#define DRM_I915_GEM_CONTEXT_DESTROY 0x2e
255#define DRM_I915_GEM_SET_CACHING 0x2f
256#define DRM_I915_GEM_GET_CACHING 0x30
257#define DRM_I915_REG_READ 0x31
b6359918 258#define DRM_I915_GET_RESET_STATS 0x32
5cc9ed4b 259#define DRM_I915_GEM_USERPTR 0x33
c9dc0f35
CW
260#define DRM_I915_GEM_CONTEXT_GETPARAM 0x34
261#define DRM_I915_GEM_CONTEXT_SETPARAM 0x35
eec688e1 262#define DRM_I915_PERF_OPEN 0x36
718dcedd
DH
263
264#define DRM_IOCTL_I915_INIT DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT, drm_i915_init_t)
265#define DRM_IOCTL_I915_FLUSH DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLUSH)
266#define DRM_IOCTL_I915_FLIP DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLIP)
267#define DRM_IOCTL_I915_BATCHBUFFER DRM_IOW( DRM_COMMAND_BASE + DRM_I915_BATCHBUFFER, drm_i915_batchbuffer_t)
268#define DRM_IOCTL_I915_IRQ_EMIT DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_IRQ_EMIT, drm_i915_irq_emit_t)
269#define DRM_IOCTL_I915_IRQ_WAIT DRM_IOW( DRM_COMMAND_BASE + DRM_I915_IRQ_WAIT, drm_i915_irq_wait_t)
270#define DRM_IOCTL_I915_GETPARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GETPARAM, drm_i915_getparam_t)
271#define DRM_IOCTL_I915_SETPARAM DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SETPARAM, drm_i915_setparam_t)
272#define DRM_IOCTL_I915_ALLOC DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_ALLOC, drm_i915_mem_alloc_t)
273#define DRM_IOCTL_I915_FREE DRM_IOW( DRM_COMMAND_BASE + DRM_I915_FREE, drm_i915_mem_free_t)
274#define DRM_IOCTL_I915_INIT_HEAP DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT_HEAP, drm_i915_mem_init_heap_t)
275#define DRM_IOCTL_I915_CMDBUFFER DRM_IOW( DRM_COMMAND_BASE + DRM_I915_CMDBUFFER, drm_i915_cmdbuffer_t)
276#define DRM_IOCTL_I915_DESTROY_HEAP DRM_IOW( DRM_COMMAND_BASE + DRM_I915_DESTROY_HEAP, drm_i915_mem_destroy_heap_t)
277#define DRM_IOCTL_I915_SET_VBLANK_PIPE DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
278#define DRM_IOCTL_I915_GET_VBLANK_PIPE DRM_IOR( DRM_COMMAND_BASE + DRM_I915_GET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
279#define DRM_IOCTL_I915_VBLANK_SWAP DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_VBLANK_SWAP, drm_i915_vblank_swap_t)
280#define DRM_IOCTL_I915_HWS_ADDR DRM_IOW(DRM_COMMAND_BASE + DRM_I915_HWS_ADDR, struct drm_i915_gem_init)
281#define DRM_IOCTL_I915_GEM_INIT DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_INIT, struct drm_i915_gem_init)
282#define DRM_IOCTL_I915_GEM_EXECBUFFER DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER, struct drm_i915_gem_execbuffer)
283#define DRM_IOCTL_I915_GEM_EXECBUFFER2 DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER2, struct drm_i915_gem_execbuffer2)
fec0445c 284#define DRM_IOCTL_I915_GEM_EXECBUFFER2_WR DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER2_WR, struct drm_i915_gem_execbuffer2)
718dcedd
DH
285#define DRM_IOCTL_I915_GEM_PIN DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_PIN, struct drm_i915_gem_pin)
286#define DRM_IOCTL_I915_GEM_UNPIN DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_UNPIN, struct drm_i915_gem_unpin)
287#define DRM_IOCTL_I915_GEM_BUSY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_BUSY, struct drm_i915_gem_busy)
288#define DRM_IOCTL_I915_GEM_SET_CACHING DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_SET_CACHING, struct drm_i915_gem_caching)
289#define DRM_IOCTL_I915_GEM_GET_CACHING DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_GET_CACHING, struct drm_i915_gem_caching)
290#define DRM_IOCTL_I915_GEM_THROTTLE DRM_IO ( DRM_COMMAND_BASE + DRM_I915_GEM_THROTTLE)
291#define DRM_IOCTL_I915_GEM_ENTERVT DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_ENTERVT)
292#define DRM_IOCTL_I915_GEM_LEAVEVT DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_LEAVEVT)
293#define DRM_IOCTL_I915_GEM_CREATE DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_CREATE, struct drm_i915_gem_create)
294#define DRM_IOCTL_I915_GEM_PREAD DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PREAD, struct drm_i915_gem_pread)
295#define DRM_IOCTL_I915_GEM_PWRITE DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PWRITE, struct drm_i915_gem_pwrite)
296#define DRM_IOCTL_I915_GEM_MMAP DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP, struct drm_i915_gem_mmap)
297#define DRM_IOCTL_I915_GEM_MMAP_GTT DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP_GTT, struct drm_i915_gem_mmap_gtt)
298#define DRM_IOCTL_I915_GEM_SET_DOMAIN DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SET_DOMAIN, struct drm_i915_gem_set_domain)
299#define DRM_IOCTL_I915_GEM_SW_FINISH DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SW_FINISH, struct drm_i915_gem_sw_finish)
300#define DRM_IOCTL_I915_GEM_SET_TILING DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_SET_TILING, struct drm_i915_gem_set_tiling)
301#define DRM_IOCTL_I915_GEM_GET_TILING DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_GET_TILING, struct drm_i915_gem_get_tiling)
302#define DRM_IOCTL_I915_GEM_GET_APERTURE DRM_IOR (DRM_COMMAND_BASE + DRM_I915_GEM_GET_APERTURE, struct drm_i915_gem_get_aperture)
303#define DRM_IOCTL_I915_GET_PIPE_FROM_CRTC_ID DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GET_PIPE_FROM_CRTC_ID, struct drm_i915_get_pipe_from_crtc_id)
304#define DRM_IOCTL_I915_GEM_MADVISE DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MADVISE, struct drm_i915_gem_madvise)
305#define DRM_IOCTL_I915_OVERLAY_PUT_IMAGE DRM_IOW(DRM_COMMAND_BASE + DRM_I915_OVERLAY_PUT_IMAGE, struct drm_intel_overlay_put_image)
306#define DRM_IOCTL_I915_OVERLAY_ATTRS DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_OVERLAY_ATTRS, struct drm_intel_overlay_attrs)
307#define DRM_IOCTL_I915_SET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_SET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
2c60fae1 308#define DRM_IOCTL_I915_GET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
718dcedd
DH
309#define DRM_IOCTL_I915_GEM_WAIT DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_WAIT, struct drm_i915_gem_wait)
310#define DRM_IOCTL_I915_GEM_CONTEXT_CREATE DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_CREATE, struct drm_i915_gem_context_create)
311#define DRM_IOCTL_I915_GEM_CONTEXT_DESTROY DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_DESTROY, struct drm_i915_gem_context_destroy)
312#define DRM_IOCTL_I915_REG_READ DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_REG_READ, struct drm_i915_reg_read)
b6359918 313#define DRM_IOCTL_I915_GET_RESET_STATS DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GET_RESET_STATS, struct drm_i915_reset_stats)
5cc9ed4b 314#define DRM_IOCTL_I915_GEM_USERPTR DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_USERPTR, struct drm_i915_gem_userptr)
c9dc0f35
CW
315#define DRM_IOCTL_I915_GEM_CONTEXT_GETPARAM DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_GETPARAM, struct drm_i915_gem_context_param)
316#define DRM_IOCTL_I915_GEM_CONTEXT_SETPARAM DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_SETPARAM, struct drm_i915_gem_context_param)
eec688e1 317#define DRM_IOCTL_I915_PERF_OPEN DRM_IOW(DRM_COMMAND_BASE + DRM_I915_PERF_OPEN, struct drm_i915_perf_open_param)
718dcedd
DH
318
319/* Allow drivers to submit batchbuffers directly to hardware, relying
320 * on the security mechanisms provided by hardware.
321 */
322typedef struct drm_i915_batchbuffer {
323 int start; /* agp offset */
324 int used; /* nr bytes in use */
325 int DR1; /* hw flags for GFX_OP_DRAWRECT_INFO */
326 int DR4; /* window origin for GFX_OP_DRAWRECT_INFO */
327 int num_cliprects; /* mulitpass with multiple cliprects? */
328 struct drm_clip_rect __user *cliprects; /* pointer to userspace cliprects */
329} drm_i915_batchbuffer_t;
330
331/* As above, but pass a pointer to userspace buffer which can be
332 * validated by the kernel prior to sending to hardware.
333 */
334typedef struct _drm_i915_cmdbuffer {
335 char __user *buf; /* pointer to userspace command buffer */
336 int sz; /* nr bytes in buf */
337 int DR1; /* hw flags for GFX_OP_DRAWRECT_INFO */
338 int DR4; /* window origin for GFX_OP_DRAWRECT_INFO */
339 int num_cliprects; /* mulitpass with multiple cliprects? */
340 struct drm_clip_rect __user *cliprects; /* pointer to userspace cliprects */
341} drm_i915_cmdbuffer_t;
342
343/* Userspace can request & wait on irq's:
344 */
345typedef struct drm_i915_irq_emit {
346 int __user *irq_seq;
347} drm_i915_irq_emit_t;
348
349typedef struct drm_i915_irq_wait {
350 int irq_seq;
351} drm_i915_irq_wait_t;
352
353/* Ioctl to query kernel params:
354 */
355#define I915_PARAM_IRQ_ACTIVE 1
356#define I915_PARAM_ALLOW_BATCHBUFFER 2
357#define I915_PARAM_LAST_DISPATCH 3
358#define I915_PARAM_CHIPSET_ID 4
359#define I915_PARAM_HAS_GEM 5
360#define I915_PARAM_NUM_FENCES_AVAIL 6
361#define I915_PARAM_HAS_OVERLAY 7
362#define I915_PARAM_HAS_PAGEFLIPPING 8
363#define I915_PARAM_HAS_EXECBUF2 9
364#define I915_PARAM_HAS_BSD 10
365#define I915_PARAM_HAS_BLT 11
366#define I915_PARAM_HAS_RELAXED_FENCING 12
367#define I915_PARAM_HAS_COHERENT_RINGS 13
368#define I915_PARAM_HAS_EXEC_CONSTANTS 14
369#define I915_PARAM_HAS_RELAXED_DELTA 15
370#define I915_PARAM_HAS_GEN7_SOL_RESET 16
371#define I915_PARAM_HAS_LLC 17
372#define I915_PARAM_HAS_ALIASING_PPGTT 18
373#define I915_PARAM_HAS_WAIT_TIMEOUT 19
374#define I915_PARAM_HAS_SEMAPHORES 20
375#define I915_PARAM_HAS_PRIME_VMAP_FLUSH 21
a1f2cc73 376#define I915_PARAM_HAS_VEBOX 22
c2fb7916 377#define I915_PARAM_HAS_SECURE_BATCHES 23
b45305fc 378#define I915_PARAM_HAS_PINNED_BATCHES 24
ed5982e6 379#define I915_PARAM_HAS_EXEC_NO_RELOC 25
eef90ccb 380#define I915_PARAM_HAS_EXEC_HANDLE_LUT 26
651d794f 381#define I915_PARAM_HAS_WT 27
d728c8ef 382#define I915_PARAM_CMD_PARSER_VERSION 28
6a2c4232 383#define I915_PARAM_HAS_COHERENT_PHYS_GTT 29
1816f923 384#define I915_PARAM_MMAP_VERSION 30
08e16dc8 385#define I915_PARAM_HAS_BSD2 31
27cd4461 386#define I915_PARAM_REVISION 32
a1559ffe
JM
387#define I915_PARAM_SUBSLICE_TOTAL 33
388#define I915_PARAM_EU_TOTAL 34
49e4d842 389#define I915_PARAM_HAS_GPU_RESET 35
a9ed33ca 390#define I915_PARAM_HAS_RESOURCE_STREAMER 36
506a8e87 391#define I915_PARAM_HAS_EXEC_SOFTPIN 37
37f501af 392#define I915_PARAM_HAS_POOLED_EU 38
393#define I915_PARAM_MIN_EU_IN_POOL 39
4cc69075 394#define I915_PARAM_MMAP_GTT_VERSION 40
718dcedd 395
0de9136d
CW
396/* Query whether DRM_I915_GEM_EXECBUFFER2 supports user defined execution
397 * priorities and the driver will attempt to execute batches in priority order.
398 */
399#define I915_PARAM_HAS_SCHEDULER 41
5464cd65 400#define I915_PARAM_HUC_STATUS 42
0de9136d 401
77ae9957
CW
402/* Query whether DRM_I915_GEM_EXECBUFFER2 supports the ability to opt-out of
403 * synchronisation with implicit fencing on individual objects.
404 * See EXEC_OBJECT_ASYNC.
405 */
406#define I915_PARAM_HAS_EXEC_ASYNC 43
407
fec0445c
CW
408/* Query whether DRM_I915_GEM_EXECBUFFER2 supports explicit fence support -
409 * both being able to pass in a sync_file fd to wait upon before executing,
410 * and being able to return a new sync_file fd that is signaled when the
411 * current request is complete. See I915_EXEC_FENCE_IN and I915_EXEC_FENCE_OUT.
412 */
413#define I915_PARAM_HAS_EXEC_FENCE 44
414
b0fd47ad
CW
415/* Query whether DRM_I915_GEM_EXECBUFFER2 supports the ability to capture
416 * user specified bufffers for post-mortem debugging of GPU hangs. See
417 * EXEC_OBJECT_CAPTURE.
418 */
419#define I915_PARAM_HAS_EXEC_CAPTURE 45
420
7fed555c
RB
421/* Query the mask of slices available for this system */
422#define I915_PARAM_SLICE_MASK 46
423
f5320233
RB
424/* Assuming it's uniform for each slice, this queries the mask of subslices
425 * per-slice for this system.
426 */
427#define I915_PARAM_SUBSLICE_MASK 47
428
718dcedd 429typedef struct drm_i915_getparam {
16f7249d 430 __s32 param;
346add78
DV
431 /*
432 * WARNING: Using pointers instead of fixed-size u64 means we need to write
433 * compat32 code. Don't repeat this mistake.
434 */
718dcedd
DH
435 int __user *value;
436} drm_i915_getparam_t;
437
438/* Ioctl to set kernel params:
439 */
440#define I915_SETPARAM_USE_MI_BATCHBUFFER_START 1
441#define I915_SETPARAM_TEX_LRU_LOG_GRANULARITY 2
442#define I915_SETPARAM_ALLOW_BATCHBUFFER 3
443#define I915_SETPARAM_NUM_USED_FENCES 4
444
445typedef struct drm_i915_setparam {
446 int param;
447 int value;
448} drm_i915_setparam_t;
449
450/* A memory manager for regions of shared memory:
451 */
452#define I915_MEM_REGION_AGP 1
453
454typedef struct drm_i915_mem_alloc {
455 int region;
456 int alignment;
457 int size;
458 int __user *region_offset; /* offset from start of fb or agp */
459} drm_i915_mem_alloc_t;
460
461typedef struct drm_i915_mem_free {
462 int region;
463 int region_offset;
464} drm_i915_mem_free_t;
465
466typedef struct drm_i915_mem_init_heap {
467 int region;
468 int size;
469 int start;
470} drm_i915_mem_init_heap_t;
471
472/* Allow memory manager to be torn down and re-initialized (eg on
473 * rotate):
474 */
475typedef struct drm_i915_mem_destroy_heap {
476 int region;
477} drm_i915_mem_destroy_heap_t;
478
479/* Allow X server to configure which pipes to monitor for vblank signals
480 */
481#define DRM_I915_VBLANK_PIPE_A 1
482#define DRM_I915_VBLANK_PIPE_B 2
483
484typedef struct drm_i915_vblank_pipe {
485 int pipe;
486} drm_i915_vblank_pipe_t;
487
488/* Schedule buffer swap at given vertical blank:
489 */
490typedef struct drm_i915_vblank_swap {
491 drm_drawable_t drawable;
492 enum drm_vblank_seq_type seqtype;
493 unsigned int sequence;
494} drm_i915_vblank_swap_t;
495
496typedef struct drm_i915_hws_addr {
497 __u64 addr;
498} drm_i915_hws_addr_t;
499
500struct drm_i915_gem_init {
501 /**
502 * Beginning offset in the GTT to be managed by the DRM memory
503 * manager.
504 */
505 __u64 gtt_start;
506 /**
507 * Ending offset in the GTT to be managed by the DRM memory
508 * manager.
509 */
510 __u64 gtt_end;
511};
512
513struct drm_i915_gem_create {
514 /**
515 * Requested size for the object.
516 *
517 * The (page-aligned) allocated size for the object will be returned.
518 */
519 __u64 size;
520 /**
521 * Returned handle for the object.
522 *
523 * Object handles are nonzero.
524 */
525 __u32 handle;
526 __u32 pad;
527};
528
529struct drm_i915_gem_pread {
530 /** Handle for the object being read. */
531 __u32 handle;
532 __u32 pad;
533 /** Offset into the object to read from */
534 __u64 offset;
535 /** Length of data to read */
536 __u64 size;
537 /**
538 * Pointer to write the data into.
539 *
540 * This is a fixed-size type for 32/64 compatibility.
541 */
542 __u64 data_ptr;
543};
544
545struct drm_i915_gem_pwrite {
546 /** Handle for the object being written to. */
547 __u32 handle;
548 __u32 pad;
549 /** Offset into the object to write to */
550 __u64 offset;
551 /** Length of data to write */
552 __u64 size;
553 /**
554 * Pointer to read the data from.
555 *
556 * This is a fixed-size type for 32/64 compatibility.
557 */
558 __u64 data_ptr;
559};
560
561struct drm_i915_gem_mmap {
562 /** Handle for the object being mapped. */
563 __u32 handle;
564 __u32 pad;
565 /** Offset in the object to map. */
566 __u64 offset;
567 /**
568 * Length of data to map.
569 *
570 * The value will be page-aligned.
571 */
572 __u64 size;
573 /**
574 * Returned pointer the data was mapped at.
575 *
576 * This is a fixed-size type for 32/64 compatibility.
577 */
578 __u64 addr_ptr;
1816f923
AG
579
580 /**
581 * Flags for extended behaviour.
582 *
583 * Added in version 2.
584 */
585 __u64 flags;
586#define I915_MMAP_WC 0x1
718dcedd
DH
587};
588
589struct drm_i915_gem_mmap_gtt {
590 /** Handle for the object being mapped. */
591 __u32 handle;
592 __u32 pad;
593 /**
594 * Fake offset to use for subsequent mmap call
595 *
596 * This is a fixed-size type for 32/64 compatibility.
597 */
598 __u64 offset;
599};
600
601struct drm_i915_gem_set_domain {
602 /** Handle for the object */
603 __u32 handle;
604
605 /** New read domains */
606 __u32 read_domains;
607
608 /** New write domain */
609 __u32 write_domain;
610};
611
612struct drm_i915_gem_sw_finish {
613 /** Handle for the object */
614 __u32 handle;
615};
616
617struct drm_i915_gem_relocation_entry {
618 /**
619 * Handle of the buffer being pointed to by this relocation entry.
620 *
621 * It's appealing to make this be an index into the mm_validate_entry
622 * list to refer to the buffer, but this allows the driver to create
623 * a relocation list for state buffers and not re-write it per
624 * exec using the buffer.
625 */
626 __u32 target_handle;
627
628 /**
629 * Value to be added to the offset of the target buffer to make up
630 * the relocation entry.
631 */
632 __u32 delta;
633
634 /** Offset in the buffer the relocation entry will be written into */
635 __u64 offset;
636
637 /**
638 * Offset value of the target buffer that the relocation entry was last
639 * written as.
640 *
641 * If the buffer has the same offset as last time, we can skip syncing
642 * and writing the relocation. This value is written back out by
643 * the execbuffer ioctl when the relocation is written.
644 */
645 __u64 presumed_offset;
646
647 /**
648 * Target memory domains read by this operation.
649 */
650 __u32 read_domains;
651
652 /**
653 * Target memory domains written by this operation.
654 *
655 * Note that only one domain may be written by the whole
656 * execbuffer operation, so that where there are conflicts,
657 * the application will get -EINVAL back.
658 */
659 __u32 write_domain;
660};
661
662/** @{
663 * Intel memory domains
664 *
665 * Most of these just align with the various caches in
666 * the system and are used to flush and invalidate as
667 * objects end up cached in different domains.
668 */
669/** CPU cache */
670#define I915_GEM_DOMAIN_CPU 0x00000001
671/** Render cache, used by 2D and 3D drawing */
672#define I915_GEM_DOMAIN_RENDER 0x00000002
673/** Sampler cache, used by texture engine */
674#define I915_GEM_DOMAIN_SAMPLER 0x00000004
675/** Command queue, used to load batch buffers */
676#define I915_GEM_DOMAIN_COMMAND 0x00000008
677/** Instruction cache, used by shader programs */
678#define I915_GEM_DOMAIN_INSTRUCTION 0x00000010
679/** Vertex address cache */
680#define I915_GEM_DOMAIN_VERTEX 0x00000020
681/** GTT domain - aperture and scanout */
682#define I915_GEM_DOMAIN_GTT 0x00000040
e22d8e3c
CW
683/** WC domain - uncached access */
684#define I915_GEM_DOMAIN_WC 0x00000080
718dcedd
DH
685/** @} */
686
687struct drm_i915_gem_exec_object {
688 /**
689 * User's handle for a buffer to be bound into the GTT for this
690 * operation.
691 */
692 __u32 handle;
693
694 /** Number of relocations to be performed on this buffer */
695 __u32 relocation_count;
696 /**
697 * Pointer to array of struct drm_i915_gem_relocation_entry containing
698 * the relocations to be performed in this buffer.
699 */
700 __u64 relocs_ptr;
701
702 /** Required alignment in graphics aperture */
703 __u64 alignment;
704
705 /**
706 * Returned value of the updated offset of the object, for future
707 * presumed_offset writes.
708 */
709 __u64 offset;
710};
711
712struct drm_i915_gem_execbuffer {
713 /**
714 * List of buffers to be validated with their relocations to be
715 * performend on them.
716 *
717 * This is a pointer to an array of struct drm_i915_gem_validate_entry.
718 *
719 * These buffers must be listed in an order such that all relocations
720 * a buffer is performing refer to buffers that have already appeared
721 * in the validate list.
722 */
723 __u64 buffers_ptr;
724 __u32 buffer_count;
725
726 /** Offset in the batchbuffer to start execution from. */
727 __u32 batch_start_offset;
728 /** Bytes used in batchbuffer from batch_start_offset */
729 __u32 batch_len;
730 __u32 DR1;
731 __u32 DR4;
732 __u32 num_cliprects;
733 /** This is a struct drm_clip_rect *cliprects */
734 __u64 cliprects_ptr;
735};
736
737struct drm_i915_gem_exec_object2 {
738 /**
739 * User's handle for a buffer to be bound into the GTT for this
740 * operation.
741 */
742 __u32 handle;
743
744 /** Number of relocations to be performed on this buffer */
745 __u32 relocation_count;
746 /**
747 * Pointer to array of struct drm_i915_gem_relocation_entry containing
748 * the relocations to be performed in this buffer.
749 */
750 __u64 relocs_ptr;
751
752 /** Required alignment in graphics aperture */
753 __u64 alignment;
754
755 /**
506a8e87
CW
756 * When the EXEC_OBJECT_PINNED flag is specified this is populated by
757 * the user with the GTT offset at which this object will be pinned.
758 * When the I915_EXEC_NO_RELOC flag is specified this must contain the
759 * presumed_offset of the object.
760 * During execbuffer2 the kernel populates it with the value of the
761 * current GTT offset of the object, for future presumed_offset writes.
718dcedd
DH
762 */
763 __u64 offset;
764
9e2793f6
DG
765#define EXEC_OBJECT_NEEDS_FENCE (1<<0)
766#define EXEC_OBJECT_NEEDS_GTT (1<<1)
767#define EXEC_OBJECT_WRITE (1<<2)
101b506a 768#define EXEC_OBJECT_SUPPORTS_48B_ADDRESS (1<<3)
9e2793f6 769#define EXEC_OBJECT_PINNED (1<<4)
91b2db6f 770#define EXEC_OBJECT_PAD_TO_SIZE (1<<5)
77ae9957
CW
771/* The kernel implicitly tracks GPU activity on all GEM objects, and
772 * synchronises operations with outstanding rendering. This includes
773 * rendering on other devices if exported via dma-buf. However, sometimes
774 * this tracking is too coarse and the user knows better. For example,
775 * if the object is split into non-overlapping ranges shared between different
776 * clients or engines (i.e. suballocating objects), the implicit tracking
777 * by kernel assumes that each operation affects the whole object rather
778 * than an individual range, causing needless synchronisation between clients.
779 * The kernel will also forgo any CPU cache flushes prior to rendering from
780 * the object as the client is expected to be also handling such domain
781 * tracking.
782 *
783 * The kernel maintains the implicit tracking in order to manage resources
784 * used by the GPU - this flag only disables the synchronisation prior to
785 * rendering with this object in this execbuf.
786 *
787 * Opting out of implicit synhronisation requires the user to do its own
788 * explicit tracking to avoid rendering corruption. See, for example,
789 * I915_PARAM_HAS_EXEC_FENCE to order execbufs and execute them asynchronously.
790 */
791#define EXEC_OBJECT_ASYNC (1<<6)
b0fd47ad
CW
792/* Request that the contents of this execobject be copied into the error
793 * state upon a GPU hang involving this batch for post-mortem debugging.
794 * These buffers are recorded in no particular order as "user" in
795 * /sys/class/drm/cardN/error. Query I915_PARAM_HAS_EXEC_CAPTURE to see
796 * if the kernel supports this flag.
797 */
798#define EXEC_OBJECT_CAPTURE (1<<7)
9e2793f6 799/* All remaining bits are MBZ and RESERVED FOR FUTURE USE */
b0fd47ad 800#define __EXEC_OBJECT_UNKNOWN_FLAGS -(EXEC_OBJECT_CAPTURE<<1)
718dcedd 801 __u64 flags;
ed5982e6 802
91b2db6f
CW
803 union {
804 __u64 rsvd1;
805 __u64 pad_to_size;
806 };
718dcedd
DH
807 __u64 rsvd2;
808};
809
810struct drm_i915_gem_execbuffer2 {
811 /**
812 * List of gem_exec_object2 structs
813 */
814 __u64 buffers_ptr;
815 __u32 buffer_count;
816
817 /** Offset in the batchbuffer to start execution from. */
818 __u32 batch_start_offset;
819 /** Bytes used in batchbuffer from batch_start_offset */
820 __u32 batch_len;
821 __u32 DR1;
822 __u32 DR4;
823 __u32 num_cliprects;
824 /** This is a struct drm_clip_rect *cliprects */
825 __u64 cliprects_ptr;
826#define I915_EXEC_RING_MASK (7<<0)
827#define I915_EXEC_DEFAULT (0<<0)
828#define I915_EXEC_RENDER (1<<0)
829#define I915_EXEC_BSD (2<<0)
830#define I915_EXEC_BLT (3<<0)
82f91b6e 831#define I915_EXEC_VEBOX (4<<0)
718dcedd
DH
832
833/* Used for switching the constants addressing mode on gen4+ RENDER ring.
834 * Gen6+ only supports relative addressing to dynamic state (default) and
835 * absolute addressing.
836 *
837 * These flags are ignored for the BSD and BLT rings.
838 */
839#define I915_EXEC_CONSTANTS_MASK (3<<6)
840#define I915_EXEC_CONSTANTS_REL_GENERAL (0<<6) /* default */
841#define I915_EXEC_CONSTANTS_ABSOLUTE (1<<6)
842#define I915_EXEC_CONSTANTS_REL_SURFACE (2<<6) /* gen4/5 only */
843 __u64 flags;
844 __u64 rsvd1; /* now used for context info */
845 __u64 rsvd2;
846};
847
848/** Resets the SO write offset registers for transform feedback on gen7. */
849#define I915_EXEC_GEN7_SOL_RESET (1<<8)
850
c2fb7916
DV
851/** Request a privileged ("secure") batch buffer. Note only available for
852 * DRM_ROOT_ONLY | DRM_MASTER processes.
853 */
854#define I915_EXEC_SECURE (1<<9)
855
b45305fc
DV
856/** Inform the kernel that the batch is and will always be pinned. This
857 * negates the requirement for a workaround to be performed to avoid
858 * an incoherent CS (such as can be found on 830/845). If this flag is
859 * not passed, the kernel will endeavour to make sure the batch is
860 * coherent with the CS before execution. If this flag is passed,
861 * userspace assumes the responsibility for ensuring the same.
862 */
863#define I915_EXEC_IS_PINNED (1<<10)
864
c3d19d3c 865/** Provide a hint to the kernel that the command stream and auxiliary
ed5982e6
DV
866 * state buffers already holds the correct presumed addresses and so the
867 * relocation process may be skipped if no buffers need to be moved in
868 * preparation for the execbuffer.
869 */
870#define I915_EXEC_NO_RELOC (1<<11)
871
eef90ccb
CW
872/** Use the reloc.handle as an index into the exec object array rather
873 * than as the per-file handle.
874 */
875#define I915_EXEC_HANDLE_LUT (1<<12)
876
8d360dff 877/** Used for switching BSD rings on the platforms with two BSD rings */
d9da6aa0
TU
878#define I915_EXEC_BSD_SHIFT (13)
879#define I915_EXEC_BSD_MASK (3 << I915_EXEC_BSD_SHIFT)
880/* default ping-pong mode */
881#define I915_EXEC_BSD_DEFAULT (0 << I915_EXEC_BSD_SHIFT)
882#define I915_EXEC_BSD_RING1 (1 << I915_EXEC_BSD_SHIFT)
883#define I915_EXEC_BSD_RING2 (2 << I915_EXEC_BSD_SHIFT)
8d360dff 884
a9ed33ca
AJ
885/** Tell the kernel that the batchbuffer is processed by
886 * the resource streamer.
887 */
888#define I915_EXEC_RESOURCE_STREAMER (1<<15)
889
fec0445c
CW
890/* Setting I915_EXEC_FENCE_IN implies that lower_32_bits(rsvd2) represent
891 * a sync_file fd to wait upon (in a nonblocking manner) prior to executing
892 * the batch.
893 *
894 * Returns -EINVAL if the sync_file fd cannot be found.
895 */
896#define I915_EXEC_FENCE_IN (1<<16)
897
898/* Setting I915_EXEC_FENCE_OUT causes the ioctl to return a sync_file fd
899 * in the upper_32_bits(rsvd2) upon success. Ownership of the fd is given
900 * to the caller, and it should be close() after use. (The fd is a regular
901 * file descriptor and will be cleaned up on process termination. It holds
902 * a reference to the request, but nothing else.)
903 *
904 * The sync_file fd can be combined with other sync_file and passed either
905 * to execbuf using I915_EXEC_FENCE_IN, to atomic KMS ioctls (so that a flip
906 * will only occur after this request completes), or to other devices.
907 *
908 * Using I915_EXEC_FENCE_OUT requires use of
909 * DRM_IOCTL_I915_GEM_EXECBUFFER2_WR ioctl so that the result is written
910 * back to userspace. Failure to do so will cause the out-fence to always
911 * be reported as zero, and the real fence fd to be leaked.
912 */
913#define I915_EXEC_FENCE_OUT (1<<17)
914
915#define __I915_EXEC_UNKNOWN_FLAGS (-(I915_EXEC_FENCE_OUT<<1))
ed5982e6 916
718dcedd
DH
917#define I915_EXEC_CONTEXT_ID_MASK (0xffffffff)
918#define i915_execbuffer2_set_context_id(eb2, context) \
919 (eb2).rsvd1 = context & I915_EXEC_CONTEXT_ID_MASK
920#define i915_execbuffer2_get_context_id(eb2) \
921 ((eb2).rsvd1 & I915_EXEC_CONTEXT_ID_MASK)
922
923struct drm_i915_gem_pin {
924 /** Handle of the buffer to be pinned. */
925 __u32 handle;
926 __u32 pad;
927
928 /** alignment required within the aperture */
929 __u64 alignment;
930
931 /** Returned GTT offset of the buffer. */
932 __u64 offset;
933};
934
935struct drm_i915_gem_unpin {
936 /** Handle of the buffer to be unpinned. */
937 __u32 handle;
938 __u32 pad;
939};
940
941struct drm_i915_gem_busy {
942 /** Handle of the buffer to check for busy */
943 __u32 handle;
944
426960be
CW
945 /** Return busy status
946 *
947 * A return of 0 implies that the object is idle (after
948 * having flushed any pending activity), and a non-zero return that
949 * the object is still in-flight on the GPU. (The GPU has not yet
950 * signaled completion for all pending requests that reference the
1255501d
CW
951 * object.) An object is guaranteed to become idle eventually (so
952 * long as no new GPU commands are executed upon it). Due to the
953 * asynchronous nature of the hardware, an object reported
954 * as busy may become idle before the ioctl is completed.
955 *
956 * Furthermore, if the object is busy, which engine is busy is only
957 * provided as a guide. There are race conditions which prevent the
958 * report of which engines are busy from being always accurate.
959 * However, the converse is not true. If the object is idle, the
960 * result of the ioctl, that all engines are idle, is accurate.
426960be
CW
961 *
962 * The returned dword is split into two fields to indicate both
963 * the engines on which the object is being read, and the
964 * engine on which it is currently being written (if any).
965 *
966 * The low word (bits 0:15) indicate if the object is being written
967 * to by any engine (there can only be one, as the GEM implicit
968 * synchronisation rules force writes to be serialised). Only the
969 * engine for the last write is reported.
970 *
971 * The high word (bits 16:31) are a bitmask of which engines are
972 * currently reading from the object. Multiple engines may be
973 * reading from the object simultaneously.
974 *
975 * The value of each engine is the same as specified in the
976 * EXECBUFFER2 ioctl, i.e. I915_EXEC_RENDER, I915_EXEC_BSD etc.
977 * Note I915_EXEC_DEFAULT is a symbolic value and is mapped to
978 * the I915_EXEC_RENDER engine for execution, and so it is never
979 * reported as active itself. Some hardware may have parallel
980 * execution engines, e.g. multiple media engines, which are
981 * mapped to the same identifier in the EXECBUFFER2 ioctl and
982 * so are not separately reported for busyness.
1255501d
CW
983 *
984 * Caveat emptor:
985 * Only the boolean result of this query is reliable; that is whether
986 * the object is idle or busy. The report of which engines are busy
987 * should be only used as a heuristic.
718dcedd
DH
988 */
989 __u32 busy;
990};
991
35c7ab42
DV
992/**
993 * I915_CACHING_NONE
994 *
995 * GPU access is not coherent with cpu caches. Default for machines without an
996 * LLC.
997 */
718dcedd 998#define I915_CACHING_NONE 0
35c7ab42
DV
999/**
1000 * I915_CACHING_CACHED
1001 *
1002 * GPU access is coherent with cpu caches and furthermore the data is cached in
1003 * last-level caches shared between cpu cores and the gpu GT. Default on
1004 * machines with HAS_LLC.
1005 */
718dcedd 1006#define I915_CACHING_CACHED 1
35c7ab42
DV
1007/**
1008 * I915_CACHING_DISPLAY
1009 *
1010 * Special GPU caching mode which is coherent with the scanout engines.
1011 * Transparently falls back to I915_CACHING_NONE on platforms where no special
1012 * cache mode (like write-through or gfdt flushing) is available. The kernel
1013 * automatically sets this mode when using a buffer as a scanout target.
1014 * Userspace can manually set this mode to avoid a costly stall and clflush in
1015 * the hotpath of drawing the first frame.
1016 */
1017#define I915_CACHING_DISPLAY 2
718dcedd
DH
1018
1019struct drm_i915_gem_caching {
1020 /**
1021 * Handle of the buffer to set/get the caching level of. */
1022 __u32 handle;
1023
1024 /**
1025 * Cacheing level to apply or return value
1026 *
1027 * bits0-15 are for generic caching control (i.e. the above defined
1028 * values). bits16-31 are reserved for platform-specific variations
1029 * (e.g. l3$ caching on gen7). */
1030 __u32 caching;
1031};
1032
1033#define I915_TILING_NONE 0
1034#define I915_TILING_X 1
1035#define I915_TILING_Y 2
deeb1519 1036#define I915_TILING_LAST I915_TILING_Y
718dcedd
DH
1037
1038#define I915_BIT_6_SWIZZLE_NONE 0
1039#define I915_BIT_6_SWIZZLE_9 1
1040#define I915_BIT_6_SWIZZLE_9_10 2
1041#define I915_BIT_6_SWIZZLE_9_11 3
1042#define I915_BIT_6_SWIZZLE_9_10_11 4
1043/* Not seen by userland */
1044#define I915_BIT_6_SWIZZLE_UNKNOWN 5
1045/* Seen by userland. */
1046#define I915_BIT_6_SWIZZLE_9_17 6
1047#define I915_BIT_6_SWIZZLE_9_10_17 7
1048
1049struct drm_i915_gem_set_tiling {
1050 /** Handle of the buffer to have its tiling state updated */
1051 __u32 handle;
1052
1053 /**
1054 * Tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
1055 * I915_TILING_Y).
1056 *
1057 * This value is to be set on request, and will be updated by the
1058 * kernel on successful return with the actual chosen tiling layout.
1059 *
1060 * The tiling mode may be demoted to I915_TILING_NONE when the system
1061 * has bit 6 swizzling that can't be managed correctly by GEM.
1062 *
1063 * Buffer contents become undefined when changing tiling_mode.
1064 */
1065 __u32 tiling_mode;
1066
1067 /**
1068 * Stride in bytes for the object when in I915_TILING_X or
1069 * I915_TILING_Y.
1070 */
1071 __u32 stride;
1072
1073 /**
1074 * Returned address bit 6 swizzling required for CPU access through
1075 * mmap mapping.
1076 */
1077 __u32 swizzle_mode;
1078};
1079
1080struct drm_i915_gem_get_tiling {
1081 /** Handle of the buffer to get tiling state for. */
1082 __u32 handle;
1083
1084 /**
1085 * Current tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
1086 * I915_TILING_Y).
1087 */
1088 __u32 tiling_mode;
1089
1090 /**
1091 * Returned address bit 6 swizzling required for CPU access through
1092 * mmap mapping.
1093 */
1094 __u32 swizzle_mode;
70f2f5c7
CW
1095
1096 /**
1097 * Returned address bit 6 swizzling required for CPU access through
1098 * mmap mapping whilst bound.
1099 */
1100 __u32 phys_swizzle_mode;
718dcedd
DH
1101};
1102
1103struct drm_i915_gem_get_aperture {
1104 /** Total size of the aperture used by i915_gem_execbuffer, in bytes */
1105 __u64 aper_size;
1106
1107 /**
1108 * Available space in the aperture used by i915_gem_execbuffer, in
1109 * bytes
1110 */
1111 __u64 aper_available_size;
1112};
1113
1114struct drm_i915_get_pipe_from_crtc_id {
1115 /** ID of CRTC being requested **/
1116 __u32 crtc_id;
1117
1118 /** pipe of requested CRTC **/
1119 __u32 pipe;
1120};
1121
1122#define I915_MADV_WILLNEED 0
1123#define I915_MADV_DONTNEED 1
1124#define __I915_MADV_PURGED 2 /* internal state */
1125
1126struct drm_i915_gem_madvise {
1127 /** Handle of the buffer to change the backing store advice */
1128 __u32 handle;
1129
1130 /* Advice: either the buffer will be needed again in the near future,
1131 * or wont be and could be discarded under memory pressure.
1132 */
1133 __u32 madv;
1134
1135 /** Whether the backing store still exists. */
1136 __u32 retained;
1137};
1138
1139/* flags */
1140#define I915_OVERLAY_TYPE_MASK 0xff
1141#define I915_OVERLAY_YUV_PLANAR 0x01
1142#define I915_OVERLAY_YUV_PACKED 0x02
1143#define I915_OVERLAY_RGB 0x03
1144
1145#define I915_OVERLAY_DEPTH_MASK 0xff00
1146#define I915_OVERLAY_RGB24 0x1000
1147#define I915_OVERLAY_RGB16 0x2000
1148#define I915_OVERLAY_RGB15 0x3000
1149#define I915_OVERLAY_YUV422 0x0100
1150#define I915_OVERLAY_YUV411 0x0200
1151#define I915_OVERLAY_YUV420 0x0300
1152#define I915_OVERLAY_YUV410 0x0400
1153
1154#define I915_OVERLAY_SWAP_MASK 0xff0000
1155#define I915_OVERLAY_NO_SWAP 0x000000
1156#define I915_OVERLAY_UV_SWAP 0x010000
1157#define I915_OVERLAY_Y_SWAP 0x020000
1158#define I915_OVERLAY_Y_AND_UV_SWAP 0x030000
1159
1160#define I915_OVERLAY_FLAGS_MASK 0xff000000
1161#define I915_OVERLAY_ENABLE 0x01000000
1162
1163struct drm_intel_overlay_put_image {
1164 /* various flags and src format description */
1165 __u32 flags;
1166 /* source picture description */
1167 __u32 bo_handle;
1168 /* stride values and offsets are in bytes, buffer relative */
1169 __u16 stride_Y; /* stride for packed formats */
1170 __u16 stride_UV;
1171 __u32 offset_Y; /* offset for packet formats */
1172 __u32 offset_U;
1173 __u32 offset_V;
1174 /* in pixels */
1175 __u16 src_width;
1176 __u16 src_height;
1177 /* to compensate the scaling factors for partially covered surfaces */
1178 __u16 src_scan_width;
1179 __u16 src_scan_height;
1180 /* output crtc description */
1181 __u32 crtc_id;
1182 __u16 dst_x;
1183 __u16 dst_y;
1184 __u16 dst_width;
1185 __u16 dst_height;
1186};
1187
1188/* flags */
1189#define I915_OVERLAY_UPDATE_ATTRS (1<<0)
1190#define I915_OVERLAY_UPDATE_GAMMA (1<<1)
ea9da4e4 1191#define I915_OVERLAY_DISABLE_DEST_COLORKEY (1<<2)
718dcedd
DH
1192struct drm_intel_overlay_attrs {
1193 __u32 flags;
1194 __u32 color_key;
1195 __s32 brightness;
1196 __u32 contrast;
1197 __u32 saturation;
1198 __u32 gamma0;
1199 __u32 gamma1;
1200 __u32 gamma2;
1201 __u32 gamma3;
1202 __u32 gamma4;
1203 __u32 gamma5;
1204};
1205
1206/*
1207 * Intel sprite handling
1208 *
1209 * Color keying works with a min/mask/max tuple. Both source and destination
1210 * color keying is allowed.
1211 *
1212 * Source keying:
1213 * Sprite pixels within the min & max values, masked against the color channels
1214 * specified in the mask field, will be transparent. All other pixels will
1215 * be displayed on top of the primary plane. For RGB surfaces, only the min
1216 * and mask fields will be used; ranged compares are not allowed.
1217 *
1218 * Destination keying:
1219 * Primary plane pixels that match the min value, masked against the color
1220 * channels specified in the mask field, will be replaced by corresponding
1221 * pixels from the sprite plane.
1222 *
1223 * Note that source & destination keying are exclusive; only one can be
1224 * active on a given plane.
1225 */
1226
1227#define I915_SET_COLORKEY_NONE (1<<0) /* disable color key matching */
1228#define I915_SET_COLORKEY_DESTINATION (1<<1)
1229#define I915_SET_COLORKEY_SOURCE (1<<2)
1230struct drm_intel_sprite_colorkey {
1231 __u32 plane_id;
1232 __u32 min_value;
1233 __u32 channel_mask;
1234 __u32 max_value;
1235 __u32 flags;
1236};
1237
1238struct drm_i915_gem_wait {
1239 /** Handle of BO we shall wait on */
1240 __u32 bo_handle;
1241 __u32 flags;
1242 /** Number of nanoseconds to wait, Returns time remaining. */
1243 __s64 timeout_ns;
1244};
1245
1246struct drm_i915_gem_context_create {
1247 /* output: id of new context*/
1248 __u32 ctx_id;
1249 __u32 pad;
1250};
1251
1252struct drm_i915_gem_context_destroy {
1253 __u32 ctx_id;
1254 __u32 pad;
1255};
1256
1257struct drm_i915_reg_read {
8697600b
VS
1258 /*
1259 * Register offset.
1260 * For 64bit wide registers where the upper 32bits don't immediately
1261 * follow the lower 32bits, the offset of the lower 32bits must
1262 * be specified
1263 */
718dcedd
DH
1264 __u64 offset;
1265 __u64 val; /* Return value */
1266};
648a9bc5
CW
1267/* Known registers:
1268 *
1269 * Render engine timestamp - 0x2358 + 64bit - gen7+
1270 * - Note this register returns an invalid value if using the default
1271 * single instruction 8byte read, in order to workaround that use
1272 * offset (0x2538 | 1) instead.
1273 *
1274 */
b6359918
MK
1275
1276struct drm_i915_reset_stats {
1277 __u32 ctx_id;
1278 __u32 flags;
1279
1280 /* All resets since boot/module reload, for all contexts */
1281 __u32 reset_count;
1282
1283 /* Number of batches lost when active in GPU, for this context */
1284 __u32 batch_active;
1285
1286 /* Number of batches lost pending for execution, for this context */
1287 __u32 batch_pending;
1288
1289 __u32 pad;
1290};
1291
5cc9ed4b
CW
1292struct drm_i915_gem_userptr {
1293 __u64 user_ptr;
1294 __u64 user_size;
1295 __u32 flags;
1296#define I915_USERPTR_READ_ONLY 0x1
1297#define I915_USERPTR_UNSYNCHRONIZED 0x80000000
1298 /**
1299 * Returned handle for the object.
1300 *
1301 * Object handles are nonzero.
1302 */
1303 __u32 handle;
1304};
1305
c9dc0f35
CW
1306struct drm_i915_gem_context_param {
1307 __u32 ctx_id;
1308 __u32 size;
1309 __u64 param;
fa8848f2
CW
1310#define I915_CONTEXT_PARAM_BAN_PERIOD 0x1
1311#define I915_CONTEXT_PARAM_NO_ZEROMAP 0x2
1312#define I915_CONTEXT_PARAM_GTT_SIZE 0x3
bc3d6744 1313#define I915_CONTEXT_PARAM_NO_ERROR_CAPTURE 0x4
84102171 1314#define I915_CONTEXT_PARAM_BANNABLE 0x5
c9dc0f35
CW
1315 __u64 value;
1316};
1317
d7965152
RB
1318enum drm_i915_oa_format {
1319 I915_OA_FORMAT_A13 = 1,
1320 I915_OA_FORMAT_A29,
1321 I915_OA_FORMAT_A13_B8_C8,
1322 I915_OA_FORMAT_B4_C8,
1323 I915_OA_FORMAT_A45_B8_C8,
1324 I915_OA_FORMAT_B4_C8_A16,
1325 I915_OA_FORMAT_C4_B8,
1326
1327 I915_OA_FORMAT_MAX /* non-ABI */
1328};
1329
eec688e1
RB
1330enum drm_i915_perf_property_id {
1331 /**
1332 * Open the stream for a specific context handle (as used with
1333 * execbuffer2). A stream opened for a specific context this way
1334 * won't typically require root privileges.
1335 */
1336 DRM_I915_PERF_PROP_CTX_HANDLE = 1,
1337
d7965152
RB
1338 /**
1339 * A value of 1 requests the inclusion of raw OA unit reports as
1340 * part of stream samples.
1341 */
1342 DRM_I915_PERF_PROP_SAMPLE_OA,
1343
1344 /**
1345 * The value specifies which set of OA unit metrics should be
1346 * be configured, defining the contents of any OA unit reports.
1347 */
1348 DRM_I915_PERF_PROP_OA_METRICS_SET,
1349
1350 /**
1351 * The value specifies the size and layout of OA unit reports.
1352 */
1353 DRM_I915_PERF_PROP_OA_FORMAT,
1354
1355 /**
1356 * Specifying this property implicitly requests periodic OA unit
1357 * sampling and (at least on Haswell) the sampling frequency is derived
1358 * from this exponent as follows:
1359 *
1360 * 80ns * 2^(period_exponent + 1)
1361 */
1362 DRM_I915_PERF_PROP_OA_EXPONENT,
1363
eec688e1
RB
1364 DRM_I915_PERF_PROP_MAX /* non-ABI */
1365};
1366
1367struct drm_i915_perf_open_param {
1368 __u32 flags;
1369#define I915_PERF_FLAG_FD_CLOEXEC (1<<0)
1370#define I915_PERF_FLAG_FD_NONBLOCK (1<<1)
1371#define I915_PERF_FLAG_DISABLED (1<<2)
1372
1373 /** The number of u64 (id, value) pairs */
1374 __u32 num_properties;
1375
1376 /**
1377 * Pointer to array of u64 (id, value) pairs configuring the stream
1378 * to open.
1379 */
cd8bddc4 1380 __u64 properties_ptr;
eec688e1
RB
1381};
1382
d7965152
RB
1383/**
1384 * Enable data capture for a stream that was either opened in a disabled state
1385 * via I915_PERF_FLAG_DISABLED or was later disabled via
1386 * I915_PERF_IOCTL_DISABLE.
1387 *
1388 * It is intended to be cheaper to disable and enable a stream than it may be
1389 * to close and re-open a stream with the same configuration.
1390 *
1391 * It's undefined whether any pending data for the stream will be lost.
1392 */
eec688e1 1393#define I915_PERF_IOCTL_ENABLE _IO('i', 0x0)
d7965152
RB
1394
1395/**
1396 * Disable data capture for a stream.
1397 *
1398 * It is an error to try and read a stream that is disabled.
1399 */
eec688e1
RB
1400#define I915_PERF_IOCTL_DISABLE _IO('i', 0x1)
1401
1402/**
1403 * Common to all i915 perf records
1404 */
1405struct drm_i915_perf_record_header {
1406 __u32 type;
1407 __u16 pad;
1408 __u16 size;
1409};
1410
1411enum drm_i915_perf_record_type {
1412
1413 /**
1414 * Samples are the work horse record type whose contents are extensible
1415 * and defined when opening an i915 perf stream based on the given
1416 * properties.
1417 *
1418 * Boolean properties following the naming convention
1419 * DRM_I915_PERF_SAMPLE_xyz_PROP request the inclusion of 'xyz' data in
1420 * every sample.
1421 *
1422 * The order of these sample properties given by userspace has no
d7965152 1423 * affect on the ordering of data within a sample. The order is
eec688e1
RB
1424 * documented here.
1425 *
1426 * struct {
1427 * struct drm_i915_perf_record_header header;
1428 *
d7965152 1429 * { u32 oa_report[]; } && DRM_I915_PERF_PROP_SAMPLE_OA
eec688e1
RB
1430 * };
1431 */
1432 DRM_I915_PERF_RECORD_SAMPLE = 1,
1433
d7965152
RB
1434 /*
1435 * Indicates that one or more OA reports were not written by the
1436 * hardware. This can happen for example if an MI_REPORT_PERF_COUNT
1437 * command collides with periodic sampling - which would be more likely
1438 * at higher sampling frequencies.
1439 */
1440 DRM_I915_PERF_RECORD_OA_REPORT_LOST = 2,
1441
1442 /**
1443 * An error occurred that resulted in all pending OA reports being lost.
1444 */
1445 DRM_I915_PERF_RECORD_OA_BUFFER_LOST = 3,
1446
eec688e1
RB
1447 DRM_I915_PERF_RECORD_MAX /* non-ABI */
1448};
1449
b1c1f5c4
EV
1450#if defined(__cplusplus)
1451}
1452#endif
1453
718dcedd 1454#endif /* _UAPI_I915_DRM_H_ */