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 Dimension   : 1;  /**< any extra dimension info? */
 113    unsigned Semantic    : 1;  /**< BOOL, any semantic info? */
 114    unsigned Centroid    : 1;  /**< centroid sampling? */
 115    unsigned Invariant   : 1;  /**< invariant optimization? */
 116    unsigned Padding     : 4;
 117 };
 118
 119 struct tgsi_declaration_range
 120 {
 121    unsigned First   : 16; /**< UINT */
 122    unsigned Last    : 16; /**< UINT */
 123 };
 124
 125 struct tgsi_declaration_dimension
 126 {
 127    unsigned Index2D:16; /**< UINT */
 128    unsigned Padding:16;
 129 };
 130
 131 #define TGSI_SEMANTIC_POSITION   0
 132 #define TGSI_SEMANTIC_COLOR      1
 133 #define TGSI_SEMANTIC_BCOLOR     2  /**< back-face color */
 134 #define TGSI_SEMANTIC_FOG        3
 135 #define TGSI_SEMANTIC_PSIZE      4
 136 #define TGSI_SEMANTIC_GENERIC    5
 137 #define TGSI_SEMANTIC_NORMAL     6
 138 #define TGSI_SEMANTIC_FACE       7
 139 #define TGSI_SEMANTIC_EDGEFLAG   8
 140 #define TGSI_SEMANTIC_PRIMID     9
 141 #define TGSI_SEMANTIC_INSTANCEID 10
 142 #define TGSI_SEMANTIC_COUNT      11 /**< number of semantic values */
 143
 144 struct tgsi_declaration_semantic
 145 {
 146    unsigned Name           : 8;  /**< one of TGSI_SEMANTIC_x */
 147    unsigned Index          : 16; /**< UINT */
 148    unsigned Padding        : 8;
 149 };
 150
 151 #define TGSI_IMM_FLOAT32   0
 152 #define TGSI_IMM_UINT32    1
 153 #define TGSI_IMM_INT32     2
 154
 155 struct tgsi_immediate
 156 {
 157    unsigned Type       : 4;  /**< TGSI_TOKEN_TYPE_IMMEDIATE */
 158    unsigned NrTokens   : 8;  /**< UINT */
 159    unsigned DataType   : 4;  /**< one of TGSI_IMM_x */
 160    unsigned Padding    : 16;
 161 };
 162
 163 union tgsi_immediate_data
 164 {
 165    float Float;
 166    unsigned Uint;
 167    int Int;
 168 };
 169
 170 #define TGSI_PROPERTY_GS_INPUT_PRIM          0
 171 #define TGSI_PROPERTY_GS_OUTPUT_PRIM         1
 172 #define TGSI_PROPERTY_GS_MAX_VERTICES        2
 173 #define TGSI_PROPERTY_COUNT                  3
 174
 175 struct tgsi_property {
 176    unsigned Type         : 4;  /**< TGSI_TOKEN_TYPE_PROPERTY */
 177    unsigned NrTokens     : 8;  /**< UINT */
 178    unsigned PropertyName : 8;  /**< one of TGSI_PROPERTY */
 179    unsigned Padding      : 12;
 180 };
 181
 182 struct tgsi_property_data {
 183    unsigned Data;
 184 };
 185
 186 /* TGSI opcodes.
 187  *
 188  * For more information on semantics of opcodes and
 189  * which APIs are known to use which opcodes, see
 190  * auxiliary/tgsi/tgsi-instruction-set.txt
 191  */
 192 #define TGSI_OPCODE_ARL                 0
 193 #define TGSI_OPCODE_MOV                 1
 194 #define TGSI_OPCODE_LIT                 2
 195 #define TGSI_OPCODE_RCP                 3
 196 #define TGSI_OPCODE_RSQ                 4
 197 #define TGSI_OPCODE_EXP                 5
 198 #define TGSI_OPCODE_LOG                 6
 199 #define TGSI_OPCODE_MUL                 7
 200 #define TGSI_OPCODE_ADD                 8
 201 #define TGSI_OPCODE_DP3                 9
 202 #define TGSI_OPCODE_DP4                 10
 203 #define TGSI_OPCODE_DST                 11
 204 #define TGSI_OPCODE_MIN                 12
 205 #define TGSI_OPCODE_MAX                 13
 206 #define TGSI_OPCODE_SLT                 14
 207 #define TGSI_OPCODE_SGE                 15
 208 #define TGSI_OPCODE_MAD                 16
 209 #define TGSI_OPCODE_SUB                 17
 210 #define TGSI_OPCODE_LRP                 18
 211 #define TGSI_OPCODE_CND                 19
 212                                 /* gap */
 213 #define TGSI_OPCODE_DP2A                21
 214                                 /* gap */
 215 #define TGSI_OPCODE_FRC                 24
 216 #define TGSI_OPCODE_CLAMP               25
 217 #define TGSI_OPCODE_FLR                 26
 218 #define TGSI_OPCODE_ROUND               27
 219 #define TGSI_OPCODE_EX2                 28
 220 #define TGSI_OPCODE_LG2                 29
 221 #define TGSI_OPCODE_POW                 30
 222 #define TGSI_OPCODE_XPD                 31
 223                                 /* gap */
 224 #define TGSI_OPCODE_ABS                 33
 225 #define TGSI_OPCODE_RCC                 34
 226 #define TGSI_OPCODE_DPH                 35
 227 #define TGSI_OPCODE_COS                 36
 228 #define TGSI_OPCODE_DDX                 37
 229 #define TGSI_OPCODE_DDY                 38
 230 #define TGSI_OPCODE_KILP                39  /* predicated kill */
 231 #define TGSI_OPCODE_PK2H                40
 232 #define TGSI_OPCODE_PK2US               41
 233 #define TGSI_OPCODE_PK4B                42
 234 #define TGSI_OPCODE_PK4UB               43
 235 #define TGSI_OPCODE_RFL                 44
 236 #define TGSI_OPCODE_SEQ                 45
 237 #define TGSI_OPCODE_SFL                 46
 238 #define TGSI_OPCODE_SGT                 47
 239 #define TGSI_OPCODE_SIN                 48
 240 #define TGSI_OPCODE_SLE                 49
 241 #define TGSI_OPCODE_SNE                 50
 242 #define TGSI_OPCODE_STR                 51
 243 #define TGSI_OPCODE_TEX                 52
 244 #define TGSI_OPCODE_TXD                 53
 245 #define TGSI_OPCODE_TXP                 54
 246 #define TGSI_OPCODE_UP2H                55
 247 #define TGSI_OPCODE_UP2US               56
 248 #define TGSI_OPCODE_UP4B                57
 249 #define TGSI_OPCODE_UP4UB               58
 250 #define TGSI_OPCODE_X2D                 59
 251 #define TGSI_OPCODE_ARA                 60
 252 #define TGSI_OPCODE_ARR                 61
 253 #define TGSI_OPCODE_BRA                 62
 254 #define TGSI_OPCODE_CAL                 63
 255 #define TGSI_OPCODE_RET                 64
 256 #define TGSI_OPCODE_SSG                 65 /* SGN */
 257 #define TGSI_OPCODE_CMP                 66
 258 #define TGSI_OPCODE_SCS                 67
 259 #define TGSI_OPCODE_TXB                 68
 260 #define TGSI_OPCODE_NRM                 69
 261 #define TGSI_OPCODE_DIV                 70
 262 #define TGSI_OPCODE_DP2                 71
 263 #define TGSI_OPCODE_TXL                 72
 264 #define TGSI_OPCODE_BRK                 73
 265 #define TGSI_OPCODE_IF                  74
 266 #define TGSI_OPCODE_BGNFOR              75
 267 #define TGSI_OPCODE_REP                 76
 268 #define TGSI_OPCODE_ELSE                77
 269 #define TGSI_OPCODE_ENDIF               78
 270 #define TGSI_OPCODE_ENDFOR              79
 271 #define TGSI_OPCODE_ENDREP              80
 272 #define TGSI_OPCODE_PUSHA               81
 273 #define TGSI_OPCODE_POPA                82
 274 #define TGSI_OPCODE_CEIL                83
 275 #define TGSI_OPCODE_I2F                 84
 276 #define TGSI_OPCODE_NOT                 85
 277 #define TGSI_OPCODE_TRUNC               86
 278 #define TGSI_OPCODE_SHL                 87
 279                                 /* gap */
 280 #define TGSI_OPCODE_AND                 89
 281 #define TGSI_OPCODE_OR                  90
 282 #define TGSI_OPCODE_MOD                 91
 283 #define TGSI_OPCODE_XOR                 92
 284 #define TGSI_OPCODE_SAD                 93
 285 #define TGSI_OPCODE_TXF                 94
 286 #define TGSI_OPCODE_TXQ                 95
 287 #define TGSI_OPCODE_CONT                96
 288 #define TGSI_OPCODE_EMIT                97
 289 #define TGSI_OPCODE_ENDPRIM             98
 290 #define TGSI_OPCODE_BGNLOOP             99
 291 #define TGSI_OPCODE_BGNSUB              100
 292 #define TGSI_OPCODE_ENDLOOP             101
 293 #define TGSI_OPCODE_ENDSUB              102
 294                                 /* gap */
 295 #define TGSI_OPCODE_NOP                 107
 296                                 /* gap */
 297 #define TGSI_OPCODE_NRM4                112
 298 #define TGSI_OPCODE_CALLNZ              113
 299 #define TGSI_OPCODE_IFC                 114
 300 #define TGSI_OPCODE_BREAKC              115
 301 #define TGSI_OPCODE_KIL                 116  /* conditional kill */
 302 #define TGSI_OPCODE_END                 117  /* aka HALT */
 303                                 /* gap */
 304 #define TGSI_OPCODE_F2I                 119
 305 #define TGSI_OPCODE_IDIV                120
 306 #define TGSI_OPCODE_IMAX                121
 307 #define TGSI_OPCODE_IMIN                122
 308 #define TGSI_OPCODE_INEG                123
 309 #define TGSI_OPCODE_ISGE                124
 310 #define TGSI_OPCODE_ISHR                125
 311 #define TGSI_OPCODE_ISLT                126
 312 #define TGSI_OPCODE_F2U                 127
 313 #define TGSI_OPCODE_U2F                 128
 314 #define TGSI_OPCODE_UADD                129
 315 #define TGSI_OPCODE_UDIV                130
 316 #define TGSI_OPCODE_UMAD                131
 317 #define TGSI_OPCODE_UMAX                132
 318 #define TGSI_OPCODE_UMIN                133
 319 #define TGSI_OPCODE_UMOD                134
 320 #define TGSI_OPCODE_UMUL                135
 321 #define TGSI_OPCODE_USEQ                136
 322 #define TGSI_OPCODE_USGE                137
 323 #define TGSI_OPCODE_USHR                138
 324 #define TGSI_OPCODE_USLT                139
 325 #define TGSI_OPCODE_USNE                140
 326 #define TGSI_OPCODE_SWITCH              141
 327 #define TGSI_OPCODE_CASE                142
 328 #define TGSI_OPCODE_DEFAULT             143
 329 #define TGSI_OPCODE_ENDSWITCH           144
 330 #define TGSI_OPCODE_LAST                145
 331
 332 #define TGSI_SAT_NONE            0  /* do not saturate */
 333 #define TGSI_SAT_ZERO_ONE        1  /* clamp to [0,1] */
 334 #define TGSI_SAT_MINUS_PLUS_ONE  2  /* clamp to [-1,1] */
 335
 336 /**
 337  * Opcode is the operation code to execute. A given operation defines the
 338  * semantics how the source registers (if any) are interpreted and what is
 339  * written to the destination registers (if any) as a result of execution.
 340  *
 341  * NumDstRegs and NumSrcRegs is the number of destination and source registers,
 342  * respectively. For a given operation code, those numbers are fixed and are
 343  * present here only for convenience.
 344  *
 345  * If Predicate is TRUE, tgsi_instruction_predicate token immediately follows.
 346  *
 347  * Saturate controls how are final results in destination registers modified.
 348  */
 349
 350 struct tgsi_instruction
 351 {
 352    unsigned Type       : 4;  /* TGSI_TOKEN_TYPE_INSTRUCTION */
 353    unsigned NrTokens   : 8;  /* UINT */
 354    unsigned Opcode     : 8;  /* TGSI_OPCODE_ */
 355    unsigned Saturate   : 2;  /* TGSI_SAT_ */
 356    unsigned NumDstRegs : 2;  /* UINT */
 357    unsigned NumSrcRegs : 4;  /* UINT */
 358    unsigned Predicate  : 1;  /* BOOL */
 359    unsigned Label      : 1;
 360    unsigned Texture    : 1;
 361    unsigned Padding    : 1;
 362 };
 363
 364 /*
 365  * If tgsi_instruction::Label is TRUE, tgsi_instruction_label follows.
 366  *
 367  * If tgsi_instruction::Texture is TRUE, tgsi_instruction_texture follows.
 368  *
 369  * Then, tgsi_instruction::NumDstRegs of tgsi_dst_register follow.
 370  *
 371  * Then, tgsi_instruction::NumSrcRegs of tgsi_src_register follow.
 372  *
 373  * tgsi_instruction::NrTokens contains the total number of words that make the
 374  * instruction, including the instruction word.
 375  */
 376
 377 #define TGSI_SWIZZLE_X      0
 378 #define TGSI_SWIZZLE_Y      1
 379 #define TGSI_SWIZZLE_Z      2
 380 #define TGSI_SWIZZLE_W      3
 381
 382 struct tgsi_instruction_label
 383 {
 384    unsigned Label    : 24;   /* UINT */
 385    unsigned Padding  : 8;
 386 };
 387
 388 #define TGSI_TEXTURE_UNKNOWN        0
 389 #define TGSI_TEXTURE_1D             1
 390 #define TGSI_TEXTURE_2D             2
 391 #define TGSI_TEXTURE_3D             3
 392 #define TGSI_TEXTURE_CUBE           4
 393 #define TGSI_TEXTURE_RECT           5
 394 #define TGSI_TEXTURE_SHADOW1D       6
 395 #define TGSI_TEXTURE_SHADOW2D       7
 396 #define TGSI_TEXTURE_SHADOWRECT     8
 397 #define TGSI_TEXTURE_COUNT          9
 398
 399 struct tgsi_instruction_texture
 400 {
 401    unsigned Texture  : 8;    /* TGSI_TEXTURE_ */
 402    unsigned Padding  : 24;
 403 };
 404
 405 /*
 406  * For SM3, the following constraint applies.
 407  *   - Swizzle is either set to identity or replicate.
 408  */
 409 struct tgsi_instruction_predicate
 410 {
 411    int      Index    : 16; /* SINT */
 412    unsigned SwizzleX : 2;  /* TGSI_SWIZZLE_x */
 413    unsigned SwizzleY : 2;  /* TGSI_SWIZZLE_x */
 414    unsigned SwizzleZ : 2;  /* TGSI_SWIZZLE_x */
 415    unsigned SwizzleW : 2;  /* TGSI_SWIZZLE_x */
 416    unsigned Negate   : 1;  /* BOOL */
 417    unsigned Padding  : 7;
 418 };
 419
 420 /**
 421  * File specifies the register array to access.
 422  *
 423  * Index specifies the element number of a register in the register file.
 424  *
 425  * If Indirect is TRUE, Index should be offset by the X component of a source
 426  * register that follows. The register can be now fetched into local storage
 427  * for further processing.
 428  *
 429  * If Negate is TRUE, all components of the fetched register are negated.
 430  *
 431  * The fetched register components are swizzled according to SwizzleX, SwizzleY,
 432  * SwizzleZ and SwizzleW.
 433  *
 434  */
 435
 436 struct tgsi_src_register
 437 {
 438    unsigned File        : 4;  /* TGSI_FILE_ */
 439    unsigned Indirect    : 1;  /* BOOL */
 440    unsigned Dimension   : 1;  /* BOOL */
 441    int      Index       : 16; /* SINT */
 442    unsigned SwizzleX    : 2;  /* TGSI_SWIZZLE_ */
 443    unsigned SwizzleY    : 2;  /* TGSI_SWIZZLE_ */
 444    unsigned SwizzleZ    : 2;  /* TGSI_SWIZZLE_ */
 445    unsigned SwizzleW    : 2;  /* TGSI_SWIZZLE_ */
 446    unsigned Absolute    : 1;    /* BOOL */
 447    unsigned Negate      : 1;    /* BOOL */
 448 };
 449
 450 /**
 451  * If tgsi_src_register::Modifier is TRUE, tgsi_src_register_modifier follows.
 452  *
 453  * Then, if tgsi_src_register::Indirect is TRUE, another tgsi_src_register
 454  * follows.
 455  *
 456  * Then, if tgsi_src_register::Dimension is TRUE, tgsi_dimension follows.
 457  */
 458
 459
 460 struct tgsi_dimension
 461 {
 462    unsigned Indirect    : 1;  /* BOOL */
 463    unsigned Dimension   : 1;  /* BOOL */
 464    unsigned Padding     : 14;
 465    int      Index       : 16; /* SINT */
 466 };
 467
 468 struct tgsi_dst_register
 469 {
 470    unsigned File        : 4;  /* TGSI_FILE_ */
 471    unsigned WriteMask   : 4;  /* TGSI_WRITEMASK_ */
 472    unsigned Indirect    : 1;  /* BOOL */
 473    unsigned Dimension   : 1;  /* BOOL */
 474    int      Index       : 16; /* SINT */
 475    unsigned Padding     : 6;
 476 };
 477
 478
 479 #ifdef __cplusplus
 480 }
 481 #endif
 482
 483 #endif /* P_SHADER_TOKENS_H */