xref: /openbmc/linux/include/drm/i915_drm.h (revision e6994aee)
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 _I915_DRM_H_
28 #define _I915_DRM_H_
29 
30 #include "drm.h"
31 
32 /* Please note that modifications to all structs defined here are
33  * subject to backwards-compatibility constraints.
34  */
35 
36 #ifdef __KERNEL__
37 /* For use by IPS driver */
38 extern unsigned long i915_read_mch_val(void);
39 extern bool i915_gpu_raise(void);
40 extern bool i915_gpu_lower(void);
41 extern bool i915_gpu_busy(void);
42 extern bool i915_gpu_turbo_disable(void);
43 #endif
44 
45 /* Each region is a minimum of 16k, and there are at most 255 of them.
46  */
47 #define I915_NR_TEX_REGIONS 255	/* table size 2k - maximum due to use
48 				 * of chars for next/prev indices */
49 #define I915_LOG_MIN_TEX_REGION_SIZE 14
50 
51 typedef struct _drm_i915_init {
52 	enum {
53 		I915_INIT_DMA = 0x01,
54 		I915_CLEANUP_DMA = 0x02,
55 		I915_RESUME_DMA = 0x03
56 	} func;
57 	unsigned int mmio_offset;
58 	int sarea_priv_offset;
59 	unsigned int ring_start;
60 	unsigned int ring_end;
61 	unsigned int ring_size;
62 	unsigned int front_offset;
63 	unsigned int back_offset;
64 	unsigned int depth_offset;
65 	unsigned int w;
66 	unsigned int h;
67 	unsigned int pitch;
68 	unsigned int pitch_bits;
69 	unsigned int back_pitch;
70 	unsigned int depth_pitch;
71 	unsigned int cpp;
72 	unsigned int chipset;
73 } drm_i915_init_t;
74 
75 typedef struct _drm_i915_sarea {
76 	struct drm_tex_region texList[I915_NR_TEX_REGIONS + 1];
77 	int last_upload;	/* last time texture was uploaded */
78 	int last_enqueue;	/* last time a buffer was enqueued */
79 	int last_dispatch;	/* age of the most recently dispatched buffer */
80 	int ctxOwner;		/* last context to upload state */
81 	int texAge;
82 	int pf_enabled;		/* is pageflipping allowed? */
83 	int pf_active;
84 	int pf_current_page;	/* which buffer is being displayed? */
85 	int perf_boxes;		/* performance boxes to be displayed */
86 	int width, height;      /* screen size in pixels */
87 
88 	drm_handle_t front_handle;
89 	int front_offset;
90 	int front_size;
91 
92 	drm_handle_t back_handle;
93 	int back_offset;
94 	int back_size;
95 
96 	drm_handle_t depth_handle;
97 	int depth_offset;
98 	int depth_size;
99 
100 	drm_handle_t tex_handle;
101 	int tex_offset;
102 	int tex_size;
103 	int log_tex_granularity;
104 	int pitch;
105 	int rotation;           /* 0, 90, 180 or 270 */
106 	int rotated_offset;
107 	int rotated_size;
108 	int rotated_pitch;
109 	int virtualX, virtualY;
110 
111 	unsigned int front_tiled;
112 	unsigned int back_tiled;
113 	unsigned int depth_tiled;
114 	unsigned int rotated_tiled;
115 	unsigned int rotated2_tiled;
116 
117 	int pipeA_x;
118 	int pipeA_y;
119 	int pipeA_w;
120 	int pipeA_h;
121 	int pipeB_x;
122 	int pipeB_y;
123 	int pipeB_w;
124 	int pipeB_h;
125 
126 	/* fill out some space for old userspace triple buffer */
127 	drm_handle_t unused_handle;
128 	__u32 unused1, unused2, unused3;
129 
130 	/* buffer object handles for static buffers. May change
131 	 * over the lifetime of the client.
132 	 */
133 	__u32 front_bo_handle;
134 	__u32 back_bo_handle;
135 	__u32 unused_bo_handle;
136 	__u32 depth_bo_handle;
137 
138 } drm_i915_sarea_t;
139 
140 /* due to userspace building against these headers we need some compat here */
141 #define planeA_x pipeA_x
142 #define planeA_y pipeA_y
143 #define planeA_w pipeA_w
144 #define planeA_h pipeA_h
145 #define planeB_x pipeB_x
146 #define planeB_y pipeB_y
147 #define planeB_w pipeB_w
148 #define planeB_h pipeB_h
149 
150 /* Flags for perf_boxes
151  */
152 #define I915_BOX_RING_EMPTY    0x1
153 #define I915_BOX_FLIP          0x2
154 #define I915_BOX_WAIT          0x4
155 #define I915_BOX_TEXTURE_LOAD  0x8
156 #define I915_BOX_LOST_CONTEXT  0x10
157 
158 /* I915 specific ioctls
159  * The device specific ioctl range is 0x40 to 0x79.
160  */
161 #define DRM_I915_INIT		0x00
162 #define DRM_I915_FLUSH		0x01
163 #define DRM_I915_FLIP		0x02
164 #define DRM_I915_BATCHBUFFER	0x03
165 #define DRM_I915_IRQ_EMIT	0x04
166 #define DRM_I915_IRQ_WAIT	0x05
167 #define DRM_I915_GETPARAM	0x06
168 #define DRM_I915_SETPARAM	0x07
169 #define DRM_I915_ALLOC		0x08
170 #define DRM_I915_FREE		0x09
171 #define DRM_I915_INIT_HEAP	0x0a
172 #define DRM_I915_CMDBUFFER	0x0b
173 #define DRM_I915_DESTROY_HEAP	0x0c
174 #define DRM_I915_SET_VBLANK_PIPE	0x0d
175 #define DRM_I915_GET_VBLANK_PIPE	0x0e
176 #define DRM_I915_VBLANK_SWAP	0x0f
177 #define DRM_I915_HWS_ADDR	0x11
178 #define DRM_I915_GEM_INIT	0x13
179 #define DRM_I915_GEM_EXECBUFFER	0x14
180 #define DRM_I915_GEM_PIN	0x15
181 #define DRM_I915_GEM_UNPIN	0x16
182 #define DRM_I915_GEM_BUSY	0x17
183 #define DRM_I915_GEM_THROTTLE	0x18
184 #define DRM_I915_GEM_ENTERVT	0x19
185 #define DRM_I915_GEM_LEAVEVT	0x1a
186 #define DRM_I915_GEM_CREATE	0x1b
187 #define DRM_I915_GEM_PREAD	0x1c
188 #define DRM_I915_GEM_PWRITE	0x1d
189 #define DRM_I915_GEM_MMAP	0x1e
190 #define DRM_I915_GEM_SET_DOMAIN	0x1f
191 #define DRM_I915_GEM_SW_FINISH	0x20
192 #define DRM_I915_GEM_SET_TILING	0x21
193 #define DRM_I915_GEM_GET_TILING	0x22
194 #define DRM_I915_GEM_GET_APERTURE 0x23
195 #define DRM_I915_GEM_MMAP_GTT	0x24
196 #define DRM_I915_GET_PIPE_FROM_CRTC_ID	0x25
197 #define DRM_I915_GEM_MADVISE	0x26
198 #define DRM_I915_OVERLAY_PUT_IMAGE	0x27
199 #define DRM_I915_OVERLAY_ATTRS	0x28
200 #define DRM_I915_GEM_EXECBUFFER2	0x29
201 #define DRM_I915_GET_SPRITE_COLORKEY	0x2a
202 #define DRM_I915_SET_SPRITE_COLORKEY	0x2b
203 #define DRM_I915_GEM_WAIT	0x2c
204 #define DRM_I915_GEM_CONTEXT_CREATE	0x2d
205 #define DRM_I915_GEM_CONTEXT_DESTROY	0x2e
206 #define DRM_I915_GEM_SET_CACHEING	0x2f
207 #define DRM_I915_GEM_GET_CACHEING	0x30
208 #define DRM_I915_REG_READ		0x31
209 
210 #define DRM_IOCTL_I915_INIT		DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT, drm_i915_init_t)
211 #define DRM_IOCTL_I915_FLUSH		DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLUSH)
212 #define DRM_IOCTL_I915_FLIP		DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLIP)
213 #define DRM_IOCTL_I915_BATCHBUFFER	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_BATCHBUFFER, drm_i915_batchbuffer_t)
214 #define DRM_IOCTL_I915_IRQ_EMIT         DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_IRQ_EMIT, drm_i915_irq_emit_t)
215 #define DRM_IOCTL_I915_IRQ_WAIT         DRM_IOW( DRM_COMMAND_BASE + DRM_I915_IRQ_WAIT, drm_i915_irq_wait_t)
216 #define DRM_IOCTL_I915_GETPARAM         DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GETPARAM, drm_i915_getparam_t)
217 #define DRM_IOCTL_I915_SETPARAM         DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SETPARAM, drm_i915_setparam_t)
218 #define DRM_IOCTL_I915_ALLOC            DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_ALLOC, drm_i915_mem_alloc_t)
219 #define DRM_IOCTL_I915_FREE             DRM_IOW( DRM_COMMAND_BASE + DRM_I915_FREE, drm_i915_mem_free_t)
220 #define DRM_IOCTL_I915_INIT_HEAP        DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT_HEAP, drm_i915_mem_init_heap_t)
221 #define DRM_IOCTL_I915_CMDBUFFER	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_CMDBUFFER, drm_i915_cmdbuffer_t)
222 #define DRM_IOCTL_I915_DESTROY_HEAP	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_DESTROY_HEAP, drm_i915_mem_destroy_heap_t)
223 #define DRM_IOCTL_I915_SET_VBLANK_PIPE	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
224 #define DRM_IOCTL_I915_GET_VBLANK_PIPE	DRM_IOR( DRM_COMMAND_BASE + DRM_I915_GET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
225 #define DRM_IOCTL_I915_VBLANK_SWAP	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_VBLANK_SWAP, drm_i915_vblank_swap_t)
226 #define DRM_IOCTL_I915_HWS_ADDR		DRM_IOW(DRM_COMMAND_BASE + DRM_I915_HWS_ADDR, struct drm_i915_gem_init)
227 #define DRM_IOCTL_I915_GEM_INIT		DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_INIT, struct drm_i915_gem_init)
228 #define DRM_IOCTL_I915_GEM_EXECBUFFER	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER, struct drm_i915_gem_execbuffer)
229 #define DRM_IOCTL_I915_GEM_EXECBUFFER2	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER2, struct drm_i915_gem_execbuffer2)
230 #define DRM_IOCTL_I915_GEM_PIN		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_PIN, struct drm_i915_gem_pin)
231 #define DRM_IOCTL_I915_GEM_UNPIN	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_UNPIN, struct drm_i915_gem_unpin)
232 #define DRM_IOCTL_I915_GEM_BUSY		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_BUSY, struct drm_i915_gem_busy)
233 #define DRM_IOCTL_I915_GEM_SET_CACHEING		DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_SET_CACHEING, struct drm_i915_gem_cacheing)
234 #define DRM_IOCTL_I915_GEM_GET_CACHEING		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_GET_CACHEING, struct drm_i915_gem_cacheing)
235 #define DRM_IOCTL_I915_GEM_THROTTLE	DRM_IO ( DRM_COMMAND_BASE + DRM_I915_GEM_THROTTLE)
236 #define DRM_IOCTL_I915_GEM_ENTERVT	DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_ENTERVT)
237 #define DRM_IOCTL_I915_GEM_LEAVEVT	DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_LEAVEVT)
238 #define DRM_IOCTL_I915_GEM_CREATE	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_CREATE, struct drm_i915_gem_create)
239 #define DRM_IOCTL_I915_GEM_PREAD	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PREAD, struct drm_i915_gem_pread)
240 #define DRM_IOCTL_I915_GEM_PWRITE	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PWRITE, struct drm_i915_gem_pwrite)
241 #define DRM_IOCTL_I915_GEM_MMAP		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP, struct drm_i915_gem_mmap)
242 #define DRM_IOCTL_I915_GEM_MMAP_GTT	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP_GTT, struct drm_i915_gem_mmap_gtt)
243 #define DRM_IOCTL_I915_GEM_SET_DOMAIN	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SET_DOMAIN, struct drm_i915_gem_set_domain)
244 #define DRM_IOCTL_I915_GEM_SW_FINISH	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SW_FINISH, struct drm_i915_gem_sw_finish)
245 #define DRM_IOCTL_I915_GEM_SET_TILING	DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_SET_TILING, struct drm_i915_gem_set_tiling)
246 #define DRM_IOCTL_I915_GEM_GET_TILING	DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_GET_TILING, struct drm_i915_gem_get_tiling)
247 #define DRM_IOCTL_I915_GEM_GET_APERTURE	DRM_IOR  (DRM_COMMAND_BASE + DRM_I915_GEM_GET_APERTURE, struct drm_i915_gem_get_aperture)
248 #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)
249 #define DRM_IOCTL_I915_GEM_MADVISE	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MADVISE, struct drm_i915_gem_madvise)
250 #define DRM_IOCTL_I915_OVERLAY_PUT_IMAGE	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_OVERLAY_PUT_IMAGE, struct drm_intel_overlay_put_image)
251 #define DRM_IOCTL_I915_OVERLAY_ATTRS	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_OVERLAY_ATTRS, struct drm_intel_overlay_attrs)
252 #define DRM_IOCTL_I915_SET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_SET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
253 #define DRM_IOCTL_I915_GET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_SET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
254 #define DRM_IOCTL_I915_GEM_WAIT		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_WAIT, struct drm_i915_gem_wait)
255 #define DRM_IOCTL_I915_GEM_CONTEXT_CREATE	DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_CREATE, struct drm_i915_gem_context_create)
256 #define DRM_IOCTL_I915_GEM_CONTEXT_DESTROY	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_CONTEXT_DESTROY, struct drm_i915_gem_context_destroy)
257 #define DRM_IOCTL_I915_REG_READ			DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_REG_READ, struct drm_i915_reg_read)
258 
259 /* Allow drivers to submit batchbuffers directly to hardware, relying
260  * on the security mechanisms provided by hardware.
261  */
262 typedef struct drm_i915_batchbuffer {
263 	int start;		/* agp offset */
264 	int used;		/* nr bytes in use */
265 	int DR1;		/* hw flags for GFX_OP_DRAWRECT_INFO */
266 	int DR4;		/* window origin for GFX_OP_DRAWRECT_INFO */
267 	int num_cliprects;	/* mulitpass with multiple cliprects? */
268 	struct drm_clip_rect __user *cliprects;	/* pointer to userspace cliprects */
269 } drm_i915_batchbuffer_t;
270 
271 /* As above, but pass a pointer to userspace buffer which can be
272  * validated by the kernel prior to sending to hardware.
273  */
274 typedef struct _drm_i915_cmdbuffer {
275 	char __user *buf;	/* pointer to userspace command buffer */
276 	int sz;			/* nr bytes in buf */
277 	int DR1;		/* hw flags for GFX_OP_DRAWRECT_INFO */
278 	int DR4;		/* window origin for GFX_OP_DRAWRECT_INFO */
279 	int num_cliprects;	/* mulitpass with multiple cliprects? */
280 	struct drm_clip_rect __user *cliprects;	/* pointer to userspace cliprects */
281 } drm_i915_cmdbuffer_t;
282 
283 /* Userspace can request & wait on irq's:
284  */
285 typedef struct drm_i915_irq_emit {
286 	int __user *irq_seq;
287 } drm_i915_irq_emit_t;
288 
289 typedef struct drm_i915_irq_wait {
290 	int irq_seq;
291 } drm_i915_irq_wait_t;
292 
293 /* Ioctl to query kernel params:
294  */
295 #define I915_PARAM_IRQ_ACTIVE            1
296 #define I915_PARAM_ALLOW_BATCHBUFFER     2
297 #define I915_PARAM_LAST_DISPATCH         3
298 #define I915_PARAM_CHIPSET_ID            4
299 #define I915_PARAM_HAS_GEM               5
300 #define I915_PARAM_NUM_FENCES_AVAIL      6
301 #define I915_PARAM_HAS_OVERLAY           7
302 #define I915_PARAM_HAS_PAGEFLIPPING	 8
303 #define I915_PARAM_HAS_EXECBUF2          9
304 #define I915_PARAM_HAS_BSD		 10
305 #define I915_PARAM_HAS_BLT		 11
306 #define I915_PARAM_HAS_RELAXED_FENCING	 12
307 #define I915_PARAM_HAS_COHERENT_RINGS	 13
308 #define I915_PARAM_HAS_EXEC_CONSTANTS	 14
309 #define I915_PARAM_HAS_RELAXED_DELTA	 15
310 #define I915_PARAM_HAS_GEN7_SOL_RESET	 16
311 #define I915_PARAM_HAS_LLC     	 	 17
312 #define I915_PARAM_HAS_ALIASING_PPGTT	 18
313 #define I915_PARAM_HAS_WAIT_TIMEOUT	 19
314 
315 typedef struct drm_i915_getparam {
316 	int param;
317 	int __user *value;
318 } drm_i915_getparam_t;
319 
320 /* Ioctl to set kernel params:
321  */
322 #define I915_SETPARAM_USE_MI_BATCHBUFFER_START            1
323 #define I915_SETPARAM_TEX_LRU_LOG_GRANULARITY             2
324 #define I915_SETPARAM_ALLOW_BATCHBUFFER                   3
325 #define I915_SETPARAM_NUM_USED_FENCES                     4
326 
327 typedef struct drm_i915_setparam {
328 	int param;
329 	int value;
330 } drm_i915_setparam_t;
331 
332 /* A memory manager for regions of shared memory:
333  */
334 #define I915_MEM_REGION_AGP 1
335 
336 typedef struct drm_i915_mem_alloc {
337 	int region;
338 	int alignment;
339 	int size;
340 	int __user *region_offset;	/* offset from start of fb or agp */
341 } drm_i915_mem_alloc_t;
342 
343 typedef struct drm_i915_mem_free {
344 	int region;
345 	int region_offset;
346 } drm_i915_mem_free_t;
347 
348 typedef struct drm_i915_mem_init_heap {
349 	int region;
350 	int size;
351 	int start;
352 } drm_i915_mem_init_heap_t;
353 
354 /* Allow memory manager to be torn down and re-initialized (eg on
355  * rotate):
356  */
357 typedef struct drm_i915_mem_destroy_heap {
358 	int region;
359 } drm_i915_mem_destroy_heap_t;
360 
361 /* Allow X server to configure which pipes to monitor for vblank signals
362  */
363 #define	DRM_I915_VBLANK_PIPE_A	1
364 #define	DRM_I915_VBLANK_PIPE_B	2
365 
366 typedef struct drm_i915_vblank_pipe {
367 	int pipe;
368 } drm_i915_vblank_pipe_t;
369 
370 /* Schedule buffer swap at given vertical blank:
371  */
372 typedef struct drm_i915_vblank_swap {
373 	drm_drawable_t drawable;
374 	enum drm_vblank_seq_type seqtype;
375 	unsigned int sequence;
376 } drm_i915_vblank_swap_t;
377 
378 typedef struct drm_i915_hws_addr {
379 	__u64 addr;
380 } drm_i915_hws_addr_t;
381 
382 struct drm_i915_gem_init {
383 	/**
384 	 * Beginning offset in the GTT to be managed by the DRM memory
385 	 * manager.
386 	 */
387 	__u64 gtt_start;
388 	/**
389 	 * Ending offset in the GTT to be managed by the DRM memory
390 	 * manager.
391 	 */
392 	__u64 gtt_end;
393 };
394 
395 struct drm_i915_gem_create {
396 	/**
397 	 * Requested size for the object.
398 	 *
399 	 * The (page-aligned) allocated size for the object will be returned.
400 	 */
401 	__u64 size;
402 	/**
403 	 * Returned handle for the object.
404 	 *
405 	 * Object handles are nonzero.
406 	 */
407 	__u32 handle;
408 	__u32 pad;
409 };
410 
411 struct drm_i915_gem_pread {
412 	/** Handle for the object being read. */
413 	__u32 handle;
414 	__u32 pad;
415 	/** Offset into the object to read from */
416 	__u64 offset;
417 	/** Length of data to read */
418 	__u64 size;
419 	/**
420 	 * Pointer to write the data into.
421 	 *
422 	 * This is a fixed-size type for 32/64 compatibility.
423 	 */
424 	__u64 data_ptr;
425 };
426 
427 struct drm_i915_gem_pwrite {
428 	/** Handle for the object being written to. */
429 	__u32 handle;
430 	__u32 pad;
431 	/** Offset into the object to write to */
432 	__u64 offset;
433 	/** Length of data to write */
434 	__u64 size;
435 	/**
436 	 * Pointer to read the data from.
437 	 *
438 	 * This is a fixed-size type for 32/64 compatibility.
439 	 */
440 	__u64 data_ptr;
441 };
442 
443 struct drm_i915_gem_mmap {
444 	/** Handle for the object being mapped. */
445 	__u32 handle;
446 	__u32 pad;
447 	/** Offset in the object to map. */
448 	__u64 offset;
449 	/**
450 	 * Length of data to map.
451 	 *
452 	 * The value will be page-aligned.
453 	 */
454 	__u64 size;
455 	/**
456 	 * Returned pointer the data was mapped at.
457 	 *
458 	 * This is a fixed-size type for 32/64 compatibility.
459 	 */
460 	__u64 addr_ptr;
461 };
462 
463 struct drm_i915_gem_mmap_gtt {
464 	/** Handle for the object being mapped. */
465 	__u32 handle;
466 	__u32 pad;
467 	/**
468 	 * Fake offset to use for subsequent mmap call
469 	 *
470 	 * This is a fixed-size type for 32/64 compatibility.
471 	 */
472 	__u64 offset;
473 };
474 
475 struct drm_i915_gem_set_domain {
476 	/** Handle for the object */
477 	__u32 handle;
478 
479 	/** New read domains */
480 	__u32 read_domains;
481 
482 	/** New write domain */
483 	__u32 write_domain;
484 };
485 
486 struct drm_i915_gem_sw_finish {
487 	/** Handle for the object */
488 	__u32 handle;
489 };
490 
491 struct drm_i915_gem_relocation_entry {
492 	/**
493 	 * Handle of the buffer being pointed to by this relocation entry.
494 	 *
495 	 * It's appealing to make this be an index into the mm_validate_entry
496 	 * list to refer to the buffer, but this allows the driver to create
497 	 * a relocation list for state buffers and not re-write it per
498 	 * exec using the buffer.
499 	 */
500 	__u32 target_handle;
501 
502 	/**
503 	 * Value to be added to the offset of the target buffer to make up
504 	 * the relocation entry.
505 	 */
506 	__u32 delta;
507 
508 	/** Offset in the buffer the relocation entry will be written into */
509 	__u64 offset;
510 
511 	/**
512 	 * Offset value of the target buffer that the relocation entry was last
513 	 * written as.
514 	 *
515 	 * If the buffer has the same offset as last time, we can skip syncing
516 	 * and writing the relocation.  This value is written back out by
517 	 * the execbuffer ioctl when the relocation is written.
518 	 */
519 	__u64 presumed_offset;
520 
521 	/**
522 	 * Target memory domains read by this operation.
523 	 */
524 	__u32 read_domains;
525 
526 	/**
527 	 * Target memory domains written by this operation.
528 	 *
529 	 * Note that only one domain may be written by the whole
530 	 * execbuffer operation, so that where there are conflicts,
531 	 * the application will get -EINVAL back.
532 	 */
533 	__u32 write_domain;
534 };
535 
536 /** @{
537  * Intel memory domains
538  *
539  * Most of these just align with the various caches in
540  * the system and are used to flush and invalidate as
541  * objects end up cached in different domains.
542  */
543 /** CPU cache */
544 #define I915_GEM_DOMAIN_CPU		0x00000001
545 /** Render cache, used by 2D and 3D drawing */
546 #define I915_GEM_DOMAIN_RENDER		0x00000002
547 /** Sampler cache, used by texture engine */
548 #define I915_GEM_DOMAIN_SAMPLER		0x00000004
549 /** Command queue, used to load batch buffers */
550 #define I915_GEM_DOMAIN_COMMAND		0x00000008
551 /** Instruction cache, used by shader programs */
552 #define I915_GEM_DOMAIN_INSTRUCTION	0x00000010
553 /** Vertex address cache */
554 #define I915_GEM_DOMAIN_VERTEX		0x00000020
555 /** GTT domain - aperture and scanout */
556 #define I915_GEM_DOMAIN_GTT		0x00000040
557 /** @} */
558 
559 struct drm_i915_gem_exec_object {
560 	/**
561 	 * User's handle for a buffer to be bound into the GTT for this
562 	 * operation.
563 	 */
564 	__u32 handle;
565 
566 	/** Number of relocations to be performed on this buffer */
567 	__u32 relocation_count;
568 	/**
569 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
570 	 * the relocations to be performed in this buffer.
571 	 */
572 	__u64 relocs_ptr;
573 
574 	/** Required alignment in graphics aperture */
575 	__u64 alignment;
576 
577 	/**
578 	 * Returned value of the updated offset of the object, for future
579 	 * presumed_offset writes.
580 	 */
581 	__u64 offset;
582 };
583 
584 struct drm_i915_gem_execbuffer {
585 	/**
586 	 * List of buffers to be validated with their relocations to be
587 	 * performend on them.
588 	 *
589 	 * This is a pointer to an array of struct drm_i915_gem_validate_entry.
590 	 *
591 	 * These buffers must be listed in an order such that all relocations
592 	 * a buffer is performing refer to buffers that have already appeared
593 	 * in the validate list.
594 	 */
595 	__u64 buffers_ptr;
596 	__u32 buffer_count;
597 
598 	/** Offset in the batchbuffer to start execution from. */
599 	__u32 batch_start_offset;
600 	/** Bytes used in batchbuffer from batch_start_offset */
601 	__u32 batch_len;
602 	__u32 DR1;
603 	__u32 DR4;
604 	__u32 num_cliprects;
605 	/** This is a struct drm_clip_rect *cliprects */
606 	__u64 cliprects_ptr;
607 };
608 
609 struct drm_i915_gem_exec_object2 {
610 	/**
611 	 * User's handle for a buffer to be bound into the GTT for this
612 	 * operation.
613 	 */
614 	__u32 handle;
615 
616 	/** Number of relocations to be performed on this buffer */
617 	__u32 relocation_count;
618 	/**
619 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
620 	 * the relocations to be performed in this buffer.
621 	 */
622 	__u64 relocs_ptr;
623 
624 	/** Required alignment in graphics aperture */
625 	__u64 alignment;
626 
627 	/**
628 	 * Returned value of the updated offset of the object, for future
629 	 * presumed_offset writes.
630 	 */
631 	__u64 offset;
632 
633 #define EXEC_OBJECT_NEEDS_FENCE (1<<0)
634 	__u64 flags;
635 	__u64 rsvd1;
636 	__u64 rsvd2;
637 };
638 
639 struct drm_i915_gem_execbuffer2 {
640 	/**
641 	 * List of gem_exec_object2 structs
642 	 */
643 	__u64 buffers_ptr;
644 	__u32 buffer_count;
645 
646 	/** Offset in the batchbuffer to start execution from. */
647 	__u32 batch_start_offset;
648 	/** Bytes used in batchbuffer from batch_start_offset */
649 	__u32 batch_len;
650 	__u32 DR1;
651 	__u32 DR4;
652 	__u32 num_cliprects;
653 	/** This is a struct drm_clip_rect *cliprects */
654 	__u64 cliprects_ptr;
655 #define I915_EXEC_RING_MASK              (7<<0)
656 #define I915_EXEC_DEFAULT                (0<<0)
657 #define I915_EXEC_RENDER                 (1<<0)
658 #define I915_EXEC_BSD                    (2<<0)
659 #define I915_EXEC_BLT                    (3<<0)
660 
661 /* Used for switching the constants addressing mode on gen4+ RENDER ring.
662  * Gen6+ only supports relative addressing to dynamic state (default) and
663  * absolute addressing.
664  *
665  * These flags are ignored for the BSD and BLT rings.
666  */
667 #define I915_EXEC_CONSTANTS_MASK 	(3<<6)
668 #define I915_EXEC_CONSTANTS_REL_GENERAL (0<<6) /* default */
669 #define I915_EXEC_CONSTANTS_ABSOLUTE 	(1<<6)
670 #define I915_EXEC_CONSTANTS_REL_SURFACE (2<<6) /* gen4/5 only */
671 	__u64 flags;
672 	__u64 rsvd1; /* now used for context info */
673 	__u64 rsvd2;
674 };
675 
676 /** Resets the SO write offset registers for transform feedback on gen7. */
677 #define I915_EXEC_GEN7_SOL_RESET	(1<<8)
678 
679 #define I915_EXEC_CONTEXT_ID_MASK	(0xffffffff)
680 #define i915_execbuffer2_set_context_id(eb2, context) \
681 	(eb2).rsvd1 = context & I915_EXEC_CONTEXT_ID_MASK
682 #define i915_execbuffer2_get_context_id(eb2) \
683 	((eb2).rsvd1 & I915_EXEC_CONTEXT_ID_MASK)
684 
685 struct drm_i915_gem_pin {
686 	/** Handle of the buffer to be pinned. */
687 	__u32 handle;
688 	__u32 pad;
689 
690 	/** alignment required within the aperture */
691 	__u64 alignment;
692 
693 	/** Returned GTT offset of the buffer. */
694 	__u64 offset;
695 };
696 
697 struct drm_i915_gem_unpin {
698 	/** Handle of the buffer to be unpinned. */
699 	__u32 handle;
700 	__u32 pad;
701 };
702 
703 struct drm_i915_gem_busy {
704 	/** Handle of the buffer to check for busy */
705 	__u32 handle;
706 
707 	/** Return busy status (1 if busy, 0 if idle).
708 	 * The high word is used to indicate on which rings the object
709 	 * currently resides:
710 	 *  16:31 - busy (r or r/w) rings (16 render, 17 bsd, 18 blt, etc)
711 	 */
712 	__u32 busy;
713 };
714 
715 #define I915_CACHEING_NONE		0
716 #define I915_CACHEING_CACHED		1
717 
718 struct drm_i915_gem_cacheing {
719 	/**
720 	 * Handle of the buffer to set/get the cacheing level of. */
721 	__u32 handle;
722 
723 	/**
724 	 * Cacheing level to apply or return value
725 	 *
726 	 * bits0-15 are for generic cacheing control (i.e. the above defined
727 	 * values). bits16-31 are reserved for platform-specific variations
728 	 * (e.g. l3$ caching on gen7). */
729 	__u32 cacheing;
730 };
731 
732 #define I915_TILING_NONE	0
733 #define I915_TILING_X		1
734 #define I915_TILING_Y		2
735 
736 #define I915_BIT_6_SWIZZLE_NONE		0
737 #define I915_BIT_6_SWIZZLE_9		1
738 #define I915_BIT_6_SWIZZLE_9_10		2
739 #define I915_BIT_6_SWIZZLE_9_11		3
740 #define I915_BIT_6_SWIZZLE_9_10_11	4
741 /* Not seen by userland */
742 #define I915_BIT_6_SWIZZLE_UNKNOWN	5
743 /* Seen by userland. */
744 #define I915_BIT_6_SWIZZLE_9_17		6
745 #define I915_BIT_6_SWIZZLE_9_10_17	7
746 
747 struct drm_i915_gem_set_tiling {
748 	/** Handle of the buffer to have its tiling state updated */
749 	__u32 handle;
750 
751 	/**
752 	 * Tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
753 	 * I915_TILING_Y).
754 	 *
755 	 * This value is to be set on request, and will be updated by the
756 	 * kernel on successful return with the actual chosen tiling layout.
757 	 *
758 	 * The tiling mode may be demoted to I915_TILING_NONE when the system
759 	 * has bit 6 swizzling that can't be managed correctly by GEM.
760 	 *
761 	 * Buffer contents become undefined when changing tiling_mode.
762 	 */
763 	__u32 tiling_mode;
764 
765 	/**
766 	 * Stride in bytes for the object when in I915_TILING_X or
767 	 * I915_TILING_Y.
768 	 */
769 	__u32 stride;
770 
771 	/**
772 	 * Returned address bit 6 swizzling required for CPU access through
773 	 * mmap mapping.
774 	 */
775 	__u32 swizzle_mode;
776 };
777 
778 struct drm_i915_gem_get_tiling {
779 	/** Handle of the buffer to get tiling state for. */
780 	__u32 handle;
781 
782 	/**
783 	 * Current tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
784 	 * I915_TILING_Y).
785 	 */
786 	__u32 tiling_mode;
787 
788 	/**
789 	 * Returned address bit 6 swizzling required for CPU access through
790 	 * mmap mapping.
791 	 */
792 	__u32 swizzle_mode;
793 };
794 
795 struct drm_i915_gem_get_aperture {
796 	/** Total size of the aperture used by i915_gem_execbuffer, in bytes */
797 	__u64 aper_size;
798 
799 	/**
800 	 * Available space in the aperture used by i915_gem_execbuffer, in
801 	 * bytes
802 	 */
803 	__u64 aper_available_size;
804 };
805 
806 struct drm_i915_get_pipe_from_crtc_id {
807 	/** ID of CRTC being requested **/
808 	__u32 crtc_id;
809 
810 	/** pipe of requested CRTC **/
811 	__u32 pipe;
812 };
813 
814 #define I915_MADV_WILLNEED 0
815 #define I915_MADV_DONTNEED 1
816 #define __I915_MADV_PURGED 2 /* internal state */
817 
818 struct drm_i915_gem_madvise {
819 	/** Handle of the buffer to change the backing store advice */
820 	__u32 handle;
821 
822 	/* Advice: either the buffer will be needed again in the near future,
823 	 *         or wont be and could be discarded under memory pressure.
824 	 */
825 	__u32 madv;
826 
827 	/** Whether the backing store still exists. */
828 	__u32 retained;
829 };
830 
831 /* flags */
832 #define I915_OVERLAY_TYPE_MASK 		0xff
833 #define I915_OVERLAY_YUV_PLANAR 	0x01
834 #define I915_OVERLAY_YUV_PACKED 	0x02
835 #define I915_OVERLAY_RGB		0x03
836 
837 #define I915_OVERLAY_DEPTH_MASK		0xff00
838 #define I915_OVERLAY_RGB24		0x1000
839 #define I915_OVERLAY_RGB16		0x2000
840 #define I915_OVERLAY_RGB15		0x3000
841 #define I915_OVERLAY_YUV422		0x0100
842 #define I915_OVERLAY_YUV411		0x0200
843 #define I915_OVERLAY_YUV420		0x0300
844 #define I915_OVERLAY_YUV410		0x0400
845 
846 #define I915_OVERLAY_SWAP_MASK		0xff0000
847 #define I915_OVERLAY_NO_SWAP		0x000000
848 #define I915_OVERLAY_UV_SWAP		0x010000
849 #define I915_OVERLAY_Y_SWAP		0x020000
850 #define I915_OVERLAY_Y_AND_UV_SWAP	0x030000
851 
852 #define I915_OVERLAY_FLAGS_MASK		0xff000000
853 #define I915_OVERLAY_ENABLE		0x01000000
854 
855 struct drm_intel_overlay_put_image {
856 	/* various flags and src format description */
857 	__u32 flags;
858 	/* source picture description */
859 	__u32 bo_handle;
860 	/* stride values and offsets are in bytes, buffer relative */
861 	__u16 stride_Y; /* stride for packed formats */
862 	__u16 stride_UV;
863 	__u32 offset_Y; /* offset for packet formats */
864 	__u32 offset_U;
865 	__u32 offset_V;
866 	/* in pixels */
867 	__u16 src_width;
868 	__u16 src_height;
869 	/* to compensate the scaling factors for partially covered surfaces */
870 	__u16 src_scan_width;
871 	__u16 src_scan_height;
872 	/* output crtc description */
873 	__u32 crtc_id;
874 	__u16 dst_x;
875 	__u16 dst_y;
876 	__u16 dst_width;
877 	__u16 dst_height;
878 };
879 
880 /* flags */
881 #define I915_OVERLAY_UPDATE_ATTRS	(1<<0)
882 #define I915_OVERLAY_UPDATE_GAMMA	(1<<1)
883 struct drm_intel_overlay_attrs {
884 	__u32 flags;
885 	__u32 color_key;
886 	__s32 brightness;
887 	__u32 contrast;
888 	__u32 saturation;
889 	__u32 gamma0;
890 	__u32 gamma1;
891 	__u32 gamma2;
892 	__u32 gamma3;
893 	__u32 gamma4;
894 	__u32 gamma5;
895 };
896 
897 /*
898  * Intel sprite handling
899  *
900  * Color keying works with a min/mask/max tuple.  Both source and destination
901  * color keying is allowed.
902  *
903  * Source keying:
904  * Sprite pixels within the min & max values, masked against the color channels
905  * specified in the mask field, will be transparent.  All other pixels will
906  * be displayed on top of the primary plane.  For RGB surfaces, only the min
907  * and mask fields will be used; ranged compares are not allowed.
908  *
909  * Destination keying:
910  * Primary plane pixels that match the min value, masked against the color
911  * channels specified in the mask field, will be replaced by corresponding
912  * pixels from the sprite plane.
913  *
914  * Note that source & destination keying are exclusive; only one can be
915  * active on a given plane.
916  */
917 
918 #define I915_SET_COLORKEY_NONE		(1<<0) /* disable color key matching */
919 #define I915_SET_COLORKEY_DESTINATION	(1<<1)
920 #define I915_SET_COLORKEY_SOURCE	(1<<2)
921 struct drm_intel_sprite_colorkey {
922 	__u32 plane_id;
923 	__u32 min_value;
924 	__u32 channel_mask;
925 	__u32 max_value;
926 	__u32 flags;
927 };
928 
929 struct drm_i915_gem_wait {
930 	/** Handle of BO we shall wait on */
931 	__u32 bo_handle;
932 	__u32 flags;
933 	/** Number of nanoseconds to wait, Returns time remaining. */
934 	__s64 timeout_ns;
935 };
936 
937 struct drm_i915_gem_context_create {
938 	/*  output: id of new context*/
939 	__u32 ctx_id;
940 	__u32 pad;
941 };
942 
943 struct drm_i915_gem_context_destroy {
944 	__u32 ctx_id;
945 	__u32 pad;
946 };
947 
948 struct drm_i915_reg_read {
949 	__u64 offset;
950 	__u64 val; /* Return value */
951 };
952 #endif				/* _I915_DRM_H_ */
953