xref: /third_party/mesa3d/src/intel/isl/isl_gfx7.c (revision bf215546)
1/*
2 * Copyright 2015 Intel Corporation
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#include "isl_gfx7.h"
25#include "isl_priv.h"
26
27static bool
28gfx7_format_needs_valign2(const struct isl_device *dev,
29                          enum isl_format format)
30{
31   assert(ISL_GFX_VER(dev) == 7);
32
33   /* From the Ivybridge PRM (2012-05-31), Volume 4, Part 1, Section 2.12.1,
34    * RENDER_SURFACE_STATE Surface Vertical Alignment:
35    *
36    *    - Value of 1 [VALIGN_4] is not supported for format YCRCB_NORMAL
37    *      (0x182), YCRCB_SWAPUVY (0x183), YCRCB_SWAPUV (0x18f), YCRCB_SWAPY
38    *      (0x190)
39    *
40    *    - VALIGN_4 is not supported for surface format R32G32B32_FLOAT.
41    *
42    * The R32G32B32_FLOAT restriction is dropped on Haswell.
43    */
44   return isl_format_is_yuv(format) ||
45          (format == ISL_FORMAT_R32G32B32_FLOAT && !ISL_DEV_IS_HASWELL(dev));
46}
47
48bool
49isl_gfx7_choose_msaa_layout(const struct isl_device *dev,
50                            const struct isl_surf_init_info *info,
51                            enum isl_tiling tiling,
52                            enum isl_msaa_layout *msaa_layout)
53{
54   bool require_array = false;
55   bool require_interleaved = false;
56
57   assert(ISL_GFX_VER(dev) == 7);
58   assert(info->samples >= 1);
59
60   if (info->samples == 1) {
61      *msaa_layout = ISL_MSAA_LAYOUT_NONE;
62      return true;
63   }
64
65   if (!isl_format_supports_multisampling(dev->info, info->format))
66      return false;
67
68   /* From the Ivybridge PRM, Volume 4 Part 1 p73, SURFACE_STATE, Number of
69    * Multisamples:
70    *
71    *    - If this field is any value other than MULTISAMPLECOUNT_1, the
72    *      Surface Type must be SURFTYPE_2D.
73    *
74    *    - If this field is any value other than MULTISAMPLECOUNT_1, Surface
75    *      Min LOD, Mip Count / LOD, and Resource Min LOD must be set to zero
76    */
77   if (info->dim != ISL_SURF_DIM_2D)
78      return false;
79   if (info->levels > 1)
80      return false;
81
82   /* The Ivyrbridge PRM insists twice that signed integer formats cannot be
83    * multisampled.
84    *
85    * From the Ivybridge PRM, Volume 4 Part 1 p73, SURFACE_STATE, Number of
86    * Multisamples:
87    *
88    *    - This field must be set to MULTISAMPLECOUNT_1 for SINT MSRTs when
89    *      all RT channels are not written.
90    *
91    * And errata from the Ivybridge PRM, Volume 4 Part 1 p77,
92    * RENDER_SURFACE_STATE, MCS Enable:
93    *
94    *   This field must be set to 0 [MULTISAMPLECOUNT_1] for all SINT MSRTs
95    *   when all RT channels are not written.
96    *
97    * Note that the above SINT restrictions apply only to *MSRTs* (that is,
98    * *multisampled* render targets). The restrictions seem to permit an MCS
99    * if the render target is singlesampled.
100    *
101    * Moreover, empirically it looks that hardware can render multisampled
102    * surfaces with RGBA8I, RGBA16I and RGBA32I.
103    */
104
105   /* Multisampling requires vertical alignment of four. */
106   if (info->samples > 1 && gfx7_format_needs_valign2(dev, info->format))
107      return false;
108
109   /* More obvious restrictions */
110   if (isl_surf_usage_is_display(info->usage))
111      return false;
112   if (tiling == ISL_TILING_LINEAR)
113      return false;
114
115   /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
116    * Surface Storage Format:
117    *
118    *    +---------------------+----------------------------------------------------------------+
119    *    | MSFMT_MSS           | Multsampled surface was/is rendered as a render target         |
120    *    | MSFMT_DEPTH_STENCIL | Multisampled surface was rendered as a depth or stencil buffer |
121    *    +---------------------+----------------------------------------------------------------+
122    *
123    * In the table above, MSFMT_MSS refers to ISL_MSAA_LAYOUT_ARRAY, and
124    * MSFMT_DEPTH_STENCIL refers to ISL_MSAA_LAYOUT_INTERLEAVED.
125    */
126   if (isl_surf_usage_is_depth_or_stencil(info->usage) ||
127       (info->usage & ISL_SURF_USAGE_HIZ_BIT))
128      require_interleaved = true;
129
130   /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
131    * Surface Storage Format:
132    *
133    *    If the surface’s Number of Multisamples is MULTISAMPLECOUNT_8, Width
134    *    is >= 8192 (meaning the actual surface width is >= 8193 pixels), this
135    *    field must be set to MSFMT_MSS.
136    */
137   if (info->samples == 8 && info->width > 8192)
138      require_array = true;
139
140   /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
141    * Surface Storage Format:
142    *
143    *    If the surface’s Number of Multisamples is MULTISAMPLECOUNT_8,
144    *    ((Depth+1) * (Height+1)) is > 4,194,304, OR if the surface’s Number
145    *    of Multisamples is MULTISAMPLECOUNT_4, ((Depth+1) * (Height+1)) is
146    *    > 8,388,608, this field must be set to MSFMT_DEPTH_STENCIL.
147    */
148   if ((info->samples == 8 && info->height > 4194304u) ||
149       (info->samples == 4 && info->height > 8388608u))
150      require_interleaved = true;
151
152   /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
153    * Surface Storage Format:
154    *
155    *    This field must be set to MSFMT_DEPTH_STENCIL if Surface Format is
156    *    one of the following: I24X8_UNORM, L24X8_UNORM, A24X8_UNORM, or
157    *    R24_UNORM_X8_TYPELESS.
158    */
159   if (info->format == ISL_FORMAT_I24X8_UNORM ||
160       info->format == ISL_FORMAT_L24X8_UNORM ||
161       info->format == ISL_FORMAT_A24X8_UNORM ||
162       info->format == ISL_FORMAT_R24_UNORM_X8_TYPELESS)
163      require_interleaved = true;
164
165   if (require_array && require_interleaved)
166      return false;
167
168   if (require_interleaved) {
169      *msaa_layout = ISL_MSAA_LAYOUT_INTERLEAVED;
170      return true;
171   }
172
173   /* Default to the array layout because it permits multisample
174    * compression.
175    */
176   *msaa_layout = ISL_MSAA_LAYOUT_ARRAY;
177   return true;
178}
179
180/**
181 * @brief Filter out tiling flags that are incompatible with the surface.
182 *
183 * The resultant outgoing @a flags is a subset of the incoming @a flags. The
184 * outgoing flags may be empty (0x0) if the incoming flags were too
185 * restrictive.
186 *
187 * For example, if the surface will be used for a display
188 * (ISL_SURF_USAGE_DISPLAY_BIT), then this function filters out all tiling
189 * flags except ISL_TILING_X_BIT and ISL_TILING_LINEAR_BIT.
190 */
191void
192isl_gfx6_filter_tiling(const struct isl_device *dev,
193                       const struct isl_surf_init_info *restrict info,
194                       isl_tiling_flags_t *flags)
195{
196   /* IVB+ requires separate stencil */
197   assert(ISL_DEV_USE_SEPARATE_STENCIL(dev));
198
199   /* Clear flags unsupported on this hardware */
200   assert(ISL_GFX_VERX10(dev) < 125);
201   if (ISL_GFX_VER(dev) >= 12) {
202      *flags &= ISL_TILING_LINEAR_BIT |
203                ISL_TILING_X_BIT |
204                ISL_TILING_ANY_Y_MASK;
205   } else if (ISL_GFX_VER(dev) >= 9) {
206      *flags &= ISL_TILING_LINEAR_BIT |
207                ISL_TILING_X_BIT |
208                ISL_TILING_W_BIT |
209                ISL_TILING_ANY_Y_MASK;
210   } else {
211      *flags &= ISL_TILING_LINEAR_BIT |
212                ISL_TILING_X_BIT |
213                ISL_TILING_W_BIT |
214                ISL_TILING_Y0_BIT;
215   }
216
217   /* And... clear the Yf and Ys bits anyway because Anvil doesn't support
218    * them yet.
219    */
220   *flags &= ~ISL_TILING_Yf_BIT; /* FINISHME[SKL]: Support Yf */
221   *flags &= ~ISL_TILING_Ys_BIT; /* FINISHME[SKL]: Support Ys */
222
223   if (isl_surf_usage_is_depth(info->usage)) {
224      /* Depth requires Y. */
225      *flags &= ISL_TILING_ANY_Y_MASK;
226   }
227
228   if (isl_surf_usage_is_stencil(info->usage)) {
229      if (ISL_GFX_VER(dev) >= 12) {
230         /* Stencil requires Y. */
231         *flags &= ISL_TILING_ANY_Y_MASK;
232      } else {
233         /* Stencil requires W. */
234         *flags &= ISL_TILING_W_BIT;
235      }
236   } else {
237      *flags &= ~ISL_TILING_W_BIT;
238   }
239
240   /* MCS buffers are always Y-tiled */
241   if (isl_format_get_layout(info->format)->txc == ISL_TXC_MCS)
242      *flags &= ISL_TILING_Y0_BIT;
243
244   if (info->usage & ISL_SURF_USAGE_DISPLAY_BIT) {
245      if (ISL_GFX_VER(dev) >= 12) {
246         *flags &= (ISL_TILING_LINEAR_BIT | ISL_TILING_X_BIT |
247                    ISL_TILING_Y0_BIT);
248      } else if (ISL_GFX_VER(dev) >= 9) {
249         /* Note we let Yf even though it was cleared above. This is just for
250          * completeness.
251          */
252         *flags &= (ISL_TILING_LINEAR_BIT | ISL_TILING_X_BIT |
253                    ISL_TILING_Y0_BIT | ISL_TILING_Yf_BIT);
254      } else {
255         /* Before Skylake, the display engine does not accept Y */
256         *flags &= (ISL_TILING_LINEAR_BIT | ISL_TILING_X_BIT);
257      }
258   }
259
260   if (info->samples > 1) {
261      /* From the Sandybridge PRM, Volume 4 Part 1, SURFACE_STATE Tiled
262       * Surface:
263       *
264       *   For multisample render targets, this field must be 1 (true). MSRTs
265       *   can only be tiled.
266       *
267       * From the Broadwell PRM >> Volume2d: Command Structures >>
268       * RENDER_SURFACE_STATE Tile Mode:
269       *
270       *   If Number of Multisamples is not MULTISAMPLECOUNT_1, this field
271       *   must be YMAJOR.
272       *
273       * As usual, though, stencil is special and requires W-tiling.
274       */
275      *flags &= (ISL_TILING_ANY_Y_MASK | ISL_TILING_W_BIT);
276   }
277
278   /* workaround */
279   if (ISL_GFX_VER(dev) == 7 &&
280       gfx7_format_needs_valign2(dev, info->format) &&
281       (info->usage & ISL_SURF_USAGE_RENDER_TARGET_BIT) &&
282       info->samples == 1) {
283      /* Y tiling is illegal. From the Ivybridge PRM, Vol4 Part1 2.12.2.1,
284       * SURFACE_STATE Surface Vertical Alignment:
285       *
286       *     This field must be set to VALIGN_4 for all tiled Y Render Target
287       *     surfaces.
288       */
289      *flags &= ~ISL_TILING_Y0_BIT;
290   }
291
292   /* From the Sandybridge PRM, Volume 1, Part 2, page 32:
293    *
294    *    "NOTE: 128BPE Format Color Buffer ( render target ) MUST be either
295    *     TileX or Linear."
296    *
297    * This is necessary all the way back to 965, but is permitted on Gfx7+.
298    */
299   if (ISL_GFX_VER(dev) < 7 && isl_format_get_layout(info->format)->bpb >= 128)
300      *flags &= ~ISL_TILING_Y0_BIT;
301
302   /* From the BDW and SKL PRMs, Volume 2d,
303    * RENDER_SURFACE_STATE::Width - Programming Notes:
304    *
305    *   A known issue exists if a primitive is rendered to the first 2 rows and
306    *   last 2 columns of a 16K width surface. If any geometry is drawn inside
307    *   this square it will be copied to column X=2 and X=3 (arrangement on Y
308    *   position will stay the same). If any geometry exceeds the boundaries of
309    *   this 2x2 region it will be drawn normally. The issue also only occurs
310    *   if the surface has TileMode != Linear.
311    *
312    * [Internal documentation notes that this issue isn't present on SKL GT4.]
313    * To prevent this rendering corruption, only allow linear tiling for
314    * surfaces with widths greater than 16K-2 pixels.
315    *
316    * TODO: Is this an issue for multisampled surfaces as well?
317    */
318   if (info->width > 16382 && info->samples == 1 &&
319       info->usage & ISL_SURF_USAGE_RENDER_TARGET_BIT &&
320       (ISL_GFX_VER(dev) == 8 ||
321        (dev->info->platform == INTEL_PLATFORM_SKL && dev->info->gt != 4))) {
322          *flags &= ISL_TILING_LINEAR_BIT;
323   }
324}
325
326void
327isl_gfx7_choose_image_alignment_el(const struct isl_device *dev,
328                                   const struct isl_surf_init_info *restrict info,
329                                   enum isl_tiling tiling,
330                                   enum isl_dim_layout dim_layout,
331                                   enum isl_msaa_layout msaa_layout,
332                                   struct isl_extent3d *image_align_el)
333{
334   assert(ISL_GFX_VER(dev) == 7);
335
336   /* Handled by isl_choose_image_alignment_el */
337   assert(info->format != ISL_FORMAT_HIZ);
338
339   /* IVB+ does not support combined depthstencil. */
340   assert(!isl_surf_usage_is_depth_and_stencil(info->usage));
341
342   /* From the Ivy Bridge PRM, Vol. 2, Part 2, Section 6.18.4.4,
343    * "Alignment unit size", the alignment parameters are summarized in the
344    * following table:
345    *
346    *     Surface Defined By | Surface Format  | Align Width | Align Height
347    *    --------------------+-----------------+-------------+--------------
348    *       DEPTH_BUFFER     |   D16_UNORM     |      8      |      4
349    *                        |     other       |      4      |      4
350    *    --------------------+-----------------+-------------+--------------
351    *       STENCIL_BUFFER   |      N/A        |      8      |      8
352    *    --------------------+-----------------+-------------+--------------
353    *       SURFACE_STATE    | BC*, ETC*, EAC* |      4      |      4
354    *                        |      FXT1       |      8      |      4
355    *                        |   all others    |   HALIGN    |   VALIGN
356    *    -------------------------------------------------------------------
357    */
358   if (isl_surf_usage_is_depth(info->usage)) {
359      *image_align_el = info->format == ISL_FORMAT_R16_UNORM ?
360                        isl_extent3d(8, 4, 1) : isl_extent3d(4, 4, 1);
361      return;
362   } else if (isl_surf_usage_is_stencil(info->usage)) {
363      *image_align_el = isl_extent3d(8, 8, 1);
364      return;
365   } else if (isl_format_is_compressed(info->format)) {
366      /* Compressed formats all have alignment equal to block size. */
367      *image_align_el = isl_extent3d(1, 1, 1);
368      return;
369   }
370
371   /* Everything after this point is in the "set by Surface Horizontal or
372    * Vertical Alignment" case.  Now it's just a matter of applying
373    * restrictions.
374    */
375
376   /* There are no restrictions on halign beyond what's given in the table
377    * above.  We set it to the minimum value of 4 because that uses the least
378    * memory.
379    */
380   const uint32_t halign = 4;
381
382   bool require_valign4 = false;
383
384   /* From the Ivybridge PRM, Volume 4, Part 1, Section 2.12.1:
385    * RENDER_SURFACE_STATE Surface Vertical Alignment:
386    *
387    *    * This field is intended to be set to VALIGN_4 if the surface was
388    *      rendered as a depth buffer,
389    *
390    *    * for a multisampled (4x) render target, or for a multisampled (8x)
391    *      render target, since these surfaces support only alignment of 4.
392    *
393    *    * This field must be set to VALIGN_4 for all tiled Y Render Target
394    *      surfaces
395    *
396    *    * Value of 1 is not supported for format YCRCB_NORMAL (0x182),
397    *      YCRCB_SWAPUVY (0x183), YCRCB_SWAPUV (0x18f), YCRCB_SWAPY (0x190)
398    *
399    *    * If Number of Multisamples is not MULTISAMPLECOUNT_1, this field
400    *      must be set to VALIGN_4."
401    *
402    * The first restriction is already handled by the table above and the
403    * second restriction is redundant with the fifth.
404    */
405   if (info->samples > 1)
406      require_valign4 = true;
407
408   if (tiling == ISL_TILING_Y0 &&
409       (info->usage & ISL_SURF_USAGE_RENDER_TARGET_BIT))
410      require_valign4 = true;
411
412   assert(!(require_valign4 && gfx7_format_needs_valign2(dev, info->format)));
413
414   /* We default to VALIGN_2 because it uses the least memory. */
415   const uint32_t valign = require_valign4 ? 4 : 2;
416
417   *image_align_el = isl_extent3d(halign, valign, 1);
418}
419