"Fossies" - the Fresh Open Source Software Archive

Member "mesa-20.1.8/src/freedreno/fdl/freedreno_layout.h" (16 Sep 2020, 6243 Bytes) of package /linux/misc/mesa-20.1.8.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "freedreno_layout.h" see the Fossies "Dox" file reference documentation and the last Fossies "Diffs" side-by-side code changes report: 20.1.5_vs_20.2.0-rc1.

    1 /*
    2  * Copyright © 2019 Google, Inc.
    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 
   24 #ifndef FREEDRENO_LAYOUT_H_
   25 #define FREEDRENO_LAYOUT_H_
   26 
   27 #include <stdbool.h>
   28 #include <stdint.h>
   29 
   30 #include "util/u_debug.h"
   31 #include "util/u_math.h"
   32 #include "util/format/u_format.h"
   33 
   34 /* Shared freedreno mipmap layout helper
   35  *
   36  * It does *not* attempt to track surface transitions, in particular
   37  * about UBWC state.  Possibly it should, but
   38  *  (a) I'm not sure if in all cases we can transparently do in-
   39  *      place transitions (ie. a5xx textures with interleaved
   40  *      meta and pixel data
   41  *  (b) Even if we can, we probably can't assume that we have
   42  *      figured out yet how to do in-place transition for every
   43  *      generation.
   44  */
   45 
   46 /* Texture Layout on a3xx:
   47  * -----------------------
   48  *
   49  * Each mipmap-level contains all of it's layers (ie. all cubmap
   50  * faces, all 1d/2d array elements, etc).  The texture sampler is
   51  * programmed with the start address of each mipmap level, and hw
   52  * derives the layer offset within the level.
   53  *
   54  *
   55  * Texture Layout on a4xx+:
   56  * -----------------------
   57  *
   58  * For cubemap and 2d array, each layer contains all of it's mipmap
   59  * levels (layer_first layout).
   60  *
   61  * 3d textures are laid out as on a3xx.
   62  *
   63  * In either case, the slice represents the per-miplevel information,
   64  * but in layer_first layout it only includes the first layer, and
   65  * an additional offset of (rsc->layer_size * layer) must be added.
   66  *
   67  *
   68  * UBWC Color Compressions (a5xx+):
   69  * -------------------------------
   70  *
   71  * Color compression is only supported for tiled layouts.  In general
   72  * the meta "flag" buffer (ie. what holds the compression state for
   73  * each block) can be separate from the color data, except for textures
   74  * on a5xx where it needs to be interleaved with layers/levels of a
   75  * texture.
   76  */
   77 
   78 #define FDL_MAX_MIP_LEVELS 14
   79 
   80 struct fdl_slice {
   81     uint32_t offset;         /* offset of first layer in slice */
   82     uint32_t pitch;          /* pitch in bytes between rows. */
   83     uint32_t size0;          /* size of first layer in slice */
   84 };
   85 
   86 /**
   87  * Encapsulates the layout of a resource, including position of given 2d
   88  * surface (layer, level) within.  Or rather all the information needed
   89  * to derive this.
   90  */
   91 struct fdl_layout {
   92     struct fdl_slice slices[FDL_MAX_MIP_LEVELS];
   93     struct fdl_slice ubwc_slices[FDL_MAX_MIP_LEVELS];
   94     uint32_t layer_size;
   95     uint32_t ubwc_layer_size; /* in bytes */
   96     bool ubwc : 1;
   97     bool layer_first : 1;    /* see above description */
   98 
   99     /* Note that for tiled textures, beyond a certain mipmap level (ie.
  100      * when width is less than block size) things switch to linear.  In
  101      * general you should not directly look at fdl_layout::tile_mode,
  102      * but instead use fdl_surface::tile_mode which will correctly take
  103      * this into account.
  104      */
  105     uint32_t tile_mode : 2;
  106     /* Bytes per pixel (where a "pixel" is a single row of a block in the case
  107      * of compression), including each sample in the case of multisample
  108      * layouts.
  109      */
  110     uint8_t cpp;
  111 
  112     /**
  113      * Left shift necessary to multiply by cpp.  Invalid for NPOT cpp, please
  114      * use fdl_cpp_shift() to sanity check you aren't hitting that case.
  115      */
  116     uint8_t cpp_shift;
  117 
  118     uint32_t width0, height0, depth0;
  119     uint32_t nr_samples;
  120     enum pipe_format format;
  121 
  122     uint32_t size; /* Size of the whole image, in bytes. */
  123     uint32_t base_align; /* Alignment of the base address, in bytes. */
  124 };
  125 
  126 static inline uint32_t
  127 fdl_cpp_shift(const struct fdl_layout *layout)
  128 {
  129     assert(util_is_power_of_two_or_zero(layout->cpp));
  130     return layout->cpp_shift;
  131 }
  132 
  133 static inline uint32_t
  134 fdl_layer_stride(const struct fdl_layout *layout, unsigned level)
  135 {
  136     if (layout->layer_first)
  137         return layout->layer_size;
  138     else
  139         return layout->slices[level].size0;
  140 }
  141 
  142 static inline uint32_t
  143 fdl_surface_offset(const struct fdl_layout *layout, unsigned level, unsigned layer)
  144 {
  145     const struct fdl_slice *slice = &layout->slices[level];
  146     return slice->offset + fdl_layer_stride(layout, level) * layer;
  147 }
  148 
  149 static inline uint32_t
  150 fdl_ubwc_offset(const struct fdl_layout *layout, unsigned level, unsigned layer)
  151 {
  152     const struct fdl_slice *slice = &layout->ubwc_slices[level];
  153     return slice->offset + layer * layout->ubwc_layer_size;
  154 }
  155 
  156 static inline bool
  157 fdl_level_linear(const struct fdl_layout *layout, int level)
  158 {
  159     if (layout->ubwc)
  160         return false;
  161 
  162     unsigned w = u_minify(layout->width0, level);
  163     if (w < 16)
  164         return true;
  165 
  166     return false;
  167 }
  168 
  169 static inline uint32_t
  170 fdl_tile_mode(const struct fdl_layout *layout, int level)
  171 {
  172     if (layout->tile_mode && fdl_level_linear(layout, level))
  173         return 0; /* linear */
  174     else
  175         return layout->tile_mode;
  176 }
  177 
  178 static inline bool
  179 fdl_ubwc_enabled(const struct fdl_layout *layout, int level)
  180 {
  181     return layout->ubwc;
  182 }
  183 
  184 void
  185 fdl_layout_buffer(struct fdl_layout *layout, uint32_t size);
  186 
  187 void
  188 fdl6_layout(struct fdl_layout *layout,
  189         enum pipe_format format, uint32_t nr_samples,
  190         uint32_t width0, uint32_t height0, uint32_t depth0,
  191         uint32_t mip_levels, uint32_t array_size, bool is_3d);
  192 
  193 void
  194 fdl_dump_layout(struct fdl_layout *layout);
  195 
  196 void
  197 fdl6_get_ubwc_blockwidth(struct fdl_layout *layout,
  198         uint32_t *blockwidth, uint32_t *blockheight);
  199 
  200 #endif /* FREEDRENO_LAYOUT_H_ */