2 * Copyright 2015 Intel Corporation
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:
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
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
28 gen7_choose_msaa_layout(const struct isl_device
*dev
,
29 const struct isl_surf_init_info
*info
,
30 enum isl_tiling tiling
,
31 enum isl_msaa_layout
*msaa_layout
)
33 const struct isl_format_layout
*fmtl
= isl_format_get_layout(info
->format
);
35 bool require_array
= false;
36 bool require_interleaved
= false;
38 assert(ISL_DEV_GEN(dev
) == 7);
39 assert(info
->samples
>= 1);
41 if (info
->samples
== 1) {
42 *msaa_layout
= ISL_MSAA_LAYOUT_NONE
;
46 /* From the Ivybridge PRM, Volume 4 Part 1 p63, SURFACE_STATE, Surface
49 * If Number of Multisamples is set to a value other than
50 * MULTISAMPLECOUNT_1, this field cannot be set to the following
51 * formats: any format with greater than 64 bits per element, any
52 * compressed texture format (BC*), and any YCRCB* format.
56 if (isl_format_is_compressed(info
->format
))
58 if (isl_format_is_yuv(info
->format
))
61 /* From the Ivybridge PRM, Volume 4 Part 1 p73, SURFACE_STATE, Number of
64 * - If this field is any value other than MULTISAMPLECOUNT_1, the
65 * Surface Type must be SURFTYPE_2D.
67 * - If this field is any value other than MULTISAMPLECOUNT_1, Surface
68 * Min LOD, Mip Count / LOD, and Resource Min LOD must be set to zero
70 if (info
->dim
!= ISL_SURF_DIM_2D
)
75 /* The Ivyrbridge PRM insists twice that signed integer formats cannot be
78 * From the Ivybridge PRM, Volume 4 Part 1 p73, SURFACE_STATE, Number of
81 * - This field must be set to MULTISAMPLECOUNT_1 for SINT MSRTs when
82 * all RT channels are not written.
84 * And errata from the Ivybridge PRM, Volume 4 Part 1 p77,
85 * RENDER_SURFACE_STATE, MCS Enable:
87 * This field must be set to 0 [MULTISAMPLECOUNT_1] for all SINT MSRTs
88 * when all RT channels are not written.
90 * Note that the above SINT restrictions apply only to *MSRTs* (that is,
91 * *multisampled* render targets). The restrictions seem to permit an MCS
92 * if the render target is singlesampled.
94 if (isl_format_has_sint_channel(info
->format
))
97 /* More obvious restrictions */
98 if (isl_surf_usage_is_display(info
->usage
))
100 if (tiling
== ISL_TILING_LINEAR
)
103 /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
104 * Suface Storage Format:
106 * +---------------------+----------------------------------------------------------------+
107 * | MSFMT_MSS | Multsampled surface was/is rendered as a render target |
108 * | MSFMT_DEPTH_STENCIL | Multisampled surface was rendered as a depth or stencil buffer |
109 * +---------------------+----------------------------------------------------------------+
111 * In the table above, MSFMT_MSS refers to ISL_MSAA_LAYOUT_ARRAY, and
112 * MSFMT_DEPTH_STENCIL refers to ISL_MSAA_LAYOUT_INTERLEAVED.
114 if (isl_surf_usage_is_depth_or_stencil(info
->usage
) ||
115 (info
->usage
& ISL_SURF_USAGE_HIZ_BIT
))
116 require_interleaved
= true;
118 /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
119 * Suface Storage Format:
121 * If the surface’s Number of Multisamples is MULTISAMPLECOUNT_8, Width
122 * is >= 8192 (meaning the actual surface width is >= 8193 pixels), this
123 * field must be set to MSFMT_MSS.
125 if (info
->samples
== 8 && info
->width
== 8192)
126 require_array
= true;
128 /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
129 * Suface Storage Format:
131 * If the surface’s Number of Multisamples is MULTISAMPLECOUNT_8,
132 * ((Depth+1) * (Height+1)) is > 4,194,304, OR if the surface’s Number
133 * of Multisamples is MULTISAMPLECOUNT_4, ((Depth+1) * (Height+1)) is
134 * > 8,388,608, this field must be set to MSFMT_DEPTH_STENCIL.
136 if ((info
->samples
== 8 && info
->height
> 4194304u) ||
137 (info
->samples
== 4 && info
->height
> 8388608u))
138 require_interleaved
= true;
140 /* From the Ivybridge PRM, Volume 4 Part 1 p72, SURFACE_STATE, Multisampled
141 * Suface Storage Format:
143 * This field must be set to MSFMT_DEPTH_STENCIL if Surface Format is
144 * one of the following: I24X8_UNORM, L24X8_UNORM, A24X8_UNORM, or
145 * R24_UNORM_X8_TYPELESS.
147 if (info
->format
== ISL_FORMAT_I24X8_UNORM
||
148 info
->format
== ISL_FORMAT_L24X8_UNORM
||
149 info
->format
== ISL_FORMAT_A24X8_UNORM
||
150 info
->format
== ISL_FORMAT_R24_UNORM_X8_TYPELESS
)
151 require_interleaved
= true;
153 if (require_array
&& require_interleaved
)
156 if (require_interleaved
) {
157 *msaa_layout
= ISL_MSAA_LAYOUT_INTERLEAVED
;
161 /* Default to the array layout because it permits multisample
164 *msaa_layout
= ISL_MSAA_LAYOUT_ARRAY
;
169 gen7_format_needs_valign2(const struct isl_device
*dev
,
170 enum isl_format format
)
172 /* This workaround applies only to gen7 */
173 if (ISL_DEV_GEN(dev
) > 7)
176 /* From the Ivybridge PRM (2012-05-31), Volume 4, Part 1, Section 2.12.1,
177 * RENDER_SURFACE_STATE Surface Vertical Alignment:
179 * - Value of 1 [VALIGN_4] is not supported for format YCRCB_NORMAL
180 * (0x182), YCRCB_SWAPUVY (0x183), YCRCB_SWAPUV (0x18f), YCRCB_SWAPY
183 * - VALIGN_4 is not supported for surface format R32G32B32_FLOAT.
185 return isl_format_is_yuv(format
) ||
186 format
== ISL_FORMAT_R32G32B32_FLOAT
;
190 * @brief Filter out tiling flags that are incompatible with the surface.
192 * The resultant outgoing @a flags is a subset of the incoming @a flags. The
193 * outgoing flags may be empty (0x0) if the incoming flags were too
196 * For example, if the surface will be used for a display
197 * (ISL_SURF_USAGE_DISPLAY_BIT), then this function filters out all tiling
198 * flags except ISL_TILING_X_BIT and ISL_TILING_LINEAR_BIT.
201 gen7_filter_tiling(const struct isl_device
*dev
,
202 const struct isl_surf_init_info
*restrict info
,
203 isl_tiling_flags_t
*flags
)
205 /* IVB+ requires separate stencil */
206 assert(ISL_DEV_USE_SEPARATE_STENCIL(dev
));
208 /* Clear flags unsupported on this hardware */
209 if (ISL_DEV_GEN(dev
) < 9) {
210 *flags
&= ~ISL_TILING_Yf_BIT
;
211 *flags
&= ~ISL_TILING_Ys_BIT
;
214 /* And... clear the Yf and Ys bits anyway because Anvil doesn't support
217 *flags
&= ~ISL_TILING_Yf_BIT
; /* FINISHME[SKL]: Support Yf */
218 *flags
&= ~ISL_TILING_Ys_BIT
; /* FINISHME[SKL]: Support Ys */
220 if (isl_surf_usage_is_depth(info
->usage
)) {
221 /* Depth requires Y. */
222 *flags
&= ISL_TILING_ANY_Y_MASK
;
225 /* Separate stencil requires W tiling, and W tiling requires separate
228 if (isl_surf_usage_is_stencil(info
->usage
)) {
229 *flags
&= ISL_TILING_W_BIT
;
231 *flags
&= ~ISL_TILING_W_BIT
;
234 /* The HiZ format and tiling always go together */
235 if (info
->format
== ISL_FORMAT_HIZ
) {
236 *flags
&= ISL_TILING_HIZ_BIT
;
238 *flags
&= ~ISL_TILING_HIZ_BIT
;
241 if (info
->usage
& (ISL_SURF_USAGE_DISPLAY_ROTATE_90_BIT
|
242 ISL_SURF_USAGE_DISPLAY_ROTATE_180_BIT
|
243 ISL_SURF_USAGE_DISPLAY_ROTATE_270_BIT
)) {
244 assert(*flags
& ISL_SURF_USAGE_DISPLAY_BIT
);
245 isl_finishme("%s:%s: handle rotated display surfaces",
249 if (info
->usage
& (ISL_SURF_USAGE_DISPLAY_FLIP_X_BIT
|
250 ISL_SURF_USAGE_DISPLAY_FLIP_Y_BIT
)) {
251 assert(*flags
& ISL_SURF_USAGE_DISPLAY_BIT
);
252 isl_finishme("%s:%s: handle flipped display surfaces",
256 if (info
->usage
& ISL_SURF_USAGE_DISPLAY_BIT
) {
257 /* Before Skylake, the display engine does not accept Y */
258 /* FINISHME[SKL]: Y tiling for display surfaces */
259 *flags
&= (ISL_TILING_LINEAR_BIT
| ISL_TILING_X_BIT
);
262 if (info
->samples
> 1) {
263 /* From the Sandybridge PRM, Volume 4 Part 1, SURFACE_STATE Tiled
266 * For multisample render targets, this field must be 1 (true). MSRTs
269 * Multisample surfaces never require X tiling, and Y tiling generally
270 * performs better than X. So choose Y. (Unless it's stencil, then it
273 *flags
&= (ISL_TILING_ANY_Y_MASK
| ISL_TILING_W_BIT
);
277 if (ISL_DEV_GEN(dev
) == 7 &&
278 gen7_format_needs_valign2(dev
, info
->format
) &&
279 (info
->usage
& ISL_SURF_USAGE_RENDER_TARGET_BIT
) &&
280 info
->samples
== 1) {
281 /* Y tiling is illegal. From the Ivybridge PRM, Vol4 Part1 2.12.2.1,
282 * SURFACE_STATE Surface Vertical Alignment:
284 * This field must be set to VALIGN_4 for all tiled Y Render Target
287 *flags
&= ~ISL_TILING_Y0_BIT
;
292 * Choose horizontal subimage alignment, in units of surface elements.
295 gen7_choose_halign_el(const struct isl_device
*dev
,
296 const struct isl_surf_init_info
*restrict info
)
298 if (isl_format_is_compressed(info
->format
))
301 /* From the Ivybridge PRM (2012-05-31), Volume 4, Part 1, Section 2.12.1,
302 * RENDER_SURFACE_STATE Surface Hoizontal Alignment:
304 * - This field is intended to be set to HALIGN_8 only if the surface
305 * was rendered as a depth buffer with Z16 format or a stencil buffer,
306 * since these surfaces support only alignment of 8. Use of HALIGN_8
307 * for other surfaces is supported, but uses more memory.
309 if (isl_surf_info_is_z16(info
) ||
310 isl_surf_usage_is_stencil(info
->usage
))
317 * Choose vertical subimage alignment, in units of surface elements.
320 gen7_choose_valign_el(const struct isl_device
*dev
,
321 const struct isl_surf_init_info
*restrict info
,
322 enum isl_tiling tiling
)
324 MAYBE_UNUSED
bool require_valign2
= false;
325 bool require_valign4
= false;
327 if (isl_format_is_compressed(info
->format
))
330 if (gen7_format_needs_valign2(dev
, info
->format
))
331 require_valign2
= true;
333 /* From the Ivybridge PRM, Volume 4, Part 1, Section 2.12.1:
334 * RENDER_SURFACE_STATE Surface Vertical Alignment:
336 * - This field is intended to be set to VALIGN_4 if the surface was
337 * rendered as a depth buffer, for a multisampled (4x) render target,
338 * or for a multisampled (8x) render target, since these surfaces
339 * support only alignment of 4. Use of VALIGN_4 for other surfaces is
340 * supported, but uses more memory. This field must be set to
341 * VALIGN_4 for all tiled Y Render Target surfaces.
344 if (isl_surf_usage_is_depth(info
->usage
) ||
346 tiling
== ISL_TILING_Y0
) {
347 require_valign4
= true;
350 if (isl_surf_usage_is_stencil(info
->usage
)) {
351 /* The Ivybridge PRM states that the stencil buffer's vertical alignment
352 * is 8 [Ivybridge PRM, Volume 1, Part 1, Section 6.18.4.4 Alignment
353 * Unit Size]. However, valign=8 is outside the set of valid values of
354 * RENDER_SURFACE_STATE.SurfaceVerticalAlignment, which is VALIGN_2
355 * (0x0) and VALIGN_4 (0x1).
357 * The PRM is generally confused about the width, height, and alignment
358 * of the stencil buffer; and this confusion appears elsewhere. For
359 * example, the following PRM text effectively converts the stencil
360 * buffer's 8-pixel alignment to a 4-pixel alignment [Ivybridge PRM,
361 * Volume 1, Part 1, Section
362 * 6.18.4.2 Base Address and LOD Calculation]:
364 * For separate stencil buffer, the width must be mutiplied by 2 and
365 * height divided by 2 as follows:
367 * w_L = 2*i*ceil(W_L/i)
368 * h_L = 1/2*j*ceil(H_L/j)
370 * The root of the confusion is that, in W tiling, each pair of rows is
371 * interleaved into one.
373 * FINISHME(chadv): Decide to set valign=4 or valign=8 after isl's API
376 require_valign4
= true;
379 assert(!require_valign2
|| !require_valign4
);
384 /* Prefer VALIGN_2 because it conserves memory. */
389 gen7_choose_image_alignment_el(const struct isl_device
*dev
,
390 const struct isl_surf_init_info
*restrict info
,
391 enum isl_tiling tiling
,
392 enum isl_msaa_layout msaa_layout
,
393 struct isl_extent3d
*image_align_el
)
395 /* Handled by isl_choose_image_alignment_el */
396 assert(info
->format
!= ISL_FORMAT_HIZ
);
398 /* IVB+ does not support combined depthstencil. */
399 assert(!isl_surf_usage_is_depth_and_stencil(info
->usage
));
401 *image_align_el
= (struct isl_extent3d
) {
402 .w
= gen7_choose_halign_el(dev
, info
),
403 .h
= gen7_choose_valign_el(dev
, info
, tiling
),