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