src/gallium/include/pipe/p_shader_tokens.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * Copyright 2009 VMware, Inc.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  22  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  23  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  24  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  25  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29 #ifndef P_SHADER_TOKENS_H
  30 #define P_SHADER_TOKENS_H
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include "p_compiler.h"
  37
  38
  39 struct tgsi_header
  40 {
  41    unsigned HeaderSize : 8;
  42    unsigned BodySize   : 24;
  43 };
  44
  45 #define TGSI_PROCESSOR_FRAGMENT  0
  46 #define TGSI_PROCESSOR_VERTEX    1
  47 #define TGSI_PROCESSOR_GEOMETRY  2
  48
  49 struct tgsi_processor
  50 {
  51    unsigned Processor  : 4;  /* TGSI_PROCESSOR_ */
  52    unsigned Padding    : 28;
  53 };
  54
  55 #define TGSI_TOKEN_TYPE_DECLARATION    0
  56 #define TGSI_TOKEN_TYPE_IMMEDIATE      1
  57 #define TGSI_TOKEN_TYPE_INSTRUCTION    2
  58 #define TGSI_TOKEN_TYPE_PROPERTY       3
  59
  60 struct tgsi_token
  61 {
  62    unsigned Type       : 4;  /**< TGSI_TOKEN_TYPE_x */
  63    unsigned NrTokens   : 8;  /**< UINT */
  64    unsigned Padding    : 20;
  65 };
  66
  67 enum tgsi_file_type {
  68    TGSI_FILE_NULL         =0,
  69    TGSI_FILE_CONSTANT     =1,
  70    TGSI_FILE_INPUT        =2,
  71    TGSI_FILE_OUTPUT       =3,
  72    TGSI_FILE_TEMPORARY    =4,
  73    TGSI_FILE_SAMPLER      =5,
  74    TGSI_FILE_ADDRESS      =6,
  75    TGSI_FILE_IMMEDIATE    =7,
  76    TGSI_FILE_LOOP         =8,
  77    TGSI_FILE_PREDICATE    =9,
  78    TGSI_FILE_SYSTEM_VALUE =10,
  79    TGSI_FILE_COUNT      /**< how many TGSI_FILE_ types */
  80 };
  81
  82
  83 #define TGSI_WRITEMASK_NONE     0x00
  84 #define TGSI_WRITEMASK_X        0x01
  85 #define TGSI_WRITEMASK_Y        0x02
  86 #define TGSI_WRITEMASK_XY       0x03
  87 #define TGSI_WRITEMASK_Z        0x04
  88 #define TGSI_WRITEMASK_XZ       0x05
  89 #define TGSI_WRITEMASK_YZ       0x06
  90 #define TGSI_WRITEMASK_XYZ      0x07
  91 #define TGSI_WRITEMASK_W        0x08
  92 #define TGSI_WRITEMASK_XW       0x09
  93 #define TGSI_WRITEMASK_YW       0x0A
  94 #define TGSI_WRITEMASK_XYW      0x0B
  95 #define TGSI_WRITEMASK_ZW       0x0C
  96 #define TGSI_WRITEMASK_XZW      0x0D
  97 #define TGSI_WRITEMASK_YZW      0x0E
  98 #define TGSI_WRITEMASK_XYZW     0x0F
  99
 100 #define TGSI_INTERPOLATE_CONSTANT      0
 101 #define TGSI_INTERPOLATE_LINEAR        1
 102 #define TGSI_INTERPOLATE_PERSPECTIVE   2
 103 #define TGSI_INTERPOLATE_COUNT         3
 104
 105 struct tgsi_declaration
 106 {
 107    unsigned Type        : 4;  /**< TGSI_TOKEN_TYPE_DECLARATION */
 108    unsigned NrTokens    : 8;  /**< UINT */
 109    unsigned File        : 4;  /**< one of TGSI_FILE_x */
 110    unsigned UsageMask   : 4;  /**< bitmask of TGSI_WRITEMASK_x flags */
 111    unsigned Interpolate : 4;  /**< one of TGSI_INTERPOLATE_x */
 112    unsigned Semantic    : 1;  /**< BOOL, any semantic info? */
 113    unsigned Centroid    : 1;  /**< centroid sampling? */
 114    unsigned Invariant   : 1;  /**< invariant optimization? */
 115    unsigned Padding     : 5;
 116 };
 117
 118 struct tgsi_declaration_range
 119 {
 120    unsigned First   : 16; /**< UINT */
 121    unsigned Last    : 16; /**< UINT */
 122 };
 123
 124 #define TGSI_SEMANTIC_POSITION  0
 125 #define TGSI_SEMANTIC_COLOR     1
 126 #define TGSI_SEMANTIC_BCOLOR    2 /**< back-face color */
 127 #define TGSI_SEMANTIC_FOG       3
 128 #define TGSI_SEMANTIC_PSIZE     4
 129 #define TGSI_SEMANTIC_GENERIC   5
 130 #define TGSI_SEMANTIC_NORMAL    6
 131 #define TGSI_SEMANTIC_FACE      7
 132 #define TGSI_SEMANTIC_EDGEFLAG  8
 133 #define TGSI_SEMANTIC_VERTICES  9
 134 #define TGSI_SEMANTIC_PRIMID   10
 135 #define TGSI_SEMANTIC_COUNT    11 /**< number of semantic values */
 136
 137 struct tgsi_declaration_semantic
 138 {
 139    unsigned Name           : 8;  /**< one of TGSI_SEMANTIC_x */
 140    unsigned Index          : 16; /**< UINT */
 141    unsigned Padding        : 8;
 142 };
 143
 144 #define TGSI_IMM_FLOAT32   0
 145
 146 struct tgsi_immediate
 147 {
 148    unsigned Type       : 4;  /**< TGSI_TOKEN_TYPE_IMMEDIATE */
 149    unsigned NrTokens   : 8;  /**< UINT */
 150    unsigned DataType   : 4;  /**< one of TGSI_IMM_x */
 151    unsigned Padding    : 16;
 152 };
 153
 154 union tgsi_immediate_data
 155 {
 156    float Float;
 157 };
 158
 159 #define TGSI_PROPERTY_GS_INPUT_PRIM          0
 160 #define TGSI_PROPERTY_GS_OUTPUT_PRIM         1
 161 #define TGSI_PROPERTY_GS_MAX_VERTICES        2
 162 #define TGSI_PROPERTY_COUNT                  3
 163
 164 struct tgsi_property {
 165    unsigned Type         : 4;  /**< TGSI_TOKEN_TYPE_PROPERTY */
 166    unsigned NrTokens     : 8;  /**< UINT */
 167    unsigned PropertyName : 8;  /**< one of TGSI_PROPERTY */
 168    unsigned Padding      : 12;
 169 };
 170
 171 struct tgsi_property_data {
 172    unsigned Data;
 173 };
 174
 175 /* TGSI opcodes.
 176  *
 177  * For more information on semantics of opcodes and
 178  * which APIs are known to use which opcodes, see
 179  * auxiliary/tgsi/tgsi-instruction-set.txt
 180  */
 181 #define TGSI_OPCODE_ARL                 0
 182 #define TGSI_OPCODE_MOV                 1
 183 #define TGSI_OPCODE_LIT                 2
 184 #define TGSI_OPCODE_RCP                 3
 185 #define TGSI_OPCODE_RSQ                 4
 186 #define TGSI_OPCODE_EXP                 5
 187 #define TGSI_OPCODE_LOG                 6
 188 #define TGSI_OPCODE_MUL                 7
 189 #define TGSI_OPCODE_ADD                 8
 190 #define TGSI_OPCODE_DP3                 9
 191 #define TGSI_OPCODE_DP4                 10
 192 #define TGSI_OPCODE_DST                 11
 193 #define TGSI_OPCODE_MIN                 12
 194 #define TGSI_OPCODE_MAX                 13
 195 #define TGSI_OPCODE_SLT                 14
 196 #define TGSI_OPCODE_SGE                 15
 197 #define TGSI_OPCODE_MAD                 16
 198 #define TGSI_OPCODE_SUB                 17
 199 #define TGSI_OPCODE_LRP                 18
 200 #define TGSI_OPCODE_CND                 19
 201                                 /* gap */
 202 #define TGSI_OPCODE_DP2A                21
 203                                 /* gap */
 204 #define TGSI_OPCODE_FRC                 24
 205 #define TGSI_OPCODE_CLAMP               25
 206 #define TGSI_OPCODE_FLR                 26
 207 #define TGSI_OPCODE_ROUND               27
 208 #define TGSI_OPCODE_EX2                 28
 209 #define TGSI_OPCODE_LG2                 29
 210 #define TGSI_OPCODE_POW                 30
 211 #define TGSI_OPCODE_XPD                 31
 212                                 /* gap */
 213 #define TGSI_OPCODE_ABS                 33
 214 #define TGSI_OPCODE_RCC                 34
 215 #define TGSI_OPCODE_DPH                 35
 216 #define TGSI_OPCODE_COS                 36
 217 #define TGSI_OPCODE_DDX                 37
 218 #define TGSI_OPCODE_DDY                 38
 219 #define TGSI_OPCODE_KILP                39  /* predicated kill */
 220 #define TGSI_OPCODE_PK2H                40
 221 #define TGSI_OPCODE_PK2US               41
 222 #define TGSI_OPCODE_PK4B                42
 223 #define TGSI_OPCODE_PK4UB               43
 224 #define TGSI_OPCODE_RFL                 44
 225 #define TGSI_OPCODE_SEQ                 45
 226 #define TGSI_OPCODE_SFL                 46
 227 #define TGSI_OPCODE_SGT                 47
 228 #define TGSI_OPCODE_SIN                 48
 229 #define TGSI_OPCODE_SLE                 49
 230 #define TGSI_OPCODE_SNE                 50
 231 #define TGSI_OPCODE_STR                 51
 232 #define TGSI_OPCODE_TEX                 52
 233 #define TGSI_OPCODE_TXD                 53
 234 #define TGSI_OPCODE_TXP                 54
 235 #define TGSI_OPCODE_UP2H                55
 236 #define TGSI_OPCODE_UP2US               56
 237 #define TGSI_OPCODE_UP4B                57
 238 #define TGSI_OPCODE_UP4UB               58
 239 #define TGSI_OPCODE_X2D                 59
 240 #define TGSI_OPCODE_ARA                 60
 241 #define TGSI_OPCODE_ARR                 61
 242 #define TGSI_OPCODE_BRA                 62
 243 #define TGSI_OPCODE_CAL                 63
 244 #define TGSI_OPCODE_RET                 64
 245 #define TGSI_OPCODE_SSG                 65 /* SGN */
 246 #define TGSI_OPCODE_CMP                 66
 247 #define TGSI_OPCODE_SCS                 67
 248 #define TGSI_OPCODE_TXB                 68
 249 #define TGSI_OPCODE_NRM                 69
 250 #define TGSI_OPCODE_DIV                 70
 251 #define TGSI_OPCODE_DP2                 71
 252 #define TGSI_OPCODE_TXL                 72
 253 #define TGSI_OPCODE_BRK                 73
 254 #define TGSI_OPCODE_IF                  74
 255 #define TGSI_OPCODE_BGNFOR              75
 256 #define TGSI_OPCODE_REP                 76
 257 #define TGSI_OPCODE_ELSE                77
 258 #define TGSI_OPCODE_ENDIF               78
 259 #define TGSI_OPCODE_ENDFOR              79
 260 #define TGSI_OPCODE_ENDREP              80
 261 #define TGSI_OPCODE_PUSHA               81
 262 #define TGSI_OPCODE_POPA                82
 263 #define TGSI_OPCODE_CEIL                83
 264 #define TGSI_OPCODE_I2F                 84
 265 #define TGSI_OPCODE_NOT                 85
 266 #define TGSI_OPCODE_TRUNC               86
 267 #define TGSI_OPCODE_SHL                 87
 268 #define TGSI_OPCODE_SHR                 88
 269 #define TGSI_OPCODE_AND                 89
 270 #define TGSI_OPCODE_OR                  90
 271 #define TGSI_OPCODE_MOD                 91
 272 #define TGSI_OPCODE_XOR                 92
 273 #define TGSI_OPCODE_SAD                 93
 274 #define TGSI_OPCODE_TXF                 94
 275 #define TGSI_OPCODE_TXQ                 95
 276 #define TGSI_OPCODE_CONT                96
 277 #define TGSI_OPCODE_EMIT                97
 278 #define TGSI_OPCODE_ENDPRIM             98
 279 #define TGSI_OPCODE_BGNLOOP             99
 280 #define TGSI_OPCODE_BGNSUB              100
 281 #define TGSI_OPCODE_ENDLOOP             101
 282 #define TGSI_OPCODE_ENDSUB              102
 283                                 /* gap */
 284 #define TGSI_OPCODE_NOP                 107
 285                                 /* gap */
 286 #define TGSI_OPCODE_NRM4                112
 287 #define TGSI_OPCODE_CALLNZ              113
 288 #define TGSI_OPCODE_IFC                 114
 289 #define TGSI_OPCODE_BREAKC              115
 290 #define TGSI_OPCODE_KIL                 116  /* conditional kill */
 291 #define TGSI_OPCODE_END                 117  /* aka HALT */
 292                                 /* gap */
 293 #define TGSI_OPCODE_LAST                119
 294
 295 #define TGSI_SAT_NONE            0  /* do not saturate */
 296 #define TGSI_SAT_ZERO_ONE        1  /* clamp to [0,1] */
 297 #define TGSI_SAT_MINUS_PLUS_ONE  2  /* clamp to [-1,1] */
 298
 299 /**
 300  * Opcode is the operation code to execute. A given operation defines the
 301  * semantics how the source registers (if any) are interpreted and what is
 302  * written to the destination registers (if any) as a result of execution.
 303  *
 304  * NumDstRegs and NumSrcRegs is the number of destination and source registers,
 305  * respectively. For a given operation code, those numbers are fixed and are
 306  * present here only for convenience.
 307  *
 308  * If Predicate is TRUE, tgsi_instruction_predicate token immediately follows.
 309  *
 310  * Saturate controls how are final results in destination registers modified.
 311  */
 312
 313 struct tgsi_instruction
 314 {
 315    unsigned Type       : 4;  /* TGSI_TOKEN_TYPE_INSTRUCTION */
 316    unsigned NrTokens   : 8;  /* UINT */
 317    unsigned Opcode     : 8;  /* TGSI_OPCODE_ */
 318    unsigned Saturate   : 2;  /* TGSI_SAT_ */
 319    unsigned NumDstRegs : 2;  /* UINT */
 320    unsigned NumSrcRegs : 4;  /* UINT */
 321    unsigned Predicate  : 1;  /* BOOL */
 322    unsigned Label      : 1;
 323    unsigned Texture    : 1;
 324    unsigned Padding    : 1;
 325 };
 326
 327 /*
 328  * If tgsi_instruction::Label is TRUE, tgsi_instruction_label follows.
 329  *
 330  * If tgsi_instruction::Texture is TRUE, tgsi_instruction_texture follows.
 331  *
 332  * Then, tgsi_instruction::NumDstRegs of tgsi_dst_register follow.
 333  *
 334  * Then, tgsi_instruction::NumSrcRegs of tgsi_src_register follow.
 335  *
 336  * tgsi_instruction::NrTokens contains the total number of words that make the
 337  * instruction, including the instruction word.
 338  */
 339
 340 #define TGSI_SWIZZLE_X      0
 341 #define TGSI_SWIZZLE_Y      1
 342 #define TGSI_SWIZZLE_Z      2
 343 #define TGSI_SWIZZLE_W      3
 344
 345 struct tgsi_instruction_label
 346 {
 347    unsigned Label    : 24;   /* UINT */
 348    unsigned Padding  : 8;
 349 };
 350
 351 #define TGSI_TEXTURE_UNKNOWN        0
 352 #define TGSI_TEXTURE_1D             1
 353 #define TGSI_TEXTURE_2D             2
 354 #define TGSI_TEXTURE_3D             3
 355 #define TGSI_TEXTURE_CUBE           4
 356 #define TGSI_TEXTURE_RECT           5
 357 #define TGSI_TEXTURE_SHADOW1D       6
 358 #define TGSI_TEXTURE_SHADOW2D       7
 359 #define TGSI_TEXTURE_SHADOWRECT     8
 360 #define TGSI_TEXTURE_COUNT          9
 361
 362 struct tgsi_instruction_texture
 363 {
 364    unsigned Texture  : 8;    /* TGSI_TEXTURE_ */
 365    unsigned Padding  : 24;
 366 };
 367
 368 /*
 369  * For SM3, the following constraint applies.
 370  *   - Swizzle is either set to identity or replicate.
 371  */
 372 struct tgsi_instruction_predicate
 373 {
 374    int      Index    : 16; /* SINT */
 375    unsigned SwizzleX : 2;  /* TGSI_SWIZZLE_x */
 376    unsigned SwizzleY : 2;  /* TGSI_SWIZZLE_x */
 377    unsigned SwizzleZ : 2;  /* TGSI_SWIZZLE_x */
 378    unsigned SwizzleW : 2;  /* TGSI_SWIZZLE_x */
 379    unsigned Negate   : 1;  /* BOOL */
 380    unsigned Padding  : 7;
 381 };
 382
 383 /**
 384  * File specifies the register array to access.
 385  *
 386  * Index specifies the element number of a register in the register file.
 387  *
 388  * If Indirect is TRUE, Index should be offset by the X component of a source
 389  * register that follows. The register can be now fetched into local storage
 390  * for further processing.
 391  *
 392  * If Negate is TRUE, all components of the fetched register are negated.
 393  *
 394  * The fetched register components are swizzled according to SwizzleX, SwizzleY,
 395  * SwizzleZ and SwizzleW.
 396  *
 397  */
 398
 399 struct tgsi_src_register
 400 {
 401    unsigned File        : 4;  /* TGSI_FILE_ */
 402    unsigned Indirect    : 1;  /* BOOL */
 403    unsigned Dimension   : 1;  /* BOOL */
 404    int      Index       : 16; /* SINT */
 405    unsigned SwizzleX    : 2;  /* TGSI_SWIZZLE_ */
 406    unsigned SwizzleY    : 2;  /* TGSI_SWIZZLE_ */
 407    unsigned SwizzleZ    : 2;  /* TGSI_SWIZZLE_ */
 408    unsigned SwizzleW    : 2;  /* TGSI_SWIZZLE_ */
 409    unsigned Absolute    : 1;    /* BOOL */
 410    unsigned Negate      : 1;    /* BOOL */
 411 };
 412
 413 /**
 414  * If tgsi_src_register::Modifier is TRUE, tgsi_src_register_modifier follows.
 415  *
 416  * Then, if tgsi_src_register::Indirect is TRUE, another tgsi_src_register
 417  * follows.
 418  *
 419  * Then, if tgsi_src_register::Dimension is TRUE, tgsi_dimension follows.
 420  */
 421
 422
 423 struct tgsi_dimension
 424 {
 425    unsigned Indirect    : 1;  /* BOOL */
 426    unsigned Dimension   : 1;  /* BOOL */
 427    unsigned Padding     : 14;
 428    int      Index       : 16; /* SINT */
 429 };
 430
 431 struct tgsi_dst_register
 432 {
 433    unsigned File        : 4;  /* TGSI_FILE_ */
 434    unsigned WriteMask   : 4;  /* TGSI_WRITEMASK_ */
 435    unsigned Indirect    : 1;  /* BOOL */
 436    unsigned Dimension   : 1;  /* BOOL */
 437    int      Index       : 16; /* SINT */
 438    unsigned Padding     : 6;
 439 };
 440
 441
 442 #ifdef __cplusplus
 443 }
 444 #endif
 445
 446 #endif /* P_SHADER_TOKENS_H */