dc96d21f3189cf78eedab5b3b86658b43b70f6c0
[mesa.git] / src / gallium / drivers / r300 / r300_context.h
1 /*
2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE. */
22
23 #ifndef R300_CONTEXT_H
24 #define R300_CONTEXT_H
25
26 #include "draw/draw_vertex.h"
27
28 #include "util/u_blitter.h"
29
30 #include "pipe/p_context.h"
31 #include "util/u_inlines.h"
32 #include "util/u_transfer.h"
33
34 #include "translate/translate_cache.h"
35
36 #include "r300_defines.h"
37 #include "r300_screen.h"
38
39 struct u_upload_mgr;
40 struct r300_context;
41 struct r300_fragment_shader;
42 struct r300_vertex_shader;
43 struct r300_stencilref_context;
44
45 struct r300_atom {
46 /* List pointers. */
47 struct r300_atom *prev, *next;
48 /* Name, for debugging. */
49 const char* name;
50 /* Stat counter. */
51 uint64_t counter;
52 /* Opaque state. */
53 void* state;
54 /* Emit the state to the context. */
55 void (*emit)(struct r300_context*, unsigned, void*);
56 /* Upper bound on number of dwords to emit. */
57 unsigned size;
58 /* Whether this atom should be emitted. */
59 boolean dirty;
60 /* Whether this atom may be emitted with state == NULL. */
61 boolean allow_null_state;
62 };
63
64 struct r300_aa_state {
65 struct r300_surface *dest;
66
67 uint32_t aa_config;
68 uint32_t aaresolve_ctl;
69 };
70
71 struct r300_blend_state {
72 uint32_t cb[8];
73 uint32_t cb_no_readwrite[8];
74 };
75
76 struct r300_blend_color_state {
77 uint32_t cb[3];
78 };
79
80 struct r300_clip_state {
81 struct pipe_clip_state clip;
82
83 uint32_t cb[29];
84 };
85
86 struct r300_dsa_state {
87 struct pipe_depth_stencil_alpha_state dsa;
88
89 /* This is actually a command buffer with named dwords. */
90 uint32_t cb_begin;
91 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
92 uint32_t cb_reg_seq;
93 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
94 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
95 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
96 uint32_t cb_reg;
97 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
98
99 /* The second command buffer disables zbuffer reads and writes. */
100 uint32_t cb_no_readwrite[8];
101
102 /* Whether a two-sided stencil is enabled. */
103 boolean two_sided;
104 /* Whether a fallback should be used for a two-sided stencil ref value. */
105 boolean two_sided_stencil_ref;
106 };
107
108 struct r300_gpu_flush {
109 uint32_t cb_flush_clean[6];
110 };
111
112 struct r300_rs_state {
113 /* Original rasterizer state. */
114 struct pipe_rasterizer_state rs;
115 /* Draw-specific rasterizer state. */
116 struct pipe_rasterizer_state rs_draw;
117
118 uint32_t vap_control_status; /* R300_VAP_CNTL_STATUS: 0x2140 */
119 uint32_t multisample_position_0;/* R300_GB_MSPOS0: 0x4010 */
120 uint32_t multisample_position_1;/* R300_GB_MSPOS1: 0x4014 */
121 uint32_t point_size; /* R300_GA_POINT_SIZE: 0x421c */
122 uint32_t point_minmax; /* R300_GA_POINT_MINMAX: 0x4230 */
123 uint32_t line_control; /* R300_GA_LINE_CNTL: 0x4234 */
124 float depth_scale; /* R300_SU_POLY_OFFSET_FRONT_SCALE: 0x42a4 */
125 /* R300_SU_POLY_OFFSET_BACK_SCALE: 0x42ac */
126 float depth_offset; /* R300_SU_POLY_OFFSET_FRONT_OFFSET: 0x42a8 */
127 /* R300_SU_POLY_OFFSET_BACK_OFFSET: 0x42b0 */
128 uint32_t polygon_offset_enable; /* R300_SU_POLY_OFFSET_ENABLE: 0x42b4 */
129 uint32_t cull_mode; /* R300_SU_CULL_MODE: 0x42b8 */
130 uint32_t line_stipple_config; /* R300_GA_LINE_STIPPLE_CONFIG: 0x4328 */
131 uint32_t line_stipple_value; /* R300_GA_LINE_STIPPLE_VALUE: 0x4260 */
132 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
133 uint32_t polygon_mode; /* R300_GA_POLY_MODE: 0x4288 */
134 uint32_t clip_rule; /* R300_SC_CLIP_RULE: 0x43D0 */
135
136 /* Specifies top of Raster pipe specific enable controls,
137 * i.e. texture coordinates stuffing for points, lines, triangles */
138 uint32_t stuffing_enable; /* R300_GB_ENABLE: 0x4008 */
139
140 /* Point sprites texture coordinates, 0: lower left, 1: upper right */
141 float point_texcoord_left; /* R300_GA_POINT_S0: 0x4200 */
142 float point_texcoord_bottom; /* R300_GA_POINT_T0: 0x4204 */
143 float point_texcoord_right; /* R300_GA_POINT_S1: 0x4208 */
144 float point_texcoord_top; /* R300_GA_POINT_T1: 0x420c */
145 };
146
147 struct r300_rs_block {
148 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
149 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
150 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
151
152 uint32_t ip[8]; /* R300_RS_IP_[0-7], R500_RS_IP_[0-7] */
153 uint32_t count; /* R300_RS_COUNT */
154 uint32_t inst_count; /* R300_RS_INST_COUNT */
155 uint32_t inst[8]; /* R300_RS_INST_[0-7] */
156 };
157
158 struct r300_sampler_state {
159 struct pipe_sampler_state state;
160
161 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
162 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
163 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
164
165 /* Min/max LOD must be clamped to [0, last_level], thus
166 * it's dependent on a currently bound texture */
167 unsigned min_lod, max_lod;
168 };
169
170 struct r300_texture_format_state {
171 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
172 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
173 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
174 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
175 };
176
177 struct r300_sampler_view {
178 struct pipe_sampler_view base;
179
180 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
181 * derived from base. */
182 unsigned char swizzle[4];
183
184 /* Copy of r300_texture::texture_format_state with format-specific bits
185 * added. */
186 struct r300_texture_format_state format;
187
188 /* The texture cache region for this texture. */
189 uint32_t texcache_region;
190 };
191
192 struct r300_texture_fb_state {
193 uint32_t pitch[R300_MAX_TEXTURE_LEVELS]; /* COLORPITCH or DEPTHPITCH. */
194 uint32_t format; /* US_OUT_FMT or R300_ZB_FORMAT */
195 };
196
197 struct r300_texture_sampler_state {
198 struct r300_texture_format_state format;
199 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
200 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
201 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
202 };
203
204 struct r300_textures_state {
205 /* Textures. */
206 struct r300_sampler_view *sampler_views[16];
207 int sampler_view_count;
208 /* Sampler states. */
209 struct r300_sampler_state *sampler_states[16];
210 int sampler_state_count;
211
212 /* This is the merge of the texture and sampler states. */
213 unsigned count;
214 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
215 struct r300_texture_sampler_state regs[16];
216 };
217
218 struct r300_vertex_stream_state {
219 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
220 uint32_t vap_prog_stream_cntl[8];
221 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
222 uint32_t vap_prog_stream_cntl_ext[8];
223
224 unsigned count;
225 };
226
227 struct r300_vap_invariant_state {
228 uint32_t cb[9];
229 };
230
231 struct r300_viewport_state {
232 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
233 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
234 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
235 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
236 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
237 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
238 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
239 };
240
241 struct r300_ztop_state {
242 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
243 };
244
245 /* The next several objects are not pure Radeon state; they inherit from
246 * various Gallium classes. */
247
248 struct r300_constant_buffer {
249 /* Buffer of constants */
250 uint32_t constants[256][4];
251 /* Total number of constants */
252 unsigned count;
253 };
254
255 /* Query object.
256 *
257 * This is not a subclass of pipe_query because pipe_query is never
258 * actually fully defined. So, rather than have it as a member, and do
259 * subclass-style casting, we treat pipe_query as an opaque, and just
260 * trust that our state tracker does not ever mess up query objects.
261 */
262 struct r300_query {
263 /* The kind of query. Currently only OQ is supported. */
264 unsigned type;
265 /* The number of pipes where query results are stored. */
266 unsigned num_pipes;
267 /* How many results have been written, in dwords. It's incremented
268 * after end_query and flush. */
269 unsigned num_results;
270 /* if we've flushed the query */
271 boolean flushed;
272 /* if begin has been emitted */
273 boolean begin_emitted;
274
275 /* The buffer where query results are stored. */
276 struct r300_winsys_buffer *buffer;
277 /* The size of the buffer. */
278 unsigned buffer_size;
279 /* The domain of the buffer. */
280 enum r300_buffer_domain domain;
281
282 /* Linked list members. */
283 struct r300_query* prev;
284 struct r300_query* next;
285 };
286
287 /* Fence object.
288 *
289 * This is a fake fence. Instead of syncing with the fence, we sync
290 * with the context, which is inefficient but compliant.
291 *
292 * This is not a subclass of pipe_fence_handle because pipe_fence_handle is
293 * never actually fully defined. So, rather than have it as a member, and do
294 * subclass-style casting, we treat pipe_fence_handle as an opaque, and just
295 * trust that our state tracker does not ever mess up fence objects.
296 */
297 struct r300_fence {
298 struct pipe_reference reference;
299 struct r300_context *ctx;
300 boolean signalled;
301 };
302
303 struct r300_surface {
304 struct pipe_surface base;
305
306 /* Winsys buffer backing the texture. */
307 struct r300_winsys_buffer *buffer;
308
309 enum r300_buffer_domain domain;
310
311 uint32_t offset;
312 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
313 uint32_t format; /* US_OUT_FMT or R300_ZB_FORMAT. */
314 };
315
316 struct r300_texture {
317 /* Parent class */
318 struct u_resource b;
319
320 enum r300_buffer_domain domain;
321
322 /* Offsets into the buffer. */
323 unsigned offset[R300_MAX_TEXTURE_LEVELS];
324
325 /* A pitch for each mip-level */
326 unsigned pitch[R300_MAX_TEXTURE_LEVELS];
327
328 /* A pitch multiplied by blockwidth as hardware wants
329 * the number of pixels instead of the number of blocks. */
330 unsigned hwpitch[R300_MAX_TEXTURE_LEVELS];
331
332 /* Size of one zslice or face based on the texture target */
333 unsigned layer_size[R300_MAX_TEXTURE_LEVELS];
334
335 /* Whether the mipmap level is macrotiled. */
336 enum r300_buffer_tiling mip_macrotile[R300_MAX_TEXTURE_LEVELS];
337
338 /**
339 * If non-zero, override the natural texture layout with
340 * a custom stride (in bytes).
341 *
342 * \note Mipmapping fails for textures with a non-natural layout!
343 *
344 * \sa r300_texture_get_stride
345 */
346 unsigned stride_override;
347
348 /* Total size of this texture, in bytes. */
349 unsigned size;
350
351 /* Whether this texture has non-power-of-two dimensions
352 * or a user-specified pitch.
353 * It can be either a regular texture or a rectangle one.
354 */
355 boolean uses_pitch;
356
357 /* Pipe buffer backing this texture. */
358 struct r300_winsys_buffer *buffer;
359
360 /* Registers carrying texture format data. */
361 /* Only format-independent bits should be filled in. */
362 struct r300_texture_format_state tx_format;
363 /* All bits should be filled in. */
364 struct r300_texture_fb_state fb_state;
365
366 /* Buffer tiling */
367 enum r300_buffer_tiling microtile, macrotile;
368 };
369
370 struct r300_vertex_element_state {
371 unsigned count;
372 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
373
374 /* If (velem[i].src_format != hw_format[i]), the vertex buffer
375 * referenced by this vertex element cannot be used for rendering and
376 * its vertex data must be translated to hw_format[i]. */
377 enum pipe_format hw_format[PIPE_MAX_ATTRIBS];
378 unsigned hw_format_size[PIPE_MAX_ATTRIBS];
379
380 /* The size of the vertex, in dwords. */
381 unsigned vertex_size_dwords;
382
383 /* This might mean two things:
384 * - src_format != hw_format, as discussed above.
385 * - src_offset % 4 != 0. */
386 boolean incompatible_layout;
387
388 struct r300_vertex_stream_state vertex_stream;
389 };
390
391 struct r300_translate_context {
392 /* Translate cache for incompatible vertex offset/stride/format fallback. */
393 struct translate_cache *translate_cache;
394
395 /* The vertex buffer slot containing the translated buffer. */
396 unsigned vb_slot;
397
398 /* Saved and new vertex element state. */
399 void *saved_velems, *new_velems;
400 };
401
402 struct r300_context {
403 /* Parent class */
404 struct pipe_context context;
405
406 /* The interface to the windowing system, etc. */
407 struct r300_winsys_screen *rws;
408 /* Screen. */
409 struct r300_screen *screen;
410 /* Draw module. Used mostly for SW TCL. */
411 struct draw_context* draw;
412 /* Accelerated blit support. */
413 struct blitter_context* blitter;
414 /* Stencil two-sided reference value fallback. */
415 struct r300_stencilref_context *stencilref_fallback;
416 /* For translating vertex buffers having incompatible vertex layout. */
417 struct r300_translate_context tran;
418
419 /* Vertex buffer for rendering. */
420 struct pipe_resource* vbo;
421 /* The KIL opcode needs the first texture unit to be enabled
422 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
423 * dummy texture there. */
424 struct r300_sampler_view *texkill_sampler;
425 /* Offset into the VBO. */
426 size_t vbo_offset;
427
428 /* The currently active query. */
429 struct r300_query *query_current;
430 /* The saved query for blitter operations. */
431 struct r300_query *blitter_saved_query;
432 /* Query list. */
433 struct r300_query query_list;
434
435 /* Various CSO state objects. */
436 /* Beginning of atom list. */
437 struct r300_atom atom_list;
438 /* Anti-aliasing (MSAA) state. */
439 struct r300_atom aa_state;
440 /* Blend state. */
441 struct r300_atom blend_state;
442 /* Blend color state. */
443 struct r300_atom blend_color_state;
444 /* User clip planes. */
445 struct r300_atom clip_state;
446 /* Depth, stencil, and alpha state. */
447 struct r300_atom dsa_state;
448 /* Fragment shader. */
449 struct r300_atom fs;
450 /* Fragment shader RC_CONSTANT_STATE variables. */
451 struct r300_atom fs_rc_constant_state;
452 /* Fragment shader constant buffer. */
453 struct r300_atom fs_constants;
454 /* Framebuffer state. */
455 struct r300_atom fb_state;
456 /* Occlusion query. */
457 struct r300_atom query_start;
458 /* Rasterizer state. */
459 struct r300_atom rs_state;
460 /* RS block state + VAP (vertex shader) output mapping state. */
461 struct r300_atom rs_block_state;
462 /* Scissor state. */
463 struct r300_atom scissor_state;
464 /* Textures state. */
465 struct r300_atom textures_state;
466 /* Vertex stream formatting state. */
467 struct r300_atom vertex_stream_state;
468 /* Vertex shader. */
469 struct r300_atom vs_state;
470 /* Vertex shader constant buffer. */
471 struct r300_atom vs_constants;
472 /* Viewport state. */
473 struct r300_atom viewport_state;
474 /* ZTOP state. */
475 struct r300_atom ztop_state;
476 /* PVS flush. */
477 struct r300_atom pvs_flush;
478 /* VAP invariant state. */
479 struct r300_atom vap_invariant_state;
480 /* Texture cache invalidate. */
481 struct r300_atom texture_cache_inval;
482 /* GPU flush. */
483 struct r300_atom gpu_flush;
484
485 /* Invariant state. This must be emitted to get the engine started. */
486 struct r300_atom invariant_state;
487
488 /* Vertex buffers for Gallium. */
489 struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
490 int vertex_buffer_count;
491 int vertex_buffer_max_index;
492 /* Vertex elements for Gallium. */
493 struct r300_vertex_element_state *velems;
494 bool any_user_vbs;
495
496 /* Vertex info for Draw. */
497 struct vertex_info vertex_info;
498
499 struct pipe_stencil_ref stencil_ref;
500 struct pipe_viewport_state viewport;
501
502 /* Stream locations for SWTCL. */
503 int stream_loc_notcl[16];
504
505 /* Flag indicating whether or not the HW is dirty. */
506 uint32_t dirty_hw;
507 /* Whether polygon offset is enabled. */
508 boolean polygon_offset_enabled;
509 /* Z buffer bit depth. */
510 uint32_t zbuffer_bpp;
511 /* Whether rendering is conditional and should be skipped. */
512 boolean skip_rendering;
513 /* Point sprites texcoord index, 1 bit per texcoord */
514 int sprite_coord_enable;
515 /* Whether two-sided color selection is enabled (AKA light_twoside). */
516 boolean two_sided_color;
517 /* Incompatible vertex buffer layout? (misaligned stride or buffer_offset) */
518 boolean incompatible_vb_layout;
519
520 /* upload managers */
521 struct u_upload_mgr *upload_vb;
522 struct u_upload_mgr *upload_ib;
523
524 /* Stat counter. */
525 uint64_t flush_counter;
526 };
527
528 /* Convenience cast wrappers. */
529 static INLINE struct r300_query* r300_query(struct pipe_query* q)
530 {
531 return (struct r300_query*)q;
532 }
533
534 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
535 {
536 return (struct r300_surface*)surf;
537 }
538
539 static INLINE struct r300_texture* r300_texture(struct pipe_resource* tex)
540 {
541 return (struct r300_texture*)tex;
542 }
543
544 static INLINE struct r300_context* r300_context(struct pipe_context* context)
545 {
546 return (struct r300_context*)context;
547 }
548
549 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
550 {
551 return (struct r300_fragment_shader*)r300->fs.state;
552 }
553
554 struct pipe_context* r300_create_context(struct pipe_screen* screen,
555 void *priv);
556
557 boolean r300_check_cs(struct r300_context *r300, unsigned size);
558 void r300_finish(struct r300_context *r300);
559
560 /* Context initialization. */
561 struct draw_stage* r300_draw_stage(struct r300_context* r300);
562 void r300_init_blit_functions(struct r300_context *r300);
563 void r300_init_flush_functions(struct r300_context* r300);
564 void r300_init_query_functions(struct r300_context* r300);
565 void r300_init_render_functions(struct r300_context *r300);
566 void r300_init_state_functions(struct r300_context* r300);
567 void r300_init_resource_functions(struct r300_context* r300);
568
569 /* r300_query.c */
570 void r300_resume_query(struct r300_context *r300,
571 struct r300_query *query);
572 void r300_stop_query(struct r300_context *r300);
573
574 /* r300_render_translate.c */
575 void r300_begin_vertex_translate(struct r300_context *r300);
576 void r300_end_vertex_translate(struct r300_context *r300);
577 void r300_translate_index_buffer(struct r300_context *r300,
578 struct pipe_resource **index_buffer,
579 unsigned *index_size, unsigned index_offset,
580 unsigned *start, unsigned count);
581
582 /* r300_render_stencilref.c */
583 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
584
585 /* r300_state.c */
586 void r300_mark_fs_code_dirty(struct r300_context *r300);
587
588 /* r300_debug.c */
589 void r500_dump_rs_block(struct r300_rs_block *rs);
590
591
592 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
593 {
594 return SCREEN_DBG_ON(ctx->screen, flags);
595 }
596
597 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
598 const char * fmt, ...)
599 {
600 if (CTX_DBG_ON(ctx, flags)) {
601 va_list va;
602 va_start(va, fmt);
603 vfprintf(stderr, fmt, va);
604 va_end(va);
605 }
606 }
607
608 #define DBG_ON CTX_DBG_ON
609 #define DBG CTX_DBG
610
611 #endif /* R300_CONTEXT_H */