src/panfrost/bifrost/bifrost.h

   1 /*
   2  * Copyright (C) 2019 Connor Abbott <cwabbott0@gmail.com>
   3  * Copyright (C) 2019 Lyude Paul <thatslyude@gmail.com>
   4  * Copyright (C) 2019 Ryan Houdek <Sonicadvance1@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __bifrost_h__
  27 #define __bifrost_h__
  28
  29 #include <stdint.h>
  30 #include <stdbool.h>
  31
  32 struct bifrost_header {
  33         unsigned unk0 : 7;
  34         // If true, convert any infinite result of any floating-point operation to
  35         // the biggest representable number.
  36         unsigned suppress_inf: 1;
  37         // Convert any NaN results to 0.
  38         unsigned suppress_nan : 1;
  39         unsigned unk1 : 2;
  40         // true if the execution mask of the next clause is the same as the mask of
  41         // the current clause.
  42         unsigned back_to_back : 1;
  43         unsigned no_end_of_shader: 1;
  44         unsigned unk2 : 2;
  45         // Set to true for fragment shaders, to implement this bit of spec text
  46         // from section 7.1.5 of the GLSL ES spec:
  47         //
  48         // "Stores to image and buffer variables performed by helper invocations
  49         // have no effect on the underlying image or buffer memory."
  50         //
  51         // Helper invocations are threads (invocations) corresponding to pixels in
  52         // a quad that aren't actually part of the triangle, but are included to
  53         // make derivatives work correctly. They're usually turned on, but they
  54         // need to be masked off for GLSL-level stores. This bit seems to be the
  55         // only bit that's actually different between fragment shaders and other
  56         // shaders, so this is probably what it's doing.
  57         unsigned elide_writes : 1;
  58         // If backToBack is off:
  59         // - true for conditional branches and fallthrough
  60         // - false for unconditional branches
  61         // The blob seems to always set it to true if back-to-back is on.
  62         unsigned branch_cond : 1;
  63         // This bit is set when the next clause writes to the data register of some
  64         // previous clause.
  65         unsigned datareg_writebarrier: 1;
  66         unsigned datareg : 6;
  67         unsigned scoreboard_deps: 8;
  68         unsigned scoreboard_index: 3;
  69         unsigned clause_type: 4;
  70         unsigned unk3 : 1; // part of clauseType?
  71         unsigned next_clause_type: 4;
  72         unsigned unk4 : 1; // part of nextClauseType?
  73 };
  74
  75 struct bifrost_fma_inst {
  76         unsigned src0 : 3;
  77         unsigned op   : 20;
  78 };
  79
  80 struct bifrost_add_inst {
  81         unsigned src0 : 3;
  82         unsigned op   : 17;
  83 };
  84
  85 enum bifrost_outmod {
  86         BIFROST_NONE = 0x0,
  87         BIFROST_POS = 0x1,
  88         BIFROST_SAT_SIGNED = 0x2,
  89         BIFROST_SAT = 0x3,
  90 };
  91
  92 enum bifrost_roundmode {
  93         BIFROST_RTE = 0x0,
  94         BIFROST_RTP = 0x1,
  95         BIFROST_RTN = 0x2,
  96         BIFROST_RTZ = 0x3
  97 };
  98
  99 struct bifrost_fma_add {
 100         unsigned src0 : 3;
 101         unsigned src1 : 3;
 102         unsigned src1_abs : 1;
 103         unsigned src0_neg : 1;
 104         unsigned src1_neg : 1;
 105         unsigned unk : 3;
 106         unsigned src0_abs : 1;
 107         enum bifrost_outmod outmod : 2;
 108         enum bifrost_roundmode roundmode : 2;
 109         unsigned op : 6;
 110 };
 111
 112 enum bifrost_csel_cond {
 113         BIFROST_FEQ_F = 0x0,
 114         BIFROST_FGT_F = 0x1,
 115         BIFROST_FGE_F = 0x2,
 116         BIFROST_IEQ_F = 0x3,
 117         BIFROST_IGT_I = 0x4,
 118         BIFROST_IGE_I = 0x5,
 119         BIFROST_UGT_I = 0x6,
 120         BIFROST_UGE_I = 0x7
 121 };
 122
 123 struct bifrost_csel4 {
 124         unsigned src0 : 3;
 125         unsigned src1 : 3;
 126         unsigned src2 : 3;
 127         unsigned src3 : 3;
 128         enum bifrost_csel_cond cond : 3;
 129         unsigned op   : 8;
 130 };
 131
 132 struct bifrost_shift_fma {
 133         unsigned src0 : 3;
 134         unsigned src1 : 3;
 135         unsigned src2 : 3;
 136         unsigned half : 3; /* 000 for i32, 100 for i8, 111 for v2i16 */
 137         unsigned unk  : 1; /* always set? */
 138         unsigned invert_1 : 1; /* Inverts sources to combining op */
 139         /* For XOR, switches RSHIFT to LSHIFT since only one invert needed */
 140         unsigned invert_2 : 1;
 141         unsigned op : 8;
 142 };
 143
 144 struct bifrost_shift_add {
 145         unsigned src0 : 3;
 146         unsigned src1 : 3;
 147         unsigned src2 : 3;
 148         unsigned zero : 2;
 149
 150         unsigned invert_1 : 1;
 151         unsigned invert_2 : 1;
 152
 153         unsigned op : 7;
 154 };
 155
 156 enum bifrost_ldst_type {
 157         BIFROST_LDST_F16 = 0,
 158         BIFROST_LDST_F32 = 1,
 159         BIFROST_LDST_I32 = 2,
 160         BIFROST_LDST_U32 = 3
 161 };
 162
 163 struct bifrost_ld_var_addr {
 164         unsigned src0 : 3;
 165         unsigned src1 : 3;
 166         unsigned location : 5;
 167         enum bifrost_ldst_type type : 2;
 168         unsigned op : 7;
 169 };
 170
 171 struct bifrost_ld_attr {
 172         unsigned src0 : 3;
 173         unsigned src1 : 3;
 174         unsigned location : 5;
 175         unsigned channels : 2; /* MALI_POSITIVE */
 176         enum bifrost_ldst_type type : 2;
 177         unsigned op : 5;
 178 };
 179
 180 struct bifrost_tex_ctrl {
 181         unsigned sampler_index : 4; // also used to signal indirects
 182         unsigned tex_index : 7;
 183         bool no_merge_index : 1; // whether to merge (direct) sampler & texture indices
 184         bool filter : 1; // use the usual filtering pipeline (0 for texelFetch & textureGather)
 185         unsigned unk0 : 2;
 186         bool texel_offset : 1; // *Offset()
 187         bool is_shadow : 1;
 188         bool is_array : 1;
 189         unsigned tex_type : 2; // 2D, 3D, Cube, Buffer
 190         bool compute_lod : 1; // 0 for *Lod()
 191         bool not_supply_lod : 1; // 0 for *Lod() or when a bias is applied
 192         bool calc_gradients : 1; // 0 for *Grad()
 193         unsigned unk1 : 1;
 194         unsigned result_type : 4; // integer, unsigned, float TODO: why is this 4 bits?
 195         unsigned unk2 : 4;
 196 };
 197
 198 struct bifrost_dual_tex_ctrl {
 199         unsigned sampler_index0 : 2;
 200         unsigned unk0 : 2;
 201         unsigned tex_index0 : 2;
 202         unsigned sampler_index1 : 2;
 203         unsigned tex_index1 : 2;
 204         unsigned unk1 : 22;
 205 };
 206
 207 enum branch_bit_size {
 208         BR_SIZE_32 = 0,
 209         BR_SIZE_16XX = 1,
 210         BR_SIZE_16YY = 2,
 211         // For the above combinations of bitsize and location, an extra bit is
 212         // encoded via comparing the sources. The only possible source of ambiguity
 213         // would be if the sources were the same, but then the branch condition
 214         // would be always true or always false anyways, so we can ignore it. But
 215         // this no longer works when comparing the y component to the x component,
 216         // since it's valid to compare the y component of a source against its own
 217         // x component. Instead, the extra bit is encoded via an extra bitsize.
 218         BR_SIZE_16YX0 = 3,
 219         BR_SIZE_16YX1 = 4,
 220         BR_SIZE_32_AND_16X = 5,
 221         BR_SIZE_32_AND_16Y = 6,
 222         // Used for comparisons with zero and always-true, see below. I think this
 223         // only works for integer comparisons.
 224         BR_SIZE_ZERO = 7,
 225 };
 226
 227 enum bifrost_reg_write_unit {
 228         REG_WRITE_NONE = 0, // don't write
 229         REG_WRITE_TWO, // write using reg2
 230         REG_WRITE_THREE, // write using reg3
 231 };
 232
 233 struct bifrost_regs {
 234         unsigned uniform_const : 8;
 235         unsigned reg2 : 6;
 236         unsigned reg3 : 6;
 237         unsigned reg0 : 5;
 238         unsigned reg1 : 6;
 239         unsigned ctrl : 4;
 240 };
 241
 242 enum bifrost_branch_cond {
 243         BR_COND_LT = 0,
 244         BR_COND_LE = 1,
 245         BR_COND_GE = 2,
 246         BR_COND_GT = 3,
 247         // Equal vs. not-equal determined by src0/src1 comparison
 248         BR_COND_EQ = 4,
 249         // floating-point comparisons
 250         // Becomes UNE when you flip the arguments
 251         BR_COND_OEQ = 5,
 252         // TODO what happens when you flip the arguments?
 253         BR_COND_OGT = 6,
 254         BR_COND_OLT = 7,
 255 };
 256
 257 enum bifrost_branch_code {
 258         BR_ALWAYS = 63,
 259 };
 260
 261 #endif