2 * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
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.
30 /* Please note that modifications to all structs defined here are
31 * subject to backwards-compatibility constraints.
36 /* Each region is a minimum of 16k, and there are at most 255 of them.
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 {
45 I915_CLEANUP_DMA = 0x02,
46 I915_RESUME_DMA = 0x03,
48 /* Since this struct isn't versioned, just used a new
49 * 'func' code to indicate the presence of dri2 sarea
53 unsigned int mmio_offset;
54 int sarea_priv_offset;
55 unsigned int ring_start;
56 unsigned int ring_end;
57 unsigned int ring_size;
58 unsigned int front_offset;
59 unsigned int back_offset;
60 unsigned int depth_offset;
64 unsigned int pitch_bits;
65 unsigned int back_pitch;
66 unsigned int depth_pitch;
69 unsigned int sarea_handle;
72 typedef struct drm_i915_sarea {
73 struct drm_tex_region texList[I915_NR_TEX_REGIONS + 1];
74 int last_upload; /* last time texture was uploaded */
75 int last_enqueue; /* last time a buffer was enqueued */
76 int last_dispatch; /* age of the most recently dispatched buffer */
77 int ctxOwner; /* last context to upload state */
79 int pf_enabled; /* is pageflipping allowed? */
81 int pf_current_page; /* which buffer is being displayed? */
82 int perf_boxes; /* performance boxes to be displayed */
83 int width, height; /* screen size in pixels */
85 drm_handle_t front_handle;
89 drm_handle_t back_handle;
93 drm_handle_t depth_handle;
97 drm_handle_t tex_handle;
100 int log_tex_granularity;
102 int rotation; /* 0, 90, 180 or 270 */
106 int virtualX, virtualY;
108 unsigned int front_tiled;
109 unsigned int back_tiled;
110 unsigned int depth_tiled;
111 unsigned int rotated_tiled;
112 unsigned int rotated2_tiled;
123 /* Triple buffering */
124 drm_handle_t third_handle;
127 unsigned int third_tiled;
129 /* buffer object handles for the static buffers. May change
130 * over the lifetime of the client, though it doesn't in our current
133 unsigned int front_bo_handle;
134 unsigned int back_bo_handle;
135 unsigned int third_bo_handle;
136 unsigned int depth_bo_handle;
139 /* Driver specific fence types and classes.
142 /* The only fence class we support */
143 #define DRM_I915_FENCE_CLASS_ACCEL 0
144 /* Fence type that guarantees read-write flush */
145 #define DRM_I915_FENCE_TYPE_RW 2
146 /* MI_FLUSH programmed just before the fence */
147 #define DRM_I915_FENCE_FLAG_FLUSHED 0x01000000
149 /* Flags for perf_boxes
151 #define I915_BOX_RING_EMPTY 0x1
152 #define I915_BOX_FLIP 0x2
153 #define I915_BOX_WAIT 0x4
154 #define I915_BOX_TEXTURE_LOAD 0x8
155 #define I915_BOX_LOST_CONTEXT 0x10
157 /* I915 specific ioctls
158 * The device specific ioctl range is 0x40 to 0x79.
160 #define DRM_I915_INIT 0x00
161 #define DRM_I915_FLUSH 0x01
162 #define DRM_I915_FLIP 0x02
163 #define DRM_I915_BATCHBUFFER 0x03
164 #define DRM_I915_IRQ_EMIT 0x04
165 #define DRM_I915_IRQ_WAIT 0x05
166 #define DRM_I915_GETPARAM 0x06
167 #define DRM_I915_SETPARAM 0x07
168 #define DRM_I915_ALLOC 0x08
169 #define DRM_I915_FREE 0x09
170 #define DRM_I915_INIT_HEAP 0x0a
171 #define DRM_I915_CMDBUFFER 0x0b
172 #define DRM_I915_DESTROY_HEAP 0x0c
173 #define DRM_I915_SET_VBLANK_PIPE 0x0d
174 #define DRM_I915_GET_VBLANK_PIPE 0x0e
175 #define DRM_I915_VBLANK_SWAP 0x0f
176 #define DRM_I915_MMIO 0x10
177 #define DRM_I915_HWS_ADDR 0x11
178 #define DRM_I915_EXECBUFFER 0x12
179 #define DRM_I915_GEM_INIT 0x13
180 #define DRM_I915_GEM_EXECBUFFER 0x14
181 #define DRM_I915_GEM_PIN 0x15
182 #define DRM_I915_GEM_UNPIN 0x16
183 #define DRM_I915_GEM_BUSY 0x17
184 #define DRM_I915_GEM_THROTTLE 0x18
185 #define DRM_I915_GEM_ENTERVT 0x19
186 #define DRM_I915_GEM_LEAVEVT 0x1a
187 #define DRM_I915_GEM_CREATE 0x1b
188 #define DRM_I915_GEM_PREAD 0x1c
189 #define DRM_I915_GEM_PWRITE 0x1d
190 #define DRM_I915_GEM_MMAP 0x1e
191 #define DRM_I915_GEM_SET_DOMAIN 0x1f
192 #define DRM_I915_GEM_SW_FINISH 0x20
194 #define DRM_IOCTL_I915_INIT DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT, drm_i915_init_t)
195 #define DRM_IOCTL_I915_FLUSH DRM_IO ( DRM_COMMAND_BASE + DRM_I915_FLUSH)
196 #define DRM_IOCTL_I915_FLIP DRM_IOW( DRM_COMMAND_BASE + DRM_I915_FLIP, drm_i915_flip_t)
197 #define DRM_IOCTL_I915_BATCHBUFFER DRM_IOW( DRM_COMMAND_BASE + DRM_I915_BATCHBUFFER, drm_i915_batchbuffer_t)
198 #define DRM_IOCTL_I915_IRQ_EMIT DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_IRQ_EMIT, drm_i915_irq_emit_t)
199 #define DRM_IOCTL_I915_IRQ_WAIT DRM_IOW( DRM_COMMAND_BASE + DRM_I915_IRQ_WAIT, drm_i915_irq_wait_t)
200 #define DRM_IOCTL_I915_GETPARAM DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GETPARAM, drm_i915_getparam_t)
201 #define DRM_IOCTL_I915_SETPARAM DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SETPARAM, drm_i915_setparam_t)
202 #define DRM_IOCTL_I915_ALLOC DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_ALLOC, drm_i915_mem_alloc_t)
203 #define DRM_IOCTL_I915_FREE DRM_IOW( DRM_COMMAND_BASE + DRM_I915_FREE, drm_i915_mem_free_t)
204 #define DRM_IOCTL_I915_INIT_HEAP DRM_IOW( DRM_COMMAND_BASE + DRM_I915_INIT_HEAP, drm_i915_mem_init_heap_t)
205 #define DRM_IOCTL_I915_CMDBUFFER DRM_IOW( DRM_COMMAND_BASE + DRM_I915_CMDBUFFER, drm_i915_cmdbuffer_t)
206 #define DRM_IOCTL_I915_DESTROY_HEAP DRM_IOW( DRM_COMMAND_BASE + DRM_I915_DESTROY_HEAP, drm_i915_mem_destroy_heap_t)
207 #define DRM_IOCTL_I915_SET_VBLANK_PIPE DRM_IOW( DRM_COMMAND_BASE + DRM_I915_SET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
208 #define DRM_IOCTL_I915_GET_VBLANK_PIPE DRM_IOR( DRM_COMMAND_BASE + DRM_I915_GET_VBLANK_PIPE, drm_i915_vblank_pipe_t)
209 #define DRM_IOCTL_I915_VBLANK_SWAP DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_VBLANK_SWAP, drm_i915_vblank_swap_t)
210 #define DRM_IOCTL_I915_MMIO DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_MMIO, drm_i915_mmio)
211 #define DRM_IOCTL_I915_EXECBUFFER DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_EXECBUFFER, struct drm_i915_execbuffer)
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_PIN DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_PIN, struct drm_i915_gem_pin)
215 #define DRM_IOCTL_I915_GEM_UNPIN DRM_IOW(DRM_COMMAND_BASE + DRM_I915_GEM_UNPIN, struct drm_i915_gem_unpin)
216 #define DRM_IOCTL_I915_GEM_BUSY DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_BUSY, struct drm_i915_gem_busy)
217 #define DRM_IOCTL_I915_GEM_THROTTLE DRM_IO ( DRM_COMMAND_BASE + DRM_I915_GEM_THROTTLE)
218 #define DRM_IOCTL_I915_GEM_ENTERVT DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_ENTERVT)
219 #define DRM_IOCTL_I915_GEM_LEAVEVT DRM_IO(DRM_COMMAND_BASE + DRM_I915_GEM_LEAVEVT)
220 #define DRM_IOCTL_I915_GEM_CREATE DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_CREATE, struct drm_i915_gem_create)
221 #define DRM_IOCTL_I915_GEM_PREAD DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PREAD, struct drm_i915_gem_pread)
222 #define DRM_IOCTL_I915_GEM_PWRITE DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_PWRITE, struct drm_i915_gem_pwrite)
223 #define DRM_IOCTL_I915_GEM_MMAP DRM_IOWR(DRM_COMMAND_BASE + DRM_I915_GEM_MMAP, struct drm_i915_gem_mmap)
224 #define DRM_IOCTL_I915_GEM_SET_DOMAIN DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SET_DOMAIN, struct drm_i915_gem_set_domain)
225 #define DRM_IOCTL_I915_GEM_SW_FINISH DRM_IOW (DRM_COMMAND_BASE + DRM_I915_GEM_SW_FINISH, struct drm_i915_gem_sw_finish)
227 /* Asynchronous page flipping:
229 typedef struct drm_i915_flip {
231 * This is really talking about planes, and we could rename it
232 * except for the fact that some of the duplicated i915_drm.h files
233 * out there check for HAVE_I915_FLIP and so might pick up this
239 /* Allow drivers to submit batchbuffers directly to hardware, relying
240 * on the security mechanisms provided by hardware.
242 typedef struct drm_i915_batchbuffer {
243 int start; /* agp offset */
244 int used; /* nr bytes in use */
245 int DR1; /* hw flags for GFX_OP_DRAWRECT_INFO */
246 int DR4; /* window origin for GFX_OP_DRAWRECT_INFO */
247 int num_cliprects; /* mulitpass with multiple cliprects? */
248 struct drm_clip_rect __user *cliprects; /* pointer to userspace cliprects */
249 } drm_i915_batchbuffer_t;
251 /* As above, but pass a pointer to userspace buffer which can be
252 * validated by the kernel prior to sending to hardware.
254 typedef struct drm_i915_cmdbuffer {
255 char __user *buf; /* pointer to userspace command buffer */
256 int sz; /* nr bytes in buf */
257 int DR1; /* hw flags for GFX_OP_DRAWRECT_INFO */
258 int DR4; /* window origin for GFX_OP_DRAWRECT_INFO */
259 int num_cliprects; /* mulitpass with multiple cliprects? */
260 struct drm_clip_rect __user *cliprects; /* pointer to userspace cliprects */
261 } drm_i915_cmdbuffer_t;
263 /* Userspace can request & wait on irq's:
265 typedef struct drm_i915_irq_emit {
267 } drm_i915_irq_emit_t;
269 typedef struct drm_i915_irq_wait {
271 } drm_i915_irq_wait_t;
273 /* Ioctl to query kernel params:
275 #define I915_PARAM_IRQ_ACTIVE 1
276 #define I915_PARAM_ALLOW_BATCHBUFFER 2
277 #define I915_PARAM_LAST_DISPATCH 3
278 #define I915_PARAM_CHIPSET_ID 4
280 typedef struct drm_i915_getparam {
283 } drm_i915_getparam_t;
285 /* Ioctl to set kernel params:
287 #define I915_SETPARAM_USE_MI_BATCHBUFFER_START 1
288 #define I915_SETPARAM_TEX_LRU_LOG_GRANULARITY 2
289 #define I915_SETPARAM_ALLOW_BATCHBUFFER 3
291 typedef struct drm_i915_setparam {
294 } drm_i915_setparam_t;
296 /* A memory manager for regions of shared memory:
298 #define I915_MEM_REGION_AGP 1
300 typedef struct drm_i915_mem_alloc {
304 int __user *region_offset; /* offset from start of fb or agp */
305 } drm_i915_mem_alloc_t;
307 typedef struct drm_i915_mem_free {
310 } drm_i915_mem_free_t;
312 typedef struct drm_i915_mem_init_heap {
316 } drm_i915_mem_init_heap_t;
318 /* Allow memory manager to be torn down and re-initialized (eg on
321 typedef struct drm_i915_mem_destroy_heap {
323 } drm_i915_mem_destroy_heap_t;
325 /* Allow X server to configure which pipes to monitor for vblank signals
327 #define DRM_I915_VBLANK_PIPE_A 1
328 #define DRM_I915_VBLANK_PIPE_B 2
330 typedef struct drm_i915_vblank_pipe {
332 } drm_i915_vblank_pipe_t;
334 /* Schedule buffer swap at given vertical blank:
336 typedef struct drm_i915_vblank_swap {
337 drm_drawable_t drawable;
338 enum drm_vblank_seq_type seqtype;
339 unsigned int sequence;
340 } drm_i915_vblank_swap_t;
342 #define I915_MMIO_READ 0
343 #define I915_MMIO_WRITE 1
345 #define I915_MMIO_MAY_READ 0x1
346 #define I915_MMIO_MAY_WRITE 0x2
348 #define MMIO_REGS_IA_PRIMATIVES_COUNT 0
349 #define MMIO_REGS_IA_VERTICES_COUNT 1
350 #define MMIO_REGS_VS_INVOCATION_COUNT 2
351 #define MMIO_REGS_GS_PRIMITIVES_COUNT 3
352 #define MMIO_REGS_GS_INVOCATION_COUNT 4
353 #define MMIO_REGS_CL_PRIMITIVES_COUNT 5
354 #define MMIO_REGS_CL_INVOCATION_COUNT 6
355 #define MMIO_REGS_PS_INVOCATION_COUNT 7
356 #define MMIO_REGS_PS_DEPTH_COUNT 8
357 #define MMIO_REGS_DOVSTA 9
358 #define MMIO_REGS_GAMMA 10
359 #define MMIO_REGS_FENCE 11
360 #define MMIO_REGS_FENCE_NEW 12
362 typedef struct drm_i915_mmio_entry {
366 } drm_i915_mmio_entry_t;
368 typedef struct drm_i915_mmio {
369 unsigned int read_write:1;
374 typedef struct drm_i915_hws_addr {
376 } drm_i915_hws_addr_t;
378 struct drm_i915_gem_init {
380 * Beginning offset in the GTT to be managed by the DRM memory
385 * Ending offset in the GTT to be managed by the DRM memory
391 struct drm_i915_gem_create {
393 * Requested size for the object.
395 * The (page-aligned) allocated size for the object will be returned.
399 * Returned handle for the object.
401 * Object handles are nonzero.
407 struct drm_i915_gem_pread {
408 /** Handle for the object being read. */
411 /** Offset into the object to read from */
413 /** Length of data to read */
415 /** Pointer to write the data into. */
416 uint64_t data_ptr; /* void *, but pointers are not 32/64 compatible */
419 struct drm_i915_gem_pwrite {
420 /** Handle for the object being written to. */
423 /** Offset into the object to write to */
425 /** Length of data to write */
427 /** Pointer to read the data from. */
428 uint64_t data_ptr; /* void *, but pointers are not 32/64 compatible */
431 struct drm_i915_gem_mmap {
432 /** Handle for the object being mapped. */
435 /** Offset in the object to map. */
438 * Length of data to map.
440 * The value will be page-aligned.
443 /** Returned pointer the data was mapped at */
444 uint64_t addr_ptr; /* void *, but pointers are not 32/64 compatible */
447 struct drm_i915_gem_set_domain {
448 /** Handle for the object */
451 /** New read domains */
452 uint32_t read_domains;
454 /** New write domain */
455 uint32_t write_domain;
458 struct drm_i915_gem_sw_finish {
459 /** Handle for the object */
463 struct drm_i915_gem_relocation_entry {
465 * Handle of the buffer being pointed to by this relocation entry.
467 * It's appealing to make this be an index into the mm_validate_entry
468 * list to refer to the buffer, but this allows the driver to create
469 * a relocation list for state buffers and not re-write it per
470 * exec using the buffer.
472 uint32_t target_handle;
475 * Value to be added to the offset of the target buffer to make up
476 * the relocation entry.
480 /** Offset in the buffer the relocation entry will be written into */
484 * Offset value of the target buffer that the relocation entry was last
487 * If the buffer has the same offset as last time, we can skip syncing
488 * and writing the relocation. This value is written back out by
489 * the execbuffer ioctl when the relocation is written.
491 uint64_t presumed_offset;
494 * Target memory domains read by this operation.
496 uint32_t read_domains;
499 * Target memory domains written by this operation.
501 * Note that only one domain may be written by the whole
502 * execbuffer operation, so that where there are conflicts,
503 * the application will get -EINVAL back.
505 uint32_t write_domain;
509 * Intel memory domains
511 * Most of these just align with the various caches in
512 * the system and are used to flush and invalidate as
513 * objects end up cached in different domains.
516 #define I915_GEM_DOMAIN_CPU 0x00000001
517 /** Render cache, used by 2D and 3D drawing */
518 #define I915_GEM_DOMAIN_RENDER 0x00000002
519 /** Sampler cache, used by texture engine */
520 #define I915_GEM_DOMAIN_SAMPLER 0x00000004
521 /** Command queue, used to load batch buffers */
522 #define I915_GEM_DOMAIN_COMMAND 0x00000008
523 /** Instruction cache, used by shader programs */
524 #define I915_GEM_DOMAIN_INSTRUCTION 0x00000010
525 /** Vertex address cache */
526 #define I915_GEM_DOMAIN_VERTEX 0x00000020
527 /** GTT domain - aperture and scanout */
528 #define I915_GEM_DOMAIN_GTT 0x00000040
531 struct drm_i915_gem_exec_object {
533 * User's handle for a buffer to be bound into the GTT for this
538 /** Number of relocations to be performed on this buffer */
539 uint32_t relocation_count;
541 * Pointer to array of struct drm_i915_gem_relocation_entry containing
542 * the relocations to be performed in this buffer.
546 /** Required alignment in graphics aperture */
550 * Returned value of the updated offset of the object, for future
551 * presumed_offset writes.
556 struct drm_i915_gem_execbuffer {
558 * List of buffers to be validated with their relocations to be
559 * performend on them.
561 * This is a pointer to an array of struct drm_i915_gem_validate_entry.
563 * These buffers must be listed in an order such that all relocations
564 * a buffer is performing refer to buffers that have already appeared
565 * in the validate list.
567 uint64_t buffers_ptr;
568 uint32_t buffer_count;
570 /** Offset in the batchbuffer to start execution from. */
571 uint32_t batch_start_offset;
572 /** Bytes used in batchbuffer from batch_start_offset */
576 uint32_t num_cliprects;
577 uint64_t cliprects_ptr; /* struct drm_clip_rect *cliprects */
580 struct drm_i915_gem_pin {
581 /** Handle of the buffer to be pinned. */
585 /** alignment required within the aperture */
588 /** Returned GTT offset of the buffer. */
592 struct drm_i915_gem_unpin {
593 /** Handle of the buffer to be unpinned. */
598 struct drm_i915_gem_busy {
599 /** Handle of the buffer to check for busy */
602 /** Return busy status (1 if busy, 0 if idle) */
606 #endif /* _I915_DRM_H_ */