i965/blorp: Explain why Z24 can't use a sensible format.
[mesa.git] / src / mesa / drivers / dri / i965 / brw_blorp.cpp
1 /*
2 * Copyright © 2012 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 "intel_batchbuffer.h"
25 #include "intel_fbo.h"
26
27 #include "brw_blorp.h"
28 #include "brw_defines.h"
29 #include "brw_state.h"
30 #include "gen6_blorp.h"
31 #include "gen7_blorp.h"
32
33 #define FILE_DEBUG_FLAG DEBUG_BLORP
34
35 brw_blorp_mip_info::brw_blorp_mip_info()
36 : mt(NULL),
37 level(0),
38 layer(0),
39 width(0),
40 height(0),
41 x_offset(0),
42 y_offset(0)
43 {
44 }
45
46 brw_blorp_surface_info::brw_blorp_surface_info()
47 : map_stencil_as_y_tiled(false),
48 num_samples(0)
49 {
50 }
51
52 void
53 brw_blorp_mip_info::set(struct intel_mipmap_tree *mt,
54 unsigned int level, unsigned int layer)
55 {
56 intel_miptree_check_level_layer(mt, level, layer);
57
58 this->mt = mt;
59 this->level = level;
60 this->layer = layer;
61 this->width = mt->level[level].width;
62 this->height = mt->level[level].height;
63
64 intel_miptree_get_image_offset(mt, level, layer, &x_offset, &y_offset);
65 }
66
67 void
68 brw_blorp_surface_info::set(struct brw_context *brw,
69 struct intel_mipmap_tree *mt,
70 unsigned int level, unsigned int layer,
71 bool is_render_target)
72 {
73 brw_blorp_mip_info::set(mt, level, layer);
74 this->num_samples = mt->num_samples;
75 this->array_spacing_lod0 = mt->array_spacing_lod0;
76 this->map_stencil_as_y_tiled = false;
77 this->msaa_layout = mt->msaa_layout;
78
79 switch (mt->format) {
80 case MESA_FORMAT_S8:
81 /* The miptree is a W-tiled stencil buffer. Surface states can't be set
82 * up for W tiling, so we'll need to use Y tiling and have the WM
83 * program swizzle the coordinates.
84 */
85 this->map_stencil_as_y_tiled = true;
86 this->brw_surfaceformat = BRW_SURFACEFORMAT_R8_UNORM;
87 break;
88 case MESA_FORMAT_X8_Z24:
89 /* It would make sense to use BRW_SURFACEFORMAT_R24_UNORM_X8_TYPELESS
90 * here, but unfortunately it isn't supported as a render target, which
91 * would prevent us from blitting to 24-bit depth.
92 *
93 * The miptree consists of 32 bits per pixel, arranged as 24-bit depth
94 * values interleaved with 8 "don't care" bits. Since depth values don't
95 * require any blending, it doesn't matter how we interpret the bit
96 * pattern as long as we copy the right amount of data, so just map it
97 * as 8-bit BGRA.
98 */
99 this->brw_surfaceformat = BRW_SURFACEFORMAT_B8G8R8A8_UNORM;
100 break;
101 case MESA_FORMAT_Z32_FLOAT:
102 this->brw_surfaceformat = BRW_SURFACEFORMAT_R32_FLOAT;
103 break;
104 case MESA_FORMAT_Z16:
105 this->brw_surfaceformat = BRW_SURFACEFORMAT_R16_UNORM;
106 break;
107 default:
108 if (is_render_target) {
109 assert(brw->format_supported_as_render_target[mt->format]);
110 this->brw_surfaceformat = brw->render_target_format[mt->format];
111 } else {
112 this->brw_surfaceformat = brw_format_for_mesa_format(mt->format);
113 }
114 break;
115 }
116 }
117
118
119 /**
120 * Split x_offset and y_offset into a base offset (in bytes) and a remaining
121 * x/y offset (in pixels). Note: we can't do this by calling
122 * intel_renderbuffer_tile_offsets(), because the offsets may have been
123 * adjusted to account for Y vs. W tiling differences. So we compute it
124 * directly from the adjusted offsets.
125 */
126 uint32_t
127 brw_blorp_surface_info::compute_tile_offsets(uint32_t *tile_x,
128 uint32_t *tile_y) const
129 {
130 struct intel_region *region = mt->region;
131 uint32_t mask_x, mask_y;
132
133 intel_region_get_tile_masks(region, &mask_x, &mask_y,
134 map_stencil_as_y_tiled);
135
136 *tile_x = x_offset & mask_x;
137 *tile_y = y_offset & mask_y;
138
139 return intel_region_get_aligned_offset(region, x_offset & ~mask_x,
140 y_offset & ~mask_y,
141 map_stencil_as_y_tiled);
142 }
143
144
145 brw_blorp_params::brw_blorp_params()
146 : x0(0),
147 y0(0),
148 x1(0),
149 y1(0),
150 depth_format(0),
151 hiz_op(GEN6_HIZ_OP_NONE),
152 fast_clear_op(GEN7_FAST_CLEAR_OP_NONE),
153 num_samples(0),
154 use_wm_prog(false)
155 {
156 color_write_disable[0] = false;
157 color_write_disable[1] = false;
158 color_write_disable[2] = false;
159 color_write_disable[3] = false;
160 }
161
162 extern "C" {
163 void
164 intel_hiz_exec(struct brw_context *brw, struct intel_mipmap_tree *mt,
165 unsigned int level, unsigned int layer, gen6_hiz_op op)
166 {
167 const char *opname = NULL;
168
169 switch (op) {
170 case GEN6_HIZ_OP_DEPTH_RESOLVE:
171 opname = "depth resolve";
172 break;
173 case GEN6_HIZ_OP_HIZ_RESOLVE:
174 opname = "hiz ambiguate";
175 break;
176 case GEN6_HIZ_OP_DEPTH_CLEAR:
177 opname = "depth clear";
178 break;
179 case GEN6_HIZ_OP_NONE:
180 opname = "noop?";
181 break;
182 }
183
184 DBG("%s %s to mt %p level %d layer %d\n",
185 __FUNCTION__, opname, mt, level, layer);
186
187 brw_hiz_op_params params(mt, level, layer, op);
188 brw_blorp_exec(brw, &params);
189 }
190
191 } /* extern "C" */
192
193 void
194 brw_blorp_exec(struct brw_context *brw, const brw_blorp_params *params)
195 {
196 switch (brw->gen) {
197 case 6:
198 gen6_blorp_exec(brw, params);
199 break;
200 case 7:
201 gen7_blorp_exec(brw, params);
202 break;
203 default:
204 /* BLORP is not supported before Gen6. */
205 assert(false);
206 break;
207 }
208
209 if (unlikely(brw->always_flush_batch))
210 intel_batchbuffer_flush(brw);
211
212 /* We've smashed all state compared to what the normal 3D pipeline
213 * rendering tracks for GL.
214 */
215 brw->state.dirty.brw = ~0;
216 brw->state.dirty.cache = ~0;
217 brw->state_batch_count = 0;
218 brw->batch.need_workaround_flush = true;
219 brw->ib.type = -1;
220 intel_batchbuffer_clear_cache(brw);
221
222 /* Flush the sampler cache so any texturing from the destination is
223 * coherent.
224 */
225 intel_batchbuffer_emit_mi_flush(brw);
226 }
227
228 brw_hiz_op_params::brw_hiz_op_params(struct intel_mipmap_tree *mt,
229 unsigned int level,
230 unsigned int layer,
231 gen6_hiz_op op)
232 {
233 this->hiz_op = op;
234
235 depth.set(mt, level, layer);
236
237 /* Align the rectangle primitive to 8x4 pixels.
238 *
239 * During fast depth clears, the emitted rectangle primitive must be
240 * aligned to 8x4 pixels. From the Ivybridge PRM, Vol 2 Part 1 Section
241 * 11.5.3.1 Depth Buffer Clear (and the matching section in the Sandybridge
242 * PRM):
243 * If Number of Multisamples is NUMSAMPLES_1, the rectangle must be
244 * aligned to an 8x4 pixel block relative to the upper left corner
245 * of the depth buffer [...]
246 *
247 * For hiz resolves, the rectangle must also be 8x4 aligned. Item
248 * WaHizAmbiguate8x4Aligned from the Haswell workarounds page and the
249 * Ivybridge simulator require the alignment.
250 *
251 * To be safe, let's just align the rect for all hiz operations and all
252 * hardware generations.
253 *
254 * However, for some miptree slices of a Z24 texture, emitting an 8x4
255 * aligned rectangle that covers the slice may clobber adjacent slices if
256 * we strictly adhered to the texture alignments specified in the PRM. The
257 * Ivybridge PRM, Section "Alignment Unit Size", states that
258 * SURFACE_STATE.Surface_Horizontal_Alignment should be 4 for Z24 surfaces,
259 * not 8. But commit 1f112cc increased the alignment from 4 to 8, which
260 * prevents the clobbering.
261 */
262 depth.width = ALIGN(depth.width, 8);
263 depth.height = ALIGN(depth.height, 4);
264
265 x1 = depth.width;
266 y1 = depth.height;
267
268 assert(intel_miptree_slice_has_hiz(mt, level, layer));
269
270 switch (mt->format) {
271 case MESA_FORMAT_Z16: depth_format = BRW_DEPTHFORMAT_D16_UNORM; break;
272 case MESA_FORMAT_Z32_FLOAT: depth_format = BRW_DEPTHFORMAT_D32_FLOAT; break;
273 case MESA_FORMAT_X8_Z24: depth_format = BRW_DEPTHFORMAT_D24_UNORM_X8_UINT; break;
274 default: assert(0); break;
275 }
276 }
277
278 uint32_t
279 brw_hiz_op_params::get_wm_prog(struct brw_context *brw,
280 brw_blorp_prog_data **prog_data) const
281 {
282 return 0;
283 }