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