anv/gen10: Implement WaSampleOffsetIZ workaround
[mesa.git] / src / intel / vulkan / genX_state.c
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 <assert.h>
25 #include <stdbool.h>
26 #include <string.h>
27 #include <unistd.h>
28 #include <fcntl.h>
29
30 #include "anv_private.h"
31
32 #include "common/gen_sample_positions.h"
33 #include "genxml/gen_macros.h"
34 #include "genxml/genX_pack.h"
35
36 #include "vk_util.h"
37
38 #if GEN_GEN == 10
39 /**
40 * From Gen10 Workarounds page in h/w specs:
41 * WaSampleOffsetIZ:
42 * "Prior to the 3DSTATE_SAMPLE_PATTERN driver must ensure there are no
43 * markers in the pipeline by programming a PIPE_CONTROL with stall."
44 */
45 static void
46 gen10_emit_wa_cs_stall_flush(struct anv_batch *batch)
47 {
48
49 anv_batch_emit(batch, GENX(PIPE_CONTROL), pc) {
50 pc.CommandStreamerStallEnable = true;
51 pc.StallAtPixelScoreboard = true;
52 }
53 }
54
55 /**
56 * From Gen10 Workarounds page in h/w specs:
57 * WaSampleOffsetIZ:_cs_stall_flush
58 * "When 3DSTATE_SAMPLE_PATTERN is programmed, driver must then issue an
59 * MI_LOAD_REGISTER_IMM command to an offset between 0x7000 and 0x7FFF(SVL)
60 * after the command to ensure the state has been delivered prior to any
61 * command causing a marker in the pipeline."
62 */
63 static void
64 gen10_emit_wa_lri_to_cache_mode_zero(struct anv_batch *batch)
65 {
66 /* Before changing the value of CACHE_MODE_0 register, GFX pipeline must
67 * be idle; i.e., full flush is required.
68 */
69 anv_batch_emit(batch, GENX(PIPE_CONTROL), pc) {
70 pc.DepthCacheFlushEnable = true;
71 pc.DCFlushEnable = true;
72 pc.RenderTargetCacheFlushEnable = true;
73 pc.InstructionCacheInvalidateEnable = true;
74 pc.StateCacheInvalidationEnable = true;
75 pc.TextureCacheInvalidationEnable = true;
76 pc.VFCacheInvalidationEnable = true;
77 pc.ConstantCacheInvalidationEnable =true;
78 }
79
80 /* Write to CACHE_MODE_0 (0x7000) */
81 uint32_t cache_mode_0 = 0;
82 anv_pack_struct(&cache_mode_0, GENX(CACHE_MODE_0));
83
84 anv_batch_emit(batch, GENX(MI_LOAD_REGISTER_IMM), lri) {
85 lri.RegisterOffset = GENX(CACHE_MODE_0_num);
86 lri.DataDWord = cache_mode_0;
87 }
88 }
89 #endif
90
91 VkResult
92 genX(init_device_state)(struct anv_device *device)
93 {
94 GENX(MEMORY_OBJECT_CONTROL_STATE_pack)(NULL, &device->default_mocs,
95 &GENX(MOCS));
96
97 struct anv_batch batch;
98
99 uint32_t cmds[64];
100 batch.start = batch.next = cmds;
101 batch.end = (void *) cmds + sizeof(cmds);
102
103 anv_batch_emit(&batch, GENX(PIPELINE_SELECT), ps) {
104 #if GEN_GEN >= 9
105 ps.MaskBits = 3;
106 #endif
107 ps.PipelineSelection = _3D;
108 }
109
110 #if GEN_GEN == 9
111 uint32_t cache_mode_1;
112 anv_pack_struct(&cache_mode_1, GENX(CACHE_MODE_1),
113 .FloatBlendOptimizationEnable = true,
114 .FloatBlendOptimizationEnableMask = true,
115 .PartialResolveDisableInVC = true,
116 .PartialResolveDisableInVCMask = true);
117
118 anv_batch_emit(&batch, GENX(MI_LOAD_REGISTER_IMM), lri) {
119 lri.RegisterOffset = GENX(CACHE_MODE_1_num);
120 lri.DataDWord = cache_mode_1;
121 }
122 #endif
123
124 anv_batch_emit(&batch, GENX(3DSTATE_AA_LINE_PARAMETERS), aa);
125
126 anv_batch_emit(&batch, GENX(3DSTATE_DRAWING_RECTANGLE), rect) {
127 rect.ClippedDrawingRectangleYMin = 0;
128 rect.ClippedDrawingRectangleXMin = 0;
129 rect.ClippedDrawingRectangleYMax = UINT16_MAX;
130 rect.ClippedDrawingRectangleXMax = UINT16_MAX;
131 rect.DrawingRectangleOriginY = 0;
132 rect.DrawingRectangleOriginX = 0;
133 }
134
135 #if GEN_GEN >= 8
136 anv_batch_emit(&batch, GENX(3DSTATE_WM_CHROMAKEY), ck);
137
138 #if GEN_GEN == 10
139 gen10_emit_wa_cs_stall_flush(&batch);
140 #endif
141
142 /* See the Vulkan 1.0 spec Table 24.1 "Standard sample locations" and
143 * VkPhysicalDeviceFeatures::standardSampleLocations.
144 */
145 anv_batch_emit(&batch, GENX(3DSTATE_SAMPLE_PATTERN), sp) {
146 GEN_SAMPLE_POS_1X(sp._1xSample);
147 GEN_SAMPLE_POS_2X(sp._2xSample);
148 GEN_SAMPLE_POS_4X(sp._4xSample);
149 GEN_SAMPLE_POS_8X(sp._8xSample);
150 #if GEN_GEN >= 9
151 GEN_SAMPLE_POS_16X(sp._16xSample);
152 #endif
153 }
154 #endif
155
156 #if GEN_GEN == 10
157 gen10_emit_wa_lri_to_cache_mode_zero(&batch);
158 #endif
159
160 anv_batch_emit(&batch, GENX(MI_BATCH_BUFFER_END), bbe);
161
162 assert(batch.next <= batch.end);
163
164 return anv_device_submit_simple_batch(device, &batch);
165 }
166
167 static uint32_t
168 vk_to_gen_tex_filter(VkFilter filter, bool anisotropyEnable)
169 {
170 switch (filter) {
171 default:
172 assert(!"Invalid filter");
173 case VK_FILTER_NEAREST:
174 return anisotropyEnable ? MAPFILTER_ANISOTROPIC : MAPFILTER_NEAREST;
175 case VK_FILTER_LINEAR:
176 return anisotropyEnable ? MAPFILTER_ANISOTROPIC : MAPFILTER_LINEAR;
177 }
178 }
179
180 static uint32_t
181 vk_to_gen_max_anisotropy(float ratio)
182 {
183 return (anv_clamp_f(ratio, 2, 16) - 2) / 2;
184 }
185
186 static const uint32_t vk_to_gen_mipmap_mode[] = {
187 [VK_SAMPLER_MIPMAP_MODE_NEAREST] = MIPFILTER_NEAREST,
188 [VK_SAMPLER_MIPMAP_MODE_LINEAR] = MIPFILTER_LINEAR
189 };
190
191 static const uint32_t vk_to_gen_tex_address[] = {
192 [VK_SAMPLER_ADDRESS_MODE_REPEAT] = TCM_WRAP,
193 [VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT] = TCM_MIRROR,
194 [VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE] = TCM_CLAMP,
195 [VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE] = TCM_MIRROR_ONCE,
196 [VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER] = TCM_CLAMP_BORDER,
197 };
198
199 /* Vulkan specifies the result of shadow comparisons as:
200 * 1 if ref <op> texel,
201 * 0 otherwise.
202 *
203 * The hardware does:
204 * 0 if texel <op> ref,
205 * 1 otherwise.
206 *
207 * So, these look a bit strange because there's both a negation
208 * and swapping of the arguments involved.
209 */
210 static const uint32_t vk_to_gen_shadow_compare_op[] = {
211 [VK_COMPARE_OP_NEVER] = PREFILTEROPALWAYS,
212 [VK_COMPARE_OP_LESS] = PREFILTEROPLEQUAL,
213 [VK_COMPARE_OP_EQUAL] = PREFILTEROPNOTEQUAL,
214 [VK_COMPARE_OP_LESS_OR_EQUAL] = PREFILTEROPLESS,
215 [VK_COMPARE_OP_GREATER] = PREFILTEROPGEQUAL,
216 [VK_COMPARE_OP_NOT_EQUAL] = PREFILTEROPEQUAL,
217 [VK_COMPARE_OP_GREATER_OR_EQUAL] = PREFILTEROPGREATER,
218 [VK_COMPARE_OP_ALWAYS] = PREFILTEROPNEVER,
219 };
220
221 VkResult genX(CreateSampler)(
222 VkDevice _device,
223 const VkSamplerCreateInfo* pCreateInfo,
224 const VkAllocationCallbacks* pAllocator,
225 VkSampler* pSampler)
226 {
227 ANV_FROM_HANDLE(anv_device, device, _device);
228 struct anv_sampler *sampler;
229
230 assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO);
231
232 sampler = vk_zalloc2(&device->alloc, pAllocator, sizeof(*sampler), 8,
233 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
234 if (!sampler)
235 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
236
237 sampler->n_planes = 1;
238
239 uint32_t border_color_offset = device->border_colors.offset +
240 pCreateInfo->borderColor * 64;
241
242 vk_foreach_struct(ext, pCreateInfo->pNext) {
243 switch (ext->sType) {
244 case VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_INFO_KHR: {
245 VkSamplerYcbcrConversionInfoKHR *pSamplerConversion =
246 (VkSamplerYcbcrConversionInfoKHR *) ext;
247 ANV_FROM_HANDLE(anv_ycbcr_conversion, conversion,
248 pSamplerConversion->conversion);
249
250 if (conversion == NULL)
251 break;
252
253 sampler->n_planes = conversion->format->n_planes;
254 sampler->conversion = conversion;
255 break;
256 }
257 default:
258 anv_debug_ignored_stype(ext->sType);
259 break;
260 }
261 }
262
263 for (unsigned p = 0; p < sampler->n_planes; p++) {
264 const bool plane_has_chroma =
265 sampler->conversion && sampler->conversion->format->planes[p].has_chroma;
266 const VkFilter min_filter =
267 plane_has_chroma ? sampler->conversion->chroma_filter : pCreateInfo->minFilter;
268 const VkFilter mag_filter =
269 plane_has_chroma ? sampler->conversion->chroma_filter : pCreateInfo->magFilter;
270 const bool enable_min_filter_addr_rounding = min_filter != VK_FILTER_NEAREST;
271 const bool enable_mag_filter_addr_rounding = mag_filter != VK_FILTER_NEAREST;
272 /* From Broadwell PRM, SAMPLER_STATE:
273 * "Mip Mode Filter must be set to MIPFILTER_NONE for Planar YUV surfaces."
274 */
275 const uint32_t mip_filter_mode =
276 (sampler->conversion &&
277 isl_format_is_yuv(sampler->conversion->format->planes[0].isl_format)) ?
278 MIPFILTER_NONE : vk_to_gen_mipmap_mode[pCreateInfo->mipmapMode];
279
280 struct GENX(SAMPLER_STATE) sampler_state = {
281 .SamplerDisable = false,
282 .TextureBorderColorMode = DX10OGL,
283
284 #if GEN_GEN >= 8
285 .LODPreClampMode = CLAMP_MODE_OGL,
286 #else
287 .LODPreClampEnable = CLAMP_ENABLE_OGL,
288 #endif
289
290 #if GEN_GEN == 8
291 .BaseMipLevel = 0.0,
292 #endif
293 .MipModeFilter = mip_filter_mode,
294 .MagModeFilter = vk_to_gen_tex_filter(mag_filter, pCreateInfo->anisotropyEnable),
295 .MinModeFilter = vk_to_gen_tex_filter(min_filter, pCreateInfo->anisotropyEnable),
296 .TextureLODBias = anv_clamp_f(pCreateInfo->mipLodBias, -16, 15.996),
297 .AnisotropicAlgorithm = EWAApproximation,
298 .MinLOD = anv_clamp_f(pCreateInfo->minLod, 0, 14),
299 .MaxLOD = anv_clamp_f(pCreateInfo->maxLod, 0, 14),
300 .ChromaKeyEnable = 0,
301 .ChromaKeyIndex = 0,
302 .ChromaKeyMode = 0,
303 .ShadowFunction = vk_to_gen_shadow_compare_op[pCreateInfo->compareOp],
304 .CubeSurfaceControlMode = OVERRIDE,
305
306 .BorderColorPointer = border_color_offset,
307
308 #if GEN_GEN >= 8
309 .LODClampMagnificationMode = MIPNONE,
310 #endif
311
312 .MaximumAnisotropy = vk_to_gen_max_anisotropy(pCreateInfo->maxAnisotropy),
313 .RAddressMinFilterRoundingEnable = enable_min_filter_addr_rounding,
314 .RAddressMagFilterRoundingEnable = enable_mag_filter_addr_rounding,
315 .VAddressMinFilterRoundingEnable = enable_min_filter_addr_rounding,
316 .VAddressMagFilterRoundingEnable = enable_mag_filter_addr_rounding,
317 .UAddressMinFilterRoundingEnable = enable_min_filter_addr_rounding,
318 .UAddressMagFilterRoundingEnable = enable_mag_filter_addr_rounding,
319 .TrilinearFilterQuality = 0,
320 .NonnormalizedCoordinateEnable = pCreateInfo->unnormalizedCoordinates,
321 .TCXAddressControlMode = vk_to_gen_tex_address[pCreateInfo->addressModeU],
322 .TCYAddressControlMode = vk_to_gen_tex_address[pCreateInfo->addressModeV],
323 .TCZAddressControlMode = vk_to_gen_tex_address[pCreateInfo->addressModeW],
324 };
325
326 GENX(SAMPLER_STATE_pack)(NULL, sampler->state[p], &sampler_state);
327 }
328
329 *pSampler = anv_sampler_to_handle(sampler);
330
331 return VK_SUCCESS;
332 }