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>
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 */
64 typedef struct _drmServerInfo {
65 int (*debug_print)(const char *format, va_list ap);
66 int (*load_module)(const char *name);
67 void (*get_perms)(gid_t *, mode_t *);
68 } drmServerInfo, *drmServerInfoPtr;
70 typedef struct drmHashEntry {
72 void (*f)(int, void *, void *);
76 extern void *drmGetHashTable(void);
77 extern drmHashEntry *drmGetEntry(int fd);
80 * Driver version information.
82 * \sa drmGetVersion() and drmSetVersion().
84 typedef struct _drmVersion {
85 int version_major; /**< Major version */
86 int version_minor; /**< Minor version */
87 int version_patchlevel; /**< Patch level */
88 int name_len; /**< Length of name buffer */
89 char *name; /**< Name of driver */
90 int date_len; /**< Length of date buffer */
91 char *date; /**< User-space buffer to hold date */
92 int desc_len; /**< Length of desc buffer */
93 char *desc; /**< User-space buffer to hold desc */
94 } drmVersion, *drmVersionPtr;
96 typedef struct _drmStats {
97 unsigned long count; /**< Number of data */
99 unsigned long value; /**< Value from kernel */
100 const char *long_format; /**< Suggested format for long_name */
101 const char *long_name; /**< Long name for value */
102 const char *rate_format; /**< Suggested format for rate_name */
103 const char *rate_name; /**< Short name for value per second */
104 int isvalue; /**< True if value (vs. counter) */
105 const char *mult_names; /**< Multiplier names (e.g., "KGM") */
106 int mult; /**< Multiplier value (e.g., 1024) */
107 int verbose; /**< Suggest only in verbose output */
112 /* All of these enums *MUST* match with the
113 kernel implementation -- so do *NOT*
114 change them! (The drmlib implementation
115 will just copy the flags instead of
116 translating them.) */
118 DRM_FRAME_BUFFER = 0, /**< WC, no caching, no core dump */
119 DRM_REGISTERS = 1, /**< no caching, no core dump */
120 DRM_SHM = 2, /**< shared, cached */
121 DRM_AGP = 3, /**< AGP/GART */
122 DRM_SCATTER_GATHER = 4, /**< PCI scatter/gather */
123 DRM_CONSISTENT = 5 /**< PCI consistent */
127 DRM_RESTRICTED = 0x0001, /**< Cannot be mapped to client-virtual */
128 DRM_READ_ONLY = 0x0002, /**< Read-only in client-virtual */
129 DRM_LOCKED = 0x0004, /**< Physical pages locked */
130 DRM_KERNEL = 0x0008, /**< Kernel requires access */
131 DRM_WRITE_COMBINING = 0x0010, /**< Use write-combining, if available */
132 DRM_CONTAINS_LOCK = 0x0020, /**< SHM page that contains lock */
133 DRM_REMOVABLE = 0x0040 /**< Removable mapping */
137 * \warning These values *MUST* match drm.h
140 /** \name Flags for DMA buffer dispatch */
142 DRM_DMA_BLOCK = 0x01, /**<
143 * Block until buffer dispatched.
145 * \note the buffer may not yet have been
146 * processed by the hardware -- getting a
147 * hardware lock with the hardware quiescent
148 * will ensure that the buffer has been
151 DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
152 DRM_DMA_PRIORITY = 0x04, /**< High priority dispatch */
155 /** \name Flags for DMA buffer request */
157 DRM_DMA_WAIT = 0x10, /**< Wait for free buffers */
158 DRM_DMA_SMALLER_OK = 0x20, /**< Smaller-than-requested buffers OK */
159 DRM_DMA_LARGER_OK = 0x40 /**< Larger-than-requested buffers OK */
164 DRM_PAGE_ALIGN = 0x01,
165 DRM_AGP_BUFFER = 0x02,
166 DRM_SG_BUFFER = 0x04,
167 DRM_FB_BUFFER = 0x08,
168 DRM_PCI_BUFFER_RO = 0x10
172 DRM_LOCK_READY = 0x01, /**< Wait until hardware is ready for DMA */
173 DRM_LOCK_QUIESCENT = 0x02, /**< Wait until hardware quiescent */
174 DRM_LOCK_FLUSH = 0x04, /**< Flush this context's DMA queue first */
175 DRM_LOCK_FLUSH_ALL = 0x08, /**< Flush all DMA queues first */
176 /* These *HALT* flags aren't supported yet
177 -- they will be used to support the
178 full-screen DGA-like mode. */
179 DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
180 DRM_HALT_CUR_QUEUES = 0x20 /**< Halt all current queues */
184 DRM_CONTEXT_PRESERVED = 0x01, /**< This context is preserved and
186 DRM_CONTEXT_2DONLY = 0x02 /**< This context is for 2D rendering only. */
187 } drm_context_tFlags, *drm_context_tFlagsPtr;
189 typedef struct _drmBufDesc {
190 int count; /**< Number of buffers of this size */
191 int size; /**< Size in bytes */
192 int low_mark; /**< Low water mark */
193 int high_mark; /**< High water mark */
194 } drmBufDesc, *drmBufDescPtr;
196 typedef struct _drmBufInfo {
197 int count; /**< Number of buffers described in list */
198 drmBufDescPtr list; /**< List of buffer descriptions */
199 } drmBufInfo, *drmBufInfoPtr;
201 typedef struct _drmBuf {
202 int idx; /**< Index into the master buffer list */
203 int total; /**< Buffer size */
204 int used; /**< Amount of buffer in use (for DMA) */
205 drmAddress address; /**< Address */
206 } drmBuf, *drmBufPtr;
209 * Buffer mapping information.
211 * Used by drmMapBufs() and drmUnmapBufs() to store information about the
214 typedef struct _drmBufMap {
215 int count; /**< Number of buffers mapped */
216 drmBufPtr list; /**< Buffers */
217 } drmBufMap, *drmBufMapPtr;
219 typedef struct _drmLock {
220 volatile unsigned int lock;
222 /* This is big enough for most current (and future?) architectures:
225 Intel P5/PPro/PII/PIII: 32 bytes
226 Intel StrongARM: 32 bytes
227 Intel i386/i486: 16 bytes
229 Motorola 68k: 16 bytes
230 Motorola PowerPC: 32 bytes
233 } drmLock, *drmLockPtr;
236 * Indices here refer to the offset into
239 typedef struct _drmDMAReq {
240 drm_context_t context; /**< Context handle */
241 int send_count; /**< Number of buffers to send */
242 int *send_list; /**< List of handles to buffers */
243 int *send_sizes; /**< Lengths of data to send, in bytes */
244 drmDMAFlags flags; /**< Flags */
245 int request_count; /**< Number of buffers requested */
246 int request_size; /**< Desired size of buffers requested */
247 int *request_list; /**< Buffer information */
248 int *request_sizes; /**< Minimum acceptable sizes */
249 int granted_count; /**< Number of buffers granted at this size */
250 } drmDMAReq, *drmDMAReqPtr;
252 typedef struct _drmRegion {
257 } drmRegion, *drmRegionPtr;
259 typedef struct _drmTextureRegion {
262 unsigned char in_use;
263 unsigned char padding; /**< Explicitly pad this out */
265 } drmTextureRegion, *drmTextureRegionPtr;
269 DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */
270 DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */
271 DRM_VBLANK_FLIP = 0x8000000, /**< Scheduled buffer swap should flip */
272 DRM_VBLANK_NEXTONMISS = 0x10000000, /**< If missed, wait for next vblank */
273 DRM_VBLANK_SECONDARY = 0x20000000, /**< Secondary display controller */
274 DRM_VBLANK_SIGNAL = 0x40000000 /* Send signal instead of blocking */
277 typedef struct _drmVBlankReq {
278 drmVBlankSeqType type;
279 unsigned int sequence;
280 unsigned long signal;
281 } drmVBlankReq, *drmVBlankReqPtr;
283 typedef struct _drmVBlankReply {
284 drmVBlankSeqType type;
285 unsigned int sequence;
288 } drmVBlankReply, *drmVBlankReplyPtr;
290 typedef union _drmVBlank {
291 drmVBlankReq request;
292 drmVBlankReply reply;
293 } drmVBlank, *drmVBlankPtr;
295 typedef struct _drmSetVersion {
300 } drmSetVersion, *drmSetVersionPtr;
302 #define __drm_dummy_lock(lock) (*(__volatile__ unsigned int *)lock)
304 #define DRM_LOCK_HELD 0x80000000U /**< Hardware lock is held */
305 #define DRM_LOCK_CONT 0x40000000U /**< Hardware lock is contended */
307 #if defined(__GNUC__) && (__GNUC__ >= 2)
308 # if defined(__i386) || defined(__AMD64__) || defined(__x86_64__) || defined(__amd64__)
309 /* Reflect changes here to drmP.h */
310 #define DRM_CAS(lock,old,new,__ret) \
312 int __dummy; /* Can't mark eax as clobbered */ \
313 __asm__ __volatile__( \
314 "lock ; cmpxchg %4,%1\n\t" \
317 "=m" (__drm_dummy_lock(lock)), \
323 #elif defined(__alpha__)
325 #define DRM_CAS(lock, old, new, ret) \
329 __asm__ __volatile__( \
331 " zap %4, 0xF0, %0\n" \
333 " zap %1, 0xF0, %1\n" \
334 " cmpeq %0, %1, %1\n" \
336 " bis %5, %5, %1\n" \
338 "1: xor %1, 1, %1\n" \
342 "=m" (__drm_dummy_lock(lock)),\
348 #elif defined(__sparc__)
350 #define DRM_CAS(lock,old,new,__ret) \
351 do { register unsigned int __old __asm("o0"); \
352 register unsigned int __new __asm("o1"); \
353 register volatile unsigned int *__lock __asm("o2"); \
356 __lock = (volatile unsigned int *)lock; \
357 __asm__ __volatile__( \
358 /*"cas [%2], %3, %0"*/ \
359 ".word 0xd3e29008\n\t" \
360 /*"membar #StoreStore | #StoreLoad"*/ \
367 __ret = (__new != __old); \
370 #elif defined(__ia64__)
372 #ifdef __INTEL_COMPILER
373 /* this currently generates bad code (missing stop bits)... */
374 #include <ia64intrin.h>
376 #define DRM_CAS(lock,old,new,__ret) \
378 unsigned long __result, __old = (old) & 0xffffffff; \
380 __result = _InterlockedCompareExchange_acq(&__drm_dummy_lock(lock), (new), __old);\
381 __ret = (__result) != (__old); \
382 /* __ret = (__sync_val_compare_and_swap(&__drm_dummy_lock(lock), \
388 #define DRM_CAS(lock,old,new,__ret) \
390 unsigned int __result, __old = (old); \
391 __asm__ __volatile__( \
395 "cmpxchg4.acq %0=%1,%3,ar.ccv" \
396 : "=r" (__result), "=m" (__drm_dummy_lock(lock)) \
397 : "r" ((unsigned long)__old), "r" (new) \
399 __ret = (__result) != (__old); \
404 #elif defined(__powerpc__)
406 #define DRM_CAS(lock,old,new,__ret) \
408 __asm__ __volatile__( \
410 "0: lwarx %0,0,%1;" \
418 : "r"(lock), "r"(new), "r"(old) \
419 : "cr0", "memory"); \
422 #endif /* architecture */
423 #endif /* __GNUC__ >= 2 */
426 #define DRM_CAS(lock,old,new,ret) do { ret=1; } while (0) /* FAST LOCK FAILS */
429 #if defined(__alpha__) || defined(__powerpc__)
430 #define DRM_CAS_RESULT(_result) int _result
432 #define DRM_CAS_RESULT(_result) char _result
435 #define DRM_LIGHT_LOCK(fd,lock,context) \
437 DRM_CAS_RESULT(__ret); \
438 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
439 if (__ret) drmGetLock(fd,context,0); \
442 /* This one counts fast locks -- for
443 benchmarking only. */
444 #define DRM_LIGHT_LOCK_COUNT(fd,lock,context,count) \
446 DRM_CAS_RESULT(__ret); \
447 DRM_CAS(lock,context,DRM_LOCK_HELD|context,__ret); \
448 if (__ret) drmGetLock(fd,context,0); \
452 #define DRM_LOCK(fd,lock,context,flags) \
454 if (flags) drmGetLock(fd,context,flags); \
455 else DRM_LIGHT_LOCK(fd,lock,context); \
458 #define DRM_UNLOCK(fd,lock,context) \
460 DRM_CAS_RESULT(__ret); \
461 DRM_CAS(lock,DRM_LOCK_HELD|context,context,__ret); \
462 if (__ret) drmUnlock(fd,context); \
465 /* Simple spin locks */
466 #define DRM_SPINLOCK(spin,val) \
468 DRM_CAS_RESULT(__ret); \
470 DRM_CAS(spin,0,val,__ret); \
471 if (__ret) while ((spin)->lock); \
475 #define DRM_SPINLOCK_TAKE(spin,val) \
477 DRM_CAS_RESULT(__ret); \
480 cur = (*spin).lock; \
481 DRM_CAS(spin,cur,val,__ret); \
485 #define DRM_SPINLOCK_COUNT(spin,val,count,__ret) \
489 for (__i = 0; __ret && __i < count; __i++) { \
490 DRM_CAS(spin,0,val,__ret); \
491 if (__ret) for (;__i < count && (spin)->lock; __i++); \
495 #define DRM_SPINUNLOCK(spin,val) \
497 DRM_CAS_RESULT(__ret); \
498 if ((*spin).lock == val) { /* else server stole lock */ \
500 DRM_CAS(spin,val,0,__ret); \
507 /* General user-level programmer's API: unprivileged */
508 extern int drmAvailable(void);
509 extern int drmOpen(const char *name, const char *busid);
510 extern int drmClose(int fd);
511 extern drmVersionPtr drmGetVersion(int fd);
512 extern drmVersionPtr drmGetLibVersion(int fd);
513 extern void drmFreeVersion(drmVersionPtr);
514 extern int drmGetMagic(int fd, drm_magic_t * magic);
515 extern char *drmGetBusid(int fd);
516 extern int drmGetInterruptFromBusID(int fd, int busnum, int devnum,
518 extern int drmGetMap(int fd, int idx, drm_handle_t *offset,
519 drmSize *size, drmMapType *type,
520 drmMapFlags *flags, drm_handle_t *handle,
522 extern int drmGetClient(int fd, int idx, int *auth, int *pid,
523 int *uid, unsigned long *magic,
524 unsigned long *iocs);
525 extern int drmGetStats(int fd, drmStatsT *stats);
526 extern int drmSetInterfaceVersion(int fd, drmSetVersion *version);
527 extern int drmCommandNone(int fd, unsigned long drmCommandIndex);
528 extern int drmCommandRead(int fd, unsigned long drmCommandIndex,
529 void *data, unsigned long size);
530 extern int drmCommandWrite(int fd, unsigned long drmCommandIndex,
531 void *data, unsigned long size);
532 extern int drmCommandWriteRead(int fd, unsigned long drmCommandIndex,
533 void *data, unsigned long size);
535 /* General user-level programmer's API: X server (root) only */
536 extern void drmFreeBusid(const char *busid);
537 extern int drmSetBusid(int fd, const char *busid);
538 extern int drmAuthMagic(int fd, drm_magic_t magic);
539 extern int drmAddMap(int fd,
544 drm_handle_t * handle);
545 extern int drmRmMap(int fd, drm_handle_t handle);
546 extern int drmAddContextPrivateMapping(int fd, drm_context_t ctx_id,
547 drm_handle_t handle);
549 extern int drmAddBufs(int fd, int count, int size,
550 drmBufDescFlags flags,
552 extern int drmMarkBufs(int fd, double low, double high);
553 extern int drmCreateContext(int fd, drm_context_t * handle);
554 extern int drmSetContextFlags(int fd, drm_context_t context,
555 drm_context_tFlags flags);
556 extern int drmGetContextFlags(int fd, drm_context_t context,
557 drm_context_tFlagsPtr flags);
558 extern int drmAddContextTag(int fd, drm_context_t context, void *tag);
559 extern int drmDelContextTag(int fd, drm_context_t context);
560 extern void *drmGetContextTag(int fd, drm_context_t context);
561 extern drm_context_t * drmGetReservedContextList(int fd, int *count);
562 extern void drmFreeReservedContextList(drm_context_t *);
563 extern int drmSwitchToContext(int fd, drm_context_t context);
564 extern int drmDestroyContext(int fd, drm_context_t handle);
565 extern int drmCreateDrawable(int fd, drm_drawable_t * handle);
566 extern int drmDestroyDrawable(int fd, drm_drawable_t handle);
567 extern int drmUpdateDrawableInfo(int fd, drm_drawable_t handle,
568 drm_drawable_info_type_t type,
569 unsigned int num, void *data);
570 extern int drmCtlInstHandler(int fd, int irq);
571 extern int drmCtlUninstHandler(int fd);
573 /* General user-level programmer's API: authenticated client and/or X */
574 extern int drmMap(int fd,
577 drmAddressPtr address);
578 extern int drmUnmap(drmAddress address, drmSize size);
579 extern drmBufInfoPtr drmGetBufInfo(int fd);
580 extern drmBufMapPtr drmMapBufs(int fd);
581 extern int drmUnmapBufs(drmBufMapPtr bufs);
582 extern int drmDMA(int fd, drmDMAReqPtr request);
583 extern int drmFreeBufs(int fd, int count, int *list);
584 extern int drmGetLock(int fd,
585 drm_context_t context,
587 extern int drmUnlock(int fd, drm_context_t context);
588 extern int drmFinish(int fd, int context, drmLockFlags flags);
589 extern int drmGetContextPrivateMapping(int fd, drm_context_t ctx_id,
590 drm_handle_t * handle);
592 /* AGP/GART support: X server (root) only */
593 extern int drmAgpAcquire(int fd);
594 extern int drmAgpRelease(int fd);
595 extern int drmAgpEnable(int fd, unsigned long mode);
596 extern int drmAgpAlloc(int fd, unsigned long size,
597 unsigned long type, unsigned long *address,
598 drm_handle_t *handle);
599 extern int drmAgpFree(int fd, drm_handle_t handle);
600 extern int drmAgpBind(int fd, drm_handle_t handle,
601 unsigned long offset);
602 extern int drmAgpUnbind(int fd, drm_handle_t handle);
604 /* AGP/GART info: authenticated client and/or X */
605 extern int drmAgpVersionMajor(int fd);
606 extern int drmAgpVersionMinor(int fd);
607 extern unsigned long drmAgpGetMode(int fd);
608 extern unsigned long drmAgpBase(int fd); /* Physical location */
609 extern unsigned long drmAgpSize(int fd); /* Bytes */
610 extern unsigned long drmAgpMemoryUsed(int fd);
611 extern unsigned long drmAgpMemoryAvail(int fd);
612 extern unsigned int drmAgpVendorId(int fd);
613 extern unsigned int drmAgpDeviceId(int fd);
615 /* PCI scatter/gather support: X server (root) only */
616 extern int drmScatterGatherAlloc(int fd, unsigned long size,
617 drm_handle_t *handle);
618 extern int drmScatterGatherFree(int fd, drm_handle_t handle);
620 extern int drmWaitVBlank(int fd, drmVBlankPtr vbl);
622 /* Support routines */
623 extern void drmSetServerInfo(drmServerInfoPtr info);
624 extern int drmError(int err, const char *label);
625 extern void *drmMalloc(int size);
626 extern void drmFree(void *pt);
628 /* Hash table routines */
629 extern void *drmHashCreate(void);
630 extern int drmHashDestroy(void *t);
631 extern int drmHashLookup(void *t, unsigned long key, void **value);
632 extern int drmHashInsert(void *t, unsigned long key, void *value);
633 extern int drmHashDelete(void *t, unsigned long key);
634 extern int drmHashFirst(void *t, unsigned long *key, void **value);
635 extern int drmHashNext(void *t, unsigned long *key, void **value);
638 extern void *drmRandomCreate(unsigned long seed);
639 extern int drmRandomDestroy(void *state);
640 extern unsigned long drmRandom(void *state);
641 extern double drmRandomDouble(void *state);
643 /* Skip list routines */
645 extern void *drmSLCreate(void);
646 extern int drmSLDestroy(void *l);
647 extern int drmSLLookup(void *l, unsigned long key, void **value);
648 extern int drmSLInsert(void *l, unsigned long key, void *value);
649 extern int drmSLDelete(void *l, unsigned long key);
650 extern int drmSLNext(void *l, unsigned long *key, void **value);
651 extern int drmSLFirst(void *l, unsigned long *key, void **value);
652 extern void drmSLDump(void *l);
653 extern int drmSLLookupNeighbors(void *l, unsigned long key,
654 unsigned long *prev_key, void **prev_value,
655 unsigned long *next_key, void **next_value);
657 extern int drmOpenOnce(void *unused, const char *BusID, int *newlyopened);
658 extern void drmCloseOnce(int fd);