src/gallium/drivers/i965/brw_winsys.h

   1 /**************************************************************************
   2  *
   3  * Copyright © 2009 Jakob Bornecrantz
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 #ifndef BRW_WINSYS_H
  27 #define BRW_WINSYS_H
  28
  29 #include "pipe/p_compiler.h"
  30 #include "pipe/p_error.h"
  31 #include "pipe/p_refcnt.h"
  32
  33 struct brw_winsys;
  34 struct pipe_fence_handle;
  35
  36 /* Not sure why the winsys needs this:
  37  */
  38 #define BRW_BATCH_SIZE (32*1024)
  39
  40 struct brw_winsys_screen;
  41
  42 /* Need a tiny bit of information inside the abstract buffer struct:
  43  */
  44 struct brw_winsys_buffer {
  45    struct pipe_reference reference;
  46    struct brw_winsys_screen *sws;
  47    unsigned size;
  48 };
  49
  50
  51 /* Should be possible to validate usages above against buffer creation
  52  * types, below:
  53  */
  54 enum brw_buffer_type
  55 {
  56    BRW_BUFFER_TYPE_TEXTURE,
  57    BRW_BUFFER_TYPE_SCANOUT,          /**< a texture used for scanning out from */
  58    BRW_BUFFER_TYPE_VERTEX,
  59    BRW_BUFFER_TYPE_CURBE,
  60    BRW_BUFFER_TYPE_QUERY,
  61    BRW_BUFFER_TYPE_SHADER_CONSTANTS,
  62    BRW_BUFFER_TYPE_SHADER_SCRATCH,
  63    BRW_BUFFER_TYPE_BATCH,
  64    BRW_BUFFER_TYPE_GENERAL_STATE,
  65    BRW_BUFFER_TYPE_SURFACE_STATE,
  66    BRW_BUFFER_TYPE_PIXEL,            /* image uploads, pbo's, etc */
  67    BRW_BUFFER_TYPE_GENERIC,          /* unknown */
  68    BRW_BUFFER_TYPE_MAX               /* Count of possible values */
  69 };
  70
  71
  72 /* Describe the usage of a particular buffer in a relocation.  The DRM
  73  * winsys will translate these back to GEM read/write domain flags.
  74  */
  75 enum brw_buffer_usage {
  76    BRW_USAGE_STATE,         /* INSTRUCTION, 0 */
  77    BRW_USAGE_QUERY_RESULT,  /* INSTRUCTION, INSTRUCTION */
  78    BRW_USAGE_RENDER_TARGET, /* RENDER,      0 */
  79    BRW_USAGE_DEPTH_BUFFER,  /* RENDER,      RENDER */
  80    BRW_USAGE_BLIT_SOURCE,   /* RENDER,      0 */
  81    BRW_USAGE_BLIT_DEST,     /* RENDER,      RENDER */
  82    BRW_USAGE_SAMPLER,       /* SAMPLER,     0 */
  83    BRW_USAGE_VERTEX,        /* VERTEX,      0 */
  84    BRW_USAGE_SCRATCH,       /* 0,           0 */
  85    BRW_USAGE_MAX
  86 };
  87
  88 enum brw_buffer_data_type {
  89    BRW_DATA_GS_CC_VP,
  90    BRW_DATA_GS_CC_UNIT,
  91    BRW_DATA_GS_WM_PROG,
  92    BRW_DATA_GS_SAMPLER_DEFAULT_COLOR,
  93    BRW_DATA_GS_SAMPLER,
  94    BRW_DATA_GS_WM_UNIT,
  95    BRW_DATA_GS_SF_PROG,
  96    BRW_DATA_GS_SF_VP,
  97    BRW_DATA_GS_SF_UNIT,
  98    BRW_DATA_GS_VS_UNIT,
  99    BRW_DATA_GS_VS_PROG,
 100    BRW_DATA_GS_GS_UNIT,
 101    BRW_DATA_GS_GS_PROG,
 102    BRW_DATA_GS_CLIP_VP,
 103    BRW_DATA_GS_CLIP_UNIT,
 104    BRW_DATA_GS_CLIP_PROG,
 105    BRW_DATA_SS_SURFACE,
 106    BRW_DATA_SS_SURF_BIND,
 107    BRW_DATA_CONSTANT_BUFFER,
 108    BRW_DATA_BATCH_BUFFER,
 109    BRW_DATA_OTHER,
 110    BRW_DATA_MAX
 111 };
 112
 113
 114 /* Relocations to be applied with subdata in a call to sws->bo_subdata, below.
 115  *
 116  * Effectively this encodes:
 117  *
 118  *    (unsigned *)(subdata + offset) = bo->offset + delta
 119  */
 120 struct brw_winsys_reloc {
 121    enum brw_buffer_usage usage; /* debug only */
 122    unsigned delta;
 123    unsigned offset;
 124    struct brw_winsys_buffer *bo;
 125 };
 126
 127 static INLINE void make_reloc(struct brw_winsys_reloc *reloc,
 128                               enum brw_buffer_usage usage,
 129                               unsigned delta,
 130                               unsigned offset,
 131                               struct brw_winsys_buffer *bo)
 132 {
 133    reloc->usage = usage;
 134    reloc->delta = delta;
 135    reloc->offset = offset;
 136    reloc->bo = bo;              /* Note - note taking a reference yet */
 137 }
 138
 139
 140
 141 struct brw_winsys_screen {
 142
 143
 144    /**
 145     * Buffer functions.
 146     */
 147
 148    /*@{*/
 149    /**
 150     * Create a buffer.
 151     */
 152    enum pipe_error (*bo_alloc)(struct brw_winsys_screen *sws,
 153                                enum brw_buffer_type type,
 154                                unsigned size,
 155                                unsigned alignment,
 156                                struct brw_winsys_buffer **bo_out);
 157
 158    /* Destroy a buffer when our refcount goes to zero:
 159     */
 160    void (*bo_destroy)(struct brw_winsys_buffer *buffer);
 161
 162    /* delta -- added to b2->offset, and written into buffer
 163     * offset -- location above value is written to within buffer
 164     */
 165    enum pipe_error (*bo_emit_reloc)(struct brw_winsys_buffer *buffer,
 166                                     enum brw_buffer_usage usage,
 167                                     unsigned delta,
 168                                     unsigned offset,
 169                                     struct brw_winsys_buffer *b2);
 170
 171    enum pipe_error (*bo_exec)(struct brw_winsys_buffer *buffer,
 172                               unsigned bytes_used);
 173
 174    enum pipe_error (*bo_subdata)(struct brw_winsys_buffer *buffer,
 175                                  enum brw_buffer_data_type data_type,
 176                                  size_t offset,
 177                                  size_t size,
 178                                  const void *data,
 179                                  const struct brw_winsys_reloc *reloc,
 180                                  unsigned nr_reloc );
 181
 182    boolean (*bo_is_busy)(struct brw_winsys_buffer *buffer);
 183    boolean (*bo_references)(struct brw_winsys_buffer *a,
 184                             struct brw_winsys_buffer *b);
 185
 186    /* XXX: couldn't this be handled by returning true/false on
 187     * bo_emit_reloc?
 188     */
 189    enum pipe_error (*check_aperture_space)(struct brw_winsys_screen *iws,
 190                                            struct brw_winsys_buffer **buffers,
 191                                            unsigned count);
 192
 193    /**
 194     * Map a buffer.
 195     */
 196    void *(*bo_map)(struct brw_winsys_buffer *buffer,
 197                    enum brw_buffer_data_type data_type,
 198                    unsigned offset,
 199                    unsigned length,
 200                    boolean write,
 201                    boolean discard,
 202                    boolean flush_explicit);
 203
 204    void (*bo_flush_range)(struct brw_winsys_buffer *buffer,
 205                           unsigned offset,
 206                           unsigned length);
 207
 208    /**
 209     * Unmap a buffer.
 210     */
 211    void (*bo_unmap)(struct brw_winsys_buffer *buffer);
 212    /*@}*/
 213
 214
 215    /* Wait for buffer to go idle.  Similar to map+unmap, but doesn't
 216     * mark buffer contents as dirty.
 217     */
 218    void (*bo_wait_idle)(struct brw_winsys_buffer *buffer);
 219
 220    /**
 221     * Destroy the winsys.
 222     */
 223    void (*destroy)(struct brw_winsys_screen *iws);
 224 };
 225
 226 static INLINE void *
 227 bo_map_read(struct brw_winsys_screen *sws, struct brw_winsys_buffer *buf)
 228 {
 229    return sws->bo_map( buf,
 230                        BRW_DATA_OTHER,
 231                        0, buf->size,
 232                        FALSE, FALSE, FALSE );
 233 }
 234
 235 static INLINE void
 236 bo_reference(struct brw_winsys_buffer **ptr, struct brw_winsys_buffer *buf)
 237 {
 238    struct brw_winsys_buffer *old_buf = *ptr;
 239
 240    if (pipe_reference((struct pipe_reference **)ptr, &buf->reference))
 241       old_buf->sws->bo_destroy(old_buf);
 242 }
 243
 244
 245 /**
 246  * Create brw pipe_screen.
 247  */
 248 struct pipe_screen *brw_create_screen(struct brw_winsys_screen *iws, unsigned pci_id);
 249
 250 /**
 251  * Create a brw pipe_context.
 252  */
 253 struct pipe_context *brw_create_context(struct pipe_screen *screen);
 254
 255 /**
 256  * Get the brw_winsys buffer backing the texture.
 257  *
 258  * TODO UGLY
 259  */
 260 struct pipe_texture;
 261 boolean brw_texture_get_winsys_buffer(struct pipe_texture *texture,
 262                                       struct brw_winsys_buffer **buffer,
 263                                       unsigned *stride);
 264
 265 /**
 266  * Wrap a brw_winsys buffer with a texture blanket.
 267  *
 268  * TODO UGLY
 269  */
 270 struct pipe_texture *
 271 brw_texture_blanket_winsys_buffer(struct pipe_screen *screen,
 272                                   const struct pipe_texture *template,
 273                                   const unsigned pitch,
 274                                   struct brw_winsys_buffer *buffer);
 275
 276
 277
 278
 279 #endif