src/panfrost/encoder/pan_texture.c

   1 /*
   2  * Copyright (C) 2008 VMware, Inc.
   3  * Copyright (C) 2014 Broadcom
   4  * Copyright (C) 2018-2019 Alyssa Rosenzweig
   5  * Copyright (C) 2019-2020 Collabora, Ltd.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  */
  27
  28 #include "util/macros.h"
  29 #include "util/u_math.h"
  30 #include "pan_texture.h"
  31
  32 /* Generates a texture descriptor. Ideally, descriptors are immutable after the
  33  * texture is created, so we can keep these hanging around in GPU memory in a
  34  * dedicated BO and not have to worry. In practice there are some minor gotchas
  35  * with this (the driver sometimes will change the format of a texture on the
  36  * fly for compression) but it's fast enough to just regenerate the descriptor
  37  * in those cases, rather than monkeypatching at drawtime.
  38  *
  39  * A texture descriptor consists of a 32-byte mali_texture_descriptor structure
  40  * followed by a variable number of pointers. Due to this variance and
  41  * potentially large size, we actually upload directly rather than returning
  42  * the descriptor. Whether the user does a copy themselves or not is irrelevant
  43  * to us here.
  44  */
  45
  46 /* Check if we need to set a custom stride by computing the "expected"
  47  * stride and comparing it to what the user actually wants. Only applies
  48  * to linear textures, since tiled/compressed textures have strict
  49  * alignment requirements for their strides as it is */
  50
  51 static bool
  52 panfrost_needs_explicit_stride(
  53                 struct panfrost_slice *slices,
  54                 uint16_t width,
  55                 unsigned first_level, unsigned last_level,
  56                 unsigned bytes_per_pixel)
  57 {
  58         for (unsigned l = first_level; l <= last_level; ++l) {
  59                 unsigned actual = slices[l].stride;
  60                 unsigned expected = u_minify(width, l) * bytes_per_pixel;
  61
  62                 if (actual != expected)
  63                         return true;
  64         }
  65
  66         return false;
  67 }
  68
  69 /* A Scalable Texture Compression (ASTC) corresponds to just a few texture type
  70  * in the hardware, but in fact can be parametrized to have various widths and
  71  * heights for the so-called "stretch factor". It turns out these parameters
  72  * are stuffed in the bottom bits of the payload pointers. This functions
  73  * computes these magic stuffing constants based on the ASTC format in use. The
  74  * constant in a given dimension is 3-bits, and two are stored side-by-side for
  75  * each active dimension.
  76  */
  77
  78 static unsigned
  79 panfrost_astc_stretch(unsigned dim)
  80 {
  81         assert(dim >= 4 && dim <= 12);
  82         return MIN2(dim, 11) - 4;
  83 }
  84
  85 /* Texture addresses are tagged with information about AFBC (colour AFBC?) xor
  86  * ASTC (stretch factor) if in use. */
  87
  88 static unsigned
  89 panfrost_compression_tag(
  90                 const struct util_format_description *desc,
  91                 enum mali_format format, enum mali_texture_layout layout)
  92 {
  93         if (layout == MALI_TEXTURE_AFBC)
  94                 return util_format_has_depth(desc) ? 0x0 : 0x1;
  95         else if (format == MALI_ASTC_HDR_SUPP || format == MALI_ASTC_SRGB_SUPP)
  96                 return (panfrost_astc_stretch(desc->block.height) << 3) |
  97                         panfrost_astc_stretch(desc->block.width);
  98         else
  99                 return 0;
 100 }
 101
 102
 103 /* Cubemaps have 6 faces as "layers" in between each actual layer. We
 104  * need to fix this up. TODO: logic wrong in the asserted out cases ...
 105  * can they happen, perhaps from cubemap arrays? */
 106
 107 static void
 108 panfrost_adjust_cube_dimensions(
 109                 unsigned *first_face, unsigned *last_face,
 110                 unsigned *first_layer, unsigned *last_layer)
 111 {
 112         *first_face = *first_layer % 6;
 113         *last_face = *last_layer % 6;
 114         *first_layer /= 6;
 115         *last_layer /= 6;
 116
 117         assert((*first_layer == *last_layer) || (*first_face == 0 && *last_face == 5));
 118 }
 119
 120 /* Following the texture descriptor is a number of pointers. How many? */
 121
 122 static unsigned
 123 panfrost_texture_num_elements(
 124                 unsigned first_level, unsigned last_level,
 125                 unsigned first_layer, unsigned last_layer,
 126                 bool is_cube, bool manual_stride)
 127 {
 128         unsigned first_face  = 0, last_face = 0;
 129
 130         if (is_cube) {
 131                 panfrost_adjust_cube_dimensions(&first_face, &last_face,
 132                                 &first_layer, &last_layer);
 133         }
 134
 135         unsigned levels = 1 + last_level - first_level;
 136         unsigned layers = 1 + last_layer - first_layer;
 137         unsigned faces  = 1 + last_face  - first_face;
 138         unsigned num_elements = levels * layers * faces;
 139
 140         if (manual_stride)
 141                 num_elements *= 2;
 142
 143         return num_elements;
 144 }
 145
 146 /* Conservative estimate of the size of the texture descriptor a priori.
 147  * Average case, size equal to the actual size. Worst case, off by 2x (if
 148  * a manual stride is not needed on a linear texture). Returned value
 149  * must be greater than or equal to the actual size, so it's safe to use
 150  * as an allocation amount */
 151
 152 unsigned
 153 panfrost_estimate_texture_size(
 154                 unsigned first_level, unsigned last_level,
 155                 unsigned first_layer, unsigned last_layer,
 156                 enum mali_texture_type type, enum mali_texture_layout layout)
 157 {
 158         /* Assume worst case */
 159         unsigned manual_stride = (layout == MALI_TEXTURE_LINEAR);
 160
 161         unsigned elements = panfrost_texture_num_elements(
 162                         first_level, last_level,
 163                         first_layer, last_layer,
 164                         type == MALI_TEX_CUBE, manual_stride);
 165
 166         return sizeof(struct mali_texture_descriptor) +
 167                 sizeof(mali_ptr) * elements;
 168 }
 169
 170 void
 171 panfrost_new_texture(
 172         void *out,
 173         uint16_t width, uint16_t height,
 174         uint16_t depth, uint16_t array_size,
 175         enum pipe_format format,
 176         enum mali_texture_type type,
 177         enum mali_texture_layout layout,
 178         unsigned first_level, unsigned last_level,
 179         unsigned first_layer, unsigned last_layer,
 180         unsigned cube_stride,
 181         unsigned swizzle,
 182         mali_ptr base,
 183         struct panfrost_slice *slices)
 184 {
 185         const struct util_format_description *desc =
 186                 util_format_description(format);
 187
 188         unsigned bytes_per_pixel = util_format_get_blocksize(format);
 189
 190         enum mali_format mali_format = panfrost_find_format(desc);
 191
 192         bool manual_stride = (layout == MALI_TEXTURE_LINEAR)
 193                 && panfrost_needs_explicit_stride(slices, width,
 194                                 first_level, last_level, bytes_per_pixel);
 195
 196         struct mali_texture_descriptor descriptor = {
 197                 .width = MALI_POSITIVE(u_minify(width, first_level)),
 198                 .height = MALI_POSITIVE(u_minify(height, first_level)),
 199                 .depth = MALI_POSITIVE(u_minify(depth, first_level)),
 200                 .array_size = MALI_POSITIVE(array_size),
 201                 .format = {
 202                         .swizzle = panfrost_translate_swizzle_4(desc->swizzle),
 203                         .format = mali_format,
 204                         .srgb = (desc->colorspace == UTIL_FORMAT_COLORSPACE_SRGB),
 205                         .type = type,
 206                         .layout = layout,
 207                         .manual_stride = manual_stride,
 208                         .unknown2 = 1,
 209                 },
 210                 .levels = last_level - first_level,
 211                 .swizzle = swizzle
 212         };
 213
 214         memcpy(out, &descriptor, sizeof(descriptor));
 215
 216         base |= panfrost_compression_tag(desc, mali_format, layout);
 217
 218         /* Inject the addresses in, interleaving array indices, mip levels,
 219          * cube faces, and strides in that order */
 220
 221         unsigned first_face  = 0, last_face = 0, face_mult = 1;
 222
 223         if (type == MALI_TEX_CUBE) {
 224                 face_mult = 6;
 225                 panfrost_adjust_cube_dimensions(&first_face, &last_face, &first_layer, &last_layer);
 226         }
 227
 228         mali_ptr *payload = (mali_ptr *) (out + sizeof(struct mali_texture_descriptor));
 229         unsigned idx = 0;
 230
 231         for (unsigned w = first_layer; w <= last_layer; ++w) {
 232                 for (unsigned l = first_level; l <= last_level; ++l) {
 233                         for (unsigned f = first_face; f <= last_face; ++f) {
 234                                 payload[idx++] = base + panfrost_texture_offset(
 235                                                 slices, type == MALI_TEX_3D,
 236                                                 cube_stride, l, w * face_mult + f);
 237
 238                                 if (manual_stride)
 239                                         payload[idx++] = slices[l].stride;
 240                         }
 241                 }
 242         }
 243 }
 244
 245 void
 246 panfrost_new_texture_bifrost(
 247         struct bifrost_texture_descriptor *descriptor,
 248         uint16_t width, uint16_t height,
 249         uint16_t depth, uint16_t array_size,
 250         enum pipe_format format,
 251         enum mali_texture_type type,
 252         enum mali_texture_layout layout,
 253         unsigned first_level, unsigned last_level,
 254         unsigned first_layer, unsigned last_layer,
 255         unsigned cube_stride,
 256         unsigned swizzle,
 257         mali_ptr base,
 258         struct panfrost_slice *slices)
 259 {
 260         const struct util_format_description *desc =
 261                 util_format_description(format);
 262
 263         enum mali_format mali_format = panfrost_find_format(desc);
 264
 265         descriptor->format_unk = 0x2;
 266         descriptor->type = type;
 267         descriptor->format_unk2 = 0x100;
 268         descriptor->format = mali_format;
 269         descriptor->srgb = (desc->colorspace == UTIL_FORMAT_COLORSPACE_SRGB);
 270         descriptor->format_unk3 = 0x0;
 271         descriptor->width = MALI_POSITIVE(u_minify(width, first_level));
 272         descriptor->height = MALI_POSITIVE(u_minify(height, first_level));
 273         descriptor->swizzle = swizzle;
 274         descriptor->layout = layout;
 275         descriptor->levels = last_level - first_level;
 276         descriptor->unk1 = 0x0;
 277         descriptor->levels_unk = 0;
 278         descriptor->level_2 = 0;
 279         descriptor->payload = base;
 280         descriptor->array_size = MALI_POSITIVE(array_size);
 281         descriptor->unk4 = 0x0;
 282         descriptor->depth = MALI_POSITIVE(u_minify(depth, first_level));
 283         descriptor->unk5 = 0x0;
 284 }
 285
 286 /* Computes sizes for checksumming, which is 8 bytes per 16x16 tile.
 287  * Checksumming is believed to be a CRC variant (CRC64 based on the size?).
 288  * This feature is also known as "transaction elimination". */
 289
 290 #define CHECKSUM_TILE_WIDTH 16
 291 #define CHECKSUM_TILE_HEIGHT 16
 292 #define CHECKSUM_BYTES_PER_TILE 8
 293
 294 unsigned
 295 panfrost_compute_checksum_size(
 296         struct panfrost_slice *slice,
 297         unsigned width,
 298         unsigned height)
 299 {
 300         unsigned aligned_width = ALIGN_POT(width, CHECKSUM_TILE_WIDTH);
 301         unsigned aligned_height = ALIGN_POT(height, CHECKSUM_TILE_HEIGHT);
 302
 303         unsigned tile_count_x = aligned_width / CHECKSUM_TILE_WIDTH;
 304         unsigned tile_count_y = aligned_height / CHECKSUM_TILE_HEIGHT;
 305
 306         slice->checksum_stride = tile_count_x * CHECKSUM_BYTES_PER_TILE;
 307
 308         return slice->checksum_stride * tile_count_y;
 309 }
 310
 311 unsigned
 312 panfrost_get_layer_stride(struct panfrost_slice *slices, bool is_3d, unsigned cube_stride, unsigned level)
 313 {
 314         return is_3d ? slices[level].size0 : cube_stride;
 315 }
 316
 317 /* Computes the offset into a texture at a particular level/face. Add to
 318  * the base address of a texture to get the address to that level/face */
 319
 320 unsigned
 321 panfrost_texture_offset(struct panfrost_slice *slices, bool is_3d, unsigned cube_stride, unsigned level, unsigned face)
 322 {
 323         unsigned layer_stride = panfrost_get_layer_stride(slices, is_3d, cube_stride, level);
 324         return slices[level].offset + (face * layer_stride);
 325 }