src/amd/common/ac_surface.h

   1 /*
   2  * Copyright © 2017 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  14  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15  * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
  16  * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  18  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * The above copyright notice and this permission notice (including the
  22  * next paragraph) shall be included in all copies or substantial portions
  23  * of the Software.
  24  */
  25
  26 #ifndef AC_SURFACE_H
  27 #define AC_SURFACE_H
  28
  29 #include <stdint.h>
  30
  31 #include "amd_family.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* Forward declarations. */
  38 typedef void* ADDR_HANDLE;
  39
  40 struct amdgpu_gpu_info;
  41 struct radeon_info;
  42
  43 #define RADEON_SURF_MAX_LEVELS                  15
  44
  45 enum radeon_surf_mode {
  46     RADEON_SURF_MODE_LINEAR_ALIGNED = 1,
  47     RADEON_SURF_MODE_1D = 2,
  48     RADEON_SURF_MODE_2D = 3,
  49 };
  50
  51 /* These are defined exactly like GB_TILE_MODEn.MICRO_TILE_MODE_NEW. */
  52 enum radeon_micro_mode {
  53     RADEON_MICRO_MODE_DISPLAY = 0,
  54     RADEON_MICRO_MODE_THIN = 1,
  55     RADEON_MICRO_MODE_DEPTH = 2,
  56     RADEON_MICRO_MODE_ROTATED = 3,
  57 };
  58
  59 /* the first 16 bits are reserved for libdrm_radeon, don't use them */
  60 #define RADEON_SURF_SCANOUT                     (1 << 16)
  61 #define RADEON_SURF_ZBUFFER                     (1 << 17)
  62 #define RADEON_SURF_SBUFFER                     (1 << 18)
  63 #define RADEON_SURF_Z_OR_SBUFFER                (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
  64 /* bits 19 and 20 are reserved for libdrm_radeon, don't use them */
  65 #define RADEON_SURF_FMASK                       (1 << 21)
  66 #define RADEON_SURF_DISABLE_DCC                 (1 << 22)
  67 #define RADEON_SURF_TC_COMPATIBLE_HTILE         (1 << 23)
  68 #define RADEON_SURF_IMPORTED                    (1 << 24)
  69 #define RADEON_SURF_OPTIMIZE_FOR_SPACE          (1 << 25)
  70 #define RADEON_SURF_SHAREABLE                   (1 << 26)
  71
  72 struct legacy_surf_level {
  73     uint64_t                    offset;
  74     uint32_t                    slice_size_dw; /* in dwords; max = 4GB / 4. */
  75     uint32_t                    dcc_offset; /* relative offset within DCC mip tree */
  76     uint32_t                    dcc_fast_clear_size;
  77     unsigned                    nblk_x:15;
  78     unsigned                    nblk_y:15;
  79     enum radeon_surf_mode       mode:2;
  80 };
  81
  82 struct legacy_surf_fmask {
  83     uint64_t size;
  84     unsigned alignment;
  85     unsigned tile_swizzle;
  86     unsigned slice_tile_max; /* max 4M */
  87     uint8_t tiling_index;    /* max 31 */
  88     uint8_t bankh;           /* max 8 */
  89     uint16_t pitch_in_pixels;
  90 };
  91
  92 struct legacy_surf_layout {
  93     unsigned                    bankw:4;  /* max 8 */
  94     unsigned                    bankh:4;  /* max 8 */
  95     unsigned                    mtilea:4; /* max 8 */
  96     unsigned                    tile_split:13;         /* max 4K */
  97     unsigned                    stencil_tile_split:13; /* max 4K */
  98     unsigned                    pipe_config:5;      /* max 17 */
  99     unsigned                    num_banks:5;        /* max 16 */
 100     unsigned                    macro_tile_index:4; /* max 15 */
 101
 102     /* Whether the depth miptree or stencil miptree as used by the DB are
 103      * adjusted from their TC compatible form to ensure depth/stencil
 104      * compatibility. If either is true, the corresponding plane cannot be
 105      * sampled from.
 106      */
 107     unsigned                    depth_adjusted:1;
 108     unsigned                    stencil_adjusted:1;
 109
 110     struct legacy_surf_level    level[RADEON_SURF_MAX_LEVELS];
 111     struct legacy_surf_level    stencil_level[RADEON_SURF_MAX_LEVELS];
 112     uint8_t                     tiling_index[RADEON_SURF_MAX_LEVELS];
 113     uint8_t                     stencil_tiling_index[RADEON_SURF_MAX_LEVELS];
 114     struct legacy_surf_fmask    fmask;
 115 };
 116
 117 /* Same as addrlib - AddrResourceType. */
 118 enum gfx9_resource_type {
 119     RADEON_RESOURCE_1D = 0,
 120     RADEON_RESOURCE_2D,
 121     RADEON_RESOURCE_3D,
 122 };
 123
 124 struct gfx9_surf_flags {
 125     uint16_t                    swizzle_mode; /* tile mode */
 126     uint16_t                    epitch; /* (pitch - 1) or (height - 1) */
 127 };
 128
 129 struct gfx9_surf_meta_flags {
 130     unsigned                    rb_aligned:1;   /* optimal for RBs */
 131     unsigned                    pipe_aligned:1; /* optimal for TC */
 132 };
 133
 134 struct gfx9_surf_layout {
 135     struct gfx9_surf_flags      surf;    /* color or depth surface */
 136     struct gfx9_surf_flags      fmask;   /* not added to surf_size */
 137     struct gfx9_surf_flags      stencil; /* added to surf_size, use stencil_offset */
 138
 139     struct gfx9_surf_meta_flags dcc;   /* metadata of color */
 140     struct gfx9_surf_meta_flags htile; /* metadata of depth and stencil */
 141     struct gfx9_surf_meta_flags cmask; /* metadata of fmask */
 142
 143     enum gfx9_resource_type     resource_type; /* 1D, 2D or 3D */
 144     uint16_t                    surf_pitch; /* in blocks */
 145     uint16_t                    surf_height;
 146
 147     uint64_t                    surf_offset; /* 0 unless imported with an offset */
 148     /* The size of the 2D plane containing all mipmap levels. */
 149     uint64_t                    surf_slice_size;
 150     /* Mipmap level offset within the slice in bytes. Only valid for LINEAR. */
 151     uint32_t                    offset[RADEON_SURF_MAX_LEVELS];
 152
 153     uint16_t                    dcc_pitch_max;  /* (mip chain pitch - 1) */
 154
 155     uint64_t                    stencil_offset; /* separate stencil */
 156     uint64_t                    fmask_size;
 157     uint64_t                    cmask_size;
 158
 159     uint32_t                    fmask_alignment;
 160     uint32_t                    cmask_alignment;
 161
 162     uint8_t                     fmask_tile_swizzle;
 163 };
 164
 165 struct radeon_surf {
 166     /* Format properties. */
 167     unsigned                    blk_w:4;
 168     unsigned                    blk_h:4;
 169     unsigned                    bpe:5;
 170     /* Number of mipmap levels where DCC is enabled starting from level 0.
 171      * Non-zero levels may be disabled due to alignment constraints, but not
 172      * the first level.
 173      */
 174     unsigned                    num_dcc_levels:4;
 175     unsigned                    is_linear:1;
 176     unsigned                    has_stencil:1;
 177     /* This might be true even if micro_tile_mode isn't displayable or rotated. */
 178     unsigned                    is_displayable:1;
 179     /* Displayable, thin, depth, rotated. AKA D,S,Z,R swizzle modes. */
 180     unsigned                    micro_tile_mode:3;
 181     uint32_t                    flags;
 182
 183     /* These are return values. Some of them can be set by the caller, but
 184      * they will be treated as hints (e.g. bankw, bankh) and might be
 185      * changed by the calculator.
 186      */
 187
 188     /* Tile swizzle can be OR'd with low bits of the BASE_256B address.
 189      * The value is the same for all mipmap levels. Supported tile modes:
 190      * - GFX6: Only macro tiling.
 191      * - GFX9: Only *_X and *_T swizzle modes. Level 0 must not be in the mip
 192      *   tail.
 193      *
 194      * Only these surfaces are allowed to set it:
 195      * - color (if it doesn't have to be displayable)
 196      * - DCC (same tile swizzle as color)
 197      * - FMASK
 198      * - CMASK if it's TC-compatible or if the gen is GFX9
 199      * - depth/stencil if HTILE is not TC-compatible and if the gen is not GFX9
 200      */
 201     uint8_t                     tile_swizzle;
 202
 203     uint64_t                    surf_size;
 204     /* DCC and HTILE are very small. */
 205     uint32_t                    dcc_size;
 206     uint32_t                    htile_size;
 207
 208     uint32_t                    htile_slice_size;
 209
 210     uint32_t                    surf_alignment;
 211     uint32_t                    dcc_alignment;
 212     uint32_t                    htile_alignment;
 213
 214     union {
 215         /* R600-VI return values.
 216          *
 217          * Some of them can be set by the caller if certain parameters are
 218          * desirable. The allocator will try to obey them.
 219          */
 220         struct legacy_surf_layout legacy;
 221
 222         /* GFX9+ return values. */
 223         struct gfx9_surf_layout gfx9;
 224     } u;
 225 };
 226
 227 struct ac_surf_info {
 228         uint32_t width;
 229         uint32_t height;
 230         uint32_t depth;
 231         uint8_t samples;
 232         uint8_t levels;
 233         uint8_t num_channels; /* heuristic for displayability */
 234         uint16_t array_size;
 235         uint32_t *surf_index; /* Set a monotonic counter for tile swizzling. */
 236         uint32_t *fmask_surf_index;
 237 };
 238
 239 struct ac_surf_config {
 240         struct ac_surf_info info;
 241         unsigned is_3d : 1;
 242         unsigned is_cube : 1;
 243 };
 244
 245 ADDR_HANDLE amdgpu_addr_create(const struct radeon_info *info,
 246                                const struct amdgpu_gpu_info *amdinfo,
 247                                uint64_t *max_alignment);
 248
 249 int ac_compute_surface(ADDR_HANDLE addrlib, const struct radeon_info *info,
 250                        const struct ac_surf_config * config,
 251                        enum radeon_surf_mode mode,
 252                        struct radeon_surf *surf);
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif
 257
 258 #endif /* AC_SURFACE_H */