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