iris: rework format translation apis
[mesa.git] / src / gallium / drivers / iris / iris_resource.h
1 /*
2 * Copyright 2017 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 * 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:
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 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.
22 */
23 #ifndef IRIS_RESOURCE_H
24 #define IRIS_RESOURCE_H
25
26 #include "pipe/p_state.h"
27 #include "util/u_inlines.h"
28 #include "intel/isl/isl.h"
29
30 struct iris_format_info {
31 enum isl_format fmt;
32 struct isl_swizzle swizzle;
33 };
34
35 #define IRIS_RESOURCE_FLAG_SHADER_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 0)
36 #define IRIS_RESOURCE_FLAG_SURFACE_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 1)
37 #define IRIS_RESOURCE_FLAG_DYNAMIC_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 2)
38
39 /**
40 * Resources represent a GPU buffer object or image (mipmap tree).
41 *
42 * They contain the storage (BO) and layout information (ISL surface).
43 */
44 struct iris_resource {
45 struct pipe_resource base;
46 enum pipe_format internal_format;
47 struct isl_surf surf;
48 struct iris_bo *bo;
49 };
50
51 /**
52 * A simple <resource, offset> tuple for storing a reference to a
53 * piece of state stored in a GPU buffer object.
54 */
55 struct iris_state_ref {
56 struct pipe_resource *res;
57 uint32_t offset;
58 };
59
60 /**
61 * Gallium CSO for sampler views (texture views).
62 *
63 * In addition to the normal pipe_resource, this adds an ISL view
64 * which may reinterpret the format or restrict levels/layers.
65 *
66 * These can also be linear texture buffers.
67 */
68 struct iris_sampler_view {
69 struct pipe_sampler_view base;
70 struct isl_view view;
71
72 /* A short-cut (not a reference) to the actual resource being viewed.
73 * Multi-planar (or depth+stencil) images may have multiple resources
74 * chained together; this skips having to traverse base->texture->*.
75 */
76 struct iris_resource *res;
77
78 /** The resource (BO) holding our SURFACE_STATE. */
79 struct iris_state_ref surface_state;
80 };
81
82 /**
83 * Gallium CSO for surfaces (framebuffer attachments).
84 *
85 * A view of a surface that can be bound to a color render target or
86 * depth/stencil attachment.
87 */
88 struct iris_surface {
89 struct pipe_surface base;
90 struct isl_view view;
91
92 /** The resource (BO) holding our SURFACE_STATE. */
93 struct iris_state_ref surface_state;
94 };
95
96 /**
97 * Transfer object - information about a buffer mapping.
98 */
99 struct iris_transfer {
100 struct pipe_transfer base;
101 struct pipe_debug_callback *dbg;
102 void *buffer;
103 void *ptr;
104
105 void (*unmap)(struct iris_transfer *);
106 };
107
108 /**
109 * Unwrap a pipe_resource to get the underlying iris_bo (for convenience).
110 */
111 static inline struct iris_bo *
112 iris_resource_bo(struct pipe_resource *p_res)
113 {
114 struct iris_resource *res = (void *) p_res;
115 return res->bo;
116 }
117
118 struct iris_format_info iris_format_for_usage(const struct gen_device_info *,
119 enum pipe_format pf,
120 isl_surf_usage_flags_t usage);
121
122 struct pipe_resource *iris_resource_get_separate_stencil(struct pipe_resource *);
123
124 void iris_get_depth_stencil_resources(struct pipe_resource *res,
125 struct iris_resource **out_z,
126 struct iris_resource **out_s);
127
128 void iris_init_screen_resource_functions(struct pipe_screen *pscreen);
129
130 #endif