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.
38 #include <sys/types.h>
42 /* Defaults, if nothing set in xf86config */
45 /* Default /dev/dri directory permissions 0755 */
46 #define DRM_DEV_DIRMODE \
47 (S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH)
48 #define DRM_DEV_MODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
50 #define DRM_DIR_NAME "/dev/dri"
51 #define DRM_DEV_NAME "%s/card%d"
52 #define DRM_PROC_NAME "/proc/dri/" /* For backward Linux compatibility */
54 #define DRM_ERR_NO_DEVICE (-1001)
55 #define DRM_ERR_NO_ACCESS (-1002)
56 #define DRM_ERR_NOT_ROOT (-1003)
57 #define DRM_ERR_INVALID (-1004)
58 #define DRM_ERR_NO_FD (-1005)
60 #define DRM_AGP_NO_HANDLE 0
62 typedef unsigned int drmSize, *drmSizePtr; /**< For mapped regions */
63 typedef void *drmAddress, **drmAddressPtr; /**< For mapped regions */
65 typedef struct _drmServerInfo {
66 int (*debug_print)(const char *format, va_list ap);
67 int (*load_module)(const char *name);
68 void (*get_perms)(gid_t *, mode_t *);
69 } drmServerInfo, *drmServerInfoPtr;
71 typedef struct drmHashEntry {
73 void (*f)(int, void *, void *);
77 extern void *drmGetHashTable(void);
78 extern drmHashEntry *drmGetEntry(int fd);
81 * Driver version information.
83 * \sa drmGetVersion() and drmSetVersion().
85 typedef struct _drmVersion {
86 int version_major; /**< Major version */
87 int version_minor; /**< Minor version */
88 int version_patchlevel; /**< Patch level */
89 int name_len; /**< Length of name buffer */
90 char *name; /**< Name of driver */
91 int date_len; /**< Length of date buffer */
92 char *date; /**< User-space buffer to hold date */
93 int desc_len; /**< Length of desc buffer */
94 char *desc; /**< User-space buffer to hold desc */
95 } drmVersion, *drmVersionPtr;
97 typedef struct _drmStats {
98 unsigned long count; /**< Number of data */
100 unsigned long value; /**< Value from kernel */
101 const char *long_format; /**< Suggested format for long_name */
102 const char *long_name; /**< Long name for value */
103 const char *rate_format; /**< Suggested format for rate_name */
104 const char *rate_name; /**< Short name for value per second */
105 int isvalue; /**< True if value (vs. counter) */
106 const char *mult_names; /**< Multiplier names (e.g., "KGM") */
107 int mult; /**< Multiplier value (e.g., 1024) */
108 int verbose; /**< Suggest only in verbose output */
113 /* All of these enums *MUST* match with the
114 kernel implementation -- so do *NOT*
115 change them! (The drmlib implementation
116 will just copy the flags instead of
117 translating them.) */
119 DRM_FRAME_BUFFER = 0, /**< WC, no caching, no core dump */
120 DRM_REGISTERS = 1, /**< no caching, no core dump */
121 DRM_SHM = 2, /**< shared, cached */
122 DRM_AGP = 3, /**< AGP/GART */
123 DRM_SCATTER_GATHER = 4, /**< PCI scatter/gather */
124 DRM_CONSISTENT = 5 /**< PCI consistent */
128 DRM_RESTRICTED = 0x0001, /**< Cannot be mapped to client-virtual */
129 DRM_READ_ONLY = 0x0002, /**< Read-only in client-virtual */
130 DRM_LOCKED = 0x0004, /**< Physical pages locked */
131 DRM_KERNEL = 0x0008, /**< Kernel requires access */
132 DRM_WRITE_COMBINING = 0x0010, /**< Use write-combining, if available */
133 DRM_CONTAINS_LOCK = 0x0020, /**< SHM page that contains lock */
134 DRM_REMOVABLE = 0x0040 /**< Removable mapping */
138 * \warning These values *MUST* match drm.h
141 /** \name Flags for DMA buffer dispatch */
143 DRM_DMA_BLOCK = 0x01, /**<
144 * Block until buffer dispatched.
146 * \note the buffer may not yet have been
147 * processed by the hardware -- getting a
148 * hardware lock with the hardware quiescent
149 * will ensure that the buffer has been
152 DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
153 DRM_DMA_PRIORITY = 0x04, /**< High priority dispatch */
156 /** \name Flags for DMA buffer request */
158 DRM_DMA_WAIT = 0x10, /**< Wait for free buffers */
159 DRM_DMA_SMALLER_OK = 0x20, /**< Smaller-than-requested buffers OK */
160 DRM_DMA_LARGER_OK = 0x40 /**< Larger-than-requested buffers OK */
165 DRM_PAGE_ALIGN = 0x01,
166 DRM_AGP_BUFFER = 0x02,
167 DRM_SG_BUFFER = 0x04,
168 DRM_FB_BUFFER = 0x08,
169 DRM_PCI_BUFFER_RO = 0x10
173 DRM_LOCK_READY = 0x01, /**< Wait until hardware is ready for DMA */
174 DRM_LOCK_QUIESCENT = 0x02, /**< Wait until hardware quiescent */
175 DRM_LOCK_FLUSH = 0x04, /**< Flush this context's DMA queue first */
176 DRM_LOCK_FLUSH_ALL = 0x08, /**< Flush all DMA queues first */
177 /* These *HALT* flags aren't supported yet
178 -- they will be used to support the
179 full-screen DGA-like mode. */
180 DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
181 DRM_HALT_CUR_QUEUES = 0x20 /**< Halt all current queues */
185 DRM_CONTEXT_PRESERVED = 0x01, /**< This context is preserved and
187 DRM_CONTEXT_2DONLY = 0x02 /**< This context is for 2D rendering only. */
188 } drm_context_tFlags, *drm_context_tFlagsPtr;
190 typedef struct _drmBufDesc {
191 int count; /**< Number of buffers of this size */
192 int size; /**< Size in bytes */
193 int low_mark; /**< Low water mark */
194 int high_mark; /**< High water mark */
195 } drmBufDesc, *drmBufDescPtr;
197 typedef struct _drmBufInfo {
198 int count; /**< Number of buffers described in list */
199 drmBufDescPtr list; /**< List of buffer descriptions */
200 } drmBufInfo, *drmBufInfoPtr;
202 typedef struct _drmBuf {
203 int idx; /**< Index into the master buffer list */
204 int total; /**< Buffer size */
205 int used; /**< Amount of buffer in use (for DMA) */
206 drmAddress address; /**< Address */
207 } drmBuf, *drmBufPtr;
210 * Buffer mapping information.
212 * Used by drmMapBufs() and drmUnmapBufs() to store information about the
215 typedef struct _drmBufMap {
216 int count; /**< Number of buffers mapped */
217 drmBufPtr list; /**< Buffers */
218 } drmBufMap, *drmBufMapPtr;
220 typedef struct _drmLock {
221 volatile unsigned int lock;
223 /* This is big enough for most current (and future?) architectures:
226 Intel P5/PPro/PII/PIII: 32 bytes
227 Intel StrongARM: 32 bytes
228 Intel i386/i486: 16 bytes
230 Motorola 68k: 16 bytes
231 Motorola PowerPC: 32 bytes
234 } drmLock, *drmLockPtr;
237 * Indices here refer to the offset into
240 typedef struct _drmDMAReq {
241 drm_context_t context; /**< Context handle */
242 int send_count; /**< Number of buffers to send */
243 int *send_list; /**< List of handles to buffers */
244 int *send_sizes; /**< Lengths of data to send, in bytes */
245 drmDMAFlags flags; /**< Flags */
246 int request_count; /**< Number of buffers requested */
247 int request_size; /**< Desired size of buffers requested */
248 int *request_list; /**< Buffer information */
249 int *request_sizes; /**< Minimum acceptable sizes */
250 int granted_count; /**< Number of buffers granted at this size */
251 } drmDMAReq, *drmDMAReqPtr;
253 typedef struct _drmRegion {
258 } drmRegion, *drmRegionPtr;
260 typedef struct _drmTextureRegion {
263 unsigned char in_use;
264 unsigned char padding; /**< Explicitly pad this out */
266 } drmTextureRegion, *drmTextureRegionPtr;
270 DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */
271 DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */
272 DRM_VBLANK_FLIP = 0x8000000, /**< Scheduled buffer swap should flip */
273 DRM_VBLANK_NEXTONMISS = 0x10000000, /**< If missed, wait for next vblank */
274 DRM_VBLANK_SECONDARY = 0x20000000, /**< Secondary display controller */
275 DRM_VBLANK_SIGNAL = 0x40000000 /* Send signal instead of blocking */
278 typedef struct _drmVBlankReq {
279 drmVBlankSeqType type;
280 unsigned int sequence;
281 unsigned long signal;
282 } drmVBlankReq, *drmVBlankReqPtr;
284 typedef struct _drmVBlankReply {
285 drmVBlankSeqType type;
286 unsigned int sequence;
289 } drmVBlankReply, *drmVBlankReplyPtr;
291 typedef union _drmVBlank {
292 drmVBlankReq request;
293 drmVBlankReply reply;
294 } drmVBlank, *drmVBlankPtr;
296 typedef struct _drmSetVersion {
301 } drmSetVersion, *drmSetVersionPtr;
303 #define __drm_dummy_lock(lock) (*(__volatile__ unsigned int *)lock)
305 #define DRM_LOCK_HELD 0x80000000U /**< Hardware lock is held */
306 #define DRM_LOCK_CONT 0x40000000U /**< Hardware lock is contended */
308 #if defined(__GNUC__) && (__GNUC__ >= 2)
309 # if defined(__i386) || defined(__AMD64__) || defined(__x86_64__) || defined(__amd64__)
310 /* Reflect changes here to drmP.h */
311 #define DRM_CAS(lock,old,new,__ret) \
313 int __dummy; /* Can't mark eax as clobbered */ \
314 __asm__ __volatile__( \
315 "lock ; cmpxchg %4,%1\n\t" \
318 "=m" (__drm_dummy_lock(lock)), \
324 #elif defined(__alpha__)
326 #define DRM_CAS(lock, old, new, ret) \
330 __asm__ __volatile__( \
332 " zap %4, 0xF0, %0\n" \
334 " zap %1, 0xF0, %1\n" \
335 " cmpeq %0, %1, %1\n" \
337 " bis %5, %5, %1\n" \
339 "1: xor %1, 1, %1\n" \
343 "=m" (__drm_dummy_lock(lock)),\
349 #elif defined(__sparc__)
351 #define DRM_CAS(lock,old,new,__ret) \
352 do { register unsigned int __old __asm("o0"); \
353 register unsigned int __new __asm("o1"); \
354 register volatile unsigned int *__lock __asm("o2"); \
357 __lock = (volatile unsigned int *)lock; \
358 __asm__ __volatile__( \
359 /*"cas [%2], %3, %0"*/ \
360 ".word 0xd3e29008\n\t" \
361 /*"membar #StoreStore | #StoreLoad"*/ \
368 __ret = (__new != __old); \
371 #elif defined(__ia64__)
373 #ifdef __INTEL_COMPILER
374 /* this currently generates bad code (missing stop bits)... */
375 #include <ia64intrin.h>
377 #define DRM_CAS(lock,old,new,__ret) \
379 unsigned long __result, __old = (old) & 0xffffffff; \
381 __result = _InterlockedCompareExchange_acq(&__drm_dummy_lock(lock), (new), __old);\
382 __ret = (__result) != (__old); \
383 /* __ret = (__sync_val_compare_and_swap(&__drm_dummy_lock(lock), \
389 #define DRM_CAS(lock,old,new,__ret) \
391 unsigned int __result, __old = (old); \
392 __asm__ __volatile__( \
396 "cmpxchg4.acq %0=%1,%3,ar.ccv" \
397 : "=r" (__result), "=m" (__drm_dummy_lock(lock)) \
398 : "r" ((unsigned long)__old), "r" (new) \
400 __ret = (__result) != (__old); \
405 #elif defined(__powerpc__)
407 #define DRM_CAS(lock,old,new,__ret) \
409 __asm__ __volatile__( \
411 "0: lwarx %0,0,%1;" \
419 : "r"(lock), "r"(new), "r"(old) \
420 : "cr0", "memory"); \
423 #endif /* architecture */
424 #endif /* __GNUC__ >= 2 */
427 #define DRM_CAS(lock,old,new,ret) do { ret=1; } while (0) /* FAST LOCK FAILS */
430 #if defined(__alpha__) || defined(__powerpc__)
431 #define DRM_CAS_RESULT(_result) int _result
433 #define DRM_CAS_RESULT(_result) char _result
436 #define DRM_LIGHT_LOCK(fd,lock,context) \
438 DRM_CAS_RESULT(__ret); \
439 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
440 if (__ret) drmGetLock(fd,context,0); \
443 /* This one counts fast locks -- for
444 benchmarking only. */
445 #define DRM_LIGHT_LOCK_COUNT(fd,lock,context,count) \
447 DRM_CAS_RESULT(__ret); \
448 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
449 if (__ret) drmGetLock(fd,context,0); \
453 #define DRM_LOCK(fd,lock,context,flags) \
455 if (flags) drmGetLock(fd,context,flags); \
456 else DRM_LIGHT_LOCK(fd,lock,context); \
459 #define DRM_UNLOCK(fd,lock,context) \
461 DRM_CAS_RESULT(__ret); \
462 DRM_CAS(lock,DRM_LOCK_HELD|context,context,__ret); \
463 if (__ret) drmUnlock(fd,context); \
466 /* Simple spin locks */
467 #define DRM_SPINLOCK(spin,val) \
469 DRM_CAS_RESULT(__ret); \
471 DRM_CAS(spin,0,val,__ret); \
472 if (__ret) while ((spin)->lock); \
476 #define DRM_SPINLOCK_TAKE(spin,val) \
478 DRM_CAS_RESULT(__ret); \
481 cur = (*spin).lock; \
482 DRM_CAS(spin,cur,val,__ret); \
486 #define DRM_SPINLOCK_COUNT(spin,val,count,__ret) \
490 for (__i = 0; __ret && __i < count; __i++) { \
491 DRM_CAS(spin,0,val,__ret); \
492 if (__ret) for (;__i < count && (spin)->lock; __i++); \
496 #define DRM_SPINUNLOCK(spin,val) \
498 DRM_CAS_RESULT(__ret); \
499 if ((*spin).lock == val) { /* else server stole lock */ \
501 DRM_CAS(spin,val,0,__ret); \
508 /* General user-level programmer's API: unprivileged */
509 extern int drmAvailable(void);
510 extern int drmOpen(const char *name, const char *busid);
511 extern int drmClose(int fd);
512 extern drmVersionPtr drmGetVersion(int fd);
513 extern drmVersionPtr drmGetLibVersion(int fd);
514 extern void drmFreeVersion(drmVersionPtr);
515 extern int drmGetMagic(int fd, drm_magic_t * magic);
516 extern char *drmGetBusid(int fd);
517 extern int drmGetInterruptFromBusID(int fd, int busnum, int devnum,
519 extern int drmGetMap(int fd, int idx, drm_handle_t *offset,
520 drmSize *size, drmMapType *type,
521 drmMapFlags *flags, drm_handle_t *handle,
523 extern int drmGetClient(int fd, int idx, int *auth, int *pid,
524 int *uid, unsigned long *magic,
525 unsigned long *iocs);
526 extern int drmGetStats(int fd, drmStatsT *stats);
527 extern int drmSetInterfaceVersion(int fd, drmSetVersion *version);
528 extern int drmCommandNone(int fd, unsigned long drmCommandIndex);
529 extern int drmCommandRead(int fd, unsigned long drmCommandIndex,
530 void *data, unsigned long size);
531 extern int drmCommandWrite(int fd, unsigned long drmCommandIndex,
532 void *data, unsigned long size);
533 extern int drmCommandWriteRead(int fd, unsigned long drmCommandIndex,
534 void *data, unsigned long size);
536 /* General user-level programmer's API: X server (root) only */
537 extern void drmFreeBusid(const char *busid);
538 extern int drmSetBusid(int fd, const char *busid);
539 extern int drmAuthMagic(int fd, drm_magic_t magic);
540 extern int drmAddMap(int fd,
545 drm_handle_t * handle);
546 extern int drmRmMap(int fd, drm_handle_t handle);
547 extern int drmAddContextPrivateMapping(int fd, drm_context_t ctx_id,
548 drm_handle_t handle);
550 extern int drmAddBufs(int fd, int count, int size,
551 drmBufDescFlags flags,
553 extern int drmMarkBufs(int fd, double low, double high);
554 extern int drmCreateContext(int fd, drm_context_t * handle);
555 extern int drmSetContextFlags(int fd, drm_context_t context,
556 drm_context_tFlags flags);
557 extern int drmGetContextFlags(int fd, drm_context_t context,
558 drm_context_tFlagsPtr flags);
559 extern int drmAddContextTag(int fd, drm_context_t context, void *tag);
560 extern int drmDelContextTag(int fd, drm_context_t context);
561 extern void *drmGetContextTag(int fd, drm_context_t context);
562 extern drm_context_t * drmGetReservedContextList(int fd, int *count);
563 extern void drmFreeReservedContextList(drm_context_t *);
564 extern int drmSwitchToContext(int fd, drm_context_t context);
565 extern int drmDestroyContext(int fd, drm_context_t handle);
566 extern int drmCreateDrawable(int fd, drm_drawable_t * handle);
567 extern int drmDestroyDrawable(int fd, drm_drawable_t handle);
568 extern int drmUpdateDrawableInfo(int fd, drm_drawable_t handle,
569 drm_drawable_info_type_t type,
570 unsigned int num, void *data);
571 extern int drmCtlInstHandler(int fd, int irq);
572 extern int drmCtlUninstHandler(int fd);
574 /* General user-level programmer's API: authenticated client and/or X */
575 extern int drmMap(int fd,
578 drmAddressPtr address);
579 extern int drmUnmap(drmAddress address, drmSize size);
580 extern drmBufInfoPtr drmGetBufInfo(int fd);
581 extern drmBufMapPtr drmMapBufs(int fd);
582 extern int drmUnmapBufs(drmBufMapPtr bufs);
583 extern int drmDMA(int fd, drmDMAReqPtr request);
584 extern int drmFreeBufs(int fd, int count, int *list);
585 extern int drmGetLock(int fd,
586 drm_context_t context,
588 extern int drmUnlock(int fd, drm_context_t context);
589 extern int drmFinish(int fd, int context, drmLockFlags flags);
590 extern int drmGetContextPrivateMapping(int fd, drm_context_t ctx_id,
591 drm_handle_t * handle);
593 /* AGP/GART support: X server (root) only */
594 extern int drmAgpAcquire(int fd);
595 extern int drmAgpRelease(int fd);
596 extern int drmAgpEnable(int fd, unsigned long mode);
597 extern int drmAgpAlloc(int fd, unsigned long size,
598 unsigned long type, unsigned long *address,
599 drm_handle_t *handle);
600 extern int drmAgpFree(int fd, drm_handle_t handle);
601 extern int drmAgpBind(int fd, drm_handle_t handle,
602 unsigned long offset);
603 extern int drmAgpUnbind(int fd, drm_handle_t handle);
605 /* AGP/GART info: authenticated client and/or X */
606 extern int drmAgpVersionMajor(int fd);
607 extern int drmAgpVersionMinor(int fd);
608 extern unsigned long drmAgpGetMode(int fd);
609 extern unsigned long drmAgpBase(int fd); /* Physical location */
610 extern unsigned long drmAgpSize(int fd); /* Bytes */
611 extern unsigned long drmAgpMemoryUsed(int fd);
612 extern unsigned long drmAgpMemoryAvail(int fd);
613 extern unsigned int drmAgpVendorId(int fd);
614 extern unsigned int drmAgpDeviceId(int fd);
616 /* PCI scatter/gather support: X server (root) only */
617 extern int drmScatterGatherAlloc(int fd, unsigned long size,
618 drm_handle_t *handle);
619 extern int drmScatterGatherFree(int fd, drm_handle_t handle);
621 extern int drmWaitVBlank(int fd, drmVBlankPtr vbl);
623 /* Support routines */
624 extern void drmSetServerInfo(drmServerInfoPtr info);
625 extern int drmError(int err, const char *label);
626 extern void *drmMalloc(int size);
627 extern void drmFree(void *pt);
629 /* Hash table routines */
630 extern void *drmHashCreate(void);
631 extern int drmHashDestroy(void *t);
632 extern int drmHashLookup(void *t, unsigned long key, void **value);
633 extern int drmHashInsert(void *t, unsigned long key, void *value);
634 extern int drmHashDelete(void *t, unsigned long key);
635 extern int drmHashFirst(void *t, unsigned long *key, void **value);
636 extern int drmHashNext(void *t, unsigned long *key, void **value);
639 extern void *drmRandomCreate(unsigned long seed);
640 extern int drmRandomDestroy(void *state);
641 extern unsigned long drmRandom(void *state);
642 extern double drmRandomDouble(void *state);
644 /* Skip list routines */
646 extern void *drmSLCreate(void);
647 extern int drmSLDestroy(void *l);
648 extern int drmSLLookup(void *l, unsigned long key, void **value);
649 extern int drmSLInsert(void *l, unsigned long key, void *value);
650 extern int drmSLDelete(void *l, unsigned long key);
651 extern int drmSLNext(void *l, unsigned long *key, void **value);
652 extern int drmSLFirst(void *l, unsigned long *key, void **value);
653 extern void drmSLDump(void *l);
654 extern int drmSLLookupNeighbors(void *l, unsigned long key,
655 unsigned long *prev_key, void **prev_value,
656 unsigned long *next_key, void **next_value);
658 extern int drmOpenOnce(void *unused, const char *BusID, int *newlyopened);
659 extern void drmCloseOnce(int fd);
660 extern void drmMsg(const char *format, ...);