drm: userspace rip out TTM API
[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 #ifndef __iomem
65 #define __iomem
66 #endif
67
68 #ifdef __GNUC__
69 # define DEPRECATED  __attribute__ ((deprecated))
70 #else
71 # define DEPRECATED
72 #endif
73
74 #if defined(__linux__)
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 #include <sys/ioccom.h>
84 #define DRM_IOCTL_NR(n)         ((n) & 0xff)
85 #define DRM_IOC_VOID            IOC_VOID
86 #define DRM_IOC_READ            IOC_OUT
87 #define DRM_IOC_WRITE           IOC_IN
88 #define DRM_IOC_READWRITE       IOC_INOUT
89 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
90 #endif
91
92 #ifdef __OpenBSD__
93 #define DRM_MAJOR       81
94 #endif
95 #if defined(__linux__) || defined(__NetBSD__)
96 #define DRM_MAJOR       226
97 #endif
98 #define DRM_MAX_MINOR   15
99
100 #define DRM_NAME        "drm"     /**< Name in kernel, /dev, and /proc */
101 #define DRM_MIN_ORDER   5         /**< At least 2^5 bytes = 32 bytes */
102 #define DRM_MAX_ORDER   22        /**< Up to 2^22 bytes = 4MB */
103 #define DRM_RAM_PERCENT 10        /**< How much system ram can we lock? */
104
105 #define _DRM_LOCK_HELD  0x80000000U /**< Hardware lock is held */
106 #define _DRM_LOCK_CONT  0x40000000U /**< Hardware lock is contended */
107 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
108 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
109 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
110
111 #if defined(__linux__)
112 typedef unsigned int drm_handle_t;
113 #else
114 #include <sys/types.h>
115 typedef unsigned long drm_handle_t;     /**< To mapped regions */
116 #endif
117 typedef unsigned int drm_context_t;     /**< GLXContext handle */
118 typedef unsigned int drm_drawable_t;
119 typedef unsigned int drm_magic_t;       /**< Magic for authentication */
120
121 /**
122  * Cliprect.
123  *
124  * \warning If you change this structure, make sure you change
125  * XF86DRIClipRectRec in the server as well
126  *
127  * \note KW: Actually it's illegal to change either for
128  * backwards-compatibility reasons.
129  */
130 struct drm_clip_rect {
131         unsigned short x1;
132         unsigned short y1;
133         unsigned short x2;
134         unsigned short y2;
135 };
136
137 /**
138  * Texture region,
139  */
140 struct drm_tex_region {
141         unsigned char next;
142         unsigned char prev;
143         unsigned char in_use;
144         unsigned char padding;
145         unsigned int age;
146 };
147
148 /**
149  * Hardware lock.
150  *
151  * The lock structure is a simple cache-line aligned integer.  To avoid
152  * processor bus contention on a multiprocessor system, there should not be any
153  * other data stored in the same cache line.
154  */
155 struct drm_hw_lock {
156         __volatile__ unsigned int lock;         /**< lock variable */
157         char padding[60];                       /**< Pad to cache line */
158 };
159
160 /* This is beyond ugly, and only works on GCC.  However, it allows me to use
161  * drm.h in places (i.e., in the X-server) where I can't use size_t.  The real
162  * fix is to use uint32_t instead of size_t, but that fix will break existing
163  * LP64 (i.e., PowerPC64, SPARC64, IA-64, Alpha, etc.) systems.  That *will*
164  * eventually happen, though.  I chose 'unsigned long' to be the fallback type
165  * because that works on all the platforms I know about.  Hopefully, the
166  * real fix will happen before that bites us.
167  */
168
169 #ifdef __SIZE_TYPE__
170 # define DRM_SIZE_T __SIZE_TYPE__
171 #else
172 # warning "__SIZE_TYPE__ not defined.  Assuming sizeof(size_t) == sizeof(unsigned long)!"
173 # define DRM_SIZE_T unsigned long
174 #endif
175
176 /**
177  * DRM_IOCTL_VERSION ioctl argument type.
178  *
179  * \sa drmGetVersion().
180  */
181 struct drm_version {
182         int version_major;        /**< Major version */
183         int version_minor;        /**< Minor version */
184         int version_patchlevel;   /**< Patch level */
185         DRM_SIZE_T name_len;      /**< Length of name buffer */
186         char __user *name;                /**< Name of driver */
187         DRM_SIZE_T date_len;      /**< Length of date buffer */
188         char __user *date;                /**< User-space buffer to hold date */
189         DRM_SIZE_T desc_len;      /**< Length of desc buffer */
190         char __user *desc;                /**< User-space buffer to hold desc */
191 };
192
193 /**
194  * DRM_IOCTL_GET_UNIQUE ioctl argument type.
195  *
196  * \sa drmGetBusid() and drmSetBusId().
197  */
198 struct drm_unique {
199         DRM_SIZE_T unique_len;    /**< Length of unique */
200         char __user *unique;              /**< Unique name for driver instantiation */
201 };
202
203 #undef DRM_SIZE_T
204
205 struct drm_list {
206         int count;                /**< Length of user-space structures */
207         struct drm_version __user *version;
208 };
209
210 struct drm_block {
211         int unused;
212 };
213
214 /**
215  * DRM_IOCTL_CONTROL ioctl argument type.
216  *
217  * \sa drmCtlInstHandler() and drmCtlUninstHandler().
218  */
219 struct drm_control {
220         enum {
221                 DRM_ADD_COMMAND,
222                 DRM_RM_COMMAND,
223                 DRM_INST_HANDLER,
224                 DRM_UNINST_HANDLER
225         } func;
226         int irq;
227 };
228
229 /**
230  * Type of memory to map.
231  */
232 enum drm_map_type {
233         _DRM_FRAME_BUFFER = 0,    /**< WC (no caching), no core dump */
234         _DRM_REGISTERS = 1,       /**< no caching, no core dump */
235         _DRM_SHM = 2,             /**< shared, cached */
236         _DRM_AGP = 3,             /**< AGP/GART */
237         _DRM_SCATTER_GATHER = 4,  /**< Scatter/gather memory for PCI DMA */
238         _DRM_CONSISTENT = 5,      /**< Consistent memory for PCI DMA */
239         _DRM_TTM = 6,
240 };
241
242 /**
243  * Memory mapping flags.
244  */
245 enum drm_map_flags {
246         _DRM_RESTRICTED = 0x01,      /**< Cannot be mapped to user-virtual */
247         _DRM_READ_ONLY = 0x02,
248         _DRM_LOCKED = 0x04,          /**< shared, cached, locked */
249         _DRM_KERNEL = 0x08,          /**< kernel requires access */
250         _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
251         _DRM_CONTAINS_LOCK = 0x20,   /**< SHM page that contains lock */
252         _DRM_REMOVABLE = 0x40,       /**< Removable mapping */
253         _DRM_DRIVER = 0x80           /**< Managed by driver */
254 };
255
256 struct drm_ctx_priv_map {
257         unsigned int ctx_id;     /**< Context requesting private mapping */
258         void *handle;            /**< Handle of map */
259 };
260
261 /**
262  * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
263  * argument type.
264  *
265  * \sa drmAddMap().
266  */
267 struct drm_map {
268         unsigned long offset;    /**< Requested physical address (0 for SAREA)*/
269         unsigned long size;      /**< Requested physical size (bytes) */
270         enum drm_map_type type;  /**< Type of memory to map */
271         enum drm_map_flags flags;        /**< Flags */
272         void *handle;            /**< User-space: "Handle" to pass to mmap() */
273                                  /**< Kernel-space: kernel-virtual address */
274         int mtrr;                /**< MTRR slot used */
275         /*   Private data */
276 };
277
278 /**
279  * DRM_IOCTL_GET_CLIENT ioctl argument type.
280  */
281 struct drm_client {
282         int idx;                /**< Which client desired? */
283         int auth;               /**< Is client authenticated? */
284         unsigned long pid;      /**< Process ID */
285         unsigned long uid;      /**< User ID */
286         unsigned long magic;    /**< Magic */
287         unsigned long iocs;     /**< Ioctl count */
288 };
289
290 enum drm_stat_type {
291         _DRM_STAT_LOCK,
292         _DRM_STAT_OPENS,
293         _DRM_STAT_CLOSES,
294         _DRM_STAT_IOCTLS,
295         _DRM_STAT_LOCKS,
296         _DRM_STAT_UNLOCKS,
297         _DRM_STAT_VALUE,        /**< Generic value */
298         _DRM_STAT_BYTE,         /**< Generic byte counter (1024bytes/K) */
299         _DRM_STAT_COUNT,        /**< Generic non-byte counter (1000/k) */
300
301         _DRM_STAT_IRQ,          /**< IRQ */
302         _DRM_STAT_PRIMARY,      /**< Primary DMA bytes */
303         _DRM_STAT_SECONDARY,    /**< Secondary DMA bytes */
304         _DRM_STAT_DMA,          /**< DMA */
305         _DRM_STAT_SPECIAL,      /**< Special DMA (e.g., priority or polled) */
306         _DRM_STAT_MISSED        /**< Missed DMA opportunity */
307             /* Add to the *END* of the list */
308 };
309
310 /**
311  * DRM_IOCTL_GET_STATS ioctl argument type.
312  */
313 struct drm_stats {
314         unsigned long count;
315         struct {
316                 unsigned long value;
317                 enum drm_stat_type type;
318         } data[15];
319 };
320
321 /**
322  * Hardware locking flags.
323  */
324 enum drm_lock_flags {
325         _DRM_LOCK_READY = 0x01,      /**< Wait until hardware is ready for DMA */
326         _DRM_LOCK_QUIESCENT = 0x02,  /**< Wait until hardware quiescent */
327         _DRM_LOCK_FLUSH = 0x04,      /**< Flush this context's DMA queue first */
328         _DRM_LOCK_FLUSH_ALL = 0x08,  /**< Flush all DMA queues first */
329         /* These *HALT* flags aren't supported yet
330            -- they will be used to support the
331            full-screen DGA-like mode. */
332         _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
333         _DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
334 };
335
336 /**
337  * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
338  *
339  * \sa drmGetLock() and drmUnlock().
340  */
341 struct drm_lock {
342         int context;
343         enum drm_lock_flags flags;
344 };
345
346 /**
347  * DMA flags
348  *
349  * \warning
350  * These values \e must match xf86drm.h.
351  *
352  * \sa drm_dma.
353  */
354 enum drm_dma_flags {
355         /* Flags for DMA buffer dispatch */
356         _DRM_DMA_BLOCK = 0x01,        /**<
357                                        * Block until buffer dispatched.
358                                        *
359                                        * \note The buffer may not yet have
360                                        * been processed by the hardware --
361                                        * getting a hardware lock with the
362                                        * hardware quiescent will ensure
363                                        * that the buffer has been
364                                        * processed.
365                                        */
366         _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
367         _DRM_DMA_PRIORITY = 0x04,     /**< High priority dispatch */
368
369         /* Flags for DMA buffer request */
370         _DRM_DMA_WAIT = 0x10,         /**< Wait for free buffers */
371         _DRM_DMA_SMALLER_OK = 0x20,   /**< Smaller-than-requested buffers OK */
372         _DRM_DMA_LARGER_OK = 0x40     /**< Larger-than-requested buffers OK */
373 };
374
375 /**
376  * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
377  *
378  * \sa drmAddBufs().
379  */
380 struct drm_buf_desc {
381         int count;               /**< Number of buffers of this size */
382         int size;                /**< Size in bytes */
383         int low_mark;            /**< Low water mark */
384         int high_mark;           /**< High water mark */
385         enum {
386                 _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
387                 _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
388                 _DRM_SG_BUFFER  = 0x04, /**< Scatter/gather memory buffer */
389                 _DRM_FB_BUFFER  = 0x08, /**< Buffer is in frame buffer */
390                 _DRM_PCI_BUFFER_RO = 0x10 /**< Map PCI DMA buffer read-only */
391         } flags;
392         unsigned long agp_start; /**<
393                                   * Start address of where the AGP buffers are
394                                   * in the AGP aperture
395                                   */
396 };
397
398 /**
399  * DRM_IOCTL_INFO_BUFS ioctl argument type.
400  */
401 struct drm_buf_info {
402         int count;                /**< Number of buffers described in list */
403         struct drm_buf_desc __user *list; /**< List of buffer descriptions */
404 };
405
406 /**
407  * DRM_IOCTL_FREE_BUFS ioctl argument type.
408  */
409 struct drm_buf_free {
410         int count;
411         int __user *list;
412 };
413
414 /**
415  * Buffer information
416  *
417  * \sa drm_buf_map.
418  */
419 struct drm_buf_pub {
420         int idx;                       /**< Index into the master buffer list */
421         int total;                     /**< Buffer size */
422         int used;                      /**< Amount of buffer in use (for DMA) */
423         void __user *address;          /**< Address of buffer */
424 };
425
426 /**
427  * DRM_IOCTL_MAP_BUFS ioctl argument type.
428  */
429 struct drm_buf_map {
430         int count;              /**< Length of the buffer list */
431 #if defined(__cplusplus)
432         void __user *c_virtual;
433 #else
434         void __user *virtual;           /**< Mmap'd area in user-virtual */
435 #endif
436         struct drm_buf_pub __user *list;        /**< Buffer information */
437 };
438
439 /**
440  * DRM_IOCTL_DMA ioctl argument type.
441  *
442  * Indices here refer to the offset into the buffer list in drm_buf_get.
443  *
444  * \sa drmDMA().
445  */
446 struct drm_dma {
447         int context;                      /**< Context handle */
448         int send_count;                   /**< Number of buffers to send */
449         int __user *send_indices;         /**< List of handles to buffers */
450         int __user *send_sizes;           /**< Lengths of data to send */
451         enum drm_dma_flags flags;         /**< Flags */
452         int request_count;                /**< Number of buffers requested */
453         int request_size;                 /**< Desired size for buffers */
454         int __user *request_indices;     /**< Buffer information */
455         int __user *request_sizes;
456         int granted_count;                /**< Number of buffers granted */
457 };
458
459 enum drm_ctx_flags {
460         _DRM_CONTEXT_PRESERVED = 0x01,
461         _DRM_CONTEXT_2DONLY = 0x02
462 };
463
464 /**
465  * DRM_IOCTL_ADD_CTX ioctl argument type.
466  *
467  * \sa drmCreateContext() and drmDestroyContext().
468  */
469 struct drm_ctx {
470         drm_context_t handle;
471         enum drm_ctx_flags flags;
472 };
473
474 /**
475  * DRM_IOCTL_RES_CTX ioctl argument type.
476  */
477 struct drm_ctx_res {
478         int count;
479         struct drm_ctx __user *contexts;
480 };
481
482 /**
483  * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
484  */
485 struct drm_draw {
486         drm_drawable_t handle;
487 };
488
489 /**
490  * DRM_IOCTL_UPDATE_DRAW ioctl argument type.
491  */
492 typedef enum {
493         DRM_DRAWABLE_CLIPRECTS,
494 } drm_drawable_info_type_t;
495
496 struct drm_update_draw {
497         drm_drawable_t handle;
498         unsigned int type;
499         unsigned int num;
500         unsigned long long data;
501 };
502
503 /**
504  * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
505  */
506 struct drm_auth {
507         drm_magic_t magic;
508 };
509
510 /**
511  * DRM_IOCTL_IRQ_BUSID ioctl argument type.
512  *
513  * \sa drmGetInterruptFromBusID().
514  */
515 struct drm_irq_busid {
516         int irq;        /**< IRQ number */
517         int busnum;     /**< bus number */
518         int devnum;     /**< device number */
519         int funcnum;    /**< function number */
520 };
521
522 enum drm_vblank_seq_type {
523         _DRM_VBLANK_ABSOLUTE = 0x0,     /**< Wait for specific vblank sequence number */
524         _DRM_VBLANK_RELATIVE = 0x1,     /**< Wait for given number of vblanks */
525         _DRM_VBLANK_FLIP = 0x8000000,   /**< Scheduled buffer swap should flip */
526         _DRM_VBLANK_NEXTONMISS = 0x10000000,    /**< If missed, wait for next vblank */
527         _DRM_VBLANK_SECONDARY = 0x20000000,     /**< Secondary display controller */
528         _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking */
529 };
530
531 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE)
532 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_SIGNAL | _DRM_VBLANK_SECONDARY | \
533                                 _DRM_VBLANK_NEXTONMISS)
534
535 struct drm_wait_vblank_request {
536         enum drm_vblank_seq_type type;
537         unsigned int sequence;
538         unsigned long signal;
539 };
540
541 struct drm_wait_vblank_reply {
542         enum drm_vblank_seq_type type;
543         unsigned int sequence;
544         long tval_sec;
545         long tval_usec;
546 };
547
548 /**
549  * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
550  *
551  * \sa drmWaitVBlank().
552  */
553 union drm_wait_vblank {
554         struct drm_wait_vblank_request request;
555         struct drm_wait_vblank_reply reply;
556 };
557
558 /* Handle monitor hotplug.
559  *
560  * May want to extend this later to pass reply information which
561  * details the connectors which generated the hotplug event.
562  * Some chipsets can't determine that though, and we'd need to leave
563  * it to the higher levels to determine exactly what changed.
564  */
565 enum drm_hotplug_seq_type {
566         _DRM_HOTPLUG_SIGNAL = 0x00000001, /**< Send signal instead of blocking */
567 };
568 struct drm_wait_hotplug_request {
569         enum drm_hotplug_seq_type type;
570         unsigned long signal;
571 };
572
573 struct drm_wait_hotplug_reply {
574         enum drm_hotplug_seq_type type;
575         unsigned int counter;
576         long tval_sec;
577         long tval_usec;
578 };
579
580 /**
581  * DRM_IOCTL_WAIT_HOTPLUG ioctl argument type.
582  *
583  * \sa drmWaitHotplug().
584  */
585 union drm_wait_hotplug {
586         struct drm_wait_hotplug_request request;
587         struct drm_wait_hotplug_reply reply;
588 };
589
590 enum drm_modeset_ctl_cmd {
591         _DRM_PRE_MODESET = 1,
592         _DRM_POST_MODESET = 2,
593 };
594
595
596 /**
597  * DRM_IOCTL_MODESET_CTL ioctl argument type
598  *
599  * \sa drmModesetCtl().
600  */
601 struct drm_modeset_ctl {
602         uint32_t crtc;
603         uint32_t cmd;
604 };
605
606 /**
607  * DRM_IOCTL_AGP_ENABLE ioctl argument type.
608  *
609  * \sa drmAgpEnable().
610  */
611 struct drm_agp_mode {
612         unsigned long mode;     /**< AGP mode */
613 };
614
615 /**
616  * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
617  *
618  * \sa drmAgpAlloc() and drmAgpFree().
619  */
620 struct drm_agp_buffer {
621         unsigned long size;     /**< In bytes -- will round to page boundary */
622         unsigned long handle;   /**< Used for binding / unbinding */
623         unsigned long type;     /**< Type of memory to allocate */
624         unsigned long physical; /**< Physical used by i810 */
625 };
626
627 /**
628  * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
629  *
630  * \sa drmAgpBind() and drmAgpUnbind().
631  */
632 struct drm_agp_binding {
633         unsigned long handle;   /**< From drm_agp_buffer */
634         unsigned long offset;   /**< In bytes -- will round to page boundary */
635 };
636
637 /**
638  * DRM_IOCTL_AGP_INFO ioctl argument type.
639  *
640  * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(),
641  * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(),
642  * drmAgpVendorId() and drmAgpDeviceId().
643  */
644 struct drm_agp_info {
645         int agp_version_major;
646         int agp_version_minor;
647         unsigned long mode;
648         unsigned long aperture_base;   /**< physical address */
649         unsigned long aperture_size;   /**< bytes */
650         unsigned long memory_allowed;  /**< bytes */
651         unsigned long memory_used;
652
653         /** \name PCI information */
654         /*@{ */
655         unsigned short id_vendor;
656         unsigned short id_device;
657         /*@} */
658 };
659
660 /**
661  * DRM_IOCTL_SG_ALLOC ioctl argument type.
662  */
663 struct drm_scatter_gather {
664         unsigned long size;     /**< In bytes -- will round to page boundary */
665         unsigned long handle;   /**< Used for mapping / unmapping */
666 };
667
668 /**
669  * DRM_IOCTL_SET_VERSION ioctl argument type.
670  */
671 struct drm_set_version {
672         int drm_di_major;
673         int drm_di_minor;
674         int drm_dd_major;
675         int drm_dd_minor;
676 };
677
678 struct drm_gem_close {
679         /** Handle of the object to be closed. */
680         uint32_t handle;
681         uint32_t pad;
682 };
683
684 struct drm_gem_flink {
685         /** Handle for the object being named */
686         uint32_t handle;
687
688         /** Returned global name */
689         uint32_t name;
690 };
691
692 struct drm_gem_open {
693         /** Name of object being opened */
694         uint32_t name;
695
696         /** Returned handle for the object */
697         uint32_t handle;
698         
699         /** Returned size of the object */
700         uint64_t size;
701 };
702
703 /*
704  * Drm mode setting
705  */
706 #define DRM_DISPLAY_INFO_LEN 32
707 #define DRM_CONNECTOR_NAME_LEN 32
708 #define DRM_DISPLAY_MODE_LEN 32
709 #define DRM_PROP_NAME_LEN 32
710
711 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
712 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
713 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
714 #define DRM_MODE_TYPE_PREFERRED (1<<3)
715 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
716 #define DRM_MODE_TYPE_USERDEF   (1<<5)
717 #define DRM_MODE_TYPE_DRIVER    (1<<6)
718
719 /* Video mode flags */
720 /* bit compatible with the xorg definitions. */
721 #define DRM_MODE_FLAG_PHSYNC    (1<<0)
722 #define DRM_MODE_FLAG_NHSYNC    (1<<1)
723 #define DRM_MODE_FLAG_PVSYNC    (1<<2)
724 #define DRM_MODE_FLAG_NVSYNC    (1<<3)
725 #define DRM_MODE_FLAG_INTERLACE (1<<4)
726 #define DRM_MODE_FLAG_DBLSCAN   (1<<5)
727 #define DRM_MODE_FLAG_CSYNC     (1<<6)
728 #define DRM_MODE_FLAG_PCSYNC    (1<<7)
729 #define DRM_MODE_FLAG_NCSYNC    (1<<8)
730 #define DRM_MODE_FLAG_HSKEW     (1<<9) /* hskew provided */
731 #define DRM_MODE_FLAG_BCAST     (1<<10)
732 #define DRM_MODE_FLAG_PIXMUX    (1<<11)
733 #define DRM_MODE_FLAG_DBLCLK    (1<<12)
734 #define DRM_MODE_FLAG_CLKDIV2   (1<<13)
735
736 /* DPMS flags */
737 /* bit compatible with the xorg definitions. */
738 #define DRM_MODE_DPMS_ON 0
739 #define DRM_MODE_DPMS_STANDBY 1
740 #define DRM_MODE_DPMS_SUSPEND 2
741 #define DRM_MODE_DPMS_OFF 3
742
743 /* Scaling mode options */
744 #define DRM_MODE_SCALE_NON_GPU 0
745 #define DRM_MODE_SCALE_FULLSCREEN 1
746 #define DRM_MODE_SCALE_NO_SCALE 2
747 #define DRM_MODE_SCALE_ASPECT 3
748
749 /* Dithering mode options */
750 #define DRM_MODE_DITHERING_OFF 0
751 #define DRM_MODE_DITHERING_ON 1
752
753 struct drm_mode_modeinfo {
754         unsigned int clock;
755         unsigned short hdisplay, hsync_start, hsync_end, htotal, hskew;
756         unsigned short vdisplay, vsync_start, vsync_end, vtotal, vscan;
757
758         unsigned int vrefresh; /* vertical refresh * 1000 */
759
760         unsigned int flags;
761         unsigned int type;
762         char name[DRM_DISPLAY_MODE_LEN];
763 };
764
765 struct drm_mode_card_res {
766         uint64_t fb_id_ptr;
767         uint64_t crtc_id_ptr;
768         uint64_t connector_id_ptr;
769         uint64_t encoder_id_ptr;
770         int count_fbs;
771         int count_crtcs;
772         int count_connectors;
773         int count_encoders;
774         int min_width, max_width;
775         int min_height, max_height;
776 };
777
778 struct drm_mode_crtc {
779         uint64_t set_connectors_ptr;
780         int count_connectors;
781
782         unsigned int crtc_id; /**< Id */
783         unsigned int fb_id; /**< Id of framebuffer */
784
785         int x, y; /**< Position on the frameuffer */
786
787         uint32_t gamma_size;
788         int mode_valid;
789         struct drm_mode_modeinfo mode;
790 };
791
792 #define DRM_MODE_ENCODER_NONE 0
793 #define DRM_MODE_ENCODER_DAC  1
794 #define DRM_MODE_ENCODER_TMDS 2
795 #define DRM_MODE_ENCODER_LVDS 3
796 #define DRM_MODE_ENCODER_TVDAC 4
797
798 struct drm_mode_get_encoder {
799
800         unsigned int encoder_type;
801         unsigned int encoder_id;
802
803         unsigned int crtc_id; /**< Id of crtc */
804
805         uint32_t possible_crtcs;
806         uint32_t possible_clones;
807 };
808
809 /* This is for connectors with multiple signal types. */
810 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
811 #define DRM_MODE_SUBCONNECTOR_Automatic 0
812 #define DRM_MODE_SUBCONNECTOR_Unknown 0
813 #define DRM_MODE_SUBCONNECTOR_DVID 3
814 #define DRM_MODE_SUBCONNECTOR_DVIA 4
815 #define DRM_MODE_SUBCONNECTOR_Composite 5
816 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6
817 #define DRM_MODE_SUBCONNECTOR_Component 8
818
819 #define DRM_MODE_CONNECTOR_Unknown 0
820 #define DRM_MODE_CONNECTOR_VGA 1
821 #define DRM_MODE_CONNECTOR_DVII 2
822 #define DRM_MODE_CONNECTOR_DVID 3
823 #define DRM_MODE_CONNECTOR_DVIA 4
824 #define DRM_MODE_CONNECTOR_Composite 5
825 #define DRM_MODE_CONNECTOR_SVIDEO 6
826 #define DRM_MODE_CONNECTOR_LVDS 7
827 #define DRM_MODE_CONNECTOR_Component 8
828 #define DRM_MODE_CONNECTOR_9PinDIN 9
829 #define DRM_MODE_CONNECTOR_DisplayPort 10
830 #define DRM_MODE_CONNECTOR_HDMIA 11
831 #define DRM_MODE_CONNECTOR_HDMIB 12
832
833 struct drm_mode_get_connector {
834
835         uint64_t encoders_ptr;
836         uint64_t modes_ptr;
837         uint64_t props_ptr;
838         uint64_t prop_values_ptr;
839
840         int count_modes;
841         int count_props;
842         int count_encoders;
843
844         unsigned int encoder_id; /**< Current Encoder */
845         unsigned int connector_id; /**< Id */
846         unsigned int connector_type;
847         unsigned int connector_type_id;
848
849         unsigned int connection;
850         unsigned int mm_width, mm_height; /**< HxW in millimeters */
851         unsigned int subpixel;
852 };
853
854 #define DRM_MODE_PROP_PENDING (1<<0)
855 #define DRM_MODE_PROP_RANGE (1<<1)
856 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
857 #define DRM_MODE_PROP_ENUM (1<<3) // enumerated type with text strings
858 #define DRM_MODE_PROP_BLOB (1<<4)
859
860 struct drm_mode_property_enum {
861         uint64_t value;
862         unsigned char name[DRM_PROP_NAME_LEN];
863 };
864
865 struct drm_mode_get_property {
866         uint64_t values_ptr; /* values and blob lengths */
867         uint64_t enum_blob_ptr; /* enum and blob id ptrs */
868
869         unsigned int prop_id;
870         unsigned int flags;
871         unsigned char name[DRM_PROP_NAME_LEN];
872
873         int count_values;
874         int count_enum_blobs;
875 };
876
877 struct drm_mode_connector_set_property {
878         uint64_t value;
879         unsigned int prop_id;
880         unsigned int connector_id;
881 };
882
883 struct drm_mode_get_blob {
884         uint32_t blob_id;
885         uint32_t length;
886         uint64_t data;
887 };
888
889 struct drm_mode_fb_cmd {
890         unsigned int buffer_id;
891         unsigned int width, height;
892         unsigned int pitch;
893         unsigned int bpp;
894         unsigned int handle;
895         unsigned int depth;
896 };
897
898 struct drm_mode_mode_cmd {
899         unsigned int connector_id;
900         struct drm_mode_modeinfo mode;
901 };
902
903 #define DRM_MODE_CURSOR_BO   0x01
904 #define DRM_MODE_CURSOR_MOVE 0x02
905
906 /*
907  * depending on the value in flags diffrent members are used.
908  *
909  * CURSOR_BO uses
910  *    crtc
911  *    width
912  *    height
913  *    handle - if 0 turns the cursor of
914  *
915  * CURSOR_MOVE uses
916  *    crtc
917  *    x
918  *    y
919  */
920 struct drm_mode_cursor {
921         unsigned int flags;
922         unsigned int crtc;
923         int x;
924         int y;
925         uint32_t width;
926         uint32_t height;
927         unsigned int handle;
928 };
929
930 /*
931  * oh so ugly hotplug
932  */
933 struct drm_mode_hotplug {
934         uint32_t counter;
935 };
936
937 struct drm_mode_crtc_lut {
938
939         uint32_t crtc_id;
940         uint32_t gamma_size;
941
942         uint64_t red;
943         uint64_t green;
944         uint64_t blue;
945 };
946
947 /**
948  * \name Ioctls Definitions
949  */
950 /*@{*/
951
952 #define DRM_IOCTL_BASE                  'd'
953 #define DRM_IO(nr)                      _IO(DRM_IOCTL_BASE,nr)
954 #define DRM_IOR(nr,type)                _IOR(DRM_IOCTL_BASE,nr,type)
955 #define DRM_IOW(nr,type)                _IOW(DRM_IOCTL_BASE,nr,type)
956 #define DRM_IOWR(nr,type)               _IOWR(DRM_IOCTL_BASE,nr,type)
957
958 #define DRM_IOCTL_VERSION               DRM_IOWR(0x00, struct drm_version)
959 #define DRM_IOCTL_GET_UNIQUE            DRM_IOWR(0x01, struct drm_unique)
960 #define DRM_IOCTL_GET_MAGIC             DRM_IOR( 0x02, struct drm_auth)
961 #define DRM_IOCTL_IRQ_BUSID             DRM_IOWR(0x03, struct drm_irq_busid)
962 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, struct drm_map)
963 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, struct drm_client)
964 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, struct drm_stats)
965 #define DRM_IOCTL_SET_VERSION           DRM_IOWR(0x07, struct drm_set_version)
966 #define DRM_IOCTL_MODESET_CTL           DRM_IOW(0x08,  struct drm_modeset_ctl)
967
968 #define DRM_IOCTL_GEM_CLOSE             DRM_IOW (0x09, struct drm_gem_close)
969 #define DRM_IOCTL_GEM_FLINK             DRM_IOWR(0x0a, struct drm_gem_flink)
970 #define DRM_IOCTL_GEM_OPEN              DRM_IOWR(0x0b, struct drm_gem_open)
971
972 #define DRM_IOCTL_SET_UNIQUE            DRM_IOW( 0x10, struct drm_unique)
973 #define DRM_IOCTL_AUTH_MAGIC            DRM_IOW( 0x11, struct drm_auth)
974 #define DRM_IOCTL_BLOCK                 DRM_IOWR(0x12, struct drm_block)
975 #define DRM_IOCTL_UNBLOCK               DRM_IOWR(0x13, struct drm_block)
976 #define DRM_IOCTL_CONTROL               DRM_IOW( 0x14, struct drm_control)
977 #define DRM_IOCTL_ADD_MAP               DRM_IOWR(0x15, struct drm_map)
978 #define DRM_IOCTL_ADD_BUFS              DRM_IOWR(0x16, struct drm_buf_desc)
979 #define DRM_IOCTL_MARK_BUFS             DRM_IOW( 0x17, struct drm_buf_desc)
980 #define DRM_IOCTL_INFO_BUFS             DRM_IOWR(0x18, struct drm_buf_info)
981 #define DRM_IOCTL_MAP_BUFS              DRM_IOWR(0x19, struct drm_buf_map)
982 #define DRM_IOCTL_FREE_BUFS             DRM_IOW( 0x1a, struct drm_buf_free)
983
984 #define DRM_IOCTL_RM_MAP                DRM_IOW( 0x1b, struct drm_map)
985
986 #define DRM_IOCTL_SET_SAREA_CTX         DRM_IOW( 0x1c, struct drm_ctx_priv_map)
987 #define DRM_IOCTL_GET_SAREA_CTX         DRM_IOWR(0x1d, struct drm_ctx_priv_map)
988
989 #define DRM_IOCTL_SET_MASTER            DRM_IO(0x1e)
990 #define DRM_IOCTL_DROP_MASTER           DRM_IO(0x1f)
991
992 #define DRM_IOCTL_ADD_CTX               DRM_IOWR(0x20, struct drm_ctx)
993 #define DRM_IOCTL_RM_CTX                DRM_IOWR(0x21, struct drm_ctx)
994 #define DRM_IOCTL_MOD_CTX               DRM_IOW( 0x22, struct drm_ctx)
995 #define DRM_IOCTL_GET_CTX               DRM_IOWR(0x23, struct drm_ctx)
996 #define DRM_IOCTL_SWITCH_CTX            DRM_IOW( 0x24, struct drm_ctx)
997 #define DRM_IOCTL_NEW_CTX               DRM_IOW( 0x25, struct drm_ctx)
998 #define DRM_IOCTL_RES_CTX               DRM_IOWR(0x26, struct drm_ctx_res)
999 #define DRM_IOCTL_ADD_DRAW              DRM_IOWR(0x27, struct drm_draw)
1000 #define DRM_IOCTL_RM_DRAW               DRM_IOWR(0x28, struct drm_draw)
1001 #define DRM_IOCTL_DMA                   DRM_IOWR(0x29, struct drm_dma)
1002 #define DRM_IOCTL_LOCK                  DRM_IOW( 0x2a, struct drm_lock)
1003 #define DRM_IOCTL_UNLOCK                DRM_IOW( 0x2b, struct drm_lock)
1004 #define DRM_IOCTL_FINISH                DRM_IOW( 0x2c, struct drm_lock)
1005
1006 #define DRM_IOCTL_AGP_ACQUIRE           DRM_IO(  0x30)
1007 #define DRM_IOCTL_AGP_RELEASE           DRM_IO(  0x31)
1008 #define DRM_IOCTL_AGP_ENABLE            DRM_IOW( 0x32, struct drm_agp_mode)
1009 #define DRM_IOCTL_AGP_INFO              DRM_IOR( 0x33, struct drm_agp_info)
1010 #define DRM_IOCTL_AGP_ALLOC             DRM_IOWR(0x34, struct drm_agp_buffer)
1011 #define DRM_IOCTL_AGP_FREE              DRM_IOW( 0x35, struct drm_agp_buffer)
1012 #define DRM_IOCTL_AGP_BIND              DRM_IOW( 0x36, struct drm_agp_binding)
1013 #define DRM_IOCTL_AGP_UNBIND            DRM_IOW( 0x37, struct drm_agp_binding)
1014
1015 #define DRM_IOCTL_SG_ALLOC              DRM_IOW( 0x38, struct drm_scatter_gather)
1016 #define DRM_IOCTL_SG_FREE               DRM_IOW( 0x39, struct drm_scatter_gather)
1017
1018 #define DRM_IOCTL_WAIT_VBLANK           DRM_IOWR(0x3a, union drm_wait_vblank)
1019
1020 #define DRM_IOCTL_UPDATE_DRAW           DRM_IOW(0x3f, struct drm_update_draw)
1021
1022 #define DRM_IOCTL_MODE_GETRESOURCES     DRM_IOWR(0xA0, struct drm_mode_card_res)
1023 #define DRM_IOCTL_MODE_GETCRTC          DRM_IOWR(0xA1, struct drm_mode_crtc)
1024 #define DRM_IOCTL_MODE_GETCONNECTOR        DRM_IOWR(0xA2, struct drm_mode_get_connector)
1025 #define DRM_IOCTL_MODE_SETCRTC          DRM_IOWR(0xA3, struct drm_mode_crtc)
1026 #define DRM_IOCTL_MODE_ADDFB            DRM_IOWR(0xA4, struct drm_mode_fb_cmd)
1027 #define DRM_IOCTL_MODE_RMFB             DRM_IOWR(0xA5, unsigned int)
1028 #define DRM_IOCTL_MODE_GETFB            DRM_IOWR(0xA6, struct drm_mode_fb_cmd)
1029
1030 #define DRM_IOCTL_MODE_SETPROPERTY     DRM_IOWR(0xA7, struct drm_mode_connector_set_property)
1031 #define DRM_IOCTL_MODE_GETPROPBLOB     DRM_IOWR(0xA8, struct drm_mode_get_blob)
1032 #define DRM_IOCTL_MODE_ATTACHMODE      DRM_IOWR(0xA9, struct drm_mode_mode_cmd)
1033 #define DRM_IOCTL_MODE_DETACHMODE      DRM_IOWR(0xAA, struct drm_mode_mode_cmd)
1034
1035 #define DRM_IOCTL_MODE_GETPROPERTY     DRM_IOWR(0xAB, struct drm_mode_get_property)
1036 #define DRM_IOCTL_MODE_CURSOR          DRM_IOWR(0xAC, struct drm_mode_cursor)
1037 #define DRM_IOCTL_MODE_HOTPLUG         DRM_IOWR(0xAD, struct drm_mode_hotplug)
1038 #define DRM_IOCTL_WAIT_HOTPLUG          DRM_IOWR(0xAE, union drm_wait_hotplug)
1039
1040 #define DRM_IOCTL_MODE_REPLACEFB       DRM_IOWR(0xAF, struct drm_mode_fb_cmd)
1041 #define DRM_IOCTL_MODE_GETENCODER      DRM_IOWR(0xB0, struct drm_mode_get_encoder)
1042 #define DRM_IOCTL_MODE_GETGAMMA        DRM_IOWR(0xB1, struct drm_mode_crtc_lut)
1043 #define DRM_IOCTL_MODE_SETGAMMA        DRM_IOWR(0xB2, struct drm_mode_crtc_lut)
1044
1045 /*@}*/
1046
1047 /**
1048  * Device specific ioctls should only be in their respective headers
1049  * The device specific ioctl range is from 0x40 to 0x99.
1050  * Generic IOCTLS restart at 0xA0.
1051  *
1052  * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and
1053  * drmCommandReadWrite().
1054  */
1055 #define DRM_COMMAND_BASE                0x40
1056 #define DRM_COMMAND_END                 0xA0
1057
1058 /* typedef area */
1059 #if !defined(__KERNEL__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
1060 typedef struct drm_clip_rect drm_clip_rect_t;
1061 typedef struct drm_tex_region drm_tex_region_t;
1062 typedef struct drm_hw_lock drm_hw_lock_t;
1063 typedef struct drm_version drm_version_t;
1064 typedef struct drm_unique drm_unique_t;
1065 typedef struct drm_list drm_list_t;
1066 typedef struct drm_block drm_block_t;
1067 typedef struct drm_control drm_control_t;
1068 typedef enum drm_map_type drm_map_type_t;
1069 typedef enum drm_map_flags drm_map_flags_t;
1070 typedef struct drm_ctx_priv_map drm_ctx_priv_map_t;
1071 typedef struct drm_map drm_map_t;
1072 typedef struct drm_client drm_client_t;
1073 typedef enum drm_stat_type drm_stat_type_t;
1074 typedef struct drm_stats drm_stats_t;
1075 typedef enum drm_lock_flags drm_lock_flags_t;
1076 typedef struct drm_lock drm_lock_t;
1077 typedef enum drm_dma_flags drm_dma_flags_t;
1078 typedef struct drm_buf_desc drm_buf_desc_t;
1079 typedef struct drm_buf_info drm_buf_info_t;
1080 typedef struct drm_buf_free drm_buf_free_t;
1081 typedef struct drm_buf_pub drm_buf_pub_t;
1082 typedef struct drm_buf_map drm_buf_map_t;
1083 typedef struct drm_dma drm_dma_t;
1084 typedef union drm_wait_vblank drm_wait_vblank_t;
1085 typedef struct drm_agp_mode drm_agp_mode_t;
1086 typedef enum drm_ctx_flags drm_ctx_flags_t;
1087 typedef struct drm_ctx drm_ctx_t;
1088 typedef struct drm_ctx_res drm_ctx_res_t;
1089 typedef struct drm_draw drm_draw_t;
1090 typedef struct drm_update_draw drm_update_draw_t;
1091 typedef struct drm_auth drm_auth_t;
1092 typedef struct drm_irq_busid drm_irq_busid_t;
1093 typedef enum drm_vblank_seq_type drm_vblank_seq_type_t;
1094 typedef struct drm_agp_buffer drm_agp_buffer_t;
1095 typedef struct drm_agp_binding drm_agp_binding_t;
1096 typedef struct drm_agp_info drm_agp_info_t;
1097 typedef struct drm_scatter_gather drm_scatter_gather_t;
1098 typedef struct drm_set_version drm_set_version_t;
1099
1100 typedef struct drm_fence_arg drm_fence_arg_t;
1101 typedef struct drm_mm_type_arg drm_mm_type_arg_t;
1102 typedef struct drm_mm_init_arg drm_mm_init_arg_t;
1103 typedef enum drm_bo_type drm_bo_type_t;
1104 #endif
1105
1106 #endif