xref: /openbmc/linux/include/drm/i915_drm.h (revision 8ea30864)
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 
204 #define DRM_IOCTL_I915_INIT		DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT, drm_i915_init_t)
205 #define DRM_IOCTL_I915_FLUSH		DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLUSH)
206 #define DRM_IOCTL_I915_FLIP		DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLIP)
207 #define DRM_IOCTL_I915_BATCHBUFFER	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_BATCHBUFFER, drm_i915_batchbuffer_t)
208 #define DRM_IOCTL_I915_IRQ_EMIT         DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_IRQ_EMIT, drm_i915_irq_emit_t)
209 #define DRM_IOCTL_I915_IRQ_WAIT         DRM_IOW( DRM_COMMAND_BASE + DRM_I915_IRQ_WAIT, drm_i915_irq_wait_t)
210 #define DRM_IOCTL_I915_GETPARAM         DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GETPARAM, drm_i915_getparam_t)
211 #define DRM_IOCTL_I915_SETPARAM         DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SETPARAM, drm_i915_setparam_t)
212 #define DRM_IOCTL_I915_ALLOC            DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_ALLOC, drm_i915_mem_alloc_t)
213 #define DRM_IOCTL_I915_FREE             DRM_IOW( DRM_COMMAND_BASE + DRM_I915_FREE, drm_i915_mem_free_t)
214 #define DRM_IOCTL_I915_INIT_HEAP        DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT_HEAP, drm_i915_mem_init_heap_t)
215 #define DRM_IOCTL_I915_CMDBUFFER	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_CMDBUFFER, drm_i915_cmdbuffer_t)
216 #define DRM_IOCTL_I915_DESTROY_HEAP	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_DESTROY_HEAP, drm_i915_mem_destroy_heap_t)
217 #define DRM_IOCTL_I915_SET_VBLANK_PIPE	DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
218 #define DRM_IOCTL_I915_GET_VBLANK_PIPE	DRM_IOR( DRM_COMMAND_BASE + DRM_I915_GET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
219 #define DRM_IOCTL_I915_VBLANK_SWAP	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_VBLANK_SWAP, drm_i915_vblank_swap_t)
220 #define DRM_IOCTL_I915_HWS_ADDR		DRM_IOW(DRM_COMMAND_BASE + DRM_I915_HWS_ADDR, struct drm_i915_gem_init)
221 #define DRM_IOCTL_I915_GEM_INIT		DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_INIT, struct drm_i915_gem_init)
222 #define DRM_IOCTL_I915_GEM_EXECBUFFER	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER, struct drm_i915_gem_execbuffer)
223 #define DRM_IOCTL_I915_GEM_EXECBUFFER2	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_EXECBUFFER2, struct drm_i915_gem_execbuffer2)
224 #define DRM_IOCTL_I915_GEM_PIN		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_PIN, struct drm_i915_gem_pin)
225 #define DRM_IOCTL_I915_GEM_UNPIN	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_UNPIN, struct drm_i915_gem_unpin)
226 #define DRM_IOCTL_I915_GEM_BUSY		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_BUSY, struct drm_i915_gem_busy)
227 #define DRM_IOCTL_I915_GEM_THROTTLE	DRM_IO ( DRM_COMMAND_BASE + DRM_I915_GEM_THROTTLE)
228 #define DRM_IOCTL_I915_GEM_ENTERVT	DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_ENTERVT)
229 #define DRM_IOCTL_I915_GEM_LEAVEVT	DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_LEAVEVT)
230 #define DRM_IOCTL_I915_GEM_CREATE	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_CREATE, struct drm_i915_gem_create)
231 #define DRM_IOCTL_I915_GEM_PREAD	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PREAD, struct drm_i915_gem_pread)
232 #define DRM_IOCTL_I915_GEM_PWRITE	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PWRITE, struct drm_i915_gem_pwrite)
233 #define DRM_IOCTL_I915_GEM_MMAP		DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP, struct drm_i915_gem_mmap)
234 #define DRM_IOCTL_I915_GEM_MMAP_GTT	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP_GTT, struct drm_i915_gem_mmap_gtt)
235 #define DRM_IOCTL_I915_GEM_SET_DOMAIN	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SET_DOMAIN, struct drm_i915_gem_set_domain)
236 #define DRM_IOCTL_I915_GEM_SW_FINISH	DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SW_FINISH, struct drm_i915_gem_sw_finish)
237 #define DRM_IOCTL_I915_GEM_SET_TILING	DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_SET_TILING, struct drm_i915_gem_set_tiling)
238 #define DRM_IOCTL_I915_GEM_GET_TILING	DRM_IOWR (DRM_COMMAND_BASE + DRM_I915_GEM_GET_TILING, struct drm_i915_gem_get_tiling)
239 #define DRM_IOCTL_I915_GEM_GET_APERTURE	DRM_IOR  (DRM_COMMAND_BASE + DRM_I915_GEM_GET_APERTURE, struct drm_i915_gem_get_aperture)
240 #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)
241 #define DRM_IOCTL_I915_GEM_MADVISE	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MADVISE, struct drm_i915_gem_madvise)
242 #define DRM_IOCTL_I915_OVERLAY_PUT_IMAGE	DRM_IOW(DRM_COMMAND_BASE + DRM_I915_OVERLAY_PUT_IMAGE, struct drm_intel_overlay_put_image)
243 #define DRM_IOCTL_I915_OVERLAY_ATTRS	DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_OVERLAY_ATTRS, struct drm_intel_overlay_attrs)
244 #define DRM_IOCTL_I915_SET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_SET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
245 #define DRM_IOCTL_I915_GET_SPRITE_COLORKEY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_SET_SPRITE_COLORKEY, struct drm_intel_sprite_colorkey)
246 
247 /* Allow drivers to submit batchbuffers directly to hardware, relying
248  * on the security mechanisms provided by hardware.
249  */
250 typedef struct drm_i915_batchbuffer {
251 	int start;		/* agp offset */
252 	int used;		/* nr bytes in use */
253 	int DR1;		/* hw flags for GFX_OP_DRAWRECT_INFO */
254 	int DR4;		/* window origin for GFX_OP_DRAWRECT_INFO */
255 	int num_cliprects;	/* mulitpass with multiple cliprects? */
256 	struct drm_clip_rect __user *cliprects;	/* pointer to userspace cliprects */
257 } drm_i915_batchbuffer_t;
258 
259 /* As above, but pass a pointer to userspace buffer which can be
260  * validated by the kernel prior to sending to hardware.
261  */
262 typedef struct _drm_i915_cmdbuffer {
263 	char __user *buf;	/* pointer to userspace command buffer */
264 	int sz;			/* nr bytes in buf */
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_cmdbuffer_t;
270 
271 /* Userspace can request & wait on irq's:
272  */
273 typedef struct drm_i915_irq_emit {
274 	int __user *irq_seq;
275 } drm_i915_irq_emit_t;
276 
277 typedef struct drm_i915_irq_wait {
278 	int irq_seq;
279 } drm_i915_irq_wait_t;
280 
281 /* Ioctl to query kernel params:
282  */
283 #define I915_PARAM_IRQ_ACTIVE            1
284 #define I915_PARAM_ALLOW_BATCHBUFFER     2
285 #define I915_PARAM_LAST_DISPATCH         3
286 #define I915_PARAM_CHIPSET_ID            4
287 #define I915_PARAM_HAS_GEM               5
288 #define I915_PARAM_NUM_FENCES_AVAIL      6
289 #define I915_PARAM_HAS_OVERLAY           7
290 #define I915_PARAM_HAS_PAGEFLIPPING	 8
291 #define I915_PARAM_HAS_EXECBUF2          9
292 #define I915_PARAM_HAS_BSD		 10
293 #define I915_PARAM_HAS_BLT		 11
294 #define I915_PARAM_HAS_RELAXED_FENCING	 12
295 #define I915_PARAM_HAS_COHERENT_RINGS	 13
296 #define I915_PARAM_HAS_EXEC_CONSTANTS	 14
297 #define I915_PARAM_HAS_RELAXED_DELTA	 15
298 
299 typedef struct drm_i915_getparam {
300 	int param;
301 	int __user *value;
302 } drm_i915_getparam_t;
303 
304 /* Ioctl to set kernel params:
305  */
306 #define I915_SETPARAM_USE_MI_BATCHBUFFER_START            1
307 #define I915_SETPARAM_TEX_LRU_LOG_GRANULARITY             2
308 #define I915_SETPARAM_ALLOW_BATCHBUFFER                   3
309 #define I915_SETPARAM_NUM_USED_FENCES                     4
310 
311 typedef struct drm_i915_setparam {
312 	int param;
313 	int value;
314 } drm_i915_setparam_t;
315 
316 /* A memory manager for regions of shared memory:
317  */
318 #define I915_MEM_REGION_AGP 1
319 
320 typedef struct drm_i915_mem_alloc {
321 	int region;
322 	int alignment;
323 	int size;
324 	int __user *region_offset;	/* offset from start of fb or agp */
325 } drm_i915_mem_alloc_t;
326 
327 typedef struct drm_i915_mem_free {
328 	int region;
329 	int region_offset;
330 } drm_i915_mem_free_t;
331 
332 typedef struct drm_i915_mem_init_heap {
333 	int region;
334 	int size;
335 	int start;
336 } drm_i915_mem_init_heap_t;
337 
338 /* Allow memory manager to be torn down and re-initialized (eg on
339  * rotate):
340  */
341 typedef struct drm_i915_mem_destroy_heap {
342 	int region;
343 } drm_i915_mem_destroy_heap_t;
344 
345 /* Allow X server to configure which pipes to monitor for vblank signals
346  */
347 #define	DRM_I915_VBLANK_PIPE_A	1
348 #define	DRM_I915_VBLANK_PIPE_B	2
349 
350 typedef struct drm_i915_vblank_pipe {
351 	int pipe;
352 } drm_i915_vblank_pipe_t;
353 
354 /* Schedule buffer swap at given vertical blank:
355  */
356 typedef struct drm_i915_vblank_swap {
357 	drm_drawable_t drawable;
358 	enum drm_vblank_seq_type seqtype;
359 	unsigned int sequence;
360 } drm_i915_vblank_swap_t;
361 
362 typedef struct drm_i915_hws_addr {
363 	__u64 addr;
364 } drm_i915_hws_addr_t;
365 
366 struct drm_i915_gem_init {
367 	/**
368 	 * Beginning offset in the GTT to be managed by the DRM memory
369 	 * manager.
370 	 */
371 	__u64 gtt_start;
372 	/**
373 	 * Ending offset in the GTT to be managed by the DRM memory
374 	 * manager.
375 	 */
376 	__u64 gtt_end;
377 };
378 
379 struct drm_i915_gem_create {
380 	/**
381 	 * Requested size for the object.
382 	 *
383 	 * The (page-aligned) allocated size for the object will be returned.
384 	 */
385 	__u64 size;
386 	/**
387 	 * Returned handle for the object.
388 	 *
389 	 * Object handles are nonzero.
390 	 */
391 	__u32 handle;
392 	__u32 pad;
393 };
394 
395 struct drm_i915_gem_pread {
396 	/** Handle for the object being read. */
397 	__u32 handle;
398 	__u32 pad;
399 	/** Offset into the object to read from */
400 	__u64 offset;
401 	/** Length of data to read */
402 	__u64 size;
403 	/**
404 	 * Pointer to write the data into.
405 	 *
406 	 * This is a fixed-size type for 32/64 compatibility.
407 	 */
408 	__u64 data_ptr;
409 };
410 
411 struct drm_i915_gem_pwrite {
412 	/** Handle for the object being written to. */
413 	__u32 handle;
414 	__u32 pad;
415 	/** Offset into the object to write to */
416 	__u64 offset;
417 	/** Length of data to write */
418 	__u64 size;
419 	/**
420 	 * Pointer to read the data from.
421 	 *
422 	 * This is a fixed-size type for 32/64 compatibility.
423 	 */
424 	__u64 data_ptr;
425 };
426 
427 struct drm_i915_gem_mmap {
428 	/** Handle for the object being mapped. */
429 	__u32 handle;
430 	__u32 pad;
431 	/** Offset in the object to map. */
432 	__u64 offset;
433 	/**
434 	 * Length of data to map.
435 	 *
436 	 * The value will be page-aligned.
437 	 */
438 	__u64 size;
439 	/**
440 	 * Returned pointer the data was mapped at.
441 	 *
442 	 * This is a fixed-size type for 32/64 compatibility.
443 	 */
444 	__u64 addr_ptr;
445 };
446 
447 struct drm_i915_gem_mmap_gtt {
448 	/** Handle for the object being mapped. */
449 	__u32 handle;
450 	__u32 pad;
451 	/**
452 	 * Fake offset to use for subsequent mmap call
453 	 *
454 	 * This is a fixed-size type for 32/64 compatibility.
455 	 */
456 	__u64 offset;
457 };
458 
459 struct drm_i915_gem_set_domain {
460 	/** Handle for the object */
461 	__u32 handle;
462 
463 	/** New read domains */
464 	__u32 read_domains;
465 
466 	/** New write domain */
467 	__u32 write_domain;
468 };
469 
470 struct drm_i915_gem_sw_finish {
471 	/** Handle for the object */
472 	__u32 handle;
473 };
474 
475 struct drm_i915_gem_relocation_entry {
476 	/**
477 	 * Handle of the buffer being pointed to by this relocation entry.
478 	 *
479 	 * It's appealing to make this be an index into the mm_validate_entry
480 	 * list to refer to the buffer, but this allows the driver to create
481 	 * a relocation list for state buffers and not re-write it per
482 	 * exec using the buffer.
483 	 */
484 	__u32 target_handle;
485 
486 	/**
487 	 * Value to be added to the offset of the target buffer to make up
488 	 * the relocation entry.
489 	 */
490 	__u32 delta;
491 
492 	/** Offset in the buffer the relocation entry will be written into */
493 	__u64 offset;
494 
495 	/**
496 	 * Offset value of the target buffer that the relocation entry was last
497 	 * written as.
498 	 *
499 	 * If the buffer has the same offset as last time, we can skip syncing
500 	 * and writing the relocation.  This value is written back out by
501 	 * the execbuffer ioctl when the relocation is written.
502 	 */
503 	__u64 presumed_offset;
504 
505 	/**
506 	 * Target memory domains read by this operation.
507 	 */
508 	__u32 read_domains;
509 
510 	/**
511 	 * Target memory domains written by this operation.
512 	 *
513 	 * Note that only one domain may be written by the whole
514 	 * execbuffer operation, so that where there are conflicts,
515 	 * the application will get -EINVAL back.
516 	 */
517 	__u32 write_domain;
518 };
519 
520 /** @{
521  * Intel memory domains
522  *
523  * Most of these just align with the various caches in
524  * the system and are used to flush and invalidate as
525  * objects end up cached in different domains.
526  */
527 /** CPU cache */
528 #define I915_GEM_DOMAIN_CPU		0x00000001
529 /** Render cache, used by 2D and 3D drawing */
530 #define I915_GEM_DOMAIN_RENDER		0x00000002
531 /** Sampler cache, used by texture engine */
532 #define I915_GEM_DOMAIN_SAMPLER		0x00000004
533 /** Command queue, used to load batch buffers */
534 #define I915_GEM_DOMAIN_COMMAND		0x00000008
535 /** Instruction cache, used by shader programs */
536 #define I915_GEM_DOMAIN_INSTRUCTION	0x00000010
537 /** Vertex address cache */
538 #define I915_GEM_DOMAIN_VERTEX		0x00000020
539 /** GTT domain - aperture and scanout */
540 #define I915_GEM_DOMAIN_GTT		0x00000040
541 /** @} */
542 
543 struct drm_i915_gem_exec_object {
544 	/**
545 	 * User's handle for a buffer to be bound into the GTT for this
546 	 * operation.
547 	 */
548 	__u32 handle;
549 
550 	/** Number of relocations to be performed on this buffer */
551 	__u32 relocation_count;
552 	/**
553 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
554 	 * the relocations to be performed in this buffer.
555 	 */
556 	__u64 relocs_ptr;
557 
558 	/** Required alignment in graphics aperture */
559 	__u64 alignment;
560 
561 	/**
562 	 * Returned value of the updated offset of the object, for future
563 	 * presumed_offset writes.
564 	 */
565 	__u64 offset;
566 };
567 
568 struct drm_i915_gem_execbuffer {
569 	/**
570 	 * List of buffers to be validated with their relocations to be
571 	 * performend on them.
572 	 *
573 	 * This is a pointer to an array of struct drm_i915_gem_validate_entry.
574 	 *
575 	 * These buffers must be listed in an order such that all relocations
576 	 * a buffer is performing refer to buffers that have already appeared
577 	 * in the validate list.
578 	 */
579 	__u64 buffers_ptr;
580 	__u32 buffer_count;
581 
582 	/** Offset in the batchbuffer to start execution from. */
583 	__u32 batch_start_offset;
584 	/** Bytes used in batchbuffer from batch_start_offset */
585 	__u32 batch_len;
586 	__u32 DR1;
587 	__u32 DR4;
588 	__u32 num_cliprects;
589 	/** This is a struct drm_clip_rect *cliprects */
590 	__u64 cliprects_ptr;
591 };
592 
593 struct drm_i915_gem_exec_object2 {
594 	/**
595 	 * User's handle for a buffer to be bound into the GTT for this
596 	 * operation.
597 	 */
598 	__u32 handle;
599 
600 	/** Number of relocations to be performed on this buffer */
601 	__u32 relocation_count;
602 	/**
603 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
604 	 * the relocations to be performed in this buffer.
605 	 */
606 	__u64 relocs_ptr;
607 
608 	/** Required alignment in graphics aperture */
609 	__u64 alignment;
610 
611 	/**
612 	 * Returned value of the updated offset of the object, for future
613 	 * presumed_offset writes.
614 	 */
615 	__u64 offset;
616 
617 #define EXEC_OBJECT_NEEDS_FENCE (1<<0)
618 	__u64 flags;
619 	__u64 rsvd1;
620 	__u64 rsvd2;
621 };
622 
623 struct drm_i915_gem_execbuffer2 {
624 	/**
625 	 * List of gem_exec_object2 structs
626 	 */
627 	__u64 buffers_ptr;
628 	__u32 buffer_count;
629 
630 	/** Offset in the batchbuffer to start execution from. */
631 	__u32 batch_start_offset;
632 	/** Bytes used in batchbuffer from batch_start_offset */
633 	__u32 batch_len;
634 	__u32 DR1;
635 	__u32 DR4;
636 	__u32 num_cliprects;
637 	/** This is a struct drm_clip_rect *cliprects */
638 	__u64 cliprects_ptr;
639 #define I915_EXEC_RING_MASK              (7<<0)
640 #define I915_EXEC_DEFAULT                (0<<0)
641 #define I915_EXEC_RENDER                 (1<<0)
642 #define I915_EXEC_BSD                    (2<<0)
643 #define I915_EXEC_BLT                    (3<<0)
644 
645 /* Used for switching the constants addressing mode on gen4+ RENDER ring.
646  * Gen6+ only supports relative addressing to dynamic state (default) and
647  * absolute addressing.
648  *
649  * These flags are ignored for the BSD and BLT rings.
650  */
651 #define I915_EXEC_CONSTANTS_MASK 	(3<<6)
652 #define I915_EXEC_CONSTANTS_REL_GENERAL (0<<6) /* default */
653 #define I915_EXEC_CONSTANTS_ABSOLUTE 	(1<<6)
654 #define I915_EXEC_CONSTANTS_REL_SURFACE (2<<6) /* gen4/5 only */
655 	__u64 flags;
656 	__u64 rsvd1;
657 	__u64 rsvd2;
658 };
659 
660 struct drm_i915_gem_pin {
661 	/** Handle of the buffer to be pinned. */
662 	__u32 handle;
663 	__u32 pad;
664 
665 	/** alignment required within the aperture */
666 	__u64 alignment;
667 
668 	/** Returned GTT offset of the buffer. */
669 	__u64 offset;
670 };
671 
672 struct drm_i915_gem_unpin {
673 	/** Handle of the buffer to be unpinned. */
674 	__u32 handle;
675 	__u32 pad;
676 };
677 
678 struct drm_i915_gem_busy {
679 	/** Handle of the buffer to check for busy */
680 	__u32 handle;
681 
682 	/** Return busy status (1 if busy, 0 if idle) */
683 	__u32 busy;
684 };
685 
686 #define I915_TILING_NONE	0
687 #define I915_TILING_X		1
688 #define I915_TILING_Y		2
689 
690 #define I915_BIT_6_SWIZZLE_NONE		0
691 #define I915_BIT_6_SWIZZLE_9		1
692 #define I915_BIT_6_SWIZZLE_9_10		2
693 #define I915_BIT_6_SWIZZLE_9_11		3
694 #define I915_BIT_6_SWIZZLE_9_10_11	4
695 /* Not seen by userland */
696 #define I915_BIT_6_SWIZZLE_UNKNOWN	5
697 /* Seen by userland. */
698 #define I915_BIT_6_SWIZZLE_9_17		6
699 #define I915_BIT_6_SWIZZLE_9_10_17	7
700 
701 struct drm_i915_gem_set_tiling {
702 	/** Handle of the buffer to have its tiling state updated */
703 	__u32 handle;
704 
705 	/**
706 	 * Tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
707 	 * I915_TILING_Y).
708 	 *
709 	 * This value is to be set on request, and will be updated by the
710 	 * kernel on successful return with the actual chosen tiling layout.
711 	 *
712 	 * The tiling mode may be demoted to I915_TILING_NONE when the system
713 	 * has bit 6 swizzling that can't be managed correctly by GEM.
714 	 *
715 	 * Buffer contents become undefined when changing tiling_mode.
716 	 */
717 	__u32 tiling_mode;
718 
719 	/**
720 	 * Stride in bytes for the object when in I915_TILING_X or
721 	 * I915_TILING_Y.
722 	 */
723 	__u32 stride;
724 
725 	/**
726 	 * Returned address bit 6 swizzling required for CPU access through
727 	 * mmap mapping.
728 	 */
729 	__u32 swizzle_mode;
730 };
731 
732 struct drm_i915_gem_get_tiling {
733 	/** Handle of the buffer to get tiling state for. */
734 	__u32 handle;
735 
736 	/**
737 	 * Current tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
738 	 * I915_TILING_Y).
739 	 */
740 	__u32 tiling_mode;
741 
742 	/**
743 	 * Returned address bit 6 swizzling required for CPU access through
744 	 * mmap mapping.
745 	 */
746 	__u32 swizzle_mode;
747 };
748 
749 struct drm_i915_gem_get_aperture {
750 	/** Total size of the aperture used by i915_gem_execbuffer, in bytes */
751 	__u64 aper_size;
752 
753 	/**
754 	 * Available space in the aperture used by i915_gem_execbuffer, in
755 	 * bytes
756 	 */
757 	__u64 aper_available_size;
758 };
759 
760 struct drm_i915_get_pipe_from_crtc_id {
761 	/** ID of CRTC being requested **/
762 	__u32 crtc_id;
763 
764 	/** pipe of requested CRTC **/
765 	__u32 pipe;
766 };
767 
768 #define I915_MADV_WILLNEED 0
769 #define I915_MADV_DONTNEED 1
770 #define __I915_MADV_PURGED 2 /* internal state */
771 
772 struct drm_i915_gem_madvise {
773 	/** Handle of the buffer to change the backing store advice */
774 	__u32 handle;
775 
776 	/* Advice: either the buffer will be needed again in the near future,
777 	 *         or wont be and could be discarded under memory pressure.
778 	 */
779 	__u32 madv;
780 
781 	/** Whether the backing store still exists. */
782 	__u32 retained;
783 };
784 
785 /* flags */
786 #define I915_OVERLAY_TYPE_MASK 		0xff
787 #define I915_OVERLAY_YUV_PLANAR 	0x01
788 #define I915_OVERLAY_YUV_PACKED 	0x02
789 #define I915_OVERLAY_RGB		0x03
790 
791 #define I915_OVERLAY_DEPTH_MASK		0xff00
792 #define I915_OVERLAY_RGB24		0x1000
793 #define I915_OVERLAY_RGB16		0x2000
794 #define I915_OVERLAY_RGB15		0x3000
795 #define I915_OVERLAY_YUV422		0x0100
796 #define I915_OVERLAY_YUV411		0x0200
797 #define I915_OVERLAY_YUV420		0x0300
798 #define I915_OVERLAY_YUV410		0x0400
799 
800 #define I915_OVERLAY_SWAP_MASK		0xff0000
801 #define I915_OVERLAY_NO_SWAP		0x000000
802 #define I915_OVERLAY_UV_SWAP		0x010000
803 #define I915_OVERLAY_Y_SWAP		0x020000
804 #define I915_OVERLAY_Y_AND_UV_SWAP	0x030000
805 
806 #define I915_OVERLAY_FLAGS_MASK		0xff000000
807 #define I915_OVERLAY_ENABLE		0x01000000
808 
809 struct drm_intel_overlay_put_image {
810 	/* various flags and src format description */
811 	__u32 flags;
812 	/* source picture description */
813 	__u32 bo_handle;
814 	/* stride values and offsets are in bytes, buffer relative */
815 	__u16 stride_Y; /* stride for packed formats */
816 	__u16 stride_UV;
817 	__u32 offset_Y; /* offset for packet formats */
818 	__u32 offset_U;
819 	__u32 offset_V;
820 	/* in pixels */
821 	__u16 src_width;
822 	__u16 src_height;
823 	/* to compensate the scaling factors for partially covered surfaces */
824 	__u16 src_scan_width;
825 	__u16 src_scan_height;
826 	/* output crtc description */
827 	__u32 crtc_id;
828 	__u16 dst_x;
829 	__u16 dst_y;
830 	__u16 dst_width;
831 	__u16 dst_height;
832 };
833 
834 /* flags */
835 #define I915_OVERLAY_UPDATE_ATTRS	(1<<0)
836 #define I915_OVERLAY_UPDATE_GAMMA	(1<<1)
837 struct drm_intel_overlay_attrs {
838 	__u32 flags;
839 	__u32 color_key;
840 	__s32 brightness;
841 	__u32 contrast;
842 	__u32 saturation;
843 	__u32 gamma0;
844 	__u32 gamma1;
845 	__u32 gamma2;
846 	__u32 gamma3;
847 	__u32 gamma4;
848 	__u32 gamma5;
849 };
850 
851 /*
852  * Intel sprite handling
853  *
854  * Color keying works with a min/mask/max tuple.  Both source and destination
855  * color keying is allowed.
856  *
857  * Source keying:
858  * Sprite pixels within the min & max values, masked against the color channels
859  * specified in the mask field, will be transparent.  All other pixels will
860  * be displayed on top of the primary plane.  For RGB surfaces, only the min
861  * and mask fields will be used; ranged compares are not allowed.
862  *
863  * Destination keying:
864  * Primary plane pixels that match the min value, masked against the color
865  * channels specified in the mask field, will be replaced by corresponding
866  * pixels from the sprite plane.
867  *
868  * Note that source & destination keying are exclusive; only one can be
869  * active on a given plane.
870  */
871 
872 #define I915_SET_COLORKEY_NONE		(1<<0) /* disable color key matching */
873 #define I915_SET_COLORKEY_DESTINATION	(1<<1)
874 #define I915_SET_COLORKEY_SOURCE	(1<<2)
875 struct drm_intel_sprite_colorkey {
876 	__u32 plane_id;
877 	__u32 min_value;
878 	__u32 channel_mask;
879 	__u32 max_value;
880 	__u32 flags;
881 };
882 
883 #endif				/* _I915_DRM_H_ */
884