panfrost: Initial stub for Panfrost driver
[mesa.git] / src / gallium / drivers / panfrost / pan_context.h
1 /*
2 * © Copyright 2018 Alyssa Rosenzweig
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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 *
23 */
24
25 #ifndef __BUILDER_H__
26 #define __BUILDER_H__
27
28 #define MFBD
29
30 #define _LARGEFILE64_SOURCE 1
31 #define CACHE_LINE_SIZE 1024 /* TODO */
32 #include <sys/mman.h>
33 #include <assert.h>
34 #include "pan_resource.h"
35
36 #include "pipe/p_compiler.h"
37 #include "pipe/p_config.h"
38 #include "pipe/p_context.h"
39 #include "pipe/p_defines.h"
40 #include "pipe/p_format.h"
41 #include "pipe/p_screen.h"
42 #include "pipe/p_state.h"
43 #include "util/u_blitter.h"
44
45 /* Forward declare to avoid extra header dep */
46 struct prim_convert_context;
47
48 /* TODO: Handle on newer hardware */
49 #ifdef MFBD
50 #define PANFROST_DEFAULT_FBD (MALI_MFBD)
51 #define PANFROST_FRAMEBUFFER struct bifrost_framebuffer
52 #else
53 #define PANFROST_DEFAULT_FBD (MALI_SFBD)
54 #define PANFROST_FRAMEBUFFER struct mali_single_framebuffer
55 #endif
56
57 #define MAX_DRAW_CALLS 4096
58 #define MAX_VARYINGS 4096
59
60 //#define PAN_DIRTY_CLEAR (1 << 0)
61 #define PAN_DIRTY_RASTERIZER (1 << 2)
62 #define PAN_DIRTY_FS (1 << 3)
63 #define PAN_DIRTY_FRAG_CORE (PAN_DIRTY_FS) /* Dirty writes are tied */
64 #define PAN_DIRTY_VS (1 << 4)
65 #define PAN_DIRTY_VERTEX (1 << 5)
66 #define PAN_DIRTY_VERT_BUF (1 << 6)
67 //#define PAN_DIRTY_VIEWPORT (1 << 7)
68 #define PAN_DIRTY_SAMPLERS (1 << 8)
69 #define PAN_DIRTY_TEXTURES (1 << 9)
70
71 struct panfrost_constant_buffer {
72 bool dirty;
73 size_t size;
74 void *buffer;
75 };
76
77 struct panfrost_query {
78 /* Passthrough from Gallium */
79 unsigned type;
80 unsigned index;
81
82 /* Memory for the GPU to writeback the value of the query */
83 struct panfrost_transfer transfer;
84 };
85
86 #define PANFROST_MAX_TRANSIENT_ENTRIES 64
87
88 struct panfrost_transient_pool {
89 /* Memory blocks in the pool */
90 struct panfrost_memory_entry *entries[PANFROST_MAX_TRANSIENT_ENTRIES];
91
92 /* Number of entries we own */
93 unsigned entry_count;
94
95 /* Current entry that we are writing to, zero-indexed, strictly less than entry_count */
96 unsigned entry_index;
97
98 /* Number of bytes into the current entry we are */
99 off_t entry_offset;
100
101 /* Entry size (all entries must be homogenous) */
102 size_t entry_size;
103 };
104
105 struct panfrost_context {
106 /* Gallium context */
107 struct pipe_context base;
108
109 struct pipe_framebuffer_state pipe_framebuffer;
110
111 /* The number of concurrent FBOs allowed depends on the number of pools
112 * used; pools are ringed for parallelism opportunities */
113
114 struct panfrost_transient_pool transient_pools[2];
115 int cmdstream_i;
116
117 struct panfrost_memory cmdstream_persistent;
118 struct panfrost_memory shaders;
119 struct panfrost_memory scratchpad;
120 struct panfrost_memory tiler_heap;
121 struct panfrost_memory varying_mem;
122 struct panfrost_memory misc_0;
123 struct panfrost_memory misc_1;
124 struct panfrost_memory depth_stencil_buffer;
125
126 struct {
127 unsigned buffers;
128 const union pipe_color_union *color;
129 double depth;
130 unsigned stencil;
131 } last_clear;
132
133 struct panfrost_query *occlusion_query;
134
135 /* Each render job has multiple framebuffer descriptors associated with
136 * it, used for various purposes with more or less the same format. The
137 * most obvious is the fragment framebuffer descriptor, which carries
138 * e.g. clearing information */
139
140 #ifdef SFBD
141 struct mali_single_framebuffer fragment_fbd;
142 #else
143 struct bifrost_framebuffer fragment_fbd;
144
145 struct bifrost_fb_extra fragment_extra;
146
147 struct bifrost_render_target fragment_rts[4];
148 #endif
149
150 /* Each draw has corresponding vertex and tiler payloads */
151 struct midgard_payload_vertex_tiler payload_vertex;
152 struct midgard_payload_vertex_tiler payload_tiler;
153
154 /* The fragment shader binary itself is pointed here (for the tripipe) but
155 * also everything else in the shader core, including blending, the
156 * stencil/depth tests, etc. Refer to the presentations. */
157
158 struct mali_shader_meta fragment_shader_core;
159
160 /* A frame is composed of a starting set value job, a number of vertex
161 * and tiler jobs, linked to the fragment job at the end. See the
162 * presentations for more information how this works */
163
164 unsigned draw_count;
165
166 mali_ptr set_value_job;
167 mali_ptr vertex_jobs[MAX_DRAW_CALLS];
168 mali_ptr tiler_jobs[MAX_DRAW_CALLS];
169
170 struct mali_job_descriptor_header *u_set_value_job;
171 struct mali_job_descriptor_header *u_vertex_jobs[MAX_DRAW_CALLS];
172 struct mali_job_descriptor_header *u_tiler_jobs[MAX_DRAW_CALLS];
173
174 unsigned vertex_job_count;
175 unsigned tiler_job_count;
176
177 /* Per-draw Dirty flags are setup like any other driver */
178 int dirty;
179
180 /* Per frame dirty flag - whether there was a clear. If not, we need to do a partial update, maybe */
181 bool frame_cleared;
182
183 unsigned vertex_count;
184
185 union mali_attr attributes[PIPE_MAX_ATTRIBS];
186
187 unsigned varying_height;
188
189 struct mali_viewport *viewport;
190 PANFROST_FRAMEBUFFER vt_framebuffer;
191
192 /* TODO: Multiple uniform buffers (index =/= 0), finer updates? */
193
194 struct panfrost_constant_buffer constant_buffer[PIPE_SHADER_TYPES];
195
196 /* CSOs */
197 struct panfrost_rasterizer *rasterizer;
198
199 struct panfrost_shader_variants *vs;
200 struct panfrost_shader_variants *fs;
201
202 struct panfrost_vertex_state *vertex;
203
204 struct pipe_vertex_buffer *vertex_buffers;
205 unsigned vertex_buffer_count;
206
207 struct panfrost_sampler_state *samplers[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
208 unsigned sampler_count[PIPE_SHADER_TYPES];
209
210 struct panfrost_sampler_view *sampler_views[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_SAMPLER_VIEWS];
211 unsigned sampler_view_count[PIPE_SHADER_TYPES];
212
213 struct primconvert_context *primconvert;
214 struct blitter_context *blitter;
215
216 struct panfrost_blend_state *blend;
217
218 struct pipe_viewport_state pipe_viewport;
219 struct pipe_scissor_state scissor;
220 struct pipe_blend_color blend_color;
221 struct pipe_depth_stencil_alpha_state *depth_stencil;
222 struct pipe_stencil_ref stencil_ref;
223 };
224
225 /* Corresponds to the CSO */
226
227 struct panfrost_rasterizer {
228 struct pipe_rasterizer_state base;
229
230 /* Bitmask of front face, etc */
231 unsigned tiler_gl_enables;
232 };
233
234 struct panfrost_blend_state {
235 struct pipe_blend_state base;
236
237 /* Whether a blend shader is in use */
238 bool has_blend_shader;
239
240 /* Compiled fixed function command */
241 struct mali_blend_equation equation;
242
243 /* Compiled blend shader */
244 mali_ptr blend_shader;
245 int blend_work_count;
246 };
247
248 /* Internal varyings descriptor */
249 struct panfrost_varyings {
250 /* Varyings information: stride of each chunk of memory used for
251 * varyings (similar structure with attributes). Count is just the
252 * number of vec4's. Buffer count is the number of varying chunks (<=
253 * count). Height is used to calculate gl_Position's position ("it's
254 * not a pun, Alyssa!"). Vertex-only varyings == descriptor for
255 * gl_Position and something else apparently occupying the same space.
256 * Varyings == main varyings descriptors following typical mali_attr
257 * conventions. */
258
259 unsigned varyings_stride[MAX_VARYINGS];
260 unsigned varying_count;
261 unsigned varying_buffer_count;
262
263 /* Map of the actual varyings buffer */
264 uint8_t *varyings_buffer_cpu;
265 mali_ptr varyings_descriptor;
266 mali_ptr varyings_descriptor_fragment;
267 };
268
269 /* Variants bundle together to form the backing CSO, bundling multiple
270 * shaders with varying emulated features baked in (alpha test
271 * parameters, etc) */
272 #define MAX_SHADER_VARIANTS 8
273
274 /* A shader state corresponds to the actual, current variant of the shader */
275 struct panfrost_shader_state {
276 struct pipe_shader_state *base;
277
278 /* Compiled, mapped descriptor, ready for the hardware */
279 bool compiled;
280 struct mali_shader_meta *tripipe;
281 mali_ptr tripipe_gpu;
282
283 /* Non-descript information */
284 int uniform_count;
285 bool can_discard;
286 bool writes_point_size;
287
288 /* Valid for vertex shaders only due to when this is calculated */
289 struct panfrost_varyings varyings;
290
291 /* Information on this particular shader variant */
292 struct pipe_alpha_state alpha_state;
293 };
294
295 /* A collection of varyings (the CSO) */
296 struct panfrost_shader_variants {
297 struct pipe_shader_state base;
298
299 struct panfrost_shader_state variants[MAX_SHADER_VARIANTS];
300 unsigned variant_count;
301
302 /* The current active variant */
303 unsigned active_variant;
304 };
305
306 struct panfrost_vertex_state {
307 unsigned num_elements;
308
309 struct pipe_vertex_element pipe[PIPE_MAX_ATTRIBS];
310 int nr_components[PIPE_MAX_ATTRIBS];
311
312 /* The actual attribute meta, prebaked and GPU mapped. TODO: Free memory */
313 struct mali_attr_meta *hw;
314 mali_ptr descriptor_ptr;
315 };
316
317 struct panfrost_sampler_state {
318 struct pipe_sampler_state base;
319 struct mali_sampler_descriptor hw;
320 };
321
322 /* Misnomer: Sampler view corresponds to textures, not samplers */
323
324 struct panfrost_sampler_view {
325 struct pipe_sampler_view base;
326 struct mali_texture_descriptor hw;
327 };
328
329 static inline struct panfrost_context *
330 pan_context(struct pipe_context *pcontext)
331 {
332 return (struct panfrost_context *) pcontext;
333 }
334
335 static inline struct panfrost_screen *
336 pan_screen(struct pipe_screen *p)
337 {
338 return (struct panfrost_screen *)p;
339 }
340
341 struct pipe_context *
342 panfrost_create_context(struct pipe_screen *screen, void *priv, unsigned flags);
343
344 void
345 panfrost_emit_for_draw(struct panfrost_context *ctx, bool with_vertex_data);
346
347 struct panfrost_transfer
348 panfrost_vertex_tiler_job(struct panfrost_context *ctx, bool is_tiler, bool is_elided_tiler);
349
350 unsigned
351 panfrost_get_default_swizzle(unsigned components);
352
353 void
354 panfrost_flush(
355 struct pipe_context *pipe,
356 struct pipe_fence_handle **fence,
357 unsigned flags);
358
359 void
360 panfrost_shader_compile(struct panfrost_context *ctx, struct mali_shader_meta *meta, const char *src, int type, struct panfrost_shader_state *state);
361
362 #endif