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
  97
  98 typedef struct _drmBO{
  99     drm_bo_type_t type;
 100     unsigned handle;
 101     drm_handle_t mapHandle;
 102     unsigned flags;
 103     unsigned mask;
 104     unsigned mapFlags;
 105     unsigned long size;
 106     unsigned long offset;
 107     unsigned long start;
 108     unsigned replyFlags;
 109     unsigned fenceFlags;
 110     void *virtual;
 111     void *mapVirtual;
 112     int mapCount;
 113     drmTTM *ttm;
 114 } drmBO;
 115
 116
 117 typedef struct _drmBONode {
 118     drmMMListHead head;
 119     drmBO *buf;
 120     drm_bo_arg_t bo_arg;
 121     unsigned long arg0;
 122     unsigned long arg1;
 123 } drmBONode;
 124
 125 typedef struct _drmBOList {
 126     unsigned numTarget;
 127     unsigned numCurrent;
 128     unsigned numOnList;
 129     drmMMListHead list;
 130     drmMMListHead free;
 131 } drmBOList;
 132
 133
 134 /*
 135  * TTM functions.
 136  */
 137
 138 extern int drmTTMCreate(int fd, drmTTM *ttm, unsigned long size,
 139                         unsigned flags);
 140 extern int drmTTMDestroy(int fd, const drmTTM *ttm);
 141 extern int drmTTMReference(int fd, unsigned handle, drmTTM *ttm);
 142 extern int drmTTMUnreference(int fd, const drmTTM *ttm);
 143 extern drm_handle_t drmTTMMapHandle(int fd, const drmTTM *ttm);
 144
 145 /*
 146  * Buffer object list functions.
 147  */
 148
 149 extern void drmBOFreeList(drmBOList *list);
 150 extern int drmBOResetList(drmBOList *list);
 151 extern void *drmBOListIterator(drmBOList *list);
 152 extern void *drmBOListNext(drmBOList *list, void *iterator);
 153 extern drmBO *drmBOListBuf(void *iterator);
 154 extern int drmBOCreateList(int numTarget, drmBOList *list);
 155
 156 /*
 157  * Buffer object functions.
 158  */
 159
 160 extern int drmBOCreate(int fd, drmTTM *ttm, unsigned long start, unsigned long size,
 161                               void *user_buffer, drm_bo_type_t type, unsigned mask,
 162                 unsigned hint, drmBO *buf);
 163 extern int drmBODestroy(int fd, drmBO *buf);
 164 extern int drmBOReference(int fd, unsigned handle, drmBO *buf);
 165 extern int drmBOUnReference(int fd, drmBO *buf);
 166 extern int drmBOMap(int fd, drmBO *buf, unsigned mapFlags, unsigned mapHint,
 167                     void **address);
 168 extern int drmBOUnmap(int fd, drmBO *buf);
 169 extern int drmBOValidate(int fd, drmBO *buf, unsigned flags, unsigned mask,
 170                          unsigned hint);
 171 extern int drmBOFence(int fd, drmBO *buf, unsigned flags, unsigned fenceHandle);
 172 extern int drmBOInfo(int fd, drmBO *buf);
 173 extern int drmBufBusy(int fd, drmBO *buf, int *busy);
 174
 175
 176 extern int drmAddValidateItem(drmBOList *list, drmBO *buf, unsigned flags,
 177                        unsigned mask,
 178                        int *newItem);
 179 extern int drmBOValidateList(int fd, drmBOList *list);
 180 extern int drmBOFenceList(int fd, drmBOList *list, unsigned fenceHandle);
 181
 182
 183 /*
 184  * Initialization functions.
 185  */
 186
 187 extern int drmMMInit(int fd, unsigned long vramPOffset, unsigned long vramPSize,
 188                      unsigned long ttPOffset, unsigned long ttPSize,
 189                      unsigned long max_locked_size);
 190 extern int drmMMTakedown(int fd);
 191
 192
 193 #endif