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