#define __PANFROST_JOB_H__
#include <stdint.h>
+#include <stdbool.h>
#include <panfrost-misc.h>
-#define MALI_SHORT_PTR_BITS (sizeof(u64)*8)
-
-#define MALI_FBD_HIERARCHY_WEIGHTS 8
-
-#define MALI_PAYLOAD_SIZE 256
-
-typedef u32 mali_jd_core_req;
-
enum mali_job_type {
JOB_NOT_STARTED = 0,
JOB_TYPE_NULL = 1,
- JOB_TYPE_SET_VALUE = 2,
+ JOB_TYPE_WRITE_VALUE = 2,
JOB_TYPE_CACHE_FLUSH = 3,
JOB_TYPE_COMPUTE = 4,
JOB_TYPE_VERTEX = 5,
/* Applies to tiler_gl_enables */
-
#define MALI_OCCLUSION_QUERY (1 << 3)
#define MALI_OCCLUSION_PRECISE (1 << 4)
* In OpenGL, this would corresponds to glFrontFace(GL_CW). Mesa and the blob
* disagree about how to do viewport flipping, so the blob actually sets this
* for GL_CW but then has a negative viewport stride */
+
#define MALI_FRONT_CCW_TOP (1 << 5)
#define MALI_CULL_FACE_FRONT (1 << 6)
#define MALI_CULL_FACE_BACK (1 << 7)
-/* TODO: Might this actually be a finer bitfield? */
-#define MALI_DEPTH_STENCIL_ENABLE 0x6400
-
-#define DS_ENABLE(field) \
- (field == MALI_DEPTH_STENCIL_ENABLE) \
- ? "MALI_DEPTH_STENCIL_ENABLE" \
- : (field == 0) ? "0" \
- : "0 /* XXX: Unknown, check hexdump */"
-
/* Used in stencil and depth tests */
enum mali_func {
MALI_FUNC_ALWAYS = 7
};
-/* Same OpenGL, but mixed up. Why? Because forget me, that's why! */
-
-enum mali_alt_func {
- MALI_ALT_FUNC_NEVER = 0,
- MALI_ALT_FUNC_GREATER = 1,
- MALI_ALT_FUNC_EQUAL = 2,
- MALI_ALT_FUNC_GEQUAL = 3,
- MALI_ALT_FUNC_LESS = 4,
- MALI_ALT_FUNC_NOTEQUAL = 5,
- MALI_ALT_FUNC_LEQUAL = 6,
- MALI_ALT_FUNC_ALWAYS = 7
-};
-
/* Flags apply to unknown2_3? */
#define MALI_HAS_MSAA (1 << 0)
#define MALI_GET_DEPTH_FUNC(flags) ((flags >> 8) & 0x7)
#define MALI_DEPTH_FUNC_MASK MALI_DEPTH_FUNC(0x7)
-#define MALI_DEPTH_TEST (1 << 11)
+#define MALI_DEPTH_WRITEMASK (1 << 11)
/* Next flags to unknown2_4 */
#define MALI_STENCIL_TEST (1 << 0)
/* The top 3 bits specify how the bits of each component are interpreted. */
+/* e.g. ETC2_RGB8 */
+#define MALI_FORMAT_COMPRESSED (0 << 5)
+
/* e.g. R11F_G11F_B10F */
#define MALI_FORMAT_SPECIAL (2 << 5)
* for Bifrost framebuffer output.
*/
#define MALI_FORMAT_SPECIAL2 (7 << 5)
+#define MALI_EXTRACT_TYPE(fmt) ((fmt) & 0xe0)
/* If the high 3 bits are 3 to 6 these two bits say how many components
* there are.
* MALI_FORMAT_UNORM, it means a 32-bit float.
*/
#define MALI_CHANNEL_FLOAT 7
+#define MALI_EXTRACT_BITS(fmt) (fmt & 0x7)
enum mali_format {
+ MALI_ETC2_RGB8 = MALI_FORMAT_COMPRESSED | 0x1,
+ MALI_ETC2_R11_UNORM = MALI_FORMAT_COMPRESSED | 0x2,
+ MALI_ETC2_RGBA8 = MALI_FORMAT_COMPRESSED | 0x3,
+ MALI_ETC2_RG11_UNORM = MALI_FORMAT_COMPRESSED | 0x4,
+ MALI_ETC2_R11_SNORM = MALI_FORMAT_COMPRESSED | 0x11,
+ MALI_ETC2_RG11_SNORM = MALI_FORMAT_COMPRESSED | 0x12,
+ MALI_ETC2_RGB8A1 = MALI_FORMAT_COMPRESSED | 0x13,
+ MALI_ASTC_SRGB_SUPP = MALI_FORMAT_COMPRESSED | 0x16,
+ MALI_ASTC_HDR_SUPP = MALI_FORMAT_COMPRESSED | 0x17,
+
MALI_RGB565 = MALI_FORMAT_SPECIAL | 0x0,
+ MALI_RGB5_X1_UNORM = MALI_FORMAT_SPECIAL | 0x1,
MALI_RGB5_A1_UNORM = MALI_FORMAT_SPECIAL | 0x2,
MALI_RGB10_A2_UNORM = MALI_FORMAT_SPECIAL | 0x3,
MALI_RGB10_A2_SNORM = MALI_FORMAT_SPECIAL | 0x5,
MALI_RGB10_A2UI = MALI_FORMAT_SPECIAL | 0x7,
MALI_RGB10_A2I = MALI_FORMAT_SPECIAL | 0x9,
- /* YUV formats */
- MALI_NV12 = MALI_FORMAT_SPECIAL | 0xc,
+ MALI_RGB332_UNORM = MALI_FORMAT_SPECIAL | 0xb,
+ MALI_RGB233_UNORM = MALI_FORMAT_SPECIAL | 0xc,
- MALI_Z32_UNORM = MALI_FORMAT_SPECIAL | 0xD,
+ MALI_Z24X8_UNORM = MALI_FORMAT_SPECIAL | 0xd,
MALI_R32_FIXED = MALI_FORMAT_SPECIAL | 0x11,
MALI_RG32_FIXED = MALI_FORMAT_SPECIAL | 0x12,
MALI_RGB32_FIXED = MALI_FORMAT_SPECIAL | 0x13,
#define MALI_ALPHA_COVERAGE(clampf) ((uint16_t) (int) (clampf * 15.0f))
#define MALI_GET_ALPHA_COVERAGE(nibble) ((float) nibble / 15.0f)
-/* Applies to midgard1.flags */
+/* Applies to midgard1.flags_lo */
-/* Should the hardware perform early-Z testing? Normally should be set
- * for performance reasons. Clear if you use: discard,
- * alpha-to-coverage... * It's also possible this disables
- * forward-pixel kill; we're not quite sure which bit is which yet.
- * TODO: How does this interact with blending?*/
+/* Should be set when the fragment shader updates the depth value. */
+#define MALI_WRITES_Z (1 << 4)
+
+/* Should the hardware perform early-Z testing? Set if the shader does not use
+ * discard, alpha-to-coverage, shader depth writes, and if the shader has no
+ * side effects (writes to global memory or images) unless early-z testing is
+ * forced in the shader.
+ */
#define MALI_EARLY_Z (1 << 6)
* it might read depth/stencil in particular, also set MALI_READS_ZS */
#define MALI_READS_ZS (1 << 8)
+
+/* The shader might write to global memory (via OpenCL, SSBOs, or images).
+ * Reading is okay, as are ordinary writes to the tilebuffer/varyings. Setting
+ * incurs a performance penalty. On a fragment shader, this bit implies there
+ * are side effects, hence it interacts with early-z. */
+#define MALI_WRITES_GLOBAL (1 << 9)
+
#define MALI_READS_TILEBUFFER (1 << 12)
+/* Applies to midgard1.flags_hi */
+
+/* Should be set when the fragment shader updates the stencil value. */
+#define MALI_WRITES_S (1 << 2)
+
+/* Mode to suppress generation of Infinity and NaN values by clamping inf
+ * (-inf) to MAX_FLOAT (-MIN_FLOAT) and flushing NaN to 0.0
+ *
+ * Compare suppress_inf/suppress_nan flags on the Bifrost clause header for the
+ * same functionality.
+ *
+ * This is not conformant on GLES3 or OpenCL, but is optional on GLES2, where
+ * it works around app bugs (e.g. in glmark2-es2 -bterrain with FP16).
+ */
+#define MALI_SUPPRESS_INF_NAN (1 << 3)
+
+/* Flags for bifrost1.unk1 */
+
+/* Shader uses less than 32 registers, partitioned as [R0, R15] U [R48, R63],
+ * allowing for full thread count. If clear, the full [R0, R63] register set is
+ * available at half thread count */
+#define MALI_BIFROST_FULL_THREAD (1 << 9)
+
+/* Enable early-z testing (presumably). This flag may not be set if the shader:
+ *
+ * - Uses blending
+ * - Uses discard
+ * - Writes gl_FragDepth
+ *
+ * This differs from Midgard which sets the MALI_EARLY_Z flag even with
+ * blending, although I've begun to suspect that flag does not in fact enable
+ * EARLY_Z alone. */
+#define MALI_BIFROST_EARLY_Z (1 << 15)
+
+/* First clause type is ATEST */
+#define MALI_BIFROST_FIRST_ATEST (1 << 26)
+
/* The raw Midgard blend payload can either be an equation or a shader
* address, depending on the context */
};
};
+/* We need to load the tilebuffer to blend (i.e. the destination factor is not
+ * ZERO) */
+
+#define MALI_BLEND_LOAD_TIB (0x1)
+
+/* A blend shader is used to blend this render target */
+#define MALI_BLEND_MRT_SHADER (0x2)
+
/* On MRT Midgard systems (using an MFBD), each render target gets its own
* blend descriptor */
struct midgard_blend_rt {
/* Flags base value of 0x200 to enable the render target.
* OR with 0x1 for blending (anything other than REPLACE).
- * OR with 0x2 for programmable blending with 0-2 registers
- * OR with 0x3 for programmable blending with 2+ registers
+ * OR with 0x2 for programmable blending
* OR with MALI_BLEND_SRGB for implicit sRGB
*/
/* On Bifrost systems (all MRT), each render target gets one of these
* descriptors */
+enum bifrost_shader_type {
+ BIFROST_BLEND_F16 = 0,
+ BIFROST_BLEND_F32 = 1,
+ BIFROST_BLEND_I32 = 2,
+ BIFROST_BLEND_U32 = 3,
+ BIFROST_BLEND_I16 = 4,
+ BIFROST_BLEND_U16 = 5,
+};
+
+#define BIFROST_MAX_RENDER_TARGET_COUNT 8
+
struct bifrost_blend_rt {
/* This is likely an analogue of the flags on
* midgard_blend_rt */
* constant_hi = int(f / 255)
* constant_lo = 65535*f - (65535/255) * constant_hi
*/
-
u16 constant;
struct mali_blend_equation equation;
+
/*
* - 0x19 normally
* - 0x3 when this slot is unused (everything else is 0 except the index)
* - 0x11 when this is the fourth slot (and it's used)
-+ * - 0 when there is a blend shader
+ * - 0 when there is a blend shader
*/
u16 unk2;
+
/* increments from 0 to 3 */
u16 index;
- union {
- struct {
- /* So far, I've only seen:
- * - R001 for 1-component formats
- * - RG01 for 2-component formats
- * - RGB1 for 3-component formats
- * - RGBA for 4-component formats
- */
- u32 swizzle : 12;
- enum mali_format format : 8;
-
- /* Type of the shader output variable. Note, this can
- * be different from the format.
- *
- * 0: f16 (mediump float)
- * 1: f32 (highp float)
- * 2: i32 (highp int)
- * 3: u32 (highp uint)
- * 4: i16 (mediump int)
- * 5: u16 (mediump uint)
- */
- u32 shader_type : 3;
- u32 zero : 9;
- };
-
- /* Only the low 32 bits of the blend shader are stored, the
- * high 32 bits are implicitly the same as the original shader.
- * According to the kernel driver, the program counter for
- * shaders is actually only 24 bits, so shaders cannot cross
- * the 2^24-byte boundary, and neither can the blend shader.
- * The blob handles this by allocating a 2^24 byte pool for
- * shaders, and making sure that any blend shaders are stored
- * in the same pool as the original shader. The kernel will
- * make sure this allocation is aligned to 2^24 bytes.
- */
- u32 shader;
- };
+ union {
+ struct {
+ /* So far, I've only seen:
+ * - R001 for 1-component formats
+ * - RG01 for 2-component formats
+ * - RGB1 for 3-component formats
+ * - RGBA for 4-component formats
+ */
+ u32 swizzle : 12;
+ enum mali_format format : 8;
+
+ /* Type of the shader output variable. Note, this can
+ * be different from the format.
+ * enum bifrost_shader_type
+ */
+ u32 zero1 : 4;
+ u32 shader_type : 3;
+ u32 zero2 : 5;
+ };
+
+ /* Only the low 32 bits of the blend shader are stored, the
+ * high 32 bits are implicitly the same as the original shader.
+ * According to the kernel driver, the program counter for
+ * shaders is actually only 24 bits, so shaders cannot cross
+ * the 2^24-byte boundary, and neither can the blend shader.
+ * The blob handles this by allocating a 2^24 byte pool for
+ * shaders, and making sure that any blend shaders are stored
+ * in the same pool as the original shader. The kernel will
+ * make sure this allocation is aligned to 2^24 bytes.
+ */
+ u32 shader;
+ };
} __attribute__((packed));
/* Descriptor for the shader. Following this is at least one, up to four blend
struct mali_shader_meta {
mali_ptr shader;
- u16 texture_count;
u16 sampler_count;
+ u16 texture_count;
u16 attribute_count;
u16 varying_count;
} bifrost1;
struct {
unsigned uniform_buffer_count : 4;
- unsigned flags : 12;
+ unsigned flags_lo : 12;
- /* Whole number of uniform registers used, times two;
- * whole number of work registers used (no scale).
- */
+ /* vec4 units */
unsigned work_count : 5;
unsigned uniform_count : 5;
- unsigned unknown2 : 6;
+ unsigned flags_hi : 6;
} midgard1;
};
* - R61 : gl_SampleMaskIn and gl_SampleID, used by
* varying interpolation.
* - R62 : unknown (bit always unset).
+ *
+ * Later GPUs (starting with Mali-G52?) support
+ * preloading float varyings into r0-r7. This is
+ * indicated by setting 0x40. There is no distinction
+ * here between 1 varying and 2.
*/
u32 preload_regs : 8;
/* In units of 8 bytes or 64 bits, since the
} midgard2;
};
- /* zero on bifrost */
- u32 unknown2_8;
+ u32 padding;
/* Blending information for the older non-MRT Midgard HW. Check for
* MALI_HAS_BLEND_SHADER to decide how to interpret.
u16 job_index;
u16 job_dependency_index_1;
u16 job_dependency_index_2;
-
- union {
- u64 next_job_64;
- u32 next_job_32;
- };
+ u64 next_job;
} __attribute__((packed));
-struct mali_payload_set_value {
- u64 out;
- u64 unknown;
-} __attribute__((packed));
+/* These concern exception_status */
+
+/* Access type causing a fault, paralleling AS_FAULTSTATUS_* entries in the
+ * kernel */
+
+enum mali_exception_access {
+ /* Atomic in the kernel for MMU, but that doesn't make sense for a job
+ * fault so it's just unused */
+ MALI_EXCEPTION_ACCESS_NONE = 0,
+
+ MALI_EXCEPTION_ACCESS_EXECUTE = 1,
+ MALI_EXCEPTION_ACCESS_READ = 2,
+ MALI_EXCEPTION_ACCESS_WRITE = 3
+};
+
+/* Details about write_value from panfrost igt tests which use it as a generic
+ * dword write primitive */
+
+#define MALI_WRITE_VALUE_ZERO 3
-/* Special attributes have a fixed index */
-#define MALI_SPECIAL_ATTRIBUTE_BASE 16
-#define MALI_VERTEX_ID (MALI_SPECIAL_ATTRIBUTE_BASE + 0)
-#define MALI_INSTANCE_ID (MALI_SPECIAL_ATTRIBUTE_BASE + 1)
+struct mali_payload_write_value {
+ u64 address;
+ u32 value_descriptor;
+ u32 reserved;
+ u64 immediate;
+} __attribute__((packed));
/*
* Mali Attributes
* implemented as special attributes, denoted by MALI_ATTR_IMAGE. For images,
* let shift=extra_flags=0. Stride is set to the image format's bytes-per-pixel
* (*NOT the row stride*). Size is set to the size of the image itself.
+ *
+ * Special internal attribtues and varyings (gl_VertexID, gl_FrontFacing, etc)
+ * use particular fixed addresses with modified structures.
*/
enum mali_attr_mode {
MALI_ATTR_POT_DIVIDE = 2,
MALI_ATTR_MODULO = 3,
MALI_ATTR_NPOT_DIVIDE = 4,
- MALI_ATTR_IMAGE = 5
+ MALI_ATTR_IMAGE = 5,
};
+/* Pseudo-address for gl_VertexID, gl_FragCoord, gl_FrontFacing */
+
+#define MALI_ATTR_VERTEXID (0x22)
+#define MALI_ATTR_INSTANCEID (0x24)
+#define MALI_VARYING_FRAG_COORD (0x25)
+#define MALI_VARYING_FRONT_FACING (0x26)
+
/* This magic "pseudo-address" is used as `elements` to implement
* gl_PointCoord. When read from a fragment shader, it generates a point
* coordinate per the OpenGL ES 2.0 specification. Flipped coordinate spaces
* require an affine transformation in the shader. */
-#define MALI_VARYING_POINT_COORD (0x60)
+#define MALI_VARYING_POINT_COORD (0x61)
+
+/* Used for comparison to check if an address is special. Mostly a guess, but
+ * it doesn't really matter. */
+
+#define MALI_RECORD_SPECIAL (0x100)
union mali_attr {
/* This is used for actual attributes. */
int32_t src_offset;
} __attribute__((packed));
-enum mali_fbd_type {
- MALI_SFBD = 0,
- MALI_MFBD = 1,
-};
-
-#define FBD_TYPE (1)
#define FBD_MASK (~0x3f)
-struct mali_uniform_buffer_meta {
- /* This is actually the size minus 1 (MALI_POSITIVE), in units of 16
- * bytes. This gives a maximum of 2^14 bytes, which just so happens to
- * be the GL minimum-maximum for GL_MAX_UNIFORM_BLOCK_SIZE.
- */
- u64 size : 10;
+/* MFBD, rather than SFBD */
+#define MALI_MFBD (0x1)
- /* This is missing the bottom 2 bits and top 8 bits. The top 8 bits
- * should be 0 for userspace pointers, according to
- * https://lwn.net/Articles/718895/. By reusing these bits, we can make
- * each entry in the table only 64 bits.
- */
- mali_ptr ptr : 64 - 10;
-};
+/* ORed into an MFBD address to specify the fbx section is included */
+#define MALI_MFBD_TAG_EXTRA (0x2)
+
+/* Uniform buffer objects are 64-bit fields divided as:
+ *
+ * u64 size : 10;
+ * mali_ptr ptr : 64 - 10;
+ *
+ * The size is actually the size minus 1 (MALI_POSITIVE), in units of 16 bytes.
+ * This gives a maximum of 2^14 bytes, which just so happens to be the GL
+ * minimum-maximum for GL_MAX_UNIFORM_BLOCK_SIZE.
+ *
+ * The pointer is missing the bottom 2 bits and top 8 bits. The top 8 bits
+ * should be 0 for userspace pointers, according to
+ * https://lwn.net/Articles/718895/. By reusing these bits, we can make each
+ * entry in the table only 64 bits.
+ */
+
+#define MALI_MAKE_UBO(elements, ptr) \
+ (MALI_POSITIVE((elements)) | (((ptr) >> 2) << 10))
/* On Bifrost, these fields are the same between the vertex and tiler payloads.
* They also seem to be the same between Bifrost and Midgard. They're shared in
#define MALI_DRAW_INDEXED_UINT8 (0x10)
#define MALI_DRAW_INDEXED_UINT16 (0x20)
#define MALI_DRAW_INDEXED_UINT32 (0x30)
+#define MALI_DRAW_INDEXED_SIZE (0x30)
+#define MALI_DRAW_INDEXED_SHIFT (4)
+
#define MALI_DRAW_VARYING_SIZE (0x100)
+
+/* Set to use first vertex as the provoking vertex for flatshading. Clear to
+ * use the last vertex. This is the default in DX and VK, but not in GL. */
+
+#define MALI_DRAW_FLATSHADE_FIRST (0x800)
+
#define MALI_DRAW_PRIMITIVE_RESTART_FIXED_INDEX (0x10000)
struct mali_vertex_tiler_prefix {
*/
u32 invocation_count;
- u32 size_y_shift : 5;
- u32 size_z_shift : 5;
- u32 workgroups_x_shift : 6;
- u32 workgroups_y_shift : 6;
- u32 workgroups_z_shift : 6;
- /* This is max(workgroups_x_shift, 2) in all the cases I've seen. */
- u32 workgroups_x_shift_2 : 4;
+ /* Bitfield for shifts:
+ *
+ * size_y_shift : 5
+ * size_z_shift : 5
+ * workgroups_x_shift : 6
+ * workgroups_y_shift : 6
+ * workgroups_z_shift : 6
+ * workgroups_x_shift_2 : 4
+ */
+ u32 invocation_shifts;
u32 draw_mode : 4;
u32 unknown_draw : 22;
u32 workgroups_x_shift_3 : 6;
- /* Negative of draw_start for TILER jobs from what I've seen */
- int32_t negative_start;
+ /* Negative of min_index. This is used to compute
+ * the unbiased index in tiler/fragment shader runs.
+ *
+ * The hardware adds offset_bias_correction in each run,
+ * so that absent an index bias, the first vertex processed is
+ * genuinely the first vertex (0). But with an index bias,
+ * the first vertex process is numbered the same as the bias.
+ *
+ * To represent this more conviniently:
+ * unbiased_index = lower_bound_index +
+ * index_bias +
+ * offset_bias_correction
+ *
+ * This is done since the hardware doesn't accept a index_bias
+ * and this allows it to recover the unbiased index.
+ */
+ int32_t offset_bias_correction;
u32 zero1;
/* Like many other strictly nonzero quantities, index_count is
u64 pointer;
};
-struct bifrost_vertex_only {
- u32 unk2; /* =0x2 */
-
- u32 zero0;
-
- u64 zero1;
-} __attribute__((packed));
-
struct bifrost_tiler_heap_meta {
u32 zero;
u32 heap_size;
mali_ptr tiler_heap_end;
/* hierarchy weights? but they're still 0 after the job has run... */
- u32 zeros[12];
+ u32 zeros[10];
+ u32 unk1;
+ u32 unk7e007e;
} __attribute__((packed));
struct bifrost_tiler_meta {
- u64 zero0;
- u16 hierarchy_mask;
+ u32 tiler_heap_next_start; /* To be written by the GPU */
+ u32 used_hierarchy_mask; /* To be written by the GPU */
+ u16 hierarchy_mask; /* Five values observed: 0xa, 0x14, 0x28, 0x50, 0xa0 */
u16 flags;
u16 width;
u16 height;
- u64 zero1;
+ u64 zero0;
mali_ptr tiler_heap_meta;
/* TODO what is this used for? */
u64 zeros[20];
mali_ptr tiler_meta;
u64 zero1, zero2, zero3, zero4, zero5, zero6;
-
- u32 gl_enables;
- u32 zero7;
- u64 zero8;
-} __attribute__((packed));
-
-struct bifrost_scratchpad {
- u32 zero;
- u32 flags; // = 0x1f
- /* This is a pointer to a CPU-inaccessible buffer, 16 pages, allocated
- * during startup. It seems to serve the same purpose as the
- * gpu_scratchpad in the SFBD for Midgard, although it's slightly
- * larger.
- */
- mali_ptr gpu_scratchpad;
} __attribute__((packed));
struct mali_vertex_tiler_postfix {
+ u16 gl_enables; // 0x6 on Midgard, 0x2 on Bifrost
+
+ /* Both zero for non-instanced draws. For instanced draws, a
+ * decomposition of padded_num_vertices. See the comments about the
+ * corresponding fields in mali_attr for context. */
+
+ unsigned instance_shift : 5;
+ unsigned instance_odd : 3;
+
+ u8 zero4;
+
+ /* Offset for first vertex in buffer */
+ u32 offset_start;
+
+ u64 zero5;
+
/* Zero for vertex jobs. Pointer to the position (gl_Position) varying
* output from the vertex shader for tiler jobs.
*/
*/
u64 uniform_buffers;
- /* This is a pointer to an array of pointers to the texture
+ /* On Bifrost, this is a pointer to an array of bifrost_texture_descriptor.
+ * On Midgard, this is a pointer to an array of pointers to the texture
* descriptors, number of pointers bounded by number of textures. The
* indirection is needed to accomodate varying numbers and sizes of
* texture descriptors */
- u64 texture_trampoline;
+ u64 textures;
/* For OpenGL, from what I've seen, this is intimately connected to
* texture_meta. cwabbott says this is not the case under Vulkan, hence
u64 sampler_descriptor;
u64 uniforms;
- u8 flags : 4;
- u64 _shader_upper : MALI_SHORT_PTR_BITS - 4; /* struct shader_meta */
+ u64 shader;
u64 attributes; /* struct attribute_buffer[] */
u64 attribute_meta; /* attribute_meta[] */
u64 varyings; /* struct attr */
u64 viewport;
u64 occlusion_counter; /* A single bit as far as I can tell */
- /* Note: on Bifrost, this isn't actually the FBD. It points to
- * bifrost_scratchpad instead. However, it does point to the same thing
- * in vertex and tiler jobs.
- */
- mali_ptr framebuffer;
+ /* On Bifrost, this points directly to a mali_shared_memory structure.
+ * On Midgard, this points to a framebuffer (either SFBD or MFBD as
+ * tagged), which embeds a mali_shared_memory structure */
+ mali_ptr shared_memory;
} __attribute__((packed));
struct midgard_payload_vertex_tiler {
struct mali_vertex_tiler_prefix prefix;
-
- u16 gl_enables; // 0x5
-
- /* Both zero for non-instanced draws. For instanced draws, a
- * decomposition of padded_num_vertices. See the comments about the
- * corresponding fields in mali_attr for context. */
-
- unsigned instance_shift : 5;
- unsigned instance_odd : 3;
-
- u8 zero4;
-
- /* Offset for first vertex in buffer */
- u32 draw_start;
-
- u64 zero5;
-
struct mali_vertex_tiler_postfix postfix;
union midgard_primitive_size primitive_size;
struct bifrost_payload_vertex {
struct mali_vertex_tiler_prefix prefix;
- struct bifrost_vertex_only vertex;
struct mali_vertex_tiler_postfix postfix;
} __attribute__((packed));
struct bifrost_tiler_only tiler;
struct mali_vertex_tiler_postfix tiler_postfix;
u64 padding; /* zero */
- struct bifrost_vertex_only vertex;
struct mali_vertex_tiler_postfix vertex_postfix;
} __attribute__((packed));
#define MALI_POSITIVE(dim) (dim - 1)
-/* Opposite of MALI_POSITIVE, found in the depth_units field */
-
-#define MALI_NEGATIVE(dim) (dim + 1)
-
-/* Used with wrapping. Incomplete (this is a 4-bit field...) */
+/* Used with wrapping. Unclear what top bit conveys */
enum mali_wrap_mode {
- MALI_WRAP_REPEAT = 0x8,
- MALI_WRAP_CLAMP_TO_EDGE = 0x9,
- MALI_WRAP_CLAMP_TO_BORDER = 0xB,
- MALI_WRAP_MIRRORED_REPEAT = 0xC
+ MALI_WRAP_REPEAT = 0x8 | 0x0,
+ MALI_WRAP_CLAMP_TO_EDGE = 0x8 | 0x1,
+ MALI_WRAP_CLAMP = 0x8 | 0x2,
+ MALI_WRAP_CLAMP_TO_BORDER = 0x8 | 0x3,
+ MALI_WRAP_MIRRORED_REPEAT = 0x8 | 0x4 | 0x0,
+ MALI_WRAP_MIRRORED_CLAMP_TO_EDGE = 0x8 | 0x4 | 0x1,
+ MALI_WRAP_MIRRORED_CLAMP = 0x8 | 0x4 | 0x2,
+ MALI_WRAP_MIRRORED_CLAMP_TO_BORDER = 0x8 | 0x4 | 0x3,
};
/* Shared across both command stream and Midgard, and even with Bifrost */
/* For each pointer, there is an address and optionally also a stride */
#define MAX_ELEMENTS (2)
-/* Corresponds to the type passed to glTexImage2D and so forth */
+/* It's not known why there are 4-bits allocated -- this enum is almost
+ * certainly incomplete */
+
+enum mali_texture_layout {
+ /* For a Z/S texture, this is linear */
+ MALI_TEXTURE_TILED = 0x1,
+
+ /* Z/S textures cannot be tiled */
+ MALI_TEXTURE_LINEAR = 0x2,
-/* Flags for usage2 */
-#define MALI_TEX_MANUAL_STRIDE (0x20)
+ /* 16x16 sparse */
+ MALI_TEXTURE_AFBC = 0xC
+};
+
+/* Corresponds to the type passed to glTexImage2D and so forth */
struct mali_texture_format {
unsigned swizzle : 12;
unsigned unknown1 : 1;
enum mali_texture_type type : 2;
+ enum mali_texture_layout layout : 4;
- unsigned usage2 : 8;
+ /* Always set */
+ unsigned unknown2 : 1;
+
+ /* Set to allow packing an explicit stride */
+ unsigned manual_stride : 1;
+
+ unsigned zero : 2;
} __attribute__((packed));
struct mali_texture_descriptor {
uint8_t unknown3A;
/* Zero for non-mipmapped, (number of levels - 1) for mipmapped */
- uint8_t nr_mipmap_levels;
+ uint8_t levels;
/* Swizzling is a single 32-bit word, broken up here for convenience.
* Here, swizzling refers to the ES 3.0 texture parameters for channel
uint32_t unknown5;
uint32_t unknown6;
uint32_t unknown7;
+} __attribute__((packed));
+
+/* While Midgard texture descriptors are variable length, Bifrost descriptors
+ * are fixed like samplers with more pointers to expand if necessary */
+
+struct bifrost_texture_descriptor {
+ unsigned format_unk : 4; /* 2 */
+ enum mali_texture_type type : 2;
+ unsigned zero : 4;
+ unsigned format_swizzle : 12;
+ enum mali_format format : 8;
+ unsigned srgb : 1;
+ unsigned format_unk3 : 1; /* 0 */
+
+ uint16_t width; /* MALI_POSITIVE */
+ uint16_t height; /* MALI_POSITIVE */
+
+ /* OpenGL swizzle */
+ unsigned swizzle : 12;
+ enum mali_texture_layout layout : 4;
+ uint8_t levels : 8; /* Number of levels-1 if mipmapped, 0 if not */
+ unsigned unk1 : 8;
+
+ unsigned levels_unk : 24; /* 0 */
+ unsigned level_2 : 8; /* Number of levels, again? */
+
+ mali_ptr payload;
+
+ uint16_t array_size;
+ uint16_t unk4;
- mali_ptr payload[MAX_MIP_LEVELS * MAX_CUBE_FACES * MAX_ELEMENTS];
+ uint16_t depth;
+ uint16_t unk5;
} __attribute__((packed));
-/* Used as part of filter_mode */
+/* filter_mode */
-#define MALI_LINEAR 0
-#define MALI_NEAREST 1
-#define MALI_MIP_LINEAR (0x18)
+#define MALI_SAMP_MAG_NEAREST (1 << 0)
+#define MALI_SAMP_MIN_NEAREST (1 << 1)
-/* Used to construct low bits of filter_mode */
+/* TODO: What do these bits mean individually? Only seen set together */
-#define MALI_TEX_MAG(mode) (((mode) & 1) << 0)
-#define MALI_TEX_MIN(mode) (((mode) & 1) << 1)
+#define MALI_SAMP_MIP_LINEAR_1 (1 << 3)
+#define MALI_SAMP_MIP_LINEAR_2 (1 << 4)
-#define MALI_TEX_MAG_MASK (1)
-#define MALI_TEX_MIN_MASK (2)
+/* Flag in filter_mode, corresponding to OpenCL's NORMALIZED_COORDS_TRUE
+ * sampler_t flag. For typical OpenGL textures, this is always set. */
-#define MALI_FILTER_NAME(filter) (filter ? "MALI_NEAREST" : "MALI_LINEAR")
+#define MALI_SAMP_NORM_COORDS (1 << 5)
/* Used for lod encoding. Thanks @urjaman for pointing out these routines can
* be cleaned up a lot. */
#define DECODE_FIXED_16(x) ((float) (x / 256.0))
-static inline uint16_t
-FIXED_16(float x)
+static inline int16_t
+FIXED_16(float x, bool allow_negative)
{
/* Clamp inputs, accounting for float error */
float max_lod = (32.0 - (1.0 / 512.0));
+ float min_lod = allow_negative ? -max_lod : 0.0;
- x = ((x > max_lod) ? max_lod : ((x < 0.0) ? 0.0 : x));
+ x = ((x > max_lod) ? max_lod : ((x < min_lod) ? min_lod : x));
return (int) (x * 256.0);
}
struct mali_sampler_descriptor {
- uint32_t filter_mode;
+ uint16_t filter_mode;
- /* Fixed point. Upper 8-bits is before the decimal point, although it
- * caps [0-31]. Lower 8-bits is after the decimal point: int(round(x *
- * 256)) */
+ /* Fixed point, signed.
+ * Upper 7 bits before the decimal point, although it caps [0-31].
+ * Lower 8 bits after the decimal point: int(round(x * 256)) */
- uint16_t min_lod;
- uint16_t max_lod;
+ int16_t lod_bias;
+ int16_t min_lod;
+ int16_t max_lod;
- /* All one word in reality, but packed a bit */
+ /* All one word in reality, but packed a bit. Comparisons are flipped
+ * from OpenGL. */
enum mali_wrap_mode wrap_s : 4;
enum mali_wrap_mode wrap_t : 4;
enum mali_wrap_mode wrap_r : 4;
- enum mali_alt_func compare_func : 3;
+ enum mali_func compare_func : 3;
/* No effect on 2D textures. For cubemaps, set for ES3 and clear for
* ES2, controlling seamless cubemapping */
float border_color[4];
} __attribute__((packed));
+/* Bifrost sampler descriptors look pretty similar */
+
+#define BIFROST_SAMP_MIN_NEAREST (1)
+#define BIFROST_SAMP_MAG_LINEAR (1)
+
+struct bifrost_sampler_descriptor {
+ uint8_t unk1;
+
+ enum mali_wrap_mode wrap_r : 4;
+ enum mali_wrap_mode wrap_t : 4;
+ enum mali_wrap_mode wrap_s : 4;
+ uint8_t unk8 : 4;
+
+ uint8_t unk2 : 1;
+ uint8_t norm_coords : 1;
+ uint8_t unk3 : 1;
+ uint8_t min_filter : 1;
+ uint8_t zero1 : 1;
+ uint8_t mag_filter : 1;
+ uint8_t mip_filter : 1;
+
+ int16_t min_lod;
+ int16_t max_lod;
+
+ uint64_t zero2;
+ uint64_t zero3;
+ uint64_t zero4;
+} __attribute__((packed));
+
/* viewport0/viewport1 form the arguments to glViewport. viewport1 is
* modified by MALI_POSITIVE; viewport0 is as-is.
*/
#define MALI_TILE_COORD_X(coord) ((coord) & MALI_X_COORD_MASK)
#define MALI_TILE_COORD_Y(coord) (((coord) & MALI_Y_COORD_MASK) >> 16)
-#define MALI_TILE_COORD_FLAGS(coord) ((coord) & ~(MALI_X_COORD_MASK | MALI_Y_COORD_MASK))
-
-/* No known flags yet, but just in case...? */
-
-#define MALI_TILE_NO_FLAG (0)
/* Helpers to generate tile coordinates based on the boundary coordinates in
* screen space. So, with the bounds (0, 0) to (128, 128) for the screen, these
/* Flags apply to format. With just MSAA_A and MSAA_B, the framebuffer is
* configured for 4x. With MSAA_8, it is configured for 8x. */
-#define MALI_FRAMEBUFFER_MSAA_8 (1 << 3)
-#define MALI_FRAMEBUFFER_MSAA_A (1 << 4)
-#define MALI_FRAMEBUFFER_MSAA_B (1 << 23)
+#define MALI_SFBD_FORMAT_MSAA_8 (1 << 3)
+#define MALI_SFBD_FORMAT_MSAA_A (1 << 4)
+#define MALI_SFBD_FORMAT_MSAA_B (1 << 4)
+#define MALI_SFBD_FORMAT_SRGB (1 << 5)
/* Fast/slow based on whether all three buffers are cleared at once */
* within the larget framebuffer descriptor). Analogous to
* bifrost_tiler_heap_meta and bifrost_tiler_meta*/
+/* See pan_tiler.c for derivation */
+#define MALI_HIERARCHY_MASK ((1 << 9) - 1)
+
+/* Flag disabling the tiler for clear-only jobs, with
+ hierarchical tiling */
+#define MALI_TILER_DISABLED (1 << 12)
+
+/* Flag selecting userspace-generated polygon list, for clear-only jobs without
+ * hierarhical tiling. */
+#define MALI_TILER_USER 0xFFF
+
+/* Absent any geometry, the minimum size of the polygon list header */
+#define MALI_TILER_MINIMUM_HEADER_SIZE 0x200
+
struct midgard_tiler_descriptor {
/* Size of the entire polygon list; see pan_tiler.c for the
* computation. It's based on hierarchical tiling */
* flagged here is less known. We do that (tiler_hierarchy_mask & 0x1ff)
* specifies a mask of hierarchy weights, which explains some of the
* performance mysteries around setting it. We also see the bottom bit
- * of tiler_flags set in the kernel, but no comment why. */
+ * of tiler_flags set in the kernel, but no comment why.
+ *
+ * hierarchy_mask can have the TILER_DISABLED flag */
u16 hierarchy_mask;
u16 flags;
u32 weights[8];
};
-struct mali_single_framebuffer {
- u32 unknown1;
- u32 unknown2;
- u64 unknown_address_0;
- u64 zero1;
- u64 zero0;
+enum mali_block_format {
+ MALI_BLOCK_TILED = 0x0,
+ MALI_BLOCK_UNKNOWN = 0x1,
+ MALI_BLOCK_LINEAR = 0x2,
+ MALI_BLOCK_AFBC = 0x3,
+};
- /* Exact format is ironically not known, since EGL is finnicky with the
- * blob. MSAA, colourspace, etc are configured here. */
+struct mali_sfbd_format {
+ /* 0x1 */
+ unsigned unk1 : 6;
- u32 format;
+ /* mali_channel_swizzle */
+ unsigned swizzle : 12;
+
+ /* MALI_POSITIVE */
+ unsigned nr_channels : 2;
+
+ /* 0x4 */
+ unsigned unk2 : 6;
+
+ enum mali_block_format block : 2;
+
+ /* 0xb */
+ unsigned unk3 : 4;
+};
+
+/* Shared structure at the start of framebuffer descriptors, or used bare for
+ * compute jobs, configuring stack and shared memory */
+
+struct mali_shared_memory {
+ u32 stack_shift : 4;
+ u32 unk0 : 28;
+
+ /* Configuration for shared memory for compute shaders.
+ * shared_workgroup_count is logarithmic and may be computed for a
+ * compute shader using shared memory as:
+ *
+ * shared_workgroup_count = MAX2(ceil(log2(count_x)) + ... + ceil(log2(count_z), 10)
+ *
+ * For compute shaders that don't use shared memory, or non-compute
+ * shaders, this is set to ~0
+ */
+
+ u32 shared_workgroup_count : 5;
+ u32 shared_unk1 : 3;
+ u32 shared_shift : 4;
+ u32 shared_zero : 20;
+
+ mali_ptr scratchpad;
+
+ /* For compute shaders, the RAM backing of workgroup-shared memory. For
+ * fragment shaders on Bifrost, apparently multisampling locations */
+
+ mali_ptr shared_memory;
+ mali_ptr unknown1;
+} __attribute__((packed));
+
+/* Configures multisampling on Bifrost fragment jobs */
+
+struct bifrost_multisampling {
+ u64 zero1;
+ u64 zero2;
+ mali_ptr sample_locations;
+ u64 zero4;
+} __attribute__((packed));
+
+struct mali_single_framebuffer {
+ struct mali_shared_memory shared_memory;
+ struct mali_sfbd_format format;
u32 clear_flags;
u32 zero2;
u16 width;
u16 height;
- u32 zero3[8];
+ u32 zero3[4];
+ mali_ptr checksum;
+ u32 checksum_stride;
+ u32 zero5;
/* By default, the framebuffer is upside down from OpenGL's
* perspective. Set framebuffer to the end and negate the stride to
* disabled. */
mali_ptr depth_buffer; // not SAME_VA
- u64 depth_buffer_enable;
+ u32 depth_stride_zero : 4;
+ u32 depth_stride : 28;
+ u32 zero7;
mali_ptr stencil_buffer; // not SAME_VA
- u64 stencil_buffer_enable;
+ u32 stencil_stride_zero : 4;
+ u32 stencil_stride : 28;
+ u32 zero8;
u32 clear_color_1; // RGBA8888 from glClear, actually used by hardware
u32 clear_color_2; // always equal, but unclear function?
/* More below this, maybe */
} __attribute__((packed));
-/* On Midgard, this "framebuffer descriptor" is used for the framebuffer field
- * of compute jobs. Superficially resembles a single framebuffer descriptor */
-
-struct mali_compute_fbd {
- u32 unknown1[16];
-} __attribute__((packed));
-
/* Format bits for the render target flags */
#define MALI_MFBD_FORMAT_MSAA (1 << 1)
#define MALI_MFBD_FORMAT_SRGB (1 << 2)
-enum mali_mfbd_block_format {
- MALI_MFBD_BLOCK_TILED = 0x0,
- MALI_MFBD_BLOCK_UNKNOWN = 0x1,
- MALI_MFBD_BLOCK_LINEAR = 0x2,
- MALI_MFBD_BLOCK_AFBC = 0x3,
-};
-
struct mali_rt_format {
unsigned unk1 : 32;
unsigned unk2 : 3;
unsigned nr_channels : 2; /* MALI_POSITIVE */
- unsigned unk3 : 5;
- enum mali_mfbd_block_format block : 2;
+ unsigned unk3 : 4;
+ unsigned unk4 : 1;
+ enum mali_block_format block : 2;
unsigned flags : 4;
unsigned swizzle : 12;
- unsigned unk4 : 4;
+ unsigned zero : 3;
+
+ /* Disables MFBD preload. When this bit is set, the render target will
+ * be cleared every frame. When this bit is clear, the hardware will
+ * automatically wallpaper the render target back from main memory.
+ * Unfortunately, MFBD preload is very broken on Midgard, so in
+ * practice, this is a chicken bit that should always be set.
+ * Discovered by accident, as all good chicken bits are. */
+
+ unsigned no_preload : 1;
} __attribute__((packed));
-struct bifrost_render_target {
- struct mali_rt_format format;
+/* Flags for afbc.flags and ds_afbc.flags */
- u64 zero1;
+#define MALI_AFBC_FLAGS 0x10009
- union {
- struct {
- /* Stuff related to ARM Framebuffer Compression. When AFBC is enabled,
- * there is an extra metadata buffer that contains 16 bytes per tile.
- * The framebuffer needs to be the same size as before, since we don't
- * know ahead of time how much space it will take up. The
- * framebuffer_stride is set to 0, since the data isn't stored linearly
- * anymore.
- */
+/* Lossless RGB and RGBA colorspace transform */
+#define MALI_AFBC_YTR (1 << 17)
- mali_ptr metadata;
- u32 stride; // stride in units of tiles
- u32 unk; // = 0x20000
- } afbc;
+struct mali_render_target {
+ struct mali_rt_format format;
- struct {
- /* Heck if I know */
- u64 unk;
- mali_ptr pointer;
- } chunknown;
- };
+ u64 zero1;
+
+ struct {
+ /* Stuff related to ARM Framebuffer Compression. When AFBC is enabled,
+ * there is an extra metadata buffer that contains 16 bytes per tile.
+ * The framebuffer needs to be the same size as before, since we don't
+ * know ahead of time how much space it will take up. The
+ * framebuffer_stride is set to 0, since the data isn't stored linearly
+ * anymore.
+ *
+ * When AFBC is disabled, these fields are zero.
+ */
+
+ mali_ptr metadata;
+ u32 stride; // stride in units of tiles
+ u32 flags; // = 0x20000
+ } afbc;
mali_ptr framebuffer;
u32 clear_color_4; // always equal, but unclear function?
} __attribute__((packed));
-/* An optional part of bifrost_framebuffer. It comes between the main structure
+/* An optional part of mali_framebuffer. It comes between the main structure
* and the array of render targets. It must be included if any of these are
* enabled:
*
* - TODO: Anything else?
*/
-/* Flags field: note, these are guesses */
+/* flags_hi */
+#define MALI_EXTRA_PRESENT (0x10)
-#define MALI_EXTRA_PRESENT (0x400)
-#define MALI_EXTRA_AFBC (0x20)
-#define MALI_EXTRA_AFBC_ZS (0x10)
+/* flags_lo */
#define MALI_EXTRA_ZS (0x4)
-struct bifrost_fb_extra {
+struct mali_framebuffer_extra {
mali_ptr checksum;
/* Each tile has an 8 byte checksum, so the stride is "width in tiles * 8" */
u32 checksum_stride;
- u32 flags;
+ unsigned flags_lo : 4;
+ enum mali_block_format zs_block : 2;
+ unsigned flags_hi : 26;
union {
/* Note: AFBC is only allowed for 24/8 combined depth/stencil. */
struct {
mali_ptr depth_stencil_afbc_metadata;
u32 depth_stencil_afbc_stride; // in units of tiles
- u32 zero1;
+ u32 flags;
mali_ptr depth_stencil;
};
- u64 zero3, zero4;
+ u32 clear_color_1;
+ u32 clear_color_2;
+ u64 zero3;
} __attribute__((packed));
/* Flags for mfbd_flags */
#define MALI_MFBD_DEPTH_WRITE (1 << 10)
-/* The MFBD contains the extra bifrost_fb_extra section */
+/* The MFBD contains the extra mali_framebuffer_extra section */
#define MALI_MFBD_EXTRA (1 << 13)
-struct bifrost_framebuffer {
- u32 unk0; // = 0x10
-
- u32 unknown2; // = 0x1f, same as SFBD
- mali_ptr scratchpad;
+struct mali_framebuffer {
+ union {
+ struct mali_shared_memory shared_memory;
+ struct bifrost_multisampling msaa;
+ };
- /* 0x10 */
- mali_ptr sample_locations;
- mali_ptr unknown1;
/* 0x20 */
u16 width1, height1;
u32 zero3;
u32 mfbd_flags : 24; // = 0x100
float clear_depth;
- struct midgard_tiler_descriptor tiler;
+ union {
+ struct midgard_tiler_descriptor tiler;
+ struct {
+ mali_ptr tiler_meta;
+ u32 zeros[16];
+ };
+ };
- /* optional: struct bifrost_fb_extra extra */
- /* struct bifrost_render_target rts[] */
+ /* optional: struct mali_framebuffer_extra extra */
+ /* struct mali_render_target rts[] */
} __attribute__((packed));
#endif /* __PANFROST_JOB_H__ */