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 "drm.h"
  33
  34 /*
  35  * Note on multithreaded applications using this interface.
  36  * Libdrm is not threadsafe, so common buffer, TTM, and fence objects need to
  37  * be protected using an external mutex.
  38  *
  39  * Note: Don't protect the following functions, as it may lead to deadlocks:
  40  * drmBOUnmap(), drmFenceBuffers().
  41  * The kernel is synchronizing and refcounting buffer maps.
  42  * User space only needs to refcount object usage within the same application.
  43  */
  44
  45
  46 /*
  47  * List macros heavily inspired by the Linux kernel
  48  * list handling. No list looping yet.
  49  */
  50
  51 typedef struct _drmMMListHead
  52 {
  53     struct _drmMMListHead *prev;
  54     struct _drmMMListHead *next;
  55 } drmMMListHead;
  56
  57 #define DRMINITLISTHEAD(__item)                \
  58   do{                                          \
  59     (__item)->prev = (__item);                 \
  60     (__item)->next = (__item);                 \
  61   } while (0)
  62
  63 #define DRMLISTADD(__item, __list)                      \
  64   do {                                          \
  65     (__item)->prev = (__list);                  \
  66     (__item)->next = (__list)->next;            \
  67     (__list)->next->prev = (__item);            \
  68     (__list)->next = (__item);                  \
  69   } while (0)
  70
  71 #define DRMLISTADDTAIL(__item, __list)          \
  72   do {                                          \
  73     (__item)->next = (__list);                  \
  74     (__item)->prev = (__list)->prev;            \
  75     (__list)->prev->next = (__item);            \
  76     (__list)->prev = (__item);                  \
  77   } while(0)
  78
  79 #define DRMLISTDEL(__item)                      \
  80   do {                                          \
  81     (__item)->prev->next = (__item)->next;      \
  82     (__item)->next->prev = (__item)->prev;      \
  83   } while(0)
  84
  85 #define DRMLISTDELINIT(__item)                  \
  86   do {                                          \
  87     (__item)->prev->next = (__item)->next;      \
  88     (__item)->next->prev = (__item)->prev;      \
  89     (__item)->next = (__item);                  \
  90     (__item)->prev = (__item);                  \
  91   } while(0)
  92
  93 #define DRMLISTENTRY(__type, __item, __field)   \
  94     ((__type *)(((char *) (__item)) - offsetof(__type, __field)))
  95
  96 typedef struct _drmFence{
  97         unsigned handle;
  98         int class;
  99         unsigned type;
 100         unsigned flags;
 101         unsigned signaled;
 102 } drmFence;
 103
 104 typedef struct _drmBO{
 105     drm_bo_type_t type;
 106     unsigned handle;
 107     drm_u64_t mapHandle;
 108     unsigned flags;
 109     unsigned mask;
 110     unsigned mapFlags;
 111     unsigned long size;
 112     unsigned long offset;
 113     unsigned long start;
 114     unsigned replyFlags;
 115     unsigned fenceFlags;
 116     void *virtual;
 117     void *mapVirtual;
 118     int mapCount;
 119 } drmBO;
 120
 121
 122 typedef struct _drmBONode {
 123     drmMMListHead head;
 124     drmBO *buf;
 125     drm_bo_arg_t bo_arg;
 126     unsigned long arg0;
 127     unsigned long arg1;
 128 } drmBONode;
 129
 130 typedef struct _drmBOList {
 131     unsigned numTarget;
 132     unsigned numCurrent;
 133     unsigned numOnList;
 134     drmMMListHead list;
 135     drmMMListHead free;
 136 } drmBOList;
 137
 138 /* Fencing */
 139
 140 extern int           drmFenceCreate(int fd, unsigned flags, int class,
 141                                     unsigned type,
 142                                     drmFence *fence);
 143 extern int           drmFenceDestroy(int fd, const drmFence *fence);
 144 extern int           drmFenceReference(int fd, unsigned handle, drmFence *fence);
 145 extern int           drmFenceUnreference(int fd, const drmFence *fence);
 146 extern int           drmFenceFlush(int fd, drmFence *fence, unsigned flush_type);
 147 extern int           drmFenceSignaled(int fd, drmFence *fence,
 148                                       unsigned fenceType, int *signaled);
 149 extern int           drmFenceWait(int fd, unsigned flags, drmFence *fence,
 150                                   unsigned flush_type);
 151 extern int           drmFenceEmit(int fd, unsigned flags, drmFence *fence,
 152                                   unsigned emit_type);
 153 extern int           drmFenceBuffers(int fd, unsigned flags, drmFence *fence);
 154
 155
 156 /*
 157  * Buffer object list functions.
 158  */
 159
 160 extern void drmBOFreeList(drmBOList *list);
 161 extern int drmBOResetList(drmBOList *list);
 162 extern void *drmBOListIterator(drmBOList *list);
 163 extern void *drmBOListNext(drmBOList *list, void *iterator);
 164 extern drmBO *drmBOListBuf(void *iterator);
 165 extern int drmBOCreateList(int numTarget, drmBOList *list);
 166
 167 /*
 168  * Buffer object functions.
 169  */
 170
 171 extern int drmBOCreate(int fd, void *ttm, unsigned long start, unsigned long size,
 172                               void *user_buffer, drm_bo_type_t type, unsigned mask,
 173                 unsigned hint, drmBO *buf);
 174 extern int drmBODestroy(int fd, drmBO *buf);
 175 extern int drmBOReference(int fd, unsigned handle, drmBO *buf);
 176 extern int drmBOUnReference(int fd, drmBO *buf);
 177 extern int drmBOMap(int fd, drmBO *buf, unsigned mapFlags, unsigned mapHint,
 178                     void **address);
 179 extern int drmBOUnmap(int fd, drmBO *buf);
 180 extern int drmBOValidate(int fd, drmBO *buf, unsigned flags, unsigned mask,
 181                          unsigned hint);
 182 extern int drmBOFence(int fd, drmBO *buf, unsigned flags, unsigned fenceHandle);
 183 extern int drmBOInfo(int fd, drmBO *buf);
 184 extern int drmBOBusy(int fd, drmBO *buf, int *busy);
 185
 186
 187 extern int drmAddValidateItem(drmBOList *list, drmBO *buf, unsigned flags,
 188                        unsigned mask,
 189                        int *newItem);
 190 extern int drmBOValidateList(int fd, drmBOList *list);
 191 extern int drmBOFenceList(int fd, drmBOList *list, unsigned fenceHandle);
 192 extern int drmBOWaitIdle(int fd, drmBO *buf, unsigned hint);
 193
 194 /*
 195  * Initialization functions.
 196  */
 197
 198 extern int drmMMInit(int fd, unsigned long pOffset, unsigned long pSize,
 199                      unsigned memType);
 200 extern int drmMMTakedown(int fd, unsigned memType);
 201 extern int drmMMLock(int fd, unsigned memType);
 202 extern int drmMMUnlock(int fd, unsigned memType);
 203
 204
 205 #endif