libdrm/xf86mm.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND. USA.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  18  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  *
  27  **************************************************************************/
  28
  29 #ifndef _XF86MM_H_
  30 #define _XF86MM_H_
  31 #include <stddef.h>
  32 #include <stdint.h>
  33 #include "drm.h"
  34
  35 /*
  36  * Note on multithreaded applications using this interface.
  37  * Libdrm is not threadsafe, so common buffer, TTM, and fence objects need to
  38  * be protected using an external mutex.
  39  *
  40  * Note: Don't protect the following functions, as it may lead to deadlocks:
  41  * drmBOUnmap().
  42  * The kernel is synchronizing and refcounting buffer maps.
  43  * User space only needs to refcount object usage within the same application.
  44  */
  45
  46
  47 /*
  48  * List macros heavily inspired by the Linux kernel
  49  * list handling. No list looping yet.
  50  */
  51
  52 typedef struct _drmMMListHead
  53 {
  54     struct _drmMMListHead *prev;
  55     struct _drmMMListHead *next;
  56 } drmMMListHead;
  57
  58 #define DRMINITLISTHEAD(__item)                \
  59   do{                                          \
  60     (__item)->prev = (__item);                 \
  61     (__item)->next = (__item);                 \
  62   } while (0)
  63
  64 #define DRMLISTADD(__item, __list)              \
  65   do {                                          \
  66     (__item)->prev = (__list);                  \
  67     (__item)->next = (__list)->next;            \
  68     (__list)->next->prev = (__item);            \
  69     (__list)->next = (__item);                  \
  70   } while (0)
  71
  72 #define DRMLISTADDTAIL(__item, __list)          \
  73   do {                                          \
  74     (__item)->next = (__list);                  \
  75     (__item)->prev = (__list)->prev;            \
  76     (__list)->prev->next = (__item);            \
  77     (__list)->prev = (__item);                  \
  78   } while(0)
  79
  80 #define DRMLISTDEL(__item)                      \
  81   do {                                          \
  82     (__item)->prev->next = (__item)->next;      \
  83     (__item)->next->prev = (__item)->prev;      \
  84   } while(0)
  85
  86 #define DRMLISTDELINIT(__item)                  \
  87   do {                                          \
  88     (__item)->prev->next = (__item)->next;      \
  89     (__item)->next->prev = (__item)->prev;      \
  90     (__item)->next = (__item);                  \
  91     (__item)->prev = (__item);                  \
  92   } while(0)
  93
  94 #define DRMLISTENTRY(__type, __item, __field)   \
  95     ((__type *)(((char *) (__item)) - offsetof(__type, __field)))
  96
  97 typedef struct _drmFence
  98 {
  99     unsigned handle;
 100     int fence_class;
 101     unsigned type;
 102     unsigned flags;
 103     unsigned signaled;
 104     uint32_t sequence;
 105     unsigned pad[4]; /* for future expansion */
 106 } drmFence;
 107
 108 typedef struct _drmBO
 109 {
 110     unsigned handle;
 111     uint64_t mapHandle;
 112     uint64_t flags;
 113     uint64_t proposedFlags;
 114     unsigned mapFlags;
 115     unsigned long size;
 116     unsigned long offset;
 117     unsigned long start;
 118     unsigned replyFlags;
 119     unsigned fenceFlags;
 120     unsigned pageAlignment;
 121     unsigned tileInfo;
 122     unsigned hwTileStride;
 123     unsigned desiredTileStride;
 124     void *virtual;
 125     void *mapVirtual;
 126     int mapCount;
 127     unsigned pad[8];     /* for future expansion */
 128 } drmBO;
 129
 130 /*
 131  * Fence functions.
 132  */
 133
 134 extern int drmFenceCreate(int fd, unsigned flags, int fence_class,
 135                           unsigned type, drmFence *fence);
 136 extern int drmFenceReference(int fd, unsigned handle, drmFence *fence);
 137 extern int drmFenceUnreference(int fd, const drmFence *fence);
 138 extern int drmFenceFlush(int fd, drmFence *fence, unsigned flush_type);
 139 extern int drmFenceSignaled(int fd, drmFence *fence,
 140                             unsigned fenceType, int *signaled);
 141 extern int drmFenceWait(int fd, unsigned flags, drmFence *fence,
 142                         unsigned flush_type);
 143 extern int drmFenceEmit(int fd, unsigned flags, drmFence *fence,
 144                         unsigned emit_type);
 145 extern int drmFenceBuffers(int fd, unsigned flags, uint32_t fence_class, drmFence *fence);
 146
 147
 148 /*
 149  * Buffer object functions.
 150  */
 151
 152 extern int drmBOCreate(int fd, unsigned long size,
 153                        unsigned pageAlignment, void *user_buffer,
 154                        uint64_t mask, unsigned hint, drmBO *buf);
 155 extern int drmBOReference(int fd, unsigned handle, drmBO *buf);
 156 extern int drmBOUnreference(int fd, drmBO *buf);
 157 extern int drmBOMap(int fd, drmBO *buf, unsigned mapFlags, unsigned mapHint,
 158                     void **address);
 159 extern int drmBOUnmap(int fd, drmBO *buf);
 160 extern int drmBOFence(int fd, drmBO *buf, unsigned flags, unsigned fenceHandle);
 161 extern int drmBOInfo(int fd, drmBO *buf);
 162 extern int drmBOBusy(int fd, drmBO *buf, int *busy);
 163
 164 extern int drmBOWaitIdle(int fd, drmBO *buf, unsigned hint);
 165
 166 /*
 167  * Initialization functions.
 168  */
 169
 170 extern int drmMMInit(int fd, unsigned long pOffset, unsigned long pSize,
 171                      unsigned memType);
 172 extern int drmMMTakedown(int fd, unsigned memType);
 173 extern int drmMMLock(int fd, unsigned memType, int lockBM, int ignoreNoEvict);
 174 extern int drmMMUnlock(int fd, unsigned memType, int unlockBM);
 175 extern int drmMMInfo(int fd, unsigned memType, uint64_t *size);
 176 extern int drmBOSetStatus(int fd, drmBO *buf,
 177                           uint64_t flags, uint64_t mask,
 178                           unsigned int hint,
 179                           unsigned int desired_tile_stride,
 180                           unsigned int tile_info);
 181 extern int drmBOVersion(int fd, unsigned int *major,
 182                         unsigned int *minor,
 183                         unsigned int *patchlevel);
 184
 185
 186 #endif