2 * © Copyright 2017-2018 Alyssa Rosenzweig
3 * © Copyright 2017-2018 Connor Abbott
4 * © Copyright 2017-2018 Lyude Paul
5 * © Copyright2019 Collabora, Ltd.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice (including the next
15 * paragraph) shall be included in all copies or substantial portions of the
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #ifndef __PANFROST_JOB_H__
29 #define __PANFROST_JOB_H__
33 #include <panfrost-misc.h>
38 JOB_TYPE_WRITE_VALUE
= 2,
39 JOB_TYPE_CACHE_FLUSH
= 3,
42 JOB_TYPE_GEOMETRY
= 6,
45 JOB_TYPE_FRAGMENT
= 9,
52 MALI_LINE_STRIP
= 0x4,
55 MALI_TRIANGLE_STRIP
= 0xA,
56 MALI_TRIANGLE_FAN
= 0xC,
59 MALI_QUAD_STRIP
= 0xF,
61 /* All other modes invalid */
64 /* Applies to tiler_gl_enables */
66 #define MALI_OCCLUSION_QUERY (1 << 3)
67 #define MALI_OCCLUSION_PRECISE (1 << 4)
69 /* Set for a glFrontFace(GL_CCW) in a Y=0=TOP coordinate system (like Gallium).
70 * In OpenGL, this would corresponds to glFrontFace(GL_CW). Mesa and the blob
71 * disagree about how to do viewport flipping, so the blob actually sets this
72 * for GL_CW but then has a negative viewport stride */
74 #define MALI_FRONT_CCW_TOP (1 << 5)
76 #define MALI_CULL_FACE_FRONT (1 << 6)
77 #define MALI_CULL_FACE_BACK (1 << 7)
79 /* Used in stencil and depth tests */
86 MALI_FUNC_GREATER
= 4,
87 MALI_FUNC_NOTEQUAL
= 5,
92 /* Flags apply to unknown2_3? */
94 #define MALI_HAS_MSAA (1 << 0)
95 #define MALI_CAN_DISCARD (1 << 5)
97 /* Applies on SFBD systems, specifying that programmable blending is in use */
98 #define MALI_HAS_BLEND_SHADER (1 << 6)
100 /* func is mali_func */
101 #define MALI_DEPTH_FUNC(func) (func << 8)
102 #define MALI_GET_DEPTH_FUNC(flags) ((flags >> 8) & 0x7)
103 #define MALI_DEPTH_FUNC_MASK MALI_DEPTH_FUNC(0x7)
105 #define MALI_DEPTH_WRITEMASK (1 << 11)
107 /* Next flags to unknown2_4 */
108 #define MALI_STENCIL_TEST (1 << 0)
111 #define MALI_SAMPLE_ALPHA_TO_COVERAGE_NO_BLEND_SHADER (1 << 1)
113 #define MALI_NO_DITHER (1 << 9)
114 #define MALI_DEPTH_RANGE_A (1 << 12)
115 #define MALI_DEPTH_RANGE_B (1 << 13)
116 #define MALI_NO_MSAA (1 << 14)
118 /* Stencil test state is all encoded in a single u32, just with a lot of
121 enum mali_stencil_op
{
122 MALI_STENCIL_KEEP
= 0,
123 MALI_STENCIL_REPLACE
= 1,
124 MALI_STENCIL_ZERO
= 2,
125 MALI_STENCIL_INVERT
= 3,
126 MALI_STENCIL_INCR_WRAP
= 4,
127 MALI_STENCIL_DECR_WRAP
= 5,
128 MALI_STENCIL_INCR
= 6,
129 MALI_STENCIL_DECR
= 7
132 struct mali_stencil_test
{
135 enum mali_func func
: 3;
136 enum mali_stencil_op sfail
: 3;
137 enum mali_stencil_op dpfail
: 3;
138 enum mali_stencil_op dppass
: 3;
140 } __attribute__((packed
));
142 #define MALI_MASK_R (1 << 0)
143 #define MALI_MASK_G (1 << 1)
144 #define MALI_MASK_B (1 << 2)
145 #define MALI_MASK_A (1 << 3)
147 enum mali_nondominant_mode
{
148 MALI_BLEND_NON_MIRROR
= 0,
149 MALI_BLEND_NON_ZERO
= 1
152 enum mali_dominant_blend
{
153 MALI_BLEND_DOM_SOURCE
= 0,
154 MALI_BLEND_DOM_DESTINATION
= 1
157 enum mali_dominant_factor
{
158 MALI_DOMINANT_UNK0
= 0,
159 MALI_DOMINANT_ZERO
= 1,
160 MALI_DOMINANT_SRC_COLOR
= 2,
161 MALI_DOMINANT_DST_COLOR
= 3,
162 MALI_DOMINANT_UNK4
= 4,
163 MALI_DOMINANT_SRC_ALPHA
= 5,
164 MALI_DOMINANT_DST_ALPHA
= 6,
165 MALI_DOMINANT_CONSTANT
= 7,
168 enum mali_blend_modifier
{
169 MALI_BLEND_MOD_UNK0
= 0,
170 MALI_BLEND_MOD_NORMAL
= 1,
171 MALI_BLEND_MOD_SOURCE_ONE
= 2,
172 MALI_BLEND_MOD_DEST_ONE
= 3,
175 struct mali_blend_mode
{
176 enum mali_blend_modifier clip_modifier
: 2;
177 unsigned unused_0
: 1;
178 unsigned negate_source
: 1;
180 enum mali_dominant_blend dominant
: 1;
182 enum mali_nondominant_mode nondominant_mode
: 1;
184 unsigned unused_1
: 1;
186 unsigned negate_dest
: 1;
188 enum mali_dominant_factor dominant_factor
: 3;
189 unsigned complement_dominant
: 1;
190 } __attribute__((packed
));
192 struct mali_blend_equation
{
193 /* Of type mali_blend_mode */
194 unsigned rgb_mode
: 12;
195 unsigned alpha_mode
: 12;
199 /* Corresponds to MALI_MASK_* above and glColorMask arguments */
201 unsigned color_mask
: 4;
202 } __attribute__((packed
));
204 /* Used with channel swizzling */
206 MALI_CHANNEL_RED
= 0,
207 MALI_CHANNEL_GREEN
= 1,
208 MALI_CHANNEL_BLUE
= 2,
209 MALI_CHANNEL_ALPHA
= 3,
210 MALI_CHANNEL_ZERO
= 4,
211 MALI_CHANNEL_ONE
= 5,
212 MALI_CHANNEL_RESERVED_0
= 6,
213 MALI_CHANNEL_RESERVED_1
= 7,
216 struct mali_channel_swizzle
{
217 enum mali_channel r
: 3;
218 enum mali_channel g
: 3;
219 enum mali_channel b
: 3;
220 enum mali_channel a
: 3;
221 } __attribute__((packed
));
223 /* Compressed per-pixel formats. Each of these formats expands to one to four
224 * floating-point or integer numbers, as defined by the OpenGL specification.
225 * There are various places in OpenGL where the user can specify a compressed
226 * format in memory, which all use the same 8-bit enum in the various
227 * descriptors, although different hardware units support different formats.
230 /* The top 3 bits specify how the bits of each component are interpreted. */
233 #define MALI_FORMAT_COMPRESSED (0 << 5)
235 /* e.g. R11F_G11F_B10F */
236 #define MALI_FORMAT_SPECIAL (2 << 5)
238 /* signed normalized, e.g. RGBA8_SNORM */
239 #define MALI_FORMAT_SNORM (3 << 5)
242 #define MALI_FORMAT_UINT (4 << 5)
244 /* e.g. RGBA8 and RGBA32F */
245 #define MALI_FORMAT_UNORM (5 << 5)
247 /* e.g. RGBA8I and RGBA16F */
248 #define MALI_FORMAT_SINT (6 << 5)
250 /* These formats seem to largely duplicate the others. They're used at least
251 * for Bifrost framebuffer output.
253 #define MALI_FORMAT_SPECIAL2 (7 << 5)
255 /* If the high 3 bits are 3 to 6 these two bits say how many components
258 #define MALI_NR_CHANNELS(n) ((n - 1) << 3)
260 /* If the high 3 bits are 3 to 6, then the low 3 bits say how big each
261 * component is, except the special MALI_CHANNEL_FLOAT which overrides what the
265 #define MALI_CHANNEL_4 2
267 #define MALI_CHANNEL_8 3
269 #define MALI_CHANNEL_16 4
271 #define MALI_CHANNEL_32 5
273 /* For MALI_FORMAT_SINT it means a half-float (e.g. RG16F). For
274 * MALI_FORMAT_UNORM, it means a 32-bit float.
276 #define MALI_CHANNEL_FLOAT 7
279 MALI_ETC2_RGB8
= MALI_FORMAT_COMPRESSED
| 0x1,
280 MALI_ETC2_R11_UNORM
= MALI_FORMAT_COMPRESSED
| 0x2,
281 MALI_ETC2_RGBA8
= MALI_FORMAT_COMPRESSED
| 0x3,
282 MALI_ETC2_RG11_UNORM
= MALI_FORMAT_COMPRESSED
| 0x4,
283 MALI_ETC2_R11_SNORM
= MALI_FORMAT_COMPRESSED
| 0x11,
284 MALI_ETC2_RG11_SNORM
= MALI_FORMAT_COMPRESSED
| 0x12,
285 MALI_ETC2_RGB8A1
= MALI_FORMAT_COMPRESSED
| 0x13,
286 MALI_ASTC_SRGB_SUPP
= MALI_FORMAT_COMPRESSED
| 0x16,
287 MALI_ASTC_HDR_SUPP
= MALI_FORMAT_COMPRESSED
| 0x17,
289 MALI_RGB565
= MALI_FORMAT_SPECIAL
| 0x0,
290 MALI_RGB5_X1_UNORM
= MALI_FORMAT_SPECIAL
| 0x1,
291 MALI_RGB5_A1_UNORM
= MALI_FORMAT_SPECIAL
| 0x2,
292 MALI_RGB10_A2_UNORM
= MALI_FORMAT_SPECIAL
| 0x3,
293 MALI_RGB10_A2_SNORM
= MALI_FORMAT_SPECIAL
| 0x5,
294 MALI_RGB10_A2UI
= MALI_FORMAT_SPECIAL
| 0x7,
295 MALI_RGB10_A2I
= MALI_FORMAT_SPECIAL
| 0x9,
297 MALI_RGB332_UNORM
= MALI_FORMAT_SPECIAL
| 0xb,
298 MALI_RGB233_UNORM
= MALI_FORMAT_SPECIAL
| 0xc,
300 MALI_Z32_UNORM
= MALI_FORMAT_SPECIAL
| 0xd,
301 MALI_R32_FIXED
= MALI_FORMAT_SPECIAL
| 0x11,
302 MALI_RG32_FIXED
= MALI_FORMAT_SPECIAL
| 0x12,
303 MALI_RGB32_FIXED
= MALI_FORMAT_SPECIAL
| 0x13,
304 MALI_RGBA32_FIXED
= MALI_FORMAT_SPECIAL
| 0x14,
305 MALI_R11F_G11F_B10F
= MALI_FORMAT_SPECIAL
| 0x19,
306 MALI_R9F_G9F_B9F_E5F
= MALI_FORMAT_SPECIAL
| 0x1b,
307 /* Only used for varyings, to indicate the transformed gl_Position */
308 MALI_VARYING_POS
= MALI_FORMAT_SPECIAL
| 0x1e,
309 /* Only used for varyings, to indicate that the write should be
312 MALI_VARYING_DISCARD
= MALI_FORMAT_SPECIAL
| 0x1f,
314 MALI_R8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
315 MALI_R16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
316 MALI_R32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
317 MALI_RG8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
318 MALI_RG16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
319 MALI_RG32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
320 MALI_RGB8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
321 MALI_RGB16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
322 MALI_RGB32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
323 MALI_RGBA8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
324 MALI_RGBA16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
325 MALI_RGBA32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
327 MALI_R8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
328 MALI_R16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
329 MALI_R32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
330 MALI_RG8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
331 MALI_RG16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
332 MALI_RG32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
333 MALI_RGB8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
334 MALI_RGB16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
335 MALI_RGB32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
336 MALI_RGBA8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
337 MALI_RGBA16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
338 MALI_RGBA32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
340 MALI_R8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
341 MALI_R16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
342 MALI_R32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
343 MALI_R32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_FLOAT
,
344 MALI_RG8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
345 MALI_RG16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
346 MALI_RG32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
347 MALI_RG32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_FLOAT
,
348 MALI_RGB8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
349 MALI_RGB16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
350 MALI_RGB32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
351 MALI_RGB32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_FLOAT
,
352 MALI_RGBA4_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_4
,
353 MALI_RGBA8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
354 MALI_RGBA16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
355 MALI_RGBA32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
356 MALI_RGBA32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_FLOAT
,
358 MALI_R8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
359 MALI_R16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
360 MALI_R32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
361 MALI_R16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_FLOAT
,
362 MALI_RG8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
363 MALI_RG16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
364 MALI_RG32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
365 MALI_RG16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_FLOAT
,
366 MALI_RGB8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
367 MALI_RGB16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
368 MALI_RGB32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
369 MALI_RGB16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_FLOAT
,
370 MALI_RGBA8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
371 MALI_RGBA16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
372 MALI_RGBA32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
373 MALI_RGBA16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_FLOAT
,
375 MALI_RGBA4
= MALI_FORMAT_SPECIAL2
| 0x8,
376 MALI_RGBA8_2
= MALI_FORMAT_SPECIAL2
| 0xd,
377 MALI_RGB10_A2_2
= MALI_FORMAT_SPECIAL2
| 0xe,
381 /* Alpha coverage is encoded as 4-bits (from a clampf), with inversion
382 * literally performing a bitwise invert. This function produces slightly wrong
383 * results and I'm not sure why; some rounding issue I suppose... */
385 #define MALI_ALPHA_COVERAGE(clampf) ((uint16_t) (int) (clampf * 15.0f))
386 #define MALI_GET_ALPHA_COVERAGE(nibble) ((float) nibble / 15.0f)
388 /* Applies to midgard1.flags_lo */
390 /* Should be set when the fragment shader updates the depth value. */
391 #define MALI_WRITES_Z (1 << 4)
393 /* Should the hardware perform early-Z testing? Normally should be set
394 * for performance reasons. Clear if you use: discard,
395 * alpha-to-coverage... * It's also possible this disables
396 * forward-pixel kill; we're not quite sure which bit is which yet.
397 * TODO: How does this interact with blending?*/
399 #define MALI_EARLY_Z (1 << 6)
401 /* Should the hardware calculate derivatives (via helper invocations)? Set in a
402 * fragment shader that uses texturing or derivative functions */
404 #define MALI_HELPER_INVOCATIONS (1 << 7)
406 /* Flags denoting the fragment shader's use of tilebuffer readback. If the
407 * shader might read any part of the tilebuffer, set MALI_READS_TILEBUFFER. If
408 * it might read depth/stencil in particular, also set MALI_READS_ZS */
410 #define MALI_READS_ZS (1 << 8)
411 #define MALI_READS_TILEBUFFER (1 << 12)
413 /* Applies to midgard1.flags_hi */
415 /* Should be set when the fragment shader updates the stencil value. */
416 #define MALI_WRITES_S (1 << 2)
418 /* The raw Midgard blend payload can either be an equation or a shader
419 * address, depending on the context */
421 union midgard_blend
{
425 struct mali_blend_equation equation
;
430 /* We need to load the tilebuffer to blend (i.e. the destination factor is not
433 #define MALI_BLEND_LOAD_TIB (0x1)
435 /* A blend shader is used to blend this render target */
436 #define MALI_BLEND_MRT_SHADER (0x2)
438 /* On MRT Midgard systems (using an MFBD), each render target gets its own
439 * blend descriptor */
441 #define MALI_BLEND_SRGB (0x400)
443 /* Dithering is specified here for MFBD, otherwise NO_DITHER for SFBD */
444 #define MALI_BLEND_NO_DITHER (0x800)
446 struct midgard_blend_rt
{
447 /* Flags base value of 0x200 to enable the render target.
448 * OR with 0x1 for blending (anything other than REPLACE).
449 * OR with 0x2 for programmable blending
450 * OR with MALI_BLEND_SRGB for implicit sRGB
454 union midgard_blend blend
;
455 } __attribute__((packed
));
457 /* On Bifrost systems (all MRT), each render target gets one of these
460 struct bifrost_blend_rt
{
461 /* This is likely an analogue of the flags on
462 * midgard_blend_rt */
464 u16 flags
; // = 0x200
466 /* Single-channel blend constants are encoded in a sort of
467 * fixed-point. Basically, the float is mapped to a byte, becoming
468 * a high byte, and then the lower-byte is added for precision.
469 * For the original float f:
471 * f = (constant_hi / 255) + (constant_lo / 65535)
473 * constant_hi = int(f / 255)
474 * constant_lo = 65535*f - (65535/255) * constant_hi
479 struct mali_blend_equation equation
;
482 * - 0x3 when this slot is unused (everything else is 0 except the index)
483 * - 0x11 when this is the fourth slot (and it's used)
484 + * - 0 when there is a blend shader
487 /* increments from 0 to 3 */
492 /* So far, I've only seen:
493 * - R001 for 1-component formats
494 * - RG01 for 2-component formats
495 * - RGB1 for 3-component formats
496 * - RGBA for 4-component formats
499 enum mali_format format
: 8;
501 /* Type of the shader output variable. Note, this can
502 * be different from the format.
504 * 0: f16 (mediump float)
505 * 1: f32 (highp float)
507 * 3: u32 (highp uint)
508 * 4: i16 (mediump int)
509 * 5: u16 (mediump uint)
515 /* Only the low 32 bits of the blend shader are stored, the
516 * high 32 bits are implicitly the same as the original shader.
517 * According to the kernel driver, the program counter for
518 * shaders is actually only 24 bits, so shaders cannot cross
519 * the 2^24-byte boundary, and neither can the blend shader.
520 * The blob handles this by allocating a 2^24 byte pool for
521 * shaders, and making sure that any blend shaders are stored
522 * in the same pool as the original shader. The kernel will
523 * make sure this allocation is aligned to 2^24 bytes.
527 } __attribute__((packed
));
529 /* Descriptor for the shader. Following this is at least one, up to four blend
530 * descriptors for each active render target */
532 struct mali_shader_meta
{
541 u32 uniform_buffer_count
: 4;
542 u32 unk1
: 28; // = 0x800000 for vertex, 0x958020 for tiler
545 unsigned uniform_buffer_count
: 4;
546 unsigned flags_lo
: 12;
549 unsigned work_count
: 5;
550 unsigned uniform_count
: 5;
551 unsigned flags_hi
: 6;
555 /* Same as glPolygoOffset() arguments */
564 u8 stencil_mask_front
;
565 u8 stencil_mask_back
;
568 struct mali_stencil_test stencil_front
;
569 struct mali_stencil_test stencil_back
;
574 /* On Bifrost, some system values are preloaded in
575 * registers R55-R62 by the thread dispatcher prior to
576 * the start of shader execution. This is a bitfield
577 * with one entry for each register saying which
578 * registers need to be preloaded. Right now, the known
582 * - R55 : gl_LocalInvocationID.xy
583 * - R56 : gl_LocalInvocationID.z + unknown in high 16 bits
584 * - R57 : gl_WorkGroupID.x
585 * - R58 : gl_WorkGroupID.y
586 * - R59 : gl_WorkGroupID.z
587 * - R60 : gl_GlobalInvocationID.x
588 * - R61 : gl_GlobalInvocationID.y/gl_VertexID (without base)
589 * - R62 : gl_GlobalInvocationID.z/gl_InstanceID (without base)
592 * - R55 : unknown, never seen (but the bit for this is
594 * - R56 : unknown (bit always unset)
595 * - R57 : gl_PrimitiveID
596 * - R58 : gl_FrontFacing in low bit, potentially other stuff
597 * - R59 : u16 fragment coordinates (used to compute
598 * gl_FragCoord.xy, together with sample positions)
599 * - R60 : gl_SampleMask (used in epilog, so pretty
600 * much always used, but the bit is always 0 -- is
601 * this just always pushed?)
602 * - R61 : gl_SampleMaskIn and gl_SampleID, used by
603 * varying interpolation.
604 * - R62 : unknown (bit always unset).
606 * Later GPUs (starting with Mali-G52?) support
607 * preloading float varyings into r0-r7. This is
608 * indicated by setting 0x40. There is no distinction
609 * here between 1 varying and 2.
611 u32 preload_regs
: 8;
612 /* In units of 8 bytes or 64 bits, since the
613 * uniform/const port loads 64 bits at a time.
615 u32 uniform_count
: 7;
616 u32 unk4
: 10; // = 2
625 /* Blending information for the older non-MRT Midgard HW. Check for
626 * MALI_HAS_BLEND_SHADER to decide how to interpret.
629 union midgard_blend blend
;
630 } __attribute__((packed
));
632 /* This only concerns hardware jobs */
634 /* Possible values for job_descriptor_size */
636 #define MALI_JOB_32 0
637 #define MALI_JOB_64 1
639 struct mali_job_descriptor_header
{
640 u32 exception_status
;
641 u32 first_incomplete_task
;
643 u8 job_descriptor_size
: 1;
644 enum mali_job_type job_type
: 7;
646 u8 unknown_flags
: 7;
648 u16 job_dependency_index_1
;
649 u16 job_dependency_index_2
;
651 } __attribute__((packed
));
653 /* These concern exception_status */
655 /* Access type causing a fault, paralleling AS_FAULTSTATUS_* entries in the
658 enum mali_exception_access
{
659 /* Atomic in the kernel for MMU, but that doesn't make sense for a job
660 * fault so it's just unused */
661 MALI_EXCEPTION_ACCESS_NONE
= 0,
663 MALI_EXCEPTION_ACCESS_EXECUTE
= 1,
664 MALI_EXCEPTION_ACCESS_READ
= 2,
665 MALI_EXCEPTION_ACCESS_WRITE
= 3
668 /* Details about write_value from panfrost igt tests which use it as a generic
669 * dword write primitive */
671 #define MALI_WRITE_VALUE_ZERO 3
673 struct mali_payload_write_value
{
675 u32 value_descriptor
;
678 } __attribute__((packed
));
683 * This structure lets the attribute unit compute the address of an attribute
684 * given the vertex and instance ID. Unfortunately, the way this works is
685 * rather complicated when instancing is enabled.
687 * To explain this, first we need to explain how compute and vertex threads are
688 * dispatched. This is a guess (although a pretty firm guess!) since the
689 * details are mostly hidden from the driver, except for attribute instancing.
690 * When a quad is dispatched, it receives a single, linear index. However, we
691 * need to translate that index into a (vertex id, instance id) pair, or a
692 * (local id x, local id y, local id z) triple for compute shaders (although
693 * vertex shaders and compute shaders are handled almost identically).
694 * Focusing on vertex shaders, one option would be to do:
696 * vertex_id = linear_id % num_vertices
697 * instance_id = linear_id / num_vertices
699 * but this involves a costly division and modulus by an arbitrary number.
700 * Instead, we could pad num_vertices. We dispatch padded_num_vertices *
701 * num_instances threads instead of num_vertices * num_instances, which results
702 * in some "extra" threads with vertex_id >= num_vertices, which we have to
703 * discard. The more we pad num_vertices, the more "wasted" threads we
704 * dispatch, but the division is potentially easier.
706 * One straightforward choice is to pad num_vertices to the next power of two,
707 * which means that the division and modulus are just simple bit shifts and
708 * masking. But the actual algorithm is a bit more complicated. The thread
709 * dispatcher has special support for dividing by 3, 5, 7, and 9, in addition
710 * to dividing by a power of two. This is possibly using the technique
711 * described in patent US20170010862A1. As a result, padded_num_vertices can be
712 * 1, 3, 5, 7, or 9 times a power of two. This results in less wasted threads,
713 * since we need less padding.
715 * padded_num_vertices is picked by the hardware. The driver just specifies the
716 * actual number of vertices. At least for Mali G71, the first few cases are
719 * num_vertices | padded_num_vertices
726 * Note that padded_num_vertices is a multiple of four (presumably because
727 * threads are dispatched in groups of 4). Also, padded_num_vertices is always
728 * at least one more than num_vertices, which seems like a quirk of the
729 * hardware. For larger num_vertices, the hardware uses the following
730 * algorithm: using the binary representation of num_vertices, we look at the
731 * most significant set bit as well as the following 3 bits. Let n be the
732 * number of bits after those 4 bits. Then we set padded_num_vertices according
733 * to the following table:
735 * high bits | padded_num_vertices
742 * For example, if num_vertices = 70 is passed to glDraw(), its binary
743 * representation is 1000110, so n = 3 and the high bits are 1000, and
744 * therefore padded_num_vertices = 9 * 2^3 = 72.
746 * The attribute unit works in terms of the original linear_id. if
747 * num_instances = 1, then they are the same, and everything is simple.
748 * However, with instancing things get more complicated. There are four
749 * possible modes, two of them we can group together:
751 * 1. Use the linear_id directly. Only used when there is no instancing.
753 * 2. Use the linear_id modulo a constant. This is used for per-vertex
754 * attributes with instancing enabled by making the constant equal
755 * padded_num_vertices. Because the modulus is always padded_num_vertices, this
756 * mode only supports a modulus that is a power of 2 times 1, 3, 5, 7, or 9.
757 * The shift field specifies the power of two, while the extra_flags field
758 * specifies the odd number. If shift = n and extra_flags = m, then the modulus
759 * is (2m + 1) * 2^n. As an example, if num_vertices = 70, then as computed
760 * above, padded_num_vertices = 9 * 2^3, so we should set extra_flags = 4 and
761 * shift = 3. Note that we must exactly follow the hardware algorithm used to
762 * get padded_num_vertices in order to correctly implement per-vertex
765 * 3. Divide the linear_id by a constant. In order to correctly implement
766 * instance divisors, we have to divide linear_id by padded_num_vertices times
767 * to user-specified divisor. So first we compute padded_num_vertices, again
768 * following the exact same algorithm that the hardware uses, then multiply it
769 * by the GL-level divisor to get the hardware-level divisor. This case is
770 * further divided into two more cases. If the hardware-level divisor is a
771 * power of two, then we just need to shift. The shift amount is specified by
772 * the shift field, so that the hardware-level divisor is just 2^shift.
774 * If it isn't a power of two, then we have to divide by an arbitrary integer.
775 * For that, we use the well-known technique of multiplying by an approximation
776 * of the inverse. The driver must compute the magic multiplier and shift
777 * amount, and then the hardware does the multiplication and shift. The
778 * hardware and driver also use the "round-down" optimization as described in
779 * http://ridiculousfish.com/files/faster_unsigned_division_by_constants.pdf.
780 * The hardware further assumes the multiplier is between 2^31 and 2^32, so the
781 * high bit is implicitly set to 1 even though it is set to 0 by the driver --
782 * presumably this simplifies the hardware multiplier a little. The hardware
783 * first multiplies linear_id by the multiplier and takes the high 32 bits,
784 * then applies the round-down correction if extra_flags = 1, then finally
785 * shifts right by the shift field.
787 * There are some differences between ridiculousfish's algorithm and the Mali
788 * hardware algorithm, which means that the reference code from ridiculousfish
789 * doesn't always produce the right constants. Mali does not use the pre-shift
790 * optimization, since that would make a hardware implementation slower (it
791 * would have to always do the pre-shift, multiply, and post-shift operations).
792 * It also forces the multplier to be at least 2^31, which means that the
793 * exponent is entirely fixed, so there is no trial-and-error. Altogether,
794 * given the divisor d, the algorithm the driver must follow is:
796 * 1. Set shift = floor(log2(d)).
797 * 2. Compute m = ceil(2^(shift + 32) / d) and e = 2^(shift + 32) % d.
798 * 3. If e <= 2^shift, then we need to use the round-down algorithm. Set
799 * magic_divisor = m - 1 and extra_flags = 1.
800 * 4. Otherwise, set magic_divisor = m and extra_flags = 0.
802 * Unrelated to instancing/actual attributes, images (the OpenCL kind) are
803 * implemented as special attributes, denoted by MALI_ATTR_IMAGE. For images,
804 * let shift=extra_flags=0. Stride is set to the image format's bytes-per-pixel
805 * (*NOT the row stride*). Size is set to the size of the image itself.
807 * Special internal attribtues and varyings (gl_VertexID, gl_FrontFacing, etc)
808 * use particular fixed addresses with modified structures.
811 enum mali_attr_mode
{
812 MALI_ATTR_UNUSED
= 0,
813 MALI_ATTR_LINEAR
= 1,
814 MALI_ATTR_POT_DIVIDE
= 2,
815 MALI_ATTR_MODULO
= 3,
816 MALI_ATTR_NPOT_DIVIDE
= 4,
820 /* Pseudo-address for gl_VertexID, gl_FragCoord, gl_FrontFacing */
822 #define MALI_ATTR_VERTEXID (0x22)
823 #define MALI_ATTR_INSTANCEID (0x24)
824 #define MALI_VARYING_FRAG_COORD (0x25)
825 #define MALI_VARYING_FRONT_FACING (0x26)
827 /* This magic "pseudo-address" is used as `elements` to implement
828 * gl_PointCoord. When read from a fragment shader, it generates a point
829 * coordinate per the OpenGL ES 2.0 specification. Flipped coordinate spaces
830 * require an affine transformation in the shader. */
832 #define MALI_VARYING_POINT_COORD (0x61)
834 /* Used for comparison to check if an address is special. Mostly a guess, but
835 * it doesn't really matter. */
837 #define MALI_RECORD_SPECIAL (0x100)
840 /* This is used for actual attributes. */
842 /* The bottom 3 bits are the mode */
843 mali_ptr elements
: 64 - 8;
849 /* The entry after an NPOT_DIVIDE entry has this format. It stores
850 * extra information that wouldn't fit in a normal entry.
853 u32 unk
; /* = 0x20 */
856 /* This is the original, GL-level divisor. */
859 } __attribute__((packed
));
861 struct mali_attr_meta
{
862 /* Vertex buffer index */
865 unsigned unknown1
: 2;
866 unsigned swizzle
: 12;
867 enum mali_format format
: 8;
869 /* Always observed to be zero at the moment */
870 unsigned unknown3
: 2;
872 /* When packing multiple attributes in a buffer, offset addresses by
873 * this value. Obscurely, this is signed. */
875 } __attribute__((packed
));
877 #define FBD_MASK (~0x3f)
879 /* MFBD, rather than SFBD */
880 #define MALI_MFBD (0x1)
882 /* ORed into an MFBD address to specify the fbx section is included */
883 #define MALI_MFBD_TAG_EXTRA (0x2)
885 /* Uniform buffer objects are 64-bit fields divided as:
888 * mali_ptr ptr : 64 - 10;
890 * The size is actually the size minus 1 (MALI_POSITIVE), in units of 16 bytes.
891 * This gives a maximum of 2^14 bytes, which just so happens to be the GL
892 * minimum-maximum for GL_MAX_UNIFORM_BLOCK_SIZE.
894 * The pointer is missing the bottom 2 bits and top 8 bits. The top 8 bits
895 * should be 0 for userspace pointers, according to
896 * https://lwn.net/Articles/718895/. By reusing these bits, we can make each
897 * entry in the table only 64 bits.
900 #define MALI_MAKE_UBO(elements, ptr) \
901 (MALI_POSITIVE((elements)) | (((ptr) >> 2) << 10))
903 /* On Bifrost, these fields are the same between the vertex and tiler payloads.
904 * They also seem to be the same between Bifrost and Midgard. They're shared in
908 /* Applies to unknown_draw */
910 #define MALI_DRAW_INDEXED_UINT8 (0x10)
911 #define MALI_DRAW_INDEXED_UINT16 (0x20)
912 #define MALI_DRAW_INDEXED_UINT32 (0x30)
913 #define MALI_DRAW_INDEXED_SIZE (0x30)
914 #define MALI_DRAW_INDEXED_SHIFT (4)
916 #define MALI_DRAW_VARYING_SIZE (0x100)
918 /* Set to use first vertex as the provoking vertex for flatshading. Clear to
919 * use the last vertex. This is the default in DX and VK, but not in GL. */
921 #define MALI_DRAW_FLATSHADE_FIRST (0x800)
923 #define MALI_DRAW_PRIMITIVE_RESTART_FIXED_INDEX (0x10000)
925 struct mali_vertex_tiler_prefix
{
926 /* This is a dynamic bitfield containing the following things in this order:
928 * - gl_WorkGroupSize.x
929 * - gl_WorkGroupSize.y
930 * - gl_WorkGroupSize.z
931 * - gl_NumWorkGroups.x
932 * - gl_NumWorkGroups.y
933 * - gl_NumWorkGroups.z
935 * The number of bits allocated for each number is based on the *_shift
936 * fields below. For example, workgroups_y_shift gives the bit that
937 * gl_NumWorkGroups.y starts at, and workgroups_z_shift gives the bit
938 * that gl_NumWorkGroups.z starts at (and therefore one after the bit
939 * that gl_NumWorkGroups.y ends at). The actual value for each gl_*
940 * value is one more than the stored value, since if any of the values
941 * are zero, then there would be no invocations (and hence no job). If
942 * there were 0 bits allocated to a given field, then it must be zero,
943 * and hence the real value is one.
945 * Vertex jobs reuse the same job dispatch mechanism as compute jobs,
946 * effectively doing glDispatchCompute(1, vertex_count, instance_count)
947 * where vertex count is the number of vertices.
949 u32 invocation_count
;
951 /* Bitfield for shifts:
955 * workgroups_x_shift : 6
956 * workgroups_y_shift : 6
957 * workgroups_z_shift : 6
958 * workgroups_x_shift_2 : 4
960 u32 invocation_shifts
;
963 u32 unknown_draw
: 22;
965 /* This is the the same as workgroups_x_shift_2 in compute shaders, but
966 * always 5 for vertex jobs and 6 for tiler jobs. I suspect this has
967 * something to do with how many quads get put in the same execution
968 * engine, which is a balance (you don't want to starve the engine, but
969 * you also want to distribute work evenly).
971 u32 workgroups_x_shift_3
: 6;
974 /* Negative of min_index. This is used to compute
975 * the unbiased index in tiler/fragment shader runs.
977 * The hardware adds offset_bias_correction in each run,
978 * so that absent an index bias, the first vertex processed is
979 * genuinely the first vertex (0). But with an index bias,
980 * the first vertex process is numbered the same as the bias.
982 * To represent this more conviniently:
983 * unbiased_index = lower_bound_index +
985 * offset_bias_correction
987 * This is done since the hardware doesn't accept a index_bias
988 * and this allows it to recover the unbiased index.
990 int32_t offset_bias_correction
;
993 /* Like many other strictly nonzero quantities, index_count is
994 * subtracted by one. For an indexed cube, this is equal to 35 = 6
995 * faces * 2 triangles/per face * 3 vertices/per triangle - 1. That is,
996 * for an indexed draw, index_count is the number of actual vertices
997 * rendered whereas invocation_count is the number of unique vertices
998 * rendered (the number of times the vertex shader must be invoked).
999 * For non-indexed draws, this is just equal to invocation_count. */
1003 /* No hidden structure; literally just a pointer to an array of uint
1004 * indices (width depends on flags). Thanks, guys, for not making my
1005 * life insane for once! NULL for non-indexed draws. */
1008 } __attribute__((packed
));
1010 /* Point size / line width can either be specified as a 32-bit float (for
1011 * constant size) or as a [machine word size]-bit GPU pointer (for varying size). If a pointer
1012 * is selected, by setting the appropriate MALI_DRAW_VARYING_SIZE bit in the tiler
1013 * payload, the contents of varying_pointer will be intepreted as an array of
1014 * fp16 sizes, one for each vertex. gl_PointSize is therefore implemented by
1015 * creating a special MALI_R16F varying writing to varying_pointer. */
1017 union midgard_primitive_size
{
1022 struct bifrost_tiler_heap_meta
{
1025 /* note: these are just guesses! */
1026 mali_ptr tiler_heap_start
;
1027 mali_ptr tiler_heap_free
;
1028 mali_ptr tiler_heap_end
;
1030 /* hierarchy weights? but they're still 0 after the job has run... */
1034 } __attribute__((packed
));
1036 struct bifrost_tiler_meta
{
1038 u16 hierarchy_mask
; /* Five values observed: 0xa, 0x14, 0x28, 0x50, 0xa0 */
1043 mali_ptr tiler_heap_meta
;
1044 /* TODO what is this used for? */
1046 } __attribute__((packed
));
1048 struct bifrost_tiler_only
{
1050 union midgard_primitive_size primitive_size
;
1052 mali_ptr tiler_meta
;
1054 u64 zero1
, zero2
, zero3
, zero4
, zero5
, zero6
;
1055 } __attribute__((packed
));
1057 struct mali_vertex_tiler_postfix
{
1058 u16 gl_enables
; // 0x6 on Midgard, 0x2 on Bifrost
1060 /* Both zero for non-instanced draws. For instanced draws, a
1061 * decomposition of padded_num_vertices. See the comments about the
1062 * corresponding fields in mali_attr for context. */
1064 unsigned instance_shift
: 5;
1065 unsigned instance_odd
: 3;
1069 /* Offset for first vertex in buffer */
1074 /* Zero for vertex jobs. Pointer to the position (gl_Position) varying
1075 * output from the vertex shader for tiler jobs.
1078 u64 position_varying
;
1080 /* An array of mali_uniform_buffer_meta's. The size is given by the
1083 u64 uniform_buffers
;
1085 /* On Bifrost, this is a pointer to an array of bifrost_texture_descriptor.
1086 * On Midgard, this is a pointer to an array of pointers to the texture
1087 * descriptors, number of pointers bounded by number of textures. The
1088 * indirection is needed to accomodate varying numbers and sizes of
1089 * texture descriptors */
1092 /* For OpenGL, from what I've seen, this is intimately connected to
1093 * texture_meta. cwabbott says this is not the case under Vulkan, hence
1094 * why this field is seperate (Midgard is Vulkan capable). Pointer to
1095 * array of sampler descriptors (which are uniform in size) */
1096 u64 sampler_descriptor
;
1100 u64 attributes
; /* struct attribute_buffer[] */
1101 u64 attribute_meta
; /* attribute_meta[] */
1102 u64 varyings
; /* struct attr */
1103 u64 varying_meta
; /* pointer */
1105 u64 occlusion_counter
; /* A single bit as far as I can tell */
1107 /* On Bifrost, this points directly to a mali_shared_memory structure.
1108 * On Midgard, this points to a framebuffer (either SFBD or MFBD as
1109 * tagged), which embeds a mali_shared_memory structure */
1110 mali_ptr shared_memory
;
1111 } __attribute__((packed
));
1113 struct midgard_payload_vertex_tiler
{
1114 struct mali_vertex_tiler_prefix prefix
;
1115 struct mali_vertex_tiler_postfix postfix
;
1117 union midgard_primitive_size primitive_size
;
1118 } __attribute__((packed
));
1120 struct bifrost_payload_vertex
{
1121 struct mali_vertex_tiler_prefix prefix
;
1122 struct mali_vertex_tiler_postfix postfix
;
1123 } __attribute__((packed
));
1125 struct bifrost_payload_tiler
{
1126 struct mali_vertex_tiler_prefix prefix
;
1127 struct bifrost_tiler_only tiler
;
1128 struct mali_vertex_tiler_postfix postfix
;
1129 } __attribute__((packed
));
1131 struct bifrost_payload_fused
{
1132 struct mali_vertex_tiler_prefix prefix
;
1133 struct bifrost_tiler_only tiler
;
1134 struct mali_vertex_tiler_postfix tiler_postfix
;
1135 u64 padding
; /* zero */
1136 struct mali_vertex_tiler_postfix vertex_postfix
;
1137 } __attribute__((packed
));
1139 /* Purposeful off-by-one in width, height fields. For example, a (64, 64)
1140 * texture is stored as (63, 63) in these fields. This adjusts for that.
1141 * There's an identical pattern in the framebuffer descriptor. Even vertex
1142 * count fields work this way, hence the generic name -- integral fields that
1143 * are strictly positive generally need this adjustment. */
1145 #define MALI_POSITIVE(dim) (dim - 1)
1147 /* Used with wrapping. Unclear what top bit conveys */
1149 enum mali_wrap_mode
{
1150 MALI_WRAP_REPEAT
= 0x8 | 0x0,
1151 MALI_WRAP_CLAMP_TO_EDGE
= 0x8 | 0x1,
1152 MALI_WRAP_CLAMP
= 0x8 | 0x2,
1153 MALI_WRAP_CLAMP_TO_BORDER
= 0x8 | 0x3,
1154 MALI_WRAP_MIRRORED_REPEAT
= 0x8 | 0x4 | 0x0,
1155 MALI_WRAP_MIRRORED_CLAMP_TO_EDGE
= 0x8 | 0x4 | 0x1,
1156 MALI_WRAP_MIRRORED_CLAMP
= 0x8 | 0x4 | 0x2,
1157 MALI_WRAP_MIRRORED_CLAMP_TO_BORDER
= 0x8 | 0x4 | 0x3,
1160 /* Shared across both command stream and Midgard, and even with Bifrost */
1162 enum mali_texture_type
{
1163 MALI_TEX_CUBE
= 0x0,
1170 #define MAX_MIP_LEVELS (13)
1172 /* Cubemap bloats everything up */
1173 #define MAX_CUBE_FACES (6)
1175 /* For each pointer, there is an address and optionally also a stride */
1176 #define MAX_ELEMENTS (2)
1178 /* It's not known why there are 4-bits allocated -- this enum is almost
1179 * certainly incomplete */
1181 enum mali_texture_layout
{
1182 /* For a Z/S texture, this is linear */
1183 MALI_TEXTURE_TILED
= 0x1,
1185 /* Z/S textures cannot be tiled */
1186 MALI_TEXTURE_LINEAR
= 0x2,
1189 MALI_TEXTURE_AFBC
= 0xC
1192 /* Corresponds to the type passed to glTexImage2D and so forth */
1194 struct mali_texture_format
{
1195 unsigned swizzle
: 12;
1196 enum mali_format format
: 8;
1199 unsigned unknown1
: 1;
1201 enum mali_texture_type type
: 2;
1202 enum mali_texture_layout layout
: 4;
1205 unsigned unknown2
: 1;
1207 /* Set to allow packing an explicit stride */
1208 unsigned manual_stride
: 1;
1211 } __attribute__((packed
));
1213 struct mali_texture_descriptor
{
1217 uint16_t array_size
;
1219 struct mali_texture_format format
;
1223 /* One for non-mipmapped, zero for mipmapped */
1226 /* Zero for non-mipmapped, (number of levels - 1) for mipmapped */
1229 /* Swizzling is a single 32-bit word, broken up here for convenience.
1230 * Here, swizzling refers to the ES 3.0 texture parameters for channel
1231 * level swizzling, not the internal pixel-level swizzling which is
1232 * below OpenGL's reach */
1234 unsigned swizzle
: 12;
1235 unsigned swizzle_zero
: 20;
1240 } __attribute__((packed
));
1242 /* While Midgard texture descriptors are variable length, Bifrost descriptors
1243 * are fixed like samplers with more pointers to expand if necessary */
1245 struct bifrost_texture_descriptor
{
1246 unsigned format_unk
: 4; /* 2 */
1247 enum mali_texture_type type
: 2;
1248 unsigned format_unk2
: 16; /* 0 */
1249 enum mali_format format
: 8;
1251 unsigned format_unk3
: 1; /* 0 */
1253 uint16_t width
; /* MALI_POSITIVE */
1254 uint16_t height
; /* MALI_POSITIVE */
1256 /* OpenGL swizzle */
1257 unsigned swizzle
: 12;
1258 unsigned unk0
: 4; /* 1 */
1259 uint8_t levels
: 8; /* Number of levels-1 if mipmapped, 0 if not */
1262 unsigned levels_unk
: 24; /* 0 */
1263 unsigned level_2
: 8; /* Number of levels, again? */
1267 uint16_t array_size
;
1272 } __attribute__((packed
));
1276 #define MALI_SAMP_MAG_NEAREST (1 << 0)
1277 #define MALI_SAMP_MIN_NEAREST (1 << 1)
1279 /* TODO: What do these bits mean individually? Only seen set together */
1281 #define MALI_SAMP_MIP_LINEAR_1 (1 << 3)
1282 #define MALI_SAMP_MIP_LINEAR_2 (1 << 4)
1284 /* Flag in filter_mode, corresponding to OpenCL's NORMALIZED_COORDS_TRUE
1285 * sampler_t flag. For typical OpenGL textures, this is always set. */
1287 #define MALI_SAMP_NORM_COORDS (1 << 5)
1289 /* Used for lod encoding. Thanks @urjaman for pointing out these routines can
1290 * be cleaned up a lot. */
1292 #define DECODE_FIXED_16(x) ((float) (x / 256.0))
1294 static inline int16_t
1295 FIXED_16(float x
, bool allow_negative
)
1297 /* Clamp inputs, accounting for float error */
1298 float max_lod
= (32.0 - (1.0 / 512.0));
1299 float min_lod
= allow_negative
? -max_lod
: 0.0;
1301 x
= ((x
> max_lod
) ? max_lod
: ((x
< min_lod
) ? min_lod
: x
));
1303 return (int) (x
* 256.0);
1306 struct mali_sampler_descriptor
{
1307 uint16_t filter_mode
;
1309 /* Fixed point, signed.
1310 * Upper 7 bits before the decimal point, although it caps [0-31].
1311 * Lower 8 bits after the decimal point: int(round(x * 256)) */
1317 /* All one word in reality, but packed a bit. Comparisons are flipped
1320 enum mali_wrap_mode wrap_s
: 4;
1321 enum mali_wrap_mode wrap_t
: 4;
1322 enum mali_wrap_mode wrap_r
: 4;
1323 enum mali_func compare_func
: 3;
1325 /* No effect on 2D textures. For cubemaps, set for ES3 and clear for
1326 * ES2, controlling seamless cubemapping */
1327 unsigned seamless_cube_map
: 1;
1332 float border_color
[4];
1333 } __attribute__((packed
));
1335 /* Bifrost sampler descriptors look pretty similar */
1337 #define BIFROST_SAMP_MIN_NEAREST (1)
1338 #define BIFROST_SAMP_MAG_LINEAR (1)
1340 struct bifrost_sampler_descriptor
{
1343 enum mali_wrap_mode wrap_s
: 4;
1344 enum mali_wrap_mode wrap_t
: 4;
1345 enum mali_wrap_mode wrap_r
: 4;
1349 uint8_t min_filter
: 1;
1350 uint8_t norm_coords
: 1;
1352 uint8_t mip_filter
: 1;
1353 uint8_t mag_filter
: 1;
1362 } __attribute__((packed
));
1364 /* viewport0/viewport1 form the arguments to glViewport. viewport1 is
1365 * modified by MALI_POSITIVE; viewport0 is as-is.
1368 struct mali_viewport
{
1369 /* XY clipping planes */
1375 /* Depth clipping planes */
1381 } __attribute__((packed
));
1383 /* From presentations, 16x16 tiles externally. Use shift for fast computation
1384 * of tile numbers. */
1386 #define MALI_TILE_SHIFT 4
1387 #define MALI_TILE_LENGTH (1 << MALI_TILE_SHIFT)
1389 /* Tile coordinates are stored as a compact u32, as only 12 bits are needed to
1390 * each component. Notice that this provides a theoretical upper bound of (1 <<
1391 * 12) = 4096 tiles in each direction, addressing a maximum framebuffer of size
1392 * 65536x65536. Multiplying that together, times another four given that Mali
1393 * framebuffers are 32-bit ARGB8888, means that this upper bound would take 16
1394 * gigabytes of RAM just to store the uncompressed framebuffer itself, let
1395 * alone rendering in real-time to such a buffer.
1399 /* From mali_kbase_10969_workaround.c */
1400 #define MALI_X_COORD_MASK 0x00000FFF
1401 #define MALI_Y_COORD_MASK 0x0FFF0000
1403 /* Extract parts of a tile coordinate */
1405 #define MALI_TILE_COORD_X(coord) ((coord) & MALI_X_COORD_MASK)
1406 #define MALI_TILE_COORD_Y(coord) (((coord) & MALI_Y_COORD_MASK) >> 16)
1408 /* Helpers to generate tile coordinates based on the boundary coordinates in
1409 * screen space. So, with the bounds (0, 0) to (128, 128) for the screen, these
1410 * functions would convert it to the bounding tiles (0, 0) to (7, 7).
1411 * Intentional "off-by-one"; finding the tile number is a form of fencepost
1414 #define MALI_MAKE_TILE_COORDS(X, Y) ((X) | ((Y) << 16))
1415 #define MALI_BOUND_TO_TILE(B, bias) ((B - bias) >> MALI_TILE_SHIFT)
1416 #define MALI_COORDINATE_TO_TILE(W, H, bias) MALI_MAKE_TILE_COORDS(MALI_BOUND_TO_TILE(W, bias), MALI_BOUND_TO_TILE(H, bias))
1417 #define MALI_COORDINATE_TO_TILE_MIN(W, H) MALI_COORDINATE_TO_TILE(W, H, 0)
1418 #define MALI_COORDINATE_TO_TILE_MAX(W, H) MALI_COORDINATE_TO_TILE(W, H, 1)
1420 struct mali_payload_fragment
{
1423 mali_ptr framebuffer
;
1424 } __attribute__((packed
));
1426 /* Single Framebuffer Descriptor */
1428 /* Flags apply to format. With just MSAA_A and MSAA_B, the framebuffer is
1429 * configured for 4x. With MSAA_8, it is configured for 8x. */
1431 #define MALI_SFBD_FORMAT_MSAA_8 (1 << 3)
1432 #define MALI_SFBD_FORMAT_MSAA_A (1 << 4)
1433 #define MALI_SFBD_FORMAT_MSAA_B (1 << 4)
1434 #define MALI_SFBD_FORMAT_SRGB (1 << 5)
1436 /* Fast/slow based on whether all three buffers are cleared at once */
1438 #define MALI_CLEAR_FAST (1 << 18)
1439 #define MALI_CLEAR_SLOW (1 << 28)
1440 #define MALI_CLEAR_SLOW_STENCIL (1 << 31)
1442 /* Configures hierarchical tiling on Midgard for both SFBD/MFBD (embedded
1443 * within the larget framebuffer descriptor). Analogous to
1444 * bifrost_tiler_heap_meta and bifrost_tiler_meta*/
1446 /* See pan_tiler.c for derivation */
1447 #define MALI_HIERARCHY_MASK ((1 << 9) - 1)
1449 /* Flag disabling the tiler for clear-only jobs, with
1450 hierarchical tiling */
1451 #define MALI_TILER_DISABLED (1 << 12)
1453 /* Flag selecting userspace-generated polygon list, for clear-only jobs without
1454 * hierarhical tiling. */
1455 #define MALI_TILER_USER 0xFFF
1457 /* Absent any geometry, the minimum size of the polygon list header */
1458 #define MALI_TILER_MINIMUM_HEADER_SIZE 0x200
1460 struct midgard_tiler_descriptor
{
1461 /* Size of the entire polygon list; see pan_tiler.c for the
1462 * computation. It's based on hierarchical tiling */
1464 u32 polygon_list_size
;
1466 /* Name known from the replay workaround in the kernel. What exactly is
1467 * flagged here is less known. We do that (tiler_hierarchy_mask & 0x1ff)
1468 * specifies a mask of hierarchy weights, which explains some of the
1469 * performance mysteries around setting it. We also see the bottom bit
1470 * of tiler_flags set in the kernel, but no comment why.
1472 * hierarchy_mask can have the TILER_DISABLED flag */
1477 /* See mali_tiler.c for an explanation */
1478 mali_ptr polygon_list
;
1479 mali_ptr polygon_list_body
;
1481 /* Names based on we see symmetry with replay jobs which name these
1484 mali_ptr heap_start
; /* tiler heap_free_address */
1487 /* Hierarchy weights. We know these are weights based on the kernel,
1488 * but I've never seen them be anything other than zero */
1492 enum mali_block_format
{
1493 MALI_BLOCK_TILED
= 0x0,
1494 MALI_BLOCK_UNKNOWN
= 0x1,
1495 MALI_BLOCK_LINEAR
= 0x2,
1496 MALI_BLOCK_AFBC
= 0x3,
1499 struct mali_sfbd_format
{
1503 /* mali_channel_swizzle */
1504 unsigned swizzle
: 12;
1507 unsigned nr_channels
: 2;
1512 enum mali_block_format block
: 2;
1518 /* Shared structure at the start of framebuffer descriptors, or used bare for
1519 * compute jobs, configuring stack and shared memory */
1521 struct mali_shared_memory
{
1522 u32 stack_shift
: 4;
1525 /* Configuration for shared memory for compute shaders.
1526 * shared_workgroup_count is logarithmic and may be computed for a
1527 * compute shader using shared memory as:
1529 * shared_workgroup_count = MAX2(ceil(log2(count_x)) + ... + ceil(log2(count_z), 10)
1531 * For compute shaders that don't use shared memory, or non-compute
1532 * shaders, this is set to ~0
1535 u32 shared_workgroup_count
: 5;
1536 u32 shared_unk1
: 3;
1537 u32 shared_shift
: 4;
1538 u32 shared_zero
: 20;
1540 mali_ptr scratchpad
;
1542 /* For compute shaders, the RAM backing of workgroup-shared memory. For
1543 * fragment shaders on Bifrost, apparently multisampling locations */
1545 mali_ptr shared_memory
;
1547 } __attribute__((packed
));
1549 /* Configures multisampling on Bifrost fragment jobs */
1551 struct bifrost_multisampling
{
1554 mali_ptr sample_locations
;
1556 } __attribute__((packed
));
1558 struct mali_single_framebuffer
{
1559 struct mali_shared_memory shared_memory
;
1560 struct mali_sfbd_format format
;
1565 /* Purposeful off-by-one in these fields should be accounted for by the
1566 * MALI_DIMENSION macro */
1573 u32 checksum_stride
;
1576 /* By default, the framebuffer is upside down from OpenGL's
1577 * perspective. Set framebuffer to the end and negate the stride to
1578 * flip in the Y direction */
1580 mali_ptr framebuffer
;
1585 /* Depth and stencil buffers are interleaved, it appears, as they are
1586 * set to the same address in captures. Both fields set to zero if the
1587 * buffer is not being cleared. Depending on GL_ENABLE magic, you might
1588 * get a zero enable despite the buffer being present; that still is
1591 mali_ptr depth_buffer
; // not SAME_VA
1592 u32 depth_stride_zero
: 4;
1593 u32 depth_stride
: 28;
1596 mali_ptr stencil_buffer
; // not SAME_VA
1597 u32 stencil_stride_zero
: 4;
1598 u32 stencil_stride
: 28;
1601 u32 clear_color_1
; // RGBA8888 from glClear, actually used by hardware
1602 u32 clear_color_2
; // always equal, but unclear function?
1603 u32 clear_color_3
; // always equal, but unclear function?
1604 u32 clear_color_4
; // always equal, but unclear function?
1606 /* Set to zero if not cleared */
1608 float clear_depth_1
; // float32, ditto
1609 float clear_depth_2
; // float32, ditto
1610 float clear_depth_3
; // float32, ditto
1611 float clear_depth_4
; // float32, ditto
1613 u32 clear_stencil
; // Exactly as it appears in OpenGL
1617 struct midgard_tiler_descriptor tiler
;
1619 /* More below this, maybe */
1620 } __attribute__((packed
));
1622 /* Format bits for the render target flags */
1624 #define MALI_MFBD_FORMAT_MSAA (1 << 1)
1625 #define MALI_MFBD_FORMAT_SRGB (1 << 2)
1627 struct mali_rt_format
{
1631 unsigned nr_channels
: 2; /* MALI_POSITIVE */
1634 enum mali_block_format block
: 2;
1637 unsigned swizzle
: 12;
1641 /* Disables MFBD preload. When this bit is set, the render target will
1642 * be cleared every frame. When this bit is clear, the hardware will
1643 * automatically wallpaper the render target back from main memory.
1644 * Unfortunately, MFBD preload is very broken on Midgard, so in
1645 * practice, this is a chicken bit that should always be set.
1646 * Discovered by accident, as all good chicken bits are. */
1648 unsigned no_preload
: 1;
1649 } __attribute__((packed
));
1651 struct mali_render_target
{
1652 struct mali_rt_format format
;
1657 /* Stuff related to ARM Framebuffer Compression. When AFBC is enabled,
1658 * there is an extra metadata buffer that contains 16 bytes per tile.
1659 * The framebuffer needs to be the same size as before, since we don't
1660 * know ahead of time how much space it will take up. The
1661 * framebuffer_stride is set to 0, since the data isn't stored linearly
1664 * When AFBC is disabled, these fields are zero.
1668 u32 stride
; // stride in units of tiles
1669 u32 unk
; // = 0x20000
1672 mali_ptr framebuffer
;
1675 u32 framebuffer_stride
: 28; // in units of bytes
1678 u32 clear_color_1
; // RGBA8888 from glClear, actually used by hardware
1679 u32 clear_color_2
; // always equal, but unclear function?
1680 u32 clear_color_3
; // always equal, but unclear function?
1681 u32 clear_color_4
; // always equal, but unclear function?
1682 } __attribute__((packed
));
1684 /* An optional part of mali_framebuffer. It comes between the main structure
1685 * and the array of render targets. It must be included if any of these are
1688 * - Transaction Elimination
1690 * - TODO: Anything else?
1694 #define MALI_EXTRA_PRESENT (0x10)
1697 #define MALI_EXTRA_ZS (0x4)
1699 struct mali_framebuffer_extra
{
1701 /* Each tile has an 8 byte checksum, so the stride is "width in tiles * 8" */
1702 u32 checksum_stride
;
1704 unsigned flags_lo
: 4;
1705 enum mali_block_format zs_block
: 2;
1706 unsigned flags_hi
: 26;
1709 /* Note: AFBC is only allowed for 24/8 combined depth/stencil. */
1711 mali_ptr depth_stencil_afbc_metadata
;
1712 u32 depth_stencil_afbc_stride
; // in units of tiles
1715 mali_ptr depth_stencil
;
1721 /* Depth becomes depth/stencil in case of combined D/S */
1723 u32 depth_stride_zero
: 4;
1724 u32 depth_stride
: 28;
1728 u32 stencil_stride_zero
: 4;
1729 u32 stencil_stride
: 28;
1738 } __attribute__((packed
));
1740 /* Flags for mfbd_flags */
1742 /* Enables writing depth results back to main memory (rather than keeping them
1743 * on-chip in the tile buffer and then discarding) */
1745 #define MALI_MFBD_DEPTH_WRITE (1 << 10)
1747 /* The MFBD contains the extra mali_framebuffer_extra section */
1749 #define MALI_MFBD_EXTRA (1 << 13)
1751 struct mali_framebuffer
{
1753 struct mali_shared_memory shared_memory
;
1754 struct bifrost_multisampling msaa
;
1758 u16 width1
, height1
;
1760 u16 width2
, height2
;
1761 u32 unk1
: 19; // = 0x01000
1762 u32 rt_count_1
: 2; // off-by-one (use MALI_POSITIVE)
1763 u32 unk2
: 3; // = 0
1764 u32 rt_count_2
: 3; // no off-by-one
1767 u32 clear_stencil
: 8;
1768 u32 mfbd_flags
: 24; // = 0x100
1772 struct midgard_tiler_descriptor tiler
;
1774 mali_ptr tiler_meta
;
1779 /* optional: struct mali_framebuffer_extra extra */
1780 /* struct mali_render_target rts[] */
1781 } __attribute__((packed
));
1783 #endif /* __PANFROST_JOB_H__ */