2 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
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:
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
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. */
23 #ifndef R300_CONTEXT_H
24 #define R300_CONTEXT_H
26 #include "draw/draw_vertex.h"
28 #include "util/u_blitter.h"
30 #include "pipe/p_context.h"
31 #include "util/u_inlines.h"
32 #include "util/u_transfer.h"
33 #include "util/u_vbuf_mgr.h"
35 #include "r300_defines.h"
36 #include "r300_screen.h"
40 struct r300_fragment_shader;
41 struct r300_vertex_shader;
42 struct r300_stencilref_context;
45 /* Name, for debugging. */
49 /* Emit the state to the context. */
50 void (*emit)(struct r300_context*, unsigned, void*);
51 /* Upper bound on number of dwords to emit. */
53 /* Whether this atom should be emitted. */
55 /* Whether this atom may be emitted with state == NULL. */
56 boolean allow_null_state;
59 struct r300_aa_state {
60 struct r300_surface *dest;
63 uint32_t aaresolve_ctl;
66 struct r300_blend_state {
68 uint32_t cb_no_readwrite[8];
71 struct r300_blend_color_state {
75 struct r300_clip_state {
76 struct pipe_clip_state clip;
81 struct r300_dsa_state {
82 struct pipe_depth_stencil_alpha_state dsa;
84 /* This is actually a command buffer with named dwords. */
86 uint32_t alpha_function; /* R300_FG_ALPHA_FUNC: 0x4bd4 */
88 uint32_t z_buffer_control; /* R300_ZB_CNTL: 0x4f00 */
89 uint32_t z_stencil_control; /* R300_ZB_ZSTENCILCNTL: 0x4f04 */
90 uint32_t stencil_ref_mask; /* R300_ZB_STENCILREFMASK: 0x4f08 */
92 uint32_t stencil_ref_bf; /* R500_ZB_STENCILREFMASK_BF: 0x4fd4 */
94 /* The second command buffer disables zbuffer reads and writes. */
95 uint32_t cb_no_readwrite[8];
97 /* Whether a two-sided stencil is enabled. */
99 /* Whether a fallback should be used for a two-sided stencil ref value. */
100 boolean two_sided_stencil_ref;
103 struct r300_hyperz_state {
104 int current_func; /* -1 after a clear before first op */
106 /* This is actually a command buffer with named dwords. */
107 uint32_t cb_flush_begin;
108 uint32_t zb_zcache_ctlstat; /* R300_ZB_CACHE_CNTL */
110 uint32_t zb_bw_cntl; /* R300_ZB_BW_CNTL */
112 uint32_t zb_depthclearvalue; /* R300_ZB_DEPTHCLEARVALUE */
114 uint32_t sc_hyperz; /* R300_SC_HYPERZ */
116 uint32_t gb_z_peq_config; /* R300_GB_Z_PEQ_CONFIG: 0x4028 */
119 struct r300_gpu_flush {
120 uint32_t cb_flush_clean[6];
123 #define RS_STATE_MAIN_SIZE 23
125 struct r300_rs_state {
126 /* Original rasterizer state. */
127 struct pipe_rasterizer_state rs;
128 /* Draw-specific rasterizer state. */
129 struct pipe_rasterizer_state rs_draw;
131 /* Command buffers. */
132 uint32_t cb_main[RS_STATE_MAIN_SIZE];
133 uint32_t cb_poly_offset_zb16[5];
134 uint32_t cb_poly_offset_zb24[5];
136 /* The index to cb_main where the cull_mode register value resides. */
137 unsigned cull_mode_index;
139 /* Whether polygon offset is enabled. */
140 boolean polygon_offset_enable;
142 /* This is emitted in the draw function. */
143 uint32_t color_control; /* R300_GA_COLOR_CONTROL: 0x4278 */
146 struct r300_rs_block {
147 uint32_t vap_vtx_state_cntl; /* R300_VAP_VTX_STATE_CNTL: 0x2180 */
148 uint32_t vap_vsm_vtx_assm; /* R300_VAP_VSM_VTX_ASSM: 0x2184 */
149 uint32_t vap_out_vtx_fmt[2]; /* R300_VAP_OUTPUT_VTX_FMT_[0-1]: 0x2090 */
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] */
158 struct r300_sampler_state {
159 struct pipe_sampler_state state;
161 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
162 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
164 /* Min/max LOD must be clamped to [0, last_level], thus
165 * it's dependent on a currently bound texture */
166 unsigned min_lod, max_lod;
169 struct r300_texture_format_state {
170 uint32_t format0; /* R300_TX_FORMAT0: 0x4480 */
171 uint32_t format1; /* R300_TX_FORMAT1: 0x44c0 */
172 uint32_t format2; /* R300_TX_FORMAT2: 0x4500 */
173 uint32_t tile_config; /* R300_TX_OFFSET (subset thereof) */
176 struct r300_sampler_view {
177 struct pipe_sampler_view base;
179 /* Swizzles in the UTIL_FORMAT_SWIZZLE_* representation,
180 * derived from base. */
181 unsigned char swizzle[4];
183 /* Copy of r300_texture::texture_format_state with format-specific bits
185 struct r300_texture_format_state format;
187 /* The texture cache region for this texture. */
188 uint32_t texcache_region;
191 struct r300_texture_sampler_state {
192 struct r300_texture_format_state format;
193 uint32_t filter0; /* R300_TX_FILTER0: 0x4400 */
194 uint32_t filter1; /* R300_TX_FILTER1: 0x4440 */
195 uint32_t border_color; /* R300_TX_BORDER_COLOR: 0x45c0 */
198 struct r300_textures_state {
200 struct r300_sampler_view *sampler_views[16];
201 int sampler_view_count;
202 /* Sampler states. */
203 struct r300_sampler_state *sampler_states[16];
204 int sampler_state_count;
206 /* This is the merge of the texture and sampler states. */
208 uint32_t tx_enable; /* R300_TX_ENABLE: 0x4101 */
209 struct r300_texture_sampler_state regs[16];
212 struct r300_vertex_stream_state {
213 /* R300_VAP_PROG_STREAK_CNTL_[0-7] */
214 uint32_t vap_prog_stream_cntl[8];
215 /* R300_VAP_PROG_STREAK_CNTL_EXT_[0-7] */
216 uint32_t vap_prog_stream_cntl_ext[8];
221 struct r300_invariant_state {
225 struct r300_vap_invariant_state {
229 struct r300_viewport_state {
230 float xscale; /* R300_VAP_VPORT_XSCALE: 0x2098 */
231 float xoffset; /* R300_VAP_VPORT_XOFFSET: 0x209c */
232 float yscale; /* R300_VAP_VPORT_YSCALE: 0x20a0 */
233 float yoffset; /* R300_VAP_VPORT_YOFFSET: 0x20a4 */
234 float zscale; /* R300_VAP_VPORT_ZSCALE: 0x20a8 */
235 float zoffset; /* R300_VAP_VPORT_ZOFFSET: 0x20ac */
236 uint32_t vte_control; /* R300_VAP_VTE_CNTL: 0x20b0 */
239 struct r300_ztop_state {
240 uint32_t z_buffer_top; /* R300_ZB_ZTOP: 0x4f14 */
243 /* The next several objects are not pure Radeon state; they inherit from
244 * various Gallium classes. */
246 struct r300_constant_buffer {
247 /* Buffer of constants */
249 /* Remapping table. */
250 unsigned *remap_table;
251 /* const buffer base */
252 uint32_t buffer_base;
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.
263 /* The kind of query. Currently only OQ is supported. */
265 /* The number of pipes where query results are stored. */
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 */
272 /* if begin has been emitted */
273 boolean begin_emitted;
275 /* The buffer where query results are stored. */
276 struct r300_winsys_buffer *buffer;
277 struct r300_winsys_cs_buffer *cs_buffer;
278 /* The size of the buffer. */
279 unsigned buffer_size;
280 /* The domain of the buffer. */
281 enum r300_buffer_domain domain;
283 /* Linked list members. */
284 struct r300_query* prev;
285 struct r300_query* next;
290 * This is a fake fence. Instead of syncing with the fence, we sync
291 * with the context, which is inefficient but compliant.
293 * This is not a subclass of pipe_fence_handle because pipe_fence_handle is
294 * never actually fully defined. So, rather than have it as a member, and do
295 * subclass-style casting, we treat pipe_fence_handle as an opaque, and just
296 * trust that our state tracker does not ever mess up fence objects.
299 struct pipe_reference reference;
300 struct r300_context *ctx;
304 struct r300_surface {
305 struct pipe_surface base;
307 /* Winsys buffer backing the texture. */
308 struct r300_winsys_buffer *buffer;
309 struct r300_winsys_cs_buffer *cs_buffer;
311 enum r300_buffer_domain domain;
313 uint32_t offset; /* COLOROFFSET or DEPTHOFFSET. */
314 uint32_t pitch; /* COLORPITCH or DEPTHPITCH. */
315 uint32_t format; /* US_OUT_FMT or ZB_FORMAT. */
317 /* Parameters dedicated to the CBZB clear. */
318 uint32_t cbzb_width; /* Aligned width. */
319 uint32_t cbzb_height; /* Half of the height. */
320 uint32_t cbzb_midpoint_offset; /* DEPTHOFFSET. */
321 uint32_t cbzb_pitch; /* DEPTHPITCH. */
322 uint32_t cbzb_format; /* ZB_FORMAT. */
324 /* Whether the CBZB clear is allowed on the surface. */
325 boolean cbzb_allowed;
329 struct r300_texture_desc {
333 /* Width, height, and depth.
334 * Most of the time, these are equal to pipe_texture::width0, height0,
335 * and depth0. However, NPOT 3D textures must have dimensions aligned
336 * to POT, and this is the only case when these variables differ from
338 unsigned width0, height0, depth0;
341 * Macrotiling is specified per-level because small mipmaps cannot
343 enum r300_buffer_tiling microtile;
344 enum r300_buffer_tiling macrotile[R300_MAX_TEXTURE_LEVELS];
346 /* Offsets into the buffer. */
347 unsigned offset_in_bytes[R300_MAX_TEXTURE_LEVELS];
349 /* Strides for each mip-level. */
350 unsigned stride_in_pixels[R300_MAX_TEXTURE_LEVELS];
351 unsigned stride_in_bytes[R300_MAX_TEXTURE_LEVELS];
353 /* Size of one zslice or face or 2D image based on the texture target. */
354 unsigned layer_size_in_bytes[R300_MAX_TEXTURE_LEVELS];
356 /* Total size of this texture, in bytes,
357 * derived from the texture properties. */
358 unsigned size_in_bytes;
360 /* Total size of the buffer backing this texture, in bytes.
361 * It must be >= size. */
362 unsigned buffer_size_in_bytes;
365 * If non-zero, override the natural texture layout with
366 * a custom stride (in bytes).
368 * \note Mipmapping fails for textures with a non-natural layout!
370 * \sa r300_texture_get_stride
372 unsigned stride_in_bytes_override;
374 /* Whether this texture has non-power-of-two dimensions.
375 * It can be either a regular texture or a rectangle one. */
378 /* This flag says that hardware must use the stride for addressing
379 * instead of the width. */
380 boolean uses_stride_addressing;
382 /* Whether CBZB fast color clear is allowed on the miplevel. */
383 boolean cbzb_allowed[R300_MAX_TEXTURE_LEVELS];
385 /* Zbuffer compression info for each miplevel. */
386 boolean zcomp8x8[R300_MAX_TEXTURE_LEVELS];
387 /* If zero, then disable compression. */
388 unsigned zmask_dwords[R300_MAX_TEXTURE_LEVELS];
391 struct r300_texture {
392 struct r300_texture_desc desc;
394 enum r300_buffer_domain domain;
396 /* Pipe buffer backing this texture. */
397 struct r300_winsys_buffer *buffer;
398 struct r300_winsys_cs_buffer *cs_buffer;
400 /* Registers carrying texture format data. */
401 /* Only format-independent bits should be filled in. */
402 struct r300_texture_format_state tx_format;
404 /* hyper-z memory allocs */
405 struct mem_block *hiz_mem[R300_MAX_TEXTURE_LEVELS];
406 boolean hiz_in_use[R300_MAX_TEXTURE_LEVELS];
408 /* This is the level tiling flags were last time set for.
409 * It's used to prevent redundant tiling-flags changes from happening.*/
410 unsigned surface_level;
413 struct r300_vertex_element_state {
415 struct pipe_vertex_element velem[PIPE_MAX_ATTRIBS];
416 unsigned format_size[PIPE_MAX_ATTRIBS];
418 struct u_vbuf_mgr_elements *vmgr_elements;
420 /* The size of the vertex, in dwords. */
421 unsigned vertex_size_dwords;
423 struct r300_vertex_stream_state vertex_stream;
426 struct r300_context {
428 struct pipe_context context;
430 /* The interface to the windowing system, etc. */
431 struct r300_winsys_screen *rws;
432 /* The command stream. */
433 struct r300_winsys_cs *cs;
435 struct r300_screen *screen;
437 /* Draw module. Used mostly for SW TCL. */
438 struct draw_context* draw;
439 /* Vertex buffer for SW TCL. */
440 struct pipe_resource* vbo;
441 /* Offset and size into the SW TCL VBO. */
442 size_t draw_vbo_offset;
443 size_t draw_vbo_size;
444 /* Whether the VBO must not be flushed. */
445 boolean draw_vbo_locked;
446 boolean draw_first_emitted;
448 /* Accelerated blit support. */
449 struct blitter_context* blitter;
450 /* Stencil two-sided reference value fallback. */
451 struct r300_stencilref_context *stencilref_fallback;
453 /* The KIL opcode needs the first texture unit to be enabled
454 * on r3xx-r4xx. In order to calm down the CS checker, we bind this
455 * dummy texture there. */
456 struct r300_sampler_view *texkill_sampler;
458 /* When no vertex buffer is set, this one is used instead to prevent
460 struct pipe_resource *dummy_vb;
462 /* The currently active query. */
463 struct r300_query *query_current;
464 /* The saved query for blitter operations. */
465 struct r300_query *blitter_saved_query;
467 struct r300_query query_list;
469 /* Various CSO state objects. */
471 /* Each atom is emitted in the order it appears here, which can affect
472 * performance and stability if not handled with care. */
474 struct r300_atom gpu_flush;
475 /* Anti-aliasing (MSAA) state. */
476 struct r300_atom aa_state;
477 /* Framebuffer state. */
478 struct r300_atom fb_state;
479 /* HyperZ state (various SC/ZB bits). */
480 struct r300_atom hyperz_state;
482 struct r300_atom ztop_state;
483 /* Depth, stencil, and alpha state. */
484 struct r300_atom dsa_state;
486 struct r300_atom blend_state;
487 /* Blend color state. */
488 struct r300_atom blend_color_state;
490 struct r300_atom scissor_state;
491 /* Invariant state. This must be emitted to get the engine started. */
492 struct r300_atom invariant_state;
493 /* Viewport state. */
494 struct r300_atom viewport_state;
496 struct r300_atom pvs_flush;
497 /* VAP invariant state. */
498 struct r300_atom vap_invariant_state;
499 /* Vertex stream formatting state. */
500 struct r300_atom vertex_stream_state;
502 struct r300_atom vs_state;
503 /* User clip planes. */
504 struct r300_atom clip_state;
505 /* RS block state + VAP (vertex shader) output mapping state. */
506 struct r300_atom rs_block_state;
507 /* Rasterizer state. */
508 struct r300_atom rs_state;
509 /* Framebuffer state (pipelined regs). */
510 struct r300_atom fb_state_pipelined;
511 /* Fragment shader. */
513 /* Fragment shader RC_CONSTANT_STATE variables. */
514 struct r300_atom fs_rc_constant_state;
515 /* Fragment shader constant buffer. */
516 struct r300_atom fs_constants;
517 /* Vertex shader constant buffer. */
518 struct r300_atom vs_constants;
519 /* Texture cache invalidate. */
520 struct r300_atom texture_cache_inval;
521 /* Textures state. */
522 struct r300_atom textures_state;
524 struct r300_atom hiz_clear;
526 struct r300_atom zmask_clear;
527 /* Occlusion query. */
528 struct r300_atom query_start;
530 /* The pointers to the first and the last atom. */
531 struct r300_atom *first_dirty, *last_dirty;
533 /* Vertex elements for Gallium. */
534 struct r300_vertex_element_state *velems;
536 struct pipe_index_buffer index_buffer;
538 /* Vertex info for Draw. */
539 struct vertex_info vertex_info;
541 struct pipe_stencil_ref stencil_ref;
542 struct pipe_viewport_state viewport;
544 /* Stream locations for SWTCL. */
545 int stream_loc_notcl[16];
547 /* Flag indicating whether or not the HW is dirty. */
549 /* Whether polygon offset is enabled. */
550 boolean polygon_offset_enabled;
551 /* Z buffer bit depth. */
552 uint32_t zbuffer_bpp;
553 /* Whether rendering is conditional and should be skipped. */
554 boolean skip_rendering;
555 /* Point sprites texcoord index, 1 bit per texcoord */
556 int sprite_coord_enable;
557 /* Whether two-sided color selection is enabled (AKA light_twoside). */
558 boolean two_sided_color;
561 /* Whether ZMASK is enabled. */
562 boolean zmask_in_use;
563 /* Whether ZMASK is being decompressed. */
564 boolean zmask_decompress;
565 /* Whether ZMASK is locked, i.e. should be disabled and cannot be taken over. */
566 boolean zmask_locked;
567 /* The zbuffer the ZMASK of which is locked. */
568 struct pipe_surface *locked_zbuffer;
570 void *dsa_decompress_zmask;
572 /* two mem block managers for hiz/zmask ram space */
573 struct mem_block *hiz_mm;
575 struct u_vbuf_mgr *vbuf_mgr;
577 struct util_slab_mempool pool_transfers;
580 uint64_t flush_counter;
582 /* const tracking for VS */
585 /* AOS (PACKET3_3D_LOAD_VBPNTR) command buffer for the case offset=0. */
586 uint32_t vertex_arrays_cb[(16 * 3 + 1) / 2];
587 boolean vertex_arrays_dirty;
589 /* Whether any buffer (FB, textures, VBOs) has been set, but buffers
590 * haven't been validated yet. */
591 boolean validate_buffers;
592 /* Whether user buffers have been validated. */
593 boolean upload_vb_validated;
594 boolean upload_ib_validated;
597 #define foreach_atom(r300, atom) \
598 for (atom = &r300->gpu_flush; atom != (&r300->query_start)+1; atom++)
600 #define foreach_dirty_atom(r300, atom) \
601 for (atom = r300->first_dirty; atom != r300->last_dirty; atom++)
603 /* Convenience cast wrappers. */
604 static INLINE struct r300_query* r300_query(struct pipe_query* q)
606 return (struct r300_query*)q;
609 static INLINE struct r300_surface* r300_surface(struct pipe_surface* surf)
611 return (struct r300_surface*)surf;
614 static INLINE struct r300_texture* r300_texture(struct pipe_resource* tex)
616 return (struct r300_texture*)tex;
619 static INLINE struct r300_context* r300_context(struct pipe_context* context)
621 return (struct r300_context*)context;
624 static INLINE struct r300_fragment_shader *r300_fs(struct r300_context *r300)
626 return (struct r300_fragment_shader*)r300->fs.state;
629 static INLINE void r300_mark_atom_dirty(struct r300_context *r300,
630 struct r300_atom *atom)
634 if (!r300->first_dirty) {
635 r300->first_dirty = atom;
636 r300->last_dirty = atom+1;
638 if (atom < r300->first_dirty)
639 r300->first_dirty = atom;
640 else if (atom+1 > r300->last_dirty)
641 r300->last_dirty = atom+1;
645 struct pipe_context* r300_create_context(struct pipe_screen* screen,
648 void r300_finish(struct r300_context *r300);
649 void r300_flush_cb(void *data);
651 /* Context initialization. */
652 struct draw_stage* r300_draw_stage(struct r300_context* r300);
653 void r300_init_blit_functions(struct r300_context *r300);
654 void r300_init_flush_functions(struct r300_context* r300);
655 void r300_init_query_functions(struct r300_context* r300);
656 void r300_init_render_functions(struct r300_context *r300);
657 void r300_init_state_functions(struct r300_context* r300);
658 void r300_init_resource_functions(struct r300_context* r300);
661 void r300_decompress_zmask(struct r300_context *r300);
662 void r300_decompress_zmask_locked_unsafe(struct r300_context *r300);
663 void r300_decompress_zmask_locked(struct r300_context *r300);
666 void r300_resume_query(struct r300_context *r300,
667 struct r300_query *query);
668 void r300_stop_query(struct r300_context *r300);
670 /* r300_render_translate.c */
671 void r300_translate_index_buffer(struct r300_context *r300,
672 struct pipe_resource **index_buffer,
673 unsigned *index_size, unsigned index_offset,
674 unsigned *start, unsigned count);
676 /* r300_render_stencilref.c */
677 void r300_plug_in_stencil_ref_fallback(struct r300_context *r300);
680 void r300_draw_flush_vbuf(struct r300_context *r300);
681 void r500_emit_index_bias(struct r300_context *r300, int index_bias);
684 enum r300_fb_state_change {
685 R300_CHANGED_FB_STATE = 0,
686 R300_CHANGED_HYPERZ_FLAG,
687 R300_CHANGED_MULTIWRITE
690 void r300_mark_fb_state_dirty(struct r300_context *r300,
691 enum r300_fb_state_change change);
692 void r300_mark_fs_code_dirty(struct r300_context *r300);
694 /* r300_state_derived.c */
695 void r300_update_derived_state(struct r300_context* r300);
698 void r500_dump_rs_block(struct r300_rs_block *rs);
701 static INLINE boolean CTX_DBG_ON(struct r300_context * ctx, unsigned flags)
703 return SCREEN_DBG_ON(ctx->screen, flags);
706 static INLINE void CTX_DBG(struct r300_context * ctx, unsigned flags,
707 const char * fmt, ...)
709 if (CTX_DBG_ON(ctx, flags)) {
712 vfprintf(stderr, fmt, va);
717 #define DBG_ON CTX_DBG_ON
720 #endif /* R300_CONTEXT_H */