xf86drm.h revision bf6cc7dc
1/**
2 * \file xf86drm.h
3 * OS-independent header for DRM user-level library interface.
4 *
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 */
7
8/*
9 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
10 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
11 * All Rights Reserved.
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a
14 * copy of this software and associated documentation files (the "Software"),
15 * to deal in the Software without restriction, including without limitation
16 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 * and/or sell copies of the Software, and to permit persons to whom the
18 * Software is furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice (including the next
21 * paragraph) shall be included in all copies or substantial portions of the
22 * Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
27 * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 * DEALINGS IN THE SOFTWARE.
31 *
32 */
33
34#ifndef _XF86DRM_H_
35#define _XF86DRM_H_
36
37#include <stdarg.h>
38#if 1
39#include <sys/atomic.h>
40#else
41#include <sys/types.h>
42#endif
43#include <stdint.h>
44#include <drm.h>
45
46#if defined(__cplusplus)
47extern "C" {
48#endif
49
50#ifndef DRM_MAX_MINOR
51#define DRM_MAX_MINOR   16
52#endif
53
54#if defined(__linux__)
55
56#define DRM_IOCTL_NR(n)		_IOC_NR(n)
57#define DRM_IOC_VOID		_IOC_NONE
58#define DRM_IOC_READ		_IOC_READ
59#define DRM_IOC_WRITE		_IOC_WRITE
60#define DRM_IOC_READWRITE	_IOC_READ|_IOC_WRITE
61#define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
62
63#else /* One of the *BSDs */
64
65#include <sys/ioccom.h>
66#define DRM_IOCTL_NR(n)         ((n) & 0xff)
67#define DRM_IOC_VOID            IOC_VOID
68#define DRM_IOC_READ            IOC_OUT
69#define DRM_IOC_WRITE           IOC_IN
70#define DRM_IOC_READWRITE       IOC_INOUT
71#define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
72
73#endif
74
75				/* Defaults, if nothing set in xf86config */
76#define DRM_DEV_UID	 0
77#define DRM_DEV_GID	 0
78/* Default /dev/dri directory permissions 0755 */
79#define DRM_DEV_DIRMODE	 	\
80	(S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH)
81#define DRM_DEV_MODE	 (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
82
83#ifdef __OpenBSD__
84#define DRM_DIR_NAME  "/dev"
85#define DRM_DEV_NAME  "%s/drm%d"
86#define DRM_CONTROL_DEV_NAME  "%s/drmC%d"
87#define DRM_RENDER_DEV_NAME  "%s/drmR%d"
88#else
89#define DRM_DIR_NAME  "/dev/dri"
90#define DRM_DEV_NAME  "%s/card%d"
91#define DRM_CONTROL_DEV_NAME  "%s/controlD%d"
92#define DRM_RENDER_DEV_NAME  "%s/renderD%d"
93#define DRM_PROC_NAME "/proc/dri/" /* For backward Linux compatibility */
94#endif
95
96#define DRM_ERR_NO_DEVICE  (-1001)
97#define DRM_ERR_NO_ACCESS  (-1002)
98#define DRM_ERR_NOT_ROOT   (-1003)
99#define DRM_ERR_INVALID    (-1004)
100#define DRM_ERR_NO_FD      (-1005)
101
102#define DRM_AGP_NO_HANDLE 0
103
104typedef unsigned int  drmSize,     *drmSizePtr;	    /**< For mapped regions */
105typedef void          *drmAddress, **drmAddressPtr; /**< For mapped regions */
106
107#if (__GNUC__ >= 3)
108#define DRM_PRINTFLIKE(f, a) __attribute__ ((format(__printf__, f, a)))
109#else
110#define DRM_PRINTFLIKE(f, a)
111#endif
112
113typedef struct _drmServerInfo {
114  int (*debug_print)(const char *format, va_list ap) DRM_PRINTFLIKE(1,0);
115  int (*load_module)(const char *name);
116  void (*get_perms)(gid_t *, mode_t *);
117} drmServerInfo, *drmServerInfoPtr;
118
119typedef struct drmHashEntry {
120    int      fd;
121    void     (*f)(int, void *, void *);
122    void     *tagTable;
123} drmHashEntry;
124
125extern int drmIoctl(int fd, unsigned long request, void *arg);
126extern void *drmGetHashTable(void);
127extern drmHashEntry *drmGetEntry(int fd);
128
129/**
130 * Driver version information.
131 *
132 * \sa drmGetVersion() and drmSetVersion().
133 */
134typedef struct _drmVersion {
135    int     version_major;        /**< Major version */
136    int     version_minor;        /**< Minor version */
137    int     version_patchlevel;   /**< Patch level */
138    int     name_len; 	          /**< Length of name buffer */
139    char    *name;	          /**< Name of driver */
140    int     date_len;             /**< Length of date buffer */
141    char    *date;                /**< User-space buffer to hold date */
142    int     desc_len;	          /**< Length of desc buffer */
143    char    *desc;                /**< User-space buffer to hold desc */
144} drmVersion, *drmVersionPtr;
145
146typedef struct _drmStats {
147    unsigned long count;	     /**< Number of data */
148    struct {
149	unsigned long value;	     /**< Value from kernel */
150	const char    *long_format;  /**< Suggested format for long_name */
151	const char    *long_name;    /**< Long name for value */
152	const char    *rate_format;  /**< Suggested format for rate_name */
153	const char    *rate_name;    /**< Short name for value per second */
154	int           isvalue;       /**< True if value (vs. counter) */
155	const char    *mult_names;   /**< Multiplier names (e.g., "KGM") */
156	int           mult;          /**< Multiplier value (e.g., 1024) */
157	int           verbose;       /**< Suggest only in verbose output */
158    } data[15];
159} drmStatsT;
160
161
162				/* All of these enums *MUST* match with the
163                                   kernel implementation -- so do *NOT*
164                                   change them!  (The drmlib implementation
165                                   will just copy the flags instead of
166                                   translating them.) */
167typedef enum {
168    DRM_FRAME_BUFFER    = 0,      /**< WC, no caching, no core dump */
169    DRM_REGISTERS       = 1,      /**< no caching, no core dump */
170    DRM_SHM             = 2,      /**< shared, cached */
171    DRM_AGP             = 3,	  /**< AGP/GART */
172    DRM_SCATTER_GATHER  = 4,	  /**< PCI scatter/gather */
173    DRM_CONSISTENT      = 5	  /**< PCI consistent */
174} drmMapType;
175
176typedef enum {
177    DRM_RESTRICTED      = 0x0001, /**< Cannot be mapped to client-virtual */
178    DRM_READ_ONLY       = 0x0002, /**< Read-only in client-virtual */
179    DRM_LOCKED          = 0x0004, /**< Physical pages locked */
180    DRM_KERNEL          = 0x0008, /**< Kernel requires access */
181    DRM_WRITE_COMBINING = 0x0010, /**< Use write-combining, if available */
182    DRM_CONTAINS_LOCK   = 0x0020, /**< SHM page that contains lock */
183    DRM_REMOVABLE	= 0x0040  /**< Removable mapping */
184} drmMapFlags;
185
186/**
187 * \warning These values *MUST* match drm.h
188 */
189typedef enum {
190    /** \name Flags for DMA buffer dispatch */
191    /*@{*/
192    DRM_DMA_BLOCK        = 0x01, /**<
193				  * Block until buffer dispatched.
194				  *
195				  * \note the buffer may not yet have been
196				  * processed by the hardware -- getting a
197				  * hardware lock with the hardware quiescent
198				  * will ensure that the buffer has been
199				  * processed.
200				  */
201    DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
202    DRM_DMA_PRIORITY     = 0x04, /**< High priority dispatch */
203    /*@}*/
204
205    /** \name Flags for DMA buffer request */
206    /*@{*/
207    DRM_DMA_WAIT         = 0x10, /**< Wait for free buffers */
208    DRM_DMA_SMALLER_OK   = 0x20, /**< Smaller-than-requested buffers OK */
209    DRM_DMA_LARGER_OK    = 0x40  /**< Larger-than-requested buffers OK */
210    /*@}*/
211} drmDMAFlags;
212
213typedef enum {
214    DRM_PAGE_ALIGN       = 0x01,
215    DRM_AGP_BUFFER       = 0x02,
216    DRM_SG_BUFFER        = 0x04,
217    DRM_FB_BUFFER        = 0x08,
218    DRM_PCI_BUFFER_RO    = 0x10
219} drmBufDescFlags;
220
221typedef enum {
222    DRM_LOCK_READY      = 0x01, /**< Wait until hardware is ready for DMA */
223    DRM_LOCK_QUIESCENT  = 0x02, /**< Wait until hardware quiescent */
224    DRM_LOCK_FLUSH      = 0x04, /**< Flush this context's DMA queue first */
225    DRM_LOCK_FLUSH_ALL  = 0x08, /**< Flush all DMA queues first */
226				/* These *HALT* flags aren't supported yet
227                                   -- they will be used to support the
228                                   full-screen DGA-like mode. */
229    DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
230    DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
231} drmLockFlags;
232
233typedef enum {
234    DRM_CONTEXT_PRESERVED = 0x01, /**< This context is preserved and
235				     never swapped. */
236    DRM_CONTEXT_2DONLY    = 0x02  /**< This context is for 2D rendering only. */
237} drm_context_tFlags, *drm_context_tFlagsPtr;
238
239typedef struct _drmBufDesc {
240    int              count;	  /**< Number of buffers of this size */
241    int              size;	  /**< Size in bytes */
242    int              low_mark;	  /**< Low water mark */
243    int              high_mark;	  /**< High water mark */
244} drmBufDesc, *drmBufDescPtr;
245
246typedef struct _drmBufInfo {
247    int              count;	  /**< Number of buffers described in list */
248    drmBufDescPtr    list;	  /**< List of buffer descriptions */
249} drmBufInfo, *drmBufInfoPtr;
250
251typedef struct _drmBuf {
252    int              idx;	  /**< Index into the master buffer list */
253    int              total;	  /**< Buffer size */
254    int              used;	  /**< Amount of buffer in use (for DMA) */
255    drmAddress       address;	  /**< Address */
256} drmBuf, *drmBufPtr;
257
258/**
259 * Buffer mapping information.
260 *
261 * Used by drmMapBufs() and drmUnmapBufs() to store information about the
262 * mapped buffers.
263 */
264typedef struct _drmBufMap {
265    int              count;	  /**< Number of buffers mapped */
266    drmBufPtr        list;	  /**< Buffers */
267} drmBufMap, *drmBufMapPtr;
268
269typedef struct _drmLock {
270    volatile unsigned int lock;
271    char                      padding[60];
272    /* This is big enough for most current (and future?) architectures:
273       DEC Alpha:              32 bytes
274       Intel Merced:           ?
275       Intel P5/PPro/PII/PIII: 32 bytes
276       Intel StrongARM:        32 bytes
277       Intel i386/i486:        16 bytes
278       MIPS:                   32 bytes (?)
279       Motorola 68k:           16 bytes
280       Motorola PowerPC:       32 bytes
281       Sun SPARC:              32 bytes
282    */
283} drmLock, *drmLockPtr;
284
285/**
286 * Indices here refer to the offset into
287 * list in drmBufInfo
288 */
289typedef struct _drmDMAReq {
290    drm_context_t    context;  	  /**< Context handle */
291    int           send_count;     /**< Number of buffers to send */
292    int           *send_list;     /**< List of handles to buffers */
293    int           *send_sizes;    /**< Lengths of data to send, in bytes */
294    drmDMAFlags   flags;          /**< Flags */
295    int           request_count;  /**< Number of buffers requested */
296    int           request_size;	  /**< Desired size of buffers requested */
297    int           *request_list;  /**< Buffer information */
298    int           *request_sizes; /**< Minimum acceptable sizes */
299    int           granted_count;  /**< Number of buffers granted at this size */
300} drmDMAReq, *drmDMAReqPtr;
301
302typedef struct _drmRegion {
303    drm_handle_t     handle;
304    unsigned int  offset;
305    drmSize       size;
306    drmAddress    map;
307} drmRegion, *drmRegionPtr;
308
309typedef struct _drmTextureRegion {
310    unsigned char next;
311    unsigned char prev;
312    unsigned char in_use;
313    unsigned char padding;	/**< Explicitly pad this out */
314    unsigned int  age;
315} drmTextureRegion, *drmTextureRegionPtr;
316
317
318typedef enum {
319    DRM_VBLANK_ABSOLUTE = 0x0,	/**< Wait for specific vblank sequence number */
320    DRM_VBLANK_RELATIVE = 0x1,	/**< Wait for given number of vblanks */
321    /* bits 1-6 are reserved for high crtcs */
322    DRM_VBLANK_HIGH_CRTC_MASK = 0x0000003e,
323    DRM_VBLANK_EVENT = 0x4000000,	/**< Send event instead of blocking */
324    DRM_VBLANK_FLIP = 0x8000000,	/**< Scheduled buffer swap should flip */
325    DRM_VBLANK_NEXTONMISS = 0x10000000,	/**< If missed, wait for next vblank */
326    DRM_VBLANK_SECONDARY = 0x20000000,	/**< Secondary display controller */
327    DRM_VBLANK_SIGNAL   = 0x40000000	/* Send signal instead of blocking */
328} drmVBlankSeqType;
329#define DRM_VBLANK_HIGH_CRTC_SHIFT 1
330
331typedef struct _drmVBlankReq {
332	drmVBlankSeqType type;
333	unsigned int sequence;
334	unsigned long signal;
335} drmVBlankReq, *drmVBlankReqPtr;
336
337typedef struct _drmVBlankReply {
338	drmVBlankSeqType type;
339	unsigned int sequence;
340	long tval_sec;
341	long tval_usec;
342} drmVBlankReply, *drmVBlankReplyPtr;
343
344typedef union _drmVBlank {
345	drmVBlankReq request;
346	drmVBlankReply reply;
347} drmVBlank, *drmVBlankPtr;
348
349typedef struct _drmSetVersion {
350	int drm_di_major;
351	int drm_di_minor;
352	int drm_dd_major;
353	int drm_dd_minor;
354} drmSetVersion, *drmSetVersionPtr;
355
356#define __drm_dummy_lock(lock) (*(__volatile__ unsigned int *)lock)
357
358#define DRM_LOCK_HELD  0x80000000U /**< Hardware lock is held */
359#define DRM_LOCK_CONT  0x40000000U /**< Hardware lock is contended */
360
361#if 1
362
363#define DRM_CAS(lock, old, new, __ret)	\
364 (__ret = atomic_cas_uint(&__drm_dummy_lock(lock), (old), (new)) != (old));
365
366#elif defined(__GNUC__) && (__GNUC__ >= 2)
367# if defined(__i386) || defined(__AMD64__) || defined(__x86_64__) || defined(__amd64__)
368				/* Reflect changes here to drmP.h */
369#define DRM_CAS(lock,old,new,__ret)                                    \
370	do {                                                           \
371                int __dummy;	/* Can't mark eax as clobbered */      \
372		__asm__ __volatile__(                                  \
373			"lock ; cmpxchg %4,%1\n\t"                     \
374                        "setnz %0"                                     \
375			: "=d" (__ret),                                \
376   			  "=m" (__drm_dummy_lock(lock)),               \
377                          "=a" (__dummy)                               \
378			: "2" (old),                                   \
379			  "r" (new));                                  \
380	} while (0)
381
382#elif defined(__alpha__)
383
384#define	DRM_CAS(lock, old, new, ret)		\
385	do {					\
386		int tmp, old32;			\
387		__asm__ __volatile__(		\
388		"	addl	$31, %5, %3\n"	\
389		"1:	ldl_l	%0, %2\n"	\
390		"	cmpeq	%0, %3, %1\n"	\
391		"	beq	%1, 2f\n"	\
392		"	mov	%4, %0\n"	\
393		"	stl_c	%0, %2\n"	\
394		"	beq	%0, 3f\n"	\
395		"	mb\n"			\
396		"2:	cmpeq	%1, 0, %1\n"	\
397		".subsection 2\n"		\
398		"3:	br	1b\n"		\
399		".previous"			\
400		: "=&r"(tmp), "=&r"(ret),	\
401		  "=m"(__drm_dummy_lock(lock)),	\
402		  "=&r"(old32)			\
403		: "r"(new), "r"(old)		\
404		: "memory");			\
405	} while (0)
406
407#elif defined(__sparc__)
408
409#define DRM_CAS(lock,old,new,__ret)				\
410do {	register unsigned int __old __asm("o0");		\
411	register unsigned int __new __asm("o1");		\
412	register volatile unsigned int *__lock __asm("o2");	\
413	__old = old;						\
414	__new = new;						\
415	__lock = (volatile unsigned int *)lock;			\
416	__asm__ __volatile__(					\
417		/*"cas [%2], %3, %0"*/				\
418		".word 0xd3e29008\n\t"				\
419		/*"membar #StoreStore | #StoreLoad"*/		\
420		".word 0x8143e00a"				\
421		: "=&r" (__new)					\
422		: "0" (__new),					\
423		  "r" (__lock),					\
424		  "r" (__old)					\
425		: "memory");					\
426	__ret = (__new != __old);				\
427} while(0)
428
429#elif defined(__ia64__)
430
431#ifdef __INTEL_COMPILER
432/* this currently generates bad code (missing stop bits)... */
433#include <ia64intrin.h>
434
435#define DRM_CAS(lock,old,new,__ret)					      \
436	do {								      \
437		unsigned long __result, __old = (old) & 0xffffffff;		\
438		__mf();							      	\
439		__result = _InterlockedCompareExchange_acq(&__drm_dummy_lock(lock), (new), __old);\
440		__ret = (__result) != (__old);					\
441/*		__ret = (__sync_val_compare_and_swap(&__drm_dummy_lock(lock), \
442						     (old), (new))	      \
443			 != (old));					      */\
444	} while (0)
445
446#else
447#define DRM_CAS(lock,old,new,__ret)					  \
448	do {								  \
449		unsigned int __result, __old = (old);			  \
450		__asm__ __volatile__(					  \
451			"mf\n"						  \
452			"mov ar.ccv=%2\n"				  \
453			";;\n"						  \
454			"cmpxchg4.acq %0=%1,%3,ar.ccv"			  \
455			: "=r" (__result), "=m" (__drm_dummy_lock(lock))  \
456			: "r" ((unsigned long)__old), "r" (new)			  \
457			: "memory");					  \
458		__ret = (__result) != (__old);				  \
459	} while (0)
460
461#endif
462
463#elif defined(__powerpc__)
464
465#define DRM_CAS(lock,old,new,__ret)			\
466	do {						\
467		__asm__ __volatile__(			\
468			"sync;"				\
469			"0:    lwarx %0,0,%1;"		\
470			"      xor. %0,%3,%0;"		\
471			"      bne 1f;"			\
472			"      stwcx. %2,0,%1;"		\
473			"      bne- 0b;"		\
474			"1:    "			\
475			"sync;"				\
476		: "=&r"(__ret)				\
477		: "r"(lock), "r"(new), "r"(old)		\
478		: "cr0", "memory");			\
479	} while (0)
480
481#endif /* architecture */
482#endif /* __GNUC__ >= 2 */
483
484#ifndef DRM_CAS
485#define DRM_CAS(lock,old,new,ret) do { ret=1; } while (0) /* FAST LOCK FAILS */
486#endif
487
488#if defined(__alpha__)
489#define DRM_CAS_RESULT(_result)		long _result
490#elif defined(__powerpc__)
491#define DRM_CAS_RESULT(_result)		int _result
492#else
493#define DRM_CAS_RESULT(_result)		char _result
494#endif
495
496#define DRM_LIGHT_LOCK(fd,lock,context)                                \
497	do {                                                           \
498                DRM_CAS_RESULT(__ret);                                 \
499		DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret);     \
500                if (__ret) drmGetLock(fd,context,0);                   \
501        } while(0)
502
503				/* This one counts fast locks -- for
504                                   benchmarking only. */
505#define DRM_LIGHT_LOCK_COUNT(fd,lock,context,count)                    \
506	do {                                                           \
507                DRM_CAS_RESULT(__ret);                                 \
508		DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret);     \
509                if (__ret) drmGetLock(fd,context,0);                   \
510                else       ++count;                                    \
511        } while(0)
512
513#define DRM_LOCK(fd,lock,context,flags)                                \
514	do {                                                           \
515		if (flags) drmGetLock(fd,context,flags);               \
516		else       DRM_LIGHT_LOCK(fd,lock,context);            \
517	} while(0)
518
519#define DRM_UNLOCK(fd,lock,context)                                    \
520	do {                                                           \
521                DRM_CAS_RESULT(__ret);                                 \
522		DRM_CAS(lock,DRM_LOCK_HELD|context,context,__ret);     \
523                if (__ret) drmUnlock(fd,context);                      \
524        } while(0)
525
526				/* Simple spin locks */
527#define DRM_SPINLOCK(spin,val)                                         \
528	do {                                                           \
529            DRM_CAS_RESULT(__ret);                                     \
530	    do {                                                       \
531		DRM_CAS(spin,0,val,__ret);                             \
532		if (__ret) while ((spin)->lock);                       \
533	    } while (__ret);                                           \
534	} while(0)
535
536#define DRM_SPINLOCK_TAKE(spin,val)                                    \
537	do {                                                           \
538            DRM_CAS_RESULT(__ret);                                     \
539            int  cur;                                                  \
540	    do {                                                       \
541                cur = (*spin).lock;                                    \
542		DRM_CAS(spin,cur,val,__ret);                           \
543	    } while (__ret);                                           \
544	} while(0)
545
546#define DRM_SPINLOCK_COUNT(spin,val,count,__ret)                       \
547	do {                                                           \
548            int  __i;                                                  \
549            __ret = 1;                                                 \
550            for (__i = 0; __ret && __i < count; __i++) {               \
551		DRM_CAS(spin,0,val,__ret);                             \
552		if (__ret) for (;__i < count && (spin)->lock; __i++);  \
553	    }                                                          \
554	} while(0)
555
556#define DRM_SPINUNLOCK(spin,val)                                       \
557	do {                                                           \
558            DRM_CAS_RESULT(__ret);                                     \
559            if ((*spin).lock == val) { /* else server stole lock */    \
560	        do {                                                   \
561		    DRM_CAS(spin,val,0,__ret);                         \
562	        } while (__ret);                                       \
563            }                                                          \
564	} while(0)
565
566
567
568/* General user-level programmer's API: unprivileged */
569extern int           drmAvailable(void);
570extern int           drmOpen(const char *name, const char *busid);
571
572#define DRM_NODE_PRIMARY 0
573#define DRM_NODE_CONTROL 1
574#define DRM_NODE_RENDER  2
575#define DRM_NODE_MAX     3
576
577extern int           drmOpenWithType(const char *name, const char *busid,
578                                     int type);
579
580extern int           drmOpenControl(int minor);
581extern int           drmOpenRender(int minor);
582extern int           drmClose(int fd);
583extern drmVersionPtr drmGetVersion(int fd);
584extern drmVersionPtr drmGetLibVersion(int fd);
585extern int           drmGetCap(int fd, uint64_t capability, uint64_t *value);
586extern void          drmFreeVersion(drmVersionPtr);
587extern int           drmGetMagic(int fd, drm_magic_t * magic);
588extern char          *drmGetBusid(int fd);
589extern int           drmGetInterruptFromBusID(int fd, int busnum, int devnum,
590					      int funcnum);
591extern int           drmGetMap(int fd, int idx, drm_handle_t *offset,
592			       drmSize *size, drmMapType *type,
593			       drmMapFlags *flags, drm_handle_t *handle,
594			       int *mtrr);
595extern int           drmGetClient(int fd, int idx, int *auth, int *pid,
596				  int *uid, unsigned long *magic,
597				  unsigned long *iocs);
598extern int           drmGetStats(int fd, drmStatsT *stats);
599extern int           drmSetInterfaceVersion(int fd, drmSetVersion *version);
600extern int           drmCommandNone(int fd, unsigned long drmCommandIndex);
601extern int           drmCommandRead(int fd, unsigned long drmCommandIndex,
602                                    void *data, unsigned long size);
603extern int           drmCommandWrite(int fd, unsigned long drmCommandIndex,
604                                     void *data, unsigned long size);
605extern int           drmCommandWriteRead(int fd, unsigned long drmCommandIndex,
606                                         void *data, unsigned long size);
607
608/* General user-level programmer's API: X server (root) only  */
609extern void          drmFreeBusid(const char *busid);
610extern int           drmSetBusid(int fd, const char *busid);
611extern int           drmAuthMagic(int fd, drm_magic_t magic);
612extern int           drmAddMap(int fd,
613			       drm_handle_t offset,
614			       drmSize size,
615			       drmMapType type,
616			       drmMapFlags flags,
617			       drm_handle_t * handle);
618extern int	     drmRmMap(int fd, drm_handle_t handle);
619extern int	     drmAddContextPrivateMapping(int fd, drm_context_t ctx_id,
620						 drm_handle_t handle);
621
622extern int           drmAddBufs(int fd, int count, int size,
623				drmBufDescFlags flags,
624				int agp_offset);
625extern int           drmMarkBufs(int fd, double low, double high);
626extern int           drmCreateContext(int fd, drm_context_t * handle);
627extern int           drmSetContextFlags(int fd, drm_context_t context,
628					drm_context_tFlags flags);
629extern int           drmGetContextFlags(int fd, drm_context_t context,
630					drm_context_tFlagsPtr flags);
631extern int           drmAddContextTag(int fd, drm_context_t context, void *tag);
632extern int           drmDelContextTag(int fd, drm_context_t context);
633extern void          *drmGetContextTag(int fd, drm_context_t context);
634extern drm_context_t * drmGetReservedContextList(int fd, int *count);
635extern void          drmFreeReservedContextList(drm_context_t *);
636extern int           drmSwitchToContext(int fd, drm_context_t context);
637extern int           drmDestroyContext(int fd, drm_context_t handle);
638extern int           drmCreateDrawable(int fd, drm_drawable_t * handle);
639extern int           drmDestroyDrawable(int fd, drm_drawable_t handle);
640extern int           drmUpdateDrawableInfo(int fd, drm_drawable_t handle,
641					   drm_drawable_info_type_t type,
642					   unsigned int num, void *data);
643extern int           drmCtlInstHandler(int fd, int irq);
644extern int           drmCtlUninstHandler(int fd);
645extern int           drmSetClientCap(int fd, uint64_t capability,
646				     uint64_t value);
647
648extern int           drmCrtcGetSequence(int fd, uint32_t crtcId,
649					uint64_t *sequence, uint64_t *ns);
650extern int           drmCrtcQueueSequence(int fd, uint32_t crtcId,
651					  uint32_t flags, uint64_t sequence,
652					  uint64_t *sequence_queued,
653					  uint64_t user_data);
654/* General user-level programmer's API: authenticated client and/or X */
655extern int           drmMap(int fd,
656			    drm_handle_t handle,
657			    drmSize size,
658			    drmAddressPtr address);
659extern int           drmUnmap(drmAddress address, drmSize size);
660extern drmBufInfoPtr drmGetBufInfo(int fd);
661extern drmBufMapPtr  drmMapBufs(int fd);
662extern int           drmUnmapBufs(drmBufMapPtr bufs);
663extern int           drmDMA(int fd, drmDMAReqPtr request);
664extern int           drmFreeBufs(int fd, int count, int *list);
665extern int           drmGetLock(int fd,
666			        drm_context_t context,
667			        drmLockFlags flags);
668extern int           drmUnlock(int fd, drm_context_t context);
669extern int           drmFinish(int fd, int context, drmLockFlags flags);
670extern int	     drmGetContextPrivateMapping(int fd, drm_context_t ctx_id,
671						 drm_handle_t * handle);
672
673/* AGP/GART support: X server (root) only */
674extern int           drmAgpAcquire(int fd);
675extern int           drmAgpRelease(int fd);
676extern int           drmAgpEnable(int fd, unsigned long mode);
677extern int           drmAgpAlloc(int fd, unsigned long size,
678				 unsigned long type, unsigned long *address,
679				 drm_handle_t *handle);
680extern int           drmAgpFree(int fd, drm_handle_t handle);
681extern int 	     drmAgpBind(int fd, drm_handle_t handle,
682				unsigned long offset);
683extern int           drmAgpUnbind(int fd, drm_handle_t handle);
684
685/* AGP/GART info: authenticated client and/or X */
686extern int           drmAgpVersionMajor(int fd);
687extern int           drmAgpVersionMinor(int fd);
688extern unsigned long drmAgpGetMode(int fd);
689extern unsigned long drmAgpBase(int fd); /* Physical location */
690extern unsigned long drmAgpSize(int fd); /* Bytes */
691extern unsigned long drmAgpMemoryUsed(int fd);
692extern unsigned long drmAgpMemoryAvail(int fd);
693extern unsigned int  drmAgpVendorId(int fd);
694extern unsigned int  drmAgpDeviceId(int fd);
695
696/* PCI scatter/gather support: X server (root) only */
697extern int           drmScatterGatherAlloc(int fd, unsigned long size,
698					   drm_handle_t *handle);
699extern int           drmScatterGatherFree(int fd, drm_handle_t handle);
700
701extern int           drmWaitVBlank(int fd, drmVBlankPtr vbl);
702
703/* Support routines */
704extern void          drmSetServerInfo(drmServerInfoPtr info);
705extern int           drmError(int err, const char *label);
706extern void          *drmMalloc(int size);
707extern void          drmFree(void *pt);
708
709/* Hash table routines */
710extern void *drmHashCreate(void);
711extern int  drmHashDestroy(void *t);
712extern int  drmHashLookup(void *t, unsigned long key, void **value);
713extern int  drmHashInsert(void *t, unsigned long key, void *value);
714extern int  drmHashDelete(void *t, unsigned long key);
715extern int  drmHashFirst(void *t, unsigned long *key, void **value);
716extern int  drmHashNext(void *t, unsigned long *key, void **value);
717
718/* PRNG routines */
719extern void          *drmRandomCreate(unsigned long seed);
720extern int           drmRandomDestroy(void *state);
721extern unsigned long drmRandom(void *state);
722extern double        drmRandomDouble(void *state);
723
724/* Skip list routines */
725
726extern void *drmSLCreate(void);
727extern int  drmSLDestroy(void *l);
728extern int  drmSLLookup(void *l, unsigned long key, void **value);
729extern int  drmSLInsert(void *l, unsigned long key, void *value);
730extern int  drmSLDelete(void *l, unsigned long key);
731extern int  drmSLNext(void *l, unsigned long *key, void **value);
732extern int  drmSLFirst(void *l, unsigned long *key, void **value);
733extern void drmSLDump(void *l);
734extern int  drmSLLookupNeighbors(void *l, unsigned long key,
735				 unsigned long *prev_key, void **prev_value,
736				 unsigned long *next_key, void **next_value);
737
738extern int drmOpenOnce(void *unused, const char *BusID, int *newlyopened);
739extern int drmOpenOnceWithType(const char *BusID, int *newlyopened, int type);
740extern void drmCloseOnce(int fd);
741extern void drmMsg(const char *format, ...) DRM_PRINTFLIKE(1, 2);
742
743extern int drmSetMaster(int fd);
744extern int drmDropMaster(int fd);
745extern int drmIsMaster(int fd);
746
747#define DRM_EVENT_CONTEXT_VERSION 4
748
749typedef struct _drmEventContext {
750
751	/* This struct is versioned so we can add more pointers if we
752	 * add more events. */
753	int version;
754
755	void (*vblank_handler)(int fd,
756			       unsigned int sequence,
757			       unsigned int tv_sec,
758			       unsigned int tv_usec,
759			       void *user_data);
760
761	void (*page_flip_handler)(int fd,
762				  unsigned int sequence,
763				  unsigned int tv_sec,
764				  unsigned int tv_usec,
765				  void *user_data);
766
767	void (*page_flip_handler2)(int fd,
768				   unsigned int sequence,
769				   unsigned int tv_sec,
770				   unsigned int tv_usec,
771				   unsigned int crtc_id,
772				   void *user_data);
773
774	void (*sequence_handler)(int fd,
775				 uint64_t sequence,
776				 uint64_t ns,
777				 uint64_t user_data);
778} drmEventContext, *drmEventContextPtr;
779
780extern int drmHandleEvent(int fd, drmEventContextPtr evctx);
781
782extern char *drmGetDeviceNameFromFd(int fd);
783
784/* Improved version of drmGetDeviceNameFromFd which attributes for any type of
785 * device/node - card, control or renderD.
786 */
787extern char *drmGetDeviceNameFromFd2(int fd);
788extern int drmGetNodeTypeFromFd(int fd);
789
790extern int drmPrimeHandleToFD(int fd, uint32_t handle, uint32_t flags, int *prime_fd);
791extern int drmPrimeFDToHandle(int fd, int prime_fd, uint32_t *handle);
792
793extern char *drmGetPrimaryDeviceNameFromFd(int fd);
794extern char *drmGetRenderDeviceNameFromFd(int fd);
795
796#define DRM_BUS_PCI       0
797#define DRM_BUS_USB       1
798#define DRM_BUS_PLATFORM  2
799#define DRM_BUS_HOST1X    3
800
801typedef struct _drmPciBusInfo {
802    uint16_t domain;
803    uint8_t bus;
804    uint8_t dev;
805    uint8_t func;
806} drmPciBusInfo, *drmPciBusInfoPtr;
807
808typedef struct _drmPciDeviceInfo {
809    uint16_t vendor_id;
810    uint16_t device_id;
811    uint16_t subvendor_id;
812    uint16_t subdevice_id;
813    uint8_t revision_id;
814} drmPciDeviceInfo, *drmPciDeviceInfoPtr;
815
816typedef struct _drmUsbBusInfo {
817    uint8_t bus;
818    uint8_t dev;
819} drmUsbBusInfo, *drmUsbBusInfoPtr;
820
821typedef struct _drmUsbDeviceInfo {
822    uint16_t vendor;
823    uint16_t product;
824} drmUsbDeviceInfo, *drmUsbDeviceInfoPtr;
825
826#define DRM_PLATFORM_DEVICE_NAME_LEN 512
827
828typedef struct _drmPlatformBusInfo {
829    char fullname[DRM_PLATFORM_DEVICE_NAME_LEN];
830} drmPlatformBusInfo, *drmPlatformBusInfoPtr;
831
832typedef struct _drmPlatformDeviceInfo {
833    char **compatible; /* NULL terminated list of compatible strings */
834} drmPlatformDeviceInfo, *drmPlatformDeviceInfoPtr;
835
836#define DRM_HOST1X_DEVICE_NAME_LEN 512
837
838typedef struct _drmHost1xBusInfo {
839    char fullname[DRM_HOST1X_DEVICE_NAME_LEN];
840} drmHost1xBusInfo, *drmHost1xBusInfoPtr;
841
842typedef struct _drmHost1xDeviceInfo {
843    char **compatible; /* NULL terminated list of compatible strings */
844} drmHost1xDeviceInfo, *drmHost1xDeviceInfoPtr;
845
846typedef struct _drmDevice {
847    char **nodes; /* DRM_NODE_MAX sized array */
848    int available_nodes; /* DRM_NODE_* bitmask */
849    int bustype;
850    union {
851        drmPciBusInfoPtr pci;
852        drmUsbBusInfoPtr usb;
853        drmPlatformBusInfoPtr platform;
854        drmHost1xBusInfoPtr host1x;
855    } businfo;
856    union {
857        drmPciDeviceInfoPtr pci;
858        drmUsbDeviceInfoPtr usb;
859        drmPlatformDeviceInfoPtr platform;
860        drmHost1xDeviceInfoPtr host1x;
861    } deviceinfo;
862} drmDevice, *drmDevicePtr;
863
864extern int drmGetDevice(int fd, drmDevicePtr *device);
865extern void drmFreeDevice(drmDevicePtr *device);
866
867extern int drmGetDevices(drmDevicePtr devices[], int max_devices);
868extern void drmFreeDevices(drmDevicePtr devices[], int count);
869
870#define DRM_DEVICE_GET_PCI_REVISION (1 << 0)
871extern int drmGetDevice2(int fd, uint32_t flags, drmDevicePtr *device);
872extern int drmGetDevices2(uint32_t flags, drmDevicePtr devices[], int max_devices);
873
874extern int drmDevicesEqual(drmDevicePtr a, drmDevicePtr b);
875
876extern int drmSyncobjCreate(int fd, uint32_t flags, uint32_t *handle);
877extern int drmSyncobjDestroy(int fd, uint32_t handle);
878extern int drmSyncobjHandleToFD(int fd, uint32_t handle, int *obj_fd);
879extern int drmSyncobjFDToHandle(int fd, int obj_fd, uint32_t *handle);
880
881extern int drmSyncobjImportSyncFile(int fd, uint32_t handle, int sync_file_fd);
882extern int drmSyncobjExportSyncFile(int fd, uint32_t handle, int *sync_file_fd);
883extern int drmSyncobjWait(int fd, uint32_t *handles, unsigned num_handles,
884			  int64_t timeout_nsec, unsigned flags,
885			  uint32_t *first_signaled);
886extern int drmSyncobjReset(int fd, const uint32_t *handles, uint32_t handle_count);
887extern int drmSyncobjSignal(int fd, const uint32_t *handles, uint32_t handle_count);
888extern int drmSyncobjTimelineSignal(int fd, const uint32_t *handles,
889				    uint64_t *points, uint32_t handle_count);
890extern int drmSyncobjTimelineWait(int fd, uint32_t *handles, uint64_t *points,
891				  unsigned num_handles,
892				  int64_t timeout_nsec, unsigned flags,
893				  uint32_t *first_signaled);
894extern int drmSyncobjQuery(int fd, uint32_t *handles, uint64_t *points,
895			   uint32_t handle_count);
896extern int drmSyncobjTransfer(int fd,
897			      uint32_t dst_handle, uint64_t dst_point,
898			      uint32_t src_handle, uint64_t src_point,
899			      uint32_t flags);
900
901#if defined(__cplusplus)
902}
903#endif
904
905#endif
906