intel/intel_bufmgr.h

   1 /*
   2  * Copyright © 2008 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 /**
  29  * @file intel_bufmgr.h
  30  *
  31  * Public definitions of Intel-specific bufmgr functions.
  32  */
  33
  34 #ifndef INTEL_BUFMGR_H
  35 #define INTEL_BUFMGR_H
  36
  37 #include <stdio.h>
  38 #include <stdint.h>
  39 #include <stdio.h>
  40
  41 struct drm_clip_rect;
  42
  43 typedef struct _drm_intel_bufmgr drm_intel_bufmgr;
  44 typedef struct _drm_intel_bo drm_intel_bo;
  45
  46 struct _drm_intel_bo {
  47         /**
  48          * Size in bytes of the buffer object.
  49          *
  50          * The size may be larger than the size originally requested for the
  51          * allocation, such as being aligned to page size.
  52          */
  53         unsigned long size;
  54
  55         /**
  56          * Alignment requirement for object
  57          *
  58          * Used for GTT mapping & pinning the object.
  59          */
  60         unsigned long align;
  61
  62         /**
  63          * Last seen card virtual address (offset from the beginning of the
  64          * aperture) for the object.  This should be used to fill relocation
  65          * entries when calling drm_intel_bo_emit_reloc()
  66          */
  67         unsigned long offset;
  68
  69         /**
  70          * Virtual address for accessing the buffer data.  Only valid while
  71          * mapped.
  72          */
  73 #ifdef __cplusplus
  74         void *virt;
  75 #else
  76         void *virtual;
  77 #endif
  78
  79         /** Buffer manager context associated with this buffer object */
  80         drm_intel_bufmgr *bufmgr;
  81
  82         /**
  83          * MM-specific handle for accessing object
  84          */
  85         int handle;
  86 };
  87
  88 enum aub_dump_bmp_format {
  89         AUB_DUMP_BMP_FORMAT_8BIT = 1,
  90         AUB_DUMP_BMP_FORMAT_ARGB_4444 = 4,
  91         AUB_DUMP_BMP_FORMAT_ARGB_0888 = 6,
  92         AUB_DUMP_BMP_FORMAT_ARGB_8888 = 7,
  93 };
  94
  95 #define BO_ALLOC_FOR_RENDER (1<<0)
  96
  97 drm_intel_bo *drm_intel_bo_alloc(drm_intel_bufmgr *bufmgr, const char *name,
  98                                  unsigned long size, unsigned int alignment);
  99 drm_intel_bo *drm_intel_bo_alloc_for_render(drm_intel_bufmgr *bufmgr,
 100                                             const char *name,
 101                                             unsigned long size,
 102                                             unsigned int alignment);
 103 drm_intel_bo *drm_intel_bo_alloc_tiled(drm_intel_bufmgr *bufmgr,
 104                                        const char *name,
 105                                        int x, int y, int cpp,
 106                                        uint32_t *tiling_mode,
 107                                        unsigned long *pitch,
 108                                        unsigned long flags);
 109 void drm_intel_bo_reference(drm_intel_bo *bo);
 110 void drm_intel_bo_unreference(drm_intel_bo *bo);
 111 int drm_intel_bo_map(drm_intel_bo *bo, int write_enable);
 112 int drm_intel_bo_unmap(drm_intel_bo *bo);
 113
 114 int drm_intel_bo_subdata(drm_intel_bo *bo, unsigned long offset,
 115                          unsigned long size, const void *data);
 116 int drm_intel_bo_get_subdata(drm_intel_bo *bo, unsigned long offset,
 117                              unsigned long size, void *data);
 118 void drm_intel_bo_wait_rendering(drm_intel_bo *bo);
 119
 120 void drm_intel_bufmgr_set_debug(drm_intel_bufmgr *bufmgr, int enable_debug);
 121 void drm_intel_bufmgr_destroy(drm_intel_bufmgr *bufmgr);
 122 int drm_intel_bo_exec(drm_intel_bo *bo, int used,
 123                       struct drm_clip_rect *cliprects, int num_cliprects, int DR4);
 124 int drm_intel_bo_mrb_exec(drm_intel_bo *bo, int used,
 125                         struct drm_clip_rect *cliprects, int num_cliprects, int DR4,
 126                         unsigned int flags);
 127 int drm_intel_bufmgr_check_aperture_space(drm_intel_bo ** bo_array, int count);
 128
 129 int drm_intel_bo_emit_reloc(drm_intel_bo *bo, uint32_t offset,
 130                             drm_intel_bo *target_bo, uint32_t target_offset,
 131                             uint32_t read_domains, uint32_t write_domain);
 132 int drm_intel_bo_emit_reloc_fence(drm_intel_bo *bo, uint32_t offset,
 133                                   drm_intel_bo *target_bo,
 134                                   uint32_t target_offset,
 135                                   uint32_t read_domains, uint32_t write_domain);
 136 int drm_intel_bo_pin(drm_intel_bo *bo, uint32_t alignment);
 137 int drm_intel_bo_unpin(drm_intel_bo *bo);
 138 int drm_intel_bo_set_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
 139                             uint32_t stride);
 140 int drm_intel_bo_get_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
 141                             uint32_t * swizzle_mode);
 142 int drm_intel_bo_flink(drm_intel_bo *bo, uint32_t * name);
 143 int drm_intel_bo_busy(drm_intel_bo *bo);
 144 int drm_intel_bo_madvise(drm_intel_bo *bo, int madv);
 145
 146 int drm_intel_bo_disable_reuse(drm_intel_bo *bo);
 147 int drm_intel_bo_is_reusable(drm_intel_bo *bo);
 148 int drm_intel_bo_references(drm_intel_bo *bo, drm_intel_bo *target_bo);
 149
 150 /* drm_intel_bufmgr_gem.c */
 151 drm_intel_bufmgr *drm_intel_bufmgr_gem_init(int fd, int batch_size);
 152 drm_intel_bo *drm_intel_bo_gem_create_from_name(drm_intel_bufmgr *bufmgr,
 153                                                 const char *name,
 154                                                 unsigned int handle);
 155 void drm_intel_bufmgr_gem_enable_reuse(drm_intel_bufmgr *bufmgr);
 156 void drm_intel_bufmgr_gem_enable_fenced_relocs(drm_intel_bufmgr *bufmgr);
 157 void drm_intel_bufmgr_gem_set_vma_cache_size(drm_intel_bufmgr *bufmgr,
 158                                              int limit);
 159 int drm_intel_gem_bo_map_gtt(drm_intel_bo *bo);
 160 int drm_intel_gem_bo_unmap_gtt(drm_intel_bo *bo);
 161 int drm_intel_gem_bo_get_reloc_count(drm_intel_bo *bo);
 162 void drm_intel_gem_bo_clear_relocs(drm_intel_bo *bo, int start);
 163 void drm_intel_gem_bo_start_gtt_access(drm_intel_bo *bo, int write_enable);
 164
 165 void drm_intel_bufmgr_gem_set_aub_dump(drm_intel_bufmgr *bufmgr, int enable);
 166 void drm_intel_gem_bo_aub_dump_bmp(drm_intel_bo *bo,
 167                                    int x1, int y1, int width, int height,
 168                                    enum aub_dump_bmp_format format,
 169                                    int pitch, int offset);
 170
 171 int drm_intel_get_pipe_from_crtc_id(drm_intel_bufmgr *bufmgr, int crtc_id);
 172
 173 int drm_intel_get_aperture_sizes(int fd, size_t *mappable, size_t *total);
 174 int drm_intel_bufmgr_gem_get_devid(drm_intel_bufmgr *bufmgr);
 175
 176 /* drm_intel_bufmgr_fake.c */
 177 drm_intel_bufmgr *drm_intel_bufmgr_fake_init(int fd,
 178                                              unsigned long low_offset,
 179                                              void *low_virtual,
 180                                              unsigned long size,
 181                                              volatile unsigned int
 182                                              *last_dispatch);
 183 void drm_intel_bufmgr_fake_set_last_dispatch(drm_intel_bufmgr *bufmgr,
 184                                              volatile unsigned int
 185                                              *last_dispatch);
 186 void drm_intel_bufmgr_fake_set_exec_callback(drm_intel_bufmgr *bufmgr,
 187                                              int (*exec) (drm_intel_bo *bo,
 188                                                           unsigned int used,
 189                                                           void *priv),
 190                                              void *priv);
 191 void drm_intel_bufmgr_fake_set_fence_callback(drm_intel_bufmgr *bufmgr,
 192                                               unsigned int (*emit) (void *priv),
 193                                               void (*wait) (unsigned int fence,
 194                                                             void *priv),
 195                                               void *priv);
 196 drm_intel_bo *drm_intel_bo_fake_alloc_static(drm_intel_bufmgr *bufmgr,
 197                                              const char *name,
 198                                              unsigned long offset,
 199                                              unsigned long size, void *virt);
 200 void drm_intel_bo_fake_disable_backing_store(drm_intel_bo *bo,
 201                                              void (*invalidate_cb) (drm_intel_bo
 202                                                                     * bo,
 203                                                                     void *ptr),
 204                                              void *ptr);
 205
 206 void drm_intel_bufmgr_fake_contended_lock_take(drm_intel_bufmgr *bufmgr);
 207 void drm_intel_bufmgr_fake_evict_all(drm_intel_bufmgr *bufmgr);
 208
 209 struct drm_intel_decode *drm_intel_decode_context_alloc(uint32_t devid);
 210 void drm_intel_decode_context_free(struct drm_intel_decode *ctx);
 211 void drm_intel_decode_set_batch_pointer(struct drm_intel_decode *ctx,
 212                                         void *data, uint32_t hw_offset,
 213                                         int count);
 214 void drm_intel_decode_set_dump_past_end(struct drm_intel_decode *ctx,
 215                                         int dump_past_end);
 216 void drm_intel_decode_set_head_tail(struct drm_intel_decode *ctx,
 217                                     uint32_t head, uint32_t tail);
 218 void drm_intel_decode_set_output_file(struct drm_intel_decode *ctx, FILE *out);
 219 void drm_intel_decode(struct drm_intel_decode *ctx);
 220
 221
 222 /** @{ Compatibility defines to keep old code building despite the symbol rename
 223  * from dri_* to drm_intel_*
 224  */
 225 #define dri_bo drm_intel_bo
 226 #define dri_bufmgr drm_intel_bufmgr
 227 #define dri_bo_alloc drm_intel_bo_alloc
 228 #define dri_bo_reference drm_intel_bo_reference
 229 #define dri_bo_unreference drm_intel_bo_unreference
 230 #define dri_bo_map drm_intel_bo_map
 231 #define dri_bo_unmap drm_intel_bo_unmap
 232 #define dri_bo_subdata drm_intel_bo_subdata
 233 #define dri_bo_get_subdata drm_intel_bo_get_subdata
 234 #define dri_bo_wait_rendering drm_intel_bo_wait_rendering
 235 #define dri_bufmgr_set_debug drm_intel_bufmgr_set_debug
 236 #define dri_bufmgr_destroy drm_intel_bufmgr_destroy
 237 #define dri_bo_exec drm_intel_bo_exec
 238 #define dri_bufmgr_check_aperture_space drm_intel_bufmgr_check_aperture_space
 239 #define dri_bo_emit_reloc(reloc_bo, read, write, target_offset,         \
 240                           reloc_offset, target_bo)                      \
 241         drm_intel_bo_emit_reloc(reloc_bo, reloc_offset,                 \
 242                                 target_bo, target_offset,               \
 243                                 read, write);
 244 #define dri_bo_pin drm_intel_bo_pin
 245 #define dri_bo_unpin drm_intel_bo_unpin
 246 #define dri_bo_get_tiling drm_intel_bo_get_tiling
 247 #define dri_bo_set_tiling(bo, mode) drm_intel_bo_set_tiling(bo, mode, 0)
 248 #define dri_bo_flink drm_intel_bo_flink
 249 #define intel_bufmgr_gem_init drm_intel_bufmgr_gem_init
 250 #define intel_bo_gem_create_from_name drm_intel_bo_gem_create_from_name
 251 #define intel_bufmgr_gem_enable_reuse drm_intel_bufmgr_gem_enable_reuse
 252 #define intel_bufmgr_fake_init drm_intel_bufmgr_fake_init
 253 #define intel_bufmgr_fake_set_last_dispatch drm_intel_bufmgr_fake_set_last_dispatch
 254 #define intel_bufmgr_fake_set_exec_callback drm_intel_bufmgr_fake_set_exec_callback
 255 #define intel_bufmgr_fake_set_fence_callback drm_intel_bufmgr_fake_set_fence_callback
 256 #define intel_bo_fake_alloc_static drm_intel_bo_fake_alloc_static
 257 #define intel_bo_fake_disable_backing_store drm_intel_bo_fake_disable_backing_store
 258 #define intel_bufmgr_fake_contended_lock_take drm_intel_bufmgr_fake_contended_lock_take
 259 #define intel_bufmgr_fake_evict_all drm_intel_bufmgr_fake_evict_all
 260
 261 /** @{ */
 262
 263 #endif /* INTEL_BUFMGR_H */