xf86drm.h

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