Support for building DRM module on OpenBSD (Wilbern Cobb, Matthieu Herrb).
[platform/upstream/libdrm.git] / shared-core / drm.h
1 /* drm.h -- Header for Direct Rendering Manager -*- linux-c -*-
2  * Created: Mon Jan  4 10:05:05 1999 by faith@precisioninsight.com
3  *
4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6  * All rights reserved.
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice (including the next
16  * paragraph) shall be included in all copies or substantial portions of the
17  * Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
22  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  *
27  * Authors:
28  *    Rickard E. (Rik) Faith <faith@valinux.com>
29  *
30  * Acknowledgements:
31  * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic cmpxchg.
32  *
33  */
34
35 #ifndef _DRM_H_
36 #define _DRM_H_
37
38 #if defined(__linux__)
39 #include <linux/config.h>
40 #include <asm/ioctl.h>          /* For _IO* macros */
41 #define DRM_IOCTL_NR(n)         _IOC_NR(n)
42 #define DRM_IOC_VOID            _IOC_NONE
43 #define DRM_IOC_READ            _IOC_READ
44 #define DRM_IOC_WRITE           _IOC_WRITE
45 #define DRM_IOC_READWRITE       _IOC_READ|_IOC_WRITE
46 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
47 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
48 #if defined(__FreeBSD__) && defined(XFree86Server)
49 /* Prevent name collision when including sys/ioccom.h */
50 #undef ioctl
51 #include <sys/ioccom.h>
52 #define ioctl(a,b,c)            xf86ioctl(a,b,c)
53 #else
54 #include <sys/ioccom.h>
55 #endif /* __FreeBSD__ && xf86ioctl */
56 #define DRM_IOCTL_NR(n)         ((n) & 0xff)
57 #define DRM_IOC_VOID            IOC_VOID
58 #define DRM_IOC_READ            IOC_OUT
59 #define DRM_IOC_WRITE           IOC_IN
60 #define DRM_IOC_READWRITE       IOC_INOUT
61 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
62 #endif
63
64 #define XFREE86_VERSION(major,minor,patch,snap) \
65                 ((major << 16) | (minor << 8) | patch)
66
67 #ifndef CONFIG_XFREE86_VERSION
68 #define CONFIG_XFREE86_VERSION XFREE86_VERSION(4,1,0,0)
69 #endif
70
71 #if CONFIG_XFREE86_VERSION < XFREE86_VERSION(4,1,0,0)
72 #define DRM_PROC_DEVICES "/proc/devices"
73 #define DRM_PROC_MISC    "/proc/misc"
74 #define DRM_PROC_DRM     "/proc/drm"
75 #define DRM_DEV_DRM      "/dev/drm"
76 #define DRM_DEV_MODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
77 #define DRM_DEV_UID      0
78 #define DRM_DEV_GID      0
79 #endif
80
81 #if CONFIG_XFREE86_VERSION >= XFREE86_VERSION(4,1,0,0)
82 #ifdef __OpenBSD__
83 #define DRM_MAJOR       81
84 #else
85 #define DRM_MAJOR       226
86 #endif
87 #define DRM_MAX_MINOR   15
88 #endif
89 #define DRM_NAME        "drm"     /* Name in kernel, /dev, and /proc        */
90 #define DRM_MIN_ORDER   5         /* At least 2^5 bytes = 32 bytes          */
91 #define DRM_MAX_ORDER   22        /* Up to 2^22 bytes = 4MB                 */
92 #define DRM_RAM_PERCENT 10        /* How much system ram can we lock?       */
93
94 #define _DRM_LOCK_HELD  0x80000000 /* Hardware lock is held                 */
95 #define _DRM_LOCK_CONT  0x40000000 /* Hardware lock is contended            */
96 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
97 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
98 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
99
100 typedef unsigned long drm_handle_t;
101 typedef unsigned int  drm_context_t;
102 typedef unsigned int  drm_drawable_t;
103 typedef unsigned int  drm_magic_t;
104
105 /* Warning: If you change this structure, make sure you change
106  * XF86DRIClipRectRec in the server as well */
107
108 /* KW: Actually it's illegal to change either for
109  * backwards-compatibility reasons.
110  */
111
112 typedef struct drm_clip_rect {
113         unsigned short  x1;
114         unsigned short  y1;
115         unsigned short  x2;
116         unsigned short  y2;
117 } drm_clip_rect_t;
118
119 typedef struct drm_tex_region {
120         unsigned char   next;
121         unsigned char   prev;
122         unsigned char   in_use;
123         unsigned char   padding;
124         unsigned int    age;
125 } drm_tex_region_t;
126
127 typedef struct drm_version {
128         int    version_major;     /* Major version                          */
129         int    version_minor;     /* Minor version                          */
130         int    version_patchlevel;/* Patch level                            */
131         size_t name_len;          /* Length of name buffer                  */
132         char   *name;             /* Name of driver                         */
133         size_t date_len;          /* Length of date buffer                  */
134         char   *date;             /* User-space buffer to hold date         */
135         size_t desc_len;          /* Length of desc buffer                  */
136         char   *desc;             /* User-space buffer to hold desc         */
137 } drm_version_t;
138
139 typedef struct drm_unique {
140         size_t unique_len;        /* Length of unique                       */
141         char   *unique;           /* Unique name for driver instantiation   */
142 } drm_unique_t;
143
144 typedef struct drm_list {
145         int              count;   /* Length of user-space structures        */
146         drm_version_t    *version;
147 } drm_list_t;
148
149 typedef struct drm_block {
150         int              unused;
151 } drm_block_t;
152
153 typedef struct drm_control {
154         enum {
155                 DRM_ADD_COMMAND,
156                 DRM_RM_COMMAND,
157                 DRM_INST_HANDLER,
158                 DRM_UNINST_HANDLER
159         }                func;
160         int              irq;
161 } drm_control_t;
162
163 typedef enum drm_map_type {
164         _DRM_FRAME_BUFFER   = 0,  /* WC (no caching), no core dump          */
165         _DRM_REGISTERS      = 1,  /* no caching, no core dump               */
166         _DRM_SHM            = 2,  /* shared, cached                         */
167         _DRM_AGP            = 3,  /* AGP/GART                               */
168         _DRM_SCATTER_GATHER = 4   /* Scatter/gather memory for PCI DMA      */
169 } drm_map_type_t;
170
171 typedef enum drm_map_flags {
172         _DRM_RESTRICTED      = 0x01, /* Cannot be mapped to user-virtual    */
173         _DRM_READ_ONLY       = 0x02,
174         _DRM_LOCKED          = 0x04, /* shared, cached, locked              */
175         _DRM_KERNEL          = 0x08, /* kernel requires access              */
176         _DRM_WRITE_COMBINING = 0x10, /* use write-combining if available    */
177         _DRM_CONTAINS_LOCK   = 0x20, /* SHM page that contains lock         */
178         _DRM_REMOVABLE       = 0x40  /* Removable mapping                   */
179 } drm_map_flags_t;
180
181 typedef struct drm_ctx_priv_map {
182         unsigned int    ctx_id;  /* Context requesting private mapping */
183         void            *handle; /* Handle of map */
184 } drm_ctx_priv_map_t;
185
186 typedef struct drm_map {
187         unsigned long   offset;  /* Requested physical address (0 for SAREA)*/
188         unsigned long   size;    /* Requested physical size (bytes)         */
189         drm_map_type_t  type;    /* Type of memory to map                   */
190         drm_map_flags_t flags;   /* Flags                                   */
191         void            *handle; /* User-space: "Handle" to pass to mmap    */
192                                  /* Kernel-space: kernel-virtual address    */
193         int             mtrr;    /* MTRR slot used                          */
194                                  /* Private data                            */
195 } drm_map_t;
196
197 typedef struct drm_client {
198         int             idx;    /* Which client desired?                    */
199         int             auth;   /* Is client authenticated?                 */
200         unsigned long   pid;    /* Process id                               */
201         unsigned long   uid;    /* User id                                  */
202         unsigned long   magic;  /* Magic                                    */
203         unsigned long   iocs;   /* Ioctl count                              */
204 } drm_client_t;
205
206 typedef enum {
207         _DRM_STAT_LOCK,
208         _DRM_STAT_OPENS,
209         _DRM_STAT_CLOSES,
210         _DRM_STAT_IOCTLS,
211         _DRM_STAT_LOCKS,
212         _DRM_STAT_UNLOCKS,
213         _DRM_STAT_VALUE,        /* Generic value                      */
214         _DRM_STAT_BYTE,         /* Generic byte counter (1024bytes/K) */
215         _DRM_STAT_COUNT,        /* Generic non-byte counter (1000/k)  */
216
217         _DRM_STAT_IRQ,          /* IRQ */
218         _DRM_STAT_PRIMARY,      /* Primary DMA bytes */
219         _DRM_STAT_SECONDARY,    /* Secondary DMA bytes */
220         _DRM_STAT_DMA,          /* DMA */
221         _DRM_STAT_SPECIAL,      /* Special DMA (e.g., priority or polled) */
222         _DRM_STAT_MISSED        /* Missed DMA opportunity */
223
224                                 /* Add to the *END* of the list */
225 } drm_stat_type_t;
226
227 typedef struct drm_stats {
228         unsigned long count;
229         struct {
230                 unsigned long   value;
231                 drm_stat_type_t type;
232         } data[15];
233 } drm_stats_t;
234
235 typedef enum drm_lock_flags {
236         _DRM_LOCK_READY      = 0x01, /* Wait until hardware is ready for DMA */
237         _DRM_LOCK_QUIESCENT  = 0x02, /* Wait until hardware quiescent        */
238         _DRM_LOCK_FLUSH      = 0x04, /* Flush this context's DMA queue first */
239         _DRM_LOCK_FLUSH_ALL  = 0x08, /* Flush all DMA queues first           */
240                                 /* These *HALT* flags aren't supported yet
241                                    -- they will be used to support the
242                                    full-screen DGA-like mode. */
243         _DRM_HALT_ALL_QUEUES = 0x10, /* Halt all current and future queues   */
244         _DRM_HALT_CUR_QUEUES = 0x20  /* Halt all current queues              */
245 } drm_lock_flags_t;
246
247 typedef struct drm_lock {
248         int              context;
249         drm_lock_flags_t flags;
250 } drm_lock_t;
251
252 typedef enum drm_dma_flags {          /* These values *MUST* match xf86drm.h */
253                                       /* Flags for DMA buffer dispatch       */
254         _DRM_DMA_BLOCK        = 0x01, /* Block until buffer dispatched.
255                                          Note, the buffer may not yet have
256                                          been processed by the hardware --
257                                          getting a hardware lock with the
258                                          hardware quiescent will ensure
259                                          that the buffer has been
260                                          processed.                          */
261         _DRM_DMA_WHILE_LOCKED = 0x02, /* Dispatch while lock held            */
262         _DRM_DMA_PRIORITY     = 0x04, /* High priority dispatch              */
263
264                                       /* Flags for DMA buffer request        */
265         _DRM_DMA_WAIT         = 0x10, /* Wait for free buffers               */
266         _DRM_DMA_SMALLER_OK   = 0x20, /* Smaller-than-requested buffers ok   */
267         _DRM_DMA_LARGER_OK    = 0x40  /* Larger-than-requested buffers ok    */
268 } drm_dma_flags_t;
269
270 typedef struct drm_buf_desc {
271         int           count;     /* Number of buffers of this size           */
272         int           size;      /* Size in bytes                            */
273         int           low_mark;  /* Low water mark                           */
274         int           high_mark; /* High water mark                          */
275         enum {
276                 _DRM_PAGE_ALIGN = 0x01, /* Align on page boundaries for DMA  */
277                 _DRM_AGP_BUFFER = 0x02, /* Buffer is in agp space            */
278                 _DRM_SG_BUFFER  = 0x04  /* Scatter/gather memory buffer      */
279         }             flags;
280         unsigned long agp_start; /* Start address of where the agp buffers
281                                   * are in the agp aperture */
282 } drm_buf_desc_t;
283
284 typedef struct drm_buf_info {
285         int            count;   /* Entries in list                           */
286         drm_buf_desc_t *list;
287 } drm_buf_info_t;
288
289 typedef struct drm_buf_free {
290         int            count;
291         int            *list;
292 } drm_buf_free_t;
293
294 typedef struct drm_buf_pub {
295         int               idx;         /* Index into master buflist          */
296         int               total;       /* Buffer size                        */
297         int               used;        /* Amount of buffer in use (for DMA)  */
298         void              *address;    /* Address of buffer                  */
299 } drm_buf_pub_t;
300
301 typedef struct drm_buf_map {
302         int           count;    /* Length of buflist                        */
303         void          *virtual; /* Mmaped area in user-virtual              */
304         drm_buf_pub_t *list;    /* Buffer information                       */
305 } drm_buf_map_t;
306
307 typedef struct drm_dma {
308                                 /* Indices here refer to the offset into
309                                    buflist in drm_buf_get_t.  */
310         int             context;          /* Context handle                 */
311         int             send_count;       /* Number of buffers to send      */
312         int             *send_indices;    /* List of handles to buffers     */
313         int             *send_sizes;      /* Lengths of data to send        */
314         drm_dma_flags_t flags;            /* Flags                          */
315         int             request_count;    /* Number of buffers requested    */
316         int             request_size;     /* Desired size for buffers       */
317         int             *request_indices; /* Buffer information             */
318         int             *request_sizes;
319         int             granted_count;    /* Number of buffers granted      */
320 } drm_dma_t;
321
322 typedef enum {
323         _DRM_CONTEXT_PRESERVED = 0x01,
324         _DRM_CONTEXT_2DONLY    = 0x02
325 } drm_ctx_flags_t;
326
327 typedef struct drm_ctx {
328         drm_context_t   handle;
329         drm_ctx_flags_t flags;
330 } drm_ctx_t;
331
332 typedef struct drm_ctx_res {
333         int             count;
334         drm_ctx_t       *contexts;
335 } drm_ctx_res_t;
336
337 typedef struct drm_draw {
338         drm_drawable_t  handle;
339 } drm_draw_t;
340
341 typedef struct drm_auth {
342         drm_magic_t     magic;
343 } drm_auth_t;
344
345 typedef struct drm_irq_busid {
346         int irq;
347         int busnum;
348         int devnum;
349         int funcnum;
350 } drm_irq_busid_t;
351
352 typedef enum {
353     _DRM_VBLANK_ABSOLUTE = 0x0,         /* Wait for specific vblank sequence number */
354     _DRM_VBLANK_RELATIVE = 0x1,         /* Wait for given number of vblanks */
355     _DRM_VBLANK_SIGNAL   = 0x40000000   /* Send signal instead of blocking */
356 } drm_vblank_seq_type_t;
357
358 #define _DRM_VBLANK_FLAGS_MASK _DRM_VBLANK_SIGNAL
359
360 struct drm_wait_vblank_request {
361         drm_vblank_seq_type_t type;
362         unsigned int sequence;
363         unsigned long signal;
364 };
365
366 struct drm_wait_vblank_reply {
367         drm_vblank_seq_type_t type;
368         unsigned int sequence;
369         long tval_sec;
370         long tval_usec;
371 };
372
373 typedef union drm_wait_vblank {
374         struct drm_wait_vblank_request request;
375         struct drm_wait_vblank_reply reply;
376 } drm_wait_vblank_t;
377
378 typedef struct drm_agp_mode {
379         unsigned long mode;
380 } drm_agp_mode_t;
381
382                                 /* For drm_agp_alloc -- allocated a buffer */
383 typedef struct drm_agp_buffer {
384         unsigned long size;     /* In bytes -- will round to page boundary */
385         unsigned long handle;   /* Used for BIND/UNBIND ioctls */
386         unsigned long type;     /* Type of memory to allocate  */
387         unsigned long physical; /* Physical used by i810       */
388 } drm_agp_buffer_t;
389
390                                 /* For drm_agp_bind */
391 typedef struct drm_agp_binding {
392         unsigned long handle;   /* From drm_agp_buffer */
393         unsigned long offset;   /* In bytes -- will round to page boundary */
394 } drm_agp_binding_t;
395
396 typedef struct drm_agp_info {
397         int            agp_version_major;
398         int            agp_version_minor;
399         unsigned long  mode;
400         unsigned long  aperture_base;  /* physical address */
401         unsigned long  aperture_size;  /* bytes */
402         unsigned long  memory_allowed; /* bytes */
403         unsigned long  memory_used;
404
405                                 /* PCI information */
406         unsigned short id_vendor;
407         unsigned short id_device;
408 } drm_agp_info_t;
409
410 typedef struct drm_scatter_gather {
411         unsigned long size;     /* In bytes -- will round to page boundary */
412         unsigned long handle;   /* Used for mapping / unmapping */
413 } drm_scatter_gather_t;
414
415 #define DRM_IOCTL_BASE                  'd'
416 #define DRM_IO(nr)                      _IO(DRM_IOCTL_BASE,nr)
417 #define DRM_IOR(nr,type)                _IOR(DRM_IOCTL_BASE,nr,type)
418 #define DRM_IOW(nr,type)                _IOW(DRM_IOCTL_BASE,nr,type)
419 #define DRM_IOWR(nr,type)               _IOWR(DRM_IOCTL_BASE,nr,type)
420
421 #define DRM_IOCTL_VERSION               DRM_IOWR(0x00, drm_version_t)
422 #define DRM_IOCTL_GET_UNIQUE            DRM_IOWR(0x01, drm_unique_t)
423 #define DRM_IOCTL_GET_MAGIC             DRM_IOR( 0x02, drm_auth_t)
424 #define DRM_IOCTL_IRQ_BUSID             DRM_IOWR(0x03, drm_irq_busid_t)
425 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, drm_map_t)
426 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, drm_client_t)
427 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, drm_stats_t)
428
429 #define DRM_IOCTL_SET_UNIQUE            DRM_IOW( 0x10, drm_unique_t)
430 #define DRM_IOCTL_AUTH_MAGIC            DRM_IOW( 0x11, drm_auth_t)
431 #define DRM_IOCTL_BLOCK                 DRM_IOWR(0x12, drm_block_t)
432 #define DRM_IOCTL_UNBLOCK               DRM_IOWR(0x13, drm_block_t)
433 #define DRM_IOCTL_CONTROL               DRM_IOW( 0x14, drm_control_t)
434 #define DRM_IOCTL_ADD_MAP               DRM_IOWR(0x15, drm_map_t)
435 #define DRM_IOCTL_ADD_BUFS              DRM_IOWR(0x16, drm_buf_desc_t)
436 #define DRM_IOCTL_MARK_BUFS             DRM_IOW( 0x17, drm_buf_desc_t)
437 #define DRM_IOCTL_INFO_BUFS             DRM_IOWR(0x18, drm_buf_info_t)
438 #define DRM_IOCTL_MAP_BUFS              DRM_IOWR(0x19, drm_buf_map_t)
439 #define DRM_IOCTL_FREE_BUFS             DRM_IOW( 0x1a, drm_buf_free_t)
440
441 #define DRM_IOCTL_RM_MAP                DRM_IOW( 0x1b, drm_map_t)
442
443 #define DRM_IOCTL_SET_SAREA_CTX         DRM_IOW( 0x1c, drm_ctx_priv_map_t)
444 #define DRM_IOCTL_GET_SAREA_CTX         DRM_IOWR(0x1d, drm_ctx_priv_map_t)
445
446 #define DRM_IOCTL_ADD_CTX               DRM_IOWR(0x20, drm_ctx_t)
447 #define DRM_IOCTL_RM_CTX                DRM_IOWR(0x21, drm_ctx_t)
448 #define DRM_IOCTL_MOD_CTX               DRM_IOW( 0x22, drm_ctx_t)
449 #define DRM_IOCTL_GET_CTX               DRM_IOWR(0x23, drm_ctx_t)
450 #define DRM_IOCTL_SWITCH_CTX            DRM_IOW( 0x24, drm_ctx_t)
451 #define DRM_IOCTL_NEW_CTX               DRM_IOW( 0x25, drm_ctx_t)
452 #define DRM_IOCTL_RES_CTX               DRM_IOWR(0x26, drm_ctx_res_t)
453 #define DRM_IOCTL_ADD_DRAW              DRM_IOWR(0x27, drm_draw_t)
454 #define DRM_IOCTL_RM_DRAW               DRM_IOWR(0x28, drm_draw_t)
455 #define DRM_IOCTL_DMA                   DRM_IOWR(0x29, drm_dma_t)
456 #define DRM_IOCTL_LOCK                  DRM_IOW( 0x2a, drm_lock_t)
457 #define DRM_IOCTL_UNLOCK                DRM_IOW( 0x2b, drm_lock_t)
458 #define DRM_IOCTL_FINISH                DRM_IOW( 0x2c, drm_lock_t)
459
460 #define DRM_IOCTL_AGP_ACQUIRE           DRM_IO(  0x30)
461 #define DRM_IOCTL_AGP_RELEASE           DRM_IO(  0x31)
462 #define DRM_IOCTL_AGP_ENABLE            DRM_IOW( 0x32, drm_agp_mode_t)
463 #define DRM_IOCTL_AGP_INFO              DRM_IOR( 0x33, drm_agp_info_t)
464 #define DRM_IOCTL_AGP_ALLOC             DRM_IOWR(0x34, drm_agp_buffer_t)
465 #define DRM_IOCTL_AGP_FREE              DRM_IOW( 0x35, drm_agp_buffer_t)
466 #define DRM_IOCTL_AGP_BIND              DRM_IOW( 0x36, drm_agp_binding_t)
467 #define DRM_IOCTL_AGP_UNBIND            DRM_IOW( 0x37, drm_agp_binding_t)
468
469 #define DRM_IOCTL_SG_ALLOC              DRM_IOW( 0x38, drm_scatter_gather_t)
470 #define DRM_IOCTL_SG_FREE               DRM_IOW( 0x39, drm_scatter_gather_t)
471
472 #define DRM_IOCTL_WAIT_VBLANK           DRM_IOWR(0x3a, drm_wait_vblank_t)
473
474 /* Device specfic ioctls should only be in their respective headers
475  * The device specific ioctl range is 0x40 to 0x79.                  */
476 #define DRM_COMMAND_BASE                0x40
477
478 #endif