src/mesa/drivers/dri/i965/intel_mipmap_tree.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 VMware, Inc.
   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 above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /** @file intel_mipmap_tree.h
  29  *
  30  * This file defines the structure that wraps a BO and describes how the
  31  * mipmap levels and slices of a texture are laid out.
  32  *
  33  * The hardware has a fixed layout of a texture depending on parameters such
  34  * as the target/type (2D, 3D, CUBE), width, height, pitch, and number of
  35  * mipmap levels.  The individual level/layer slices are each 2D rectangles of
  36  * pixels at some x/y offset from the start of the drm_intel_bo.
  37  *
  38  * Original OpenGL allowed texture miplevels to be specified in arbitrary
  39  * order, and a texture may change size over time.  Thus, each
  40  * intel_texture_image has a reference to a miptree that contains the pixel
  41  * data sized appropriately for it, which will later be referenced by/copied
  42  * to the intel_texture_object at draw time (intel_finalize_mipmap_tree()) so
  43  * that there's a single miptree for the complete texture.
  44  */
  45
  46 #ifndef INTEL_MIPMAP_TREE_H
  47 #define INTEL_MIPMAP_TREE_H
  48
  49 #include <assert.h>
  50
  51 #include "main/mtypes.h"
  52 #include "intel_bufmgr.h"
  53 #include "intel_resolve_map.h"
  54 #include <GL/internal/dri_interface.h>
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60 struct brw_context;
  61 struct intel_renderbuffer;
  62
  63 struct intel_resolve_map;
  64 struct intel_texture_image;
  65
  66 /**
  67  * When calling intel_miptree_map() on an ETC-transcoded-to-RGB miptree or a
  68  * depthstencil-split-to-separate-stencil miptree, we'll normally make a
  69  * tmeporary and recreate the kind of data requested by Mesa core, since we're
  70  * satisfying some glGetTexImage() request or something.
  71  *
  72  * However, occasionally you want to actually map the miptree's current data
  73  * without transcoding back.  This flag to intel_miptree_map() gets you that.
  74  */
  75 #define BRW_MAP_DIRECT_BIT      0x80000000
  76
  77 struct intel_miptree_map {
  78    /** Bitfield of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT, GL_MAP_INVALIDATE_BIT */
  79    GLbitfield mode;
  80    /** Region of interest for the map. */
  81    int x, y, w, h;
  82    /** Possibly malloced temporary buffer for the mapping. */
  83    void *buffer;
  84    /** Possible pointer to a temporary linear miptree for the mapping. */
  85    struct intel_mipmap_tree *mt;
  86    /** Pointer to the start of (map_x, map_y) returned by the mapping. */
  87    void *ptr;
  88    /** Stride of the mapping. */
  89    int stride;
  90 };
  91
  92 /**
  93  * Describes the location of each texture image within a miptree.
  94  */
  95 struct intel_mipmap_level
  96 {
  97    /** Offset to this miptree level, used in computing x_offset. */
  98    GLuint level_x;
  99    /** Offset to this miptree level, used in computing y_offset. */
 100    GLuint level_y;
 101
 102    /**
 103     * \brief Number of 2D slices in this miplevel.
 104     *
 105     * The exact semantics of depth varies according to the texture target:
 106     *    - For GL_TEXTURE_CUBE_MAP, depth is 6.
 107     *    - For GL_TEXTURE_2D_ARRAY, depth is the number of array slices. It is
 108     *      identical for all miplevels in the texture.
 109     *    - For GL_TEXTURE_3D, it is the texture's depth at this miplevel. Its
 110     *      value, like width and height, varies with miplevel.
 111     *    - For other texture types, depth is 1.
 112     *    - Additionally, for UMS and CMS miptrees, depth is multiplied by
 113     *      sample count.
 114     */
 115    GLuint depth;
 116
 117    /**
 118     * \brief Is HiZ enabled for this level?
 119     *
 120     * If \c mt->level[l].has_hiz is set, then (1) \c mt->hiz_mt has been
 121     * allocated and (2) the HiZ memory for the slices in this level reside at
 122     * \c mt->hiz_mt->level[l].
 123     */
 124    bool has_hiz;
 125
 126    /**
 127     * \brief List of 2D images in this mipmap level.
 128     *
 129     * This may be a list of cube faces, array slices in 2D array texture, or
 130     * layers in a 3D texture. The list's length is \c depth.
 131     */
 132    struct intel_mipmap_slice {
 133       /**
 134        * \name Offset to slice
 135        * \{
 136        *
 137        * Hardware formats are so diverse that that there is no unified way to
 138        * compute the slice offsets, so we store them in this table.
 139        *
 140        * The (x, y) offset to slice \c s at level \c l relative the miptrees
 141        * base address is
 142        * \code
 143        *     x = mt->level[l].slice[s].x_offset
 144        *     y = mt->level[l].slice[s].y_offset
 145        */
 146       GLuint x_offset;
 147       GLuint y_offset;
 148       /** \} */
 149
 150       /**
 151        * Mapping information. Persistent for the duration of
 152        * intel_miptree_map/unmap on this slice.
 153        */
 154       struct intel_miptree_map *map;
 155    } *slice;
 156 };
 157
 158 /**
 159  * Enum for keeping track of the different MSAA layouts supported by Gen7.
 160  */
 161 enum intel_msaa_layout
 162 {
 163    /**
 164     * Ordinary surface with no MSAA.
 165     */
 166    INTEL_MSAA_LAYOUT_NONE,
 167
 168    /**
 169     * Interleaved Multisample Surface.  The additional samples are
 170     * accommodated by scaling up the width and the height of the surface so
 171     * that all the samples corresponding to a pixel are located at nearby
 172     * memory locations.
 173     */
 174    INTEL_MSAA_LAYOUT_IMS,
 175
 176    /**
 177     * Uncompressed Multisample Surface.  The surface is stored as a 2D array,
 178     * with array slice n containing all pixel data for sample n.
 179     */
 180    INTEL_MSAA_LAYOUT_UMS,
 181
 182    /**
 183     * Compressed Multisample Surface.  The surface is stored as in
 184     * INTEL_MSAA_LAYOUT_UMS, but there is an additional buffer called the MCS
 185     * (Multisample Control Surface) buffer.  Each pixel in the MCS buffer
 186     * indicates the mapping from sample number to array slice.  This allows
 187     * the common case (where all samples constituting a pixel have the same
 188     * color value) to be stored efficiently by just using a single array
 189     * slice.
 190     */
 191    INTEL_MSAA_LAYOUT_CMS,
 192 };
 193
 194
 195 /**
 196  * Enum for keeping track of the fast clear state of a buffer associated with
 197  * a miptree.
 198  *
 199  * Fast clear works by deferring the memory writes that would be used to clear
 200  * the buffer, so that instead of performing them at the time of the clear
 201  * operation, the hardware automatically performs them at the time that the
 202  * buffer is later accessed for rendering.  The MCS buffer keeps track of
 203  * which regions of the buffer still have pending clear writes.
 204  *
 205  * This enum keeps track of the driver's knowledge of pending fast clears in
 206  * the MCS buffer.
 207  *
 208  * MCS buffers only exist on Gen7+.
 209  */
 210 enum intel_fast_clear_state
 211 {
 212    /**
 213     * There is no MCS buffer for this miptree, and one should never be
 214     * allocated.
 215     */
 216    INTEL_FAST_CLEAR_STATE_NO_MCS,
 217
 218    /**
 219     * No deferred clears are pending for this miptree, and the contents of the
 220     * color buffer are entirely correct.  An MCS buffer may or may not exist
 221     * for this miptree.  If it does exist, it is entirely in the "no deferred
 222     * clears pending" state.  If it does not exist, it will be created the
 223     * first time a fast color clear is executed.
 224     *
 225     * In this state, the color buffer can be used for purposes other than
 226     * rendering without needing a render target resolve.
 227     *
 228     * Since there is no such thing as a "fast color clear resolve" for MSAA
 229     * buffers, an MSAA buffer will never be in this state.
 230     */
 231    INTEL_FAST_CLEAR_STATE_RESOLVED,
 232
 233    /**
 234     * An MCS buffer exists for this miptree, and deferred clears are pending
 235     * for some regions of the color buffer, as indicated by the MCS buffer.
 236     * The contents of the color buffer are only correct for the regions where
 237     * the MCS buffer doesn't indicate a deferred clear.
 238     *
 239     * If a single-sample buffer is in this state, a render target resolve must
 240     * be performed before it can be used for purposes other than rendering.
 241     */
 242    INTEL_FAST_CLEAR_STATE_UNRESOLVED,
 243
 244    /**
 245     * An MCS buffer exists for this miptree, and deferred clears are pending
 246     * for the entire color buffer, and the contents of the MCS buffer reflect
 247     * this.  The contents of the color buffer are undefined.
 248     *
 249     * If a single-sample buffer is in this state, a render target resolve must
 250     * be performed before it can be used for purposes other than rendering.
 251     *
 252     * If the client attempts to clear a buffer which is already in this state,
 253     * the clear can be safely skipped, since the buffer is already clear.
 254     */
 255    INTEL_FAST_CLEAR_STATE_CLEAR,
 256 };
 257
 258 enum miptree_array_layout {
 259    /* Each array slice contains all miplevels packed together.
 260     *
 261     * Gen hardware usually wants multilevel miptrees configured this way.
 262     *
 263     * A 2D Array texture with 2 slices and multiple LODs using
 264     * ALL_LOD_IN_EACH_SLICE would look somewhat like this:
 265     *
 266     *   +----------+
 267     *   |          |
 268     *   |          |
 269     *   +----------+
 270     *   +---+ +-+
 271     *   |   | +-+
 272     *   +---+ *
 273     *   +----------+
 274     *   |          |
 275     *   |          |
 276     *   +----------+
 277     *   +---+ +-+
 278     *   |   | +-+
 279     *   +---+ *
 280     */
 281    ALL_LOD_IN_EACH_SLICE,
 282
 283    /* Each LOD contains all slices of that LOD packed together.
 284     *
 285     * In some situations, Gen7+ hardware can use the array_spacing_lod0
 286     * feature to save space when the surface only contains LOD 0.
 287     *
 288     * Gen6 uses this for separate stencil and hiz since gen6 does not support
 289     * multiple LODs for separate stencil and hiz.
 290     *
 291     * A 2D Array texture with 2 slices and multiple LODs using
 292     * ALL_SLICES_AT_EACH_LOD would look somewhat like this:
 293     *
 294     *   +----------+
 295     *   |          |
 296     *   |          |
 297     *   +----------+
 298     *   |          |
 299     *   |          |
 300     *   +----------+
 301     *   +---+ +-+
 302     *   |   | +-+
 303     *   +---+ +-+
 304     *   |   | :
 305     *   +---+
 306     */
 307    ALL_SLICES_AT_EACH_LOD,
 308 };
 309
 310 /**
 311  * Miptree aux buffer. These buffers are associated with a miptree, but the
 312  * format is managed by the hardware.
 313  *
 314  * For Gen7+, we always give the hardware the start of the buffer, and let it
 315  * handle all accesses to the buffer. Therefore we don't need the full miptree
 316  * layout structure for this buffer.
 317  *
 318  * For Gen6, we need a hiz miptree structure for this buffer so we can program
 319  * offsets to slices & miplevels.
 320  */
 321 struct intel_miptree_aux_buffer
 322 {
 323    /** Buffer object containing the pixel data. */
 324    drm_intel_bo *bo;
 325
 326    uint32_t pitch; /**< pitch in bytes. */
 327
 328    uint32_t qpitch; /**< The distance in rows between array slices. */
 329
 330    struct intel_mipmap_tree *mt; /**< hiz miptree used with Gen6 */
 331 };
 332
 333 /* Tile resource modes */
 334 enum intel_miptree_tr_mode {
 335    INTEL_MIPTREE_TRMODE_NONE,
 336    INTEL_MIPTREE_TRMODE_YF,
 337    INTEL_MIPTREE_TRMODE_YS
 338 };
 339
 340 struct intel_mipmap_tree
 341 {
 342    /** Buffer object containing the pixel data. */
 343    drm_intel_bo *bo;
 344
 345    uint32_t pitch; /**< pitch in bytes. */
 346
 347    uint32_t tiling; /**< One of the I915_TILING_* flags */
 348    enum intel_miptree_tr_mode tr_mode;
 349
 350    /* Effectively the key:
 351     */
 352    GLenum target;
 353
 354    /**
 355     * Generally, this is just the same as the gl_texture_image->TexFormat or
 356     * gl_renderbuffer->Format.
 357     *
 358     * However, for textures and renderbuffers with packed depth/stencil formats
 359     * on hardware where we want or need to use separate stencil, there will be
 360     * two miptrees for storing the data.  If the depthstencil texture or rb is
 361     * MESA_FORMAT_Z32_FLOAT_S8X24_UINT, then mt->format will be
 362     * MESA_FORMAT_Z_FLOAT32, otherwise for MESA_FORMAT_Z24_UNORM_S8_UINT objects it will be
 363     * MESA_FORMAT_Z24_UNORM_X8_UINT.
 364     *
 365     * For ETC1/ETC2 textures, this is one of the uncompressed mesa texture
 366     * formats if the hardware lacks support for ETC1/ETC2. See @ref etc_format.
 367     */
 368    mesa_format format;
 369
 370    /** This variable stores the value of ETC compressed texture format */
 371    mesa_format etc_format;
 372
 373    /**
 374     * The X offset of each image in the miptree must be aligned to this.
 375     * See the comments in brw_tex_layout.c.
 376     */
 377    unsigned int align_w;
 378    unsigned int align_h; /**< \see align_w */
 379
 380    GLuint first_level;
 381    GLuint last_level;
 382
 383    /**
 384     * Level zero image dimensions.  These dimensions correspond to the
 385     * physical layout of data in memory.  Accordingly, they account for the
 386     * extra width, height, and or depth that must be allocated in order to
 387     * accommodate multisample formats, and they account for the extra factor
 388     * of 6 in depth that must be allocated in order to accommodate cubemap
 389     * textures.
 390     */
 391    GLuint physical_width0, physical_height0, physical_depth0;
 392
 393    GLuint cpp; /**< bytes per pixel */
 394    GLuint num_samples;
 395    bool compressed;
 396
 397    /**
 398     * Level zero image dimensions.  These dimensions correspond to the
 399     * logical width, height, and depth of the texture as seen by client code.
 400     * Accordingly, they do not account for the extra width, height, and/or
 401     * depth that must be allocated in order to accommodate multisample
 402     * formats, nor do they account for the extra factor of 6 in depth that
 403     * must be allocated in order to accommodate cubemap textures.
 404     */
 405    uint32_t logical_width0, logical_height0, logical_depth0;
 406
 407    /**
 408     * Indicates if we use the standard miptree layout (ALL_LOD_IN_EACH_SLICE),
 409     * or if we tightly pack array slices at each LOD (ALL_SLICES_AT_EACH_LOD).
 410     */
 411    enum miptree_array_layout array_layout;
 412
 413    /**
 414     * The distance in between array slices.
 415     *
 416     * The value is the one that is sent in the surface state. The actual
 417     * meaning depends on certain criteria. Usually it is simply the number of
 418     * uncompressed rows between each slice. However on Gen9+ for compressed
 419     * surfaces it is the number of blocks. For 1D array surfaces that have the
 420     * mipmap tree stored horizontally it is the number of pixels between each
 421     * slice.
 422     */
 423    uint32_t qpitch;
 424
 425    /**
 426     * MSAA layout used by this buffer.
 427     */
 428    enum intel_msaa_layout msaa_layout;
 429
 430    /* Derived from the above:
 431     */
 432    GLuint total_width;
 433    GLuint total_height;
 434
 435    /* The 3DSTATE_CLEAR_PARAMS value associated with the last depth clear to
 436     * this depth mipmap tree, if any.
 437     */
 438    uint32_t depth_clear_value;
 439
 440    /* Includes image offset tables:
 441     */
 442    struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
 443
 444    /* Offset into bo where miptree starts:
 445     */
 446    uint32_t offset;
 447
 448    /**
 449     * \brief HiZ aux buffer
 450     *
 451     * The hiz miptree contains the miptree's hiz buffer. To allocate the hiz
 452     * buffer, use intel_miptree_alloc_hiz().
 453     *
 454     * To determine if hiz is enabled, do not check this pointer. Instead, use
 455     * intel_miptree_slice_has_hiz().
 456     */
 457    struct intel_miptree_aux_buffer *hiz_buf;
 458
 459    /**
 460     * \brief Map of miptree slices to needed resolves.
 461     *
 462     * This is used only when the miptree has a child HiZ miptree.
 463     *
 464     * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
 465     * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
 466     * mt->hiz_mt->hiz_map, is unused.
 467     */
 468    struct exec_list hiz_map; /* List of intel_resolve_map. */
 469
 470    /**
 471     * \brief Stencil miptree for depthstencil textures.
 472     *
 473     * This miptree is used for depthstencil textures and renderbuffers that
 474     * require separate stencil.  It always has the true copy of the stencil
 475     * bits, regardless of mt->format.
 476     *
 477     * \see intel_miptree_map_depthstencil()
 478     * \see intel_miptree_unmap_depthstencil()
 479     */
 480    struct intel_mipmap_tree *stencil_mt;
 481
 482    /**
 483     * \brief MCS miptree.
 484     *
 485     * This miptree contains the "multisample control surface", which stores
 486     * the necessary information to implement compressed MSAA
 487     * (INTEL_MSAA_FORMAT_CMS) and "fast color clear" behaviour on Gen7+.
 488     *
 489     * NULL if no MCS miptree is in use for this surface.
 490     */
 491    struct intel_mipmap_tree *mcs_mt;
 492
 493    /**
 494     * Fast clear state for this buffer.
 495     */
 496    enum intel_fast_clear_state fast_clear_state;
 497
 498    /**
 499     * The SURFACE_STATE bits associated with the last fast color clear to this
 500     * color mipmap tree, if any.
 501     *
 502     * This value will only ever contain ones in bits 28-31, so it is safe to
 503     * OR into dword 7 of SURFACE_STATE.
 504     */
 505    uint32_t fast_clear_color_value;
 506
 507    /**
 508     * Disable allocation of auxiliary buffers, such as the HiZ buffer and MCS
 509     * buffer. This is useful for sharing the miptree bo with an external client
 510     * that doesn't understand auxiliary buffers.
 511     */
 512    bool disable_aux_buffers;
 513
 514    /* These are also refcounted:
 515     */
 516    GLuint refcount;
 517 };
 518
 519 enum intel_miptree_tiling_mode {
 520    INTEL_MIPTREE_TILING_ANY,
 521    INTEL_MIPTREE_TILING_Y,
 522    INTEL_MIPTREE_TILING_NONE,
 523 };
 524
 525 bool
 526 intel_is_non_msrt_mcs_buffer_supported(struct brw_context *brw,
 527                                        struct intel_mipmap_tree *mt);
 528
 529 void
 530 intel_get_non_msrt_mcs_alignment(struct brw_context *brw,
 531                                  struct intel_mipmap_tree *mt,
 532                                  unsigned *width_px, unsigned *height);
 533
 534 bool
 535 intel_miptree_alloc_non_msrt_mcs(struct brw_context *brw,
 536                                  struct intel_mipmap_tree *mt);
 537
 538 struct intel_mipmap_tree *intel_miptree_create(struct brw_context *brw,
 539                                                GLenum target,
 540                                                mesa_format format,
 541                                                GLuint first_level,
 542                                                GLuint last_level,
 543                                                GLuint width0,
 544                                                GLuint height0,
 545                                                GLuint depth0,
 546                                                bool expect_accelerated_upload,
 547                                                GLuint num_samples,
 548                                                enum intel_miptree_tiling_mode,
 549                                                bool force_all_slices_at_each_lod);
 550
 551 struct intel_mipmap_tree *
 552 intel_miptree_create_for_bo(struct brw_context *brw,
 553                             drm_intel_bo *bo,
 554                             mesa_format format,
 555                             uint32_t offset,
 556                             uint32_t width,
 557                             uint32_t height,
 558                             uint32_t depth,
 559                             int pitch,
 560                             bool disable_aux_buffers);
 561
 562 void
 563 intel_update_winsys_renderbuffer_miptree(struct brw_context *intel,
 564                                          struct intel_renderbuffer *irb,
 565                                          drm_intel_bo *bo,
 566                                          uint32_t width, uint32_t height,
 567                                          uint32_t pitch);
 568
 569 /**
 570  * Create a miptree appropriate as the storage for a non-texture renderbuffer.
 571  * The miptree has the following properties:
 572  *     - The target is GL_TEXTURE_2D.
 573  *     - There are no levels other than the base level 0.
 574  *     - Depth is 1.
 575  */
 576 struct intel_mipmap_tree*
 577 intel_miptree_create_for_renderbuffer(struct brw_context *brw,
 578                                       mesa_format format,
 579                                       uint32_t width,
 580                                       uint32_t height,
 581                                       uint32_t num_samples);
 582
 583 mesa_format
 584 intel_depth_format_for_depthstencil_format(mesa_format format);
 585
 586 mesa_format
 587 intel_lower_compressed_format(struct brw_context *brw, mesa_format format);
 588
 589 /** \brief Assert that the level and layer are valid for the miptree. */
 590 static inline void
 591 intel_miptree_check_level_layer(struct intel_mipmap_tree *mt,
 592                                 uint32_t level,
 593                                 uint32_t layer)
 594 {
 595    assert(level >= mt->first_level);
 596    assert(level <= mt->last_level);
 597    assert(layer < mt->level[level].depth);
 598 }
 599
 600 void intel_miptree_reference(struct intel_mipmap_tree **dst,
 601                              struct intel_mipmap_tree *src);
 602
 603 void intel_miptree_release(struct intel_mipmap_tree **mt);
 604
 605 /* Check if an image fits an existing mipmap tree layout
 606  */
 607 bool intel_miptree_match_image(struct intel_mipmap_tree *mt,
 608                                     struct gl_texture_image *image);
 609
 610 void
 611 intel_miptree_get_image_offset(const struct intel_mipmap_tree *mt,
 612                                GLuint level, GLuint slice,
 613                                GLuint *x, GLuint *y);
 614
 615 void
 616 intel_miptree_get_dimensions_for_image(struct gl_texture_image *image,
 617                                        int *width, int *height, int *depth);
 618
 619 void
 620 intel_miptree_get_tile_masks(const struct intel_mipmap_tree *mt,
 621                              uint32_t *mask_x, uint32_t *mask_y,
 622                              bool map_stencil_as_y_tiled);
 623
 624 uint32_t
 625 intel_miptree_get_tile_offsets(const struct intel_mipmap_tree *mt,
 626                                GLuint level, GLuint slice,
 627                                uint32_t *tile_x,
 628                                uint32_t *tile_y);
 629 uint32_t
 630 intel_miptree_get_aligned_offset(const struct intel_mipmap_tree *mt,
 631                                  uint32_t x, uint32_t y,
 632                                  bool map_stencil_as_y_tiled);
 633
 634 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
 635                                   GLuint level,
 636                                   GLuint x, GLuint y, GLuint d);
 637
 638 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
 639                                     GLuint level,
 640                                     GLuint img, GLuint x, GLuint y);
 641
 642 void
 643 intel_miptree_copy_teximage(struct brw_context *brw,
 644                             struct intel_texture_image *intelImage,
 645                             struct intel_mipmap_tree *dst_mt, bool invalidate);
 646
 647 /**
 648  * \name Miptree HiZ functions
 649  * \{
 650  *
 651  * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
 652  * functions on a miptree without HiZ. In that case, each function is a no-op.
 653  */
 654
 655 bool
 656 intel_miptree_wants_hiz_buffer(struct brw_context *brw,
 657                                struct intel_mipmap_tree *mt);
 658
 659 /**
 660  * \brief Allocate the miptree's embedded HiZ miptree.
 661  * \see intel_mipmap_tree:hiz_mt
 662  * \return false if allocation failed
 663  */
 664 bool
 665 intel_miptree_alloc_hiz(struct brw_context *brw,
 666                         struct intel_mipmap_tree *mt);
 667
 668 bool
 669 intel_miptree_level_has_hiz(struct intel_mipmap_tree *mt, uint32_t level);
 670
 671 void
 672 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree *mt,
 673                                           uint32_t level,
 674                                           uint32_t depth);
 675 void
 676 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree *mt,
 677                                             uint32_t level,
 678                                             uint32_t depth);
 679
 680 void
 681 intel_miptree_set_all_slices_need_depth_resolve(struct intel_mipmap_tree *mt,
 682                                                 uint32_t level);
 683
 684 /**
 685  * \return false if no resolve was needed
 686  */
 687 bool
 688 intel_miptree_slice_resolve_hiz(struct brw_context *brw,
 689                                 struct intel_mipmap_tree *mt,
 690                                 unsigned int level,
 691                                 unsigned int depth);
 692
 693 /**
 694  * \return false if no resolve was needed
 695  */
 696 bool
 697 intel_miptree_slice_resolve_depth(struct brw_context *brw,
 698                                   struct intel_mipmap_tree *mt,
 699                                   unsigned int level,
 700                                   unsigned int depth);
 701
 702 /**
 703  * \return false if no resolve was needed
 704  */
 705 bool
 706 intel_miptree_all_slices_resolve_hiz(struct brw_context *brw,
 707                                      struct intel_mipmap_tree *mt);
 708
 709 /**
 710  * \return false if no resolve was needed
 711  */
 712 bool
 713 intel_miptree_all_slices_resolve_depth(struct brw_context *brw,
 714                                        struct intel_mipmap_tree *mt);
 715
 716 /**\}*/
 717
 718 /**
 719  * Update the fast clear state for a miptree to indicate that it has been used
 720  * for rendering.
 721  */
 722 static inline void
 723 intel_miptree_used_for_rendering(struct intel_mipmap_tree *mt)
 724 {
 725    /* If the buffer was previously in fast clear state, change it to
 726     * unresolved state, since it won't be guaranteed to be clear after
 727     * rendering occurs.
 728     */
 729    if (mt->fast_clear_state == INTEL_FAST_CLEAR_STATE_CLEAR)
 730       mt->fast_clear_state = INTEL_FAST_CLEAR_STATE_UNRESOLVED;
 731 }
 732
 733 void
 734 intel_miptree_resolve_color(struct brw_context *brw,
 735                             struct intel_mipmap_tree *mt);
 736
 737 void
 738 intel_miptree_make_shareable(struct brw_context *brw,
 739                              struct intel_mipmap_tree *mt);
 740
 741 void
 742 intel_miptree_updownsample(struct brw_context *brw,
 743                            struct intel_mipmap_tree *src,
 744                            struct intel_mipmap_tree *dst);
 745
 746 /**
 747  * Horizontal distance from one slice to the next in the two-dimensional
 748  * miptree layout.
 749  */
 750 unsigned
 751 brw_miptree_get_horizontal_slice_pitch(const struct brw_context *brw,
 752                                        const struct intel_mipmap_tree *mt,
 753                                        unsigned level);
 754
 755 /**
 756  * Vertical distance from one slice to the next in the two-dimensional miptree
 757  * layout.
 758  */
 759 unsigned
 760 brw_miptree_get_vertical_slice_pitch(const struct brw_context *brw,
 761                                      const struct intel_mipmap_tree *mt,
 762                                      unsigned level);
 763
 764 void
 765 brw_miptree_layout(struct brw_context *brw,
 766                    bool for_bo,
 767                    enum intel_miptree_tiling_mode requested,
 768                    struct intel_mipmap_tree *mt);
 769
 770 void *intel_miptree_map_raw(struct brw_context *brw,
 771                             struct intel_mipmap_tree *mt);
 772
 773 void intel_miptree_unmap_raw(struct brw_context *brw,
 774                              struct intel_mipmap_tree *mt);
 775
 776 void
 777 intel_miptree_map(struct brw_context *brw,
 778                   struct intel_mipmap_tree *mt,
 779                   unsigned int level,
 780                   unsigned int slice,
 781                   unsigned int x,
 782                   unsigned int y,
 783                   unsigned int w,
 784                   unsigned int h,
 785                   GLbitfield mode,
 786                   void **out_ptr,
 787                   ptrdiff_t *out_stride);
 788
 789 void
 790 intel_miptree_unmap(struct brw_context *brw,
 791                     struct intel_mipmap_tree *mt,
 792                     unsigned int level,
 793                     unsigned int slice);
 794
 795 void
 796 intel_hiz_exec(struct brw_context *brw, struct intel_mipmap_tree *mt,
 797                unsigned int level, unsigned int layer, enum gen6_hiz_op op);
 798
 799 #ifdef __cplusplus
 800 }
 801 #endif
 802
 803 #endif