2 * Copyright 2017 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 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE.
23 #ifndef IRIS_RESOURCE_H
24 #define IRIS_RESOURCE_H
26 #include "pipe/p_state.h"
27 #include "util/u_inlines.h"
28 #include "intel/isl/isl.h"
33 #define IRIS_MAX_MIPLEVELS 15
35 struct iris_format_info
{
37 struct isl_swizzle swizzle
;
40 #define IRIS_RESOURCE_FLAG_SHADER_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 0)
41 #define IRIS_RESOURCE_FLAG_SURFACE_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 1)
42 #define IRIS_RESOURCE_FLAG_DYNAMIC_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 2)
44 enum gen9_astc5x5_wa_tex_type
{
45 GEN9_ASTC5X5_WA_TEX_TYPE_ASTC5x5
= 1 << 0,
46 GEN9_ASTC5X5_WA_TEX_TYPE_AUX
= 1 << 1,
50 * Resources represent a GPU buffer object or image (mipmap tree).
52 * They contain the storage (BO) and layout information (ISL surface).
54 struct iris_resource
{
55 struct pipe_resource base
;
56 enum pipe_format internal_format
;
59 * The ISL surface layout information for this resource.
61 * This is not filled out for PIPE_BUFFER resources, but is guaranteed
62 * to be zeroed. Note that this also guarantees that res->surf.tiling
63 * will be ISL_TILING_LINEAR, so it's safe to check that.
67 /** Backing storage for the resource */
71 * A bitfield of PIPE_BIND_* indicating how this resource was bound
72 * in the past. Only meaningful for PIPE_BUFFER; used for flushing.
74 unsigned bind_history
;
77 * Auxiliary buffer information (CCS, MCS, or HiZ).
80 /** The surface layout for the auxiliary buffer. */
83 /** The buffer object containing the auxiliary data. */
86 /** Offset into 'bo' where the auxiliary surface starts. */
90 * \brief The type of auxiliary compression used by this resource.
92 * This describes the type of auxiliary compression that is intended to
93 * be used by this resource. An aux usage of ISL_AUX_USAGE_NONE means
94 * that auxiliary compression is permanently disabled. An aux usage
95 * other than ISL_AUX_USAGE_NONE does not imply that auxiliary
96 * compression will always be enabled for this surface.
98 enum isl_aux_usage usage
;
101 * A bitfield of ISL_AUX_* modes that might this resource might use.
103 * For example, a surface might use both CCS_E and CCS_D at times.
105 unsigned possible_usages
;
108 * \brief Maps miptree slices to their current aux state.
110 * This two-dimensional array is indexed as [level][layer] and stores an
111 * aux state for each slice.
113 enum isl_aux_state
**state
;
118 * A simple <resource, offset> tuple for storing a reference to a
119 * piece of state stored in a GPU buffer object.
121 struct iris_state_ref
{
122 struct pipe_resource
*res
;
127 * Gallium CSO for sampler views (texture views).
129 * In addition to the normal pipe_resource, this adds an ISL view
130 * which may reinterpret the format or restrict levels/layers.
132 * These can also be linear texture buffers.
134 struct iris_sampler_view
{
135 struct pipe_sampler_view base
;
136 struct isl_view view
;
138 /* A short-cut (not a reference) to the actual resource being viewed.
139 * Multi-planar (or depth+stencil) images may have multiple resources
140 * chained together; this skips having to traverse base->texture->*.
142 struct iris_resource
*res
;
144 /** The resource (BO) holding our SURFACE_STATE. */
145 struct iris_state_ref surface_state
;
149 * Gallium CSO for surfaces (framebuffer attachments).
151 * A view of a surface that can be bound to a color render target or
152 * depth/stencil attachment.
154 struct iris_surface
{
155 struct pipe_surface base
;
156 struct isl_view view
;
158 /** The resource (BO) holding our SURFACE_STATE. */
159 struct iris_state_ref surface_state
;
163 * Transfer object - information about a buffer mapping.
165 struct iris_transfer
{
166 struct pipe_transfer base
;
167 struct pipe_debug_callback
*dbg
;
171 void (*unmap
)(struct iris_transfer
*);
175 * Unwrap a pipe_resource to get the underlying iris_bo (for convenience).
177 static inline struct iris_bo
*
178 iris_resource_bo(struct pipe_resource
*p_res
)
180 struct iris_resource
*res
= (void *) p_res
;
184 struct iris_format_info
iris_format_for_usage(const struct gen_device_info
*,
186 isl_surf_usage_flags_t usage
);
188 struct pipe_resource
*iris_resource_get_separate_stencil(struct pipe_resource
*);
190 void iris_get_depth_stencil_resources(struct pipe_resource
*res
,
191 struct iris_resource
**out_z
,
192 struct iris_resource
**out_s
);
194 void iris_init_screen_resource_functions(struct pipe_screen
*pscreen
);
196 void iris_flush_and_dirty_for_history(struct iris_context
*ice
,
197 struct iris_batch
*batch
,
198 struct iris_resource
*res
);
200 unsigned iris_get_num_logical_layers(const struct iris_resource
*res
,
203 void iris_resource_disable_aux(struct iris_resource
*res
);
205 #define INTEL_REMAINING_LAYERS UINT32_MAX
206 #define INTEL_REMAINING_LEVELS UINT32_MAX
209 * Prepare a miptree for access
211 * This function should be called prior to any access to miptree in order to
212 * perform any needed resolves.
214 * \param[in] start_level The first mip level to be accessed
216 * \param[in] num_levels The number of miplevels to be accessed or
217 * INTEL_REMAINING_LEVELS to indicate every level
218 * above start_level will be accessed
220 * \param[in] start_layer The first array slice or 3D layer to be accessed
222 * \param[in] num_layers The number of array slices or 3D layers be
223 * accessed or INTEL_REMAINING_LAYERS to indicate
224 * every layer above start_layer will be accessed
226 * \param[in] aux_supported Whether or not the access will support the
227 * miptree's auxiliary compression format; this
228 * must be false for uncompressed miptrees
230 * \param[in] fast_clear_supported Whether or not the access will support
231 * fast clears in the miptree's auxiliary
235 iris_resource_prepare_access(struct iris_context
*ice
,
236 struct iris_batch
*batch
,
237 struct iris_resource
*res
,
238 uint32_t start_level
, uint32_t num_levels
,
239 uint32_t start_layer
, uint32_t num_layers
,
240 enum isl_aux_usage aux_usage
,
241 bool fast_clear_supported
);
244 * Complete a write operation
246 * This function should be called after any operation writes to a miptree.
247 * This will update the miptree's compression state so that future resolves
248 * happen correctly. Technically, this function can be called before the
249 * write occurs but the caller must ensure that they don't interlace
250 * iris_resource_prepare_access and iris_resource_finish_write calls to
251 * overlapping layer/level ranges.
253 * \param[in] level The mip level that was written
255 * \param[in] start_layer The first array slice or 3D layer written
257 * \param[in] num_layers The number of array slices or 3D layers
258 * written or INTEL_REMAINING_LAYERS to indicate
259 * every layer above start_layer was written
261 * \param[in] written_with_aux Whether or not the write was done with
262 * auxiliary compression enabled
265 iris_resource_finish_write(struct iris_context
*ice
,
266 struct iris_resource
*res
, uint32_t level
,
267 uint32_t start_layer
, uint32_t num_layers
,
268 enum isl_aux_usage aux_usage
);
270 /** Get the auxiliary compression state of a miptree slice */
272 iris_resource_get_aux_state(const struct iris_resource
*res
,
273 uint32_t level
, uint32_t layer
);
276 * Set the auxiliary compression state of a miptree slice range
278 * This function directly sets the auxiliary compression state of a slice
279 * range of a miptree. It only modifies data structures and does not do any
280 * resolves. This should only be called by code which directly performs
281 * compression operations such as fast clears and resolves. Most code should
282 * use iris_resource_prepare_access or iris_resource_finish_write.
285 iris_resource_set_aux_state(struct iris_resource
*res
, uint32_t level
,
286 uint32_t start_layer
, uint32_t num_layers
,
287 enum isl_aux_state aux_state
);
290 * Prepare a miptree for raw access
292 * This helper prepares the miptree for access that knows nothing about any
293 * sort of compression whatsoever. This is useful when mapping the surface or
294 * using it with the blitter.
297 iris_resource_access_raw(struct iris_context
*ice
,
298 struct iris_batch
*batch
,
299 struct iris_resource
*res
,
300 uint32_t level
, uint32_t layer
,
304 iris_resource_prepare_access(ice
, batch
, res
, level
, 1, layer
, num_layers
,
305 ISL_AUX_USAGE_NONE
, false);
307 iris_resource_finish_write(ice
, res
, level
, layer
, num_layers
,
312 enum isl_aux_usage
iris_resource_texture_aux_usage(struct iris_context
*ice
,
313 const struct iris_resource
*res
,
314 enum isl_format view_fmt
,
315 enum gen9_astc5x5_wa_tex_type
);
316 void iris_resource_prepare_texture(struct iris_context
*ice
,
317 struct iris_batch
*batch
,
318 struct iris_resource
*res
,
319 enum isl_format view_format
,
320 uint32_t start_level
, uint32_t num_levels
,
321 uint32_t start_layer
, uint32_t num_layers
,
322 enum gen9_astc5x5_wa_tex_type
);
323 void iris_resource_prepare_image(struct iris_context
*ice
,
324 struct iris_batch
*batch
,
325 struct iris_resource
*res
);
327 void iris_resource_check_level_layer(const struct iris_resource
*res
,
328 uint32_t level
, uint32_t layer
);
330 bool iris_resource_level_has_hiz(const struct iris_resource
*res
,
333 enum isl_aux_usage
iris_resource_render_aux_usage(struct iris_context
*ice
,
334 struct iris_resource
*res
,
335 enum isl_format render_fmt
,
337 bool draw_aux_disabled
);
338 void iris_resource_prepare_render(struct iris_context
*ice
,
339 struct iris_batch
*batch
,
340 struct iris_resource
*res
, uint32_t level
,
341 uint32_t start_layer
, uint32_t layer_count
,
342 enum isl_aux_usage aux_usage
);
343 void iris_resource_finish_render(struct iris_context
*ice
,
344 struct iris_resource
*res
, uint32_t level
,
345 uint32_t start_layer
, uint32_t layer_count
,
346 enum isl_aux_usage aux_usage
);
347 void iris_resource_prepare_depth(struct iris_context
*ice
,
348 struct iris_batch
*batch
,
349 struct iris_resource
*res
, uint32_t level
,
350 uint32_t start_layer
, uint32_t layer_count
);
351 void iris_resource_finish_depth(struct iris_context
*ice
,
352 struct iris_resource
*res
, uint32_t level
,
353 uint32_t start_layer
, uint32_t layer_count
,