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 enum bifrost_clause_type {
  33         BIFROST_CLAUSE_NONE       = 0,
  34         BIFROST_CLAUSE_LOAD_VARY  = 1,
  35         BIFROST_CLAUSE_UBO        = 2,
  36         BIFROST_CLAUSE_TEX        = 3,
  37         BIFROST_CLAUSE_SSBO_LOAD  = 5,
  38         BIFROST_CLAUSE_SSBO_STORE = 6,
  39         BIFROST_CLAUSE_BLEND      = 9,
  40         BIFROST_CLAUSE_ATEST      = 13,
  41         BIFROST_CLAUSE_64BIT      = 15
  42 };
  43
  44 struct bifrost_header {
  45         unsigned unk0 : 7;
  46         // If true, convert any infinite result of any floating-point operation to
  47         // the biggest representable number.
  48         unsigned suppress_inf: 1;
  49         // Convert any NaN results to 0.
  50         unsigned suppress_nan : 1;
  51         unsigned unk1 : 2;
  52         // true if the execution mask of the next clause is the same as the mask of
  53         // the current clause.
  54         unsigned back_to_back : 1;
  55         unsigned no_end_of_shader: 1;
  56         unsigned unk2 : 2;
  57         // Set to true for fragment shaders, to implement this bit of spec text
  58         // from section 7.1.5 of the GLSL ES spec:
  59         //
  60         // "Stores to image and buffer variables performed by helper invocations
  61         // have no effect on the underlying image or buffer memory."
  62         //
  63         // Helper invocations are threads (invocations) corresponding to pixels in
  64         // a quad that aren't actually part of the triangle, but are included to
  65         // make derivatives work correctly. They're usually turned on, but they
  66         // need to be masked off for GLSL-level stores. This bit seems to be the
  67         // only bit that's actually different between fragment shaders and other
  68         // shaders, so this is probably what it's doing.
  69         unsigned elide_writes : 1;
  70         // If backToBack is off:
  71         // - true for conditional branches and fallthrough
  72         // - false for unconditional branches
  73         // The blob seems to always set it to true if back-to-back is on.
  74         unsigned branch_cond : 1;
  75         // This bit is set when the next clause writes to the data register of some
  76         // previous clause.
  77         unsigned datareg_writebarrier: 1;
  78         unsigned datareg : 6;
  79         unsigned scoreboard_deps: 8;
  80         unsigned scoreboard_index: 3;
  81         enum bifrost_clause_type clause_type: 4;
  82         unsigned unk3 : 1; // part of clauseType?
  83         enum bifrost_clause_type next_clause_type: 4;
  84         unsigned unk4 : 1; // part of nextClauseType?
  85 } __attribute__((packed));
  86
  87 enum bifrost_packed_src {
  88         BIFROST_SRC_PORT0    = 0,
  89         BIFROST_SRC_PORT1    = 1,
  90         BIFROST_SRC_PORT3    = 2,
  91         BIFROST_SRC_STAGE    = 3,
  92         BIFROST_SRC_CONST_LO = 4,
  93         BIFROST_SRC_CONST_HI = 5,
  94         BIFROST_SRC_PASS_FMA = 6,
  95         BIFROST_SRC_PASS_ADD = 7,
  96 };
  97
  98 struct bifrost_fma_inst {
  99         unsigned src0 : 3;
 100         unsigned op   : 20;
 101 } __attribute__((packed));
 102
 103 struct bifrost_add_inst {
 104         unsigned src0 : 3;
 105         unsigned op   : 17;
 106 } __attribute__((packed));
 107
 108 #define BIFROST_ADD_OP_ATEST (0xc8f)
 109
 110 struct bifrost_add_atest {
 111         /* gl_SampleMask (R60) */
 112         unsigned src0 : 3;
 113
 114         /* Alpha value */
 115         unsigned src1 : 3;
 116
 117         /* If half, X/Y select. If !half, always set */
 118         unsigned component : 1;
 119         unsigned half : 1;
 120
 121         unsigned op   : 12;
 122 } __attribute__((packed));
 123
 124 enum bifrost_outmod {
 125         BIFROST_NONE = 0x0,
 126         BIFROST_POS = 0x1,
 127         BIFROST_SAT_SIGNED = 0x2,
 128         BIFROST_SAT = 0x3,
 129 };
 130
 131 enum bifrost_roundmode {
 132         BIFROST_RTE = 0x0, /* round to even */
 133         BIFROST_RTP = 0x1, /* round to positive */
 134         BIFROST_RTN = 0x2, /* round to negative */
 135         BIFROST_RTZ = 0x3 /* round to zero */
 136 };
 137
 138 /* NONE: Same as fmax() and fmin() -- return the other
 139  * number if any number is NaN.  Also always return +0 if
 140  * one argument is +0 and the other is -0.
 141  *
 142  * NAN_WINS: Instead of never returning a NaN, always return
 143  * one. The "greater"/"lesser" NaN is always returned, first
 144  * by checking the sign and then the mantissa bits.
 145  *
 146  * SRC1_WINS: For max, implement src0 > src1 ? src0 : src1.
 147  * For min, implement src0 < src1 ? src0 : src1.  This
 148  * includes handling NaN's and signedness of 0 differently
 149  * from above, since +0 and -0 compare equal and comparisons
 150  * always return false for NaN's. As a result, this mode is
 151  * *not* commutative.
 152  *
 153  * SRC0_WINS: For max, implement src0 < src1 ? src1 : src0
 154  * For min, implement src0 > src1 ? src1 : src0
 155  */
 156
 157
 158 enum bifrost_minmax_mode {
 159         BIFROST_MINMAX_NONE = 0x0,
 160         BIFROST_NAN_WINS    = 0x1,
 161         BIFROST_SRC1_WINS   = 0x2,
 162         BIFROST_SRC0_WINS   = 0x3,
 163 };
 164
 165 #define BIFROST_FMA_OP_FADD32 (0x58 >> 2)
 166
 167 struct bifrost_fma_add {
 168         unsigned src0 : 3;
 169         unsigned src1 : 3;
 170         unsigned src1_abs : 1;
 171         unsigned src0_neg : 1;
 172         unsigned src1_neg : 1;
 173         unsigned unk : 3;
 174         unsigned src0_abs : 1;
 175         enum bifrost_outmod outmod : 2;
 176         enum bifrost_roundmode roundmode : 2;
 177         unsigned op : 6;
 178 } __attribute__((packed));
 179
 180 #define BIFROST_FMA_OP_FMA (0x00)
 181
 182 struct bifrost_fma_fma {
 183         unsigned src0 : 3;
 184         unsigned src1 : 3;
 185         unsigned src2 : 3;
 186         unsigned src_expand : 3;
 187         unsigned src0_abs : 1;
 188         unsigned unk : 4;
 189         unsigned src0_neg : 1;
 190         unsigned src2_neg : 1;
 191         unsigned src1_abs : 1;
 192         unsigned src2_abs : 1;
 193         unsigned op : 5;
 194 } __attribute__((packed));
 195
 196 enum bifrost_csel_cond {
 197         BIFROST_FEQ_F = 0x0,
 198         BIFROST_FGT_F = 0x1,
 199         BIFROST_FGE_F = 0x2,
 200         BIFROST_IEQ_F = 0x3,
 201         BIFROST_IGT_I = 0x4,
 202         BIFROST_IGE_I = 0x5,
 203         BIFROST_UGT_I = 0x6,
 204         BIFROST_UGE_I = 0x7
 205 };
 206
 207 struct bifrost_csel4 {
 208         unsigned src0 : 3;
 209         unsigned src1 : 3;
 210         unsigned src2 : 3;
 211         unsigned src3 : 3;
 212         enum bifrost_csel_cond cond : 3;
 213         unsigned op   : 8;
 214 } __attribute__((packed));
 215
 216 struct bifrost_shift_fma {
 217         unsigned src0 : 3;
 218         unsigned src1 : 3;
 219         unsigned src2 : 3;
 220         unsigned half : 3; /* 000 for i32, 100 for i8, 111 for v2i16 */
 221         unsigned unk  : 1; /* always set? */
 222         unsigned invert_1 : 1; /* Inverts sources to combining op */
 223         /* For XOR, switches RSHIFT to LSHIFT since only one invert needed */
 224         unsigned invert_2 : 1;
 225         unsigned op : 8;
 226 } __attribute__((packed));
 227
 228 struct bifrost_shift_add {
 229         unsigned src0 : 3;
 230         unsigned src1 : 3;
 231         unsigned src2 : 3;
 232         unsigned zero : 2;
 233
 234         unsigned invert_1 : 1;
 235         unsigned invert_2 : 1;
 236
 237         unsigned op : 7;
 238 } __attribute__((packed));
 239
 240 enum bifrost_ldst_type {
 241         BIFROST_LDST_F16 = 0,
 242         BIFROST_LDST_F32 = 1,
 243         BIFROST_LDST_I32 = 2,
 244         BIFROST_LDST_U32 = 3
 245 };
 246
 247 struct bifrost_ld_var_addr {
 248         unsigned src0 : 3;
 249         unsigned src1 : 3;
 250         unsigned location : 5;
 251         enum bifrost_ldst_type type : 2;
 252         unsigned op : 7;
 253 } __attribute__((packed));
 254
 255 struct bifrost_ld_attr {
 256         unsigned src0 : 3;
 257         unsigned src1 : 3;
 258         unsigned location : 5;
 259         unsigned channels : 2; /* MALI_POSITIVE */
 260         enum bifrost_ldst_type type : 2;
 261         unsigned op : 5;
 262 } __attribute__((packed));
 263
 264 enum bifrost_interp_mode {
 265         BIFROST_INTERP_PER_FRAG = 0x0,
 266         BIFROST_INTERP_CENTROID = 0x1,
 267         BIFROST_INTERP_DEFAULT  = 0x2,
 268         BIFROST_INTERP_EXPLICIT = 0x3
 269 };
 270
 271 #define BIFROST_ADD_OP_LD_VAR_16 (0x1a << 1)
 272 #define BIFROST_ADD_OP_LD_VAR_32 (0x0a << 1)
 273
 274 struct bifrost_ld_var {
 275         unsigned src0 : 3;
 276
 277         /* If top two bits set, indirect with src in bottom three */
 278         unsigned addr : 5;
 279
 280         unsigned channels : 2; /* MALI_POSITIVE */
 281         enum bifrost_interp_mode interp_mode : 2;
 282         unsigned reuse : 1;
 283         unsigned flat : 1;
 284         unsigned op : 6;
 285 } __attribute__((packed));
 286
 287 struct bifrost_tex_ctrl {
 288         unsigned sampler_index : 4; // also used to signal indirects
 289         unsigned tex_index : 7;
 290         bool no_merge_index : 1; // whether to merge (direct) sampler & texture indices
 291         bool filter : 1; // use the usual filtering pipeline (0 for texelFetch & textureGather)
 292         unsigned unk0 : 2;
 293         bool texel_offset : 1; // *Offset()
 294         bool is_shadow : 1;
 295         bool is_array : 1;
 296         unsigned tex_type : 2; // 2D, 3D, Cube, Buffer
 297         bool compute_lod : 1; // 0 for *Lod()
 298         bool not_supply_lod : 1; // 0 for *Lod() or when a bias is applied
 299         bool calc_gradients : 1; // 0 for *Grad()
 300         unsigned unk1 : 1;
 301         unsigned result_type : 4; // integer, unsigned, float TODO: why is this 4 bits?
 302         unsigned unk2 : 4;
 303 } __attribute__((packed));
 304
 305 struct bifrost_dual_tex_ctrl {
 306         unsigned sampler_index0 : 2;
 307         unsigned unk0 : 2;
 308         unsigned tex_index0 : 2;
 309         unsigned sampler_index1 : 2;
 310         unsigned tex_index1 : 2;
 311         unsigned unk1 : 22;
 312 } __attribute__((packed));
 313
 314 enum branch_bit_size {
 315         BR_SIZE_32 = 0,
 316         BR_SIZE_16XX = 1,
 317         BR_SIZE_16YY = 2,
 318         // For the above combinations of bitsize and location, an extra bit is
 319         // encoded via comparing the sources. The only possible source of ambiguity
 320         // would be if the sources were the same, but then the branch condition
 321         // would be always true or always false anyways, so we can ignore it. But
 322         // this no longer works when comparing the y component to the x component,
 323         // since it's valid to compare the y component of a source against its own
 324         // x component. Instead, the extra bit is encoded via an extra bitsize.
 325         BR_SIZE_16YX0 = 3,
 326         BR_SIZE_16YX1 = 4,
 327         BR_SIZE_32_AND_16X = 5,
 328         BR_SIZE_32_AND_16Y = 6,
 329         // Used for comparisons with zero and always-true, see below. I think this
 330         // only works for integer comparisons.
 331         BR_SIZE_ZERO = 7,
 332 };
 333
 334 enum bifrost_reg_write_unit {
 335         REG_WRITE_NONE = 0, // don't write
 336         REG_WRITE_TWO, // write using reg2
 337         REG_WRITE_THREE, // write using reg3
 338 };
 339
 340 struct bifrost_regs {
 341         unsigned uniform_const : 8;
 342         unsigned reg2 : 6;
 343         unsigned reg3 : 6;
 344         unsigned reg0 : 5;
 345         unsigned reg1 : 6;
 346         unsigned ctrl : 4;
 347 } __attribute__((packed));
 348
 349 enum bifrost_branch_cond {
 350         BR_COND_LT = 0,
 351         BR_COND_LE = 1,
 352         BR_COND_GE = 2,
 353         BR_COND_GT = 3,
 354         // Equal vs. not-equal determined by src0/src1 comparison
 355         BR_COND_EQ = 4,
 356         // floating-point comparisons
 357         // Becomes UNE when you flip the arguments
 358         BR_COND_OEQ = 5,
 359         // TODO what happens when you flip the arguments?
 360         BR_COND_OGT = 6,
 361         BR_COND_OLT = 7,
 362 };
 363
 364 enum bifrost_branch_code {
 365         BR_ALWAYS = 63,
 366 };
 367
 368 struct bifrost_branch {
 369         unsigned src0 : 3;
 370
 371         /* For BR_SIZE_ZERO, upper two bits become ctrl */
 372         unsigned src1 : 3;
 373
 374         /* Offset source -- always uniform/const but
 375          * theoretically could support indirect jumps? */
 376         unsigned src2 : 3;
 377
 378         enum bifrost_branch_cond cond : 3;
 379         enum branch_bit_size size : 3;
 380
 381         unsigned op : 5;
 382 };
 383
 384 /* Clause packing */
 385
 386 #define BIFROST_FMA_NOP (0x701960)
 387 #define BIFROST_ADD_NOP (0x3D960)
 388
 389 struct bifrost_fmt1 {
 390         unsigned ins_0 : 3;
 391         unsigned tag : 5;
 392         uint64_t ins_1 : 64;
 393         unsigned ins_2 : 11;
 394         uint64_t header : 45;
 395 } __attribute__((packed));
 396
 397 #define BIFROST_FMT1_INSTRUCTIONS    0b00101
 398 #define BIFROST_FMT1_FINAL           0b01001
 399 #define BIFROST_FMT1_CONSTANTS       0b00001
 400
 401 enum bifrost_reg_control {
 402         BIFROST_WRITE_FMA_P2         = 1,
 403         BIFROST_WRITE_FMA_P2_READ_P3 = 2,
 404         BIFROST_WRITE_FMA_P2_READ_P3_ALT = 3,
 405         BIFROST_READ_P3              = 4,
 406         BIFROST_WRITE_ADD_P2         = 5,
 407         BIFROST_WRITE_ADD_P2_READ_P3 = 6,
 408         BIFROST_WRITE_ADD_P2_FMA_P3  = 7,
 409
 410         BIFROST_FIRST_NONE           = 8,
 411         BIFROST_FIRST_WRITE_FMA_P2   = 9,
 412         BIFROST_REG_NONE             = 11,
 413         BIFROST_FIRST_READ_P3        = 12,
 414         BIFROST_FIRST_WRITE_ADD_P2   = 13,
 415         BIFROST_FIRST_WRITE_ADD_P2_READ_P3 = 14,
 416         BIFROST_FIRST_WRITE_ADD_P2_FMA_P3  = 15
 417 };
 418
 419 #endif