aboutsummaryrefslogtreecommitdiffstats
path: root/src/gallium/drivers/cell/common.h
blob: a8cdde34aa7717b6738c746511d897909c949455 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/**************************************************************************
 * 
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 **************************************************************************/

/**
 * Types and tokens which are common to the SPU and PPU code.
 */


#ifndef CELL_COMMON_H
#define CELL_COMMON_H

#include "pipe/p_compiler.h"
#include "pipe/p_format.h"
#include "pipe/p_state.h"
#include <stdio.h>

/** The standard assert macro doesn't seem to work reliably */
#define ASSERT(x) \
   if (!(x)) { \
      ubyte *p = NULL; \
      fprintf(stderr, "%s:%d: %s(): assertion %s failed.\n", \
              __FILE__, __LINE__, __FUNCTION__, #x);             \
      *p = 0; \
      exit(1); \
   }


#define JOIN(x, y) JOIN_AGAIN(x, y)
#define JOIN_AGAIN(x, y) x ## y

#define STATIC_ASSERT(e) \
{typedef char JOIN(assertion_failed_at_line_, __LINE__) [(e) ? 1 : -1];}



/** for sanity checking */
#define ASSERT_ALIGN16(ptr) \
  ASSERT((((unsigned long) (ptr)) & 0xf) == 0);


/** round up value to next multiple of 4 */
#define ROUNDUP4(k)  (((k) + 0x3) & ~0x3)

/** round up value to next multiple of 8 */
#define ROUNDUP8(k)  (((k) + 0x7) & ~0x7)

/** round up value to next multiple of 16 */
#define ROUNDUP16(k)  (((k) + 0xf) & ~0xf)


#define CELL_MAX_SPUS 8

#define CELL_MAX_SAMPLERS 4
#define CELL_MAX_TEXTURE_LEVELS 12  /* 2k x 2k */
#define CELL_MAX_CONSTANTS 32  /**< number of float[4] constants */
#define CELL_MAX_WIDTH 1024    /**< max framebuffer width */
#define CELL_MAX_HEIGHT 1024   /**< max framebuffer width */

#define TILE_SIZE 32


/**
 * The low byte of a mailbox word contains the command opcode.
 * Remaining higher bytes are command specific.
 */
#define CELL_CMD_OPCODE_MASK 0xff

#define CELL_CMD_EXIT                 1
#define CELL_CMD_CLEAR_SURFACE        2
#define CELL_CMD_FINISH               3
#define CELL_CMD_RENDER               4
#define CELL_CMD_BATCH                5
#define CELL_CMD_RELEASE_VERTS        6
#define CELL_CMD_STATE_FRAMEBUFFER   10
#define CELL_CMD_STATE_FRAGMENT_OPS  11
#define CELL_CMD_STATE_SAMPLER       12
#define CELL_CMD_STATE_TEXTURE       13
#define CELL_CMD_STATE_VERTEX_INFO   14
#define CELL_CMD_STATE_VIEWPORT      15
#define CELL_CMD_STATE_UNIFORMS      16
#define CELL_CMD_STATE_VS_ARRAY_INFO 17
#define CELL_CMD_STATE_BIND_VS       18
#define CELL_CMD_STATE_FRAGMENT_PROGRAM 19
#define CELL_CMD_STATE_ATTRIB_FETCH  20
#define CELL_CMD_STATE_FS_CONSTANTS  21
#define CELL_CMD_STATE_RASTERIZER    22
#define CELL_CMD_VS_EXECUTE          23
#define CELL_CMD_FLUSH_BUFFER_RANGE  24
#define CELL_CMD_FENCE               25


/** Command/batch buffers */
#define CELL_NUM_BUFFERS 4
#define CELL_BUFFER_SIZE (4*1024)  /**< 16KB would be the max */

#define CELL_BUFFER_STATUS_FREE 10
#define CELL_BUFFER_STATUS_USED 20

/** Debug flags */
#define CELL_DEBUG_CHECKER              (1 << 0)
#define CELL_DEBUG_ASM                  (1 << 1)
#define CELL_DEBUG_SYNC                 (1 << 2)
#define CELL_DEBUG_FRAGMENT_OPS         (1 << 3)
#define CELL_DEBUG_FRAGMENT_OP_FALLBACK (1 << 4)
#define CELL_DEBUG_CMD                  (1 << 5)
#define CELL_DEBUG_CACHE                (1 << 6)

#define CELL_FENCE_IDLE      0
#define CELL_FENCE_EMITTED   1
#define CELL_FENCE_SIGNALLED 2

#define CELL_FACING_FRONT    0
#define CELL_FACING_BACK     1

struct cell_fence
{
   /** There's a 16-byte status qword per SPU */
   volatile uint status[CELL_MAX_SPUS][4];
};

#ifdef __SPU__
typedef vector unsigned int opcode_t;
#else
typedef unsigned int opcode_t[4];
#endif

/**
 * Fence command sent to SPUs.  In response, the SPUs will write
 * CELL_FENCE_STATUS_SIGNALLED back to the fence status word in main memory.
 */
struct cell_command_fence
{
   opcode_t opcode;      /**< CELL_CMD_FENCE */
   struct cell_fence *fence;
   uint32_t pad_[3];
};


/**
 * Command to specify per-fragment operations state and generated code.
 * Note that this is a variant-length structure, allocated with as 
 * much memory as needed to hold the generated code; the "code"
 * field *must* be the last field in the structure.  Also, the entire
 * length of the structure (including the variant code field) must be
 * a multiple of 8 bytes; we require that this structure itself be
 * a multiple of 8 bytes, and that the generated code also be a multiple
 * of 8 bytes.
 *
 * Also note that the dsa, blend, blend_color fields are really only needed
 * for the fallback/C per-pixel code.  They're not used when we generate
 * dynamic SPU fragment code (which is the normal case), and will eventually
 * be removed from this structure.
 */
struct cell_command_fragment_ops
{
   opcode_t opcode;      /**< CELL_CMD_STATE_FRAGMENT_OPS */

   /* Fields for the fallback case */
   struct pipe_depth_stencil_alpha_state dsa;
   struct pipe_blend_state blend;
   struct pipe_blend_color blend_color;

   /* Fields for the generated SPU code */
   unsigned total_code_size;
   unsigned front_code_index;
   unsigned back_code_index;
   /* this field has variant length, and must be the last field in 
    * the structure
    */
   unsigned code[0];
};


/** Max instructions for fragment programs */
#define SPU_MAX_FRAGMENT_PROGRAM_INSTS 512

/**
 * Command to send a fragment program to SPUs.
 */
struct cell_command_fragment_program
{
   opcode_t opcode;      /**< CELL_CMD_STATE_FRAGMENT_PROGRAM */
   uint num_inst;        /**< Number of instructions */
   uint32_t pad[3];
   unsigned code[SPU_MAX_FRAGMENT_PROGRAM_INSTS];
};


/**
 * Tell SPUs about the framebuffer size, location
 */
struct cell_command_framebuffer
{
   opcode_t opcode;     /**< CELL_CMD_STATE_FRAMEBUFFER */
   int width, height;
   void *color_start, *depth_start;
   enum pipe_format color_format, depth_format;
   uint32_t pad_[2];
};


/**
 * Tell SPUs about rasterizer state.
 */
struct cell_command_rasterizer
{
   opcode_t opcode;    /**< CELL_CMD_STATE_RASTERIZER */
   struct pipe_rasterizer_state rasterizer;
   /*uint32_t pad[1];*/
};


/**
 * Clear framebuffer to the given value/color.
 */
struct cell_command_clear_surface
{
   opcode_t opcode;     /**< CELL_CMD_CLEAR_SURFACE */
   uint surface; /**< Temporary: 0=color, 1=Z */
   uint value;
   uint32_t pad[2];
};


/**
 * Array info used by the vertex shader's vertex puller.
 */
struct cell_array_info
{
   uint64_t base;      /**< Base address of the 0th element. */
   uint attr;          /**< Attribute that this state is for. */
   uint pitch;         /**< Byte pitch from one entry to the next. */
   uint size;
   uint function_offset;
};


struct cell_attribute_fetch_code
{
   uint64_t base;
   uint size;
};


struct cell_buffer_range
{
   uint64_t base;
   unsigned size;
};


struct cell_shader_info
{
   uint64_t declarations;
   uint64_t instructions;
   uint64_t  immediates;

   unsigned num_outputs;
   unsigned num_declarations;
   unsigned num_instructions;
   unsigned num_immediates;
};


#define SPU_VERTS_PER_BATCH 64
struct cell_command_vs
{
   opcode_t opcode;       /**< CELL_CMD_VS_EXECUTE */
   uint64_t vOut[SPU_VERTS_PER_BATCH];
   unsigned num_elts;
   unsigned elts[SPU_VERTS_PER_BATCH];
   float plane[12][4];
   unsigned nr_planes;
   unsigned nr_attrs;
};


struct cell_command_render
{
   opcode_t opcode;   /**< CELL_CMD_RENDER */
   uint prim_type;    /**< PIPE_PRIM_x */
   uint num_verts;
   uint vertex_size;  /**< bytes per vertex */
   uint num_indexes;
   uint vertex_buf;  /**< which cell->buffer[] contains the vertex data */
   float xmin, ymin, xmax, ymax;  /* XXX another dummy field */
   uint min_index;
   boolean inline_verts;
   uint32_t pad_[1];
};


struct cell_command_release_verts
{
   opcode_t opcode;         /**< CELL_CMD_RELEASE_VERTS */
   uint vertex_buf;    /**< in [0, CELL_NUM_BUFFERS-1] */
   uint32_t pad_[3];
};


struct cell_command_sampler
{
   opcode_t opcode;         /**< CELL_CMD_STATE_SAMPLER */
   uint unit;
   struct pipe_sampler_state state;
   uint32_t pad_[3];
};


struct cell_command_texture
{
   opcode_t opcode;     /**< CELL_CMD_STATE_TEXTURE */
   uint target;         /**< PIPE_TEXTURE_x */
   uint unit;
   void *start[CELL_MAX_TEXTURE_LEVELS];   /**< Address in main memory */
   ushort width[CELL_MAX_TEXTURE_LEVELS];
   ushort height[CELL_MAX_TEXTURE_LEVELS];
   ushort depth[CELL_MAX_TEXTURE_LEVELS];
};


#define MAX_SPU_FUNCTIONS 12
/**
 * Used to tell the PPU about the address of particular functions in the
 * SPU's address space.
 */
struct cell_spu_function_info
{
   uint num;
   char names[MAX_SPU_FUNCTIONS][16];
   uint addrs[MAX_SPU_FUNCTIONS];
   char pad[12];   /**< Pad struct to multiple of 16 bytes (256 currently) */
};


/** This is the object passed to spe_create_thread() */
PIPE_ALIGN_TYPE(16,
struct cell_init_info
{
   unsigned id;
   unsigned num_spus;
   unsigned debug_flags;  /**< mask of CELL_DEBUG_x flags */
   float inv_timebase;    /**< 1.0/timebase, for perf measurement */

   /** Buffers for command batches, vertex/index data */
   ubyte *buffers[CELL_NUM_BUFFERS];
   uint *buffer_status;  /**< points at cell_context->buffer_status */

   struct cell_spu_function_info *spu_functions;
});


#endif /* CELL_COMMON_H */