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__
32 #include <panfrost-misc.h>
37 JOB_TYPE_WRITE_VALUE
= 2,
38 JOB_TYPE_CACHE_FLUSH
= 3,
41 JOB_TYPE_GEOMETRY
= 6,
44 JOB_TYPE_FRAGMENT
= 9,
51 MALI_LINE_STRIP
= 0x4,
54 MALI_TRIANGLE_STRIP
= 0xA,
55 MALI_TRIANGLE_FAN
= 0xC,
58 MALI_QUAD_STRIP
= 0xF,
60 /* All other modes invalid */
63 /* Applies to tiler_gl_enables */
65 #define MALI_OCCLUSION_QUERY (1 << 3)
66 #define MALI_OCCLUSION_PRECISE (1 << 4)
68 /* Set for a glFrontFace(GL_CCW) in a Y=0=TOP coordinate system (like Gallium).
69 * In OpenGL, this would corresponds to glFrontFace(GL_CW). Mesa and the blob
70 * disagree about how to do viewport flipping, so the blob actually sets this
71 * for GL_CW but then has a negative viewport stride */
73 #define MALI_FRONT_CCW_TOP (1 << 5)
75 #define MALI_CULL_FACE_FRONT (1 << 6)
76 #define MALI_CULL_FACE_BACK (1 << 7)
78 /* Used in stencil and depth tests */
85 MALI_FUNC_GREATER
= 4,
86 MALI_FUNC_NOTEQUAL
= 5,
91 /* Same OpenGL, but mixed up. Why? Because forget me, that's why! */
94 MALI_ALT_FUNC_NEVER
= 0,
95 MALI_ALT_FUNC_GREATER
= 1,
96 MALI_ALT_FUNC_EQUAL
= 2,
97 MALI_ALT_FUNC_GEQUAL
= 3,
98 MALI_ALT_FUNC_LESS
= 4,
99 MALI_ALT_FUNC_NOTEQUAL
= 5,
100 MALI_ALT_FUNC_LEQUAL
= 6,
101 MALI_ALT_FUNC_ALWAYS
= 7
104 /* Flags apply to unknown2_3? */
106 #define MALI_HAS_MSAA (1 << 0)
107 #define MALI_CAN_DISCARD (1 << 5)
109 /* Applies on SFBD systems, specifying that programmable blending is in use */
110 #define MALI_HAS_BLEND_SHADER (1 << 6)
112 /* func is mali_func */
113 #define MALI_DEPTH_FUNC(func) (func << 8)
114 #define MALI_GET_DEPTH_FUNC(flags) ((flags >> 8) & 0x7)
115 #define MALI_DEPTH_FUNC_MASK MALI_DEPTH_FUNC(0x7)
117 #define MALI_DEPTH_WRITEMASK (1 << 11)
119 /* Next flags to unknown2_4 */
120 #define MALI_STENCIL_TEST (1 << 0)
123 #define MALI_SAMPLE_ALPHA_TO_COVERAGE_NO_BLEND_SHADER (1 << 1)
125 #define MALI_NO_DITHER (1 << 9)
126 #define MALI_DEPTH_RANGE_A (1 << 12)
127 #define MALI_DEPTH_RANGE_B (1 << 13)
128 #define MALI_NO_MSAA (1 << 14)
130 /* Stencil test state is all encoded in a single u32, just with a lot of
133 enum mali_stencil_op
{
134 MALI_STENCIL_KEEP
= 0,
135 MALI_STENCIL_REPLACE
= 1,
136 MALI_STENCIL_ZERO
= 2,
137 MALI_STENCIL_INVERT
= 3,
138 MALI_STENCIL_INCR_WRAP
= 4,
139 MALI_STENCIL_DECR_WRAP
= 5,
140 MALI_STENCIL_INCR
= 6,
141 MALI_STENCIL_DECR
= 7
144 struct mali_stencil_test
{
147 enum mali_func func
: 3;
148 enum mali_stencil_op sfail
: 3;
149 enum mali_stencil_op dpfail
: 3;
150 enum mali_stencil_op dppass
: 3;
152 } __attribute__((packed
));
154 #define MALI_MASK_R (1 << 0)
155 #define MALI_MASK_G (1 << 1)
156 #define MALI_MASK_B (1 << 2)
157 #define MALI_MASK_A (1 << 3)
159 enum mali_nondominant_mode
{
160 MALI_BLEND_NON_MIRROR
= 0,
161 MALI_BLEND_NON_ZERO
= 1
164 enum mali_dominant_blend
{
165 MALI_BLEND_DOM_SOURCE
= 0,
166 MALI_BLEND_DOM_DESTINATION
= 1
169 enum mali_dominant_factor
{
170 MALI_DOMINANT_UNK0
= 0,
171 MALI_DOMINANT_ZERO
= 1,
172 MALI_DOMINANT_SRC_COLOR
= 2,
173 MALI_DOMINANT_DST_COLOR
= 3,
174 MALI_DOMINANT_UNK4
= 4,
175 MALI_DOMINANT_SRC_ALPHA
= 5,
176 MALI_DOMINANT_DST_ALPHA
= 6,
177 MALI_DOMINANT_CONSTANT
= 7,
180 enum mali_blend_modifier
{
181 MALI_BLEND_MOD_UNK0
= 0,
182 MALI_BLEND_MOD_NORMAL
= 1,
183 MALI_BLEND_MOD_SOURCE_ONE
= 2,
184 MALI_BLEND_MOD_DEST_ONE
= 3,
187 struct mali_blend_mode
{
188 enum mali_blend_modifier clip_modifier
: 2;
189 unsigned unused_0
: 1;
190 unsigned negate_source
: 1;
192 enum mali_dominant_blend dominant
: 1;
194 enum mali_nondominant_mode nondominant_mode
: 1;
196 unsigned unused_1
: 1;
198 unsigned negate_dest
: 1;
200 enum mali_dominant_factor dominant_factor
: 3;
201 unsigned complement_dominant
: 1;
202 } __attribute__((packed
));
204 struct mali_blend_equation
{
205 /* Of type mali_blend_mode */
206 unsigned rgb_mode
: 12;
207 unsigned alpha_mode
: 12;
211 /* Corresponds to MALI_MASK_* above and glColorMask arguments */
213 unsigned color_mask
: 4;
214 } __attribute__((packed
));
216 /* Used with channel swizzling */
218 MALI_CHANNEL_RED
= 0,
219 MALI_CHANNEL_GREEN
= 1,
220 MALI_CHANNEL_BLUE
= 2,
221 MALI_CHANNEL_ALPHA
= 3,
222 MALI_CHANNEL_ZERO
= 4,
223 MALI_CHANNEL_ONE
= 5,
224 MALI_CHANNEL_RESERVED_0
= 6,
225 MALI_CHANNEL_RESERVED_1
= 7,
228 struct mali_channel_swizzle
{
229 enum mali_channel r
: 3;
230 enum mali_channel g
: 3;
231 enum mali_channel b
: 3;
232 enum mali_channel a
: 3;
233 } __attribute__((packed
));
235 /* Compressed per-pixel formats. Each of these formats expands to one to four
236 * floating-point or integer numbers, as defined by the OpenGL specification.
237 * There are various places in OpenGL where the user can specify a compressed
238 * format in memory, which all use the same 8-bit enum in the various
239 * descriptors, although different hardware units support different formats.
242 /* The top 3 bits specify how the bits of each component are interpreted. */
244 /* e.g. R11F_G11F_B10F */
245 #define MALI_FORMAT_SPECIAL (2 << 5)
247 /* signed normalized, e.g. RGBA8_SNORM */
248 #define MALI_FORMAT_SNORM (3 << 5)
251 #define MALI_FORMAT_UINT (4 << 5)
253 /* e.g. RGBA8 and RGBA32F */
254 #define MALI_FORMAT_UNORM (5 << 5)
256 /* e.g. RGBA8I and RGBA16F */
257 #define MALI_FORMAT_SINT (6 << 5)
259 /* These formats seem to largely duplicate the others. They're used at least
260 * for Bifrost framebuffer output.
262 #define MALI_FORMAT_SPECIAL2 (7 << 5)
264 /* If the high 3 bits are 3 to 6 these two bits say how many components
267 #define MALI_NR_CHANNELS(n) ((n - 1) << 3)
269 /* If the high 3 bits are 3 to 6, then the low 3 bits say how big each
270 * component is, except the special MALI_CHANNEL_FLOAT which overrides what the
274 #define MALI_CHANNEL_4 2
276 #define MALI_CHANNEL_8 3
278 #define MALI_CHANNEL_16 4
280 #define MALI_CHANNEL_32 5
282 /* For MALI_FORMAT_SINT it means a half-float (e.g. RG16F). For
283 * MALI_FORMAT_UNORM, it means a 32-bit float.
285 #define MALI_CHANNEL_FLOAT 7
288 MALI_RGB565
= MALI_FORMAT_SPECIAL
| 0x0,
289 MALI_RGB5_A1_UNORM
= MALI_FORMAT_SPECIAL
| 0x2,
290 MALI_RGB10_A2_UNORM
= MALI_FORMAT_SPECIAL
| 0x3,
291 MALI_RGB10_A2_SNORM
= MALI_FORMAT_SPECIAL
| 0x5,
292 MALI_RGB10_A2UI
= MALI_FORMAT_SPECIAL
| 0x7,
293 MALI_RGB10_A2I
= MALI_FORMAT_SPECIAL
| 0x9,
296 MALI_NV12
= MALI_FORMAT_SPECIAL
| 0xc,
298 MALI_Z32_UNORM
= MALI_FORMAT_SPECIAL
| 0xD,
299 MALI_R32_FIXED
= MALI_FORMAT_SPECIAL
| 0x11,
300 MALI_RG32_FIXED
= MALI_FORMAT_SPECIAL
| 0x12,
301 MALI_RGB32_FIXED
= MALI_FORMAT_SPECIAL
| 0x13,
302 MALI_RGBA32_FIXED
= MALI_FORMAT_SPECIAL
| 0x14,
303 MALI_R11F_G11F_B10F
= MALI_FORMAT_SPECIAL
| 0x19,
304 MALI_R9F_G9F_B9F_E5F
= MALI_FORMAT_SPECIAL
| 0x1b,
305 /* Only used for varyings, to indicate the transformed gl_Position */
306 MALI_VARYING_POS
= MALI_FORMAT_SPECIAL
| 0x1e,
307 /* Only used for varyings, to indicate that the write should be
310 MALI_VARYING_DISCARD
= MALI_FORMAT_SPECIAL
| 0x1f,
312 MALI_R8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
313 MALI_R16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
314 MALI_R32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
315 MALI_RG8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
316 MALI_RG16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
317 MALI_RG32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
318 MALI_RGB8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
319 MALI_RGB16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
320 MALI_RGB32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
321 MALI_RGBA8_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
322 MALI_RGBA16_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
323 MALI_RGBA32_SNORM
= MALI_FORMAT_SNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
325 MALI_R8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
326 MALI_R16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
327 MALI_R32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
328 MALI_RG8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
329 MALI_RG16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
330 MALI_RG32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
331 MALI_RGB8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
332 MALI_RGB16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
333 MALI_RGB32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
334 MALI_RGBA8UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
335 MALI_RGBA16UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
336 MALI_RGBA32UI
= MALI_FORMAT_UINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
338 MALI_R8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
339 MALI_R16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
340 MALI_R32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
341 MALI_R32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_FLOAT
,
342 MALI_RG8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
343 MALI_RG16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
344 MALI_RG32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
345 MALI_RG32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_FLOAT
,
346 MALI_RGB8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
347 MALI_RGB16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
348 MALI_RGB32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
349 MALI_RGB32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_FLOAT
,
350 MALI_RGBA4_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_4
,
351 MALI_RGBA8_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
352 MALI_RGBA16_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
353 MALI_RGBA32_UNORM
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
354 MALI_RGBA32F
= MALI_FORMAT_UNORM
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_FLOAT
,
356 MALI_R8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_8
,
357 MALI_R16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_16
,
358 MALI_R32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_32
,
359 MALI_R16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(1) | MALI_CHANNEL_FLOAT
,
360 MALI_RG8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_8
,
361 MALI_RG16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_16
,
362 MALI_RG32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_32
,
363 MALI_RG16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(2) | MALI_CHANNEL_FLOAT
,
364 MALI_RGB8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_8
,
365 MALI_RGB16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_16
,
366 MALI_RGB32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_32
,
367 MALI_RGB16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(3) | MALI_CHANNEL_FLOAT
,
368 MALI_RGBA8I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_8
,
369 MALI_RGBA16I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_16
,
370 MALI_RGBA32I
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_32
,
371 MALI_RGBA16F
= MALI_FORMAT_SINT
| MALI_NR_CHANNELS(4) | MALI_CHANNEL_FLOAT
,
373 MALI_RGBA4
= MALI_FORMAT_SPECIAL2
| 0x8,
374 MALI_RGBA8_2
= MALI_FORMAT_SPECIAL2
| 0xd,
375 MALI_RGB10_A2_2
= MALI_FORMAT_SPECIAL2
| 0xe,
379 /* Alpha coverage is encoded as 4-bits (from a clampf), with inversion
380 * literally performing a bitwise invert. This function produces slightly wrong
381 * results and I'm not sure why; some rounding issue I suppose... */
383 #define MALI_ALPHA_COVERAGE(clampf) ((uint16_t) (int) (clampf * 15.0f))
384 #define MALI_GET_ALPHA_COVERAGE(nibble) ((float) nibble / 15.0f)
386 /* Applies to midgard1.flags */
388 /* Should the hardware perform early-Z testing? Normally should be set
389 * for performance reasons. Clear if you use: discard,
390 * alpha-to-coverage... * It's also possible this disables
391 * forward-pixel kill; we're not quite sure which bit is which yet.
392 * TODO: How does this interact with blending?*/
394 #define MALI_EARLY_Z (1 << 6)
396 /* Should the hardware calculate derivatives (via helper invocations)? Set in a
397 * fragment shader that uses texturing or derivative functions */
399 #define MALI_HELPER_INVOCATIONS (1 << 7)
401 /* Flags denoting the fragment shader's use of tilebuffer readback. If the
402 * shader might read any part of the tilebuffer, set MALI_READS_TILEBUFFER. If
403 * it might read depth/stencil in particular, also set MALI_READS_ZS */
405 #define MALI_READS_ZS (1 << 8)
406 #define MALI_READS_TILEBUFFER (1 << 12)
408 /* The raw Midgard blend payload can either be an equation or a shader
409 * address, depending on the context */
411 union midgard_blend
{
415 struct mali_blend_equation equation
;
420 /* We need to load the tilebuffer to blend (i.e. the destination factor is not
423 #define MALI_BLEND_LOAD_TIB (0x1)
425 /* A blend shader is used to blend this render target */
426 #define MALI_BLEND_MRT_SHADER (0x2)
428 /* On MRT Midgard systems (using an MFBD), each render target gets its own
429 * blend descriptor */
431 #define MALI_BLEND_SRGB (0x400)
433 /* Dithering is specified here for MFBD, otherwise NO_DITHER for SFBD */
434 #define MALI_BLEND_NO_DITHER (0x800)
436 struct midgard_blend_rt
{
437 /* Flags base value of 0x200 to enable the render target.
438 * OR with 0x1 for blending (anything other than REPLACE).
439 * OR with 0x2 for programmable blending
440 * OR with MALI_BLEND_SRGB for implicit sRGB
444 union midgard_blend blend
;
445 } __attribute__((packed
));
447 /* On Bifrost systems (all MRT), each render target gets one of these
450 struct bifrost_blend_rt
{
451 /* This is likely an analogue of the flags on
452 * midgard_blend_rt */
454 u16 flags
; // = 0x200
456 /* Single-channel blend constants are encoded in a sort of
457 * fixed-point. Basically, the float is mapped to a byte, becoming
458 * a high byte, and then the lower-byte is added for precision.
459 * For the original float f:
461 * f = (constant_hi / 255) + (constant_lo / 65535)
463 * constant_hi = int(f / 255)
464 * constant_lo = 65535*f - (65535/255) * constant_hi
469 struct mali_blend_equation equation
;
472 * - 0x3 when this slot is unused (everything else is 0 except the index)
473 * - 0x11 when this is the fourth slot (and it's used)
474 + * - 0 when there is a blend shader
477 /* increments from 0 to 3 */
482 /* So far, I've only seen:
483 * - R001 for 1-component formats
484 * - RG01 for 2-component formats
485 * - RGB1 for 3-component formats
486 * - RGBA for 4-component formats
489 enum mali_format format
: 8;
491 /* Type of the shader output variable. Note, this can
492 * be different from the format.
494 * 0: f16 (mediump float)
495 * 1: f32 (highp float)
497 * 3: u32 (highp uint)
498 * 4: i16 (mediump int)
499 * 5: u16 (mediump uint)
505 /* Only the low 32 bits of the blend shader are stored, the
506 * high 32 bits are implicitly the same as the original shader.
507 * According to the kernel driver, the program counter for
508 * shaders is actually only 24 bits, so shaders cannot cross
509 * the 2^24-byte boundary, and neither can the blend shader.
510 * The blob handles this by allocating a 2^24 byte pool for
511 * shaders, and making sure that any blend shaders are stored
512 * in the same pool as the original shader. The kernel will
513 * make sure this allocation is aligned to 2^24 bytes.
517 } __attribute__((packed
));
519 /* Descriptor for the shader. Following this is at least one, up to four blend
520 * descriptors for each active render target */
522 struct mali_shader_meta
{
531 u32 uniform_buffer_count
: 4;
532 u32 unk1
: 28; // = 0x800000 for vertex, 0x958020 for tiler
535 unsigned uniform_buffer_count
: 4;
538 /* Whole number of uniform registers used, times two;
539 * whole number of work registers used (no scale).
541 unsigned work_count
: 5;
542 unsigned uniform_count
: 5;
543 unsigned unknown2
: 6;
547 /* Same as glPolygoOffset() arguments */
556 u8 stencil_mask_front
;
557 u8 stencil_mask_back
;
560 struct mali_stencil_test stencil_front
;
561 struct mali_stencil_test stencil_back
;
566 /* On Bifrost, some system values are preloaded in
567 * registers R55-R62 by the thread dispatcher prior to
568 * the start of shader execution. This is a bitfield
569 * with one entry for each register saying which
570 * registers need to be preloaded. Right now, the known
574 * - R55 : gl_LocalInvocationID.xy
575 * - R56 : gl_LocalInvocationID.z + unknown in high 16 bits
576 * - R57 : gl_WorkGroupID.x
577 * - R58 : gl_WorkGroupID.y
578 * - R59 : gl_WorkGroupID.z
579 * - R60 : gl_GlobalInvocationID.x
580 * - R61 : gl_GlobalInvocationID.y/gl_VertexID (without base)
581 * - R62 : gl_GlobalInvocationID.z/gl_InstanceID (without base)
584 * - R55 : unknown, never seen (but the bit for this is
586 * - R56 : unknown (bit always unset)
587 * - R57 : gl_PrimitiveID
588 * - R58 : gl_FrontFacing in low bit, potentially other stuff
589 * - R59 : u16 fragment coordinates (used to compute
590 * gl_FragCoord.xy, together with sample positions)
591 * - R60 : gl_SampleMask (used in epilog, so pretty
592 * much always used, but the bit is always 0 -- is
593 * this just always pushed?)
594 * - R61 : gl_SampleMaskIn and gl_SampleID, used by
595 * varying interpolation.
596 * - R62 : unknown (bit always unset).
598 u32 preload_regs
: 8;
599 /* In units of 8 bytes or 64 bits, since the
600 * uniform/const port loads 64 bits at a time.
602 u32 uniform_count
: 7;
603 u32 unk4
: 10; // = 2
610 /* zero on bifrost */
613 /* Blending information for the older non-MRT Midgard HW. Check for
614 * MALI_HAS_BLEND_SHADER to decide how to interpret.
617 union midgard_blend blend
;
618 } __attribute__((packed
));
620 /* This only concerns hardware jobs */
622 /* Possible values for job_descriptor_size */
624 #define MALI_JOB_32 0
625 #define MALI_JOB_64 1
627 struct mali_job_descriptor_header
{
628 u32 exception_status
;
629 u32 first_incomplete_task
;
631 u8 job_descriptor_size
: 1;
632 enum mali_job_type job_type
: 7;
634 u8 unknown_flags
: 7;
636 u16 job_dependency_index_1
;
637 u16 job_dependency_index_2
;
643 } __attribute__((packed
));
645 /* These concern exception_status */
647 /* Access type causing a fault, paralleling AS_FAULTSTATUS_* entries in the
650 enum mali_exception_access
{
651 /* Atomic in the kernel for MMU, but that doesn't make sense for a job
652 * fault so it's just unused */
653 MALI_EXCEPTION_ACCESS_NONE
= 0,
655 MALI_EXCEPTION_ACCESS_EXECUTE
= 1,
656 MALI_EXCEPTION_ACCESS_READ
= 2,
657 MALI_EXCEPTION_ACCESS_WRITE
= 3
660 /* Details about write_value from panfrost igt tests which use it as a generic
661 * dword write primitive */
663 #define MALI_WRITE_VALUE_ZERO 3
665 struct mali_payload_write_value
{
667 u32 value_descriptor
;
670 } __attribute__((packed
));
672 /* Special attributes have a fixed index */
673 #define MALI_SPECIAL_ATTRIBUTE_BASE 16
674 #define MALI_VERTEX_ID (MALI_SPECIAL_ATTRIBUTE_BASE + 0)
675 #define MALI_INSTANCE_ID (MALI_SPECIAL_ATTRIBUTE_BASE + 1)
680 * This structure lets the attribute unit compute the address of an attribute
681 * given the vertex and instance ID. Unfortunately, the way this works is
682 * rather complicated when instancing is enabled.
684 * To explain this, first we need to explain how compute and vertex threads are
685 * dispatched. This is a guess (although a pretty firm guess!) since the
686 * details are mostly hidden from the driver, except for attribute instancing.
687 * When a quad is dispatched, it receives a single, linear index. However, we
688 * need to translate that index into a (vertex id, instance id) pair, or a
689 * (local id x, local id y, local id z) triple for compute shaders (although
690 * vertex shaders and compute shaders are handled almost identically).
691 * Focusing on vertex shaders, one option would be to do:
693 * vertex_id = linear_id % num_vertices
694 * instance_id = linear_id / num_vertices
696 * but this involves a costly division and modulus by an arbitrary number.
697 * Instead, we could pad num_vertices. We dispatch padded_num_vertices *
698 * num_instances threads instead of num_vertices * num_instances, which results
699 * in some "extra" threads with vertex_id >= num_vertices, which we have to
700 * discard. The more we pad num_vertices, the more "wasted" threads we
701 * dispatch, but the division is potentially easier.
703 * One straightforward choice is to pad num_vertices to the next power of two,
704 * which means that the division and modulus are just simple bit shifts and
705 * masking. But the actual algorithm is a bit more complicated. The thread
706 * dispatcher has special support for dividing by 3, 5, 7, and 9, in addition
707 * to dividing by a power of two. This is possibly using the technique
708 * described in patent US20170010862A1. As a result, padded_num_vertices can be
709 * 1, 3, 5, 7, or 9 times a power of two. This results in less wasted threads,
710 * since we need less padding.
712 * padded_num_vertices is picked by the hardware. The driver just specifies the
713 * actual number of vertices. At least for Mali G71, the first few cases are
716 * num_vertices | padded_num_vertices
723 * Note that padded_num_vertices is a multiple of four (presumably because
724 * threads are dispatched in groups of 4). Also, padded_num_vertices is always
725 * at least one more than num_vertices, which seems like a quirk of the
726 * hardware. For larger num_vertices, the hardware uses the following
727 * algorithm: using the binary representation of num_vertices, we look at the
728 * most significant set bit as well as the following 3 bits. Let n be the
729 * number of bits after those 4 bits. Then we set padded_num_vertices according
730 * to the following table:
732 * high bits | padded_num_vertices
739 * For example, if num_vertices = 70 is passed to glDraw(), its binary
740 * representation is 1000110, so n = 3 and the high bits are 1000, and
741 * therefore padded_num_vertices = 9 * 2^3 = 72.
743 * The attribute unit works in terms of the original linear_id. if
744 * num_instances = 1, then they are the same, and everything is simple.
745 * However, with instancing things get more complicated. There are four
746 * possible modes, two of them we can group together:
748 * 1. Use the linear_id directly. Only used when there is no instancing.
750 * 2. Use the linear_id modulo a constant. This is used for per-vertex
751 * attributes with instancing enabled by making the constant equal
752 * padded_num_vertices. Because the modulus is always padded_num_vertices, this
753 * mode only supports a modulus that is a power of 2 times 1, 3, 5, 7, or 9.
754 * The shift field specifies the power of two, while the extra_flags field
755 * specifies the odd number. If shift = n and extra_flags = m, then the modulus
756 * is (2m + 1) * 2^n. As an example, if num_vertices = 70, then as computed
757 * above, padded_num_vertices = 9 * 2^3, so we should set extra_flags = 4 and
758 * shift = 3. Note that we must exactly follow the hardware algorithm used to
759 * get padded_num_vertices in order to correctly implement per-vertex
762 * 3. Divide the linear_id by a constant. In order to correctly implement
763 * instance divisors, we have to divide linear_id by padded_num_vertices times
764 * to user-specified divisor. So first we compute padded_num_vertices, again
765 * following the exact same algorithm that the hardware uses, then multiply it
766 * by the GL-level divisor to get the hardware-level divisor. This case is
767 * further divided into two more cases. If the hardware-level divisor is a
768 * power of two, then we just need to shift. The shift amount is specified by
769 * the shift field, so that the hardware-level divisor is just 2^shift.
771 * If it isn't a power of two, then we have to divide by an arbitrary integer.
772 * For that, we use the well-known technique of multiplying by an approximation
773 * of the inverse. The driver must compute the magic multiplier and shift
774 * amount, and then the hardware does the multiplication and shift. The
775 * hardware and driver also use the "round-down" optimization as described in
776 * http://ridiculousfish.com/files/faster_unsigned_division_by_constants.pdf.
777 * The hardware further assumes the multiplier is between 2^31 and 2^32, so the
778 * high bit is implicitly set to 1 even though it is set to 0 by the driver --
779 * presumably this simplifies the hardware multiplier a little. The hardware
780 * first multiplies linear_id by the multiplier and takes the high 32 bits,
781 * then applies the round-down correction if extra_flags = 1, then finally
782 * shifts right by the shift field.
784 * There are some differences between ridiculousfish's algorithm and the Mali
785 * hardware algorithm, which means that the reference code from ridiculousfish
786 * doesn't always produce the right constants. Mali does not use the pre-shift
787 * optimization, since that would make a hardware implementation slower (it
788 * would have to always do the pre-shift, multiply, and post-shift operations).
789 * It also forces the multplier to be at least 2^31, which means that the
790 * exponent is entirely fixed, so there is no trial-and-error. Altogether,
791 * given the divisor d, the algorithm the driver must follow is:
793 * 1. Set shift = floor(log2(d)).
794 * 2. Compute m = ceil(2^(shift + 32) / d) and e = 2^(shift + 32) % d.
795 * 3. If e <= 2^shift, then we need to use the round-down algorithm. Set
796 * magic_divisor = m - 1 and extra_flags = 1.
797 * 4. Otherwise, set magic_divisor = m and extra_flags = 0.
799 * Unrelated to instancing/actual attributes, images (the OpenCL kind) are
800 * implemented as special attributes, denoted by MALI_ATTR_IMAGE. For images,
801 * let shift=extra_flags=0. Stride is set to the image format's bytes-per-pixel
802 * (*NOT the row stride*). Size is set to the size of the image itself.
804 * Special internal varyings (including gl_FrontFacing) could be seen as
805 * IMAGE/INTERNAL as well as LINEAR, setting all fields set to zero and using a
806 * special elements pseudo-pointer.
809 enum mali_attr_mode
{
810 MALI_ATTR_UNUSED
= 0,
811 MALI_ATTR_LINEAR
= 1,
812 MALI_ATTR_POT_DIVIDE
= 2,
813 MALI_ATTR_MODULO
= 3,
814 MALI_ATTR_NPOT_DIVIDE
= 4,
816 MALI_ATTR_INTERNAL
= 6
819 /* Pseudo-address for gl_FrontFacing, used with INTERNAL. Same addres is used
820 * for gl_FragCoord with IMAGE, needing a coordinate flip. Who knows. */
822 #define MALI_VARYING_FRAG_COORD (0x25)
823 #define MALI_VARYING_FRONT_FACING (0x26)
825 /* This magic "pseudo-address" is used as `elements` to implement
826 * gl_PointCoord. When read from a fragment shader, it generates a point
827 * coordinate per the OpenGL ES 2.0 specification. Flipped coordinate spaces
828 * require an affine transformation in the shader. */
830 #define MALI_VARYING_POINT_COORD (0x61)
832 /* Used for comparison to check if an address is special. Mostly a guess, but
833 * it doesn't really matter. */
835 #define MALI_VARYING_SPECIAL (0x100)
838 /* This is used for actual attributes. */
840 /* The bottom 3 bits are the mode */
841 mali_ptr elements
: 64 - 8;
847 /* The entry after an NPOT_DIVIDE entry has this format. It stores
848 * extra information that wouldn't fit in a normal entry.
851 u32 unk
; /* = 0x20 */
854 /* This is the original, GL-level divisor. */
857 } __attribute__((packed
));
859 struct mali_attr_meta
{
860 /* Vertex buffer index */
863 unsigned unknown1
: 2;
864 unsigned swizzle
: 12;
865 enum mali_format format
: 8;
867 /* Always observed to be zero at the moment */
868 unsigned unknown3
: 2;
870 /* When packing multiple attributes in a buffer, offset addresses by
871 * this value. Obscurely, this is signed. */
873 } __attribute__((packed
));
881 #define FBD_MASK (~0x3f)
883 /* ORed into an MFBD address to specify the fbx section is included */
884 #define MALI_MFBD_TAG_EXTRA (0x2)
886 struct mali_uniform_buffer_meta
{
887 /* This is actually the size minus 1 (MALI_POSITIVE), in units of 16
888 * bytes. This gives a maximum of 2^14 bytes, which just so happens to
889 * be the GL minimum-maximum for GL_MAX_UNIFORM_BLOCK_SIZE.
893 /* This is missing the bottom 2 bits and top 8 bits. The top 8 bits
894 * should be 0 for userspace pointers, according to
895 * https://lwn.net/Articles/718895/. By reusing these bits, we can make
896 * each entry in the table only 64 bits.
898 mali_ptr ptr
: 64 - 10;
901 /* On Bifrost, these fields are the same between the vertex and tiler payloads.
902 * They also seem to be the same between Bifrost and Midgard. They're shared in
906 /* Applies to unknown_draw */
908 #define MALI_DRAW_INDEXED_UINT8 (0x10)
909 #define MALI_DRAW_INDEXED_UINT16 (0x20)
910 #define MALI_DRAW_INDEXED_UINT32 (0x30)
911 #define MALI_DRAW_INDEXED_SIZE (0x30)
912 #define MALI_DRAW_INDEXED_SHIFT (4)
914 #define MALI_DRAW_VARYING_SIZE (0x100)
915 #define MALI_DRAW_PRIMITIVE_RESTART_FIXED_INDEX (0x10000)
917 struct mali_vertex_tiler_prefix
{
918 /* This is a dynamic bitfield containing the following things in this order:
920 * - gl_WorkGroupSize.x
921 * - gl_WorkGroupSize.y
922 * - gl_WorkGroupSize.z
923 * - gl_NumWorkGroups.x
924 * - gl_NumWorkGroups.y
925 * - gl_NumWorkGroups.z
927 * The number of bits allocated for each number is based on the *_shift
928 * fields below. For example, workgroups_y_shift gives the bit that
929 * gl_NumWorkGroups.y starts at, and workgroups_z_shift gives the bit
930 * that gl_NumWorkGroups.z starts at (and therefore one after the bit
931 * that gl_NumWorkGroups.y ends at). The actual value for each gl_*
932 * value is one more than the stored value, since if any of the values
933 * are zero, then there would be no invocations (and hence no job). If
934 * there were 0 bits allocated to a given field, then it must be zero,
935 * and hence the real value is one.
937 * Vertex jobs reuse the same job dispatch mechanism as compute jobs,
938 * effectively doing glDispatchCompute(1, vertex_count, instance_count)
939 * where vertex count is the number of vertices.
941 u32 invocation_count
;
943 u32 size_y_shift
: 5;
944 u32 size_z_shift
: 5;
945 u32 workgroups_x_shift
: 6;
946 u32 workgroups_y_shift
: 6;
947 u32 workgroups_z_shift
: 6;
948 /* This is max(workgroups_x_shift, 2) in all the cases I've seen. */
949 u32 workgroups_x_shift_2
: 4;
952 u32 unknown_draw
: 22;
954 /* This is the the same as workgroups_x_shift_2 in compute shaders, but
955 * always 5 for vertex jobs and 6 for tiler jobs. I suspect this has
956 * something to do with how many quads get put in the same execution
957 * engine, which is a balance (you don't want to starve the engine, but
958 * you also want to distribute work evenly).
960 u32 workgroups_x_shift_3
: 6;
963 /* Negative of min_index. This is used to compute
964 * the unbiased index in tiler/fragment shader runs.
966 * The hardware adds offset_bias_correction in each run,
967 * so that absent an index bias, the first vertex processed is
968 * genuinely the first vertex (0). But with an index bias,
969 * the first vertex process is numbered the same as the bias.
971 * To represent this more conviniently:
972 * unbiased_index = lower_bound_index +
974 * offset_bias_correction
976 * This is done since the hardware doesn't accept a index_bias
977 * and this allows it to recover the unbiased index.
979 int32_t offset_bias_correction
;
982 /* Like many other strictly nonzero quantities, index_count is
983 * subtracted by one. For an indexed cube, this is equal to 35 = 6
984 * faces * 2 triangles/per face * 3 vertices/per triangle - 1. That is,
985 * for an indexed draw, index_count is the number of actual vertices
986 * rendered whereas invocation_count is the number of unique vertices
987 * rendered (the number of times the vertex shader must be invoked).
988 * For non-indexed draws, this is just equal to invocation_count. */
992 /* No hidden structure; literally just a pointer to an array of uint
993 * indices (width depends on flags). Thanks, guys, for not making my
994 * life insane for once! NULL for non-indexed draws. */
997 } __attribute__((packed
));
999 /* Point size / line width can either be specified as a 32-bit float (for
1000 * constant size) or as a [machine word size]-bit GPU pointer (for varying size). If a pointer
1001 * is selected, by setting the appropriate MALI_DRAW_VARYING_SIZE bit in the tiler
1002 * payload, the contents of varying_pointer will be intepreted as an array of
1003 * fp16 sizes, one for each vertex. gl_PointSize is therefore implemented by
1004 * creating a special MALI_R16F varying writing to varying_pointer. */
1006 union midgard_primitive_size
{
1011 struct bifrost_vertex_only
{
1012 u32 unk2
; /* =0x2 */
1017 } __attribute__((packed
));
1019 struct bifrost_tiler_heap_meta
{
1022 /* note: these are just guesses! */
1023 mali_ptr tiler_heap_start
;
1024 mali_ptr tiler_heap_free
;
1025 mali_ptr tiler_heap_end
;
1027 /* hierarchy weights? but they're still 0 after the job has run... */
1029 } __attribute__((packed
));
1031 struct bifrost_tiler_meta
{
1038 mali_ptr tiler_heap_meta
;
1039 /* TODO what is this used for? */
1041 } __attribute__((packed
));
1043 struct bifrost_tiler_only
{
1045 union midgard_primitive_size primitive_size
;
1047 mali_ptr tiler_meta
;
1049 u64 zero1
, zero2
, zero3
, zero4
, zero5
, zero6
;
1054 } __attribute__((packed
));
1056 struct bifrost_scratchpad
{
1058 u32 flags
; // = 0x1f
1059 /* This is a pointer to a CPU-inaccessible buffer, 16 pages, allocated
1060 * during startup. It seems to serve the same purpose as the
1061 * gpu_scratchpad in the SFBD for Midgard, although it's slightly
1064 mali_ptr gpu_scratchpad
;
1065 } __attribute__((packed
));
1067 struct mali_vertex_tiler_postfix
{
1068 /* Zero for vertex jobs. Pointer to the position (gl_Position) varying
1069 * output from the vertex shader for tiler jobs.
1072 u64 position_varying
;
1074 /* An array of mali_uniform_buffer_meta's. The size is given by the
1077 u64 uniform_buffers
;
1079 /* This is a pointer to an array of pointers to the texture
1080 * descriptors, number of pointers bounded by number of textures. The
1081 * indirection is needed to accomodate varying numbers and sizes of
1082 * texture descriptors */
1083 u64 texture_trampoline
;
1085 /* For OpenGL, from what I've seen, this is intimately connected to
1086 * texture_meta. cwabbott says this is not the case under Vulkan, hence
1087 * why this field is seperate (Midgard is Vulkan capable). Pointer to
1088 * array of sampler descriptors (which are uniform in size) */
1089 u64 sampler_descriptor
;
1093 u64 attributes
; /* struct attribute_buffer[] */
1094 u64 attribute_meta
; /* attribute_meta[] */
1095 u64 varyings
; /* struct attr */
1096 u64 varying_meta
; /* pointer */
1098 u64 occlusion_counter
; /* A single bit as far as I can tell */
1100 /* Note: on Bifrost, this isn't actually the FBD. It points to
1101 * bifrost_scratchpad instead. However, it does point to the same thing
1102 * in vertex and tiler jobs.
1104 mali_ptr framebuffer
;
1105 } __attribute__((packed
));
1107 struct midgard_payload_vertex_tiler
{
1108 struct mali_vertex_tiler_prefix prefix
;
1110 u16 gl_enables
; // 0x5
1112 /* Both zero for non-instanced draws. For instanced draws, a
1113 * decomposition of padded_num_vertices. See the comments about the
1114 * corresponding fields in mali_attr for context. */
1116 unsigned instance_shift
: 5;
1117 unsigned instance_odd
: 3;
1121 /* Offset for first vertex in buffer */
1126 struct mali_vertex_tiler_postfix postfix
;
1128 union midgard_primitive_size primitive_size
;
1129 } __attribute__((packed
));
1131 struct bifrost_payload_vertex
{
1132 struct mali_vertex_tiler_prefix prefix
;
1133 struct bifrost_vertex_only vertex
;
1134 struct mali_vertex_tiler_postfix postfix
;
1135 } __attribute__((packed
));
1137 struct bifrost_payload_tiler
{
1138 struct mali_vertex_tiler_prefix prefix
;
1139 struct bifrost_tiler_only tiler
;
1140 struct mali_vertex_tiler_postfix postfix
;
1141 } __attribute__((packed
));
1143 struct bifrost_payload_fused
{
1144 struct mali_vertex_tiler_prefix prefix
;
1145 struct bifrost_tiler_only tiler
;
1146 struct mali_vertex_tiler_postfix tiler_postfix
;
1147 u64 padding
; /* zero */
1148 struct bifrost_vertex_only vertex
;
1149 struct mali_vertex_tiler_postfix vertex_postfix
;
1150 } __attribute__((packed
));
1152 /* Purposeful off-by-one in width, height fields. For example, a (64, 64)
1153 * texture is stored as (63, 63) in these fields. This adjusts for that.
1154 * There's an identical pattern in the framebuffer descriptor. Even vertex
1155 * count fields work this way, hence the generic name -- integral fields that
1156 * are strictly positive generally need this adjustment. */
1158 #define MALI_POSITIVE(dim) (dim - 1)
1160 /* Opposite of MALI_POSITIVE, found in the depth_units field */
1162 #define MALI_NEGATIVE(dim) (dim + 1)
1164 /* Used with wrapping. Incomplete (this is a 4-bit field...) */
1166 enum mali_wrap_mode
{
1167 MALI_WRAP_REPEAT
= 0x8,
1168 MALI_WRAP_CLAMP_TO_EDGE
= 0x9,
1169 MALI_WRAP_CLAMP_TO_BORDER
= 0xB,
1170 MALI_WRAP_MIRRORED_REPEAT
= 0xC
1173 /* Shared across both command stream and Midgard, and even with Bifrost */
1175 enum mali_texture_type
{
1176 MALI_TEX_CUBE
= 0x0,
1183 #define MAX_MIP_LEVELS (13)
1185 /* Cubemap bloats everything up */
1186 #define MAX_CUBE_FACES (6)
1188 /* For each pointer, there is an address and optionally also a stride */
1189 #define MAX_ELEMENTS (2)
1191 /* It's not known why there are 4-bits allocated -- this enum is almost
1192 * certainly incomplete */
1194 enum mali_texture_layout
{
1195 /* For a Z/S texture, this is linear */
1196 MALI_TEXTURE_TILED
= 0x1,
1198 /* Z/S textures cannot be tiled */
1199 MALI_TEXTURE_LINEAR
= 0x2,
1202 MALI_TEXTURE_AFBC
= 0xC
1205 /* Corresponds to the type passed to glTexImage2D and so forth */
1207 struct mali_texture_format
{
1208 unsigned swizzle
: 12;
1209 enum mali_format format
: 8;
1212 unsigned unknown1
: 1;
1214 enum mali_texture_type type
: 2;
1215 enum mali_texture_layout layout
: 4;
1218 unsigned unknown2
: 1;
1220 /* Set to allow packing an explicit stride */
1221 unsigned manual_stride
: 1;
1224 } __attribute__((packed
));
1226 struct mali_texture_descriptor
{
1230 uint16_t array_size
;
1232 struct mali_texture_format format
;
1236 /* One for non-mipmapped, zero for mipmapped */
1239 /* Zero for non-mipmapped, (number of levels - 1) for mipmapped */
1242 /* Swizzling is a single 32-bit word, broken up here for convenience.
1243 * Here, swizzling refers to the ES 3.0 texture parameters for channel
1244 * level swizzling, not the internal pixel-level swizzling which is
1245 * below OpenGL's reach */
1247 unsigned swizzle
: 12;
1248 unsigned swizzle_zero
: 20;
1254 mali_ptr payload
[MAX_MIP_LEVELS
* MAX_CUBE_FACES
* MAX_ELEMENTS
];
1255 } __attribute__((packed
));
1259 #define MALI_SAMP_MAG_NEAREST (1 << 0)
1260 #define MALI_SAMP_MIN_NEAREST (1 << 1)
1262 /* TODO: What do these bits mean individually? Only seen set together */
1264 #define MALI_SAMP_MIP_LINEAR_1 (1 << 3)
1265 #define MALI_SAMP_MIP_LINEAR_2 (1 << 4)
1267 /* Flag in filter_mode, corresponding to OpenCL's NORMALIZED_COORDS_TRUE
1268 * sampler_t flag. For typical OpenGL textures, this is always set. */
1270 #define MALI_SAMP_NORM_COORDS (1 << 5)
1272 /* Used for lod encoding. Thanks @urjaman for pointing out these routines can
1273 * be cleaned up a lot. */
1275 #define DECODE_FIXED_16(x) ((float) (x / 256.0))
1277 static inline uint16_t
1280 /* Clamp inputs, accounting for float error */
1281 float max_lod
= (32.0 - (1.0 / 512.0));
1283 x
= ((x
> max_lod
) ? max_lod
: ((x
< 0.0) ? 0.0 : x
));
1285 return (int) (x
* 256.0);
1288 struct mali_sampler_descriptor
{
1289 uint16_t filter_mode
;
1291 /* Fixed point. Upper 8-bits is before the decimal point, although it
1292 * caps [0-31]. Lower 8-bits is after the decimal point: int(round(x *
1299 /* All one word in reality, but packed a bit */
1301 enum mali_wrap_mode wrap_s
: 4;
1302 enum mali_wrap_mode wrap_t
: 4;
1303 enum mali_wrap_mode wrap_r
: 4;
1304 enum mali_alt_func compare_func
: 3;
1306 /* No effect on 2D textures. For cubemaps, set for ES3 and clear for
1307 * ES2, controlling seamless cubemapping */
1308 unsigned seamless_cube_map
: 1;
1313 float border_color
[4];
1314 } __attribute__((packed
));
1316 /* viewport0/viewport1 form the arguments to glViewport. viewport1 is
1317 * modified by MALI_POSITIVE; viewport0 is as-is.
1320 struct mali_viewport
{
1321 /* XY clipping planes */
1327 /* Depth clipping planes */
1333 } __attribute__((packed
));
1335 /* From presentations, 16x16 tiles externally. Use shift for fast computation
1336 * of tile numbers. */
1338 #define MALI_TILE_SHIFT 4
1339 #define MALI_TILE_LENGTH (1 << MALI_TILE_SHIFT)
1341 /* Tile coordinates are stored as a compact u32, as only 12 bits are needed to
1342 * each component. Notice that this provides a theoretical upper bound of (1 <<
1343 * 12) = 4096 tiles in each direction, addressing a maximum framebuffer of size
1344 * 65536x65536. Multiplying that together, times another four given that Mali
1345 * framebuffers are 32-bit ARGB8888, means that this upper bound would take 16
1346 * gigabytes of RAM just to store the uncompressed framebuffer itself, let
1347 * alone rendering in real-time to such a buffer.
1351 /* From mali_kbase_10969_workaround.c */
1352 #define MALI_X_COORD_MASK 0x00000FFF
1353 #define MALI_Y_COORD_MASK 0x0FFF0000
1355 /* Extract parts of a tile coordinate */
1357 #define MALI_TILE_COORD_X(coord) ((coord) & MALI_X_COORD_MASK)
1358 #define MALI_TILE_COORD_Y(coord) (((coord) & MALI_Y_COORD_MASK) >> 16)
1360 /* Helpers to generate tile coordinates based on the boundary coordinates in
1361 * screen space. So, with the bounds (0, 0) to (128, 128) for the screen, these
1362 * functions would convert it to the bounding tiles (0, 0) to (7, 7).
1363 * Intentional "off-by-one"; finding the tile number is a form of fencepost
1366 #define MALI_MAKE_TILE_COORDS(X, Y) ((X) | ((Y) << 16))
1367 #define MALI_BOUND_TO_TILE(B, bias) ((B - bias) >> MALI_TILE_SHIFT)
1368 #define MALI_COORDINATE_TO_TILE(W, H, bias) MALI_MAKE_TILE_COORDS(MALI_BOUND_TO_TILE(W, bias), MALI_BOUND_TO_TILE(H, bias))
1369 #define MALI_COORDINATE_TO_TILE_MIN(W, H) MALI_COORDINATE_TO_TILE(W, H, 0)
1370 #define MALI_COORDINATE_TO_TILE_MAX(W, H) MALI_COORDINATE_TO_TILE(W, H, 1)
1372 struct mali_payload_fragment
{
1375 mali_ptr framebuffer
;
1376 } __attribute__((packed
));
1378 /* Single Framebuffer Descriptor */
1380 /* Flags apply to format. With just MSAA_A and MSAA_B, the framebuffer is
1381 * configured for 4x. With MSAA_8, it is configured for 8x. */
1383 #define MALI_SFBD_FORMAT_MSAA_8 (1 << 3)
1384 #define MALI_SFBD_FORMAT_MSAA_A (1 << 4)
1385 #define MALI_SFBD_FORMAT_MSAA_B (1 << 4)
1386 #define MALI_SFBD_FORMAT_SRGB (1 << 5)
1388 /* Fast/slow based on whether all three buffers are cleared at once */
1390 #define MALI_CLEAR_FAST (1 << 18)
1391 #define MALI_CLEAR_SLOW (1 << 28)
1392 #define MALI_CLEAR_SLOW_STENCIL (1 << 31)
1394 /* Configures hierarchical tiling on Midgard for both SFBD/MFBD (embedded
1395 * within the larget framebuffer descriptor). Analogous to
1396 * bifrost_tiler_heap_meta and bifrost_tiler_meta*/
1398 /* See pan_tiler.c for derivation */
1399 #define MALI_HIERARCHY_MASK ((1 << 9) - 1)
1401 /* Flag disabling the tiler for clear-only jobs, with
1402 hierarchical tiling */
1403 #define MALI_TILER_DISABLED (1 << 12)
1405 /* Flag selecting userspace-generated polygon list, for clear-only jobs without
1406 * hierarhical tiling. */
1407 #define MALI_TILER_USER 0xFFF
1409 /* Absent any geometry, the minimum size of the polygon list header */
1410 #define MALI_TILER_MINIMUM_HEADER_SIZE 0x200
1412 struct midgard_tiler_descriptor
{
1413 /* Size of the entire polygon list; see pan_tiler.c for the
1414 * computation. It's based on hierarchical tiling */
1416 u32 polygon_list_size
;
1418 /* Name known from the replay workaround in the kernel. What exactly is
1419 * flagged here is less known. We do that (tiler_hierarchy_mask & 0x1ff)
1420 * specifies a mask of hierarchy weights, which explains some of the
1421 * performance mysteries around setting it. We also see the bottom bit
1422 * of tiler_flags set in the kernel, but no comment why.
1424 * hierarchy_mask can have the TILER_DISABLED flag */
1429 /* See mali_tiler.c for an explanation */
1430 mali_ptr polygon_list
;
1431 mali_ptr polygon_list_body
;
1433 /* Names based on we see symmetry with replay jobs which name these
1436 mali_ptr heap_start
; /* tiler heap_free_address */
1439 /* Hierarchy weights. We know these are weights based on the kernel,
1440 * but I've never seen them be anything other than zero */
1444 enum mali_block_format
{
1445 MALI_BLOCK_TILED
= 0x0,
1446 MALI_BLOCK_UNKNOWN
= 0x1,
1447 MALI_BLOCK_LINEAR
= 0x2,
1448 MALI_BLOCK_AFBC
= 0x3,
1451 struct mali_sfbd_format
{
1455 /* mali_channel_swizzle */
1456 unsigned swizzle
: 12;
1459 unsigned nr_channels
: 2;
1464 enum mali_block_format block
: 2;
1470 struct mali_single_framebuffer
{
1473 u64 unknown_address_0
;
1477 struct mali_sfbd_format format
;
1482 /* Purposeful off-by-one in these fields should be accounted for by the
1483 * MALI_DIMENSION macro */
1490 u32 checksum_stride
;
1493 /* By default, the framebuffer is upside down from OpenGL's
1494 * perspective. Set framebuffer to the end and negate the stride to
1495 * flip in the Y direction */
1497 mali_ptr framebuffer
;
1502 /* Depth and stencil buffers are interleaved, it appears, as they are
1503 * set to the same address in captures. Both fields set to zero if the
1504 * buffer is not being cleared. Depending on GL_ENABLE magic, you might
1505 * get a zero enable despite the buffer being present; that still is
1508 mali_ptr depth_buffer
; // not SAME_VA
1509 u32 depth_stride_zero
: 4;
1510 u32 depth_stride
: 28;
1513 mali_ptr stencil_buffer
; // not SAME_VA
1514 u32 stencil_stride_zero
: 4;
1515 u32 stencil_stride
: 28;
1518 u32 clear_color_1
; // RGBA8888 from glClear, actually used by hardware
1519 u32 clear_color_2
; // always equal, but unclear function?
1520 u32 clear_color_3
; // always equal, but unclear function?
1521 u32 clear_color_4
; // always equal, but unclear function?
1523 /* Set to zero if not cleared */
1525 float clear_depth_1
; // float32, ditto
1526 float clear_depth_2
; // float32, ditto
1527 float clear_depth_3
; // float32, ditto
1528 float clear_depth_4
; // float32, ditto
1530 u32 clear_stencil
; // Exactly as it appears in OpenGL
1534 struct midgard_tiler_descriptor tiler
;
1536 /* More below this, maybe */
1537 } __attribute__((packed
));
1539 /* On Midgard, this "framebuffer descriptor" is used for the framebuffer field
1540 * of compute jobs. Superficially resembles a single framebuffer descriptor */
1542 struct mali_compute_fbd
{
1544 } __attribute__((packed
));
1546 /* Format bits for the render target flags */
1548 #define MALI_MFBD_FORMAT_MSAA (1 << 1)
1549 #define MALI_MFBD_FORMAT_SRGB (1 << 2)
1551 struct mali_rt_format
{
1555 unsigned nr_channels
: 2; /* MALI_POSITIVE */
1558 enum mali_block_format block
: 2;
1561 unsigned swizzle
: 12;
1565 /* Disables MFBD preload. When this bit is set, the render target will
1566 * be cleared every frame. When this bit is clear, the hardware will
1567 * automatically wallpaper the render target back from main memory.
1568 * Unfortunately, MFBD preload is very broken on Midgard, so in
1569 * practice, this is a chicken bit that should always be set.
1570 * Discovered by accident, as all good chicken bits are. */
1572 unsigned no_preload
: 1;
1573 } __attribute__((packed
));
1575 struct bifrost_render_target
{
1576 struct mali_rt_format format
;
1581 /* Stuff related to ARM Framebuffer Compression. When AFBC is enabled,
1582 * there is an extra metadata buffer that contains 16 bytes per tile.
1583 * The framebuffer needs to be the same size as before, since we don't
1584 * know ahead of time how much space it will take up. The
1585 * framebuffer_stride is set to 0, since the data isn't stored linearly
1588 * When AFBC is disabled, these fields are zero.
1592 u32 stride
; // stride in units of tiles
1593 u32 unk
; // = 0x20000
1596 mali_ptr framebuffer
;
1599 u32 framebuffer_stride
: 28; // in units of bytes
1602 u32 clear_color_1
; // RGBA8888 from glClear, actually used by hardware
1603 u32 clear_color_2
; // always equal, but unclear function?
1604 u32 clear_color_3
; // always equal, but unclear function?
1605 u32 clear_color_4
; // always equal, but unclear function?
1606 } __attribute__((packed
));
1608 /* An optional part of bifrost_framebuffer. It comes between the main structure
1609 * and the array of render targets. It must be included if any of these are
1612 * - Transaction Elimination
1614 * - TODO: Anything else?
1617 /* Flags field: note, these are guesses */
1619 #define MALI_EXTRA_PRESENT (0x400)
1620 #define MALI_EXTRA_AFBC (0x20)
1621 #define MALI_EXTRA_AFBC_ZS (0x10)
1622 #define MALI_EXTRA_ZS (0x4)
1624 struct bifrost_fb_extra
{
1626 /* Each tile has an 8 byte checksum, so the stride is "width in tiles * 8" */
1627 u32 checksum_stride
;
1632 /* Note: AFBC is only allowed for 24/8 combined depth/stencil. */
1634 mali_ptr depth_stencil_afbc_metadata
;
1635 u32 depth_stencil_afbc_stride
; // in units of tiles
1638 mali_ptr depth_stencil
;
1644 /* Depth becomes depth/stencil in case of combined D/S */
1646 u32 depth_stride_zero
: 4;
1647 u32 depth_stride
: 28;
1651 u32 stencil_stride_zero
: 4;
1652 u32 stencil_stride
: 28;
1659 } __attribute__((packed
));
1661 /* Flags for mfbd_flags */
1663 /* Enables writing depth results back to main memory (rather than keeping them
1664 * on-chip in the tile buffer and then discarding) */
1666 #define MALI_MFBD_DEPTH_WRITE (1 << 10)
1668 /* The MFBD contains the extra bifrost_fb_extra section */
1670 #define MALI_MFBD_EXTRA (1 << 13)
1672 struct bifrost_framebuffer
{
1675 u32 unknown2
; // = 0x1f, same as SFBD
1676 mali_ptr scratchpad
;
1679 mali_ptr sample_locations
;
1682 u16 width1
, height1
;
1684 u16 width2
, height2
;
1685 u32 unk1
: 19; // = 0x01000
1686 u32 rt_count_1
: 2; // off-by-one (use MALI_POSITIVE)
1687 u32 unk2
: 3; // = 0
1688 u32 rt_count_2
: 3; // no off-by-one
1691 u32 clear_stencil
: 8;
1692 u32 mfbd_flags
: 24; // = 0x100
1695 struct midgard_tiler_descriptor tiler
;
1697 /* optional: struct bifrost_fb_extra extra */
1698 /* struct bifrost_render_target rts[] */
1699 } __attribute__((packed
));
1701 #endif /* __PANFROST_JOB_H__ */