3 * OS-independent header for DRM user-level library interface.
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
9 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
10 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
11 * All Rights Reserved.
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:
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
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.
34 /* $XFree86: xc/programs/Xserver/hw/xfree86/os-support/xf86drm.h,v 1.26 2003/08/16 19:26:37 dawes Exp $ */
41 /* Defaults, if nothing set in xf86config */
44 /* Default /dev/dri directory permissions 0755 */
45 #define DRM_DEV_DIRMODE \
46 (S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH)
47 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
49 #define DRM_DIR_NAME "/dev/dri"
50 #define DRM_DEV_NAME "%s/card%d"
51 #define DRM_PROC_NAME "/proc/dri/" /* For backward Linux compatibility */
53 #define DRM_ERR_NO_DEVICE (-1001)
54 #define DRM_ERR_NO_ACCESS (-1002)
55 #define DRM_ERR_NOT_ROOT (-1003)
56 #define DRM_ERR_INVALID (-1004)
57 #define DRM_ERR_NO_FD (-1005)
59 #define DRM_AGP_NO_HANDLE 0
61 typedef unsigned int drmSize, *drmSizePtr; /**< For mapped regions */
62 typedef void *drmAddress, **drmAddressPtr; /**< For mapped regions */
65 * Driver version information.
67 * \sa drmGetVersion() and drmSetVersion().
69 typedef struct _drmVersion {
70 int version_major; /**< Major version */
71 int version_minor; /**< Minor version */
72 int version_patchlevel; /**< Patch level */
73 int name_len; /**< Length of name buffer */
74 char *name; /**< Name of driver */
75 int date_len; /**< Length of date buffer */
76 char *date; /**< User-space buffer to hold date */
77 int desc_len; /**< Length of desc buffer */
78 char *desc; /**< User-space buffer to hold desc */
79 } drmVersion, *drmVersionPtr;
81 typedef struct _drmStats {
82 unsigned long count; /**< Number of data */
84 unsigned long value; /**< Value from kernel */
85 const char *long_format; /**< Suggested format for long_name */
86 const char *long_name; /**< Long name for value */
87 const char *rate_format; /**< Suggested format for rate_name */
88 const char *rate_name; /**< Short name for value per second */
89 int isvalue; /**< True if value (vs. counter) */
90 const char *mult_names; /**< Multiplier names (e.g., "KGM") */
91 int mult; /**< Multiplier value (e.g., 1024) */
92 int verbose; /**< Suggest only in verbose output */
97 /* All of these enums *MUST* match with the
98 kernel implementation -- so do *NOT*
99 change them! (The drmlib implementation
100 will just copy the flags instead of
101 translating them.) */
103 DRM_FRAME_BUFFER = 0, /**< WC, no caching, no core dump */
104 DRM_REGISTERS = 1, /**< no caching, no core dump */
105 DRM_SHM = 2, /**< shared, cached */
106 DRM_AGP = 3, /**< AGP/GART */
107 DRM_SCATTER_GATHER = 4, /**< PCI scatter/gather */
108 DRM_CONSISTENT = 5 /**< PCI consistent */
112 DRM_RESTRICTED = 0x0001, /**< Cannot be mapped to client-virtual */
113 DRM_READ_ONLY = 0x0002, /**< Read-only in client-virtual */
114 DRM_LOCKED = 0x0004, /**< Physical pages locked */
115 DRM_KERNEL = 0x0008, /**< Kernel requires access */
116 DRM_WRITE_COMBINING = 0x0010, /**< Use write-combining, if available */
117 DRM_CONTAINS_LOCK = 0x0020, /**< SHM page that contains lock */
118 DRM_REMOVABLE = 0x0040 /**< Removable mapping */
122 * \warning These values *MUST* match drm.h
125 /** \name Flags for DMA buffer dispatch */
127 DRM_DMA_BLOCK = 0x01, /**<
128 * Block until buffer dispatched.
130 * \note the buffer may not yet have been
131 * processed by the hardware -- getting a
132 * hardware lock with the hardware quiescent
133 * will ensure that the buffer has been
136 DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
137 DRM_DMA_PRIORITY = 0x04, /**< High priority dispatch */
140 /** \name Flags for DMA buffer request */
142 DRM_DMA_WAIT = 0x10, /**< Wait for free buffers */
143 DRM_DMA_SMALLER_OK = 0x20, /**< Smaller-than-requested buffers OK */
144 DRM_DMA_LARGER_OK = 0x40 /**< Larger-than-requested buffers OK */
149 DRM_PAGE_ALIGN = 0x01,
150 DRM_AGP_BUFFER = 0x02,
151 DRM_SG_BUFFER = 0x04,
156 DRM_LOCK_READY = 0x01, /**< Wait until hardware is ready for DMA */
157 DRM_LOCK_QUIESCENT = 0x02, /**< Wait until hardware quiescent */
158 DRM_LOCK_FLUSH = 0x04, /**< Flush this context's DMA queue first */
159 DRM_LOCK_FLUSH_ALL = 0x08, /**< Flush all DMA queues first */
160 /* These *HALT* flags aren't supported yet
161 -- they will be used to support the
162 full-screen DGA-like mode. */
163 DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
164 DRM_HALT_CUR_QUEUES = 0x20 /**< Halt all current queues */
168 DRM_CONTEXT_PRESERVED = 0x01, /**< This context is preserved and
170 DRM_CONTEXT_2DONLY = 0x02 /**< This context is for 2D rendering only. */
171 } drm_context_tFlags, *drm_context_tFlagsPtr;
173 typedef struct _drmBufDesc {
174 int count; /**< Number of buffers of this size */
175 int size; /**< Size in bytes */
176 int low_mark; /**< Low water mark */
177 int high_mark; /**< High water mark */
178 } drmBufDesc, *drmBufDescPtr;
180 typedef struct _drmBufInfo {
181 int count; /**< Number of buffers described in list */
182 drmBufDescPtr list; /**< List of buffer descriptions */
183 } drmBufInfo, *drmBufInfoPtr;
185 typedef struct _drmBuf {
186 int idx; /**< Index into the master buffer list */
187 int total; /**< Buffer size */
188 int used; /**< Amount of buffer in use (for DMA) */
189 drmAddress address; /**< Address */
190 } drmBuf, *drmBufPtr;
193 * Buffer mapping information.
195 * Used by drmMapBufs() and drmUnmapBufs() to store information about the
198 typedef struct _drmBufMap {
199 int count; /**< Number of buffers mapped */
200 drmBufPtr list; /**< Buffers */
201 } drmBufMap, *drmBufMapPtr;
203 typedef struct _drmLock {
204 volatile unsigned int lock;
206 /* This is big enough for most current (and future?) architectures:
209 Intel P5/PPro/PII/PIII: 32 bytes
210 Intel StrongARM: 32 bytes
211 Intel i386/i486: 16 bytes
213 Motorola 68k: 16 bytes
214 Motorola PowerPC: 32 bytes
217 } drmLock, *drmLockPtr;
220 * Indices here refer to the offset into
223 typedef struct _drmDMAReq {
224 drm_context_t context; /**< Context handle */
225 int send_count; /**< Number of buffers to send */
226 int *send_list; /**< List of handles to buffers */
227 int *send_sizes; /**< Lengths of data to send, in bytes */
228 drmDMAFlags flags; /**< Flags */
229 int request_count; /**< Number of buffers requested */
230 int request_size; /**< Desired size of buffers requested */
231 int *request_list; /**< Buffer information */
232 int *request_sizes; /**< Minimum acceptable sizes */
233 int granted_count; /**< Number of buffers granted at this size */
234 } drmDMAReq, *drmDMAReqPtr;
236 typedef struct _drmRegion {
241 } drmRegion, *drmRegionPtr;
243 typedef struct _drmTextureRegion {
246 unsigned char in_use;
247 unsigned char padding; /**< Explicitly pad this out */
249 } drmTextureRegion, *drmTextureRegionPtr;
253 DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */
254 DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */
255 DRM_VBLANK_SIGNAL = 0x40000000 /* Send signal instead of blocking */
258 typedef struct _drmVBlankReq {
259 drmVBlankSeqType type;
260 unsigned int sequence;
261 unsigned long signal;
262 } drmVBlankReq, *drmVBlankReqPtr;
264 typedef struct _drmVBlankReply {
265 drmVBlankSeqType type;
266 unsigned int sequence;
269 } drmVBlankReply, *drmVBlankReplyPtr;
271 typedef union _drmVBlank {
272 drmVBlankReq request;
273 drmVBlankReply reply;
274 } drmVBlank, *drmVBlankPtr;
276 typedef struct _drmSetVersion {
281 } drmSetVersion, *drmSetVersionPtr;
283 typedef struct _drmFence{
290 #define __drm_dummy_lock(lock) (*(__volatile__ unsigned int *)lock)
292 #define DRM_LOCK_HELD 0x80000000U /**< Hardware lock is held */
293 #define DRM_LOCK_CONT 0x40000000U /**< Hardware lock is contended */
295 #if defined(__GNUC__) && (__GNUC__ >= 2)
296 # if defined(__i386) || defined(__AMD64__) || defined(__x86_64__) || defined(__amd64__)
297 /* Reflect changes here to drmP.h */
298 #define DRM_CAS(lock,old,new,__ret) \
300 int __dummy; /* Can't mark eax as clobbered */ \
301 __asm__ __volatile__( \
302 "lock ; cmpxchg %4,%1\n\t" \
305 "=m" (__drm_dummy_lock(lock)), \
311 #elif defined(__alpha__)
313 #define DRM_CAS(lock, old, new, ret) \
317 __asm__ __volatile__( \
319 " zap %4, 0xF0, %0\n" \
321 " zap %1, 0xF0, %1\n" \
322 " cmpeq %0, %1, %1\n" \
324 " bis %5, %5, %1\n" \
326 "1: xor %1, 1, %1\n" \
330 "=m" (__drm_dummy_lock(lock)),\
336 #elif defined(__sparc__)
338 #define DRM_CAS(lock,old,new,__ret) \
339 do { register unsigned int __old __asm("o0"); \
340 register unsigned int __new __asm("o1"); \
341 register volatile unsigned int *__lock __asm("o2"); \
344 __lock = (volatile unsigned int *)lock; \
345 __asm__ __volatile__( \
346 /*"cas [%2], %3, %0"*/ \
347 ".word 0xd3e29008\n\t" \
348 /*"membar #StoreStore | #StoreLoad"*/ \
355 __ret = (__new != __old); \
358 #elif defined(__ia64__)
360 #ifdef __INTEL_COMPILER
361 /* this currently generates bad code (missing stop bits)... */
362 #include <ia64intrin.h>
364 #define DRM_CAS(lock,old,new,__ret) \
366 unsigned long __result, __old = (old) & 0xffffffff; \
368 __result = _InterlockedCompareExchange_acq(&__drm_dummy_lock(lock), (new), __old);\
369 __ret = (__result) != (__old); \
370 /* __ret = (__sync_val_compare_and_swap(&__drm_dummy_lock(lock), \
376 #define DRM_CAS(lock,old,new,__ret) \
378 unsigned int __result, __old = (old); \
379 __asm__ __volatile__( \
383 "cmpxchg4.acq %0=%1,%3,ar.ccv" \
384 : "=r" (__result), "=m" (__drm_dummy_lock(lock)) \
385 : "r" ((unsigned long)__old), "r" (new) \
387 __ret = (__result) != (__old); \
392 #elif defined(__powerpc__)
394 #define DRM_CAS(lock,old,new,__ret) \
396 __asm__ __volatile__( \
398 "0: lwarx %0,0,%1;" \
406 : "r"(lock), "r"(new), "r"(old) \
407 : "cr0", "memory"); \
410 #endif /* architecture */
411 #endif /* __GNUC__ >= 2 */
414 #define DRM_CAS(lock,old,new,ret) do { ret=1; } while (0) /* FAST LOCK FAILS */
417 #if defined(__alpha__) || defined(__powerpc__)
418 #define DRM_CAS_RESULT(_result) int _result
420 #define DRM_CAS_RESULT(_result) char _result
423 #define DRM_LIGHT_LOCK(fd,lock,context) \
425 DRM_CAS_RESULT(__ret); \
426 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
427 if (__ret) drmGetLock(fd,context,0); \
430 /* This one counts fast locks -- for
431 benchmarking only. */
432 #define DRM_LIGHT_LOCK_COUNT(fd,lock,context,count) \
434 DRM_CAS_RESULT(__ret); \
435 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
436 if (__ret) drmGetLock(fd,context,0); \
440 #define DRM_LOCK(fd,lock,context,flags) \
442 if (flags) drmGetLock(fd,context,flags); \
443 else DRM_LIGHT_LOCK(fd,lock,context); \
446 #define DRM_UNLOCK(fd,lock,context) \
448 DRM_CAS_RESULT(__ret); \
449 DRM_CAS(lock,DRM_LOCK_HELD|context,context,__ret); \
450 if (__ret) drmUnlock(fd,context); \
453 /* Simple spin locks */
454 #define DRM_SPINLOCK(spin,val) \
456 DRM_CAS_RESULT(__ret); \
458 DRM_CAS(spin,0,val,__ret); \
459 if (__ret) while ((spin)->lock); \
463 #define DRM_SPINLOCK_TAKE(spin,val) \
465 DRM_CAS_RESULT(__ret); \
468 cur = (*spin).lock; \
469 DRM_CAS(spin,cur,val,__ret); \
473 #define DRM_SPINLOCK_COUNT(spin,val,count,__ret) \
477 for (__i = 0; __ret && __i < count; __i++) { \
478 DRM_CAS(spin,0,val,__ret); \
479 if (__ret) for (;__i < count && (spin)->lock; __i++); \
483 #define DRM_SPINUNLOCK(spin,val) \
485 DRM_CAS_RESULT(__ret); \
486 if ((*spin).lock == val) { /* else server stole lock */ \
488 DRM_CAS(spin,val,0,__ret); \
493 /* General user-level programmer's API: unprivileged */
494 extern int drmAvailable(void);
495 extern int drmOpen(const char *name, const char *busid);
496 extern int drmClose(int fd);
497 extern drmVersionPtr drmGetVersion(int fd);
498 extern drmVersionPtr drmGetLibVersion(int fd);
499 extern void drmFreeVersion(drmVersionPtr);
500 extern int drmGetMagic(int fd, drm_magic_t * magic);
501 extern char *drmGetBusid(int fd);
502 extern int drmGetInterruptFromBusID(int fd, int busnum, int devnum,
504 extern int drmGetMap(int fd, int idx, drm_handle_t *offset,
505 drmSize *size, drmMapType *type,
506 drmMapFlags *flags, drm_handle_t *handle,
508 extern int drmGetClient(int fd, int idx, int *auth, int *pid,
509 int *uid, unsigned long *magic,
510 unsigned long *iocs);
511 extern int drmGetStats(int fd, drmStatsT *stats);
512 extern int drmSetInterfaceVersion(int fd, drmSetVersion *version);
513 extern int drmCommandNone(int fd, unsigned long drmCommandIndex);
514 extern int drmCommandRead(int fd, unsigned long drmCommandIndex,
515 void *data, unsigned long size);
516 extern int drmCommandWrite(int fd, unsigned long drmCommandIndex,
517 void *data, unsigned long size);
518 extern int drmCommandWriteRead(int fd, unsigned long drmCommandIndex,
519 void *data, unsigned long size);
521 /* General user-level programmer's API: X server (root) only */
522 extern void drmFreeBusid(const char *busid);
523 extern int drmSetBusid(int fd, const char *busid);
524 extern int drmAuthMagic(int fd, drm_magic_t magic);
525 extern int drmAddMap(int fd,
530 drm_handle_t * handle);
531 extern int drmRmMap(int fd, drm_handle_t handle);
532 extern int drmAddContextPrivateMapping(int fd, drm_context_t ctx_id,
533 drm_handle_t handle);
535 extern int drmAddBufs(int fd, int count, int size,
536 drmBufDescFlags flags,
538 extern int drmMarkBufs(int fd, double low, double high);
539 extern int drmCreateContext(int fd, drm_context_t * handle);
540 extern int drmSetContextFlags(int fd, drm_context_t context,
541 drm_context_tFlags flags);
542 extern int drmGetContextFlags(int fd, drm_context_t context,
543 drm_context_tFlagsPtr flags);
544 extern int drmAddContextTag(int fd, drm_context_t context, void *tag);
545 extern int drmDelContextTag(int fd, drm_context_t context);
546 extern void *drmGetContextTag(int fd, drm_context_t context);
547 extern drm_context_t * drmGetReservedContextList(int fd, int *count);
548 extern void drmFreeReservedContextList(drm_context_t *);
549 extern int drmSwitchToContext(int fd, drm_context_t context);
550 extern int drmDestroyContext(int fd, drm_context_t handle);
551 extern int drmCreateDrawable(int fd, drm_drawable_t * handle);
552 extern int drmDestroyDrawable(int fd, drm_drawable_t handle);
553 extern int drmCtlInstHandler(int fd, int irq);
554 extern int drmCtlUninstHandler(int fd);
556 /* General user-level programmer's API: authenticated client and/or X */
557 extern int drmMap(int fd,
560 drmAddressPtr address);
561 extern int drmUnmap(drmAddress address, drmSize size);
562 extern drmBufInfoPtr drmGetBufInfo(int fd);
563 extern drmBufMapPtr drmMapBufs(int fd);
564 extern int drmUnmapBufs(drmBufMapPtr bufs);
565 extern int drmDMA(int fd, drmDMAReqPtr request);
566 extern int drmFreeBufs(int fd, int count, int *list);
567 extern int drmGetLock(int fd,
568 drm_context_t context,
570 extern int drmUnlock(int fd, drm_context_t context);
571 extern int drmFinish(int fd, int context, drmLockFlags flags);
572 extern int drmGetContextPrivateMapping(int fd, drm_context_t ctx_id,
573 drm_handle_t * handle);
575 /* AGP/GART support: X server (root) only */
576 extern int drmAgpAcquire(int fd);
577 extern int drmAgpRelease(int fd);
578 extern int drmAgpEnable(int fd, unsigned long mode);
579 extern int drmAgpAlloc(int fd, unsigned long size,
580 unsigned long type, unsigned long *address,
581 drm_handle_t *handle);
582 extern int drmAgpFree(int fd, drm_handle_t handle);
583 extern int drmAgpBind(int fd, drm_handle_t handle,
584 unsigned long offset);
585 extern int drmAgpUnbind(int fd, drm_handle_t handle);
587 /* AGP/GART info: authenticated client and/or X */
588 extern int drmAgpVersionMajor(int fd);
589 extern int drmAgpVersionMinor(int fd);
590 extern unsigned long drmAgpGetMode(int fd);
591 extern unsigned long drmAgpBase(int fd); /* Physical location */
592 extern unsigned long drmAgpSize(int fd); /* Bytes */
593 extern unsigned long drmAgpMemoryUsed(int fd);
594 extern unsigned long drmAgpMemoryAvail(int fd);
595 extern unsigned int drmAgpVendorId(int fd);
596 extern unsigned int drmAgpDeviceId(int fd);
598 /* PCI scatter/gather support: X server (root) only */
599 extern int drmScatterGatherAlloc(int fd, unsigned long size,
600 drm_handle_t *handle);
601 extern int drmScatterGatherFree(int fd, drm_handle_t handle);
603 extern int drmWaitVBlank(int fd, drmVBlankPtr vbl);
607 extern int drmFenceCreate(int fd, int shareable, int class,
608 unsigned type, int emit,
610 extern int drmFenceDestroy(int fd, const drmFence *fence);
611 extern int drmFenceReference(int fd, unsigned handle, drmFence *fence);
612 extern int drmFenceUnreference(int fd, const drmFence *fence);
613 extern int drmFenceFlush(int fd, drmFence *fence, unsigned flush_type);
614 extern int drmFenceSignaled(int fd, drmFence *fence);
615 extern int drmFenceWait(int fd, drmFence *fence, unsigned flush_type,
616 int lazy, int ignore_signals);
617 extern int drmFenceEmit(int fd, drmFence *fence, unsigned emit_type);
621 /* Support routines */
622 extern int drmError(int err, const char *label);
623 extern void *drmMalloc(int size);
624 extern void drmFree(void *pt);
626 /* Hash table routines */
627 extern void *drmHashCreate(void);
628 extern int drmHashDestroy(void *t);
629 extern int drmHashLookup(void *t, unsigned long key, void **value);
630 extern int drmHashInsert(void *t, unsigned long key, void *value);
631 extern int drmHashDelete(void *t, unsigned long key);
632 extern int drmHashFirst(void *t, unsigned long *key, void **value);
633 extern int drmHashNext(void *t, unsigned long *key, void **value);
636 extern void *drmRandomCreate(unsigned long seed);
637 extern int drmRandomDestroy(void *state);
638 extern unsigned long drmRandom(void *state);
639 extern double drmRandomDouble(void *state);
641 /* Skip list routines */
643 extern void *drmSLCreate(void);
644 extern int drmSLDestroy(void *l);
645 extern int drmSLLookup(void *l, unsigned long key, void **value);
646 extern int drmSLInsert(void *l, unsigned long key, void *value);
647 extern int drmSLDelete(void *l, unsigned long key);
648 extern int drmSLNext(void *l, unsigned long *key, void **value);
649 extern int drmSLFirst(void *l, unsigned long *key, void **value);
650 extern void drmSLDump(void *l);
651 extern int drmSLLookupNeighbors(void *l, unsigned long key,
652 unsigned long *prev_key, void **prev_value,
653 unsigned long *next_key, void **next_value);