614422bdae0718ebd74d3b38dcedf52169074ae0
[platform/upstream/libdrm.git] / shared-core / drm.h
1 /**
2  * \file drm.h
3  * Header for the Direct Rendering Manager
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  *
7  * \par Acknowledgments:
8  * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic \c cmpxchg.
9  */
10
11 /*
12  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
13  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14  * All rights reserved.
15  *
16  * Permission is hereby granted, free of charge, to any person obtaining a
17  * copy of this software and associated documentation files (the "Software"),
18  * to deal in the Software without restriction, including without limitation
19  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20  * and/or sell copies of the Software, and to permit persons to whom the
21  * Software is furnished to do so, subject to the following conditions:
22  *
23  * The above copyright notice and this permission notice (including the next
24  * paragraph) shall be included in all copies or substantial portions of the
25  * Software.
26  *
27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
30  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
31  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
32  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
33  * OTHER DEALINGS IN THE SOFTWARE.
34  */
35
36 /**
37  * \mainpage
38  *
39  * The Direct Rendering Manager (DRM) is a device-independent kernel-level
40  * device driver that provides support for the XFree86 Direct Rendering
41  * Infrastructure (DRI).
42  *
43  * The DRM supports the Direct Rendering Infrastructure (DRI) in four major
44  * ways:
45  *     -# The DRM provides synchronized access to the graphics hardware via
46  *        the use of an optimized two-tiered lock.
47  *     -# The DRM enforces the DRI security policy for access to the graphics
48  *        hardware by only allowing authenticated X11 clients access to
49  *        restricted regions of memory.
50  *     -# The DRM provides a generic DMA engine, complete with multiple
51  *        queues and the ability to detect the need for an OpenGL context
52  *        switch.
53  *     -# The DRM is extensible via the use of small device-specific modules
54  *        that rely extensively on the API exported by the DRM module.
55  *
56  */
57
58 #ifndef _DRM_H_
59 #define _DRM_H_
60
61 #ifndef __user
62 #define __user
63 #endif
64
65 #ifdef __GNUC__
66 # define DEPRECATED  __attribute__ ((deprecated))
67 #else
68 # define DEPRECATED
69 #endif
70
71 #if defined(__linux__)
72 #if defined(__KERNEL__)
73 #include <linux/config.h>
74 #endif
75 #include <asm/ioctl.h>          /* For _IO* macros */
76 #define DRM_IOCTL_NR(n)         _IOC_NR(n)
77 #define DRM_IOC_VOID            _IOC_NONE
78 #define DRM_IOC_READ            _IOC_READ
79 #define DRM_IOC_WRITE           _IOC_WRITE
80 #define DRM_IOC_READWRITE       _IOC_READ|_IOC_WRITE
81 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
82 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
83 #if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__)) && defined(IN_MODULE)
84 /* Prevent name collision when including sys/ioccom.h */
85 #undef ioctl
86 #include <sys/ioccom.h>
87 #define ioctl(a,b,c)            xf86ioctl(a,b,c)
88 #else
89 #include <sys/ioccom.h>
90 #endif                          /* __FreeBSD__ && xf86ioctl */
91 #define DRM_IOCTL_NR(n)         ((n) & 0xff)
92 #define DRM_IOC_VOID            IOC_VOID
93 #define DRM_IOC_READ            IOC_OUT
94 #define DRM_IOC_WRITE           IOC_IN
95 #define DRM_IOC_READWRITE       IOC_INOUT
96 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
97 #endif
98
99 #define XFREE86_VERSION(major,minor,patch,snap) \
100                 ((major << 16) | (minor << 8) | patch)
101
102 #ifndef CONFIG_XFREE86_VERSION
103 #define CONFIG_XFREE86_VERSION XFREE86_VERSION(4,1,0,0)
104 #endif
105
106 #if CONFIG_XFREE86_VERSION < XFREE86_VERSION(4,1,0,0)
107 #define DRM_PROC_DEVICES "/proc/devices"
108 #define DRM_PROC_MISC    "/proc/misc"
109 #define DRM_PROC_DRM     "/proc/drm"
110 #define DRM_DEV_DRM      "/dev/drm"
111 #define DRM_DEV_MODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
112 #define DRM_DEV_UID      0
113 #define DRM_DEV_GID      0
114 #endif
115
116 #if CONFIG_XFREE86_VERSION >= XFREE86_VERSION(4,1,0,0)
117 #ifdef __OpenBSD__
118 #define DRM_MAJOR       81
119 #endif
120 #if defined(__linux__) || defined(__NetBSD__)
121 #define DRM_MAJOR       226
122 #endif
123 #define DRM_MAX_MINOR   15
124 #endif
125 #define DRM_NAME        "drm"     /**< Name in kernel, /dev, and /proc */
126 #define DRM_MIN_ORDER   5         /**< At least 2^5 bytes = 32 bytes */
127 #define DRM_MAX_ORDER   22        /**< Up to 2^22 bytes = 4MB */
128 #define DRM_RAM_PERCENT 10        /**< How much system ram can we lock? */
129
130 #define _DRM_LOCK_HELD  0x80000000U /**< Hardware lock is held */
131 #define _DRM_LOCK_CONT  0x40000000U /**< Hardware lock is contended */
132 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
133 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
134 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
135
136 #if defined(__linux__)
137 typedef unsigned int drm_handle_t;
138 #else
139 typedef unsigned long drm_handle_t;     /**< To mapped regions */
140 #endif
141 typedef unsigned int drm_context_t;     /**< GLXContext handle */
142 typedef unsigned int drm_drawable_t;
143 typedef unsigned int drm_magic_t;       /**< Magic for authentication */
144
145 /**
146  * Cliprect.
147  *
148  * \warning If you change this structure, make sure you change
149  * XF86DRIClipRectRec in the server as well
150  *
151  * \note KW: Actually it's illegal to change either for
152  * backwards-compatibility reasons.
153  */
154 typedef struct drm_clip_rect {
155         unsigned short x1;
156         unsigned short y1;
157         unsigned short x2;
158         unsigned short y2;
159 } drm_clip_rect_t;
160
161 /**
162  * Drawable information.
163  */
164 typedef struct drm_drawable_info {
165         unsigned int num_rects;
166         drm_clip_rect_t *rects;
167 } drm_drawable_info_t;
168
169 /**
170  * Texture region,
171  */
172 typedef struct drm_tex_region {
173         unsigned char next;
174         unsigned char prev;
175         unsigned char in_use;
176         unsigned char padding;
177         unsigned int age;
178 } drm_tex_region_t;
179
180 /**
181  * Hardware lock.
182  *
183  * The lock structure is a simple cache-line aligned integer.  To avoid
184  * processor bus contention on a multiprocessor system, there should not be any
185  * other data stored in the same cache line.
186  */
187 typedef struct drm_hw_lock {
188         __volatile__ unsigned int lock;         /**< lock variable */
189         char padding[60];                       /**< Pad to cache line */
190 } drm_hw_lock_t;
191
192 /* This is beyond ugly, and only works on GCC.  However, it allows me to use
193  * drm.h in places (i.e., in the X-server) where I can't use size_t.  The real
194  * fix is to use uint32_t instead of size_t, but that fix will break existing
195  * LP64 (i.e., PowerPC64, SPARC64, IA-64, Alpha, etc.) systems.  That *will*
196  * eventually happen, though.  I chose 'unsigned long' to be the fallback type
197  * because that works on all the platforms I know about.  Hopefully, the
198  * real fix will happen before that bites us.
199  */
200
201 #ifdef __SIZE_TYPE__
202 # define DRM_SIZE_T __SIZE_TYPE__
203 #else
204 # warning "__SIZE_TYPE__ not defined.  Assuming sizeof(size_t) == sizeof(unsigned long)!"
205 # define DRM_SIZE_T unsigned long
206 #endif
207
208 /**
209  * DRM_IOCTL_VERSION ioctl argument type.
210  *
211  * \sa drmGetVersion().
212  */
213 typedef struct drm_version {
214         int version_major;        /**< Major version */
215         int version_minor;        /**< Minor version */
216         int version_patchlevel;   /**< Patch level */
217         DRM_SIZE_T name_len;      /**< Length of name buffer */
218         char __user *name;                /**< Name of driver */
219         DRM_SIZE_T date_len;      /**< Length of date buffer */
220         char __user *date;                /**< User-space buffer to hold date */
221         DRM_SIZE_T desc_len;      /**< Length of desc buffer */
222         char __user *desc;                /**< User-space buffer to hold desc */
223 } drm_version_t;
224
225 /**
226  * DRM_IOCTL_GET_UNIQUE ioctl argument type.
227  *
228  * \sa drmGetBusid() and drmSetBusId().
229  */
230 typedef struct drm_unique {
231         DRM_SIZE_T unique_len;    /**< Length of unique */
232         char __user *unique;              /**< Unique name for driver instantiation */
233 } drm_unique_t;
234
235 #undef DRM_SIZE_T
236
237 typedef struct drm_list {
238         int count;                /**< Length of user-space structures */
239         drm_version_t __user *version;
240 } drm_list_t;
241
242 typedef struct drm_block {
243         int unused;
244 } drm_block_t;
245
246 /**
247  * DRM_IOCTL_CONTROL ioctl argument type.
248  *
249  * \sa drmCtlInstHandler() and drmCtlUninstHandler().
250  */
251 typedef struct drm_control {
252         enum {
253                 DRM_ADD_COMMAND,
254                 DRM_RM_COMMAND,
255                 DRM_INST_HANDLER,
256                 DRM_UNINST_HANDLER
257         } func;
258         int irq;
259 } drm_control_t;
260
261 /**
262  * Type of memory to map.
263  */
264 typedef enum drm_map_type {
265         _DRM_FRAME_BUFFER = 0,    /**< WC (no caching), no core dump */
266         _DRM_REGISTERS = 1,       /**< no caching, no core dump */
267         _DRM_SHM = 2,             /**< shared, cached */
268         _DRM_AGP = 3,             /**< AGP/GART */
269         _DRM_SCATTER_GATHER = 4,  /**< Scatter/gather memory for PCI DMA */
270         _DRM_CONSISTENT = 5       /**< Consistent memory for PCI DMA */
271 } drm_map_type_t;
272
273 /**
274  * Memory mapping flags.
275  */
276 typedef enum drm_map_flags {
277         _DRM_RESTRICTED = 0x01,      /**< Cannot be mapped to user-virtual */
278         _DRM_READ_ONLY = 0x02,
279         _DRM_LOCKED = 0x04,          /**< shared, cached, locked */
280         _DRM_KERNEL = 0x08,          /**< kernel requires access */
281         _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
282         _DRM_CONTAINS_LOCK = 0x20,   /**< SHM page that contains lock */
283         _DRM_REMOVABLE = 0x40        /**< Removable mapping */
284 } drm_map_flags_t;
285
286 typedef struct drm_ctx_priv_map {
287         unsigned int ctx_id;     /**< Context requesting private mapping */
288         void *handle;            /**< Handle of map */
289 } drm_ctx_priv_map_t;
290
291 /**
292  * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
293  * argument type.
294  *
295  * \sa drmAddMap().
296  */
297 typedef struct drm_map {
298         unsigned long offset;    /**< Requested physical address (0 for SAREA)*/
299         unsigned long size;      /**< Requested physical size (bytes) */
300         drm_map_type_t type;     /**< Type of memory to map */
301         drm_map_flags_t flags;   /**< Flags */
302         void *handle;            /**< User-space: "Handle" to pass to mmap() */
303                                  /**< Kernel-space: kernel-virtual address */
304         int mtrr;                /**< MTRR slot used */
305         /*   Private data */
306 } drm_map_t;
307
308 /**
309  * DRM_IOCTL_GET_CLIENT ioctl argument type.
310  */
311 typedef struct drm_client {
312         int idx;                /**< Which client desired? */
313         int auth;               /**< Is client authenticated? */
314         unsigned long pid;      /**< Process ID */
315         unsigned long uid;      /**< User ID */
316         unsigned long magic;    /**< Magic */
317         unsigned long iocs;     /**< Ioctl count */
318 } drm_client_t;
319
320 typedef enum {
321         _DRM_STAT_LOCK,
322         _DRM_STAT_OPENS,
323         _DRM_STAT_CLOSES,
324         _DRM_STAT_IOCTLS,
325         _DRM_STAT_LOCKS,
326         _DRM_STAT_UNLOCKS,
327         _DRM_STAT_VALUE,        /**< Generic value */
328         _DRM_STAT_BYTE,         /**< Generic byte counter (1024bytes/K) */
329         _DRM_STAT_COUNT,        /**< Generic non-byte counter (1000/k) */
330
331         _DRM_STAT_IRQ,          /**< IRQ */
332         _DRM_STAT_PRIMARY,      /**< Primary DMA bytes */
333         _DRM_STAT_SECONDARY,    /**< Secondary DMA bytes */
334         _DRM_STAT_DMA,          /**< DMA */
335         _DRM_STAT_SPECIAL,      /**< Special DMA (e.g., priority or polled) */
336         _DRM_STAT_MISSED        /**< Missed DMA opportunity */
337             /* Add to the *END* of the list */
338 } drm_stat_type_t;
339
340 /**
341  * DRM_IOCTL_GET_STATS ioctl argument type.
342  */
343 typedef struct drm_stats {
344         unsigned long count;
345         struct {
346                 unsigned long value;
347                 drm_stat_type_t type;
348         } data[15];
349 } drm_stats_t;
350
351 /**
352  * Hardware locking flags.
353  */
354 typedef enum drm_lock_flags {
355         _DRM_LOCK_READY = 0x01,      /**< Wait until hardware is ready for DMA */
356         _DRM_LOCK_QUIESCENT = 0x02,  /**< Wait until hardware quiescent */
357         _DRM_LOCK_FLUSH = 0x04,      /**< Flush this context's DMA queue first */
358         _DRM_LOCK_FLUSH_ALL = 0x08,  /**< Flush all DMA queues first */
359         /* These *HALT* flags aren't supported yet
360            -- they will be used to support the
361            full-screen DGA-like mode. */
362         _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
363         _DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
364 } drm_lock_flags_t;
365
366 /**
367  * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
368  *
369  * \sa drmGetLock() and drmUnlock().
370  */
371 typedef struct drm_lock {
372         int context;
373         drm_lock_flags_t flags;
374 } drm_lock_t;
375
376 /**
377  * DMA flags
378  *
379  * \warning
380  * These values \e must match xf86drm.h.
381  *
382  * \sa drm_dma.
383  */
384 typedef enum drm_dma_flags {
385         /* Flags for DMA buffer dispatch */
386         _DRM_DMA_BLOCK = 0x01,        /**<
387                                        * Block until buffer dispatched.
388                                        *
389                                        * \note The buffer may not yet have
390                                        * been processed by the hardware --
391                                        * getting a hardware lock with the
392                                        * hardware quiescent will ensure
393                                        * that the buffer has been
394                                        * processed.
395                                        */
396         _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
397         _DRM_DMA_PRIORITY = 0x04,     /**< High priority dispatch */
398
399         /* Flags for DMA buffer request */
400         _DRM_DMA_WAIT = 0x10,         /**< Wait for free buffers */
401         _DRM_DMA_SMALLER_OK = 0x20,   /**< Smaller-than-requested buffers OK */
402         _DRM_DMA_LARGER_OK = 0x40     /**< Larger-than-requested buffers OK */
403 } drm_dma_flags_t;
404
405 /**
406  * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
407  *
408  * \sa drmAddBufs().
409  */
410 typedef struct drm_buf_desc {
411         int count;               /**< Number of buffers of this size */
412         int size;                /**< Size in bytes */
413         int low_mark;            /**< Low water mark */
414         int high_mark;           /**< High water mark */
415         enum {
416                 _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
417                 _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
418                 _DRM_SG_BUFFER  = 0x04, /**< Scatter/gather memory buffer */
419                 _DRM_FB_BUFFER  = 0x08  /**< Buffer is in frame buffer */
420         } flags;
421         unsigned long agp_start; /**<
422                                   * Start address of where the AGP buffers are
423                                   * in the AGP aperture
424                                   */
425 } drm_buf_desc_t;
426
427 /**
428  * DRM_IOCTL_INFO_BUFS ioctl argument type.
429  */
430 typedef struct drm_buf_info {
431         int count;                /**< Number of buffers described in list */
432         drm_buf_desc_t __user *list;      /**< List of buffer descriptions */
433 } drm_buf_info_t;
434
435 /**
436  * DRM_IOCTL_FREE_BUFS ioctl argument type.
437  */
438 typedef struct drm_buf_free {
439         int count;
440         int __user *list;
441 } drm_buf_free_t;
442
443 /**
444  * Buffer information
445  *
446  * \sa drm_buf_map.
447  */
448 typedef struct drm_buf_pub {
449         int idx;                       /**< Index into the master buffer list */
450         int total;                     /**< Buffer size */
451         int used;                      /**< Amount of buffer in use (for DMA) */
452         void __user *address;          /**< Address of buffer */
453 } drm_buf_pub_t;
454
455 /**
456  * DRM_IOCTL_MAP_BUFS ioctl argument type.
457  */
458 typedef struct drm_buf_map {
459         int count;              /**< Length of the buffer list */
460 #if defined(__cplusplus)
461         void __user *c_virtual;
462 #else
463         void __user *virtual;           /**< Mmap'd area in user-virtual */
464 #endif
465         drm_buf_pub_t __user *list;     /**< Buffer information */
466 } drm_buf_map_t;
467
468 /**
469  * DRM_IOCTL_DMA ioctl argument type.
470  *
471  * Indices here refer to the offset into the buffer list in drm_buf_get.
472  *
473  * \sa drmDMA().
474  */
475 typedef struct drm_dma {
476         int context;                      /**< Context handle */
477         int send_count;                   /**< Number of buffers to send */
478         int __user *send_indices;         /**< List of handles to buffers */
479         int __user *send_sizes;           /**< Lengths of data to send */
480         drm_dma_flags_t flags;            /**< Flags */
481         int request_count;                /**< Number of buffers requested */
482         int request_size;                 /**< Desired size for buffers */
483         int __user *request_indices;     /**< Buffer information */
484         int __user *request_sizes;
485         int granted_count;                /**< Number of buffers granted */
486 } drm_dma_t;
487
488 typedef enum {
489         _DRM_CONTEXT_PRESERVED = 0x01,
490         _DRM_CONTEXT_2DONLY = 0x02
491 } drm_ctx_flags_t;
492
493 /**
494  * DRM_IOCTL_ADD_CTX ioctl argument type.
495  *
496  * \sa drmCreateContext() and drmDestroyContext().
497  */
498 typedef struct drm_ctx {
499         drm_context_t handle;
500         drm_ctx_flags_t flags;
501 } drm_ctx_t;
502
503 /**
504  * DRM_IOCTL_RES_CTX ioctl argument type.
505  */
506 typedef struct drm_ctx_res {
507         int count;
508         drm_ctx_t __user *contexts;
509 } drm_ctx_res_t;
510
511 /**
512  * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
513  */
514 typedef struct drm_draw {
515         drm_drawable_t handle;
516 } drm_draw_t;
517
518 /**
519  * DRM_IOCTL_UPDATE_DRAW ioctl argument type.
520  */
521 typedef enum {
522         DRM_DRAWABLE_CLIPRECTS,
523 } drm_drawable_info_type_t;
524
525 typedef struct drm_update_draw {
526         drm_drawable_t handle;
527         unsigned int type;
528         unsigned int num;
529         unsigned long long data;
530 } drm_update_draw_t;
531
532 /**
533  * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
534  */
535 typedef struct drm_auth {
536         drm_magic_t magic;
537 } drm_auth_t;
538
539 /**
540  * DRM_IOCTL_IRQ_BUSID ioctl argument type.
541  *
542  * \sa drmGetInterruptFromBusID().
543  */
544 typedef struct drm_irq_busid {
545         int irq;        /**< IRQ number */
546         int busnum;     /**< bus number */
547         int devnum;     /**< device number */
548         int funcnum;    /**< function number */
549 } drm_irq_busid_t;
550
551 typedef enum {
552         _DRM_VBLANK_ABSOLUTE = 0x0,     /**< Wait for specific vblank sequence number */
553         _DRM_VBLANK_RELATIVE = 0x1,     /**< Wait for given number of vblanks */
554         _DRM_VBLANK_SECONDARY = 0x20000000,     /**< Secondary display controller */
555         _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking */
556 } drm_vblank_seq_type_t;
557
558 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE)
559 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_SIGNAL | _DRM_VBLANK_SECONDARY)
560
561 struct drm_wait_vblank_request {
562         drm_vblank_seq_type_t type;
563         unsigned int sequence;
564         unsigned long signal;
565 };
566
567 struct drm_wait_vblank_reply {
568         drm_vblank_seq_type_t type;
569         unsigned int sequence;
570         long tval_sec;
571         long tval_usec;
572 };
573
574 /**
575  * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
576  *
577  * \sa drmWaitVBlank().
578  */
579 typedef union drm_wait_vblank {
580         struct drm_wait_vblank_request request;
581         struct drm_wait_vblank_reply reply;
582 } drm_wait_vblank_t;
583
584 /**
585  * DRM_IOCTL_AGP_ENABLE ioctl argument type.
586  *
587  * \sa drmAgpEnable().
588  */
589 typedef struct drm_agp_mode {
590         unsigned long mode;     /**< AGP mode */
591 } drm_agp_mode_t;
592
593 /**
594  * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
595  *
596  * \sa drmAgpAlloc() and drmAgpFree().
597  */
598 typedef struct drm_agp_buffer {
599         unsigned long size;     /**< In bytes -- will round to page boundary */
600         unsigned long handle;   /**< Used for binding / unbinding */
601         unsigned long type;     /**< Type of memory to allocate */
602         unsigned long physical; /**< Physical used by i810 */
603 } drm_agp_buffer_t;
604
605 /**
606  * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
607  *
608  * \sa drmAgpBind() and drmAgpUnbind().
609  */
610 typedef struct drm_agp_binding {
611         unsigned long handle;   /**< From drm_agp_buffer */
612         unsigned long offset;   /**< In bytes -- will round to page boundary */
613 } drm_agp_binding_t;
614
615 /**
616  * DRM_IOCTL_AGP_INFO ioctl argument type.
617  *
618  * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(),
619  * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(),
620  * drmAgpVendorId() and drmAgpDeviceId().
621  */
622 typedef struct drm_agp_info {
623         int agp_version_major;
624         int agp_version_minor;
625         unsigned long mode;
626         unsigned long aperture_base;   /**< physical address */
627         unsigned long aperture_size;   /**< bytes */
628         unsigned long memory_allowed;  /**< bytes */
629         unsigned long memory_used;
630
631         /** \name PCI information */
632         /*@{ */
633         unsigned short id_vendor;
634         unsigned short id_device;
635         /*@} */
636 } drm_agp_info_t;
637
638 /**
639  * DRM_IOCTL_SG_ALLOC ioctl argument type.
640  */
641 typedef struct drm_scatter_gather {
642         unsigned long size;     /**< In bytes -- will round to page boundary */
643         unsigned long handle;   /**< Used for mapping / unmapping */
644 } drm_scatter_gather_t;
645
646 /**
647  * DRM_IOCTL_SET_VERSION ioctl argument type.
648  */
649 typedef struct drm_set_version {
650         int drm_di_major;
651         int drm_di_minor;
652         int drm_dd_major;
653         int drm_dd_minor;
654 } drm_set_version_t;
655
656 /**
657  * \name Ioctls Definitions
658  */
659 /*@{*/
660
661 #define DRM_IOCTL_BASE                  'd'
662 #define DRM_IO(nr)                      _IO(DRM_IOCTL_BASE,nr)
663 #define DRM_IOR(nr,type)                _IOR(DRM_IOCTL_BASE,nr,type)
664 #define DRM_IOW(nr,type)                _IOW(DRM_IOCTL_BASE,nr,type)
665 #define DRM_IOWR(nr,type)               _IOWR(DRM_IOCTL_BASE,nr,type)
666
667 #define DRM_IOCTL_VERSION               DRM_IOWR(0x00, drm_version_t)
668 #define DRM_IOCTL_GET_UNIQUE            DRM_IOWR(0x01, drm_unique_t)
669 #define DRM_IOCTL_GET_MAGIC             DRM_IOR( 0x02, drm_auth_t)
670 #define DRM_IOCTL_IRQ_BUSID             DRM_IOWR(0x03, drm_irq_busid_t)
671 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, drm_map_t)
672 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, drm_client_t)
673 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, drm_stats_t)
674 #define DRM_IOCTL_SET_VERSION           DRM_IOWR(0x07, drm_set_version_t)
675
676 #define DRM_IOCTL_SET_UNIQUE            DRM_IOW( 0x10, drm_unique_t)
677 #define DRM_IOCTL_AUTH_MAGIC            DRM_IOW( 0x11, drm_auth_t)
678 #define DRM_IOCTL_BLOCK                 DRM_IOWR(0x12, drm_block_t)
679 #define DRM_IOCTL_UNBLOCK               DRM_IOWR(0x13, drm_block_t)
680 #define DRM_IOCTL_CONTROL               DRM_IOW( 0x14, drm_control_t)
681 #define DRM_IOCTL_ADD_MAP               DRM_IOWR(0x15, drm_map_t)
682 #define DRM_IOCTL_ADD_BUFS              DRM_IOWR(0x16, drm_buf_desc_t)
683 #define DRM_IOCTL_MARK_BUFS             DRM_IOW( 0x17, drm_buf_desc_t)
684 #define DRM_IOCTL_INFO_BUFS             DRM_IOWR(0x18, drm_buf_info_t)
685 #define DRM_IOCTL_MAP_BUFS              DRM_IOWR(0x19, drm_buf_map_t)
686 #define DRM_IOCTL_FREE_BUFS             DRM_IOW( 0x1a, drm_buf_free_t)
687
688 #define DRM_IOCTL_RM_MAP                DRM_IOW( 0x1b, drm_map_t)
689
690 #define DRM_IOCTL_SET_SAREA_CTX         DRM_IOW( 0x1c, drm_ctx_priv_map_t)
691 #define DRM_IOCTL_GET_SAREA_CTX         DRM_IOWR(0x1d, drm_ctx_priv_map_t)
692
693 #define DRM_IOCTL_ADD_CTX               DRM_IOWR(0x20, drm_ctx_t)
694 #define DRM_IOCTL_RM_CTX                DRM_IOWR(0x21, drm_ctx_t)
695 #define DRM_IOCTL_MOD_CTX               DRM_IOW( 0x22, drm_ctx_t)
696 #define DRM_IOCTL_GET_CTX               DRM_IOWR(0x23, drm_ctx_t)
697 #define DRM_IOCTL_SWITCH_CTX            DRM_IOW( 0x24, drm_ctx_t)
698 #define DRM_IOCTL_NEW_CTX               DRM_IOW( 0x25, drm_ctx_t)
699 #define DRM_IOCTL_RES_CTX               DRM_IOWR(0x26, drm_ctx_res_t)
700 #define DRM_IOCTL_ADD_DRAW              DRM_IOWR(0x27, drm_draw_t)
701 #define DRM_IOCTL_RM_DRAW               DRM_IOWR(0x28, drm_draw_t)
702 #define DRM_IOCTL_DMA                   DRM_IOWR(0x29, drm_dma_t)
703 #define DRM_IOCTL_LOCK                  DRM_IOW( 0x2a, drm_lock_t)
704 #define DRM_IOCTL_UNLOCK                DRM_IOW( 0x2b, drm_lock_t)
705 #define DRM_IOCTL_FINISH                DRM_IOW( 0x2c, drm_lock_t)
706
707 #define DRM_IOCTL_AGP_ACQUIRE           DRM_IO(  0x30)
708 #define DRM_IOCTL_AGP_RELEASE           DRM_IO(  0x31)
709 #define DRM_IOCTL_AGP_ENABLE            DRM_IOW( 0x32, drm_agp_mode_t)
710 #define DRM_IOCTL_AGP_INFO              DRM_IOR( 0x33, drm_agp_info_t)
711 #define DRM_IOCTL_AGP_ALLOC             DRM_IOWR(0x34, drm_agp_buffer_t)
712 #define DRM_IOCTL_AGP_FREE              DRM_IOW( 0x35, drm_agp_buffer_t)
713 #define DRM_IOCTL_AGP_BIND              DRM_IOW( 0x36, drm_agp_binding_t)
714 #define DRM_IOCTL_AGP_UNBIND            DRM_IOW( 0x37, drm_agp_binding_t)
715
716 #define DRM_IOCTL_SG_ALLOC              DRM_IOW( 0x38, drm_scatter_gather_t)
717 #define DRM_IOCTL_SG_FREE               DRM_IOW( 0x39, drm_scatter_gather_t)
718
719 #define DRM_IOCTL_WAIT_VBLANK           DRM_IOWR(0x3a, drm_wait_vblank_t)
720
721 #define DRM_IOCTL_UPDATE_DRAW           DRM_IOW(0x3f, drm_update_draw_t)
722
723 /*@}*/
724
725 /**
726  * Device specific ioctls should only be in their respective headers
727  * The device specific ioctl range is from 0x40 to 0x79.
728  *
729  * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and
730  * drmCommandReadWrite().
731  */
732 #define DRM_COMMAND_BASE                0x40
733
734 #endif